libgig  4.0.0
gig::File Class Reference

Provides convenient access to Gigasampler/GigaStudio .gig files. More...

#include <gig.h>

Inheritance diagram for gig::File:
DLS::File DLS::Resource

Public Member Functions

 File ()
 
 File (RIFF::File *pRIFF)
 
SampleGetFirstSample (progress_t *pProgress=NULL)
 Returns a pointer to the first Sample object of the file, NULL otherwise. More...
 
SampleGetNextSample ()
 Returns a pointer to the next Sample object of the file, NULL otherwise. More...
 
SampleGetSample (uint index)
 Returns Sample object of index. More...
 
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. More...
 
InstrumentGetNextInstrument ()
 Returns a pointer to the next Instrument object of the file, NULL otherwise. More...
 
InstrumentGetInstrument (uint index, progress_t *pProgress=NULL)
 Returns the instrument with the given index. More...
 
InstrumentAddInstrument ()
 Add a new instrument definition. More...
 
InstrumentAddDuplicateInstrument (const Instrument *orig)
 Add a duplicate of an existing instrument. More...
 
void DeleteInstrument (Instrument *pInstrument)
 Delete an instrument. More...
 
GroupGetFirstGroup ()
 Returns a pointer to the first Group object of the file, NULL otherwise. More...
 
GroupGetNextGroup ()
 Returns a pointer to the next Group object of the file, NULL otherwise. More...
 
GroupGetGroup (uint index)
 Returns the group with the given index. More...
 
GroupGetGroup (String name)
 Returns the group with the given group name. More...
 
GroupAddGroup ()
 
void DeleteGroup (Group *pGroup)
 Delete a group and its samples. More...
 
void DeleteGroupOnly (Group *pGroup)
 Delete a group. More...
 
void SetAutoLoad (bool b)
 Enable / disable automatic loading. More...
 
bool GetAutoLoad ()
 Returns whether automatic loading is enabled. More...
 
void AddContentOf (File *pFile)
 Add content of another existing file. More...
 
ScriptGroupGetScriptGroup (uint index)
 Get instrument script group (by index). More...
 
ScriptGroupGetScriptGroup (const String &name)
 Get instrument script group (by name). More...
 
ScriptGroupAddScriptGroup ()
 Add new instrument script group. More...
 
void DeleteScriptGroup (ScriptGroup *pGroup)
 Delete an instrument script group. More...
 
virtual ~File ()
 
virtual void UpdateChunks (progress_t *pProgress)
 Apply all the gig file's current instruments, samples, groups and settings to the respective RIFF chunks. More...
 

Static Public Attributes

static const DLS::version_t VERSION_2
 Reflects Gigasampler file format version 2.0 (1998-06-28). More...
 
static const DLS::version_t VERSION_3
 Reflects Gigasampler file format version 3.0 (2003-03-31). More...
 

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 UpdateFileOffsets ()
 Updates all file offsets stored all over the file. More...
 
virtual void LoadSamples (progress_t *pProgress)
 
virtual void LoadInstruments (progress_t *pProgress)
 
virtual void LoadScriptGroups ()
 
void SetSampleChecksum (Sample *pSample, uint32_t crc)
 Updates the 3crc chunk with the checksum of a sample. 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. More...
 
SampleGetFirstSample ()
 Returns a pointer to the first Sample object of the file, NULL otherwise. More...
 
void DeleteSample (Sample *pSample)
 Delete a sample. More...
 
void DeleteInstrument (Instrument *pInstrument)
 Delete an instrument. More...
 
RIFF::FileGetExtensionFile (int index)
 Returns extension file of given index. 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...
 
void __ensureMandatoryChunksExist ()
 Checks if all (for DLS) mandatory chunks exist, if not they will be created. More...
 
ResourceGetParent ()
 
const ResourceGetParent () const
 
void GenerateDLSID ()
 Generates a new DLSID for the resource. More...
 
virtual void CopyAssign (const Resource *orig)
 Make a deep copy of the Resource object given by orig and assign it to this object. More...
 

Protected Attributes

version_t * pVersion
 Points to a version_t structure if the file provided a version number else is set to NULL. More...
 
uint32_t Instruments
 Reflects the number of available Instrument objects. More...
 
RIFF::FilepRIFF
 
std::list< RIFF::File * > ExtensionFiles
 
SampleListpSamples
 
SampleList::iterator SamplesIterator
 
InstrumentListpInstruments
 
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. More...
 
dlsid_t * pDLSID
 Points to a dlsid_t structure if the file provided a DLS ID else is NULL. More...
 
ResourcepParent
 
RIFF::ListpResourceList
 

Friends

class Region
 
class Sample
 
class Instrument
 
class Group
 
class ScriptGroup
 

Detailed Description

Provides convenient access to Gigasampler/GigaStudio .gig files.

This is the entry class for accesing a Gigasampler/GigaStudio (.gig) file with libgig. It allows you to open existing .gig files, modifying them and saving them persistently either under the same file name or under a different location.

A .gig file is merely a monolithic file. That means samples and the defintion of the virtual instruments are contained in the same file. A .gig file contains an arbitrary amount of samples, and an arbitrary amount of instruments which are referencing those samples. It is also possible to store samples in .gig files not being referenced by any instrument. This is not an error from the file format's point of view and it is actually often used in practice during the design phase of new gig instruments.

So on toplevel of the gig file format you have:

And as extension to the original GigaStudio format, we added:

  • Real-time instrument scripts (see Script).

Note that the latter however is only supported by libgig, gigedit and LinuxSampler. Scripts are not supported by the original GigaStudio software.

All released Gigasampler/GigaStudio file format versions are supported (so from first Gigasampler version up to including GigaStudio 4).

Since the gig format was designed as extension to the DLS file format, this class is derived from the DLS::File class. So also refer to DLS::File for additional informations, class attributes and methods.

Definition at line 1210 of file gig.h.

Member Typedef Documentation

◆ InstrumentList

typedef std::list<Instrument*> DLS::File::InstrumentList
protectedinherited

Definition at line 520 of file DLS.h.

◆ SampleList

typedef std::list<Sample*> DLS::File::SampleList
protectedinherited

Definition at line 519 of file DLS.h.

Constructor & Destructor Documentation

◆ File() [1/2]

◆ File() [2/2]

gig::File::File ( RIFF::File pRIFF)

Definition at line 5201 of file gig.cpp.

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

◆ ~File()

gig::File::~File ( )
virtual

Reimplemented from DLS::File.

Definition at line 5208 of file gig.cpp.

Member Function Documentation

◆ __ensureMandatoryChunksExist()

void DLS::File::__ensureMandatoryChunksExist ( )
protectedinherited

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 1855 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(), DLS::File::AddInstrument(), AddInstrument(), DLS::File::AddSample(), and AddSample().

◆ AddContentOf()

void gig::File::AddContentOf ( File pFile)

Add content of another existing file.

Duplicates the samples, groups and instruments of the original file given by pFile and adds them to this File. In case this File is a new one that you haven't saved before, then you have to call SetFileName() before calling AddContentOf(), because this method will automatically save this file during operation, which is required for writing the sample waveform data by disk streaming.

Parameters
pFile- original file whose's content shall be copied from

Definition at line 5488 of file gig.cpp.

References AddGroup(), AddInstrument(), AddSample(), gig::Instrument::CopyAssign(), gig::Sample::CopyAssignMeta(), DLS::File::GetFileName(), gig::Sample::GetGroup(), GetGroup(), GetInstrument(), GetSample(), RIFF::File::IsNew(), gig::Group::Name, DLS::File::pRIFF, and DLS::File::Save().

◆ AddDuplicateInstrument()

Instrument * gig::File::AddDuplicateInstrument ( const Instrument orig)

Add a duplicate of an existing instrument.

Duplicates the instrument definition given by orig and adds it to this file. This allows in an instrument editor application to easily create variations of an instrument, which will be stored in the same .gig file, sharing i.e. the same samples.

Note that all sample pointers referenced by orig are simply copied as memory address. Thus the respective samples are shared, not duplicated!

You have to call Save() to make this persistent to the file.

Parameters
orig- original instrument to be copied
Returns
duplicated copy of the given instrument

Definition at line 5471 of file gig.cpp.

References AddInstrument(), and gig::Instrument::CopyAssign().

◆ AddGroup()

Group * gig::File::AddGroup ( )

Definition at line 5659 of file gig.cpp.

References DLS::File::__ensureMandatoryChunksExist(), Group, and LoadGroups().

Referenced by AddContentOf().

◆ AddInstrument()

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.

Returns
pointer to new Instrument object

Definition at line 5434 of file gig.cpp.

References DLS::File::__ensureMandatoryChunksExist(), RIFF::List::AddSubChunk(), RIFF::List::AddSubList(), CHUNK_ID_DLID, CHUNK_ID_INSH, DLS::Resource::GenerateDLSID(), RIFF::List::GetSubList(), Instrument, LIST_TYPE_INFO, LIST_TYPE_INS, LIST_TYPE_LINS, LoadInstruments(), DLS::Resource::pInfo, DLS::File::pInstruments, DLS::File::pRIFF, and DLS::Info::Software.

Referenced by AddContentOf(), and AddDuplicateInstrument().

◆ AddSample()

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.

Returns
pointer to new Sample object

Definition at line 5266 of file gig.cpp.

References DLS::File::__ensureMandatoryChunksExist(), RIFF::List::AddSubChunk(), RIFF::List::AddSubList(), CHUNK_ID_FMT, RIFF::List::GetSubList(), LIST_TYPE_INFO, LIST_TYPE_WAVE, LIST_TYPE_WVPL, LoadSamples(), DLS::File::pRIFF, DLS::File::pSamples, and Sample.

Referenced by AddContentOf().

◆ AddScriptGroup()

ScriptGroup * gig::File::AddScriptGroup ( )

Add new instrument script group.

Adds a new, empty real-time instrument script group to the file.

You have to call Save() to make this persistent to the file.

Returns
new empty script group

Definition at line 5778 of file gig.cpp.

References LoadScriptGroups(), and ScriptGroup.

◆ 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(), DLS::Sample::CopyAssignCore(), and DLS::Instrument::CopyAssignCore().

◆ DeleteGroup()

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.

Parameters
pGroup- group to delete
Exceptions
gig::Exceptionif given group could not be found

Definition at line 5677 of file gig.cpp.

References DeleteSample(), gig::Group::GetFirstSample(), gig::Group::GetNextSample(), and LoadGroups().

◆ DeleteGroupOnly()

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.

Parameters
pGroup- group to delete
Exceptions
gig::Exceptionif given group could not be found

Definition at line 5701 of file gig.cpp.

References LoadGroups(), and gig::Group::MoveAll().

◆ DeleteInstrument() [1/2]

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.

Parameters
pInstrument- instrument to delete

Definition at line 1638 of file DLS.cpp.

References DLS::File::pInstruments.

◆ DeleteInstrument() [2/2]

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.

Parameters
pInstrument- instrument to delete
Exceptions
gig::Exceptionif given instrument could not be found

Definition at line 5548 of file gig.cpp.

References DLS::File::pInstruments.

◆ DeleteSample() [1/2]

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

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

References DLS::File::pSamples.

◆ DeleteSample() [2/2]

void gig::File::DeleteSample ( Sample pSample)

Delete a sample.

This will delete the given Sample object from the gig file. Any references to this sample from Regions and DimensionRegions will be removed. You have to call Save() to make this persistent to the file.

Parameters
pSample- sample to delete
Exceptions
gig::Exceptionif given sample could not be found

Definition at line 5291 of file gig.cpp.

References GetFirstInstrument(), GetNextInstrument(), gig::DimensionRegion::pSample, DLS::File::pSamples, and DLS::File::SamplesIterator.

Referenced by DeleteGroup().

◆ DeleteScriptGroup()

void gig::File::DeleteScriptGroup ( ScriptGroup pScriptGroup)

Delete an instrument script group.

This will delete the given real-time instrument script group and all its instrument scripts it contains. References inside instruments that are using the deleted scripts will be removed from the respective instruments accordingly.

You have to call Save() to make this persistent to the file.

Parameters
pScriptGroup- script group to delete
Exceptions
gig::Exceptionif given script group could not be found

Definition at line 5797 of file gig.cpp.

References gig::ScriptGroup::DeleteScript(), RIFF::List::DeleteSubChunk(), RIFF::Chunk::GetParent(), gig::ScriptGroup::GetScript(), and LoadScriptGroups().

◆ GenerateDLSID()

void Resource::GenerateDLSID ( )
inherited

Generates a new DLSID for the resource.

Definition at line 495 of file DLS.cpp.

References DLS::dlsid_t::abData, DLS::Resource::pDLSID, DLS::dlsid_t::ulData1, DLS::dlsid_t::usData2, and DLS::dlsid_t::usData3.

Referenced by AddInstrument(), and File().

◆ GetAutoLoad()

bool gig::File::GetAutoLoad ( )

Returns whether automatic loading is enabled.

See also
SetAutoLoad()

Definition at line 6069 of file gig.cpp.

Referenced by GetInstrument(), gig::Instrument::Instrument(), and gig::Region::Region().

◆ GetExtensionFile()

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

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

References DLS::File::ExtensionFiles.

◆ GetFileName()

String DLS::File::GetFileName ( )
inherited

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

References RIFF::File::GetFileName(), and DLS::File::pRIFF.

Referenced by AddContentOf().

◆ GetFirstGroup()

Group * gig::File::GetFirstGroup ( )

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

Definition at line 5612 of file gig.cpp.

References LoadGroups().

Referenced by gig::Group::MoveAll().

◆ GetFirstInstrument()

Instrument * gig::File::GetFirstInstrument ( )

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

Definition at line 5377 of file gig.cpp.

References DLS::File::InstrumentsIterator, LoadInstruments(), and DLS::File::pInstruments.

Referenced by DeleteSample(), UpdateChunks(), and UpdateFileOffsets().

◆ GetFirstSample() [1/2]

Sample * DLS::File::GetFirstSample ( )
inherited

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

Definition at line 1511 of file DLS.cpp.

References DLS::File::LoadSamples(), DLS::File::pSamples, and DLS::File::SamplesIterator.

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

◆ GetFirstSample() [2/2]

Sample * gig::File::GetFirstSample ( progress_t pProgress = NULL)

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

Definition at line 5229 of file gig.cpp.

References LoadSamples(), DLS::File::pSamples, and DLS::File::SamplesIterator.

Referenced by gig::Group::GetFirstSample(), and gig::Region::GetSampleFromWavePool().

◆ GetGroup() [1/2]

Group * gig::File::GetGroup ( uint  index)

Returns the group with the given index.

Parameters
index- number of the sought group (0..n)
Returns
sought group or NULL if there's no such group

Definition at line 5631 of file gig.cpp.

References LoadGroups().

Referenced by AddContentOf(), and gig::Sample::Sample().

◆ GetGroup() [2/2]

Group * gig::File::GetGroup ( String  name)

Returns the group with the given group name.

Note: group names don't have to be unique in the gig format! So there can be multiple groups with the same name. This method will simply return the first group found with the given name.

Parameters
name- name of the sought group
Returns
sought group or NULL if there's no group with that name

Definition at line 5651 of file gig.cpp.

References LoadGroups().

◆ GetInstrument()

Instrument * gig::File::GetInstrument ( uint  index,
progress_t pProgress = NULL 
)

Returns the instrument with the given index.

Parameters
index- number of the sought instrument (0..n)
pProgress- optional: callback function for progress notification
Returns
sought instrument or NULL if there's no such instrument

Definition at line 5397 of file gig.cpp.

References RIFF::progress_t::__range_max, RIFF::progress_t::__range_min, RIFF::progress_t::callback, GetAutoLoad(), DLS::File::GetFirstSample(), DLS::File::InstrumentsIterator, LoadInstruments(), and DLS::File::pInstruments.

Referenced by AddContentOf(), and gig::Script::RemoveAllScriptReferences().

◆ GetNextGroup()

Group * gig::File::GetNextGroup ( )

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

Definition at line 5619 of file gig.cpp.

Referenced by gig::Group::MoveAll().

◆ GetNextInstrument()

Instrument * gig::File::GetNextInstrument ( )

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

Definition at line 5384 of file gig.cpp.

References DLS::File::InstrumentsIterator, and DLS::File::pInstruments.

Referenced by DeleteSample(), UpdateChunks(), and UpdateFileOffsets().

◆ GetNextSample()

Sample * gig::File::GetNextSample ( )

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

Definition at line 5236 of file gig.cpp.

References DLS::File::pSamples, and DLS::File::SamplesIterator.

Referenced by gig::Group::GetFirstSample(), gig::Group::GetNextSample(), gig::Region::GetSampleFromWavePool(), and UpdateChunks().

◆ GetParent() [1/2]

◆ GetParent() [2/2]

const Resource* DLS::Resource::GetParent ( ) const
inlineinherited

Definition at line 351 of file DLS.h.

References DLS::Resource::pParent.

◆ GetSample()

Sample * gig::File::GetSample ( uint  index)

Returns Sample object of index.

Returns
sample object or NULL if index is out of bounds

Definition at line 5247 of file gig.cpp.

References LoadSamples(), and DLS::File::pSamples.

Referenced by AddContentOf().

◆ GetScriptGroup() [1/2]

ScriptGroup * gig::File::GetScriptGroup ( uint  index)

Get instrument script group (by index).

Returns the real-time instrument script group with the given index.

Parameters
index- number of the sought group (0..n)
Returns
sought script group or NULL if there's no such group

Definition at line 5746 of file gig.cpp.

References LoadScriptGroups().

Referenced by gig::Instrument::LoadScripts().

◆ GetScriptGroup() [2/2]

ScriptGroup * gig::File::GetScriptGroup ( const String name)

Get instrument script group (by name).

Returns the first real-time instrument script group found with the given group name. Note that group names may not necessarily be unique.

Parameters
name- name of the sought script group
Returns
sought script group or NULL if there's no such group

Definition at line 5762 of file gig.cpp.

References LoadScriptGroups().

◆ LoadGroups()

◆ LoadInstruments() [1/2]

void gig::File::LoadInstruments ( )
protectedvirtual

Reimplemented from DLS::File.

Definition at line 5556 of file gig.cpp.

Referenced by AddInstrument(), GetFirstInstrument(), and GetInstrument().

◆ LoadInstruments() [2/2]

◆ LoadSamples() [1/2]

void gig::File::LoadSamples ( )
protectedvirtual

Reimplemented from DLS::File.

Definition at line 5317 of file gig.cpp.

Referenced by AddSample(), GetFirstSample(), and GetSample().

◆ LoadSamples() [2/2]

◆ LoadScriptGroups()

void gig::File::LoadScriptGroups ( )
protectedvirtual

◆ Save() [1/2]

void DLS::File::Save ( const String Path,
progress_t pProgress = NULL 
)
virtualinherited

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

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

Referenced by AddContentOf().

◆ Save() [2/2]

void DLS::File::Save ( progress_t pProgress = NULL)
virtualinherited

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 occured
DLS::Exceptionif any kind of DLS specific error occured

Definition at line 1817 of file DLS.cpp.

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

◆ SetAutoLoad()

void gig::File::SetAutoLoad ( bool  b)

Enable / disable automatic loading.

By default this properyt is enabled and all informations are loaded automatically. However loading all Regions, DimensionRegions and especially samples might take a long time for large .gig files, and sometimes one might only be interested in retrieving very superficial informations like the amount of instruments and their names. In this case one might disable automatic loading to avoid very slow response times.

CAUTION: by disabling this property many pointers (i.e. sample references) and informations will have invalid or even undefined data! This feature is currently only intended for retrieving very superficial informations in a very fast way. Don't use it to retrieve details like synthesis informations or even to modify .gig files!

Definition at line 6061 of file gig.cpp.

◆ SetFileName()

void DLS::File::SetFileName ( const String name)
inherited

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.

Definition at line 1683 of file DLS.cpp.

References DLS::File::pRIFF, and RIFF::File::SetFileName().

◆ SetSampleChecksum()

void gig::File::SetSampleChecksum ( Sample pSample,
uint32_t  crc 
)
protected

Updates the 3crc chunk with the checksum of a sample.

The update is done directly to disk, as this method is called after File::Save()

Definition at line 5589 of file gig.cpp.

References CHUNK_ID_3CRC, RIFF::List::GetSubChunk(), DLS::File::pRIFF, DLS::File::pSamples, RIFF::Chunk::SetPos(), and RIFF::Chunk::WriteUint32().

Referenced by gig::Sample::Write().

◆ UpdateChunks()

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

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

Reimplemented from DLS::File.

Definition at line 6036 of file gig.cpp.

References GetFirstInstrument(), GetNextInstrument(), and DLS::File::UpdateFileOffsets().

Friends And Related Function Documentation

◆ Group

friend class Group
friend

Definition at line 1272 of file gig.h.

Referenced by AddGroup(), and LoadGroups().

◆ Instrument

friend class Instrument
friend

Definition at line 1271 of file gig.h.

Referenced by AddInstrument(), and LoadInstruments().

◆ Region

friend class Region
friend

Definition at line 1269 of file gig.h.

◆ Sample

friend class Sample
friend

Definition at line 1270 of file gig.h.

Referenced by AddSample(), and LoadSamples().

◆ ScriptGroup

friend class ScriptGroup
friend

Definition at line 1273 of file gig.h.

Referenced by AddScriptGroup(), and LoadScriptGroups().

Member Data Documentation

◆ b64BitWavePoolOffsets

bool DLS::File::b64BitWavePoolOffsets
protectedinherited

◆ ExtensionFiles

std::list<RIFF::File*> DLS::File::ExtensionFiles
protectedinherited

Definition at line 523 of file DLS.h.

Referenced by DLS::File::GetExtensionFile(), LoadSamples(), and DLS::File::~File().

◆ Instruments

uint32_t DLS::File::Instruments
inherited

Reflects the number of available Instrument objects.

Definition at line 499 of file DLS.h.

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

◆ InstrumentsIterator

InstrumentList::iterator DLS::File::InstrumentsIterator
protectedinherited

◆ pDLSID

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 348 of file DLS.h.

Referenced by DLS::Resource::GenerateDLSID(), DLS::Resource::Resource(), DLS::Resource::UpdateChunks(), and DLS::Resource::~Resource().

◆ pInfo

Info* DLS::Resource::pInfo
inherited

Points (in any case) to an Info object, providing additional, optional infos and comments.

Definition at line 347 of file DLS.h.

Referenced by AddInstrument(), DLS::Resource::CopyAssign(), File(), gig::Instrument::Instrument(), DLS::Resource::Resource(), gig::Sample::Sample(), DLS::Resource::UpdateChunks(), and DLS::Resource::~Resource().

◆ pInstruments

◆ pParent

◆ pResourceList

RIFF::List* DLS::Resource::pResourceList
protectedinherited

Definition at line 357 of file DLS.h.

Referenced by DLS::Resource::Resource(), and DLS::Resource::UpdateChunks().

◆ pRIFF

◆ pSamples

◆ pVersion

version_t* DLS::File::pVersion
inherited

◆ pWavePoolTable

uint32_t* DLS::File::pWavePoolTable
protectedinherited

◆ pWavePoolTableHi

uint32_t* DLS::File::pWavePoolTableHi
protectedinherited

◆ SamplesIterator

SampleList::iterator DLS::File::SamplesIterator
protectedinherited

◆ VERSION_2

const DLS::version_t gig::File::VERSION_2
static
Initial value:
= {
0, 2, 19980628 & 0xffff, 19980628 >> 16
}

Reflects Gigasampler file format version 2.0 (1998-06-28).

Definition at line 1212 of file gig.h.

◆ VERSION_3

const DLS::version_t gig::File::VERSION_3
static
Initial value:
= {
0, 3, 20030331 & 0xffff, 20030331 >> 16
}

Reflects Gigasampler file format version 3.0 (2003-03-31).

Definition at line 1213 of file gig.h.

Referenced by File().

◆ WavePoolCount

uint32_t DLS::File::WavePoolCount
protectedinherited

Definition at line 529 of file DLS.h.

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

◆ WavePoolHeaderSize

uint32_t DLS::File::WavePoolHeaderSize
protectedinherited

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