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-2013 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 * |
27 |
#include "RIFF.h" |
#include "RIFF.h" |
28 |
|
|
29 |
#if WORDS_BIGENDIAN |
#if WORDS_BIGENDIAN |
30 |
# define RIFF_TYPE_DLS 0x646C7320 |
# define RIFF_TYPE_DLS 0x444C5320 |
|
# define LIST_TYPE_INFO 0x494E464F |
|
31 |
# define LIST_TYPE_WVPL 0x7776706C |
# define LIST_TYPE_WVPL 0x7776706C |
32 |
# define LIST_TYPE_DWPL 0x6477706C ///< Seen on some files instead of a wvpl list chunk. |
# define LIST_TYPE_DWPL 0x6477706C ///< Seen on some files instead of a wvpl list chunk. |
33 |
# define LIST_TYPE_WAVE 0x77617665 |
# define LIST_TYPE_WAVE 0x77617665 |
41 |
# define CHUNK_ID_IARL 0x4941524C |
# define CHUNK_ID_IARL 0x4941524C |
42 |
# define CHUNK_ID_IART 0x49415254 |
# define CHUNK_ID_IART 0x49415254 |
43 |
# define CHUNK_ID_ICMS 0x49434D53 |
# define CHUNK_ID_ICMS 0x49434D53 |
|
# define CHUNK_ID_ICMT 0x49434D54 |
|
|
# define CHUNK_ID_ICOP 0x49434F50 |
|
|
# define CHUNK_ID_ICRD 0x49435244 |
|
|
# define CHUNK_ID_IENG 0x49454E47 |
|
44 |
# define CHUNK_ID_IGNR 0x49474E52 |
# define CHUNK_ID_IGNR 0x49474E52 |
45 |
# define CHUNK_ID_IKEY 0x494B4559 |
# define CHUNK_ID_IKEY 0x494B4559 |
46 |
# define CHUNK_ID_IMED 0x494D4544 |
# define CHUNK_ID_IMED 0x494D4544 |
|
# define CHUNK_ID_INAM 0x494E414D |
|
|
# define CHUNK_ID_IPRD 0x49505244 |
|
47 |
# define CHUNK_ID_ISBJ 0x4953424A |
# define CHUNK_ID_ISBJ 0x4953424A |
|
# define CHUNK_ID_ISFT 0x49534654 |
|
48 |
# define CHUNK_ID_ISRC 0x49535243 |
# define CHUNK_ID_ISRC 0x49535243 |
49 |
# define CHUNK_ID_ISRF 0x49535246 |
# define CHUNK_ID_ISRF 0x49535246 |
50 |
# define CHUNK_ID_ITCH 0x49544348 |
# define CHUNK_ID_ITCH 0x49544348 |
61 |
# define CHUNK_ID_ARTL 0x6172746C |
# define CHUNK_ID_ARTL 0x6172746C |
62 |
# define CHUNK_ID_ART2 0x61727432 |
# define CHUNK_ID_ART2 0x61727432 |
63 |
#else // little endian |
#else // little endian |
64 |
# define RIFF_TYPE_DLS 0x20736C64 |
# define RIFF_TYPE_DLS 0x20534C44 |
|
# define LIST_TYPE_INFO 0x4F464E49 |
|
65 |
# define LIST_TYPE_WVPL 0x6C707677 |
# define LIST_TYPE_WVPL 0x6C707677 |
66 |
# define LIST_TYPE_DWPL 0x6C707764 ///< Seen on some files instead of a wvpl list chunk. |
# define LIST_TYPE_DWPL 0x6C707764 ///< Seen on some files instead of a wvpl list chunk. |
67 |
# define LIST_TYPE_WAVE 0x65766177 |
# define LIST_TYPE_WAVE 0x65766177 |
75 |
# define CHUNK_ID_IARL 0x4C524149 |
# define CHUNK_ID_IARL 0x4C524149 |
76 |
# define CHUNK_ID_IART 0x54524149 |
# define CHUNK_ID_IART 0x54524149 |
77 |
# define CHUNK_ID_ICMS 0x534D4349 |
# define CHUNK_ID_ICMS 0x534D4349 |
|
# define CHUNK_ID_ICMT 0x544D4349 |
|
|
# define CHUNK_ID_ICOP 0x504F4349 |
|
|
# define CHUNK_ID_ICRD 0x44524349 |
|
|
# define CHUNK_ID_IENG 0x474E4549 |
|
78 |
# define CHUNK_ID_IGNR 0x524E4749 |
# define CHUNK_ID_IGNR 0x524E4749 |
79 |
# define CHUNK_ID_IKEY 0x59454B49 |
# define CHUNK_ID_IKEY 0x59454B49 |
80 |
# define CHUNK_ID_IMED 0x44525049 |
# define CHUNK_ID_IMED 0x44454D49 |
|
# define CHUNK_ID_INAM 0x4D414E49 |
|
|
# define CHUNK_ID_IPRD 0x44525049 |
|
81 |
# define CHUNK_ID_ISBJ 0x4A425349 |
# define CHUNK_ID_ISBJ 0x4A425349 |
|
# define CHUNK_ID_ISFT 0x54465349 |
|
82 |
# define CHUNK_ID_ISRC 0x43525349 |
# define CHUNK_ID_ISRC 0x43525349 |
83 |
# define CHUNK_ID_ISRF 0x46525349 |
# define CHUNK_ID_ISRF 0x46525349 |
84 |
# define CHUNK_ID_ITCH 0x48435449 |
# define CHUNK_ID_ITCH 0x48435449 |
96 |
# define CHUNK_ID_ART2 0x32747261 |
# define CHUNK_ID_ART2 0x32747261 |
97 |
#endif // WORDS_BIGENDIAN |
#endif // WORDS_BIGENDIAN |
98 |
|
|
99 |
#define WAVE_FORMAT_PCM 0x0001 |
#define DLS_WAVE_FORMAT_PCM 0x0001 |
100 |
|
|
101 |
//TODO: no support for conditional chunks <cdl> yet |
//TODO: no support for conditional chunks <cdl> yet |
102 |
|
|
208 |
|
|
209 |
/** Defines Sample Loop Points. */ |
/** Defines Sample Loop Points. */ |
210 |
struct sample_loop_t { |
struct sample_loop_t { |
211 |
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! |
212 |
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). |
213 |
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. |
214 |
uint32_t LoopLength; |
uint32_t LoopLength; ///< Length of the looping area (in sample points). |
215 |
}; |
}; |
216 |
|
|
217 |
// just symbol prototyping |
// just symbol prototyping |
242 |
uint16_t transform; |
uint16_t transform; |
243 |
uint32_t scale; |
uint32_t scale; |
244 |
}; |
}; |
245 |
Connection() {}; |
Connection() {} |
246 |
void Init(conn_block_t* Header); |
void Init(conn_block_t* Header); |
247 |
conn_block_t ToConnBlock(); |
conn_block_t ToConnBlock(); |
248 |
virtual ~Connection() {}; |
virtual ~Connection() {} |
249 |
friend class Articulation; |
friend class Articulation; |
250 |
}; |
}; |
251 |
|
|
270 |
Articulation* GetFirstArticulation(); |
Articulation* GetFirstArticulation(); |
271 |
Articulation* GetNextArticulation(); |
Articulation* GetNextArticulation(); |
272 |
virtual void UpdateChunks(); |
virtual void UpdateChunks(); |
273 |
|
virtual void CopyAssign(const Articulator* orig); |
274 |
protected: |
protected: |
275 |
typedef std::list<Articulation*> ArticulationList; |
typedef std::list<Articulation*> ArticulationList; |
276 |
RIFF::List* pParentList; |
RIFF::List* pParentList; |
300 |
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. |
301 |
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>. |
302 |
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. |
303 |
|
String Subject; ///< <ISBJ-ck>. Describes the contents of the file. |
304 |
|
bool UseFixedLengthStrings; ///< @deprecated Not used anymore, use SetFixedStringLengths() instead. |
305 |
|
|
306 |
|
struct string_length_t { |
307 |
|
uint32_t chunkId; |
308 |
|
int length; |
309 |
|
}; |
310 |
|
|
311 |
Info(RIFF::List* list); |
Info(RIFF::List* list); |
312 |
|
void SetFixedStringLengths(const string_length_t* lengths); |
313 |
|
virtual ~Info(); |
314 |
virtual void UpdateChunks(); |
virtual void UpdateChunks(); |
315 |
|
virtual void CopyAssign(const Info* orig); |
316 |
private: |
private: |
317 |
RIFF::List* pResourceListChunk; |
RIFF::List* pResourceListChunk; |
318 |
|
const string_length_t* pFixedStringLengths; ///< 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. |
319 |
|
|
320 |
void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s); |
static void LoadString(uint32_t ChunkID, RIFF::List* lstINFO, String& s); |
321 |
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); |
322 |
}; |
}; |
323 |
|
|
327 |
Info* pInfo; ///< Points (in any case) to an <i>Info</i> object, providing additional, optional infos and comments. |
Info* pInfo; ///< Points (in any case) to an <i>Info</i> object, providing additional, optional infos and comments. |
328 |
dlsid_t* pDLSID; ///< Points to a <i>dlsid_t</i> structure if the file provided a DLS ID else is <i>NULL</i>. |
dlsid_t* pDLSID; ///< Points to a <i>dlsid_t</i> structure if the file provided a DLS ID else is <i>NULL</i>. |
329 |
|
|
330 |
Resource* GetParent() { return pParent; }; |
Resource* GetParent() { return pParent; } |
331 |
virtual void UpdateChunks(); |
virtual void UpdateChunks(); |
332 |
|
void GenerateDLSID(); |
333 |
|
virtual void CopyAssign(const Resource* orig); |
334 |
protected: |
protected: |
335 |
Resource* pParent; |
Resource* pParent; |
336 |
RIFF::List* pResourceList; |
RIFF::List* pResourceList; |
344 |
public: |
public: |
345 |
uint8_t UnityNote; |
uint8_t UnityNote; |
346 |
int16_t FineTune; |
int16_t FineTune; |
347 |
int32_t Gain; |
int32_t Gain; ///< @deprecated Don't alter directly, use SetGain() instead! |
348 |
bool NoSampleDepthTruncation; |
bool NoSampleDepthTruncation; |
349 |
bool NoSampleCompression; |
bool NoSampleCompression; |
350 |
uint32_t SampleLoops; ///< Reflects the number of sample loops. |
uint32_t SampleLoops; ///< Reflects the number of sample loops. |
351 |
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. |
352 |
|
|
353 |
|
void AddSampleLoop(sample_loop_t* pLoopDef); |
354 |
|
void DeleteSampleLoop(sample_loop_t* pLoopDef); |
355 |
|
virtual void SetGain(int32_t gain); |
356 |
virtual void UpdateChunks(); |
virtual void UpdateChunks(); |
357 |
|
virtual void CopyAssign(const Sampler* orig); |
358 |
protected: |
protected: |
359 |
RIFF::List* pParentList; |
RIFF::List* pParentList; |
360 |
uint32_t uiHeaderSize; |
uint32_t uiHeaderSize; |
366 |
/** @brief Encapsulates sample waves used for playback. |
/** @brief Encapsulates sample waves used for playback. |
367 |
* |
* |
368 |
* In case you created a new sample with File::AddSample(), you should |
* In case you created a new sample with File::AddSample(), you should |
369 |
* first call Resize() with the desired sample size. This will create |
* first update all attributes with the desired meta informations |
370 |
|
* (amount of channels, bit depth, sample rate, etc.), then call |
371 |
|
* Resize() with the desired sample size. The latter will create |
372 |
* the mandatory RIFF chunk which will hold the sample wave data. |
* the mandatory RIFF chunk which will hold the sample wave data. |
373 |
*/ |
*/ |
374 |
class Sample : public Resource { |
class Sample : public Resource { |
375 |
public: |
public: |
376 |
uint16_t FormatTag; ///< Format ID of the waveform data (should be WAVE_FORMAT_PCM for DLS1 compliant files). |
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()). |
377 |
uint16_t Channels; ///< Number of channels represented in the waveform data, e.g. 1 for mono, 2 for stereo (). |
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). |
378 |
uint32_t SamplesPerSecond; ///< Sampling rate at which each channel should be played. |
uint32_t SamplesPerSecond; ///< Sampling rate at which each channel should be played (defaults to 44100 if Sample was created with Instrument::AddSample() previously). |
379 |
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). |
380 |
uint16_t BlockAlign; ///< The block alignment (in bytes) of the waveform data. Playback software needs to process a multiple of <i>BlockAlign</i> bytes of data at a time, so the value of <i>BlockAlign</i> can be used for buffer alignment. |
uint16_t BlockAlign; ///< The block alignment (in bytes) of the waveform data. Playback software needs to process a multiple of <i>BlockAlign</i> bytes of data at a time, so the value of <i>BlockAlign</i> can be used for buffer alignment. |
381 |
uint16_t BitDepth; ///< Size of each sample per channel (only if known sample data format is used, 0 otherwise). |
uint16_t BitDepth; ///< Size of each sample per channel (only if known sample data format is used, 0 otherwise). |
382 |
unsigned long SamplesTotal; ///< Reflects total number of sample points (only if known sample data format is used, 0 otherwise), do not bother to change this value, it will not be saved. |
unsigned long SamplesTotal; ///< Reflects total number of sample points (only if known sample data format is used, 0 otherwise), do not bother to change this value, it will not be saved. |
383 |
uint FrameSize; ///< Reflects the size (in bytes) of one single sample point (only if known sample data format is used, 0 otherwise). |
uint FrameSize; ///< Reflects the size (in bytes) of one single sample point (only if known sample data format is used, 0 otherwise). <b>Caution:</b> with the current version of libgig you have to upate this field by yourself whenever you change one of the following fields: Channels, BitDepth ! Ignoring this might lead to undesired behavior when i.e. calling Resize(), SetPos(), Write() or Read(). |
384 |
|
|
385 |
void* LoadSampleData(); |
void* LoadSampleData(); |
386 |
void ReleaseSampleData(); |
void ReleaseSampleData(); |
405 |
/** Defines <i>Region</i> information of an <i>Instrument</i>. */ |
/** Defines <i>Region</i> information of an <i>Instrument</i>. */ |
406 |
class Region : public Resource, public Articulator, public Sampler { |
class Region : public Resource, public Articulator, public Sampler { |
407 |
public: |
public: |
408 |
range_t KeyRange; |
range_t KeyRange; ///< @deprecated Only read, don't write! Use SetKeyRange() instead. |
409 |
range_t VelocityRange; |
range_t VelocityRange; |
410 |
uint16_t KeyGroup; |
uint16_t KeyGroup; |
411 |
uint16_t Layer; |
uint16_t Layer; |
417 |
|
|
418 |
Sample* GetSample(); |
Sample* GetSample(); |
419 |
void SetSample(Sample* pSample); |
void SetSample(Sample* pSample); |
420 |
|
virtual void SetKeyRange(uint16_t Low, uint16_t High); |
421 |
virtual void UpdateChunks(); |
virtual void UpdateChunks(); |
422 |
|
virtual void CopyAssign(const Region* orig); |
423 |
protected: |
protected: |
424 |
RIFF::List* pCkRegion; |
RIFF::List* pCkRegion; |
425 |
uint32_t WavePoolTableIndex; // index in the wave pool table to the sample wave this region is linked to |
uint32_t WavePoolTableIndex; // index in the wave pool table to the sample wave this region is linked to |
447 |
Region* AddRegion(); |
Region* AddRegion(); |
448 |
void DeleteRegion(Region* pRegion); |
void DeleteRegion(Region* pRegion); |
449 |
virtual void UpdateChunks(); |
virtual void UpdateChunks(); |
450 |
|
virtual void CopyAssign(const Instrument* orig); |
451 |
protected: |
protected: |
452 |
typedef std::list<Region*> RegionList; |
typedef std::list<Region*> RegionList; |
453 |
struct midi_locale_t { |
struct midi_locale_t { |
460 |
RegionList::iterator RegionsIterator; |
RegionList::iterator RegionsIterator; |
461 |
|
|
462 |
Instrument(File* pFile, RIFF::List* insList); |
Instrument(File* pFile, RIFF::List* insList); |
463 |
void LoadRegions(); |
void CopyAssignCore(const Instrument* orig); |
464 |
|
virtual void LoadRegions(); |
465 |
virtual ~Instrument(); |
virtual ~Instrument(); |
466 |
friend class File; |
friend class File; |
467 |
|
friend class Region; |
468 |
|
private: |
469 |
|
void MoveRegion(Region* pSrc, Region* pDst); |
470 |
}; |
}; |
471 |
|
|
472 |
/** Parses DLS Level 1 and 2 compliant files and provides abstract access to the data. */ |
/** Parses DLS Level 1 and 2 compliant files and provides abstract access to the data. */ |
477 |
|
|
478 |
File(); |
File(); |
479 |
File(RIFF::File* pRIFF); |
File(RIFF::File* pRIFF); |
480 |
|
String GetFileName(); |
481 |
Sample* GetFirstSample(); ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise. |
Sample* GetFirstSample(); ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise. |
482 |
Sample* GetNextSample(); ///< Returns a pointer to the next <i>Sample</i> object of the file, <i>NULL</i> otherwise. |
Sample* GetNextSample(); ///< Returns a pointer to the next <i>Sample</i> object of the file, <i>NULL</i> otherwise. |
483 |
Sample* AddSample(); |
Sample* AddSample(); |
486 |
Instrument* GetNextInstrument(); ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise. |
Instrument* GetNextInstrument(); ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise. |
487 |
Instrument* AddInstrument(); |
Instrument* AddInstrument(); |
488 |
void DeleteInstrument(Instrument* pInstrument); |
void DeleteInstrument(Instrument* pInstrument); |
489 |
|
RIFF::File* GetExtensionFile(int index); |
490 |
virtual void UpdateChunks(); |
virtual void UpdateChunks(); |
491 |
virtual void Save(const String& Path); |
virtual void Save(const String& Path); |
492 |
virtual void Save(); |
virtual void Save(); |
496 |
typedef std::list<Instrument*> InstrumentList; |
typedef std::list<Instrument*> InstrumentList; |
497 |
|
|
498 |
RIFF::File* pRIFF; |
RIFF::File* pRIFF; |
499 |
|
std::list<RIFF::File*> ExtensionFiles; |
500 |
SampleList* pSamples; |
SampleList* pSamples; |
501 |
SampleList::iterator SamplesIterator; |
SampleList::iterator SamplesIterator; |
502 |
InstrumentList* pInstruments; |
InstrumentList* pInstruments; |
507 |
uint32_t* pWavePoolTableHi; |
uint32_t* pWavePoolTableHi; |
508 |
bool b64BitWavePoolOffsets; |
bool b64BitWavePoolOffsets; |
509 |
|
|
510 |
void LoadSamples(); |
virtual void LoadSamples(); |
511 |
void LoadInstruments(); |
virtual void LoadInstruments(); |
512 |
void __ensureMandatoryChunksExist(); |
void __ensureMandatoryChunksExist(); |
513 |
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 |
514 |
private: |
private: |
516 |
void __UpdateWavePoolTable(); |
void __UpdateWavePoolTable(); |
517 |
}; |
}; |
518 |
|
|
519 |
/** Will be thrown whenever a DLS specific error occurs while trying to access a DLS File. */ |
/** |
520 |
|
* Will be thrown whenever a DLS specific error occurs while trying to |
521 |
|
* access a DLS File. Note: In your application you should better catch |
522 |
|
* for RIFF::Exception rather than this one, except you explicitly want |
523 |
|
* to catch and handle DLS::Exception and RIFF::Exception independently, |
524 |
|
* which usually shouldn't be necessary though. |
525 |
|
*/ |
526 |
class Exception : public RIFF::Exception { |
class Exception : public RIFF::Exception { |
527 |
public: |
public: |
528 |
Exception(String Message); |
Exception(String Message); |