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

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

Parent Directory | Revision Log | View Patch Patch

-revision 858 by persson,
Sat May  6 11:29:29 2006 UTC
+revision 2467 by schoenebeck,
Sun Sep  8 16:25:42 2013 UTC
 Line 1
  /***************************************************************************
   *                                                                         *
-  *   libgig - C++ cross-platform Gigasampler format file loader library    *
+  *   libgig - C++ cross-platform Gigasampler format file access library    *
   *                                                                         *
-  *   Copyright (C) 2003-2005 by Christian Schoenebeck                      *
+  *   Copyright (C) 2003-2013 by Christian Schoenebeck                      *
   *                              <cuse@users.sourceforge.net>               *
   *                                                                         *
   *   This library is free software; you can redistribute it and/or modify  *
 Line 29
  #if WORDS_BIGENDIAN
  # define LIST_TYPE_3PRG 0x33707267
  # define LIST_TYPE_3EWL 0x3365776C
- # define CHUNK_ID_SMPL  0x736D706C
+ # define LIST_TYPE_3GRI 0x33677269
+ # define LIST_TYPE_3GNL 0x33676E6C
  # define CHUNK_ID_3GIX  0x33676978
  # define CHUNK_ID_3EWA  0x33657761
  # define CHUNK_ID_3LNK  0x336C6E6B
  # define CHUNK_ID_3EWG  0x33657767
  # define CHUNK_ID_EWAV  0x65776176
+ # define CHUNK_ID_3GNM  0x33676E6D
+ # define CHUNK_ID_EINF  0x65696E66
+ # define CHUNK_ID_3CRC  0x33637263
  #else  // little endian
  # define LIST_TYPE_3PRG 0x67727033
  # define LIST_TYPE_3EWL 0x6C776533
- # define CHUNK_ID_SMPL  0x6C706D73
+ # define LIST_TYPE_3GRI 0x69726733
+ # define LIST_TYPE_3GNL 0x6C6E6733
  # define CHUNK_ID_3GIX  0x78696733
  # define CHUNK_ID_3EWA  0x61776533
  # define CHUNK_ID_3LNK  0x6B6E6C33
  # define CHUNK_ID_3EWG  0x67776533
  # define CHUNK_ID_EWAV  0x76617765
+ # define CHUNK_ID_3GNM  0x6D6E6733
+ # define CHUNK_ID_EINF  0x666E6965
+ # define CHUNK_ID_3CRC  0x63726333
  #endif // WORDS_BIGENDIAN
  /** Gigasampler specific classes and definitions */
-Line 204 
 namespace gig {
+Line 212 
 namespace gig {
          dimension_none              = 0x00, ///< Dimension not in use.
          dimension_samplechannel     = 0x80, ///< If used sample has more than one channel (thus is not mono).
          dimension_layer             = 0x81, ///< For layering of up to 8 instruments (and eventually crossfading of 2 or 4 layers).
-         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 in gig2 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, ///< 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_smartmidi         = 0x88, ///< For MIDI tools like legato and repetition mode
+         dimension_roundrobinkeyboard = 0x89, ///< Different samples triggered each time a note is played, any key advances the counter
          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 316 
 namespace gig {
+Line 326 
 namespace gig {
      class Instrument;
      class Sample;
      class Region;
+     class Group;
-     /** Encapsulates articulation information of a dimension region.
+     /** @brief Encapsulates articulation information of a dimension region.
       *
       *  Every Gigasampler Instrument has at least one dimension region
       *  (exactly then when it has no dimension defined).
-Line 331 
 namespace gig {
+Line 342 
 namespace gig {
       */
      class DimensionRegion : protected DLS::Sampler {
          public:
-             uint8_t            VelocityUpperLimit;            ///< Defines the upper velocity value limit of a velocity split (only if an user defined limit was set, thus a value not equal to 128/NumberOfSplits, else this value is 0).
+             uint8_t            VelocityUpperLimit;            ///< Defines the upper velocity value limit of a velocity split (only if an user defined limit was set, thus a value not equal to 128/NumberOfSplits, else this value is 0). Only for gig2, otherwise the DimensionUpperLimts are used instead.
              Sample*            pSample;                       ///< Points to the Sample which is assigned to the dimension region.
              // Sample Amplitude EG/LFO
              uint16_t           EG1PreAttack;                  ///< Preattack value of the sample amplitude EG (0 - 1000 permille).
-Line 383 
 namespace gig {
+Line 394 
 namespace gig {
              // Filter
              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.
+             vcf_cutoff_ctrl_t  VCFCutoffController;           ///< Specifies which external controller has influence on the filter cutoff frequency. @deprecated Don't alter directly, use SetVCFCutoffController() instead!
              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.
+             curve_type_t       VCFVelocityCurve;              ///< Defines a transformation curve for the incoming velocity values, affecting the VCF. @deprecated Don't alter directly, use SetVCFVelocityCurve() instead!
-             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            VCFVelocityScale;              ///< (0-127) Amount velocity controls VCF cutoff frequency (only if no other VCF cutoff controller is defined, otherwise this is the minimum cutoff). @deprecated Don't alter directly, use SetVCFVelocityScale() instead!
-             uint8_t            VCFVelocityDynamicRange;       ///< 0x04 = lowest, 0x00 = highest
+             uint8_t            VCFVelocityDynamicRange;       ///< 0x04 = lowest, 0x00 = highest . @deprecated Don't alter directly, use SetVCFVelocityDynamicRange() instead!
              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).
              vcf_res_ctrl_t     VCFResonanceController;        ///< Specifies which external controller has influence on the filter resonance Q.
              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 (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead).
+             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). @deprecated Don't alter directly, use SetVelocityResponseCurve() instead!
-             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            VelocityResponseDepth;         ///< Dynamic range of velocity affecting amplitude (0 - 4) (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead). @deprecated Don't alter directly, use SetVelocityResponseDepth() instead!
-             uint8_t            VelocityResponseCurveScaling;  ///< 0 - 127 (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead)
+             uint8_t            VelocityResponseCurveScaling;  ///< 0 - 127 (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead). @deprecated Don't alter directly, use SetVelocityResponseCurveScaling() instead!
-             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. @deprecated Don't alter directly, use SetReleaseVelocityResponseCurve() instead!
-             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). @deprecated Don't alter directly, use SetReleaseVelocityResponseDepth() instead!
              uint8_t            ReleaseTriggerDecay;           ///< 0 - 8
              // Mix / Layer
              crossfade_t        Crossfade;
-Line 415 
 namespace gig {
+Line 426 
 namespace gig {
              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)
+             uint8_t            DimensionUpperLimits[8];       ///< gig3: defines the upper limit of the dimension values for this dimension region
              // derived attributes from DLS::Sampler
-             DLS::Sampler::UnityNote;
+             using DLS::Sampler::UnityNote;
-             DLS::Sampler::FineTune;
+             using DLS::Sampler::FineTune;
-             DLS::Sampler::Gain;
+             using DLS::Sampler::Gain;
-             DLS::Sampler::SampleLoops;
+             using DLS::Sampler::SampleLoops;
-             DLS::Sampler::pSampleLoops;
+             using DLS::Sampler::pSampleLoops;
              // own methods
              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
              double GetVelocityRelease(uint8_t MIDIKeyVelocity);
              double GetVelocityCutoff(uint8_t MIDIKeyVelocity);
+             void SetVelocityResponseCurve(curve_type_t curve);
+             void SetVelocityResponseDepth(uint8_t depth);
+             void SetVelocityResponseCurveScaling(uint8_t scaling);
+             void SetReleaseVelocityResponseCurve(curve_type_t curve);
+             void SetReleaseVelocityResponseDepth(uint8_t depth);
+             void SetVCFCutoffController(vcf_cutoff_ctrl_t controller);
+             void SetVCFVelocityCurve(curve_type_t curve);
+             void SetVCFVelocityDynamicRange(uint8_t range);
+             void SetVCFVelocityScale(uint8_t scaling);
+             Region* GetParent() const;
+             // derived methods
+             using DLS::Sampler::AddSampleLoop;
+             using DLS::Sampler::DeleteSampleLoop;
              // overridden methods
+             virtual void SetGain(int32_t gain);
              virtual void UpdateChunks();
+             virtual void CopyAssign(const DimensionRegion* orig);
          protected:
              uint8_t* VelocityTable; ///< For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number.
-             DimensionRegion(RIFF::List* _3ewl);
+             DimensionRegion(Region* pParent, RIFF::List* _3ewl);
+             DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);
             ~DimensionRegion();
              friend class Region;
          private:
-Line 470 
 namespace gig {
+Line 498 
 namespace gig {
              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
+             Region*                  pRegion;
              leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
              _lev_ctrl_t     EncodeLeverageController(leverage_ctrl_t DecodedController);
+             double* GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth);
+             double* GetCutoffVelocityTable(curve_type_t vcfVelocityCurve, uint8_t vcfVelocityDynamicRange, uint8_t vcfVelocityScale, vcf_cutoff_ctrl_t vcfCutoffController);
              double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
      };
-Line 486 
 namespace gig {
+Line 517 
 namespace gig {
       * will create the mandatory RIFF chunk which will hold the sample wave
       * data and / or resize the file so you will be able to Write() the
       * sample data directly to disk.
+      *
+      * @e Caution: for gig synthesis, most looping relevant information are
+      * retrieved from the respective DimensionRegon instead from the Sample
+      * itself. This was made for allowing different loop definitions for the
+      * same sample under different conditions.
       */
      class Sample : public DLS::Sample {
          public:
-             uint16_t       SampleGroup;
              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       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       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.
-Line 497 
 namespace gig {
+Line 532 
 namespace gig {
              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.
              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.
              uint32_t       SMPTEOffset;       ///< The SMPTE Offset value specifies the time offset to be used for the synchronization / calibration to the first sample in the waveform. This value uses a format of 0xhhmmssff where hh is a signed value that specifies the number of hours (-23 to 23), mm is an unsigned value that specifies the number of minutes (0 to 59), ss is an unsigned value that specifies the number of seconds (0 to 59) and ff is an unsigned value that specifies the number of frames (0 to -1).
-             uint32_t       Loops;             ///< Number of defined sample loops (so far only seen single loops in gig files - please report me if you encounter more!).
+             uint32_t       Loops;             ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: Number of defined sample loops. So far only seen single loops in gig files - please report if you encounter more!)
              uint32_t       LoopID;            ///< Specifies the unique ID that corresponds to one of the defined cue points in the cue point list (only if Loops > 0), as the Gigasampler format only allows one loop definition at the moment, this attribute isn't really useful for anything.
-             loop_type_t    LoopType;          ///< The type field defines how the waveform samples will be looped (only if Loops > 0).
+             loop_type_t    LoopType;          ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The type field defines how the waveform samples will be looped.)
-             uint32_t       LoopStart;         ///< The start value specifies the offset (in sample points) in the waveform data of the first sample to be played in the loop (only if Loops > 0).
+             uint32_t       LoopStart;         ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The start value specifies the offset [in sample points] in the waveform data of the first sample to be played in the loop [only if Loops > 0].)
-             uint32_t       LoopEnd;           ///< The end value specifies the offset (in sample points) in the waveform data which represents the end of the loop (only if Loops > 0).
+             uint32_t       LoopEnd;           ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The end value specifies the offset [in sample points] in the waveform data which represents the end of the loop [only if Loops > 0].)
-             uint32_t       LoopSize;          ///< Length of the looping area (in sample points) which is equivalent to <i>LoopEnd - LoopStart</i>.
+             uint32_t       LoopSize;          ///< @e Caution: Use the respective fields in the DimensionRegion instead of this one! (Intended purpose: Length of the looping area [in sample points] which is equivalent to @code LoopEnd - LoopStart @endcode.)
-             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       LoopFraction;      ///< The fractional value specifies a fraction of a sample at which to loop. 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).
+             uint32_t       LoopPlayCount;     ///< Number of times the loop should be played (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
-Line 524 
 namespace gig {
+Line 559 
 namespace gig {
              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, buffer_t* pExternalDecompressionBuffer = NULL);
-             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);
              unsigned long Write(void* pBuffer, unsigned long SampleCount);
+             Group*        GetGroup() const;
              virtual void  UpdateChunks();
          protected:
              static unsigned int  Instances;               ///< Number of instances of class Sample.
              static buffer_t      InternalDecompressionBuffer; ///< Buffer used for decompression as well as for truncation of 24 Bit -> 16 Bit samples.
+             Group*               pGroup;                  ///< pointer to the Group this sample belongs to (always not-NULL)
              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).
-Line 540 
 namespace gig {
+Line 577 
 namespace gig {
              unsigned long        FileNo;                  ///< File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)
              RIFF::Chunk*         pCk3gix;
              RIFF::Chunk*         pCkSmpl;
+             uint32_t             crc;                     ///< CRC-32 checksum of the raw sample data
              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo = 0);
             ~Sample();
-Line 569 
 namespace gig {
+Line 607 
 namespace gig {
              void ScanCompressedSample();
              friend class File;
              friend class Region;
+             friend class Group; // allow to modify protected member pGroup
      };
      // TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions)
-Line 576 
 namespace gig {
+Line 615 
 namespace gig {
      class Region : public DLS::Region {
          public:
              unsigned int            Dimensions;               ///< Number of defined dimensions, do not alter!
-             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.
              uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains, do not alter!
-             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).
              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!
+             // own methods
              DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
              DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
              Sample*          GetSample();
              void             AddDimension(dimension_def_t* pDimDef);
              void             DeleteDimension(dimension_def_t* pDimDef);
+             // overridden methods
+             virtual void     SetKeyRange(uint16_t Low, uint16_t High);
              virtual void     UpdateChunks();
+             virtual void     CopyAssign(const Region* orig);
          protected:
              Region(Instrument* pInstrument, RIFF::List* rgnList);
              void LoadDimensionRegions(RIFF::List* rgn);
-Line 596 
 namespace gig {
+Line 639 
 namespace gig {
              friend class Instrument;
      };
+     /** Abstract base class for all MIDI rules. */
+     class MidiRule {
+         public:
+             virtual ~MidiRule() { }
+         protected:
+             virtual void UpdateChunks(uint8_t* pData) const = 0;
+             friend class Instrument;
+     };
+     /** MIDI rule for triggering notes by control change events. */
+     class MidiRuleCtrlTrigger : public MidiRule {
+         public:
+             uint8_t ControllerNumber;   ///< MIDI controller number.
+             uint8_t Triggers;           ///< Number of triggers.
+             struct trigger_t {
+                 uint8_t TriggerPoint;   ///< The CC value to pass for the note to be triggered.
+                 bool    Descending;     ///< If the change in CC value should be downwards.
+                 uint8_t VelSensitivity; ///< How sensitive the velocity should be to the speed of the controller change.
+                 uint8_t Key;            ///< Key to trigger.
+                 bool    NoteOff;        ///< If a note off should be triggered instead of a note on.
+                 uint8_t Velocity;       ///< Velocity of the note to trigger. 255 means that velocity should depend on the speed of the controller change.
+                 bool    OverridePedal;  ///< If a note off should be triggered even if the sustain pedal is down.
+             } pTriggers[32];
+         protected:
+             MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg);
+             MidiRuleCtrlTrigger();
+             void UpdateChunks(uint8_t* pData) const;
+             friend class Instrument;
+     };
+     /** MIDI rule for instruments with legato samples. */
+     class MidiRuleLegato : public MidiRule {
+         public:
+             uint8_t LegatoSamples;     ///< Number of legato samples per key in each direction (always 12)
+             bool BypassUseController;  ///< If a controller should be used to bypass the sustain note
+             uint8_t BypassKey;         ///< Key to be used to bypass the sustain note
+             uint8_t BypassController;  ///< Controller to be used to bypass the sustain note
+             uint16_t ThresholdTime;    ///< Maximum time (ms) between two notes that should be played legato
+             uint16_t ReleaseTime;      ///< Release time
+             range_t KeyRange;          ///< Key range for legato notes
+             uint8_t ReleaseTriggerKey; ///< Key triggering release samples
+             uint8_t AltSustain1Key;    ///< Key triggering alternate sustain samples
+             uint8_t AltSustain2Key;    ///< Key triggering a second set of alternate sustain samples
+         protected:
+             MidiRuleLegato(RIFF::Chunk* _3ewg);
+             MidiRuleLegato();
+             void UpdateChunks(uint8_t* pData) const;
+             friend class Instrument;
+     };
+     /** MIDI rule to automatically cycle through specified sequences of different articulations. The instrument must be using the smartmidi dimension. */
+     class MidiRuleAlternator : public MidiRule {
+         public:
+             uint8_t Articulations;     ///< Number of articulations in the instrument
+             String pArticulations[32]; ///< Names of the articulations
+             range_t PlayRange;         ///< Key range of the playable keys in the instrument
+             uint8_t Patterns;          ///< Number of alternator patterns
+             struct pattern_t {
+                 String Name;           ///< Name of the pattern
+                 int Size;              ///< Number of steps in the pattern
+                 const uint8_t& operator[](int i) const { /// Articulation to play
+                     return data[i];
+                 }
+                 uint8_t& operator[](int i) {
+                     return data[i];
+                 }
+             private:
+                 uint8_t data[32];
+             } pPatterns[32];           ///< A pattern is a sequence of articulation numbers
+             typedef enum {
+                 selector_none,
+                 selector_key_switch,
+                 selector_controller
+             } selector_t;
+             selector_t Selector;       ///< Method by which pattern is chosen
+             range_t KeySwitchRange;    ///< Key range for key switch selector
+             uint8_t Controller;        ///< CC number for controller selector
+             bool Polyphonic;           ///< If alternator should step forward only when all notes are off
+             bool Chained;              ///< If all patterns should be chained together
+         protected:
+             MidiRuleAlternator(RIFF::Chunk* _3ewg);
+             MidiRuleAlternator();
+             void UpdateChunks(uint8_t* pData) const;
+             friend class Instrument;
+     };
+     /** A MIDI rule not yet implemented by libgig. */
+     class MidiRuleUnknown : public MidiRule {
+         protected:
+             MidiRuleUnknown() { }
+             void UpdateChunks(uint8_t* pData) const { }
+             friend class Instrument;
+     };
      /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */
      class Instrument : protected DLS::Instrument {
          public:
              // derived attributes from DLS::Resource
-             DLS::Resource::pInfo;
+             using DLS::Resource::pInfo;
-             DLS::Resource::pDLSID;
+             using DLS::Resource::pDLSID;
              // derived attributes from DLS::Instrument
-             DLS::Instrument::IsDrum;
+             using DLS::Instrument::IsDrum;
-             DLS::Instrument::MIDIBank;
+             using DLS::Instrument::MIDIBank;
-             DLS::Instrument::MIDIBankCoarse;
+             using DLS::Instrument::MIDIBankCoarse;
-             DLS::Instrument::MIDIBankFine;
+             using DLS::Instrument::MIDIBankFine;
-             DLS::Instrument::MIDIProgram;
+             using DLS::Instrument::MIDIProgram;
-             DLS::Instrument::Regions;
+             using DLS::Instrument::Regions;
              // own attributes
              int32_t   Attenuation;       ///< in dB
              uint16_t  EffectSend;
-Line 619 
 namespace gig {
+Line 763 
 namespace gig {
              // derived methods from DLS::Resource
-             DLS::Resource::GetParent;
+             using DLS::Resource::GetParent;
              // overridden methods
              Region*   GetFirstRegion();
              Region*   GetNextRegion();
              Region*   AddRegion();
              void      DeleteRegion(Region* pRegion);
              virtual void UpdateChunks();
+             virtual void CopyAssign(const Instrument* orig);
              // own methods
              Region*   GetRegion(unsigned int Key);
+             MidiRule* GetMidiRule(int i);
+             MidiRuleCtrlTrigger* AddMidiRuleCtrlTrigger();
+             MidiRuleLegato*      AddMidiRuleLegato();
+             MidiRuleAlternator*  AddMidiRuleAlternator();
+             void      DeleteMidiRule(int i);
          protected:
              Region*   RegionKeyTable[128]; ///< fast lookup for the corresponding Region of a MIDI key
-Line 635 
 namespace gig {
+Line 785 
 namespace gig {
             ~Instrument();
              void UpdateRegionKeyTable();
              friend class File;
+             friend class Region; // so Region can call UpdateRegionKeyTable()
+         private:
+             MidiRule** pMidiRules;
+     };
+     /** @brief Group of Gigasampler objects
+      *
+      * Groups help to organize a huge collection of Gigasampler objects.
+      * Groups are not concerned at all for the synthesis, but they help
+      * sound library developers when working on complex instruments with an
+      * instrument editor (as long as that instrument editor supports it ;-).
+      *
+      * At the moment, it seems as only samples can be grouped together in
+      * the Gigasampler format yet. If this is false in the meantime, please
+      * tell us !
+      *
+      * A sample is always assigned to exactly one Group. This also means
+      * there is always at least one Group in a .gig file, no matter if you
+      * created one yet or not.
+      */
+     class Group {
+         public:
+             String Name; ///< Stores the name of this Group.
+             Sample* GetFirstSample();
+             Sample* GetNextSample();
+             void AddSample(Sample* pSample);
+         protected:
+             Group(File* file, RIFF::Chunk* ck3gnm);
+             virtual ~Group();
+             virtual void UpdateChunks();
+             void MoveAll();
+             friend class File;
+         private:
+             File*        pFile;
+             RIFF::Chunk* pNameChunk; ///< '3gnm' chunk
      };
-     // TODO: <3gnm> chunk not added yet (just contains the names of the sample groups)
      /** Parses Gigasampler files and provides abstract access to the data. */
      class File : protected DLS::File {
          public:
+             static const DLS::version_t VERSION_2;
+             static const DLS::version_t VERSION_3;
              // derived attributes from DLS::Resource
-             DLS::Resource::pInfo;
+             using DLS::Resource::pInfo;
-             DLS::Resource::pDLSID;
+             using DLS::Resource::pDLSID;
              // derived attributes from DLS::File
-             DLS::File::pVersion;
+             using DLS::File::pVersion;
-             DLS::File::Instruments;
+             using DLS::File::Instruments;
              // derived methods from DLS::Resource
-             DLS::Resource::GetParent;
+             using DLS::Resource::GetParent;
              // derived methods from DLS::File
-             DLS::File::Save;
+             using DLS::File::Save;
+             using DLS::File::GetFileName;
              // overridden  methods
              File();
              File(RIFF::File* pRIFF);
              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.
              Sample*     AddSample();
              void        DeleteSample(Sample* pSample);
+             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, progress_t* pProgress = NULL);
              Instrument* AddInstrument();
+             Instrument* AddDuplicateInstrument(const Instrument* orig);
              void        DeleteInstrument(Instrument* pInstrument);
+             Group*      GetFirstGroup(); ///< Returns a pointer to the first <i>Group</i> object of the file, <i>NULL</i> otherwise.
+             Group*      GetNextGroup();  ///< Returns a pointer to the next <i>Group</i> object of the file, <i>NULL</i> otherwise.
+             Group*      GetGroup(uint index);
+             Group*      AddGroup();
+             void        DeleteGroup(Group* pGroup);
+             void        DeleteGroupOnly(Group* pGroup);
+             void        SetAutoLoad(bool b);
+             bool        GetAutoLoad();
+             virtual    ~File();
+             virtual void UpdateChunks();
          protected:
              // overridden protected methods from DLS::File
              virtual void LoadSamples();
              virtual void LoadInstruments();
+             virtual void LoadGroups();
              // own protected methods
              virtual void LoadSamples(progress_t* pProgress);
              virtual void LoadInstruments(progress_t* pProgress);
+             void SetSampleChecksum(Sample* pSample, uint32_t crc);
              friend class Region;
+             friend class Sample;
+             friend class Group; // so Group can access protected member pRIFF
+         private:
+             std::list<Group*>*          pGroups;
+             std::list<Group*>::iterator GroupsIterator;
+             bool                        bAutoLoad;
      };
-     /** 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. Note: In your application you should
+      * better catch for RIFF::Exception rather than this one, except you
+      * explicitly want to catch and handle gig::Exception, DLS::Exception
+      * and RIFF::Exception independently, which usually shouldn't be
+      * necessary though.
+      */
      class Exception : public DLS::Exception {
          public:
              Exception(String Message);

 Legend:



Removed from v.858
 


changed lines


 
Added in v.2467
 Legend:



Removed from v.858
 


changed lines


 
Added in v.2467
-Removed from v.858
+Added in v.2467

	ViewVC Help
Powered by ViewVC