/[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 36 by schoenebeck, Wed Mar 10 21:34:28 2004 UTC revision 406 by persson, Wed Feb 23 19:11:07 2005 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file loader library    *   *   libgig - C++ cross-platform Gigasampler format file loader library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003 by Christian Schoenebeck                           *   *   Copyright (C) 2003-2005 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  *
9   *   it under the terms of the GNU General Public License as published by  *   *   it under the terms of the GNU General Public License as published by  *
# Line 63  Line 63 
63  #define GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(x)                  ((x >> 1) & 0x03)  #define GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(x)                  ((x >> 1) & 0x03)
64  #define GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(x)                   ((x >> 3) & 0x03)  #define GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(x)                   ((x >> 3) & 0x03)
65  #define GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(x)                 ((x >> 5) & 0x03)  #define GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(x)                 ((x >> 5) & 0x03)
 //TODO: the transformation functions are not very accurate compared to the original ones  
 #define GIG_VELOCITY_TRANSFORM_NONLINEAR(x,dynamic,scale)       ((1.0-1.0/pow(x,1.0/(129.0-x))) * (1.0+scale/20.0) + (5.0-dynamic)*pow(x/300.0* (1.0+2.0*scale/128.0),2))  
 #define GIG_VELOCITY_TRANSFORM_LINEAR(x,dynamic,scale)          ((1.0+scale*3.0/128.0)/110.0*x+(5.0-dynamic)/5.0+(5.0-dynamic)*scale)  
 #define GIG_VELOCITY_TRANSFORM_SPECIAL(x,dynamic,scale)         ((1.0+9.0*scale/129.0)*(1.0-1.0/pow(x,1.0/(129.0-x))+pow(3.0*x/pow(129,2),2)+pow((5.0-dynamic)*x/500.0,2)))  
66    
67  /** Gigasampler specific classes and definitions */  /** Gigasampler specific classes and definitions */
68  namespace gig {  namespace gig {
# Line 84  namespace gig { Line 80  namespace gig {
80          void*         pStart;            ///< Points to the beginning of the buffer.          void*         pStart;            ///< Points to the beginning of the buffer.
81          unsigned long Size;              ///< Size of the actual data in the buffer in bytes.          unsigned long Size;              ///< Size of the actual data in the buffer in bytes.
82          unsigned long NullExtensionSize; ///< The buffer might be bigger than the actual data, if that's the case that unused space at the end of the buffer is filled with NULLs and NullExtensionSize reflects that unused buffer space in bytes. Those NULL extensions are mandatory for differential algorithms that have to take the following data words into account, thus have to access past the buffer's boundary. If you don't know what I'm talking about, just forget this variable. :)          unsigned long NullExtensionSize; ///< The buffer might be bigger than the actual data, if that's the case that unused space at the end of the buffer is filled with NULLs and NullExtensionSize reflects that unused buffer space in bytes. Those NULL extensions are mandatory for differential algorithms that have to take the following data words into account, thus have to access past the buffer's boundary. If you don't know what I'm talking about, just forget this variable. :)
83            buffer_t() {
84                pStart            = NULL;
85                Size              = 0;
86                NullExtensionSize = 0;
87            }
88      };      };
89    
90      /** Standard types of sample loops. */      /** Standard types of sample loops. */
# Line 167  namespace gig { Line 168  namespace gig {
168          vcf_res_ctrl_genpurpose5 = 2,           ///< General Purpose Controller 5 (Button, MIDI Controller 80)          vcf_res_ctrl_genpurpose5 = 2,           ///< General Purpose Controller 5 (Button, MIDI Controller 80)
169          vcf_res_ctrl_genpurpose6 = 3            ///< General Purpose Controller 6 (Button, MIDI Controller 81)          vcf_res_ctrl_genpurpose6 = 3            ///< General Purpose Controller 6 (Button, MIDI Controller 81)
170      } vcf_res_ctrl_t;      } vcf_res_ctrl_t;
171        
172      /**      /**
173       * Defines a controller that has a certain contrained influence on a       * Defines a controller that has a certain contrained influence on a
174       * particular synthesis parameter (used to define attenuation controller,       * particular synthesis parameter (used to define attenuation controller,
# Line 183  namespace gig { Line 184  namespace gig {
184              type_velocity          = 0xff, ///< Key Velocity              type_velocity          = 0xff, ///< Key Velocity
185              type_controlchange     = 0xfe  ///< Ordinary MIDI control change controller, see field 'controller_number'              type_controlchange     = 0xfe  ///< Ordinary MIDI control change controller, see field 'controller_number'
186          } type_t;          } type_t;
187            
188          type_t type;              ///< Controller type          type_t type;              ///< Controller type
189          uint   controller_number; ///< MIDI controller number if this controller is a control change controller, 0 otherwise          uint   controller_number; ///< MIDI controller number if this controller is a control change controller, 0 otherwise
190      };      };
191        
192      /**      /**
193       * Defines controller influencing attenuation.       * Defines controller influencing attenuation.
194       *       *
195       * @see leverage_ctrl_t       * @see leverage_ctrl_t
196       */       */
197      typedef leverage_ctrl_t attenuation_ctrl_t;      typedef leverage_ctrl_t attenuation_ctrl_t;
198        
199      /**      /**
200       * Defines controller influencing envelope generator 1.       * Defines controller influencing envelope generator 1.
201       *       *
202       * @see leverage_ctrl_t       * @see leverage_ctrl_t
203       */       */
204      typedef leverage_ctrl_t eg1_ctrl_t;      typedef leverage_ctrl_t eg1_ctrl_t;
205        
206      /**      /**
207       * Defines controller influencing envelope generator 2.       * Defines controller influencing envelope generator 2.
208       *       *
# Line 223  namespace gig { Line 224  namespace gig {
224          dimension_velocity          = 0x82, ///< Key Velocity (this is the only dimension where the ranges can exactly be defined).          dimension_velocity          = 0x82, ///< Key Velocity (this is the only dimension where the ranges can exactly be defined).
225          dimension_channelaftertouch = 0x83, ///< Channel Key Pressure          dimension_channelaftertouch = 0x83, ///< Channel Key Pressure
226          dimension_releasetrigger    = 0x84, ///< Special dimension for triggering samples on releasing a key.          dimension_releasetrigger    = 0x84, ///< Special dimension for triggering samples on releasing a key.
227          dimension_keyboard          = 0x85, ///< Key Position          dimension_keyboard          = 0x85, ///< Dimension for keyswitching
228          dimension_modwheel          = 0x01, ///< Modulation Wheel (MIDI Controller 1)          dimension_modwheel          = 0x01, ///< Modulation Wheel (MIDI Controller 1)
229          dimension_breath            = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)          dimension_breath            = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)
230          dimension_foot              = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)          dimension_foot              = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)
# Line 278  namespace gig { Line 279  namespace gig {
279          vcf_type_bandreject   = 0x03          vcf_type_bandreject   = 0x03
280      } vcf_type_t;      } vcf_type_t;
281    
282      /** Defines the envelope of a crossfade. */      /**
283         * Defines the envelope of a crossfade.
284         *
285         * Note: The default value for crossfade points is 0,0,0,0. Layers with
286         * such a default value should be treated as if they would not have a
287         * crossfade.
288         */
289      struct crossfade_t {      struct crossfade_t {
290          #if WORDS_BIGENDIAN          #if WORDS_BIGENDIAN
         uint8_t in_start;   ///< Start position of fade in.  
         uint8_t in_end;     ///< End position of fade in.  
         uint8_t out_start;  ///< Start position of fade out.  
         uint8_t out_end;    ///< End postition of fade out.  
         #else // little endian  
291          uint8_t out_end;    ///< End postition of fade out.          uint8_t out_end;    ///< End postition of fade out.
292          uint8_t out_start;  ///< Start position of fade out.          uint8_t out_start;  ///< Start position of fade out.
293          uint8_t in_end;     ///< End position of fade in.          uint8_t in_end;     ///< End position of fade in.
294          uint8_t in_start;   ///< Start position of fade in.          uint8_t in_start;   ///< Start position of fade in.
295            #else // little endian
296            uint8_t in_start;   ///< Start position of fade in.
297            uint8_t in_end;     ///< End position of fade in.
298            uint8_t out_start;  ///< Start position of fade out.
299            uint8_t out_end;    ///< End postition of fade out.
300          #endif // WORDS_BIGENDIAN          #endif // WORDS_BIGENDIAN
301      };      };
302    
# Line 304  namespace gig { Line 311  namespace gig {
311      class File;      class File;
312      class Instrument;      class Instrument;
313      class Sample;      class Sample;
314        class Region;
315    
316      /** Encapsulates articulation information of a dimension region.      /** Encapsulates articulation information of a dimension region.
317       *       *
# Line 382  namespace gig { Line 390  namespace gig {
390              bool               VCFKeyboardTracking;           ///< If <i>true</i>: VCF cutoff frequence will be dependend to the note key position relative to the defined breakpoint value.              bool               VCFKeyboardTracking;           ///< If <i>true</i>: VCF cutoff frequence will be dependend to the note key position relative to the defined breakpoint value.
391              uint8_t            VCFKeyboardTrackingBreakpoint; ///< See VCFKeyboardTracking (0 - 127).              uint8_t            VCFKeyboardTrackingBreakpoint; ///< See VCFKeyboardTracking (0 - 127).
392              // Key Velocity Transformations              // Key Velocity Transformations
393              curve_type_t       VelocityResponseCurve;         ///< Defines a transformation curve to the incoming velocity values affecting amplitude.              curve_type_t       VelocityResponseCurve;         ///< Defines a transformation curve to the incoming velocity values affecting amplitude (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead).
394              uint8_t            VelocityResponseDepth;         ///< Dynamic range of velocity affecting amplitude (0 - 4).              uint8_t            VelocityResponseDepth;         ///< Dynamic range of velocity affecting amplitude (0 - 4) (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead).
395              uint8_t            VelocityResponseCurveScaling;  ///< 0 - 127              uint8_t            VelocityResponseCurveScaling;  ///< 0 - 127 (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead)
396              curve_type_t       ReleaseVelocityResponseCurve;  ///< Defines a transformation curve to the incoming release veloctiy values affecting envelope times.              curve_type_t       ReleaseVelocityResponseCurve;  ///< Defines a transformation curve to the incoming release veloctiy values affecting envelope times.
397              uint8_t            ReleaseVelocityResponseDepth;  ///< Dynamic range of release velocity affecting envelope time (0 - 4).              uint8_t            ReleaseVelocityResponseDepth;  ///< Dynamic range of release velocity affecting envelope time (0 - 4).
398              uint8_t            ReleaseTriggerDecay;           ///< 0 - 8              uint8_t            ReleaseTriggerDecay;           ///< 0 - 8
# Line 401  namespace gig { Line 409  namespace gig {
409              bool               SustainDefeat;                 ///< If <i>true</i>: Sustain pedal will not hold a note.              bool               SustainDefeat;                 ///< If <i>true</i>: Sustain pedal will not hold a note.
410              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.
411              uint16_t           SampleStartOffset;             ///< Number of samples the sample start should be moved (0 - 2000).              uint16_t           SampleStartOffset;             ///< Number of samples the sample start should be moved (0 - 2000).
412                double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)
413    
414              // derived attributes from DLS::Sampler              // derived attributes from DLS::Sampler
415              DLS::Sampler::UnityNote;              DLS::Sampler::UnityNote;
416              DLS::Sampler::FineTune;              DLS::Sampler::FineTune;
# Line 442  namespace gig { Line 452  namespace gig {
452                  _lev_ctrl_effect5depth      = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)                  _lev_ctrl_effect5depth      = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)
453                  _lev_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure                  _lev_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure
454                  _lev_ctrl_velocity          = 0xff  ///< Key Velocity                  _lev_ctrl_velocity          = 0xff  ///< Key Velocity
455              } _lev_ctrl_t;                      } _lev_ctrl_t;
456              typedef std::map<uint32_t, double*> VelocityTableMap;              typedef std::map<uint32_t, double*> VelocityTableMap;
457    
458              static uint              Instances;                  ///< Number of DimensionRegion instances.              static uint              Instances;                  ///< Number of DimensionRegion instances.
459              static VelocityTableMap* pVelocityTables;            ///< Contains the tables corresponding to the various velocity parameters (VelocityResponseCurve and VelocityResponseDepth).              static VelocityTableMap* pVelocityTables;            ///< Contains the tables corresponding to the various velocity parameters (VelocityResponseCurve and VelocityResponseDepth).
460              double*                  pVelocityAttenuationTable;  ///< Points to the velocity table corresponding to the velocity parameters of this DimensionRegion.              double*                  pVelocityAttenuationTable;  ///< Points to the velocity table corresponding to the velocity parameters of this DimensionRegion.
461                
462              leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);              leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
463                double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
464      };      };
465    
466      /** Encapsulates sample waves used for playback. */      /** Encapsulates sample waves used for playback. */
# Line 479  namespace gig { Line 490  namespace gig {
490              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
491              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);
492              buffer_t      GetCache();              buffer_t      GetCache();
493                // own static methods
494                static buffer_t CreateDecompressionBuffer(unsigned long MaxReadSize);
495                static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
496              // overridden methods              // overridden methods
497              void          ReleaseSampleData();              void          ReleaseSampleData();
498              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);
499              unsigned long GetPos();              unsigned long GetPos();
500              unsigned long Read(void* pBuffer, unsigned long SampleCount);              unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
501              unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState);              unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, buffer_t* pExternalDecompressionBuffer = NULL);
502          protected:          protected:
503              static unsigned int  Instances;               ///< Number of instances of class Sample.              static unsigned int  Instances;               ///< Number of instances of class Sample.
504              static unsigned long DecompressionBufferSize; ///< Current size of the decompression buffer.              static buffer_t      InternalDecompressionBuffer; ///< Buffer used for decompression as well as for truncation of 24 Bit -> 16 Bit samples.
             static void*         pDecompressionBuffer;    ///< Small buffer used for decompression only.  
505              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).
506              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.
507              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).
508                unsigned long        SamplesInLastFrame;      ///< For compressed samples only: length of the last sample frame.
509                unsigned long        WorstCaseFrameSize;      ///< For compressed samples only: size (in bytes) of the largest possible sample frame.
510                unsigned long        SamplesPerFrame;         ///< For compressed samples only: number of samples in a full sample frame.
511              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.
512    
513              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);
# Line 556  namespace gig { Line 572  namespace gig {
572                  return (A > B) ? B : A;                  return (A > B) ? B : A;
573              }              }
574              inline long Abs(long val) { return (val > 0) ? val : -val; }              inline long Abs(long val) { return (val > 0) ? val : -val; }
575    
576                // Guess size (in bytes) of a compressed sample
577                inline unsigned long GuessSize(unsigned long samples) {
578                    // 16 bit: assume all frames are compressed - 1 byte
579                    // per sample and 5 bytes header per 2048 samples
580    
581                    // 24 bit: assume next best compression rate - 1.5
582                    // bytes per sample and 13 bytes header per 256
583                    // samples
584                    const unsigned long size =
585                        BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
586                                       : samples + (samples >> 10) * 5;
587                    // Double for stereo and add one worst case sample
588                    // frame
589                    return (Channels == 2 ? size << 1 : size) + WorstCaseFrameSize;
590                }
591    
592                // Worst case amount of sample points that can be read with the
593                // given decompression buffer.
594                inline unsigned long WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
595                    return (unsigned long) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
596                }
597          private:          private:
598              void ScanCompressedSample();              void ScanCompressedSample();
599              friend class File;              friend class File;
# Line 567  namespace gig { Line 605  namespace gig {
605      class Region : public DLS::Region {      class Region : public DLS::Region {
606          public:          public:
607              unsigned int            Dimensions;               ///< Number of defined dimensions.              unsigned int            Dimensions;               ///< Number of defined dimensions.
608              dimension_def_t         pDimensionDefinitions[5]; ///< Defines the five 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).
609              uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains.              uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains.
610              DimensionRegion*        pDimensionRegions[32];    ///< Pointer array to the 32 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).
611                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.
612    
613              DimensionRegion* GetDimensionRegionByValue(uint Dim4Val, uint Dim3Val, uint Dim2Val, uint Dim1Val, uint Dim0Val);              DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
614              DimensionRegion* GetDimensionRegionByBit(uint8_t Dim4Bit, uint8_t Dim3Bit, uint8_t Dim2Bit, uint8_t Dim1Bit, uint8_t Dim0Bit);              DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
615              Sample*          GetSample();              Sample*          GetSample();
616          protected:          protected:
617              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.
# Line 643  namespace gig { Line 682  namespace gig {
682              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.
683              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.
684              Instrument* GetInstrument(uint index);              Instrument* GetInstrument(uint index);
685             ~File() {};             ~File();
686          protected:          protected:
687              typedef std::list<Sample*>     SampleList;              typedef std::list<Sample*>     SampleList;
688              typedef std::list<Instrument*> InstrumentList;              typedef std::list<Instrument*> InstrumentList;
Legend:
Removed from v.36  
changed lines
  Added in v.406
  ViewVC Help
Powered by ViewVC