libgig  4.0.0
RIFF::List Class Reference

RIFF List Chunk. More...

#include <RIFF.h>

Inheritance diagram for RIFF::List:
RIFF::Chunk RIFF::File

Public Member Functions

 List (File *pFile, unsigned long StartPos, List *Parent)
 
String GetListTypeString ()
 Returns string representation of the lists's id. More...
 
uint32_t GetListType ()
 Returns unsigned integer representation of the list's ID. More...
 
ChunkGetSubChunk (uint32_t ChunkID)
 Returns subchunk with chunk ID ChunkID within this chunk list. More...
 
ListGetSubList (uint32_t ListType)
 Returns sublist chunk with list type ListType within this chunk list. More...
 
ChunkGetFirstSubChunk ()
 Returns the first subchunk within the list. More...
 
ChunkGetNextSubChunk ()
 Returns the next subchunk within the list. More...
 
ListGetFirstSubList ()
 Returns the first sublist within the list (that is a subchunk with chunk ID "LIST"). More...
 
ListGetNextSubList ()
 Returns the next sublist (that is a subchunk with chunk ID "LIST") within the list. More...
 
unsigned int CountSubChunks ()
 Returns number of subchunks within the list. More...
 
unsigned int CountSubChunks (uint32_t ChunkID)
 Returns number of subchunks within the list with chunk ID ChunkId. More...
 
unsigned int CountSubLists ()
 Returns number of sublists within the list. More...
 
unsigned int CountSubLists (uint32_t ListType)
 Returns number of sublists within the list with list type ListType More...
 
ChunkAddSubChunk (uint32_t uiChunkID, uint uiBodySize)
 Creates a new sub chunk. More...
 
ListAddSubList (uint32_t uiListType)
 Creates a new list sub chunk. More...
 
void DeleteSubChunk (Chunk *pSubChunk)
 Removes a sub chunk. More...
 
void MoveSubChunk (Chunk *pSrc, Chunk *pDst)
 Moves a sub chunk witin this list. More...
 
void MoveSubChunk (Chunk *pSrc, List *pNewParent)
 Moves a sub chunk from this list to another list. More...
 
virtual ~List ()
 
String GetChunkIDString ()
 Returns the String representation of the chunk's ID (e.g. More...
 
uint32_t GetChunkID ()
 Chunk ID in unsigned integer representation. More...
 
FileGetFile ()
 Returns pointer to the chunk's File object. More...
 
ListGetParent ()
 Returns pointer to the chunk's parent list chunk. More...
 
unsigned long GetSize () const
 Chunk size in bytes (without header, thus the chunk data body) More...
 
unsigned long GetNewSize ()
 New chunk size if it was modified with Resize(). More...
 
unsigned long GetPos ()
 Position within the chunk data body. More...
 
unsigned long GetFilePos ()
 Current, actual offset in file. More...
 
unsigned long SetPos (unsigned long Where, stream_whence_t Whence=stream_start)
 Sets the position within the chunk body, thus within the data portion of the chunk (in bytes). More...
 
unsigned long RemainingBytes ()
 Returns the number of bytes left to read in the chunk body. More...
 
stream_state_t GetState ()
 Returns the current state of the chunk object. More...
 
unsigned long Read (void *pData, unsigned long WordCount, unsigned long WordSize)
 Reads WordCount number of data words with given WordSize and copies it into a buffer pointed by pData. More...
 
unsigned long ReadInt8 (int8_t *pData, unsigned long WordCount=1)
 Reads WordCount number of 8 Bit signed integer words and copies it into the buffer pointed by pData. More...
 
int8_t ReadInt8 ()
 Reads one 8 Bit signed integer word and increments the position within the chunk. More...
 
unsigned long ReadUint8 (uint8_t *pData, unsigned long WordCount=1)
 Reads WordCount number of 8 Bit unsigned integer words and copies it into the buffer pointed by pData. More...
 
uint8_t ReadUint8 ()
 Reads one 8 Bit unsigned integer word and increments the position within the chunk. More...
 
unsigned long ReadInt16 (int16_t *pData, unsigned long WordCount=1)
 Reads WordCount number of 16 Bit signed integer words and copies it into the buffer pointed by pData. More...
 
int16_t ReadInt16 ()
 Reads one 16 Bit signed integer word and increments the position within the chunk. More...
 
unsigned long ReadUint16 (uint16_t *pData, unsigned long WordCount=1)
 Reads WordCount number of 16 Bit unsigned integer words and copies it into the buffer pointed by pData. More...
 
uint16_t ReadUint16 ()
 Reads one 16 Bit unsigned integer word and increments the position within the chunk. More...
 
unsigned long ReadInt32 (int32_t *pData, unsigned long WordCount=1)
 Reads WordCount number of 32 Bit signed integer words and copies it into the buffer pointed by pData. More...
 
int32_t ReadInt32 ()
 Reads one 32 Bit signed integer word and increments the position within the chunk. More...
 
unsigned long ReadUint32 (uint32_t *pData, unsigned long WordCount=1)
 Reads WordCount number of 32 Bit unsigned integer words and copies it into the buffer pointed by pData. More...
 
uint32_t ReadUint32 ()
 Reads one 32 Bit unsigned integer word and increments the position within the chunk. More...
 
void ReadString (String &s, int size)
 Reads a null-padded string of size characters and copies it into the string s. More...
 
unsigned long Write (void *pData, unsigned long WordCount, unsigned long WordSize)
 Writes WordCount number of data words with given WordSize from the buffer pointed by pData. More...
 
unsigned long WriteInt8 (int8_t *pData, unsigned long WordCount=1)
 Writes WordCount number of 8 Bit signed integer words from the buffer pointed by pData to the chunk's body, directly to the actual "physical" file. More...
 
unsigned long WriteUint8 (uint8_t *pData, unsigned long WordCount=1)
 Writes WordCount number of 8 Bit unsigned integer words from the buffer pointed by pData to the chunk's body, directly to the actual "physical" file. More...
 
unsigned long WriteInt16 (int16_t *pData, unsigned long WordCount=1)
 Writes WordCount number of 16 Bit signed integer words from the buffer pointed by pData to the chunk's body, directly to the actual "physical" file. More...
 
unsigned long WriteUint16 (uint16_t *pData, unsigned long WordCount=1)
 Writes WordCount number of 16 Bit unsigned integer words from the buffer pointed by pData to the chunk's body, directly to the actual "physical" file. More...
 
unsigned long WriteInt32 (int32_t *pData, unsigned long WordCount=1)
 Writes WordCount number of 32 Bit signed integer words from the buffer pointed by pData to the chunk's body, directly to the actual "physical" file. More...
 
unsigned long WriteUint32 (uint32_t *pData, unsigned long WordCount=1)
 Writes WordCount number of 32 Bit unsigned integer words from the buffer pointed by pData to the chunk's body, directly to the actual "physical" file. More...
 
void * LoadChunkData ()
 Load chunk body into RAM. More...
 
void ReleaseChunkData ()
 Free loaded chunk body from RAM. More...
 
void Resize (int iNewSize)
 Resize chunk. More...
 

Protected Types

typedef std::map< uint32_t, RIFF::Chunk * > ChunkMap
 
typedef std::list< Chunk * > ChunkList
 
typedef std::set< Chunk * > ChunkSet
 

Protected Member Functions

 List (File *pFile)
 
 List (File *pFile, List *pParent, uint32_t uiListID)
 
void ReadHeader (unsigned long fPos)
 
void WriteHeader (unsigned long fPos)
 
void LoadSubChunks (progress_t *pProgress=NULL)
 
void LoadSubChunksRecursively (progress_t *pProgress=NULL)
 
virtual unsigned long WriteChunk (unsigned long ulWritePos, unsigned long ulCurrentDataOffset, progress_t *pProgress=NULL)
 Write list chunk persistently e.g. More...
 
virtual void __resetPos ()
 Sets List Chunk's read/write position to zero and causes all sub chunks to do the same. More...
 
void DeleteChunkList ()
 
unsigned long ReadSceptical (void *pData, unsigned long WordCount, unsigned long WordSize)
 Just an internal wrapper for the main Read() method with additional Exception throwing on errors. More...
 
void swapBytes_16 (void *Word)
 
void swapBytes_32 (void *Word)
 
void swapBytes (void *Word, unsigned long WordSize)
 
String convertToString (uint32_t word)
 

Protected Attributes

uint32_t ListType
 
ChunkListpSubChunks
 
ChunkMappSubChunksMap
 
ChunkList::iterator ChunksIterator
 
ChunkList::iterator ListIterator
 
uint32_t ChunkID
 
uint32_t CurrentChunkSize
 
uint32_t NewChunkSize
 
ListpParent
 
FilepFile
 
unsigned long ulStartPos
 
unsigned long ulPos
 
uint8_t * pChunkData
 
unsigned long ulChunkDataSize
 

Detailed Description

RIFF List Chunk.

Provides convenient methods to access data of RIFF list chunks and their subchunks.

Definition at line 302 of file RIFF.h.

Member Typedef Documentation

◆ ChunkList

typedef std::list<Chunk*> RIFF::List::ChunkList
protected

Definition at line 325 of file RIFF.h.

◆ ChunkMap

typedef std::map<uint32_t, RIFF::Chunk*> RIFF::List::ChunkMap
protected

Definition at line 324 of file RIFF.h.

◆ ChunkSet

typedef std::set<Chunk*> RIFF::List::ChunkSet
protected

Definition at line 326 of file RIFF.h.

Constructor & Destructor Documentation

◆ List() [1/3]

RIFF::List::List ( File pFile,
unsigned long  StartPos,
List Parent 
)

Definition at line 973 of file RIFF.cpp.

References LIST_HEADER_SIZE, pSubChunks, pSubChunksMap, ReadHeader(), and RIFF::Chunk::ulStartPos.

Referenced by AddSubList().

◆ ~List()

RIFF::List::~List ( )
virtual

Definition at line 991 of file RIFF.cpp.

References DeleteChunkList().

◆ List() [2/3]

RIFF::List::List ( File pFile)
protected

Definition at line 965 of file RIFF.cpp.

References pSubChunks, and pSubChunksMap.

◆ List() [3/3]

RIFF::List::List ( File pFile,
List pParent,
uint32_t  uiListID 
)
protected

Definition at line 984 of file RIFF.cpp.

References ListType, pSubChunks, and pSubChunksMap.

Member Function Documentation

◆ __resetPos()

void RIFF::List::__resetPos ( )
protectedvirtual

Sets List Chunk's read/write position to zero and causes all sub chunks to do the same.

Reimplemented from RIFF::Chunk.

Definition at line 1457 of file RIFF.cpp.

References RIFF::Chunk::__resetPos(), and pSubChunks.

Referenced by RIFF::File::SetMode().

◆ AddSubChunk()

Chunk * RIFF::List::AddSubChunk ( uint32_t  uiChunkID,
uint  uiBodySize 
)

Creates a new sub chunk.

Creates and adds a new sub chunk to this list chunk. Note that the chunk's body size given by uiBodySize must be greater than zero. You have to call File::Save() to make this change persistent to the actual file and before performing any data write operations on the new chunk!

Parameters
uiChunkID- chunk ID of the new chunk
uiBodySize- size of the new chunk's body, that is its actual data size (without header)
Exceptions
RIFF::Exceptionif uiBodySize equals zero

Definition at line 1206 of file RIFF.cpp.

References RIFF::Chunk::Chunk(), CHUNK_HEADER_SIZE, LoadSubChunks(), RIFF::File::LogAsResized(), RIFF::Chunk::NewChunkSize, RIFF::Chunk::pFile, pSubChunks, and RIFF::Chunk::Resize().

Referenced by DLS::File::__ensureMandatoryChunksExist(), gig::File::AddInstrument(), gig::File::AddSample(), gig::File::File(), DLS::Sample::Resize(), DLS::Sample::UpdateChunks(), DLS::Region::UpdateChunks(), DLS::Instrument::UpdateChunks(), gig::DimensionRegion::UpdateChunks(), DLS::File::UpdateChunks(), gig::Sample::UpdateChunks(), gig::Region::UpdateChunks(), gig::Instrument::UpdateChunks(), and gig::File::UpdateChunks().

◆ AddSubList()

List * RIFF::List::AddSubList ( uint32_t  uiListType)

Creates a new list sub chunk.

Creates and adds a new list sub chunk to this list chunk. Note that you have to add sub chunks / sub list chunks to the new created chunk before trying to make this change persisten to the actual file with File::Save()!

Parameters
uiListType- list ID of the new list chunk

Definition at line 1277 of file RIFF.cpp.

References CHUNK_ID_LIST, List(), LIST_HEADER_SIZE, LoadSubChunks(), RIFF::File::LogAsResized(), RIFF::Chunk::NewChunkSize, RIFF::Chunk::pFile, and pSubChunks.

Referenced by DLS::File::__ensureMandatoryChunksExist(), gig::Region::AddDimension(), DLS::File::AddInstrument(), gig::File::AddInstrument(), DLS::Instrument::AddRegion(), gig::Instrument::AddRegion(), DLS::File::AddSample(), gig::File::AddSample(), gig::Region::DeleteDimensionZone(), gig::Region::Region(), gig::Region::SplitDimensionZone(), DLS::Info::UpdateChunks(), gig::Instrument::UpdateChunks(), gig::Group::UpdateChunks(), and gig::File::UpdateChunks().

◆ convertToString()

String RIFF::Chunk::convertToString ( uint32_t  word)
inlineprotectedinherited

Definition at line 282 of file RIFF.h.

Referenced by RIFF::File::File(), GetListTypeString(), LoadSubChunks(), and ReadHeader().

◆ CountSubChunks() [1/2]

unsigned int RIFF::List::CountSubChunks ( )

Returns number of subchunks within the list.

Definition at line 1144 of file RIFF.cpp.

References LoadSubChunks(), and pSubChunks.

Referenced by CountSubLists().

◆ CountSubChunks() [2/2]

unsigned int RIFF::List::CountSubChunks ( uint32_t  ChunkID)

Returns number of subchunks within the list with chunk ID ChunkId.

Definition at line 1153 of file RIFF.cpp.

References RIFF::Chunk::ChunkID, LoadSubChunks(), and pSubChunks.

◆ CountSubLists() [1/2]

unsigned int RIFF::List::CountSubLists ( )

Returns number of sublists within the list.

Definition at line 1170 of file RIFF.cpp.

References CHUNK_ID_LIST, and CountSubChunks().

Referenced by LoadSubChunksRecursively().

◆ CountSubLists() [2/2]

unsigned int RIFF::List::CountSubLists ( uint32_t  ListType)

Returns number of sublists within the list with list type ListType

Definition at line 1178 of file RIFF.cpp.

References CHUNK_ID_LIST, GetListType(), ListType, LoadSubChunks(), and pSubChunks.

◆ DeleteChunkList()

void RIFF::List::DeleteChunkList ( )
protected

Definition at line 998 of file RIFF.cpp.

References pSubChunks, and pSubChunksMap.

Referenced by RIFF::File::IsNew(), and ~List().

◆ DeleteSubChunk()

void RIFF::List::DeleteSubChunk ( Chunk pSubChunk)

Removes a sub chunk.

Removes the sub chunk given by pSubChunk from this list and frees it completely from RAM. The given chunk can either be a normal sub chunk or a list sub chunk. In case the given chunk is a list chunk, all its subchunks (if any) will be removed recursively as well. You should call File::Save() to make this change persistent at any time.

Parameters
pSubChunk- sub chunk or sub list chunk to be removed

Definition at line 1297 of file RIFF.cpp.

References RIFF::Chunk::GetChunkID(), LoadSubChunks(), pSubChunks, and pSubChunksMap.

Referenced by gig::Region::DeleteDimension(), gig::ScriptGroup::DeleteScript(), gig::File::DeleteScriptGroup(), gig::Sample::UpdateChunks(), gig::Instrument::UpdateChunks(), gig::File::UpdateChunks(), DLS::Instrument::~Instrument(), DLS::Region::~Region(), and DLS::Sample::~Sample().

◆ GetChunkID()

uint32_t RIFF::Chunk::GetChunkID ( )
inlineinherited

◆ GetChunkIDString()

String RIFF::Chunk::GetChunkIDString ( )
inherited

Returns the String representation of the chunk's ID (e.g.

"RIFF", "LIST").

Definition at line 199 of file RIFF.cpp.

◆ GetFile()

File* RIFF::Chunk::GetFile ( )
inlineinherited

Returns pointer to the chunk's File object.

Definition at line 210 of file RIFF.h.

Referenced by Korg::KMPRegion::FullSampleFileName().

◆ GetFilePos()

unsigned long RIFF::Chunk::GetFilePos ( )
inlineinherited

Current, actual offset in file.

Definition at line 215 of file RIFF.h.

References RIFF::stream_start.

Referenced by DLS::File::__ensureMandatoryChunksExist(), DLS::File::LoadSamples(), gig::File::LoadSamples(), and gig::Instrument::LoadScripts().

◆ GetFirstSubChunk()

Chunk * RIFF::List::GetFirstSubChunk ( )

Returns the first subchunk within the list.

You have to call this method before you can call GetNextSubChunk(). Recall it when you want to start from the beginning of the list again.

Returns
pointer to the first subchunk within the list, NULL otherwise

Definition at line 1070 of file RIFF.cpp.

References ChunksIterator, LoadSubChunks(), and pSubChunks.

Referenced by DLS::Articulator::LoadArticulations(), gig::File::LoadGroups(), gig::Group::UpdateChunks(), and gig::File::UpdateChunks().

◆ GetFirstSubList()

List * RIFF::List::GetFirstSubList ( )

Returns the first sublist within the list (that is a subchunk with chunk ID "LIST").

You have to call this method before you can call GetNextSubList(). Recall it when you want to start from the beginning of the list again.

Returns
pointer to the first sublist within the list, NULL otherwise

Definition at line 1104 of file RIFF.cpp.

References CHUNK_ID_LIST, ListIterator, LoadSubChunks(), and pSubChunks.

Referenced by gig::Instrument::Instrument(), gig::Region::LoadDimensionRegions(), DLS::File::LoadInstruments(), gig::File::LoadInstruments(), DLS::Instrument::LoadRegions(), DLS::File::LoadSamples(), gig::File::LoadSamples(), gig::File::LoadScriptGroups(), and LoadSubChunksRecursively().

◆ GetListType()

◆ GetListTypeString()

String RIFF::List::GetListTypeString ( )

Returns string representation of the lists's id.

Definition at line 1469 of file RIFF.cpp.

References RIFF::Chunk::convertToString(), and ListType.

◆ GetNewSize()

unsigned long RIFF::Chunk::GetNewSize ( )
inlineinherited

New chunk size if it was modified with Resize().

Definition at line 213 of file RIFF.h.

Referenced by gig::DimensionRegion::UpdateChunks().

◆ GetNextSubChunk()

Chunk * RIFF::List::GetNextSubChunk ( )

Returns the next subchunk within the list.

You have to call GetFirstSubChunk() before you can use this method!

Returns
pointer to the next subchunk within the list or NULL if end of list is reached

Definition at line 1086 of file RIFF.cpp.

References ChunksIterator, and pSubChunks.

Referenced by DLS::Articulator::LoadArticulations(), gig::File::LoadGroups(), gig::Group::UpdateChunks(), and gig::File::UpdateChunks().

◆ GetNextSubList()

List * RIFF::List::GetNextSubList ( )

Returns the next sublist (that is a subchunk with chunk ID "LIST") within the list.

You have to call GetFirstSubList() before you can use this method!

Returns
pointer to the next sublist within the list, NULL if end of list is reached

Definition at line 1126 of file RIFF.cpp.

References CHUNK_ID_LIST, ListIterator, and pSubChunks.

Referenced by gig::Instrument::Instrument(), gig::Region::LoadDimensionRegions(), DLS::File::LoadInstruments(), gig::File::LoadInstruments(), DLS::Instrument::LoadRegions(), DLS::File::LoadSamples(), gig::File::LoadSamples(), gig::File::LoadScriptGroups(), and LoadSubChunksRecursively().

◆ GetParent()

List* RIFF::Chunk::GetParent ( )
inlineinherited

Returns pointer to the chunk's parent list chunk.

Definition at line 211 of file RIFF.h.

Referenced by gig::ScriptGroup::DeleteScript(), gig::File::DeleteScriptGroup(), DLS::Instrument::~Instrument(), DLS::Region::~Region(), and DLS::Sample::~Sample().

◆ GetPos()

◆ GetSize()

◆ GetState()

stream_state_t RIFF::Chunk::GetState ( )
inherited

Returns the current state of the chunk object.

Following values are possible:

Definition at line 265 of file RIFF.cpp.

References RIFF::stream_closed, RIFF::stream_end_reached, and RIFF::stream_ready.

◆ GetSubChunk()

Chunk * RIFF::List::GetSubChunk ( uint32_t  ChunkID)

Returns subchunk with chunk ID ChunkID within this chunk list.

Use this method if you expect only one subchunk of that type in the list. It there are more than one, it's undetermined which one of them will be returned! If there are no subchunks with that desired chunk ID, NULL will be returned.

Parameters
ChunkID- chunk ID of the sought subchunk
Returns
pointer to the subchunk or NULL if there is none of that ID

Definition at line 1026 of file RIFF.cpp.

References RIFF::Chunk::ChunkID, LoadSubChunks(), and pSubChunksMap.

Referenced by DLS::File::__ensureMandatoryChunksExist(), gig::DimensionRegion::DimensionRegion(), DLS::File::File(), sf2::File::File(), sf2::GetMandatoryChunk(), Korg::KSFSample::GetPos(), sf2::Info::Info(), DLS::Instrument::Instrument(), gig::Instrument::Instrument(), Korg::KSFSample::KSFSample(), Korg::KSFSample::Read(), DLS::Region::Region(), gig::Region::Region(), DLS::Sample::Resize(), DLS::Resource::Resource(), DLS::Sample::Sample(), gig::Sample::Sample(), DLS::Sampler::Sampler(), gig::ScriptGroup::ScriptGroup(), DLS::Info::SetFixedStringLengths(), Korg::KSFSample::SetPos(), gig::File::SetSampleChecksum(), DLS::Sample::UpdateChunks(), DLS::Region::UpdateChunks(), DLS::Instrument::UpdateChunks(), gig::DimensionRegion::UpdateChunks(), DLS::File::UpdateChunks(), gig::Sample::UpdateChunks(), gig::Region::UpdateChunks(), gig::Instrument::UpdateChunks(), gig::Group::UpdateChunks(), gig::File::UpdateChunks(), gig::Instrument::UpdateScriptFileOffsets(), and sf2::Info::~Info().

◆ GetSubList()

List * RIFF::List::GetSubList ( uint32_t  ListType)

Returns sublist chunk with list type ListType within this chunk list.

Use this method if you expect only one sublist chunk of that type in the list. It there are more than one, it's undetermined which one of them will be returned! If there are no sublists with that desired list type, NULL will be returned.

Parameters
ListType- list type of the sought sublist
Returns
pointer to the sublist or NULL if there is none of that type

Definition at line 1045 of file RIFF.cpp.

References CHUNK_ID_LIST, GetListType(), ListType, LoadSubChunks(), and pSubChunks.

Referenced by DLS::File::__ensureMandatoryChunksExist(), gig::Region::AddDimension(), DLS::File::AddInstrument(), gig::File::AddInstrument(), DLS::Instrument::AddRegion(), gig::Instrument::AddRegion(), DLS::File::AddSample(), gig::File::AddSample(), gig::Region::DeleteDimension(), gig::Region::DeleteDimensionZone(), sf2::File::File(), sf2::Info::Info(), DLS::Info::Info(), gig::Instrument::Instrument(), DLS::Articulator::LoadArticulations(), gig::Region::LoadDimensionRegions(), gig::File::LoadGroups(), DLS::File::LoadInstruments(), gig::File::LoadInstruments(), DLS::Instrument::LoadRegions(), DLS::File::LoadSamples(), gig::File::LoadSamples(), gig::File::LoadScriptGroups(), gig::Instrument::MoveTo(), gig::Region::Region(), gig::Region::SplitDimensionZone(), DLS::Info::UpdateChunks(), gig::Region::UpdateChunks(), gig::Instrument::UpdateChunks(), gig::Group::UpdateChunks(), gig::File::UpdateChunks(), and gig::Instrument::UpdateScriptFileOffsets().

◆ LoadChunkData()

void * RIFF::Chunk::LoadChunkData ( )
inherited

Load chunk body into RAM.

Loads the whole chunk body into memory. You can modify the data in RAM and save the data by calling File::Save() afterwards.

Caution: the buffer pointer will be invalidated once File::Save() was called. You have to call LoadChunkData() again to get a new, valid pointer whenever File::Save() was called.

You can call LoadChunkData() again if you previously scheduled to enlarge this chunk with a Resize() call. In that case the buffer will be enlarged to the new, scheduled chunk size and you can already place the new chunk data to the buffer and finally call File::Save() to enlarge the chunk physically and write the new data in one rush. This approach is definitely recommended if you have to enlarge and write new data to a lot of chunks.

Returns
a pointer to the data in RAM on success, NULL otherwise
Exceptions
Exceptionif data buffer could not be enlarged
See also
ReleaseChunkData()

Definition at line 774 of file RIFF.cpp.

Referenced by gig::File::LoadGroups(), DLS::Sample::LoadSampleData(), DLS::Resource::UpdateChunks(), DLS::Sampler::UpdateChunks(), DLS::Sample::UpdateChunks(), DLS::Region::UpdateChunks(), DLS::Instrument::UpdateChunks(), gig::DimensionRegion::UpdateChunks(), DLS::File::UpdateChunks(), gig::Sample::UpdateChunks(), gig::Region::UpdateChunks(), gig::Instrument::UpdateChunks(), and gig::File::UpdateChunks().

◆ LoadSubChunks()

◆ LoadSubChunksRecursively()

void RIFF::List::LoadSubChunksRecursively ( progress_t pProgress = NULL)
protected

Definition at line 1397 of file RIFF.cpp.

References CountSubLists(), GetFirstSubList(), and GetNextSubList().

Referenced by RIFF::File::Save().

◆ MoveSubChunk() [1/2]

void RIFF::List::MoveSubChunk ( Chunk pSrc,
Chunk pDst 
)

Moves a sub chunk witin this list.

Moves a sub chunk from one position in this list to another position in the same list. The pSrc chunk is placed before the pDst chunk.

Parameters
pSrc- sub chunk to be moved
pDst- the position to move to. pSrc will be placed before pDst. If pDst is 0, pSrc will be placed last in list.

Definition at line 1229 of file RIFF.cpp.

References LoadSubChunks(), and pSubChunks.

Referenced by gig::Region::AddDimension(), DLS::Instrument::AddRegion(), gig::Instrument::MoveTo(), gig::Region::UpdateChunks(), gig::Group::UpdateChunks(), and gig::File::UpdateChunks().

◆ MoveSubChunk() [2/2]

void RIFF::List::MoveSubChunk ( Chunk pSrc,
List pNewParent 
)

Moves a sub chunk from this list to another list.

Moves a sub chunk from this list list to the end of another list.

Parameters
pSrc- sub chunk to be moved
pDst- destination list where the chunk shall be moved to

Definition at line 1244 of file RIFF.cpp.

References RIFF::Chunk::GetChunkID(), LoadSubChunks(), pSubChunks, and pSubChunksMap.

◆ Read()

unsigned long RIFF::Chunk::Read ( void *  pData,
unsigned long  WordCount,
unsigned long  WordSize 
)
inherited

Reads WordCount number of data words with given WordSize and copies it into a buffer pointed by pData.

The buffer has to be allocated and be sure to provide the correct WordSize, as this will be important and taken into account for eventual endian correction (swapping of bytes due to different native byte order of a system). The position within the chunk will automatically be incremented.

Parameters
pDatadestination buffer
WordCountnumber of data words to read
WordSizesize of each data word to read
Returns
number of successfully read data words or 0 if end of file reached or error occured

Definition at line 296 of file RIFF.cpp.

References RIFF::stream_curpos.

Referenced by DLS::Articulation::Articulation(), gig::DimensionRegion::DimensionRegion(), RIFF::File::File(), DLS::File::File(), DLS::Instrument::Instrument(), LoadSubChunks(), gig::MidiRuleAlternator::MidiRuleAlternator(), Korg::KSFSample::Read(), DLS::Sample::Read(), gig::Sample::Read(), sf2::ReadSample(), Korg::readText(), DLS::Region::Region(), DLS::Resource::Resource(), gig::Sample::Sample(), and DLS::Sampler::Sampler().

◆ ReadHeader()

◆ ReadInt16() [1/2]

unsigned long RIFF::Chunk::ReadInt16 ( int16_t *  pData,
unsigned long  WordCount = 1 
)
inherited

Reads WordCount number of 16 Bit signed integer words and copies it into the buffer pointed by pData.

The buffer has to be allocated. Endian correction will automatically be done if needed. The position within the chunk will automatically be incremented.

Parameters
pDatadestination buffer
WordCountnumber of 16 Bit signed integers to read
Returns
number of read integers
Exceptions
RIFF::Exceptionif an error occured or less than WordCount integers could be read!

Definition at line 500 of file RIFF.cpp.

Referenced by gig::DimensionRegion::DimensionRegion(), sf2::File::File(), sf2::Instrument::Instrument(), gig::Instrument::Instrument(), gig::MidiRuleLegato::MidiRuleLegato(), sf2::Preset::Preset(), sf2::Sample::Sample(), gig::Sample::Sample(), and DLS::Sampler::Sampler().

◆ ReadInt16() [2/2]

int16_t RIFF::Chunk::ReadInt16 ( )
inherited

Reads one 16 Bit signed integer word and increments the position within the chunk.

Endian correction will automatically be done if needed.

Returns
read integer word
Exceptions
RIFF::Exceptionif an error occured

Definition at line 693 of file RIFF.cpp.

◆ ReadInt32() [1/2]

unsigned long RIFF::Chunk::ReadInt32 ( int32_t *  pData,
unsigned long  WordCount = 1 
)
inherited

Reads WordCount number of 32 Bit signed integer words and copies it into the buffer pointed by pData.

The buffer has to be allocated. Endian correction will automatically be done if needed. The position within the chunk will automatically be incremented.

Parameters
pDatadestination buffer
WordCountnumber of 32 Bit signed integers to read
Returns
number of read integers
Exceptions
RIFF::Exceptionif an error occured or less than WordCount integers could be read!

Definition at line 574 of file RIFF.cpp.

Referenced by gig::DimensionRegion::DimensionRegion(), gig::Instrument::Instrument(), sf2::Preset::Preset(), sf2::Sample::Sample(), gig::Sample::Sample(), and DLS::Sampler::Sampler().

◆ ReadInt32() [2/2]

int32_t RIFF::Chunk::ReadInt32 ( )
inherited

Reads one 32 Bit signed integer word and increments the position within the chunk.

Endian correction will automatically be done if needed.

Returns
read integer word
Exceptions
RIFF::Exceptionif an error occured

Definition at line 727 of file RIFF.cpp.

◆ ReadInt8() [1/2]

unsigned long RIFF::Chunk::ReadInt8 ( int8_t *  pData,
unsigned long  WordCount = 1 
)
inherited

Reads WordCount number of 8 Bit signed integer words and copies it into the buffer pointed by pData.

The buffer has to be allocated. The position within the chunk will automatically be incremented.

Parameters
pDatadestination buffer
WordCountnumber of 8 Bit signed integers to read
Returns
number of read integers
Exceptions
RIFF::Exceptionif an error occured or less than WordCount integers could be read!

Definition at line 426 of file RIFF.cpp.

Referenced by gig::DimensionRegion::DimensionRegion(), Korg::KMPRegion::KMPRegion(), Korg::KSFSample::KSFSample(), sf2::LoadString(), and sf2::Sample::Sample().

◆ ReadInt8() [2/2]

int8_t RIFF::Chunk::ReadInt8 ( )
inherited

Reads one 8 Bit signed integer word and increments the position within the chunk.

Returns
read integer word
Exceptions
RIFF::Exceptionif an error occured

Definition at line 660 of file RIFF.cpp.

◆ ReadSceptical()

unsigned long RIFF::Chunk::ReadSceptical ( void *  pData,
unsigned long  WordCount,
unsigned long  WordSize 
)
protectedinherited

Just an internal wrapper for the main Read() method with additional Exception throwing on errors.

Definition at line 409 of file RIFF.cpp.

◆ ReadString()

void RIFF::Chunk::ReadString ( String s,
int  size 
)
inherited

Reads a null-padded string of size characters and copies it into the string s.

The position within the chunk will automatically be incremented.

Parameters
sdestination string
sizenumber of characters to read
Exceptions
RIFF::Exceptionif an error occured or less than size characters could be read!

Definition at line 628 of file RIFF.cpp.

Referenced by gig::MidiRuleAlternator::MidiRuleAlternator().

◆ ReadUint16() [1/2]

unsigned long RIFF::Chunk::ReadUint16 ( uint16_t *  pData,
unsigned long  WordCount = 1 
)
inherited

Reads WordCount number of 16 Bit unsigned integer words and copies it into the buffer pointed by pData.

The buffer has to be allocated. Endian correction will automatically be done if needed. The position within the chunk will automatically be incremented.

Parameters
pDatadestination buffer
WordCountnumber of 8 Bit unsigned integers to read
Returns
number of read integers
Exceptions
RIFF::Exceptionif an error occured or less than WordCount integers could be read!

Definition at line 537 of file RIFF.cpp.

Referenced by gig::DimensionRegion::DimensionRegion(), gig::Instrument::Instrument(), gig::MidiRuleLegato::MidiRuleLegato(), DLS::Region::Region(), DLS::Sample::Sample(), DLS::Sampler::Sampler(), and sf2::Version::Version().

◆ ReadUint16() [2/2]

uint16_t RIFF::Chunk::ReadUint16 ( )
inherited

Reads one 16 Bit unsigned integer word and increments the position within the chunk.

Endian correction will automatically be done if needed.

Returns
read integer word
Exceptions
RIFF::Exceptionif an error occured

Definition at line 710 of file RIFF.cpp.

◆ ReadUint32() [1/2]

unsigned long RIFF::Chunk::ReadUint32 ( uint32_t *  pData,
unsigned long  WordCount = 1 
)
inherited

Reads WordCount number of 32 Bit unsigned integer words and copies it into the buffer pointed by pData.

The buffer has to be allocated. Endian correction will automatically be done if needed. The position within the chunk will automatically be incremented.

Parameters
pDatadestination buffer
WordCountnumber of 32 Bit unsigned integers to read
Returns
number of read integers
Exceptions
RIFF::Exceptionif an error occured or less than WordCount integers could be read!

Definition at line 611 of file RIFF.cpp.

Referenced by DLS::Articulation::Articulation(), DLS::File::File(), DLS::Instrument::Instrument(), gig::Instrument::Instrument(), Korg::KSFSample::KSFSample(), DLS::Region::Region(), gig::Region::Region(), DLS::Sample::Sample(), DLS::Sampler::Sampler(), and gig::Script::Script().

◆ ReadUint32() [2/2]

uint32_t RIFF::Chunk::ReadUint32 ( )
inherited

Reads one 32 Bit unsigned integer word and increments the position within the chunk.

Endian correction will automatically be done if needed.

Returns
read integer word
Exceptions
RIFF::Exceptionif an error occured

Definition at line 744 of file RIFF.cpp.

◆ ReadUint8() [1/2]

unsigned long RIFF::Chunk::ReadUint8 ( uint8_t *  pData,
unsigned long  WordCount = 1 
)
inherited

Reads WordCount number of 8 Bit unsigned integer words and copies it into the buffer pointed by pData.

The buffer has to be allocated. The position within the chunk will automatically be incremented.

Parameters
pDatadestination buffer
WordCountnumber of 8 Bit unsigned integers to read
Returns
number of read integers
Exceptions
RIFF::Exceptionif an error occured or less than WordCount integers could be read!

Definition at line 463 of file RIFF.cpp.

Referenced by gig::DimensionRegion::DimensionRegion(), gig::Instrument::Instrument(), Korg::KMPInstrument::KMPInstrument(), Korg::KMPRegion::KMPRegion(), Korg::KSFSample::KSFSample(), gig::MidiRuleAlternator::MidiRuleAlternator(), gig::MidiRuleCtrlTrigger::MidiRuleCtrlTrigger(), gig::MidiRuleLegato::MidiRuleLegato(), gig::Region::Region(), gig::Script::Script(), and gig::Sample::UpdateChunks().

◆ ReadUint8() [2/2]

uint8_t RIFF::Chunk::ReadUint8 ( )
inherited

Reads one 8 Bit unsigned integer word and increments the position within the chunk.

Returns
read integer word
Exceptions
RIFF::Exceptionif an error occured

Definition at line 676 of file RIFF.cpp.

◆ ReleaseChunkData()

void RIFF::Chunk::ReleaseChunkData ( )
inherited

Free loaded chunk body from RAM.

Frees loaded chunk body data from memory (RAM). You should call File::Save() before calling this method if you modified the data to make the changes persistent.

Definition at line 818 of file RIFF.cpp.

Referenced by DLS::Sample::ReleaseSampleData().

◆ RemainingBytes()

unsigned long RIFF::Chunk::RemainingBytes ( )
inherited

Returns the number of bytes left to read in the chunk body.

When reading data from the chunk using the Read*() Methods, the position within the chunk data (that is the chunk body) will be incremented by the number of read bytes and RemainingBytes() returns how much data is left to read from the current position to the end of the chunk data.

Returns
number of bytes left to read

Definition at line 247 of file RIFF.cpp.

Referenced by gig::DimensionRegion::DimensionRegion(), LoadSubChunks(), gig::Sample::Read(), DLS::Region::Region(), and gig::Sample::UpdateChunks().

◆ Resize()

void RIFF::Chunk::Resize ( int  iNewSize)
inherited

Resize chunk.

Resizes this chunk's body, that is the actual size of data possible to be written to this chunk. This call will return immediately and just schedule the resize operation. You should call File::Save() to actually perform the resize operation(s) "physically" to the file. As this can take a while on large files, it is recommended to call Resize() first on all chunks which have to be resized and finally to call File::Save() to perform all those resize operations in one rush.

Caution: You cannot directly write to enlarged chunks before calling File::Save() as this might exceed the current chunk's body boundary!

Parameters
iNewSize- new chunk body size in bytes (must be greater than zero)
Exceptions
RIFF::Exceptionif iNewSize is less than 1
See also
File::Save()

Definition at line 843 of file RIFF.cpp.

Referenced by AddSubChunk(), DLS::Sample::Resize(), DLS::Sampler::UpdateChunks(), DLS::File::UpdateChunks(), gig::Instrument::UpdateChunks(), and gig::File::UpdateChunks().

◆ SetPos()

unsigned long RIFF::Chunk::SetPos ( unsigned long  Where,
stream_whence_t  Whence = stream_start 
)
inherited

◆ swapBytes()

void RIFF::Chunk::swapBytes ( void *  Word,
unsigned long  WordSize 
)
inlineprotectedinherited

Definition at line 273 of file RIFF.h.

◆ swapBytes_16()

void RIFF::Chunk::swapBytes_16 ( void *  Word)
inlineprotectedinherited

Definition at line 260 of file RIFF.h.

◆ swapBytes_32()

void RIFF::Chunk::swapBytes_32 ( void *  Word)
inlineprotectedinherited

Definition at line 265 of file RIFF.h.

◆ Write()

unsigned long RIFF::Chunk::Write ( void *  pData,
unsigned long  WordCount,
unsigned long  WordSize 
)
inherited

Writes WordCount number of data words with given WordSize from the buffer pointed by pData.

Be sure to provide the correct WordSize, as this will be important and taken into account for eventual endian correction (swapping of bytes due to different native byte order of a system). The position within the chunk will automatically be incremented.

Parameters
pDatasource buffer (containing the data)
WordCountnumber of data words to write
WordSizesize of each data word to write
Returns
number of successfully written data words
Exceptions
RIFF::Exceptionif write operation would exceed current chunk size or any IO error occured
See also
Resize()

Definition at line 359 of file RIFF.cpp.

References RIFF::stream_curpos, and RIFF::stream_mode_read_write.

Referenced by DLS::Sample::Write(), and gig::Sample::Write().

◆ WriteChunk()

unsigned long RIFF::List::WriteChunk ( unsigned long  ulWritePos,
unsigned long  ulCurrentDataOffset,
progress_t pProgress = NULL 
)
protectedvirtual

Write list chunk persistently e.g.

to disk.

Stores the list chunk persistently to its actual "physical" file. All subchunks (including sub list chunks) will be stored recursively as well.

Parameters
ulWritePos- position within the "physical" file where this list chunk should be written to
ulCurrentDataOffset- offset of current (old) data within the file
pProgress- optional: callback function for progress notification
Returns
new write position in the "physical" file, that is ulWritePos incremented by this list chunk's new size (including its header size of course)

Reimplemented from RIFF::Chunk.

Definition at line 1425 of file RIFF.cpp.

References RIFF::Chunk::CurrentChunkSize, LIST_HEADER_SIZE, RIFF::Chunk::NewChunkSize, RIFF::Chunk::pFile, pSubChunks, RIFF::stream_mode_read_write, RIFF::Chunk::ulStartPos, and WriteHeader().

Referenced by RIFF::File::Save().

◆ WriteHeader()

void RIFF::List::WriteHeader ( unsigned long  fPos)
protected

◆ WriteInt16()

unsigned long RIFF::Chunk::WriteInt16 ( int16_t *  pData,
unsigned long  WordCount = 1 
)
inherited

Writes WordCount number of 16 Bit signed integer words from the buffer pointed by pData to the chunk's body, directly to the actual "physical" file.

The position within the chunk will automatically be incremented. Note: you cannot write beyond the boundaries of the chunk, to append data to the chunk call Resize() before.

Parameters
pDatasource buffer (containing the data)
WordCountnumber of 16 Bit signed integers to write
Returns
number of written integers
Exceptions
RIFF::Exceptionif an IO error occured
See also
Resize()

Definition at line 521 of file RIFF.cpp.

◆ WriteInt32()

unsigned long RIFF::Chunk::WriteInt32 ( int32_t *  pData,
unsigned long  WordCount = 1 
)
inherited

Writes WordCount number of 32 Bit signed integer words from the buffer pointed by pData to the chunk's body, directly to the actual "physical" file.

The position within the chunk will automatically be incremented. Note: you cannot write beyond the boundaries of the chunk, to append data to the chunk call Resize() before.

Parameters
pDatasource buffer (containing the data)
WordCountnumber of 32 Bit signed integers to write
Returns
number of written integers
Exceptions
RIFF::Exceptionif an IO error occured
See also
Resize()

Definition at line 595 of file RIFF.cpp.

◆ WriteInt8()

unsigned long RIFF::Chunk::WriteInt8 ( int8_t *  pData,
unsigned long  WordCount = 1 
)
inherited

Writes WordCount number of 8 Bit signed integer words from the buffer pointed by pData to the chunk's body, directly to the actual "physical" file.

The position within the chunk will automatically be incremented. Note: you cannot write beyond the boundaries of the chunk, to append data to the chunk call Resize() before.

Parameters
pDatasource buffer (containing the data)
WordCountnumber of 8 Bit signed integers to write
Returns
number of written integers
Exceptions
RIFF::Exceptionif an IO error occured
See also
Resize()

Definition at line 447 of file RIFF.cpp.

◆ WriteUint16()

unsigned long RIFF::Chunk::WriteUint16 ( uint16_t *  pData,
unsigned long  WordCount = 1 
)
inherited

Writes WordCount number of 16 Bit unsigned integer words from the buffer pointed by pData to the chunk's body, directly to the actual "physical" file.

The position within the chunk will automatically be incremented. Note: you cannot write beyond the boundaries of the chunk, to append data to the chunk call Resize() before.

Parameters
pDatasource buffer (containing the data)
WordCountnumber of 16 Bit unsigned integers to write
Returns
number of written integers
Exceptions
RIFF::Exceptionif an IO error occured
See also
Resize()

Definition at line 558 of file RIFF.cpp.

◆ WriteUint32()

unsigned long RIFF::Chunk::WriteUint32 ( uint32_t *  pData,
unsigned long  WordCount = 1 
)
inherited

Writes WordCount number of 32 Bit unsigned integer words from the buffer pointed by pData to the chunk's body, directly to the actual "physical" file.

The position within the chunk will automatically be incremented. Note: you cannot write beyond the boundaries of the chunk, to append data to the chunk call Resize() before.

Parameters
pDatasource buffer (containing the data)
WordCountnumber of 32 Bit unsigned integers to write
Returns
number of written integers
Exceptions
RIFF::Exceptionif an IO error occured
See also
Resize()

Definition at line 649 of file RIFF.cpp.

Referenced by DLS::File::__ensureMandatoryChunksExist(), gig::File::SetSampleChecksum(), and gig::Instrument::UpdateScriptFileOffsets().

◆ WriteUint8()

unsigned long RIFF::Chunk::WriteUint8 ( uint8_t *  pData,
unsigned long  WordCount = 1 
)
inherited

Writes WordCount number of 8 Bit unsigned integer words from the buffer pointed by pData to the chunk's body, directly to the actual "physical" file.

The position within the chunk will automatically be incremented. Note: you cannot write beyond the boundaries of the chunk, to append data to the chunk call Resize() before.

Parameters
pDatasource buffer (containing the data)
WordCountnumber of 8 Bit unsigned integers to write
Returns
number of written integers
Exceptions
RIFF::Exceptionif an IO error occured
See also
Resize()

Definition at line 484 of file RIFF.cpp.

Member Data Documentation

◆ ChunkID

uint32_t RIFF::Chunk::ChunkID
protectedinherited

Definition at line 245 of file RIFF.h.

Referenced by CountSubChunks(), RIFF::File::File(), and GetSubChunk().

◆ ChunksIterator

ChunkList::iterator RIFF::List::ChunksIterator
protected

Definition at line 331 of file RIFF.h.

Referenced by GetFirstSubChunk(), and GetNextSubChunk().

◆ CurrentChunkSize

uint32_t RIFF::Chunk::CurrentChunkSize
protectedinherited

Definition at line 246 of file RIFF.h.

Referenced by RIFF::File::File(), ReadHeader(), and WriteChunk().

◆ ListIterator

ChunkList::iterator RIFF::List::ListIterator
protected

Definition at line 332 of file RIFF.h.

Referenced by GetFirstSubList(), and GetNextSubList().

◆ ListType

uint32_t RIFF::List::ListType
protected

◆ NewChunkSize

uint32_t RIFF::Chunk::NewChunkSize
protectedinherited

Definition at line 247 of file RIFF.h.

Referenced by AddSubChunk(), AddSubList(), RIFF::File::File(), ReadHeader(), WriteChunk(), and WriteHeader().

◆ pChunkData

uint8_t* RIFF::Chunk::pChunkData
protectedinherited

Definition at line 252 of file RIFF.h.

◆ pFile

File* RIFF::Chunk::pFile
protectedinherited

◆ pParent

List* RIFF::Chunk::pParent
protectedinherited

Definition at line 248 of file RIFF.h.

◆ pSubChunks

◆ pSubChunksMap

ChunkMap* RIFF::List::pSubChunksMap
protected

Definition at line 330 of file RIFF.h.

Referenced by DeleteChunkList(), DeleteSubChunk(), GetSubChunk(), List(), LoadSubChunks(), and MoveSubChunk().

◆ ulChunkDataSize

unsigned long RIFF::Chunk::ulChunkDataSize
protectedinherited

Definition at line 253 of file RIFF.h.

◆ ulPos

unsigned long RIFF::Chunk::ulPos
protectedinherited

Definition at line 251 of file RIFF.h.

Referenced by LoadSubChunks(), and RIFF::File::Save().

◆ ulStartPos

unsigned long RIFF::Chunk::ulStartPos
protectedinherited

Definition at line 250 of file RIFF.h.

Referenced by RIFF::File::File(), List(), LoadSubChunks(), and WriteChunk().


The documentation for this class was generated from the following files: