libgig  4.1.0.svn8
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:
DLS::Resource

Public Member Functions

 File ()
 Constructor. More...
 
 File (RIFF::File *pRIFF)
 Constructor. More...
 
String GetFileName ()
 File name of this DLS file. More...
 
void SetFileName (const String &name)
 You may call this method store a future file name, so you don't have to to pass it to the Save() call later on.
 
SampleGetFirstSample ()
 Returns a pointer to the first Sample object of the file, NULL otherwise.
 
SampleGetNextSample ()
 Returns a pointer to the next Sample object of the file, NULL otherwise.
 
SampleAddSample ()
 Add a new sample. More...
 
void DeleteSample (Sample *pSample)
 Delete a sample. More...
 
InstrumentGetFirstInstrument ()
 Returns a pointer to the first Instrument object of the file, NULL otherwise.
 
InstrumentGetNextInstrument ()
 Returns a pointer to the next Instrument object of the file, NULL otherwise.
 
InstrumentAddInstrument ()
 Add a new instrument definition. More...
 
void DeleteInstrument (Instrument *pInstrument)
 Delete an instrument. More...
 
RIFF::FileGetExtensionFile (int index)
 Returns extension file of given index. More...
 
virtual void UpdateChunks (progress_t *pProgress)
 Apply all the DLS file's current instruments, samples and settings to the respective RIFF chunks. More...
 
virtual void Save (const String &Path, progress_t *pProgress=NULL)
 Save changes to another file. More...
 
virtual void Save (progress_t *pProgress=NULL)
 Save changes to same file. More...
 
ResourceGetParent ()
 
const ResourceGetParent () const
 
void GenerateDLSID ()
 Generates a new DLSID for the resource.
 
virtual void CopyAssign (const Resource *orig)
 Make a deep copy of the Resource object given by orig and assign it to this object. More...
 

Public Attributes

version_tpVersion
 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.
 
InfopInfo
 Points (in any case) to an Info object, providing additional, optional infos and comments.
 
dlsid_tpDLSID
 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 ()
 
virtual void UpdateFileOffsets ()
 Updates all file offsets stored all over the file. More...
 
void __ensureMandatoryChunksExist ()
 Checks if all (for DLS) mandatory chunks exist, if not they will be created. More...
 

Protected Attributes

RIFF::FilepRIFF
 
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
 
ResourcepParent
 
RIFF::ListpResourceList
 

Detailed Description

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

Definition at line 498 of file DLS.h.

Constructor & Destructor Documentation

◆ File() [1/2]

gig::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.

Definition at line 1408 of file DLS.cpp.

References Instruments, pVersion, and RIFF::File::SetByteOrder().

◆ File() [2/2]

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
Exceptionif given file is not a DLS file, expected chunks are missing

Definition at line 1437 of file DLS.cpp.

References RIFF::Chunk::GetSize(), RIFF::List::GetSubChunk(), Instruments, pVersion, RIFF::Chunk::Read(), RIFF::Chunk::ReadUint32(), and RIFF::Chunk::SetPos().

Member Function Documentation

◆ __ensureMandatoryChunksExist()

void DLS::File::__ensureMandatoryChunksExist ( )
protected

Checks if all (for DLS) mandatory chunks exist, if not they will be created.

Note that those chunks will not be made persistent until Save() was called.

Definition at line 1871 of file DLS.cpp.

References RIFF::List::AddSubChunk(), RIFF::List::AddSubList(), RIFF::List::GetSubChunk(), and RIFF::List::GetSubList().

Referenced by AddInstrument(), and AddSample().

◆ AddInstrument()

Instrument * gig::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

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

Returns
pointer to new Instrument object

Definition at line 1624 of file DLS.cpp.

References __ensureMandatoryChunksExist(), RIFF::List::AddSubList(), and RIFF::List::GetSubList().

◆ AddSample()

Sample * gig::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

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

Returns
pointer to new Sample object

Definition at line 1564 of file DLS.cpp.

References __ensureMandatoryChunksExist(), RIFF::List::AddSubList(), and RIFF::List::GetSubList().

◆ CopyAssign()

void Resource::CopyAssign ( const Resource orig)
virtualinherited

Make a deep copy of the Resource object given by orig and assign it to this object.

Parameters
orig- original Resource object to be copied from

Definition at line 542 of file DLS.cpp.

References DLS::Info::CopyAssign(), and DLS::Resource::pInfo.

Referenced by DLS::Region::CopyAssign(), and DLS::Sample::CopyAssignCore().

◆ DeleteInstrument()

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 1641 of file DLS.cpp.

◆ DeleteSample()

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 1582 of file DLS.cpp.

◆ GetExtensionFile()

RIFF::File * DLS::File::GetExtensionFile ( int  index)

Returns extension file of given index.

Extension files are used sometimes to circumvent the 2 GB file size limit of the RIFF format and of certain operating systems in general. In this case, instead of just using one file, the content is spread among several files with similar file name scheme. This is especially used by some GigaStudio sound libraries.

Parameters
index- index of extension file
Returns
sought extension file, NULL if index out of bounds
See also
GetFileName()

Definition at line 1661 of file DLS.cpp.

◆ GetFileName()

String DLS::File::GetFileName ( )

File name of this DLS file.

This method returns the file name as it was provided when loading the respective DLS file. However in case the File object associates an empty, that is new DLS file, which was not yet saved to disk, this method will return an empty string.

See also
GetExtensionFile()

Definition at line 1678 of file DLS.cpp.

◆ Save() [1/2]

void DLS::File::Save ( const String &  Path,
progress_t pProgress = NULL 
)
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
pProgress- optional: callback function for progress notification

Definition at line 1803 of file DLS.cpp.

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

◆ Save() [2/2]

void DLS::File::Save ( progress_t pProgress = NULL)
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.

Parameters
pProgress- optional: callback function for progress notification
Exceptions
RIFF::Exceptionif any kind of IO error occurred
DLS::Exceptionif any kind of DLS specific error occurred

Definition at line 1833 of file DLS.cpp.

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

◆ UpdateChunks()

void gig::File::UpdateChunks ( progress_t pProgress)
virtual

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

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

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

Parameters
pProgress- callback function for progress notification
Exceptions
Exception- on errors

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

Usually there is absolutely no need to call this method explicitly. It will be called automatically when File::Save() was called.

Parameters
pProgress- callback function for progress notification
Exceptions
Exception- on errors

Reimplemented from DLS::Resource.

Definition at line 1698 of file DLS.cpp.

References RIFF::List::AddSubChunk(), RIFF::File::GetRequiredFileSize(), RIFF::List::GetSubChunk(), Instruments, RIFF::Chunk::LoadChunkData(), pVersion, RIFF::Chunk::Resize(), and DLS::Resource::UpdateChunks().

Referenced by Save().

◆ UpdateFileOffsets()

void gig::File::UpdateFileOffsets ( )
protectedvirtual

Updates all file offsets stored all over the file.

This virtual method is called whenever the overall file layout has been changed (i.e. file or individual RIFF chunks have been resized). It is then the responsibility of this method to update all file offsets stored in the file format. For example samples are referenced by instruments by file offsets. The gig format also stores references to instrument scripts as file offsets, and thus it overrides this method to update those file offsets as well.

Definition at line 1862 of file DLS.cpp.

Referenced by Save().


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