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

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

Parent Directory | Revision Log | View Patch Patch

-revision 55 by schoenebeck,
Tue Apr 27 09:06:07 2004 UTC
+revision 728 by persson,
Tue Jul 26 11:13:53 2005 UTC
 Line 2
   *                                                                         *
   *   libgig - C++ cross-platform Gigasampler format file loader library    *
   *                                                                         *
-  *   Copyright (C) 2003, 2004 by Christian Schoenebeck                     *
+  *   Copyright (C) 2003-2005 by Christian Schoenebeck                      *
-  *                               <cuse@users.sourceforge.net>              *
+  *                              <cuse@users.sourceforge.net>               *
   *                                                                         *
   *   This library is free software; you can redistribute it and/or modify  *
   *   it under the terms of the GNU General Public License as published by  *
 Line 63
  #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)
- //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)))
  /** Gigasampler specific classes and definitions */
  namespace gig {
-Line 84 
 namespace gig {
+Line 80 
 namespace gig {
          void*         pStart;            ///< Points to the beginning of the buffer.
          unsigned long Size;              ///< Size of the actual data in the buffer in bytes.
          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. :)
+         buffer_t() {
+             pStart            = NULL;
+             Size              = 0;
+             NullExtensionSize = 0;
+         }
      };
      /** Standard types of sample loops. */
-Line 223 
 namespace gig {
+Line 224 
 namespace gig {
          dimension_velocity          = 0x82, ///< Key Velocity (this is the only dimension where the ranges can exactly be defined).
          dimension_channelaftertouch = 0x83, ///< Channel Key Pressure
          dimension_releasetrigger    = 0x84, ///< Special dimension for triggering samples on releasing a key.
-         dimension_keyboard          = 0x85, ///< Key Position
+         dimension_keyboard          = 0x85, ///< Dimension for keyswitching
+         dimension_roundrobin        = 0x86, ///< Different samples triggered each time a note is played, dimension regions selected in sequence
+         dimension_random            = 0x87, ///< Different samples triggered each time a note is played, random order
          dimension_modwheel          = 0x01, ///< Modulation Wheel (MIDI Controller 1)
          dimension_breath            = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)
          dimension_foot              = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)
-Line 278 
 namespace gig {
+Line 281 
 namespace gig {
          vcf_type_bandreject   = 0x03
      } vcf_type_t;
-     /** Defines the envelope of a crossfade. */
+     /**
+      * Defines the envelope of a crossfade.
+      *
+      * Note: The default value for crossfade points is 0,0,0,0. Layers with
+      * such a default value should be treated as if they would not have a
+      * crossfade.
+      */
      struct crossfade_t {
          #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
          uint8_t out_end;    ///< End postition of fade out.
          uint8_t out_start;  ///< Start position of fade out.
          uint8_t in_end;     ///< End position of fade in.
          uint8_t in_start;   ///< Start position of fade in.
+         #else // little endian
+         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.
          #endif // WORDS_BIGENDIAN
      };
-Line 300 
 namespace gig {
+Line 309 
 namespace gig {
          unsigned long loop_cycles_left;  ///< How many times the loop has still to be passed, this value will be decremented with each loop cycle.
      };
+     /**
+      * @brief Used for indicating the progress of a certain task.
+      *
+      * The function pointer argument has to be supplied with a valid
+      * function of the given signature which will then be called on
+      * progress changes. An equivalent progress_t structure will be passed
+      * back as argument to the callback function on each progress change.
+      * The factor field of the supplied progress_t structure will then
+      * reflect the current progress as value between 0.0 and 1.0. You might
+      * want to use the custom field for data needed in your callback
+      * function.
+      */
+     struct progress_t {
+         void (*callback)(progress_t*); ///< Callback function pointer which has to be assigned to a function for progress notification.
+         float factor;                  ///< Reflects current progress as value between 0.0 and 1.0.
+         void* custom;                  ///< This pointer can be used for arbitrary data.
+         float __range_min;             ///< Only for internal usage, do not modify!
+         float __range_max;             ///< Only for internal usage, do not modify!
+         progress_t();
+     };
      // just symbol prototyping
      class File;
      class Instrument;
      class Sample;
+     class Region;
      /** Encapsulates articulation information of a dimension region.
       *
-Line 372 
 namespace gig {
+Line 403 
 namespace gig {
              bool               VCFEnabled;                    ///< If filter should be used.
              vcf_type_t         VCFType;                       ///< Defines the general filter characteristic (lowpass, highpass, bandpass, etc.).
              vcf_cutoff_ctrl_t  VCFCutoffController;           ///< Specifies which external controller has influence on the filter cutoff frequency.
+             bool               VCFCutoffControllerInvert;     ///< Inverts values coming from the defined cutoff controller
              uint8_t            VCFCutoff;                     ///< Max. cutoff frequency.
              curve_type_t       VCFVelocityCurve;              ///< Defines a transformation curve for the incoming velocity values, affecting the VCF.
-             uint8_t            VCFVelocityScale;              ///< (0-127) Amount velocity controls VCF cutoff frequency (only if no other VCF cutoff controller is defined).
+             uint8_t            VCFVelocityScale;              ///< (0-127) Amount velocity controls VCF cutoff frequency (only if no other VCF cutoff controller is defined, otherwise this is the minimum cutoff).
              uint8_t            VCFVelocityDynamicRange;       ///< 0x04 = lowest, 0x00 = highest
              uint8_t            VCFResonance;                  ///< Firm internal filter resonance weight.
              bool               VCFResonanceDynamic;           ///< If <i>true</i>: Increases the resonance Q according to changes of controllers that actually control the VCF cutoff frequency (EG2, ext. VCF MIDI controller).
-Line 382 
 namespace gig {
+Line 414 
 namespace gig {
              bool               VCFKeyboardTracking;           ///< If <i>true</i>: VCF cutoff frequence will be dependend to the note key position relative to the defined breakpoint value.
              uint8_t            VCFKeyboardTrackingBreakpoint; ///< See VCFKeyboardTracking (0 - 127).
              // Key Velocity Transformations
-             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).
-             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).
-             uint8_t            VelocityResponseCurveScaling;  ///< 0 - 127
+             uint8_t            VelocityResponseCurveScaling;  ///< 0 - 127 (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead)
              curve_type_t       ReleaseVelocityResponseCurve;  ///< Defines a transformation curve to the incoming release veloctiy values affecting envelope times.
              uint8_t            ReleaseVelocityResponseDepth;  ///< Dynamic range of release velocity affecting envelope time (0 - 4).
              uint8_t            ReleaseTriggerDecay;           ///< 0 - 8
-Line 401 
 namespace gig {
+Line 433 
 namespace gig {
              bool               SustainDefeat;                 ///< If <i>true</i>: Sustain pedal will not hold a note.
              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.
              uint16_t           SampleStartOffset;             ///< Number of samples the sample start should be moved (0 - 2000).
+             double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)
              // derived attributes from DLS::Sampler
              DLS::Sampler::UnityNote;
              DLS::Sampler::FineTune;
-Line 410 
 namespace gig {
+Line 444 
 namespace gig {
              // Methods
              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
+             double GetVelocityRelease(uint8_t MIDIKeyVelocity);
+             double GetVelocityCutoff(uint8_t MIDIKeyVelocity);
          protected:
              DimensionRegion(RIFF::List* _3ewl);
             ~DimensionRegion();
-Line 448 
 namespace gig {
+Line 485 
 namespace gig {
              static uint              Instances;                  ///< Number of DimensionRegion instances.
              static VelocityTableMap* pVelocityTables;            ///< Contains the tables corresponding to the various velocity parameters (VelocityResponseCurve and VelocityResponseDepth).
              double*                  pVelocityAttenuationTable;  ///< Points to the velocity table corresponding to the velocity parameters of this DimensionRegion.
+             double*                  pVelocityReleaseTable;      ///< Points to the velocity table corresponding to the release velocity parameters of this DimensionRegion
+             double*                  pVelocityCutoffTable;       ///< Points to the velocity table corresponding to the filter velocity parameters of this DimensionRegion
              leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
+             double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
+             double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
      };
      /** Encapsulates sample waves used for playback. */
-Line 472 
 namespace gig {
+Line 513 
 namespace gig {
              uint32_t       LoopFraction;      ///< The fractional value specifies a fraction of a sample at which to loop (only if Loops > 0). This allows a loop to be fine tuned at a resolution greater than one sample. A value of 0 means no fraction, a value of 0x80000000 means 1/2 of a sample length. 0xFFFFFFFF is the smallest fraction of a sample that can be represented.
              uint32_t       LoopPlayCount;     ///< Number of times the loop should be played (only if Loops > 0, a value of 0 = infinite).
              bool           Compressed;        ///< If the sample wave is compressed (probably just interesting for instrument and sample editors, as this library already handles the decompression in it's sample access methods anyway).
+             uint32_t       TruncatedBits;     ///< For 24-bit compressed samples only: number of bits truncated during compression (0, 4 or 6)
+             bool           Dithered;          ///< For 24-bit compressed samples only: if dithering was used during compression with bit reduction
              // own methods
              buffer_t      LoadSampleData();
-Line 479 
 namespace gig {
+Line 522 
 namespace gig {
              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);
              buffer_t      GetCache();
+             // own static methods
+             static buffer_t CreateDecompressionBuffer(unsigned long MaxReadSize);
+             static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
              // overridden methods
              void          ReleaseSampleData();
              unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
              unsigned long GetPos();
-             unsigned long Read(void* pBuffer, unsigned long SampleCount);
+             unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
-             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);
          protected:
              static unsigned int  Instances;               ///< Number of instances of class Sample.
-             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.
              unsigned long        FrameOffset;             ///< Current offset (sample points) in current sample frame (for decompression only).
              unsigned long*       FrameTable;              ///< For positioning within compressed samples only: stores the offset values for each frame.
              unsigned long        SamplePos;               ///< For compressed samples only: stores the current position (in sample points).
+             unsigned long        SamplesInLastFrame;      ///< For compressed samples only: length of the last sample frame.
+             unsigned long        WorstCaseFrameSize;      ///< For compressed samples only: size (in bytes) of the largest possible sample frame.
+             unsigned long        SamplesPerFrame;         ///< For compressed samples only: number of samples in a full sample frame.
              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.
+             unsigned long        FileNo;                  ///< File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)
-             Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);
+             Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo = 0);
             ~Sample();
              /**
               * Swaps the order of the data words in the given memory area
-Line 556 
 namespace gig {
+Line 605 
 namespace gig {
                  return (A > B) ? B : A;
              }
              inline long Abs(long val) { return (val > 0) ? val : -val; }
+             // Guess size (in bytes) of a compressed sample
+             inline unsigned long GuessSize(unsigned long samples) {
+                 // 16 bit: assume all frames are compressed - 1 byte
+                 // per sample and 5 bytes header per 2048 samples
+                 // 24 bit: assume next best compression rate - 1.5
+                 // bytes per sample and 13 bytes header per 256
+                 // samples
+                 const unsigned long size =
+                     BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
+                                    : samples + (samples >> 10) * 5;
+                 // Double for stereo and add one worst case sample
+                 // frame
+                 return (Channels == 2 ? size << 1 : size) + WorstCaseFrameSize;
+             }
+             // Worst case amount of sample points that can be read with the
+             // given decompression buffer.
+             inline unsigned long WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
+                 return (unsigned long) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
+             }
          private:
              void ScanCompressedSample();
              friend class File;
-Line 567 
 namespace gig {
+Line 638 
 namespace gig {
      class Region : public DLS::Region {
          public:
              unsigned int            Dimensions;               ///< Number of defined dimensions.
-             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).
              uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains.
-             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).
+             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.
-             DimensionRegion* GetDimensionRegionByValue(uint Dim4Val, uint Dim3Val, uint Dim2Val, uint Dim1Val, uint Dim0Val);
+             DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
-             DimensionRegion* GetDimensionRegionByBit(uint8_t Dim4Bit, uint8_t Dim3Bit, uint8_t Dim2Bit, uint8_t Dim1Bit, uint8_t Dim0Bit);
+             DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
              Sample*          GetSample();
          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.
              Region(Instrument* pInstrument, RIFF::List* rgnList);
              void LoadDimensionRegions(RIFF::List* rgn);
-             Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex);
+             Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
             ~Region();
              friend class Instrument;
      };
-Line 618 
 namespace gig {
+Line 690 
 namespace gig {
              Region*   RegionKeyTable[128]; ///< fast lookup for the corresponding Region of a MIDI key
              int       RegionIndex;
-             Instrument(File* pFile, RIFF::List* insList);
+             Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
             ~Instrument();
              friend class File;
      };
-Line 638 
 namespace gig {
+Line 710 
 namespace gig {
              DLS::Resource::GetParent;
              // overridden  methods
              File(RIFF::File* pRIFF);
-             Sample*     GetFirstSample();     ///< 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.
              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.
              Instrument* GetNextInstrument();  ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
-             Instrument* GetInstrument(uint index);
+             Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
-            ~File() {};
+            ~File();
          protected:
              typedef std::list<Sample*>     SampleList;
              typedef std::list<Instrument*> InstrumentList;
-Line 653 
 namespace gig {
+Line 725 
 namespace gig {
              InstrumentList*          pInstruments;
              InstrumentList::iterator InstrumentsIterator;
-             void LoadSamples();
+             void LoadSamples(progress_t* pProgress = NULL);
-             void LoadInstruments();
+             void LoadInstruments(progress_t* pProgress = NULL);
              friend class Region;
+             std::list<RIFF::File*> ExtensionFiles;
      };
      /** Will be thrown whenever a gig specific error occurs while trying to access a Gigasampler File. */
-Line 665 
 namespace gig {
+Line 739 
 namespace gig {
              void PrintMessage();
      };
+     String libraryName();
+     String libraryVersion();
  } // namespace gig
  #endif // __GIG_H__

 Legend:



Removed from v.55
 


changed lines


 
Added in v.728
 Legend:



Removed from v.55
 


changed lines


 
Added in v.728
-Removed from v.55
+Added in v.728

	ViewVC Help
Powered by ViewVC