#include <gig.h>
Inheritance diagram for gig::File:
Public Member Functions | |
File () | |
Constructor. | |
File (RIFF::File *pRIFF) | |
Constructor. | |
Sample * | GetFirstSample (progress_t *pProgress=NULL) |
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 * | GetInstrument (uint index, progress_t *pProgress=NULL) |
Returns the instrument with the given index. | |
Instrument * | AddInstrument () |
Add a new instrument definition. | |
void | DeleteInstrument (Instrument *pInstrument) |
Delete an instrument. | |
Group * | GetFirstGroup () |
Returns a pointer to the first Group object of the file, NULL otherwise. | |
Group * | GetNextGroup () |
Returns a pointer to the next Group object of the file, NULL otherwise. | |
Group * | GetGroup (uint index) |
Returns the group with the given index. | |
Group * | AddGroup () |
void | DeleteGroup (Group *pGroup) |
Delete a group and its samples. | |
void | DeleteGroupOnly (Group *pGroup) |
Delete a group. | |
virtual | ~File () |
virtual void | UpdateChunks () |
Apply all the gig file's current instruments, samples, groups and settings to the respective RIFF chunks. | |
Protected Types | |
typedef std::list< Sample * > | SampleList |
typedef std::list< Instrument * > | InstrumentList |
Protected Member Functions | |
virtual void | LoadSamples () |
virtual void | LoadInstruments () |
virtual void | LoadGroups () |
virtual void | LoadSamples (progress_t *pProgress) |
virtual void | LoadInstruments (progress_t *pProgress) |
Sample * | GetFirstSample () |
Returns a pointer to the first Sample object of the file, NULL otherwise. | |
void | DeleteSample (Sample *pSample) |
Delete a sample. | |
void | DeleteInstrument (Instrument *pInstrument) |
Delete an instrument. | |
virtual void | Save (const String &Path) |
Save changes to another file. | |
virtual void | Save () |
Save changes to same file. | |
void | __ensureMandatoryChunksExist () |
Checks if all (for DLS) mandatory chunks exist, if not they will be created. | |
Resource * | GetParent () |
Protected 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. | |
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 |
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. | |
Resource * | pParent |
RIFF::List * | pResourceList |
Friends | |
class | Region |
class | Sample |
class | Group |
Definition at line 688 of file gig.h.
typedef std::list<Sample*> DLS::File::SampleList [protected, inherited] |
typedef std::list<Instrument*> DLS::File::InstrumentList [protected, inherited] |
gig::File::File | ( | ) |
gig::File::File | ( | RIFF::File * | pRIFF | ) |
Constructor.
Load an existing DLS file.
Reimplemented from DLS::File.
Definition at line 2869 of file gig.cpp.
References DLS::Resource::pInfo.
gig::File::~File | ( | ) | [virtual] |
Sample * gig::File::GetFirstSample | ( | progress_t * | pProgress = NULL |
) |
Returns a pointer to the first Sample object of the file, NULL otherwise.
Definition at line 2886 of file gig.cpp.
References LoadSamples(), DLS::File::pSamples, and DLS::File::SamplesIterator.
Referenced by gig::Group::GetFirstSample(), and gig::Region::GetSampleFromWavePool().
Sample * gig::File::GetNextSample | ( | ) |
Returns a pointer to the next Sample object of the file, NULL otherwise.
Reimplemented from DLS::File.
Definition at line 2893 of file gig.cpp.
References DLS::File::pSamples, and DLS::File::SamplesIterator.
Referenced by gig::Group::GetFirstSample(), gig::Group::GetNextSample(), and gig::Region::GetSampleFromWavePool().
Sample * gig::File::AddSample | ( | ) |
Add a new sample.
This will create a new Sample object for the gig file. You have to call Save() to make this persistent to the file.
Reimplemented from DLS::File.
Definition at line 2906 of file gig.cpp.
References DLS::File::__ensureMandatoryChunksExist(), RIFF::List::AddSubList(), RIFF::List::GetSubList(), LIST_TYPE_WAVE, LIST_TYPE_WVPL, LoadSamples(), DLS::File::pRIFF, DLS::File::pSamples, and Sample.
void gig::File::DeleteSample | ( | Sample * | pSample | ) |
Delete a sample.
This will delete the given Sample object from the gig file. You have to call Save() to make this persistent to the file.
pSample | - sample to delete |
gig::Exception | if given sample could not be found |
Definition at line 2925 of file gig.cpp.
References DLS::File::pSamples, and DLS::File::SamplesIterator.
Referenced by DeleteGroup().
Instrument * gig::File::GetFirstInstrument | ( | ) |
Returns a pointer to the first Instrument object of the file, NULL otherwise.
Reimplemented from DLS::File.
Definition at line 2994 of file gig.cpp.
References DLS::File::InstrumentsIterator, LoadInstruments(), and DLS::File::pInstruments.
Instrument * gig::File::GetNextInstrument | ( | ) |
Returns a pointer to the next Instrument object of the file, NULL otherwise.
Reimplemented from DLS::File.
Definition at line 3001 of file gig.cpp.
References DLS::File::InstrumentsIterator, and DLS::File::pInstruments.
Instrument * gig::File::GetInstrument | ( | uint | index, | |
progress_t * | pProgress = NULL | |||
) |
Returns the instrument with the given index.
index | - number of the sought instrument (0..n) | |
pProgress | - optional: callback function for progress notification |
Definition at line 3014 of file gig.cpp.
References gig::__divide_progress(), gig::__notify_progress(), gig::progress_t::__range_max, gig::progress_t::__range_min, gig::progress_t::callback, DLS::File::GetFirstSample(), DLS::File::InstrumentsIterator, LoadInstruments(), and DLS::File::pInstruments.
Instrument * gig::File::AddInstrument | ( | ) |
Add a new instrument definition.
This will create a new Instrument object for the gig file. You have to call Save() to make this persistent to the file.
Reimplemented from DLS::File.
Definition at line 3050 of file gig.cpp.
References DLS::File::__ensureMandatoryChunksExist(), RIFF::List::AddSubList(), RIFF::List::GetSubList(), LIST_TYPE_INS, LIST_TYPE_LINS, LoadInstruments(), DLS::File::pInstruments, and DLS::File::pRIFF.
void gig::File::DeleteInstrument | ( | Instrument * | pInstrument | ) |
Delete an instrument.
This will delete the given Instrument object from the gig file. You have to call Save() to make this persistent to the file.
pInstrument | - instrument to delete |
gig::Exception | if given instrument could not be found |
Definition at line 3068 of file gig.cpp.
References DLS::File::pInstruments.
Group * gig::File::GetFirstGroup | ( | ) |
Returns a pointer to the first Group object of the file, NULL otherwise.
Definition at line 3106 of file gig.cpp.
References LoadGroups().
Referenced by gig::Group::MoveAll().
Group * gig::File::GetNextGroup | ( | ) |
Returns a pointer to the next Group object of the file, NULL otherwise.
Definition at line 3113 of file gig.cpp.
Referenced by gig::Group::MoveAll().
Group * gig::File::GetGroup | ( | uint | index | ) |
Returns the group with the given index.
index | - number of the sought group (0..n) |
Definition at line 3125 of file gig.cpp.
References LoadGroups().
Referenced by gig::Sample::Sample().
Group * gig::File::AddGroup | ( | ) |
Definition at line 3135 of file gig.cpp.
References DLS::File::__ensureMandatoryChunksExist(), Group, and LoadGroups().
void gig::File::DeleteGroup | ( | Group * | pGroup | ) |
Delete a group and its samples.
This will delete the given Group object and all the samples that belong to this group from the gig file. You have to call Save() to make this persistent to the file.
pGroup | - group to delete |
gig::Exception | if given group could not be found |
Definition at line 3153 of file gig.cpp.
References DeleteSample(), gig::Group::GetFirstSample(), gig::Group::GetNextSample(), and LoadGroups().
void gig::File::DeleteGroupOnly | ( | Group * | pGroup | ) |
Delete a group.
This will delete the given Group object from the gig file. All the samples that belong to this group will not be deleted, but instead be moved to another group. You have to call Save() to make this persistent to the file.
pGroup | - group to delete |
gig::Exception | if given group could not be found |
Definition at line 3177 of file gig.cpp.
References LoadGroups(), and gig::Group::MoveAll().
void gig::File::UpdateChunks | ( | ) | [virtual] |
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.
Usually there is absolutely no need to call this method explicitly. It will be called automatically when File::Save() was called.
Exception | - on errors |
Reimplemented from DLS::File.
Definition at line 3222 of file gig.cpp.
References DLS::File::UpdateChunks().
void gig::File::LoadSamples | ( | ) | [protected, virtual] |
Reimplemented from DLS::File.
Definition at line 2934 of file gig.cpp.
Referenced by AddSample(), and GetFirstSample().
void gig::File::LoadInstruments | ( | ) | [protected, virtual] |
Reimplemented from DLS::File.
Definition at line 3076 of file gig.cpp.
Referenced by AddInstrument(), GetFirstInstrument(), and GetInstrument().
void gig::File::LoadGroups | ( | ) | [protected, virtual] |
Definition at line 3188 of file gig.cpp.
References CHUNK_ID_3GNM, RIFF::Chunk::GetChunkID(), RIFF::List::GetFirstSubChunk(), RIFF::List::GetNextSubChunk(), RIFF::List::GetSubList(), Group, LIST_TYPE_3GNL, LIST_TYPE_3GRI, and DLS::File::pRIFF.
Referenced by AddGroup(), DeleteGroup(), DeleteGroupOnly(), GetFirstGroup(), GetGroup(), and LoadSamples().
void gig::File::LoadSamples | ( | progress_t * | pProgress | ) | [protected, virtual] |
Definition at line 2938 of file gig.cpp.
References gig::__notify_progress(), DLS::File::ExtensionFiles, RIFF::File::GetFileName(), RIFF::Chunk::GetFilePos(), RIFF::List::GetListType(), RIFF::List::GetNextSubList(), RIFF::List::GetSubList(), LIST_TYPE_WAVE, LIST_TYPE_WVPL, LoadGroups(), DLS::File::pRIFF, DLS::File::pSamples, DLS::File::pWavePoolTableHi, Sample, and DLS::File::WavePoolCount.
void gig::File::LoadInstruments | ( | progress_t * | pProgress | ) | [protected, virtual] |
Definition at line 3080 of file gig.cpp.
References gig::__divide_progress(), gig::__notify_progress(), RIFF::List::GetFirstSubList(), RIFF::List::GetListType(), RIFF::List::GetNextSubList(), RIFF::List::GetSubList(), DLS::File::Instruments, LIST_TYPE_INS, LIST_TYPE_LINS, DLS::File::pInstruments, and DLS::File::pRIFF.
Sample * DLS::File::GetFirstSample | ( | ) | [inherited] |
Returns a pointer to the first Sample object of the file, NULL otherwise.
Definition at line 1130 of file DLS.cpp.
References DLS::File::LoadSamples(), DLS::File::pSamples, and DLS::File::SamplesIterator.
Referenced by GetInstrument(), and DLS::Region::GetSample().
void DLS::File::DeleteSample | ( | Sample * | pSample | ) | [inherited] |
void DLS::File::DeleteInstrument | ( | Instrument * | pInstrument | ) | [inherited] |
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.
pInstrument | - instrument to delete |
Definition at line 1257 of file DLS.cpp.
References DLS::File::pInstruments.
void DLS::File::Save | ( | const String & | Path | ) | [virtual, inherited] |
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.
Path | - path and file name where everything should be written to |
Definition at line 1336 of file DLS.cpp.
References DLS::File::pRIFF, RIFF::File::Save(), and DLS::File::UpdateChunks().
void DLS::File::Save | ( | ) | [virtual, inherited] |
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.
RIFF::Exception | if any kind of IO error occured | |
DLS::Exception | if any kind of DLS specific error occured |
Definition at line 1351 of file DLS.cpp.
References DLS::File::pRIFF, RIFF::File::Save(), and DLS::File::UpdateChunks().
void DLS::File::__ensureMandatoryChunksExist | ( | ) | [protected, inherited] |
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 1362 of file DLS.cpp.
References RIFF::List::AddSubChunk(), RIFF::List::AddSubList(), DLS::File::b64BitWavePoolOffsets, CHUNK_ID_PTBL, RIFF::List::GetSubChunk(), RIFF::List::GetSubList(), LIST_TYPE_LINS, LIST_TYPE_WVPL, DLS::File::pRIFF, and DLS::File::WavePoolHeaderSize.
Referenced by AddGroup(), AddInstrument(), DLS::File::AddInstrument(), AddSample(), and DLS::File::AddSample().
Resource* DLS::Resource::GetParent | ( | ) | [inline, inherited] |
Definition at line 337 of file DLS.h.
References DLS::Resource::pParent.
Referenced by gig::Region::AddDimension(), DLS::Region::GetSample(), gig::Region::GetSampleFromWavePool(), gig::Region::Region(), gig::Region::UpdateChunks(), and DLS::Region::UpdateChunks().
friend class Sample [friend] |
friend class Group [friend] |
version_t* DLS::File::pVersion [inherited] |
Points to a version_t structure if the file provided a version number else is set to NULL.
Definition at line 470 of file DLS.h.
Referenced by gig::Region::AddDimension(), DLS::File::File(), gig::Region::Region(), gig::Region::UpdateChunks(), DLS::File::UpdateChunks(), and DLS::File::~File().
uint32_t DLS::File::Instruments [inherited] |
Reflects the number of available Instrument objects.
Definition at line 471 of file DLS.h.
Referenced by DLS::File::File(), LoadInstruments(), and DLS::File::UpdateChunks().
RIFF::File* DLS::File::pRIFF [protected, inherited] |
Definition at line 491 of file DLS.h.
Referenced by DLS::File::__ensureMandatoryChunksExist(), AddInstrument(), DLS::File::AddInstrument(), AddSample(), DLS::File::AddSample(), DLS::File::File(), LoadGroups(), LoadInstruments(), DLS::File::LoadInstruments(), LoadSamples(), DLS::File::LoadSamples(), DLS::File::Save(), gig::Group::UpdateChunks(), and DLS::File::UpdateChunks().
std::list<RIFF::File*> DLS::File::ExtensionFiles [protected, inherited] |
SampleList* DLS::File::pSamples [protected, inherited] |
Definition at line 493 of file DLS.h.
Referenced by AddSample(), DLS::File::AddSample(), DeleteSample(), DLS::File::DeleteSample(), DLS::File::File(), GetFirstSample(), DLS::File::GetFirstSample(), GetNextSample(), DLS::File::GetNextSample(), LoadSamples(), DLS::File::LoadSamples(), gig::Region::UpdateChunks(), DLS::File::UpdateChunks(), DLS::Region::UpdateChunks(), and DLS::File::~File().
SampleList::iterator DLS::File::SamplesIterator [protected, inherited] |
Definition at line 494 of file DLS.h.
Referenced by DeleteSample(), GetFirstSample(), DLS::File::GetFirstSample(), GetNextSample(), and DLS::File::GetNextSample().
InstrumentList* DLS::File::pInstruments [protected, inherited] |
Definition at line 495 of file DLS.h.
Referenced by AddInstrument(), DLS::File::AddInstrument(), DeleteInstrument(), DLS::File::DeleteInstrument(), DLS::File::File(), GetFirstInstrument(), DLS::File::GetFirstInstrument(), GetInstrument(), GetNextInstrument(), DLS::File::GetNextInstrument(), LoadInstruments(), DLS::File::LoadInstruments(), DLS::File::UpdateChunks(), and DLS::File::~File().
InstrumentList::iterator DLS::File::InstrumentsIterator [protected, inherited] |
Definition at line 496 of file DLS.h.
Referenced by GetFirstInstrument(), DLS::File::GetFirstInstrument(), GetInstrument(), GetNextInstrument(), and DLS::File::GetNextInstrument().
uint32_t DLS::File::WavePoolHeaderSize [protected, inherited] |
Definition at line 497 of file DLS.h.
Referenced by DLS::File::__ensureMandatoryChunksExist(), DLS::File::File(), and DLS::File::UpdateChunks().
uint32_t DLS::File::WavePoolCount [protected, inherited] |
Definition at line 498 of file DLS.h.
Referenced by DLS::File::File(), LoadSamples(), and DLS::File::UpdateChunks().
uint32_t* DLS::File::pWavePoolTable [protected, inherited] |
Definition at line 499 of file DLS.h.
Referenced by DLS::File::File(), DLS::Region::GetSample(), gig::Region::GetSampleFromWavePool(), gig::Region::Region(), and DLS::File::~File().
uint32_t* DLS::File::pWavePoolTableHi [protected, inherited] |
Definition at line 500 of file DLS.h.
Referenced by DLS::File::File(), gig::Region::GetSampleFromWavePool(), LoadSamples(), and DLS::File::~File().
bool DLS::File::b64BitWavePoolOffsets [protected, inherited] |
Definition at line 501 of file DLS.h.
Referenced by DLS::File::__ensureMandatoryChunksExist(), DLS::File::File(), and DLS::File::UpdateChunks().
Info* DLS::Resource::pInfo [inherited] |
Points (in any case) to an Info object, providing additional, optional infos and comments.
Definition at line 334 of file DLS.h.
Referenced by File(), gig::Instrument::Instrument(), gig::Region::Region(), DLS::Resource::Resource(), gig::Sample::Sample(), DLS::Resource::UpdateChunks(), and DLS::Resource::~Resource().
dlsid_t* DLS::Resource::pDLSID [inherited] |
Points to a dlsid_t structure if the file provided a DLS ID else is NULL.
Definition at line 335 of file DLS.h.
Referenced by DLS::Resource::Resource(), and DLS::Resource::~Resource().
Resource* DLS::Resource::pParent [protected, inherited] |
Definition at line 340 of file DLS.h.
Referenced by DLS::Resource::GetParent(), DLS::Resource::Resource(), gig::Sample::UpdateChunks(), DLS::Instrument::~Instrument(), DLS::Region::~Region(), and DLS::Sample::~Sample().
RIFF::List* DLS::Resource::pResourceList [protected, inherited] |