1 |
/*************************************************************************** |
/*************************************************************************** |
2 |
* * |
* * |
3 |
* libgig - C++ cross-platform Gigasampler format file loader library * |
* libgig - C++ cross-platform Gigasampler format file access library * |
4 |
* * |
* * |
5 |
* Copyright (C) 2003-2005 by Christian Schoenebeck * |
* Copyright (C) 2003-2007 by Christian Schoenebeck * |
6 |
* <cuse@users.sourceforge.net> * |
* <cuse@users.sourceforge.net> * |
7 |
* * |
* * |
8 |
* This library is free software; you can redistribute it and/or modify * |
* This library is free software; you can redistribute it and/or modify * |
90 |
# define CHUNK_ID_IENG 0x474E4549 |
# define CHUNK_ID_IENG 0x474E4549 |
91 |
# define CHUNK_ID_IGNR 0x524E4749 |
# define CHUNK_ID_IGNR 0x524E4749 |
92 |
# define CHUNK_ID_IKEY 0x59454B49 |
# define CHUNK_ID_IKEY 0x59454B49 |
93 |
# define CHUNK_ID_IMED 0x44525049 |
# define CHUNK_ID_IMED 0x44454D49 |
94 |
# define CHUNK_ID_INAM 0x4D414E49 |
# define CHUNK_ID_INAM 0x4D414E49 |
95 |
# define CHUNK_ID_IPRD 0x44525049 |
# define CHUNK_ID_IPRD 0x44525049 |
96 |
# define CHUNK_ID_ISBJ 0x4A425349 |
# define CHUNK_ID_ISBJ 0x4A425349 |
112 |
# define CHUNK_ID_ART2 0x32747261 |
# define CHUNK_ID_ART2 0x32747261 |
113 |
#endif // WORDS_BIGENDIAN |
#endif // WORDS_BIGENDIAN |
114 |
|
|
115 |
#define WAVE_FORMAT_PCM 0x0001 |
#define DLS_WAVE_FORMAT_PCM 0x0001 |
116 |
|
|
117 |
//TODO: no support for conditional chunks <cdl> yet |
//TODO: no support for conditional chunks <cdl> yet |
118 |
|
|
224 |
|
|
225 |
/** Defines Sample Loop Points. */ |
/** Defines Sample Loop Points. */ |
226 |
struct sample_loop_t { |
struct sample_loop_t { |
227 |
uint32_t Size; |
uint32_t Size; ///< For internal usage only: usually reflects exactly @c sizeof(sample_loop_t), otherwise if the value is larger then the DLS format was extended! |
228 |
uint32_t LoopType; |
uint32_t LoopType; ///< Defines how the waveform samples will be looped (appropriate loop types for the gig format are defined by gig::loop_type_t). |
229 |
uint32_t LoopStart; |
uint32_t LoopStart; ///< The start value specifies the offset (in sample points) in the waveform data of the first sample point to be played in the loop. |
230 |
uint32_t LoopLength; |
uint32_t LoopLength; ///< Length of the looping area (in sample points). |
231 |
}; |
}; |
232 |
|
|
233 |
// just symbol prototyping |
// just symbol prototyping |
315 |
String Source; ///< <ISRC-ck>. Identifies the name of the person or organization who supplied the original subject of the file. |
String Source; ///< <ISRC-ck>. Identifies the name of the person or organization who supplied the original subject of the file. |
316 |
String SourceForm; ///< <ISRF-ck>. Identifies the original form of the material that was digitized, such as record, sampling CD, TV sound track. This is not neccessarily the same as <i>Medium</i>. |
String SourceForm; ///< <ISRF-ck>. Identifies the original form of the material that was digitized, such as record, sampling CD, TV sound track. This is not neccessarily the same as <i>Medium</i>. |
317 |
String Commissioned; ///< <ICMS-ck>. Lists the name of the person or organization that commissioned the subject of the file, e.g., Pope Julian II. |
String Commissioned; ///< <ICMS-ck>. Lists the name of the person or organization that commissioned the subject of the file, e.g., Pope Julian II. |
318 |
|
String Subject; ///< <ISBJ-ck>. Describes the contents of the file. |
319 |
|
bool UseFixedLengthStrings; ///< Deprecated. Use #FixedStringLengths instead. |
320 |
|
|
321 |
|
struct FixedStringLength { |
322 |
|
uint32_t chunkId; |
323 |
|
int length; |
324 |
|
}; |
325 |
|
const FixedStringLength* FixedStringLengths; ///< List of IDs and string lengths for strings that should be stored in a fixed length format. This is used for gig files, not for ordinary DLS files. |
326 |
Info(RIFF::List* list); |
Info(RIFF::List* list); |
327 |
|
virtual ~Info(); |
328 |
virtual void UpdateChunks(); |
virtual void UpdateChunks(); |
329 |
private: |
private: |
330 |
RIFF::List* pResourceListChunk; |
RIFF::List* pResourceListChunk; |
331 |
|
|
332 |
void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s); |
static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s); |
333 |
void SaveString(uint32_t ChunkID, RIFF::List* lstINFO, const String& s, const String& sDefault); |
void SaveString(uint32_t ChunkID, RIFF::List* lstINFO, const String& s, const String& sDefault); |
334 |
}; |
}; |
335 |
|
|
341 |
|
|
342 |
Resource* GetParent() { return pParent; }; |
Resource* GetParent() { return pParent; }; |
343 |
virtual void UpdateChunks(); |
virtual void UpdateChunks(); |
344 |
|
void GenerateDLSID(); |
345 |
protected: |
protected: |
346 |
Resource* pParent; |
Resource* pParent; |
347 |
RIFF::List* pResourceList; |
RIFF::List* pResourceList; |
361 |
uint32_t SampleLoops; ///< Reflects the number of sample loops. |
uint32_t SampleLoops; ///< Reflects the number of sample loops. |
362 |
sample_loop_t* pSampleLoops; ///< Points to the beginning of a sample loop array, or is NULL if there are no loops defined. |
sample_loop_t* pSampleLoops; ///< Points to the beginning of a sample loop array, or is NULL if there are no loops defined. |
363 |
|
|
364 |
|
void AddSampleLoop(sample_loop_t* pLoopDef); |
365 |
|
void DeleteSampleLoop(sample_loop_t* pLoopDef); |
366 |
virtual void UpdateChunks(); |
virtual void UpdateChunks(); |
367 |
protected: |
protected: |
368 |
RIFF::List* pParentList; |
RIFF::List* pParentList; |
382 |
*/ |
*/ |
383 |
class Sample : public Resource { |
class Sample : public Resource { |
384 |
public: |
public: |
385 |
uint16_t FormatTag; ///< Format ID of the waveform data (should be WAVE_FORMAT_PCM for DLS1 compliant files, this is also the default value if Sample was created with Instrument::AddSample()). |
uint16_t FormatTag; ///< Format ID of the waveform data (should be DLS_WAVE_FORMAT_PCM for DLS1 compliant files, this is also the default value if Sample was created with Instrument::AddSample()). |
386 |
uint16_t Channels; ///< Number of channels represented in the waveform data, e.g. 1 for mono, 2 for stereo (defaults to 1=mono if Sample was created with Instrument::AddSample() previously). |
uint16_t Channels; ///< Number of channels represented in the waveform data, e.g. 1 for mono, 2 for stereo (defaults to 1=mono if Sample was created with Instrument::AddSample() previously). |
387 |
uint32_t SamplesPerSecond; ///< Sampling rate at which each channel should be played (defaults to 44100 if Sample was created with Instrument::AddSample() previously). |
uint32_t SamplesPerSecond; ///< Sampling rate at which each channel should be played (defaults to 44100 if Sample was created with Instrument::AddSample() previously). |
388 |
uint32_t AverageBytesPerSecond; ///< The average number of bytes per second at which the waveform data should be transferred (Playback software can estimate the buffer size using this value). |
uint32_t AverageBytesPerSecond; ///< The average number of bytes per second at which the waveform data should be transferred (Playback software can estimate the buffer size using this value). |
452 |
Region* GetFirstRegion(); |
Region* GetFirstRegion(); |
453 |
Region* GetNextRegion(); |
Region* GetNextRegion(); |
454 |
Region* AddRegion(); |
Region* AddRegion(); |
455 |
|
void MoveRegion(Region* pSrc, Region* pDst); |
456 |
void DeleteRegion(Region* pRegion); |
void DeleteRegion(Region* pRegion); |
457 |
virtual void UpdateChunks(); |
virtual void UpdateChunks(); |
458 |
protected: |
protected: |
467 |
RegionList::iterator RegionsIterator; |
RegionList::iterator RegionsIterator; |
468 |
|
|
469 |
Instrument(File* pFile, RIFF::List* insList); |
Instrument(File* pFile, RIFF::List* insList); |
470 |
void LoadRegions(); |
virtual void LoadRegions(); |
471 |
virtual ~Instrument(); |
virtual ~Instrument(); |
472 |
friend class File; |
friend class File; |
473 |
}; |
}; |
497 |
typedef std::list<Instrument*> InstrumentList; |
typedef std::list<Instrument*> InstrumentList; |
498 |
|
|
499 |
RIFF::File* pRIFF; |
RIFF::File* pRIFF; |
500 |
|
std::list<RIFF::File*> ExtensionFiles; |
501 |
SampleList* pSamples; |
SampleList* pSamples; |
502 |
SampleList::iterator SamplesIterator; |
SampleList::iterator SamplesIterator; |
503 |
InstrumentList* pInstruments; |
InstrumentList* pInstruments; |
508 |
uint32_t* pWavePoolTableHi; |
uint32_t* pWavePoolTableHi; |
509 |
bool b64BitWavePoolOffsets; |
bool b64BitWavePoolOffsets; |
510 |
|
|
511 |
void LoadSamples(); |
virtual void LoadSamples(); |
512 |
void LoadInstruments(); |
virtual void LoadInstruments(); |
513 |
void __ensureMandatoryChunksExist(); |
void __ensureMandatoryChunksExist(); |
514 |
friend class Region; // Region has to look in the wave pool table to get its sample |
friend class Region; // Region has to look in the wave pool table to get its sample |
515 |
private: |
private: |
517 |
void __UpdateWavePoolTable(); |
void __UpdateWavePoolTable(); |
518 |
}; |
}; |
519 |
|
|
520 |
/** Will be thrown whenever a DLS specific error occurs while trying to access a DLS File. */ |
/** |
521 |
|
* Will be thrown whenever a DLS specific error occurs while trying to |
522 |
|
* access a DLS File. Note: In your application you should better catch |
523 |
|
* for RIFF::Exception rather than this one, except you explicitly want |
524 |
|
* to catch and handle DLS::Exception and RIFF::Exception independently, |
525 |
|
* which usually shouldn't be necessary though. |
526 |
|
*/ |
527 |
class Exception : public RIFF::Exception { |
class Exception : public RIFF::Exception { |
528 |
public: |
public: |
529 |
Exception(String Message); |
Exception(String Message); |