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-2006 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 * |
29 |
#if WORDS_BIGENDIAN |
#if WORDS_BIGENDIAN |
30 |
# define LIST_TYPE_3PRG 0x33707267 |
# define LIST_TYPE_3PRG 0x33707267 |
31 |
# define LIST_TYPE_3EWL 0x3365776C |
# define LIST_TYPE_3EWL 0x3365776C |
32 |
|
# define LIST_TYPE_3GRI 0x33677269 |
33 |
|
# define LIST_TYPE_3GNL 0x33676E6C |
34 |
# define CHUNK_ID_SMPL 0x736D706C |
# define CHUNK_ID_SMPL 0x736D706C |
35 |
# define CHUNK_ID_3GIX 0x33676978 |
# define CHUNK_ID_3GIX 0x33676978 |
36 |
# define CHUNK_ID_3EWA 0x33657761 |
# define CHUNK_ID_3EWA 0x33657761 |
37 |
# define CHUNK_ID_3LNK 0x336C6E6B |
# define CHUNK_ID_3LNK 0x336C6E6B |
38 |
# define CHUNK_ID_3EWG 0x33657767 |
# define CHUNK_ID_3EWG 0x33657767 |
39 |
# define CHUNK_ID_EWAV 0x65776176 |
# define CHUNK_ID_EWAV 0x65776176 |
40 |
|
# define CHUNK_ID_3GNM 0x33676E6D |
41 |
#else // little endian |
#else // little endian |
42 |
# define LIST_TYPE_3PRG 0x67727033 |
# define LIST_TYPE_3PRG 0x67727033 |
43 |
# define LIST_TYPE_3EWL 0x6C776533 |
# define LIST_TYPE_3EWL 0x6C776533 |
44 |
|
# define LIST_TYPE_3GRI 0x69726733 |
45 |
|
# define LIST_TYPE_3GNL 0x6C6E6733 |
46 |
# define CHUNK_ID_SMPL 0x6C706D73 |
# define CHUNK_ID_SMPL 0x6C706D73 |
47 |
# define CHUNK_ID_3GIX 0x78696733 |
# define CHUNK_ID_3GIX 0x78696733 |
48 |
# define CHUNK_ID_3EWA 0x61776533 |
# define CHUNK_ID_3EWA 0x61776533 |
49 |
# define CHUNK_ID_3LNK 0x6B6E6C33 |
# define CHUNK_ID_3LNK 0x6B6E6C33 |
50 |
# define CHUNK_ID_3EWG 0x67776533 |
# define CHUNK_ID_3EWG 0x67776533 |
51 |
# define CHUNK_ID_EWAV 0x76617765 |
# define CHUNK_ID_EWAV 0x76617765 |
52 |
|
# define CHUNK_ID_3GNM 0x6D6E6733 |
53 |
#endif // WORDS_BIGENDIAN |
#endif // WORDS_BIGENDIAN |
54 |
|
|
55 |
/** Gigasampler specific classes and definitions */ |
/** Gigasampler specific classes and definitions */ |
246 |
* into the corresponding dimension bit number. |
* into the corresponding dimension bit number. |
247 |
*/ |
*/ |
248 |
typedef enum { |
typedef enum { |
249 |
split_type_normal, ///< dimension value between 0-127, no custom range of zones |
split_type_normal, ///< dimension value between 0-127 |
|
split_type_customvelocity, ///< a velocity dimension split with custom range definition for each zone (if a velocity dimension split has no custom defined zone ranges then it's also just of type split_type_normal) |
|
250 |
split_type_bit ///< dimension values are already the sought bit number |
split_type_bit ///< dimension values are already the sought bit number |
251 |
} split_type_t; |
} split_type_t; |
252 |
|
|
256 |
uint8_t bits; ///< Number of "bits" (1 bit = 2 splits/zones, 2 bit = 4 splits/zones, 3 bit = 8 splits/zones,...). |
uint8_t bits; ///< Number of "bits" (1 bit = 2 splits/zones, 2 bit = 4 splits/zones, 3 bit = 8 splits/zones,...). |
257 |
uint8_t zones; ///< Number of zones the dimension has. |
uint8_t zones; ///< Number of zones the dimension has. |
258 |
split_type_t split_type; ///< Intended for internal usage: will be used to convert a dimension value into the corresponding dimension bit number. |
split_type_t split_type; ///< Intended for internal usage: will be used to convert a dimension value into the corresponding dimension bit number. |
|
range_t* ranges; ///< Intended for internal usage: Points to the beginning of a range_t array which reflects the value ranges of each dimension zone (only if custom defined ranges are defined, is NULL otherwise). |
|
259 |
float zone_size; ///< Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only, 0 otherwise. |
float zone_size; ///< Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only, 0 otherwise. |
|
|
|
|
dimension_def_t& operator=(const dimension_def_t& arg); |
|
260 |
}; |
}; |
261 |
|
|
262 |
/** Defines which frequencies are filtered by the VCF. */ |
/** Defines which frequencies are filtered by the VCF. */ |
322 |
class Instrument; |
class Instrument; |
323 |
class Sample; |
class Sample; |
324 |
class Region; |
class Region; |
325 |
|
class Group; |
326 |
|
|
327 |
/** Encapsulates articulation information of a dimension region. |
/** Encapsulates articulation information of a dimension region. |
328 |
* |
* |
437 |
// overridden methods |
// overridden methods |
438 |
virtual void UpdateChunks(); |
virtual void UpdateChunks(); |
439 |
protected: |
protected: |
440 |
|
uint8_t* VelocityTable; ///< For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number. |
441 |
DimensionRegion(RIFF::List* _3ewl); |
DimensionRegion(RIFF::List* _3ewl); |
442 |
~DimensionRegion(); |
~DimensionRegion(); |
443 |
friend class Region; |
friend class Region; |
496 |
*/ |
*/ |
497 |
class Sample : public DLS::Sample { |
class Sample : public DLS::Sample { |
498 |
public: |
public: |
|
uint16_t SampleGroup; |
|
499 |
uint32_t Manufacturer; ///< Specifies the MIDI Manufacturer's Association (MMA) Manufacturer code for the sampler intended to receive this file's waveform. If no particular manufacturer is to be specified, a value of 0 should be used. |
uint32_t Manufacturer; ///< Specifies the MIDI Manufacturer's Association (MMA) Manufacturer code for the sampler intended to receive this file's waveform. If no particular manufacturer is to be specified, a value of 0 should be used. |
500 |
uint32_t Product; ///< Specifies the MIDI model ID defined by the manufacturer corresponding to the Manufacturer field. If no particular manufacturer's product is to be specified, a value of 0 should be used. |
uint32_t Product; ///< Specifies the MIDI model ID defined by the manufacturer corresponding to the Manufacturer field. If no particular manufacturer's product is to be specified, a value of 0 should be used. |
501 |
uint32_t SamplePeriod; ///< Specifies the duration of time that passes during the playback of one sample in nanoseconds (normally equal to 1 / Samples Per Second, where Samples Per Second is the value found in the format chunk), don't bother to update this attribute, it won't be saved. |
uint32_t SamplePeriod; ///< Specifies the duration of time that passes during the playback of one sample in nanoseconds (normally equal to 1 / Samples Per Second, where Samples Per Second is the value found in the format chunk), don't bother to update this attribute, it won't be saved. |
530 |
unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start); |
unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start); |
531 |
unsigned long GetPos(); |
unsigned long GetPos(); |
532 |
unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL); |
unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL); |
533 |
unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, buffer_t* pExternalDecompressionBuffer = NULL); |
unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL); |
534 |
unsigned long Write(void* pBuffer, unsigned long SampleCount); |
unsigned long Write(void* pBuffer, unsigned long SampleCount); |
535 |
|
Group* GetGroup() const; |
536 |
virtual void UpdateChunks(); |
virtual void UpdateChunks(); |
537 |
protected: |
protected: |
538 |
static unsigned int Instances; ///< Number of instances of class Sample. |
static unsigned int Instances; ///< Number of instances of class Sample. |
539 |
static buffer_t InternalDecompressionBuffer; ///< Buffer used for decompression as well as for truncation of 24 Bit -> 16 Bit samples. |
static buffer_t InternalDecompressionBuffer; ///< Buffer used for decompression as well as for truncation of 24 Bit -> 16 Bit samples. |
540 |
|
Group* pGroup; ///< pointer to the Group this sample belongs to (always not-NULL) |
541 |
unsigned long FrameOffset; ///< Current offset (sample points) in current sample frame (for decompression only). |
unsigned long FrameOffset; ///< Current offset (sample points) in current sample frame (for decompression only). |
542 |
unsigned long* FrameTable; ///< For positioning within compressed samples only: stores the offset values for each frame. |
unsigned long* FrameTable; ///< For positioning within compressed samples only: stores the offset values for each frame. |
543 |
unsigned long SamplePos; ///< For compressed samples only: stores the current position (in sample points). |
unsigned long SamplePos; ///< For compressed samples only: stores the current position (in sample points). |
577 |
void ScanCompressedSample(); |
void ScanCompressedSample(); |
578 |
friend class File; |
friend class File; |
579 |
friend class Region; |
friend class Region; |
580 |
|
friend class Group; // allow to modify protected member pGroup |
581 |
}; |
}; |
582 |
|
|
583 |
// TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions) |
// TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions) |
585 |
class Region : public DLS::Region { |
class Region : public DLS::Region { |
586 |
public: |
public: |
587 |
unsigned int Dimensions; ///< Number of defined dimensions, do not alter! |
unsigned int Dimensions; ///< Number of defined dimensions, do not alter! |
588 |
dimension_def_t pDimensionDefinitions[8]; ///< Defines the five (gig2) or eight (gig3) possible dimensions (the dimension's controller and number of bits/splits). Use AddDimension() and DeleteDimension() to create a new dimension ot delete an existing one. |
dimension_def_t pDimensionDefinitions[8]; ///< Defines the five (gig2) or eight (gig3) possible dimensions (the dimension's controller and number of bits/splits). Use AddDimension() and DeleteDimension() to create a new dimension or delete an existing one. |
589 |
uint32_t DimensionRegions; ///< Total number of DimensionRegions this Region contains, do not alter! |
uint32_t DimensionRegions; ///< Total number of DimensionRegions this Region contains, do not alter! |
590 |
DimensionRegion* pDimensionRegions[256]; ///< Pointer array to the 32 (gig2) or 256 (gig3) possible dimension regions (reflects NULL for dimension regions not in use). Avoid to access the array directly and better use GetDimensionRegionByValue() instead, but of course in some cases it makes sense to use the array (e.g. iterating through all DimensionRegions). Use AddDimension() and DeleteDimension() to create a new dimension ot delete an existing one (which will create or delete the respective dimension region(s) automatically). |
DimensionRegion* pDimensionRegions[256]; ///< Pointer array to the 32 (gig2) or 256 (gig3) possible dimension regions (reflects NULL for dimension regions not in use). Avoid to access the array directly and better use GetDimensionRegionByValue() instead, but of course in some cases it makes sense to use the array (e.g. iterating through all DimensionRegions). Use AddDimension() and DeleteDimension() to create a new dimension or delete an existing one (which will create or delete the respective dimension region(s) automatically). |
591 |
unsigned int Layers; ///< Amount of defined layers (1 - 32). A value of 1 actually means no layering, a value > 1 means there is Layer dimension. The same information can of course also be obtained by accessing pDimensionDefinitions. Do not alter this value! |
unsigned int Layers; ///< Amount of defined layers (1 - 32). A value of 1 actually means no layering, a value > 1 means there is Layer dimension. The same information can of course also be obtained by accessing pDimensionDefinitions. Do not alter this value! |
592 |
|
|
593 |
DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]); |
DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]); |
597 |
void DeleteDimension(dimension_def_t* pDimDef); |
void DeleteDimension(dimension_def_t* pDimDef); |
598 |
virtual void UpdateChunks(); |
virtual void UpdateChunks(); |
599 |
protected: |
protected: |
|
uint8_t VelocityTable[128]; ///< For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number. |
|
|
|
|
600 |
Region(Instrument* pInstrument, RIFF::List* rgnList); |
Region(Instrument* pInstrument, RIFF::List* rgnList); |
601 |
void LoadDimensionRegions(RIFF::List* rgn); |
void LoadDimensionRegions(RIFF::List* rgn); |
602 |
void UpdateVelocityTable(dimension_def_t* pDimDef); |
void UpdateVelocityTable(); |
603 |
Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL); |
Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL); |
604 |
~Region(); |
~Region(); |
605 |
friend class Instrument; |
friend class Instrument; |
646 |
friend class File; |
friend class File; |
647 |
}; |
}; |
648 |
|
|
649 |
// TODO: <3gnm> chunk not added yet (just contains the names of the sample groups) |
/** @brief Group of Gigasampler objects |
650 |
|
* |
651 |
|
* Groups help to organize a huge collection of Gigasampler objects. |
652 |
|
* Groups are not concerned at all for the synthesis, but they help |
653 |
|
* sound library developers when working on complex instruments with an |
654 |
|
* instrument editor (as long as that instrument editor supports it ;-). |
655 |
|
* |
656 |
|
* At the moment, it seems as only samples can be grouped together in |
657 |
|
* the Gigasampler format yet. If this is false in the meantime, please |
658 |
|
* tell us ! |
659 |
|
* |
660 |
|
* A sample is always assigned to exactly one Group. This also means |
661 |
|
* there is always at least one Group in a .gig file, no matter if you |
662 |
|
* created one yet or not. |
663 |
|
*/ |
664 |
|
class Group { |
665 |
|
public: |
666 |
|
String Name; ///< Stores the name of this Group. |
667 |
|
|
668 |
|
Sample* GetFirstSample(); |
669 |
|
Sample* GetNextSample(); |
670 |
|
void AddSample(Sample* pSample); |
671 |
|
protected: |
672 |
|
Group(File* file, RIFF::Chunk* ck3gnm); |
673 |
|
virtual ~Group(); |
674 |
|
virtual void UpdateChunks(); |
675 |
|
void MoveAll(); |
676 |
|
friend class File; |
677 |
|
private: |
678 |
|
File* pFile; |
679 |
|
RIFF::Chunk* pNameChunk; |
680 |
|
}; |
681 |
|
|
682 |
/** Parses Gigasampler files and provides abstract access to the data. */ |
/** Parses Gigasampler files and provides abstract access to the data. */ |
683 |
class File : protected DLS::File { |
class File : protected DLS::File { |
684 |
public: |
public: |
698 |
File(RIFF::File* pRIFF); |
File(RIFF::File* pRIFF); |
699 |
Sample* GetFirstSample(progress_t* pProgress = NULL); ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise. |
Sample* GetFirstSample(progress_t* pProgress = NULL); ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise. |
700 |
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. |
|
Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</i> object of the file, <i>NULL</i> otherwise. |
|
701 |
Sample* AddSample(); |
Sample* AddSample(); |
702 |
void DeleteSample(Sample* pSample); |
void DeleteSample(Sample* pSample); |
703 |
|
Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</i> object of the file, <i>NULL</i> otherwise. |
704 |
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. |
705 |
Instrument* GetInstrument(uint index, progress_t* pProgress = NULL); |
Instrument* GetInstrument(uint index, progress_t* pProgress = NULL); |
706 |
Instrument* AddInstrument(); |
Instrument* AddInstrument(); |
707 |
void DeleteInstrument(Instrument* pInstrument); |
void DeleteInstrument(Instrument* pInstrument); |
708 |
|
Group* GetFirstGroup(); ///< Returns a pointer to the first <i>Group</i> object of the file, <i>NULL</i> otherwise. |
709 |
|
Group* GetNextGroup(); ///< Returns a pointer to the next <i>Group</i> object of the file, <i>NULL</i> otherwise. |
710 |
|
Group* GetGroup(uint index); |
711 |
|
Group* AddGroup(); |
712 |
|
void DeleteGroup(Group* pGroup); |
713 |
|
virtual ~File(); |
714 |
protected: |
protected: |
715 |
// overridden protected methods from DLS::File |
// overridden protected methods from DLS::File |
716 |
virtual void LoadSamples(); |
virtual void LoadSamples(); |
717 |
virtual void LoadInstruments(); |
virtual void LoadInstruments(); |
718 |
|
virtual void LoadGroups(); |
719 |
// own protected methods |
// own protected methods |
720 |
virtual void LoadSamples(progress_t* pProgress); |
virtual void LoadSamples(progress_t* pProgress); |
721 |
virtual void LoadInstruments(progress_t* pProgress); |
virtual void LoadInstruments(progress_t* pProgress); |
722 |
friend class Region; |
friend class Region; |
723 |
|
friend class Sample; |
724 |
|
friend class Group; // so Group can access protected member pRIFF |
725 |
|
private: |
726 |
|
std::list<Group*>* pGroups; |
727 |
|
std::list<Group*>::iterator GroupsIterator; |
728 |
}; |
}; |
729 |
|
|
730 |
/** Will be thrown whenever a gig specific error occurs while trying to access a Gigasampler File. */ |
/** Will be thrown whenever a gig specific error occurs while trying to access a Gigasampler File. */ |