#include <RIFF.h>

Inheritance diagram for RIFF::File:

Public Types
typedef int	Handle
	OS dependent type serving as file handle / descriptor for OS dependent file I/O operations.

Public Member Functions
	File (uint32_t FileType)
	Create new RIFF file. More...

	File (const String &path)
	Load existing RIFF file. More...

	File (const String &path, uint32_t FileType, endian_t Endian, layout_t layout, offset_size_t fileOffsetSize=offset_size_auto)
	Load existing RIFF-like file. More...

stream_mode_t	GetMode () const
	Returns the file I/O mode currently being available for the calling thread for this RIFF file (either ro, rw or closed). More...

bool	SetMode (stream_mode_t NewMode)
	Change file access mode. More...

void	SetByteOrder (endian_t Endian)
	Set the byte order to be used when saving. More...

String	GetFileName () const

void	SetFileName (const String &path)

Handle	FileHandle () const
	Returns the OS dependent file I/O read handle intended to be used by the calling thread. More...

bool	IsNew () const
	Returns `true` if this file has been created new from scratch and has not been stored to disk yet.

layout_t	GetLayout () const

file_offset_t	GetCurrentFileSize () const
	Returns the current size of this file (in bytes) as it is currently yet stored on disk. More...

file_offset_t	GetRequiredFileSize ()
	Returns the required size (in bytes) for this RIFF File to be saved to disk. More...

file_offset_t	GetRequiredFileSize (offset_size_t fileOffsetSize)
	Returns the rquired size (in bytes) for this RIFF file to be saved to disk, assuming the passed fileOffsestSize would be used for the Save() operation. More...

int	GetFileOffsetSize () const
	Returns the current size (in bytes) of file offsets stored in the headers of all chunks of this file. More...

int	GetRequiredFileOffsetSize ()
	Returns the required size (in bytes) of file offsets stored in the headers of all chunks of this file if the current RIFF tree would be saved to disk by calling Save(). More...

bool	IsIOPerThread () const
	Whether file streams are independent for each thread. More...

void	SetIOPerThread (bool enable)
	Enable/disable file streams being independent for each thread. More...

virtual void	Save (progress_t *pProgress=NULL)
	Save changes to same file. More...

virtual void	Save (const String &path, progress_t *pProgress=NULL)
	Save changes to another file. More...

String	GetListTypeString () const
	Returns string representation of the lists's id.

uint32_t	GetListType () const
	Returns unsigned integer representation of the list's ID.

Chunk *	GetSubChunkAt (size_t pos)
	Returns subchunk at supplied pos position within this chunk list. More...

Chunk *	GetSubChunk (uint32_t ChunkID)
	Returns subchunk with chunk ID ChunkID within this chunk list. More...

List *	GetSubListAt (size_t pos)
	Returns sublist chunk with list type ListType at supplied pos position among all subchunks of type ListType within this chunk list. More...

List *	GetSubList (uint32_t ListType)
	Returns sublist chunk with list type ListType within this chunk list. More...

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

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

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

List *	GetNextSubList ()
	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

Chunk *	AddSubChunk (uint32_t uiChunkID, file_offset_t ullBodySize)
	Creates a new sub chunk. More...

List *	AddSubList (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.

File *	GetFile () const
	Returns pointer to the chunk's File object.

List *	GetParent () 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
	Current read/write position within the chunk data body (starting with 0). More...

file_offset_t	GetFilePos () const
	Current, actual offset in file of current chunk data body read/write position. More...

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::vector< Chunk * >	ChunkList

typedef std::set< Chunk * >	ChunkSet

Protected Member Functions
Handle	FileWriteHandle () const
	Returns the OS dependent file I/O write handle intended to be used by the calling thread. More...

HandlePair	FileHandlePair () const
	Returns the OS dependent file I/O read and write handles intended to be used by the calling thread. More...

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
RIFF::File::IO	io

String	Filename

bool	bEndianNative

bool	bIsNewFile

layout_t	Layout
	An ordinary RIFF file is always set to layout_standard.

offset_size_t	FileOffsetPreference

int	FileOffsetSize
	Size of file offsets (in bytes) when this file was opened (or saved the last time).

uint32_t	ListType

ChunkList *	pSubChunks

ChunkMap *	pSubChunksMap

ChunkList::iterator	ChunksIterator

ChunkList::iterator	ListIterator

uint32_t	ChunkID

file_offset_t	ullCurrentChunkSize

file_offset_t	ullNewChunkSize

List *	pParent

File *	pFile

file_offset_t	ullStartPos

uint8_t *	pChunkData

file_offset_t	ullChunkDataSize

struct RIFF::Chunk::ChunkPos	chunkPos

Detailed Description

RIFF File.

Handles arbitrary RIFF files and provides together with its base classes convenient methods to walk through, read and modify the file's RIFF tree.

Definition at line 313 of file RIFF.h.

Constructor & Destructor Documentation

◆ File() [1/3]

RIFF::File::File ( uint32_t FileType )

Create new RIFF file.

Use this constructor if you want to create a new RIFF file completely "from scratch". Note: there must be no empty chunks or empty list chunks when trying to make the new RIFF file persistent with Save()!

Note: by default, the RIFF file will be saved in native endian format; that is, as a RIFF file on little-endian machines and as a RIFX file on big-endian. To change this behaviour, call SetByteOrder() before calling Save().

Parameters

FileType - four-byte identifier of the RIFF file type

See also: AddSubChunk(), AddSubList(), SetByteOrder()

Definition at line 1793 of file RIFF.cpp.

References FileOffsetSize.

◆ File() [2/3]

RIFF::File::File ( const String & path )

Load existing RIFF file.

Loads an existing RIFF file with all its chunks.

Parameters

path	- path and file name of the RIFF file to open

Exceptions

RIFF::Exception if error occurred while trying to load the given RIFF file

Definition at line 1818 of file RIFF.cpp.

References FileOffsetSize.

◆ File() [3/3]

RIFF::File::File	(	const String &	path,
		uint32_t	FileType,
		endian_t	Endian,
		layout_t	layout,
		offset_size_t	fileOffsetSize = `offset_size_auto`
	)

Load existing RIFF-like file.

Loads an existing file, which is not a "real" RIFF file, but similar to an ordinary RIFF file.

A "real" RIFF file contains at top level a List chunk either with chunk ID "RIFF" or "RIFX". The simple constructor above expects this to be case, and if it finds the toplevel List chunk to have another chunk ID than one of those two expected ones, it would throw an Exception and would refuse to load the file accordingly.

Since there are however a lot of file formats which use the same simple principles of the RIFF format, with another toplevel List chunk ID though, you can use this alternative constructor here to be able to load and handle those files in the same way as you would do with "real" RIFF files.

Parameters

path	- path and file name of the RIFF-alike file to be opened
FileType	- expected toplevel List chunk ID (this is the very first chunk found in the file)
Endian	- whether the file uses little endian or big endian layout
layout	- general file structure type
fileOffsetSize	- (optional) preference how to deal with large files

Exceptions

RIFF::Exception if error occurred while trying to load the given RIFF-alike file

Definition at line 1865 of file RIFF.cpp.

References FileOffsetSize, GetCurrentFileSize(), Layout, RIFF::layout_flat, RIFF::layout_standard, RIFF::offset_size_64bit, RIFF::Chunk::Read(), SetByteOrder(), and RIFF::Chunk::SetPos().

Member Function Documentation

◆ AddSubChunk()

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

inherited

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::Exception if ullBodySize equals zero

Definition at line 1458 of file RIFF.cpp.

References 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 )

inherited

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

References FileOffsetSize.

Referenced by DLS::File::__ensureMandatoryChunksExist(), gig::Region::AddDimension(), DLS::File::AddInstrument(), gig::File::AddInstrument(), DLS::File::AddSample(), gig::File::AddSample(), gig::Region::DeleteDimensionZone(), DLS::Instrument::GetNextRegion(), gig::Instrument::GetNextRegion(), 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 )

inherited

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 1556 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().

◆ FileHandle()

File::Handle RIFF::File::FileHandle ( ) const

Returns the OS dependent file I/O read handle intended to be used by the calling thread.

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 2015 of file RIFF.cpp.

References FileHandlePair().

Referenced by GetCurrentFileSize(), RIFF::Chunk::GetState(), RIFF::Chunk::LoadChunkData(), RIFF::Chunk::Read(), RIFF::List::RequiredPhysicalSize(), and RIFF::progress_t::subdivide().

◆ FileHandlePair()

File::HandlePair RIFF::File::FileHandlePair ( ) const

protected

Returns the OS dependent file I/O read and write handles intended to be used by the calling thread.

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 1989 of file RIFF.cpp.

Referenced by FileHandle(), FileWriteHandle(), GetMode(), Save(), RIFF::Chunk::Write(), and RIFF::Chunk::WriteChunk().

◆ FileWriteHandle()

File::Handle RIFF::File::FileWriteHandle ( ) const

protected

Returns the OS dependent file I/O write handle intended to be used by the calling thread.

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 2025 of file RIFF.cpp.

References FileHandlePair().

Referenced by RIFF::List::RequiredPhysicalSize(), Save(), and RIFF::progress_t::subdivide().

◆ GetChunkIDString()

String RIFF::Chunk::GetChunkIDString ( ) const

inherited

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

"RIFF", "LIST").

Definition at line 288 of file RIFF.cpp.

References IsIOPerThread().

◆ GetCurrentFileSize()

file_offset_t RIFF::File::GetCurrentFileSize ( ) const

Returns the current size of this file (in bytes) as it is currently yet stored on disk.

If this file does not yet exist on disk (i.e. when this RIFF File has just been created from scratch and Save() has not been called yet) then this method returns 0.

Definition at line 2461 of file RIFF.cpp.

References FileHandle().

Referenced by File(), GetRequiredFileOffsetSize(), gig::Region::GetSample(), and Save().

◆ GetFileOffsetSize()

int RIFF::File::GetFileOffsetSize ( ) const

Returns the current size (in bytes) of file offsets stored in the headers of all chunks of this file.

Most RIFF files are using 32 bit file offsets internally, which limits them to a maximum file size of less than 4 GB though. In contrast to the common standard, this RIFF File class implementation supports handling of RIFF files equal or larger than 4 GB. In such cases 64 bit file offsets have to be used in all headers of all RIFF Chunks when being stored to a physical file. libgig by default automatically selects the correct file offset size for you. You may however also force one particular file offset size by supplying the respective option to the RIFF::File constructor.

This method can be used to check which RIFF file offset size is currently being used for this RIFF File.

Returns: current RIFF file offset size used (in bytes)

See also: offset_size_t

Definition at line 2555 of file RIFF.cpp.

References FileOffsetSize.

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

◆ GetFilePos()

file_offset_t RIFF::Chunk::GetFilePos ( ) const

inherited

Current, actual offset in file of current chunk data body read/write position.

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 324 of file RIFF.cpp.

Referenced by DLS::File::__ensureMandatoryChunksExist(), gig::Instrument::DeleteMidiRule(), gig::File::DeleteSample(), and DLS::File::GetNextSample().

◆ GetFirstSubChunk()

Chunk * RIFF::List::GetFirstSubChunk ( )

inherited

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

Deprecated:: This method is not reentrant-safe, use GetSubChunkAt() instead.

Definition at line 1315 of file RIFF.cpp.

◆ GetFirstSubList()

List * RIFF::List::GetFirstSubList ( )

inherited

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

Deprecated:: This method is not reentrant-safe, use GetSubListAt() instead.

Definition at line 1354 of file RIFF.cpp.

◆ GetMode()

stream_mode_t RIFF::File::GetMode ( ) const

Returns the file I/O mode currently being available for the calling thread for this RIFF file (either ro, rw or closed).

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 2035 of file RIFF.cpp.

References FileHandlePair(), and Layout.

Referenced by RIFF::List::WriteChunk().

◆ GetNextSubChunk()

Chunk * RIFF::List::GetNextSubChunk ( )

inherited

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

Deprecated:: This method is not reentrant-safe, use GetSubChunkAt() instead.

Definition at line 1334 of file RIFF.cpp.

◆ GetNextSubList()

List * RIFF::List::GetNextSubList ( )

inherited

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

Deprecated:: This method is not reentrant-safe, use GetSubListAt() instead.

Definition at line 1378 of file RIFF.cpp.

◆ GetPos()

file_offset_t RIFF::Chunk::GetPos ( ) const

inherited

Current read/write position within the chunk data body (starting with 0).

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 311 of file RIFF.cpp.

References IsIOPerThread().

Referenced by DLS::File::__ensureMandatoryChunksExist(), DLS::Sample::CopyAssign(), gig::Region::CopyAssign(), gig::Instrument::DeleteMidiRule(), gig::File::DeleteSample(), gig::ScriptGroup::DeleteScript(), DLS::File::GetNextSample(), Korg::KSFSample::GetPos(), gig::Sample::GetPos(), gig::Sample::UpdateChunks(), sf2::VerifySize(), and gig::Sample::Write().

◆ GetRequiredFileOffsetSize()

int RIFF::File::GetRequiredFileOffsetSize ( )

Returns the required size (in bytes) of file offsets stored in the headers of all chunks of this file if the current RIFF tree would be saved to disk by calling Save().

See GetFileOffsetSize() for mor details about RIFF file offsets.

Returns: RIFF file offset size required (in bytes) if being saved

See also: offset_size_t

Definition at line 2569 of file RIFF.cpp.

References GetCurrentFileSize().

◆ GetRequiredFileSize() [1/2]

file_offset_t RIFF::File::GetRequiredFileSize ( )

Returns the required size (in bytes) for this RIFF File to be saved to disk.

The precise size of the final file on disk depends on the RIFF file offset size actually used internally in all headers of the RIFF chunks. By default libgig handles the required file offset size automatically for you; that means it is using 32 bit offsets for files smaller than 4 GB and 64 bit offsets for files equal or larger than 4 GB. You may however also override this default behavior by passing the respective option to the RIFF File constructor to force one particular offset size. In the latter case this method will return the file size for the requested forced file offset size that will be used when calling Save() later on.

You may also use the overridden method below to get the file size for an arbitrary other file offset size instead.

See also: offset_size_t; GetFileOffsetSize()

Definition at line 2491 of file RIFF.cpp.

Referenced by GetRequiredFileSize(), Save(), and DLS::File::UpdateChunks().

◆ GetRequiredFileSize() [2/2]

file_offset_t RIFF::File::GetRequiredFileSize ( offset_size_t fileOffsetSize )

Returns the rquired size (in bytes) for this RIFF file to be saved to disk, assuming the passed fileOffsestSize would be used for the Save() operation.

This overridden method essentialy behaves like the above method, with the difference that you must provide a specific RIFF fileOffsetSize for calculating the theoretical final file size.

See also: GetFileOffsetSize()

Definition at line 2506 of file RIFF.cpp.

References FileOffsetSize, GetRequiredFileSize(), RIFF::offset_size_32bit, RIFF::offset_size_64bit, RIFF::offset_size_auto, and RIFF::List::RequiredPhysicalSize().

◆ 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()

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 410 of file RIFF.cpp.

References FileHandle().

◆ GetSubChunk()

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

inherited

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

Referenced by DLS::File::__ensureMandatoryChunksExist(), DLS::Resource::CopyAssign(), gig::Script::CopyAssign(), gig::File::DeleteSample(), gig::ScriptGroup::DeleteScript(), DLS::File::File(), Korg::KSFSample::FrameSize(), Korg::KSFSample::GetPos(), DLS::Instrument::Instrument(), Korg::KSFSample::Read(), gig::File::RebuildSampleChecksumTable(), Korg::removeFileTypeExtension(), DLS::Sample::Resize(), DLS::Resource::Resource(), DLS::Sample::Sample(), gig::Sample::Sample(), DLS::Info::SetFixedStringLengths(), Korg::KSFSample::SetPos(), gig::File::SetSampleChecksum(), gig::DimensionRegion::SetVCFVelocityScale(), DLS::Sample::UpdateChunks(), DLS::Instrument::UpdateChunks(), DLS::File::UpdateChunks(), gig::Sample::UpdateChunks(), gig::Instrument::UpdateChunks(), gig::Group::UpdateChunks(), gig::File::UpdateChunks(), gig::File::VerifySampleChecksumTable(), and sf2::VerifySize().

◆ GetSubChunkAt()

Chunk * RIFF::List::GetSubChunkAt ( size_t pos )

inherited

Returns subchunk at supplied pos position within this chunk list.

If supplied pos is out of bounds then NULL is returned. The returned subchunk can either by an ordinary data chunk or a list chunk.

Parameters

pos	- position of sought subchunk within this list

Returns: pointer to the subchunk or NULL if supplied position is not within the valid range of this list

Definition at line 1229 of file RIFF.cpp.

Referenced by gig::File::DeleteGroupOnly(), DLS::Articulator::GetNextArticulation(), gig::Group::UpdateChunks(), and gig::File::UpdateChunks().

◆ GetSubList()

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

inherited

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

References RIFF::List::GetListType().

Referenced by DLS::File::__ensureMandatoryChunksExist(), gig::Region::AddDimension(), DLS::File::AddInstrument(), gig::File::AddInstrument(), DLS::File::AddSample(), gig::File::AddSample(), gig::Region::DeleteDimension(), gig::Region::DeleteDimensionZone(), gig::File::DeleteGroupOnly(), gig::File::DeleteInstrument(), gig::File::DeleteSample(), gig::ScriptGroup::DeleteScript(), gig::File::DeleteScriptGroup(), DLS::Articulator::GetNextArticulation(), DLS::File::GetNextInstrument(), DLS::Instrument::GetNextRegion(), gig::Instrument::GetNextRegion(), DLS::File::GetNextSample(), DLS::Info::Info(), 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().

◆ GetSubListAt()

List * RIFF::List::GetSubListAt ( size_t pos )

inherited

Returns sublist chunk with list type ListType at supplied pos position among all subchunks of type ListType within this chunk list.

If supplied pos is out of bounds then NULL is returned.

Parameters

pos	- position of sought sublist within this list

Returns: pointer to the sublist or NULL if if supplied position is not within valid range

Definition at line 1264 of file RIFF.cpp.

References RIFF::Chunk::GetChunkID().

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

◆ IsIOPerThread()

bool RIFF::File::IsIOPerThread ( ) const

Whether file streams are independent for each thread.

All file I/O operations like reading from a RIFF chunk body (e.g. by calling Chunk::Read(), Chunk::ReadInt8()), writing to a RIFF chunk body (e.g. by calling Chunk::Write(), Chunk::WriteInt8()) or saving the current RIFF tree structure to some file (e.g. by calling Save()) operate on a file I/O stream state, i.e. there is a "current" file read/write position and reading/writing by a certain amount of bytes automatically advances that "current" file position.

By default there is only one stream state for a RIFF::File object, which is not an issue as long as only one thread is using the RIFF::File object at a time (which might also be the case in a collaborative / coroutine multi-threaded scenario).

If however a RIFF::File object is read/written simultaniously by multiple threads this can lead to undefined behaviour as the individual threads would concurrently alter the file stream position. For such a concurrent multithreaded file I/O scenario SetIOPerThread(true) might be enabled which causes each thread to automatically use its own file stream state.

Returns: true if each thread has its own file stream state (default: false)

See also: SetIOPerThread()

Definition at line 2599 of file RIFF.cpp.

Referenced by RIFF::Chunk::GetChunkIDString(), RIFF::Chunk::GetPos(), and IsNew().

◆ 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

Exception if data buffer could not be enlarged

See also: ReleaseChunkData(); File::IsIOPerThread() for multi-threaded streaming

Definition at line 960 of file RIFF.cpp.

References FileHandle().

Referenced by 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
	)

inherited

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

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

◆ MoveSubChunk() [2/2]

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

inherited

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 1501 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

pData	destination buffer
WordCount	number of data words to read
WordSize	size of each data word to read

Returns: number of successfully read data words or 0 if end of file reached or error occurred

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 441 of file RIFF.cpp.

References FileHandle().

Referenced by DLS::Articulation::Articulation(), DLS::Resource::CopyAssign(), gig::Region::CopyAssign(), gig::File::DeleteSample(), 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

pData	destination buffer
WordCount	number of 16 Bit signed integers to read

Returns: number of read integers

Exceptions

RIFF::Exception if an error occurred or less than WordCount integers could be read!

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 671 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::Exception if an error occurred

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 875 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

pData	destination buffer
WordCount	number of 32 Bit signed integers to read

Returns: number of read integers

Exceptions

RIFF::Exception if an error occurred or less than WordCount integers could be read!

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 749 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::Exception if an error occurred

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 911 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

pData	destination buffer
WordCount	number of 8 Bit signed integers to read

Returns: number of read integers

Exceptions

RIFF::Exception if an error occurred or less than WordCount integers could be read!

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 593 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::Exception if an error occurred

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 840 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 575 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

s	destination string
size	number of characters to read

Exceptions

RIFF::Exception if an error occurred or less than size characters could be read!

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 806 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

pData	destination buffer
WordCount	number of 8 Bit unsigned integers to read

Returns: number of read integers

Exceptions

RIFF::Exception if an error occurred or less than WordCount integers could be read!

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 710 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::Exception if an error occurred

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 893 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

pData	destination buffer
WordCount	number of 32 Bit unsigned integers to read

Returns: number of read integers

Exceptions

RIFF::Exception if an error occurred or less than WordCount integers could be read!

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 788 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::Exception if an error occurred

See also: File::IsIOPerThread() for multi-threaded streamings

Definition at line 929 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

pData	destination buffer
WordCount	number of 8 Bit unsigned integers to read

Returns: number of read integers

Exceptions

RIFF::Exception if an error occurred or less than WordCount integers could be read!

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 632 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::Exception if an error occurred

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 857 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 1009 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

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 376 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 )

protectedvirtualinherited

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

References FileHandle(), FileOffsetSize, FileWriteHandle(), and RIFF::Chunk::GetSize().

Referenced by 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::Exception if NewSize is less than 1 or unrealistic large

See also: File::Save()

Definition at line 1034 of file RIFF.cpp.

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

◆ Save() [1/2]

void RIFF::File::Save ( progress_t * pProgress = NULL )

virtual

Save changes to same file.

Make all changes of all chunks persistent by writing them to the actual (same) file.

Parameters

pProgress - optional: callback function for progress notification

Exceptions

RIFF::Exception if there is an empty chunk or empty list chunk or any kind of IO error occurred

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 2185 of file RIFF.cpp.

References FileHandlePair(), FileOffsetSize, GetCurrentFileSize(), GetRequiredFileSize(), Layout, RIFF::layout_flat, SetMode(), and RIFF::List::WriteChunk().

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

◆ Save() [2/2]

void RIFF::File::Save	(	const String &	path,
		progress_t *	pProgress = `NULL`
	)

virtual

Save changes to another file.

Make all changes of all chunks persistent by writing them to another file. Caution: this method is optimized for writing to another file, do not use it to save the changes to the same file! Use File::Save() in that case instead! Ignoring this might result in a corrupted file, especially in case chunks were resized!

After calling this method, this File object will be associated with the new file (given by path) afterwards.

Parameters

path	- path and file name where everything should be written to
pProgress	- optional: callback function for progress notification

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 2314 of file RIFF.cpp.

References FileOffsetSize, FileWriteHandle(), GetRequiredFileSize(), Layout, RIFF::layout_flat, SetMode(), and RIFF::List::WriteChunk().

◆ SetByteOrder()

void RIFF::File::SetByteOrder ( endian_t Endian )

Set the byte order to be used when saving.

Set the byte order to be used in the file. A value of endian_little will create a RIFF file, endian_big a RIFX file and endian_native will create a RIFF file on little-endian machines and RIFX on big-endian machines.

Parameters

Endian - endianess to use when file is saved.

Definition at line 2167 of file RIFF.cpp.

Referenced by File(), and DLS::File::File().

◆ SetIOPerThread()

void RIFF::File::SetIOPerThread ( bool enable )

Enable/disable file streams being independent for each thread.

By enabling this feature (default off) each thread will automatically use its own file I/O stream state for allowing simultanious multi-threaded file read/write operations.

NOTE: After having enabled this feature, the individual threads must at least once check GetState() and if their file I/O stream is yet closed they must call SetMode() (i.e. once) respectively to open their own file handles before being able to use any of the Read() or Write() methods.

Parameters

enable - true: one independent stream state per thread, false: only one stream in total shared by all threads

See also: IsIOPerThread() for more details about this feature

Definition at line 2628 of file RIFF.cpp.

◆ SetMode()

bool RIFF::File::SetMode ( stream_mode_t NewMode )

Change file access mode.

Changes files access mode either to read-only mode or to read/write mode.

Parameters

NewMode - new file access mode

Returns: true if mode was changed, false if current mode already equals new mode

Exceptions

RIFF::Exception if file could not be opened in requested file access mode or if passed access mode is unknown

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 2055 of file RIFF.cpp.

References RIFF::List::__resetPos().

Referenced by gig::File::RebuildSampleChecksumTable(), and Save().

◆ SetPos()

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

inherited

Sets the position within the chunk body, thus within the data portion of the chunk (in bytes).

Caution: the position will be reset to zero whenever File::Save() was called.

Parameters

Where	- position offset (in bytes)
Whence	- optional: defines to what Where relates to, if omitted Where relates to beginning of the chunk data

See also: File::IsIOPerThread() for multi-threaded streaming

Definition at line 341 of file RIFF.cpp.

Referenced by DLS::File::__ensureMandatoryChunksExist(), DLS::Articulation::Articulation(), DLS::Resource::CopyAssign(), DLS::Sample::CopyAssign(), gig::Region::CopyAssign(), gig::File::DeleteSample(), gig::ScriptGroup::DeleteScript(), File(), DLS::File::File(), DLS::Instrument::Instrument(), gig::Sample::Read(), DLS::Resource::Resource(), DLS::Sample::Sample(), gig::Sample::Sample(), Korg::KSFSample::SetPos(), DLS::Sample::SetPos(), gig::Sample::SetPos(), gig::File::SetSampleChecksum(), gig::DimensionRegion::SetVCFVelocityScale(), DLS::Sample::UpdateChunks(), gig::Sample::UpdateChunks(), gig::Instrument::UpdateChunks(), and sf2::VerifySize().

◆ 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

pData	source buffer (containing the data)
WordCount	number of data words to write
WordSize	size of each data word to write

Returns: number of successfully written data words

Exceptions

RIFF::Exception if write operation would exceed current chunk size or any IO error occurred

See also: Resize(); File::IsIOPerThread() for multi-threaded streaming

Definition at line 517 of file RIFF.cpp.

References FileHandlePair().

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`
	)

protectedvirtualinherited

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

References FileOffsetSize, and GetMode().

Referenced by 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

pData	source buffer (containing the data)
WordCount	number of 16 Bit signed integers to write

Returns: number of written integers

Exceptions

RIFF::Exception if an IO error occurred

See also: Resize(); File::IsIOPerThread() for multi-threaded streaming

Definition at line 693 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

pData	source buffer (containing the data)
WordCount	number of 32 Bit signed integers to write

Returns: number of written integers

Exceptions

RIFF::Exception if an IO error occurred

See also: Resize(); File::IsIOPerThread() for multi-threaded streaming

Definition at line 771 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

pData	source buffer (containing the data)
WordCount	number of 8 Bit signed integers to write

Returns: number of written integers

Exceptions

RIFF::Exception if an IO error occurred

See also: Resize(); File::IsIOPerThread() for multi-threaded streaming

Definition at line 615 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

pData	source buffer (containing the data)
WordCount	number of 16 Bit unsigned integers to write

Returns: number of written integers

Exceptions

RIFF::Exception if an IO error occurred

See also: Resize(); File::IsIOPerThread() for multi-threaded streaming

Definition at line 732 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

pData	source buffer (containing the data)
WordCount	number of 32 Bit unsigned integers to write

Returns: number of written integers

Exceptions

RIFF::Exception if an IO error occurred

See also: Resize(); File::IsIOPerThread() for multi-threaded streaming

Definition at line 828 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

pData	source buffer (containing the data)
WordCount	number of 8 Bit unsigned integers to write

Returns: number of written integers

Exceptions

RIFF::Exception if an IO error occurred

See also: Resize(); File::IsIOPerThread() for multi-threaded streaming

Definition at line 654 of file RIFF.cpp.

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

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ File() [1/3]

◆ File() [2/3]

◆ File() [3/3]

Member Function Documentation

◆ AddSubChunk()

◆ AddSubList()

◆ DeleteSubChunk()

◆ FileHandle()

◆ FileHandlePair()

◆ FileWriteHandle()

◆ GetChunkIDString()

◆ GetCurrentFileSize()

◆ GetFileOffsetSize()

◆ GetFilePos()

◆ GetFirstSubChunk()

◆ GetFirstSubList()

◆ GetMode()

◆ GetNextSubChunk()

◆ GetNextSubList()

◆ GetPos()

◆ GetRequiredFileOffsetSize()

◆ GetRequiredFileSize() [1/2]

◆ GetRequiredFileSize() [2/2]

◆ GetState()

◆ GetSubChunk()

◆ GetSubChunkAt()

◆ GetSubList()

◆ GetSubListAt()

◆ IsIOPerThread()

◆ LoadChunkData()

◆ MoveSubChunk() [1/2]

◆ MoveSubChunk() [2/2]

◆ Read()

◆ ReadInt16() [1/2]

◆ ReadInt16() [2/2]

◆ ReadInt32() [1/2]

◆ ReadInt32() [2/2]

◆ ReadInt8() [1/2]

◆ ReadInt8() [2/2]

◆ ReadSceptical()

◆ ReadString()

◆ ReadUint16() [1/2]

◆ ReadUint16() [2/2]

◆ ReadUint32() [1/2]

◆ ReadUint32() [2/2]

◆ ReadUint8() [1/2]

◆ ReadUint8() [2/2]

◆ ReleaseChunkData()

◆ RemainingBytes()

◆ RequiredPhysicalSize()

◆ Resize()

◆ Save() [1/2]

◆ Save() [2/2]

◆ SetByteOrder()

◆ SetIOPerThread()

◆ SetMode()

◆ SetPos()

◆ Write()

◆ WriteChunk()

◆ WriteInt16()

◆ WriteInt32()

◆ WriteInt8()

◆ WriteUint16()

◆ WriteUint32()

◆ WriteUint8()