DLS::File

DLS::File Class Reference

Parses DLS Level 1 and 2 compliant files and provides abstract access to the data. More...

#include <DLS.h>

Inheritance diagram for DLS::File:


Public Member Functions
	File ()
	Constructor.
	File (RIFF::File *pRIFF)
	Constructor.
Sample *	GetFirstSample ()
	Returns a pointer to the first Sample object of the file, NULL otherwise.
Sample *	GetNextSample ()
	Returns a pointer to the next Sample object of the file, NULL otherwise.
Sample *	AddSample ()
	Add a new sample.
void	DeleteSample (Sample *pSample)
	Delete a sample.
Instrument *	GetFirstInstrument ()
	Returns a pointer to the first Instrument object of the file, NULL otherwise.
Instrument *	GetNextInstrument ()
	Returns a pointer to the next Instrument object of the file, NULL otherwise.
Instrument *	AddInstrument ()
	Add a new instrument definition.
void	DeleteInstrument (Instrument *pInstrument)
	Delete an instrument.
virtual void	UpdateChunks ()
	Apply all the DLS file's current instruments, samples and settings to the respective RIFF chunks.
virtual void	Save (const String &Path)
	Save changes to another file.
virtual void	Save ()
	Save changes to same file.
virtual	~File ()
Resource *	GetParent ()
void	GenerateDLSID ()
	Generates a new DLSID for the resource.
Public Attributes
version_t *	pVersion
	Points to a version_t structure if the file provided a version number else is set to NULL.
uint32_t	Instruments
	Reflects the number of available Instrument objects.
Info *	pInfo
	Points (in any case) to an Info object, providing additional, optional infos and comments.
dlsid_t *	pDLSID
	Points to a dlsid_t structure if the file provided a DLS ID else is NULL.
Protected Types
typedef std::list< Sample * >	SampleList
typedef std::list< Instrument * >	InstrumentList
Protected Member Functions
virtual void	LoadSamples ()
virtual void	LoadInstruments ()
void	__ensureMandatoryChunksExist ()
	Checks if all (for DLS) mandatory chunks exist, if not they will be created.
Protected Attributes
RIFF::File *	pRIFF
std::list< RIFF::File * >	ExtensionFiles
SampleList *	pSamples
SampleList::iterator	SamplesIterator
InstrumentList *	pInstruments
InstrumentList::iterator	InstrumentsIterator
uint32_t	WavePoolHeaderSize
uint32_t	WavePoolCount
uint32_t *	pWavePoolTable
uint32_t *	pWavePoolTableHi
bool	b64BitWavePoolOffsets
Resource *	pParent
RIFF::List *	pResourceList
Friends
class	Region

Detailed Description

Parses DLS Level 1 and 2 compliant files and provides abstract access to the data.

Definition at line 466 of file DLS.h.

Member Typedef Documentation

typedef std::list<Sample*> DLS::File::SampleList [protected]

Definition at line 486 of file DLS.h.

typedef std::list<Instrument*> DLS::File::InstrumentList [protected]

Definition at line 487 of file DLS.h.

Constructor & Destructor Documentation

DLS::File::File ( )

Constructor.

Default constructor, use this to create an empty DLS file. You have to add samples, instruments and finally call Save() to actually write a DLS file.

Reimplemented in gig::File.

Definition at line 1193 of file DLS.cpp.

References b64BitWavePoolOffsets, DLS::version_t::build, RIFF::endian_little, Instruments, DLS::version_t::major, DLS::version_t::minor, pInstruments, pRIFF, pSamples, pVersion, pWavePoolTable, pWavePoolTableHi, DLS::version_t::release, RIFF::File::SetByteOrder(), WavePoolCount, and WavePoolHeaderSize.

DLS::File::File ( RIFF::File * pRIFF )

Constructor.

Load an existing DLS file.

Parameters:

pRIFF

- pointer to a RIFF file which is actually the DLS file to load

Exceptions:

Exception

if given file is not a DLS file, expected chunks are missing

Reimplemented in gig::File.

Definition at line 1222 of file DLS.cpp.

References b64BitWavePoolOffsets, CHUNK_ID_COLH, CHUNK_ID_PTBL, CHUNK_ID_VERS, RIFF::Chunk::GetSize(), RIFF::List::GetSubChunk(), Instruments, pInstruments, pRIFF, pSamples, pVersion, pWavePoolTable, pWavePoolTableHi, RIFF::Chunk::Read(), RIFF::Chunk::ReadUint32(), RIFF::Chunk::SetPos(), WavePoolCount, and WavePoolHeaderSize.

DLS::File::~File ( ) [virtual]

Reimplemented in gig::File.

Definition at line 1270 of file DLS.cpp.

References ExtensionFiles, pInstruments, pSamples, pVersion, pWavePoolTable, and pWavePoolTableHi.

Member Function Documentation

Sample * DLS::File::GetFirstSample ( )

Returns a pointer to the first Sample object of the file, NULL otherwise.

Definition at line 1298 of file DLS.cpp.

References LoadSamples(), pSamples, and SamplesIterator.

Referenced by gig::File::GetInstrument(), DLS::Region::GetSample(), and gig::File::UpdateChunks().

Sample * DLS::File::GetNextSample ( )

Returns a pointer to the next Sample object of the file, NULL otherwise.

Reimplemented in gig::File.

Definition at line 1305 of file DLS.cpp.

References pSamples, and SamplesIterator.

Referenced by DLS::Region::GetSample().

Sample * DLS::File::AddSample ( )

Add a new sample.

This will create a new Sample object for the DLS file. You have to call Save() to make this persistent to the file.

Returns:: pointer to new Sample object

Reimplemented in gig::File.

Definition at line 1348 of file DLS.cpp.

References __ensureMandatoryChunksExist(), RIFF::List::AddSubList(), RIFF::List::GetSubList(), LIST_TYPE_WAVE, LIST_TYPE_WVPL, LoadSamples(), pRIFF, and pSamples.

void DLS::File::DeleteSample ( Sample * pSample )

Delete a sample.

This will delete the given Sample object from the DLS file. You have to call Save() to make this persistent to the file.

Parameters:

pSample

- sample to delete

Definition at line 1366 of file DLS.cpp.

References pSamples.

Instrument * DLS::File::GetFirstInstrument ( )

Returns a pointer to the first Instrument object of the file, NULL otherwise.

Reimplemented in gig::File.

Definition at line 1374 of file DLS.cpp.

References InstrumentsIterator, LoadInstruments(), and pInstruments.

Instrument * DLS::File::GetNextInstrument ( )

Returns a pointer to the next Instrument object of the file, NULL otherwise.

Reimplemented in gig::File.

Definition at line 1381 of file DLS.cpp.

References InstrumentsIterator, and pInstruments.

Instrument * DLS::File::AddInstrument ( )

Add a new instrument definition.

This will create a new Instrument object for the DLS file. You have to call Save() to make this persistent to the file.

Returns:: pointer to new Instrument object

Reimplemented in gig::File.

Definition at line 1408 of file DLS.cpp.

References __ensureMandatoryChunksExist(), RIFF::List::AddSubList(), RIFF::List::GetSubList(), LIST_TYPE_INS, LIST_TYPE_LINS, LoadInstruments(), pInstruments, and pRIFF.

void DLS::File::DeleteInstrument ( Instrument * pInstrument )

Delete an instrument.

This will delete the given Instrument object from the DLS file. You have to call Save() to make this persistent to the file.

Parameters:

pInstrument

- instrument to delete

Definition at line 1425 of file DLS.cpp.

References pInstruments.

void DLS::File::UpdateChunks ( ) [virtual]

Apply all the DLS file's current instruments, samples and settings to the respective RIFF chunks.

You have to call Save() to make changes persistent.

Exceptions:

Exception

- on errors

Reimplemented from DLS::Resource.

Reimplemented in gig::File.

Definition at line 1440 of file DLS.cpp.

References RIFF::List::AddSubChunk(), b64BitWavePoolOffsets, DLS::version_t::build, CHUNK_ID_COLH, CHUNK_ID_PTBL, CHUNK_ID_VERS, RIFF::List::GetSubChunk(), Instruments, RIFF::Chunk::LoadChunkData(), DLS::version_t::major, DLS::version_t::minor, pInstruments, pRIFF, pSamples, pVersion, DLS::version_t::release, RIFF::Chunk::Resize(), DLS::Resource::UpdateChunks(), WavePoolCount, and WavePoolHeaderSize.

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

void DLS::File::Save ( const String & Path ) [virtual]

Save changes to another file.

Make all changes 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 Save() (without path argument) in that case instead! Ignoring this might result in a corrupted file!

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

Definition at line 1507 of file DLS.cpp.

References pRIFF, RIFF::File::Save(), and UpdateChunks().

void DLS::File::Save ( ) [virtual]

Save changes to same file.

Make all changes persistent by writing them to the actual (same) file. The file might temporarily grow to a higher size than it will have at the end of the saving process.

Exceptions: