/[svn]/libgig/trunk/src/gig.h
ViewVC logotype

Diff of /libgig/trunk/src/gig.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 774 by persson, Sun Sep 18 12:41:56 2005 UTC revision 809 by schoenebeck, Tue Nov 22 11:26:55 2005 UTC
# Line 26  Line 26 
26    
27  #include "DLS.h"  #include "DLS.h"
28    
 #include <math.h>  
 #include <string.h>  
   
 /// Initial size of the sample buffer which is used for decompression of  
 /// compressed sample wave streams - this value should always be bigger than  
 /// the biggest sample piece expected to be read by the sampler engine,  
 /// otherwise the buffer size will be raised at runtime and thus the buffer  
 /// reallocated which is time consuming and unefficient.  
 #define INITIAL_SAMPLE_BUFFER_SIZE              512000 // 512 kB  
   
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
# Line 56  Line 46 
46  # define CHUNK_ID_EWAV  0x76617765  # define CHUNK_ID_EWAV  0x76617765
47  #endif // WORDS_BIGENDIAN  #endif // WORDS_BIGENDIAN
48    
 /** (so far) every exponential paramater in the gig format has a basis of 1.000000008813822 */  
 #define GIG_EXP_DECODE(x)                                       (pow(1.000000008813822, x))  
 #define GIG_PITCH_TRACK_EXTRACT(x)                              (!(x & 0x01))  
 #define GIG_VCF_RESONANCE_CTRL_EXTRACT(x)                       ((x >> 4) & 0x03)  
 #define GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(x)                  ((x >> 1) & 0x03)  
 #define GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(x)                   ((x >> 3) & 0x03)  
 #define GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(x)                 ((x >> 5) & 0x03)  
   
49  /** Gigasampler specific classes and definitions */  /** Gigasampler specific classes and definitions */
50  namespace gig {  namespace gig {
51    
# Line 271  namespace gig { Line 253  namespace gig {
253          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.
254          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).          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).
255          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.
256    
257            dimension_def_t& operator=(const dimension_def_t& arg);
258      };      };
259    
260      /** Defines which frequencies are filtered by the VCF. */      /** Defines which frequencies are filtered by the VCF. */
# Line 443  namespace gig { Line 427  namespace gig {
427              DLS::Sampler::SampleLoops;              DLS::Sampler::SampleLoops;
428              DLS::Sampler::pSampleLoops;              DLS::Sampler::pSampleLoops;
429    
430              // Methods              // own methods
431              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
432              double GetVelocityRelease(uint8_t MIDIKeyVelocity);              double GetVelocityRelease(uint8_t MIDIKeyVelocity);
433              double GetVelocityCutoff(uint8_t MIDIKeyVelocity);              double GetVelocityCutoff(uint8_t MIDIKeyVelocity);
434                // overridden methods
435                virtual void UpdateChunks();
436          protected:          protected:
437              DimensionRegion(RIFF::List* _3ewl);              DimensionRegion(RIFF::List* _3ewl);
438             ~DimensionRegion();             ~DimensionRegion();
# Line 490  namespace gig { Line 475  namespace gig {
475              double*                  pVelocityCutoffTable;       ///< Points to the velocity table corresponding to the filter velocity parameters of this DimensionRegion              double*                  pVelocityCutoffTable;       ///< Points to the velocity table corresponding to the filter velocity parameters of this DimensionRegion
476    
477              leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);              leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
478                _lev_ctrl_t     EncodeLeverageController(leverage_ctrl_t DecodedController);
479              double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);              double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
480              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
481      };      };
482    
483      /** Encapsulates sample waves used for playback. */      /** @brief Encapsulates sample waves used for playback.
484         *
485         * In case you created a new sample with File::AddSample(), you should
486         * first update all attributes with the desired meta informations
487         * (amount of channels, bit depth, sample rate, etc.), then call
488         * Resize() with the desired sample size, followed by File::Save(), this
489         * will create the mandatory RIFF chunk which will hold the sample wave
490         * data and / or resize the file so you will be able to Write() the
491         * sample data directly to disk.
492         */
493      class Sample : public DLS::Sample {      class Sample : public DLS::Sample {
494          public:          public:
495              uint16_t       SampleGroup;              uint16_t       SampleGroup;
496              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.
497              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.
498              uint32_t       SamplePeriod;      ///< Specifies the duration of time that passes during the playback of one sample in nanoseconds (normally equal to 1 / Samplers Per Second, where Samples Per Second is the value found in the format chunk).              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.
499              uint32_t       MIDIUnityNote;     ///< Specifies the musical note at which the sample will be played at it's original sample rate.              uint32_t       MIDIUnityNote;     ///< Specifies the musical note at which the sample will be played at it's original sample rate.
500              uint32_t       FineTune;          ///< Specifies the fraction of a semitone up from the specified MIDI unity note field. A value of 0x80000000 means 1/2 semitone (50 cents) and a value of 0x00000000 means no fine tuning between semitones.              uint32_t       FineTune;          ///< Specifies the fraction of a semitone up from the specified MIDI unity note field. A value of 0x80000000 means 1/2 semitone (50 cents) and a value of 0x00000000 means no fine tuning between semitones.
501              smpte_format_t SMPTEFormat;       ///< Specifies the Society of Motion Pictures and Television E time format used in the following <i>SMPTEOffset</i> field. If a value of 0 is set, <i>SMPTEOffset</i> should also be set to 0.              smpte_format_t SMPTEFormat;       ///< Specifies the Society of Motion Pictures and Television E time format used in the following <i>SMPTEOffset</i> field. If a value of 0 is set, <i>SMPTEOffset</i> should also be set to 0.
# Line 528  namespace gig { Line 523  namespace gig {
523              static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);              static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
524              // overridden methods              // overridden methods
525              void          ReleaseSampleData();              void          ReleaseSampleData();
526                void          Resize(int iNewSize);
527              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);
528              unsigned long GetPos();              unsigned long GetPos();
529              unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);              unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
530              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, buffer_t* pExternalDecompressionBuffer = NULL);
531                unsigned long Write(void* pBuffer, unsigned long SampleCount);
532                virtual void  UpdateChunks();
533          protected:          protected:
534              static unsigned int  Instances;               ///< Number of instances of class Sample.              static unsigned int  Instances;               ///< Number of instances of class Sample.
535              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.
# Line 543  namespace gig { Line 541  namespace gig {
541              unsigned long        SamplesPerFrame;         ///< For compressed samples only: number of samples in a full sample frame.              unsigned long        SamplesPerFrame;         ///< For compressed samples only: number of samples in a full sample frame.
542              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.
543              unsigned long        FileNo;                  ///< File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)              unsigned long        FileNo;                  ///< File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)
544                RIFF::Chunk*         pCk3gix;
545                RIFF::Chunk*         pCkSmpl;
546    
547              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo = 0);              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo = 0);
548             ~Sample();             ~Sample();
             /**  
              * Swaps the order of the data words in the given memory area  
              * with a granularity given by \a WordSize.  
              *  
              * @param pData    - pointer to the memory area to be swapped  
              * @param AreaSize - size of the memory area to be swapped (in bytes)  
              * @param WordSize - size of the data words (in bytes)  
              */  
             inline void SwapMemoryArea(void* pData, unsigned long AreaSize, uint WordSize) {  
                 switch (WordSize) { // TODO: unefficient  
                     case 1: {  
                         uint8_t* pDst = (uint8_t*) pData;  
                         uint8_t  cache;  
                         unsigned long lo = 0, hi = AreaSize - 1;  
                         for (; lo < hi; hi--, lo++) {  
                             cache    = pDst[lo];  
                             pDst[lo] = pDst[hi];  
                             pDst[hi] = cache;  
                         }  
                         break;  
                     }  
                     case 2: {  
                         uint16_t* pDst = (uint16_t*) pData;  
                         uint16_t  cache;  
                         unsigned long lo = 0, hi = (AreaSize >> 1) - 1;  
                         for (; lo < hi; hi--, lo++) {  
                             cache    = pDst[lo];  
                             pDst[lo] = pDst[hi];  
                             pDst[hi] = cache;  
                         }  
                         break;  
                     }  
                     case 4: {  
                         uint32_t* pDst = (uint32_t*) pData;  
                         uint32_t  cache;  
                         unsigned long lo = 0, hi = (AreaSize >> 2) - 1;  
                         for (; lo < hi; hi--, lo++) {  
                             cache    = pDst[lo];  
                             pDst[lo] = pDst[hi];  
                             pDst[hi] = cache;  
                         }  
                         break;  
                     }  
                     default: {  
                         uint8_t* pCache = new uint8_t[WordSize]; // TODO: unefficient  
                         unsigned long lo = 0, hi = AreaSize - WordSize;  
                         for (; lo < hi; hi -= WordSize, lo += WordSize) {  
                             memcpy(pCache, (uint8_t*) pData + lo, WordSize);  
                             memcpy((uint8_t*) pData + lo, (uint8_t*) pData + hi, WordSize);  
                             memcpy((uint8_t*) pData + hi, pCache, WordSize);  
                         }  
                         delete[] pCache;  
                         break;  
                     }  
                 }  
             }  
             inline long Min(long A, long B) {  
                 return (A > B) ? B : A;  
             }  
             inline long Abs(long val) { return (val > 0) ? val : -val; }  
549    
550              // Guess size (in bytes) of a compressed sample              // Guess size (in bytes) of a compressed sample
551              inline unsigned long GuessSize(unsigned long samples) {              inline unsigned long GuessSize(unsigned long samples) {
# Line 638  namespace gig { Line 578  namespace gig {
578      /** Defines <i>Region</i> information of an <i>Instrument</i>. */      /** Defines <i>Region</i> information of an <i>Instrument</i>. */
579      class Region : public DLS::Region {      class Region : public DLS::Region {
580          public:          public:
581              unsigned int            Dimensions;               ///< Number of defined dimensions.              unsigned int            Dimensions;               ///< Number of defined dimensions, do not alter!
582              dimension_def_t         pDimensionDefinitions[8]; ///< Defines the five (gig2) or eight (gig3) possible dimensions (the dimension's controller and number of bits/splits).              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.
583              uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains.              uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains, do not alter!
584              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).              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).
585              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.              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!
586    
587              DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);              DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
588              DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);              DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
589              Sample*          GetSample();              Sample*          GetSample();
590                void             AddDimension(dimension_def_t* pDimDef);
591                void             DeleteDimension(dimension_def_t* pDimDef);
592                virtual void     UpdateChunks();
593          protected:          protected:
594                typedef std::list<dimension_def_t*> DimensionList;
595    
596              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.              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.
597                DimensionList DimensionDefinitions;
598    
599              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
600              void LoadDimensionRegions(RIFF::List* rgn);              void LoadDimensionRegions(RIFF::List* rgn);
601                void UpdateVelocityTable(dimension_def_t* pDimDef);
602              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
603             ~Region();             ~Region();
604              friend class Instrument;              friend class Instrument;
# Line 684  namespace gig { Line 631  namespace gig {
631              // overridden methods              // overridden methods
632              Region*   GetFirstRegion();              Region*   GetFirstRegion();
633              Region*   GetNextRegion();              Region*   GetNextRegion();
634                Region*   AddRegion();
635                void      DeleteRegion(Region* pRegion);
636                virtual void UpdateChunks();
637              // own methods              // own methods
638              Region*   GetRegion(unsigned int Key);              Region*   GetRegion(unsigned int Key);
639          protected:          protected:
# Line 693  namespace gig { Line 643  namespace gig {
643    
644              Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);              Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
645             ~Instrument();             ~Instrument();
646                void UpdateRegionKeyTable();
647              friend class File;              friend class File;
648      };      };
649    
# Line 709  namespace gig { Line 660  namespace gig {
660    
661              // derived methods from DLS::Resource              // derived methods from DLS::Resource
662              DLS::Resource::GetParent;              DLS::Resource::GetParent;
663                // derived methods from DLS::File
664                DLS::File::Save;
665              // overridden  methods              // overridden  methods
666                File();
667              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
668              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.
669              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.
670              Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</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.
671                Sample*     AddSample();
672                void        DeleteSample(Sample* pSample);
673              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.
674              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
675                Instrument* AddInstrument();
676                void        DeleteInstrument(Instrument* pInstrument);
677             ~File();             ~File();
678          protected:          protected:
679              typedef std::list<Sample*>     SampleList;              typedef std::list<Sample*>     SampleList;
Legend:
Removed from v.774  
changed lines
  Added in v.809
  ViewVC Help
Powered by ViewVC