libgig  4.2.0.svn17
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, file_offset_t StartPos, List *Parent)
 
String GetListTypeString () const
 Returns string representation of the lists's id.
 
uint32_t GetListType () const
 Returns unsigned integer representation of the list's ID.
 
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 (which may be an ordinary chunk as well as a list chunk). More...
 
ChunkGetNextSubChunk ()
 Returns the next subchunk within the list (which may be an ordinary chunk as well as a list chunk). 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...
 
size_t CountSubChunks ()
 Returns number of subchunks within the list (including list chunks).
 
size_t CountSubChunks (uint32_t ChunkID)
 Returns number of subchunks within the list with chunk ID ChunkId.
 
size_t CountSubLists ()
 Returns number of sublists within the list.
 
size_t CountSubLists (uint32_t ListType)
 Returns number of sublists within the list with list type ListType
 
ChunkAddSubChunk (uint32_t uiChunkID, file_offset_t ullBodySize)
 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...
 
String GetChunkIDString () const
 Returns the String representation of the chunk's ID (e.g. More...
 
uint32_t GetChunkID () const
 Chunk ID in unsigned integer representation.
 
FileGetFile () const
 Returns pointer to the chunk's File object.
 
ListGetParent () const
 Returns pointer to the chunk's parent list chunk.
 
file_offset_t GetSize () const
 Chunk size in bytes (without header, thus the chunk data body)
 
file_offset_t GetNewSize () const
 New chunk size if it was modified with Resize(), otherwise value returned will be equal to GetSize().
 
file_offset_t GetPos () const
 Position within the chunk data body (starting with 0).
 
file_offset_t GetFilePos () const
 Current, actual offset in file of current chunk data body read/write position.
 
file_offset_t SetPos (file_offset_t 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...
 
file_offset_t RemainingBytes () const
 Returns the number of bytes left to read in the chunk body. More...
 
stream_state_t GetState () const
 Returns the current state of the chunk object. More...
 
file_offset_t Read (void *pData, file_offset_t WordCount, file_offset_t WordSize)
 Reads WordCount number of data words with given WordSize and copies it into a buffer pointed by pData. More...
 
file_offset_t ReadInt8 (int8_t *pData, file_offset_t 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...
 
file_offset_t ReadUint8 (uint8_t *pData, file_offset_t 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...
 
file_offset_t ReadInt16 (int16_t *pData, file_offset_t 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...
 
file_offset_t ReadUint16 (uint16_t *pData, file_offset_t 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...
 
file_offset_t ReadInt32 (int32_t *pData, file_offset_t 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...
 
file_offset_t ReadUint32 (uint32_t *pData, file_offset_t 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...
 
file_offset_t Write (void *pData, file_offset_t WordCount, file_offset_t WordSize)
 Writes WordCount number of data words with given WordSize from the buffer pointed by pData. More...
 
file_offset_t WriteInt8 (int8_t *pData, file_offset_t 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...
 
file_offset_t WriteUint8 (uint8_t *pData, file_offset_t 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...
 
file_offset_t WriteInt16 (int16_t *pData, file_offset_t 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...
 
file_offset_t WriteUint16 (uint16_t *pData, file_offset_t 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...
 
file_offset_t WriteInt32 (int32_t *pData, file_offset_t 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...
 
file_offset_t WriteUint32 (uint32_t *pData, file_offset_t 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 (file_offset_t NewSize)
 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 (file_offset_t filePos)
 
void WriteHeader (file_offset_t filePos)
 
void LoadSubChunks (progress_t *pProgress=NULL)
 
void LoadSubChunksRecursively (progress_t *pProgress=NULL)
 
virtual file_offset_t RequiredPhysicalSize (int fileOffsetSize)
 Returns the actual total size in bytes (including List chunk header and all subchunks) of this List Chunk if being stored to a file. More...
 
virtual file_offset_t WriteChunk (file_offset_t ullWritePos, file_offset_t ullCurrentDataOffset, 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.
 
void DeleteChunkList ()
 
file_offset_t ReadSceptical (void *pData, file_offset_t WordCount, file_offset_t WordSize)
 Just an internal wrapper for the main Read() method with additional Exception throwing on errors. More...
 

Static Protected Member Functions

static String convertToString (uint32_t word)
 

Protected Attributes

uint32_t ListType
 
ChunkList * pSubChunks
 
ChunkMap * pSubChunksMap
 
ChunkList::iterator ChunksIterator
 
ChunkList::iterator ListIterator
 
uint32_t ChunkID
 
file_offset_t ullCurrentChunkSize
 
file_offset_t ullNewChunkSize
 
ListpParent
 
FilepFile
 
file_offset_t ullStartPos
 
file_offset_t ullPos
 
uint8_t * pChunkData
 
file_offset_t ullChunkDataSize
 

Detailed Description

RIFF List Chunk.

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

Definition at line 308 of file RIFF.h.

Member Function Documentation

◆ AddSubChunk()

Chunk * RIFF::List::AddSubChunk ( uint32_t  uiChunkID,
file_offset_t  ullBodySize 
)

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 ullBodySize 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
ullBodySize- size of the new chunk's body, that is its actual data size (without header)
Exceptions
RIFF::Exceptionif ullBodySize equals zero

Definition at line 1310 of file RIFF.cpp.

References RIFF::File::FileOffsetSize, and RIFF::Chunk::Resize().

Referenced by DLS::File::__ensureMandatoryChunksExist(), gig::File::AddInstrument(), gig::File::AddSample(), gig::File::RebuildSampleChecksumTable(), DLS::Sample::Resize(), DLS::Sample::UpdateChunks(), DLS::Instrument::UpdateChunks(), DLS::File::UpdateChunks(), gig::Sample::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 1380 of file RIFF.cpp.

References RIFF::File::FileOffsetSize.

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

◆ 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 1399 of file RIFF.cpp.

References RIFF::Chunk::GetChunkID().

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

◆ GetChunkIDString()

String RIFF::Chunk::GetChunkIDString ( ) const
inherited

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

"RIFF", "LIST").

Definition at line 264 of file RIFF.cpp.

◆ GetFirstSubChunk()

Chunk * RIFF::List::GetFirstSubChunk ( )

Returns the first subchunk within the list (which may be an ordinary chunk as well as a list chunk).

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 1173 of file RIFF.cpp.

Referenced by DLS::Articulation::DeleteChunks(), gig::File::DeleteGroupOnly(), 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 1208 of file RIFF.cpp.

Referenced by gig::File::DeleteInstrument(), gig::File::DeleteSample(), gig::ScriptGroup::DeleteScript(), gig::File::DeleteScriptGroup(), DLS::File::GetNextInstrument(), DLS::File::GetNextSample(), DLS::Instrument::Instrument(), and gig::Region::UpdateChunks().

◆ GetNextSubChunk()

Chunk * RIFF::List::GetNextSubChunk ( )

Returns the next subchunk within the list (which may be an ordinary chunk as well as a list chunk).

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 1190 of file RIFF.cpp.

Referenced by DLS::Articulation::DeleteChunks(), gig::File::DeleteGroupOnly(), 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 1230 of file RIFF.cpp.

Referenced by gig::File::DeleteInstrument(), gig::File::DeleteSample(), gig::ScriptGroup::DeleteScript(), gig::File::DeleteScriptGroup(), DLS::File::GetNextInstrument(), DLS::File::GetNextSample(), DLS::Instrument::Instrument(), and gig::Region::UpdateChunks().

◆ GetState()

stream_state_t RIFF::Chunk::GetState ( ) const
inherited

Returns the current state of the chunk object.

Following values are possible:

  • RIFF::stream_ready : chunk data can be read (this is the usual case)
  • RIFF::stream_closed : the data stream was closed somehow, no more reading possible
  • RIFF::stream_end_reached : already reached the end of the chunk data, no more reading possible without SetPos()

Definition at line 343 of file RIFF.cpp.

References RIFF::File::hFileRead.

◆ GetSubChunk()

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

◆ 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. If 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 1147 of file RIFF.cpp.

References GetListType().

Referenced by DLS::File::__ensureMandatoryChunksExist(), gig::Region::AddDimension(), DLS::File::AddInstrument(), gig::File::AddInstrument(), DLS::File::AddSample(), gig::File::AddSample(), DLS::Articulation::DeleteChunks(), gig::Region::DeleteDimension(), gig::Region::DeleteDimensionZone(), gig::File::DeleteGroupOnly(), gig::File::DeleteInstrument(), gig::File::DeleteSample(), gig::ScriptGroup::DeleteScript(), gig::File::DeleteScriptGroup(), DLS::File::GetNextInstrument(), gig::Instrument::GetNextRegion(), DLS::File::GetNextSample(), DLS::Info::Info(), DLS::Instrument::Instrument(), gig::Instrument::MoveTo(), gig::DimensionRegion::SetVCFVelocityScale(), gig::Region::SplitDimensionZone(), DLS::Info::UpdateChunks(), gig::Region::UpdateChunks(), gig::Instrument::UpdateChunks(), gig::Group::UpdateChunks(), gig::File::UpdateChunks(), and sf2::VerifySize().

◆ 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 865 of file RIFF.cpp.

References RIFF::File::hFileRead.

Referenced by gig::File::DeleteGroupOnly(), DLS::Sample::LoadSampleData(), gig::File::RebuildSampleChecksumTable(), gig::File::SetSampleChecksum(), DLS::Resource::UpdateChunks(), DLS::Sampler::UpdateChunks(), DLS::Sample::UpdateChunks(), DLS::Region::UpdateChunks(), DLS::Instrument::UpdateChunks(), DLS::File::UpdateChunks(), gig::DimensionRegion::UpdateChunks(), gig::Sample::UpdateChunks(), gig::Region::UpdateChunks(), gig::Instrument::UpdateChunks(), gig::File::UpdateChunks(), and gig::File::VerifySampleChecksumTable().

◆ 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 1332 of file RIFF.cpp.

Referenced by gig::Region::AddDimension(), DLS::Instrument::Instrument(), gig::Instrument::MoveTo(), gig::File::RebuildSampleChecksumTable(), 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 1347 of file RIFF.cpp.

References RIFF::Chunk::GetChunkID().

◆ Read()

file_offset_t RIFF::Chunk::Read ( void *  pData,
file_offset_t  WordCount,
file_offset_t  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 occurred

Definition at line 374 of file RIFF.cpp.

References RIFF::File::hFileRead.

Referenced by DLS::Articulation::Articulation(), DLS::Resource::CopyAssign(), gig::Region::CopyAssign(), gig::File::DeleteSample(), RIFF::File::File(), DLS::File::File(), DLS::Instrument::Instrument(), Korg::KSFSample::Read(), DLS::Sample::Read(), gig::Sample::Read(), DLS::Resource::Resource(), gig::Sample::Sample(), DLS::Sample::UpdateChunks(), and DLS::File::UpdateChunks().

◆ ReadInt16() [1/2]

file_offset_t RIFF::Chunk::ReadInt16 ( int16_t *  pData,
file_offset_t  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 occurred or less than WordCount integers could be read!

Definition at line 591 of file RIFF.cpp.

Referenced by DLS::Resource::CopyAssign(), gig::Region::CopyAssign(), gig::File::DeleteSample(), gig::ScriptGroup::DeleteScript(), gig::Sample::Sample(), and sf2::VerifySize().

◆ 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 occurred

Definition at line 784 of file RIFF.cpp.

◆ ReadInt32() [1/2]

file_offset_t RIFF::Chunk::ReadInt32 ( int32_t *  pData,
file_offset_t  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 occurred or less than WordCount integers could be read!

Definition at line 665 of file RIFF.cpp.

Referenced by DLS::Resource::CopyAssign(), gig::File::DeleteSample(), gig::ScriptGroup::DeleteScript(), gig::Sample::Sample(), and sf2::VerifySize().

◆ 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 occurred

Definition at line 818 of file RIFF.cpp.

◆ ReadInt8() [1/2]

file_offset_t RIFF::Chunk::ReadInt8 ( int8_t *  pData,
file_offset_t  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 occurred or less than WordCount integers could be read!

Definition at line 517 of file RIFF.cpp.

Referenced by Korg::KSFSample::FrameSize(), Korg::removeFileTypeExtension(), and sf2::VerifySize().

◆ 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 occurred

Definition at line 751 of file RIFF.cpp.

◆ ReadSceptical()

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

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

Definition at line 500 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 occurred or less than size characters could be read!

Definition at line 719 of file RIFF.cpp.

Referenced by gig::Region::CopyAssign(), and gig::File::DeleteSample().

◆ ReadUint16() [1/2]

file_offset_t RIFF::Chunk::ReadUint16 ( uint16_t *  pData,
file_offset_t  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 occurred or less than WordCount integers could be read!

Definition at line 628 of file RIFF.cpp.

Referenced by DLS::Resource::CopyAssign(), gig::Region::CopyAssign(), gig::ScriptGroup::DeleteScript(), DLS::Sample::UpdateChunks(), and sf2::VerifySize().

◆ 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 occurred

Definition at line 801 of file RIFF.cpp.

◆ ReadUint32() [1/2]

file_offset_t RIFF::Chunk::ReadUint32 ( uint32_t *  pData,
file_offset_t  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 occurred or less than WordCount integers could be read!

Definition at line 702 of file RIFF.cpp.

Referenced by DLS::Articulation::Articulation(), DLS::Resource::CopyAssign(), gig::Region::CopyAssign(), gig::ScriptGroup::DeleteScript(), DLS::File::File(), DLS::Instrument::Instrument(), Korg::removeFileTypeExtension(), gig::DimensionRegion::SetVCFVelocityScale(), and DLS::Sample::UpdateChunks().

◆ 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 occurred

Definition at line 835 of file RIFF.cpp.

◆ ReadUint8() [1/2]

file_offset_t RIFF::Chunk::ReadUint8 ( uint8_t *  pData,
file_offset_t  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 occurred or less than WordCount integers could be read!

Definition at line 554 of file RIFF.cpp.

Referenced by gig::Region::CopyAssign(), gig::ScriptGroup::DeleteScript(), Korg::KSFSample::FrameSize(), Korg::removeFileTypeExtension(), gig::DimensionRegion::SetVCFVelocityScale(), 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 occurred

Definition at line 767 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 911 of file RIFF.cpp.

Referenced by DLS::Sample::ReleaseSampleData(), and DLS::Sample::~Sample().

◆ RemainingBytes()

file_offset_t RIFF::Chunk::RemainingBytes ( ) const
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 312 of file RIFF.cpp.

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

◆ RequiredPhysicalSize()

file_offset_t RIFF::List::RequiredPhysicalSize ( int  fileOffsetSize)
protectedvirtual

Returns the actual total size in bytes (including List chunk header and all subchunks) of this List Chunk if being stored to a file.

Parameters
fileOffsetSize- RIFF file offset size (in bytes) assumed when being saved to a file

Reimplemented from RIFF::Chunk.

Definition at line 1424 of file RIFF.cpp.

References RIFF::File::FileOffsetSize, RIFF::Chunk::GetSize(), RIFF::File::hFileRead, and RIFF::File::hFileWrite.

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

◆ Resize()

void RIFF::Chunk::Resize ( file_offset_t  NewSize)
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
NewSize- new chunk body size in bytes (must be greater than zero)
Exceptions
RIFF::Exceptionif NewSize is less than 1 or unrealistic large
See also
File::Save()

Definition at line 936 of file RIFF.cpp.

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

◆ SetPos()

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

◆ Write()

file_offset_t RIFF::Chunk::Write ( void *  pData,
file_offset_t  WordCount,
file_offset_t  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 occurred
See also
Resize()

Definition at line 444 of file RIFF.cpp.

References RIFF::File::hFileWrite.

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

◆ WriteChunk()

file_offset_t RIFF::List::WriteChunk ( file_offset_t  ullWritePos,
file_offset_t  ullCurrentDataOffset,
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
ullWritePos- position within the "physical" file where this list chunk should be written to
ullCurrentDataOffset- 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 ullWritePos incremented by this list chunk's new size (including its header size of course)

Reimplemented from RIFF::Chunk.

Definition at line 1553 of file RIFF.cpp.

References RIFF::File::FileOffsetSize.

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

◆ WriteInt16()

file_offset_t RIFF::Chunk::WriteInt16 ( int16_t *  pData,
file_offset_t  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 occurred
See also
Resize()

Definition at line 612 of file RIFF.cpp.

◆ WriteInt32()

file_offset_t RIFF::Chunk::WriteInt32 ( int32_t *  pData,
file_offset_t  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 occurred
See also
Resize()

Definition at line 686 of file RIFF.cpp.

◆ WriteInt8()

file_offset_t RIFF::Chunk::WriteInt8 ( int8_t *  pData,
file_offset_t  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 occurred
See also
Resize()

Definition at line 538 of file RIFF.cpp.

◆ WriteUint16()

file_offset_t RIFF::Chunk::WriteUint16 ( uint16_t *  pData,
file_offset_t  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 occurred
See also
Resize()

Definition at line 649 of file RIFF.cpp.

◆ WriteUint32()

file_offset_t RIFF::Chunk::WriteUint32 ( uint32_t *  pData,
file_offset_t  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 occurred
See also
Resize()

Definition at line 740 of file RIFF.cpp.

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

◆ WriteUint8()

file_offset_t RIFF::Chunk::WriteUint8 ( uint8_t *  pData,
file_offset_t  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 occurred
See also
Resize()

Definition at line 575 of file RIFF.cpp.


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