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

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

Parent Directory | Revision Log | View Patch Patch

-revision 2334 by persson,
Sat Mar 17 06:18:52 2012 UTC
+revision 3173 by schoenebeck,
Wed May 10 23:07:28 2017 UTC
 Line 2
   *                                                                         *
   *   libgig - C++ cross-platform Gigasampler format file access library    *
   *                                                                         *
-  *   Copyright (C) 2003-2012 by Christian Schoenebeck                      *
+  *   Copyright (C) 2003-2017 by Christian Schoenebeck                      *
   *                              <cuse@users.sourceforge.net>               *
   *                                                                         *
   *   This library is free software; you can redistribute it and/or modify  *
 Line 25
  #define __GIG_H__
  #include "DLS.h"
+ #include <vector>
+ #ifndef __has_feature
+ # define __has_feature(x) 0
+ #endif
+ #ifndef HAVE_RTTI
+ # if __GXX_RTTI || __has_feature(cxx_rtti) || _CPPRTTI
+ #  define HAVE_RTTI 1
+ # else
+ #  define HAVE_RTTI 0
+ # endif
+ #endif
+ #if HAVE_RTTI
+ # include <typeinfo>
+ #else
+ # warning No RTTI available!
+ #endif
  #if WORDS_BIGENDIAN
  # define LIST_TYPE_3PRG 0x33707267
  # define LIST_TYPE_3EWL 0x3365776C
  # define LIST_TYPE_3GRI 0x33677269
  # define LIST_TYPE_3GNL 0x33676E6C
+ # define LIST_TYPE_3LS  0x334c5320 // own gig format extension
+ # define LIST_TYPE_RTIS 0x52544953 // own gig format extension
  # define CHUNK_ID_3GIX  0x33676978
  # define CHUNK_ID_3EWA  0x33657761
  # define CHUNK_ID_3LNK  0x336C6E6B
-Line 39
+Line 58
  # define CHUNK_ID_3GNM  0x33676E6D
  # define CHUNK_ID_EINF  0x65696E66
  # define CHUNK_ID_3CRC  0x33637263
+ # define CHUNK_ID_SCRI  0x53637269 // own gig format extension
+ # define CHUNK_ID_LSNM  0x4c534e4d // own gig format extension
+ # define CHUNK_ID_SCSL  0x5343534c // own gig format extension
  #else  // little endian
  # define LIST_TYPE_3PRG 0x67727033
  # define LIST_TYPE_3EWL 0x6C776533
  # define LIST_TYPE_3GRI 0x69726733
  # define LIST_TYPE_3GNL 0x6C6E6733
+ # define LIST_TYPE_3LS  0x20534c33 // own gig format extension
+ # define LIST_TYPE_RTIS 0x53495452 // own gig format extension
  # define CHUNK_ID_3GIX  0x78696733
  # define CHUNK_ID_3EWA  0x61776533
  # define CHUNK_ID_3LNK  0x6B6E6C33
-Line 52
+Line 76
  # define CHUNK_ID_3GNM  0x6D6E6733
  # define CHUNK_ID_EINF  0x666E6965
  # define CHUNK_ID_3CRC  0x63726333
+ # define CHUNK_ID_SCRI  0x69726353 // own gig format extension
+ # define CHUNK_ID_LSNM  0x4d4e534c // own gig format extension
+ # define CHUNK_ID_SCSL  0x4c534353 // own gig format extension
  #endif // WORDS_BIGENDIAN
- /** Gigasampler specific classes and definitions */
+ #ifndef GIG_DECLARE_ENUM
+ # define GIG_DECLARE_ENUM(type, ...) enum type { __VA_ARGS__ }
+ #endif
+ // just symbol prototyping (since Serialization.h not included by default here)
+ namespace Serialization { class Archive; }
+ /** Gigasampler/GigaStudio specific classes and definitions */
  namespace gig {
      typedef std::string String;
+     typedef RIFF::progress_t progress_t;
+     typedef RIFF::file_offset_t file_offset_t;
      /** Lower and upper limit of a range. */
      struct range_t {
-Line 68 
 namespace gig {
+Line 104 
 namespace gig {
      /** Pointer address and size of a buffer. */
      struct buffer_t {
          void*         pStart;            ///< Points to the beginning of the buffer.
-         unsigned long Size;              ///< Size of the actual data in the buffer in bytes.
+         file_offset_t 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. :)
+         file_offset_t 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;
-Line 77 
 namespace gig {
+Line 113 
 namespace gig {
          }
      };
-     /** Standard types of sample loops. */
+     /** Standard types of sample loops.
-     typedef enum {
+      *
+      * @see countEnum(), enumKey(), enumKeys(), enumValue()
+      */
+     GIG_DECLARE_ENUM(loop_type_t,
          loop_type_normal        = 0x00000000,  ///< Loop forward (normal)
          loop_type_bidirectional = 0x00000001,  ///< Alternating loop (forward/backward, also known as Ping Pong)
          loop_type_backward      = 0x00000002   ///< Loop backward (reverse)
-     } loop_type_t;
+     );
-     /** Society of Motion Pictures and Television E time format. */
+     /** Society of Motion Pictures and Television E time format.
-     typedef enum {
+      *
+      * @see countEnum(), enumKey(), enumKeys(), enumValue()
+      */
+     GIG_DECLARE_ENUM(smpte_format_t,
          smpte_format_no_offset          = 0x00000000,  ///< no SMPTE offset
          smpte_format_24_frames          = 0x00000018,  ///< 24 frames per second
          smpte_format_25_frames          = 0x00000019,  ///< 25 frames per second
          smpte_format_30_frames_dropping = 0x0000001D,  ///< 30 frames per second with frame dropping (30 drop)
          smpte_format_30_frames          = 0x0000001E   ///< 30 frames per second
-     } smpte_format_t;
+     );
-     /** Defines the shape of a function graph. */
+     /** Defines the shape of a function graph.
-     typedef enum {
+      *
+      * @see countEnum(), enumKey(), enumKeys(), enumValue()
+      */
+     GIG_DECLARE_ENUM(curve_type_t,
          curve_type_nonlinear = 0,
          curve_type_linear    = 1,
          curve_type_special   = 2,
          curve_type_unknown   = 0xffffffff
-     } curve_type_t;
+     );
-     /** Dimensions allow to bypass one of the following controllers. */
+     /** Dimensions allow to bypass one of the following controllers.
-     typedef enum {
+      *
+      * @see countEnum(), enumKey(), enumKeys(), enumValue()
+      */
+     GIG_DECLARE_ENUM(dim_bypass_ctrl_t,
          dim_bypass_ctrl_none,
          dim_bypass_ctrl_94,   ///< Effect 4 Depth (MIDI Controller 94)
          dim_bypass_ctrl_95    ///< Effect 5 Depth (MIDI Controller 95)
-     } dim_bypass_ctrl_t;
+     );
-     /** Defines how LFO3 is controlled by. */
+     /** Defines how LFO3 is controlled by.
-     typedef enum {
+      *
+      * @see countEnum(), enumKey(), enumKeys(), enumValue()
+      */
+     GIG_DECLARE_ENUM(lfo3_ctrl_t,
          lfo3_ctrl_internal            = 0x00, ///< Only internally controlled.
          lfo3_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.
          lfo3_ctrl_aftertouch          = 0x02, ///< Only controlled by aftertouch controller.
          lfo3_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.
          lfo3_ctrl_internal_aftertouch = 0x04  ///< Controlled internally and by aftertouch controller.
-     } lfo3_ctrl_t;
+     );
-     /** Defines how LFO2 is controlled by. */
+     /** Defines how LFO2 is controlled by.
-     typedef enum {
+      *
+      * @see countEnum(), enumKey(), enumKeys(), enumValue()
+      */
+     GIG_DECLARE_ENUM(lfo2_ctrl_t,
          lfo2_ctrl_internal            = 0x00, ///< Only internally controlled.
          lfo2_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.
          lfo2_ctrl_foot                = 0x02, ///< Only controlled by external foot controller.
          lfo2_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.
          lfo2_ctrl_internal_foot       = 0x04  ///< Controlled internally and by external foot controller.
-     } lfo2_ctrl_t;
+     );
-     /** Defines how LFO1 is controlled by. */
+     /** Defines how LFO1 is controlled by.
-     typedef enum {
+      *
+      * @see countEnum(), enumKey(), enumKeys(), enumValue()
+      */
+     GIG_DECLARE_ENUM(lfo1_ctrl_t,
          lfo1_ctrl_internal            = 0x00, ///< Only internally controlled.
          lfo1_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.
          lfo1_ctrl_breath              = 0x02, ///< Only controlled by external breath controller.
          lfo1_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.
          lfo1_ctrl_internal_breath     = 0x04  ///< Controlled internally and by external breath controller.
-     } lfo1_ctrl_t;
+     );
-     /** Defines how the filter cutoff frequency is controlled by. */
+     /** Defines how the filter cutoff frequency is controlled by.
-     typedef enum {
+      *
+      * @see countEnum(), enumKey(), enumKeys(), enumValue()
+      */
+     GIG_DECLARE_ENUM(vcf_cutoff_ctrl_t,
          vcf_cutoff_ctrl_none         = 0x00,
          vcf_cutoff_ctrl_none2        = 0x01,  ///< The difference between none and none2 is unknown
          vcf_cutoff_ctrl_modwheel     = 0x81,  ///< Modulation Wheel (MIDI Controller 1)
-Line 149 
 namespace gig {
+Line 209 
 namespace gig {
          vcf_cutoff_ctrl_genpurpose7  = 0xd2,  ///< General Purpose Controller 7 (Button, MIDI Controller 82)
          vcf_cutoff_ctrl_genpurpose8  = 0xd3,  ///< General Purpose Controller 8 (Button, MIDI Controller 83)
          vcf_cutoff_ctrl_aftertouch   = 0x80   ///< Key Pressure
-     } vcf_cutoff_ctrl_t;
+     );
-     /** Defines how the filter resonance is controlled by. */
+     /** Defines how the filter resonance is controlled by.
-     typedef enum {
+      *
+      * @see countEnum(), enumKey(), enumKeys(), enumValue()
+      */
+     GIG_DECLARE_ENUM(vcf_res_ctrl_t,
          vcf_res_ctrl_none        = 0xffffffff,
          vcf_res_ctrl_genpurpose3 = 0,           ///< General Purpose Controller 3 (Slider, MIDI Controller 18)
          vcf_res_ctrl_genpurpose4 = 1,           ///< General Purpose Controller 4 (Slider, MIDI Controller 19)
          vcf_res_ctrl_genpurpose5 = 2,           ///< General Purpose Controller 5 (Button, MIDI Controller 80)
          vcf_res_ctrl_genpurpose6 = 3            ///< General Purpose Controller 6 (Button, MIDI Controller 81)
-     } vcf_res_ctrl_t;
+     );
      /**
       * Defines a controller that has a certain contrained influence on a
-Line 169 
 namespace gig {
+Line 232 
 namespace gig {
       * attenuation_ctrl_t, eg1_ctrl_t or eg2_ctrl_t) in your code!
       */
      struct leverage_ctrl_t {
-         typedef enum {
+         /** Defines possible controllers.
+          *
+          * @see countEnum(), enumKey(), enumKeys(), enumValue()
+          */
+         GIG_DECLARE_ENUM(type_t,
              type_none              = 0x00, ///< No controller defined
              type_channelaftertouch = 0x2f, ///< Channel Key Pressure
              type_velocity          = 0xff, ///< Key Velocity
              type_controlchange     = 0xfe  ///< Ordinary MIDI control change controller, see field 'controller_number'
-         } type_t;
+         );
          type_t type;              ///< Controller type
          uint   controller_number; ///< MIDI controller number if this controller is a control change controller, 0 otherwise
+         void serialize(Serialization::Archive* archive);
      };
      /**
-Line 207 
 namespace gig {
+Line 276 
 namespace gig {
       * dimension zones is always a power of two. All dimensions can have up
       * to 32 zones (except the layer dimension with only up to 8 zones and
       * the samplechannel dimension which currently allows only 2 zones).
+      *
+      * @see countEnum(), enumKey(), enumKeys(), enumValue()
       */
-     typedef enum {
+     GIG_DECLARE_ENUM(dimension_t,
          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).
-Line 243 
 namespace gig {
+Line 314 
 namespace gig {
          dimension_effect3depth      = 0x5d, ///< Effect 3 Depth (MIDI Controller 93)
          dimension_effect4depth      = 0x5e, ///< Effect 4 Depth (MIDI Controller 94)
          dimension_effect5depth      = 0x5f  ///< Effect 5 Depth (MIDI Controller 95)
-     } dimension_t;
+     );
      /**
       * Intended for internal usage: will be used to convert a dimension value
       * into the corresponding dimension bit number.
+      *
+      * @see countEnum(), enumKey(), enumKeys(), enumValue()
       */
-     typedef enum {
+     GIG_DECLARE_ENUM(split_type_t,
          split_type_normal,         ///< dimension value between 0-127
          split_type_bit             ///< dimension values are already the sought bit number
-     } split_type_t;
+     );
      /** General dimension definition. */
      struct dimension_def_t {
-Line 263 
 namespace gig {
+Line 336 
 namespace gig {
          float        zone_size;  ///< Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only, 0 otherwise.
      };
-     /** Defines which frequencies are filtered by the VCF. */
+     /** Defines which frequencies are filtered by the VCF.
-     typedef enum {
+      *
+      * @see countEnum(), enumKey(), enumKeys(), enumValue()
+      */
+     GIG_DECLARE_ENUM(vcf_type_t,
          vcf_type_lowpass      = 0x00,
          vcf_type_lowpassturbo = 0xff, ///< More poles than normal lowpass
          vcf_type_bandpass     = 0x01,
          vcf_type_highpass     = 0x02,
          vcf_type_bandreject   = 0x03
-     } vcf_type_t;
+     );
      /**
       * Defines the envelope of a crossfade.
-Line 291 
 namespace gig {
+Line 367 
 namespace gig {
          uint8_t out_start;  ///< Start position of fade out.
          uint8_t out_end;    ///< End postition of fade out.
          #endif // WORDS_BIGENDIAN
+         void serialize(Serialization::Archive* archive);
      };
      /** Reflects the current playback state for a sample. */
      struct playback_state_t {
-         unsigned long position;          ///< Current position within the sample.
+         file_offset_t position;          ///< Current position within the sample.
          bool          reverse;           ///< If playback direction is currently backwards (in case there is a pingpong or reverse loop defined).
-         unsigned long loop_cycles_left;  ///< How many times the loop has still to be passed, this value will be decremented with each loop cycle.
+         file_offset_t 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
-Line 327 
 namespace gig {
+Line 384 
 namespace gig {
      class Sample;
      class Region;
      class Group;
+     class Script;
+     class ScriptGroup;
-     /** @brief Encapsulates articulation information of a dimension region.
+     /** @brief Encapsulates articulation informations of a dimension region.
       *
-      *  Every Gigasampler Instrument has at least one dimension region
+      * This is the most important data object of the Gigasampler / GigaStudio
-      *  (exactly then when it has no dimension defined).
+      * format. A DimensionRegion provides the link to the sample to be played
+      * and all required articulation informations to be interpreted for playing
+      * back the sample and processing it appropriately by the sampler software.
+      * Every Region of a Gigasampler Instrument has at least one dimension
+      * region (exactly then when the Region has no dimension defined). Many
+      * Regions though provide more than one DimensionRegion, which reflect
+      * different playing "cases". For example a different sample might be played
+      * if a certain pedal is pressed down, or if the note was triggered with
+      * different velocity.
       *
-      *  Gigasampler provides three Envelope Generators and Low Frequency
+      * One instance of a DimensionRegion reflects exactly one particular case
-      *  Oscillators:
+      * while playing an instrument (for instance "note between C3 and E3 was
+      * triggered AND note on velocity was between 20 and 42 AND modulation wheel
+      * controller is between 80 and 127). The DimensionRegion defines what to do
+      * under that one particular case, that is which sample to play back and how
+      * to play that sample back exactly and how to process it. So a
+      * DimensionRegion object is always linked to exactly one sample. It may
+      * however also link to no sample at all, for defining a "silence" case
+      * where nothing shall be played (for example when note on velocity was
+      * below 6).
+      *
+      * Note that a DimensionRegion object only defines "what to do", but it does
+      * not define "when to do it". To actually resolve which DimensionRegion to
+      * pick under which situation, you need to refer to the DimensionRegions'
+      * parent Region object. The Region object contains the necessary
+      * "Dimension" definitions, which in turn define which DimensionRegion is
+      * associated with which playing case exactly.
+      *
+      * The Gigasampler/GigaStudio format defines 3 Envelope Generators and 3
+      * Low Frequency Oscillators:
       *
       *  - EG1 and LFO1, both controlling sample amplitude
       *  - EG2 and LFO2, both controlling filter cutoff frequency
       *  - EG3 and LFO3, both controlling sample pitch
+      *
+      * Since the gig format was designed as extension to the DLS file format,
+      * this class is derived from the DLS::Sampler class. So also refer to
+      * DLS::Sampler for additional informations, class attributes and methods.
       */
      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). Only for gig2, otherwise the DimensionUpperLimts are used instead.
+             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, for gig3 and above the DimensionUpperLimits 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 426 
 namespace gig {
+Line 515 
 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
+             uint8_t            DimensionUpperLimits[8];       ///< gig3: defines the upper limit of the dimension values for this dimension region. In case you wondered why this is defined on DimensionRegion level and not on Region level: the zone sizes (upper limits) of the velocity dimension can indeed differ in the individual dimension regions, depending on which zones of the other dimension types are currently selected. So this is exceptional for the velocity dimension only. All other dimension types have the same dimension zone sizes for every single DimensionRegion (of the sample Region).
              // derived attributes from DLS::Sampler
              using DLS::Sampler::UnityNote;
-Line 454 
 namespace gig {
+Line 543 
 namespace gig {
              using DLS::Sampler::DeleteSampleLoop;
              // overridden methods
              virtual void SetGain(int32_t gain);
-             virtual void UpdateChunks();
+             virtual void UpdateChunks(progress_t* pProgress);
+             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(Region* pParent, RIFF::List* _3ewl);
              DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);
             ~DimensionRegion();
+             void CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples);
+             void serialize(Serialization::Archive* archive);
              friend class Region;
+             friend class Serialization::Archive;
          private:
              typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller
+                 // official leverage controllers as they were defined in the original Gigasampler/GigaStudio format:
                  _lev_ctrl_none              = 0x00,
                  _lev_ctrl_modwheel          = 0x03, ///< Modulation Wheel (MIDI Controller 1)
                  _lev_ctrl_breath            = 0x05, ///< Breath Controller (Coarse, MIDI Controller 2)
-Line 488 
 namespace gig {
+Line 582 
 namespace gig {
                  _lev_ctrl_effect4depth      = 0x2b, ///< Effect 4 Depth (MIDI Controller 94)
                  _lev_ctrl_effect5depth      = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)
                  _lev_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure
-                 _lev_ctrl_velocity          = 0xff  ///< Key Velocity
+                 _lev_ctrl_velocity          = 0xff, ///< Key Velocity
+                 // format extension (these controllers are so far only supported by LinuxSampler & gigedit) they will *NOT* work with Gigasampler/GigaStudio !
+                 // (the assigned values here are their official MIDI CC number plus the highest bit set):
+                 _lev_ctrl_CC3_EXT           = 0x83, ///< MIDI Controller 3 [gig format extension]
+                 _lev_ctrl_CC6_EXT           = 0x86, ///< Data Entry MSB (MIDI Controller 6) [gig format extension]
+                 _lev_ctrl_CC7_EXT           = 0x87, ///< Channel Volume (MIDI Controller 7) [gig format extension]
+                 _lev_ctrl_CC8_EXT           = 0x88, ///< Balance (MIDI Controller 8) [gig format extension]
+                 _lev_ctrl_CC9_EXT           = 0x89, ///< MIDI Controller 9 [gig format extension]
+                 _lev_ctrl_CC10_EXT          = 0x8a, ///< Pan (MIDI Controller 10) [gig format extension]
+                 _lev_ctrl_CC11_EXT          = 0x8b, ///< Expression Controller (MIDI Controller 11) [gig format extension]
+                 _lev_ctrl_CC14_EXT          = 0x8e, ///< MIDI Controller 14 [gig format extension]
+                 _lev_ctrl_CC15_EXT          = 0x8f, ///< MIDI Controller 15 [gig format extension]
+                 _lev_ctrl_CC20_EXT          = 0x94, ///< MIDI Controller 20 [gig format extension]
+                 _lev_ctrl_CC21_EXT          = 0x95, ///< MIDI Controller 21 [gig format extension]
+                 _lev_ctrl_CC22_EXT          = 0x96, ///< MIDI Controller 22 [gig format extension]
+                 _lev_ctrl_CC23_EXT          = 0x97, ///< MIDI Controller 23 [gig format extension]
+                 _lev_ctrl_CC24_EXT          = 0x98, ///< MIDI Controller 24 [gig format extension]
+                 _lev_ctrl_CC25_EXT          = 0x99, ///< MIDI Controller 25 [gig format extension]
+                 _lev_ctrl_CC26_EXT          = 0x9a, ///< MIDI Controller 26 [gig format extension]
+                 _lev_ctrl_CC27_EXT          = 0x9b, ///< MIDI Controller 27 [gig format extension]
+                 _lev_ctrl_CC28_EXT          = 0x9c, ///< MIDI Controller 28 [gig format extension]
+                 _lev_ctrl_CC29_EXT          = 0x9d, ///< MIDI Controller 29 [gig format extension]
+                 _lev_ctrl_CC30_EXT          = 0x9e, ///< MIDI Controller 30 [gig format extension]
+                 _lev_ctrl_CC31_EXT          = 0x9f, ///< MIDI Controller 31 [gig format extension]
+                 _lev_ctrl_CC68_EXT          = 0xc4, ///< Legato Footswitch (MIDI Controller 68) [gig format extension]
+                 _lev_ctrl_CC69_EXT          = 0xc5, ///< Hold 2 (MIDI Controller 69) [gig format extension]
+                 _lev_ctrl_CC70_EXT          = 0xc6, ///< Sound Ctrl. 1 - Sound Variation (MIDI Controller 70) [gig format extension]
+                 _lev_ctrl_CC71_EXT          = 0xc7, ///< Sound Ctrl. 2 - Timbre (MIDI Controller 71) [gig format extension]
+                 _lev_ctrl_CC72_EXT          = 0xc8, ///< Sound Ctrl. 3 - Release Time (MIDI Controller 72) [gig format extension]
+                 _lev_ctrl_CC73_EXT          = 0xc9, ///< Sound Ctrl. 4 - Attack Time (MIDI Controller 73) [gig format extension]
+                 _lev_ctrl_CC74_EXT          = 0xca, ///< Sound Ctrl. 5 - Brightness (MIDI Controller 74) [gig format extension]
+                 _lev_ctrl_CC75_EXT          = 0xcb, ///< Sound Ctrl. 6 - Decay Time (MIDI Controller 75) [gig format extension]
+                 _lev_ctrl_CC76_EXT          = 0xcc, ///< Sound Ctrl. 7 - Vibrato Rate (MIDI Controller 76) [gig format extension]
+                 _lev_ctrl_CC77_EXT          = 0xcd, ///< Sound Ctrl. 8 - Vibrato Depth (MIDI Controller 77) [gig format extension]
+                 _lev_ctrl_CC78_EXT          = 0xce, ///< Sound Ctrl. 9 - Vibrato Delay (MIDI Controller 78) [gig format extension]
+                 _lev_ctrl_CC79_EXT          = 0xcf, ///< Sound Ctrl. 10 (MIDI Controller 79) [gig format extension]
+                 _lev_ctrl_CC84_EXT          = 0xd4, ///< Portamento Control (MIDI Controller 84) [gig format extension]
+                 _lev_ctrl_CC85_EXT          = 0xd5, ///< MIDI Controller 85 [gig format extension]
+                 _lev_ctrl_CC86_EXT          = 0xd6, ///< MIDI Controller 86 [gig format extension]
+                 _lev_ctrl_CC87_EXT          = 0xd7, ///< MIDI Controller 87 [gig format extension]
+                 _lev_ctrl_CC89_EXT          = 0xd9, ///< MIDI Controller 89 [gig format extension]
+                 _lev_ctrl_CC90_EXT          = 0xda, ///< MIDI Controller 90 [gig format extension]
+                 _lev_ctrl_CC96_EXT          = 0xe0, ///< Data Increment (MIDI Controller 96) [gig format extension]
+                 _lev_ctrl_CC97_EXT          = 0xe1, ///< Data Decrement (MIDI Controller 97) [gig format extension]
+                 _lev_ctrl_CC102_EXT         = 0xe6, ///< MIDI Controller 102 [gig format extension]
+                 _lev_ctrl_CC103_EXT         = 0xe7, ///< MIDI Controller 103 [gig format extension]
+                 _lev_ctrl_CC104_EXT         = 0xe8, ///< MIDI Controller 104 [gig format extension]
+                 _lev_ctrl_CC105_EXT         = 0xe9, ///< MIDI Controller 105 [gig format extension]
+                 _lev_ctrl_CC106_EXT         = 0xea, ///< MIDI Controller 106 [gig format extension]
+                 _lev_ctrl_CC107_EXT         = 0xeb, ///< MIDI Controller 107 [gig format extension]
+                 _lev_ctrl_CC108_EXT         = 0xec, ///< MIDI Controller 108 [gig format extension]
+                 _lev_ctrl_CC109_EXT         = 0xed, ///< MIDI Controller 109 [gig format extension]
+                 _lev_ctrl_CC110_EXT         = 0xee, ///< MIDI Controller 110 [gig format extension]
+                 _lev_ctrl_CC111_EXT         = 0xef, ///< MIDI Controller 111 [gig format extension]
+                 _lev_ctrl_CC112_EXT         = 0xf0, ///< MIDI Controller 112 [gig format extension]
+                 _lev_ctrl_CC113_EXT         = 0xf1, ///< MIDI Controller 113 [gig format extension]
+                 _lev_ctrl_CC114_EXT         = 0xf2, ///< MIDI Controller 114 [gig format extension]
+                 _lev_ctrl_CC115_EXT         = 0xf3, ///< MIDI Controller 115 [gig format extension]
+                 _lev_ctrl_CC116_EXT         = 0xf4, ///< MIDI Controller 116 [gig format extension]
+                 _lev_ctrl_CC117_EXT         = 0xf5, ///< MIDI Controller 117 [gig format extension]
+                 _lev_ctrl_CC118_EXT         = 0xf6, ///< MIDI Controller 118 [gig format extension]
+                 _lev_ctrl_CC119_EXT         = 0xf7  ///< MIDI Controller 119 [gig format extension]
              } _lev_ctrl_t;
              typedef std::map<uint32_t, double*> VelocityTableMap;
-             static uint              Instances;                  ///< Number of DimensionRegion instances.
+             static size_t            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
-Line 507 
 namespace gig {
+Line 671 
 namespace gig {
              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
      };
-     /** @brief Encapsulates sample waves used for playback.
+     /** @brief Encapsulates sample waves of Gigasampler/GigaStudio files used for playback.
+      *
+      * This class provides access to the actual audio sample data of a
+      * Gigasampler/GigaStudio file. Along to the actual sample data, it also
+      * provides access to the sample's meta informations like bit depth,
+      * sample rate, encoding type, but also loop informations. The latter may be
+      * used by instruments for resembling sounds with arbitary note lengths.
       *
       * In case you created a new sample with File::AddSample(), you should
       * first update all attributes with the desired meta informations
-Line 521 
 namespace gig {
+Line 691 
 namespace gig {
       * 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.
+      *
+      * Since the gig format was designed as extension to the DLS file format,
+      * this class is derived from the DLS::Sample class. So also refer to
+      * DLS::Sample for additional informations, class attributes and methods.
       */
      class Sample : public DLS::Sample {
          public:
-Line 545 
 namespace gig {
+Line 719 
 namespace gig {
              // own methods
              buffer_t      LoadSampleData();
-             buffer_t      LoadSampleData(unsigned long SampleCount);
+             buffer_t      LoadSampleData(file_offset_t SampleCount);
              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
-             buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);
+             buffer_t      LoadSampleDataWithNullSamplesExtension(file_offset_t SampleCount, uint NullSamplesCount);
              buffer_t      GetCache();
              // own static methods
-             static buffer_t CreateDecompressionBuffer(unsigned long MaxReadSize);
+             static buffer_t CreateDecompressionBuffer(file_offset_t MaxReadSize);
              static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
              // overridden methods
              void          ReleaseSampleData();
-             void          Resize(int iNewSize);
+             void          Resize(file_offset_t NewSize);
-             unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
+             file_offset_t SetPos(file_offset_t SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
-             unsigned long GetPos();
+             file_offset_t GetPos() const;
-             unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
+             file_offset_t Read(void* pBuffer, file_offset_t SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
-             unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL);
+             file_offset_t ReadAndLoop(void* pBuffer, file_offset_t SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL);
-             unsigned long Write(void* pBuffer, unsigned long SampleCount);
+             file_offset_t Write(void* pBuffer, file_offset_t SampleCount);
              Group*        GetGroup() const;
-             virtual void  UpdateChunks();
+             virtual void  UpdateChunks(progress_t* pProgress);
+             void CopyAssignMeta(const Sample* orig);
+             void CopyAssignWave(const Sample* orig);
+             uint32_t GetWaveDataCRC32Checksum();
+             bool VerifyWaveData(uint32_t* pActually = NULL);
          protected:
-             static unsigned int  Instances;               ///< Number of instances of class Sample.
+             static size_t        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).
+             file_offset_t        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.
+             file_offset_t*       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).
+             file_offset_t        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.
+             file_offset_t        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.
+             file_offset_t        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.
+             file_offset_t        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)
              RIFF::Chunk*         pCk3gix;
              RIFF::Chunk*         pCkSmpl;
-             uint32_t             crc;                     ///< CRC-32 checksum of the raw sample data
+             uint32_t             crc;                     ///< Reflects CRC-32 checksum of the raw sample data at the last time when the sample's raw wave form data has been modified consciously by the user by calling Write().
-             Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo = 0);
+             Sample(File* pFile, RIFF::List* waveList, file_offset_t WavePoolOffset, unsigned long fileNo = 0, int index = -1);
             ~Sample();
+             uint32_t CalculateWaveDataChecksum();
              // Guess size (in bytes) of a compressed sample
-             inline unsigned long GuessSize(unsigned long samples) {
+             inline file_offset_t GuessSize(file_offset_t 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 =
+                 const file_offset_t size =
                      BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
                                     : samples + (samples >> 10) * 5;
                  // Double for stereo and add one worst case sample
-Line 599 
 namespace gig {
+Line 778 
 namespace gig {
              // Worst case amount of sample points that can be read with the
              // given decompression buffer.
-             inline unsigned long WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
+             inline file_offset_t WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
-                 return (unsigned long) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
+                 return (file_offset_t) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
              }
          private:
              void ScanCompressedSample();
-Line 610 
 namespace gig {
+Line 789 
 namespace gig {
      };
      // TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions)
-     /** Defines <i>Region</i> information of an <i>Instrument</i>. */
+     /** @brief Defines Region information of a Gigasampler/GigaStudio instrument.
+      *
+      * A Region reflects a consecutive area (key range) on the keyboard. The
+      * individual regions in the gig format may not overlap with other regions
+      * (of the same instrument that is). Further, in the gig format a Region is
+      * merely a container for DimensionRegions (a.k.a. "Cases"). The Region
+      * itself does not provide the sample mapping or articulation informations
+      * used, even though the data structures of regions indeed provide such
+      * informations. The latter is however just of historical nature, because
+      * the gig file format was derived from the DLS file format.
+      *
+      * Each Region consists of at least one or more DimensionRegions. The actual
+      * amount of DimensionRegions depends on which kind of "dimensions" are
+      * defined for this region, and on the split / zone amount for each of those
+      * dimensions.
+      *
+      * Since the gig format was designed as extension to the DLS file format,
+      * this class is derived from the DLS::Region class. So also refer to
+      * DLS::Region for additional informations, class attributes and methods.
+      */
      class Region : public DLS::Region {
          public:
              unsigned int            Dimensions;               ///< Number of defined dimensions, do not alter!
-Line 622 
 namespace gig {
+Line 820 
 namespace gig {
              // own methods
              DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
              DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
+             int              GetDimensionRegionIndexByValue(const uint DimValues[8]);
              Sample*          GetSample();
              void             AddDimension(dimension_def_t* pDimDef);
              void             DeleteDimension(dimension_def_t* pDimDef);
+             dimension_def_t* GetDimensionDefinition(dimension_t type);
+             void             DeleteDimensionZone(dimension_t type, int zone);
+             void             SplitDimensionZone(dimension_t type, int zone);
+             void             SetDimensionType(dimension_t oldType, dimension_t newType);
              // overridden methods
              virtual void     SetKeyRange(uint16_t Low, uint16_t High);
-             virtual void     UpdateChunks();
+             virtual void     UpdateChunks(progress_t* pProgress);
+             virtual void     CopyAssign(const Region* orig);
          protected:
              Region(Instrument* pInstrument, RIFF::List* rgnList);
              void LoadDimensionRegions(RIFF::List* rgn);
              void UpdateVelocityTable();
              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
+             void CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples);
+             DimensionRegion* GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase);
             ~Region();
              friend class Instrument;
      };
-     /** Abstract base class for all MIDI rules. */
+     /** @brief Abstract base class for all MIDI rules.
+      *
+      * Note: Instead of using MIDI rules, we recommend you using real-time
+      * instrument scripts instead. Read about the reasons below.
+      *
+      * MIDI Rules (also called "iMIDI rules" or "intelligent MIDI rules") were
+      * introduced with GigaStudio 4 as an attempt to increase the power of
+      * potential user controls over sounds. At that point other samplers already
+      * supported certain powerful user control features, which were not possible
+      * with GigaStudio yet. For example triggering new notes by MIDI CC
+      * controller.
+      *
+      * Such extended features however were usually implemented by other samplers
+      * by requiring the sound designer to write an instrument script which the
+      * designer would then bundle with the respective instrument file. Such
+      * scripts are essentially text files, using a very specific programming
+      * language for the purpose of controlling the sampler in real-time. Since
+      * however musicians are not typically keen to writing such cumbersome
+      * script files, the GigaStudio designers decided to implement such extended
+      * features completely without instrument scripts. Instead they created a
+      * set of rules, which could be defined and altered conveniently by mouse
+      * clicks in GSt's instrument editor application. The downside of this
+      * overall approach however, was that those MIDI rules were very limited in
+      * practice. As sound designer you easily came across the possiblities such
+      * MIDI rules were able to offer.
+      *
+      * Due to such severe use case constraints, support for MIDI rules is quite
+      * limited in libgig. At the moment only the "Control Trigger", "Alternator"
+      * and the "Legato" MIDI rules are supported by libgig. Consequently the
+      * graphical instrument editor application gigedit just supports the
+      * "Control Trigger" and "Legato" MIDI rules, and LinuxSampler even does not
+      * support any MIDI rule type at all and LinuxSampler probably will not
+      * support MIDI rules in future either.
+      *
+      * Instead of using MIDI rules, we introduced real-time instrument scripts
+      * as extension to the original GigaStudio file format. This script based
+      * solution is much more powerful than MIDI rules and is already supported
+      * by libgig, gigedit and LinuxSampler.
+      *
+      * @deprecated Just provided for backward compatiblity, use Script for new
+      *             instruments instead.
+      */
      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. */
+     /** @brief MIDI rule for triggering notes by control change events.
+      *
+      * A "Control Trigger MIDI rule" allows to trigger new notes by sending MIDI
+      * control change events to the sampler.
+      *
+      * Note: "Control Trigger" MIDI rules are only supported by gigedit, but not
+      * by LinuxSampler. We recommend you using real-time instrument scripts
+      * instead. Read more about the details and reasons for this in the
+      * description of the MidiRule base class.
+      *
+      * @deprecated Just provided for backward compatiblity, use Script for new
+      *             instruments instead. See description of MidiRule for details.
+      */
      class MidiRuleCtrlTrigger : public MidiRule {
          public:
              uint8_t ControllerNumber;   ///< MIDI controller number.
-Line 660 
 namespace gig {
+Line 922 
 namespace gig {
          protected:
              MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg);
+             MidiRuleCtrlTrigger();
+             void UpdateChunks(uint8_t* pData) const;
+             friend class Instrument;
+     };
+     /** @brief MIDI rule for instruments with legato samples.
+      *
+      * A "Legato MIDI rule" allows playing instruments resembling the legato
+      * playing technique. In the past such legato articulations were tried to be
+      * simulated by pitching the samples of the instrument. However since
+      * usually a high amount of pitch is needed for legatos, this always sounded
+      * very artificial and unrealistic. The "Legato MIDI rule" thus uses another
+      * approach. Instead of pitching the samples, it allows the sound designer
+      * to bundle separate, additional samples for the individual legato
+      * situations and the legato rules defined which samples to be played in
+      * which situation.
+      *
+      * Note: "Legato MIDI rules" are only supported by gigedit, but not
+      * by LinuxSampler. We recommend you using real-time instrument scripts
+      * instead. Read more about the details and reasons for this in the
+      * description of the MidiRule base class.
+      *
+      * @deprecated Just provided for backward compatiblity, use Script for new
+      *             instruments instead. See description of MidiRule for details.
+      */
+     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;
+     };
+     /** @brief MIDI rule to automatically cycle through specified sequences of different articulations.
+      *
+      * The instrument must be using the smartmidi dimension.
+      *
+      * Note: "Alternator" MIDI rules are neither supported by gigedit nor by
+      * LinuxSampler. We recommend you using real-time instrument scripts
+      * instead. Read more about the details and reasons for this in the
+      * description of the MidiRule base class.
+      *
+      * @deprecated Just provided for backward compatiblity, use Script for new
+      *             instruments instead. See description of MidiRule for details.
+      */
+     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;
      };
-     /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */
+     /** @brief A MIDI rule not yet implemented by libgig.
+      *
+      * This class is currently used as a place holder by libgig for MIDI rule
+      * types which are not supported by libgig yet.
+      *
+      * Note: Support for missing MIDI rule types are probably never added to
+      * libgig. We recommend you using real-time instrument scripts instead.
+      * Read more about the details and reasons for this in the description of
+      * the MidiRule base class.
+      *
+      * @deprecated Just provided for backward compatiblity, use Script for new
+      *             instruments instead. See description of MidiRule for details.
+      */
+     class MidiRuleUnknown : public MidiRule {
+         protected:
+             MidiRuleUnknown() { }
+             void UpdateChunks(uint8_t* pData) const { }
+             friend class Instrument;
+     };
+     /** @brief Real-time instrument script (gig format extension).
+      *
+      * Real-time instrument scripts are user supplied small programs which can
+      * be used by instrument designers to create custom behaviors and features
+      * not available in the stock sampler engine. Features which might be very
+      * exotic or specific for the respective instrument.
+      *
+      * This is an extension of the GigaStudio format, thus a feature which was
+      * not available in the GigaStudio 4 software. It is currently only
+      * supported by LinuxSampler and gigedit. Scripts will not load with the
+      * original GigaStudio software.
+      *
+      * You find more informations about Instrument Scripts on the LinuxSampler
+      * documentation site:
+      *
+      * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/">About Instrument Scripts in General</a>
+      * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language">Introduction to the NKSP Script Language</a>
+      * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language/Reference/">NKSP Reference Manual</a>
+      * - <a href="http://doc.linuxsampler.org/Gigedit/Managing_Scripts">Using Instrument Scripts with Gigedit</a>
+      */
+     class Script {
+         public:
+             enum Encoding_t {
+                 ENCODING_ASCII = 0 ///< Standard 8 bit US ASCII character encoding (default).
+             };
+             enum Compression_t {
+                 COMPRESSION_NONE = 0 ///< Is not compressed at all (default).
+             };
+             enum Language_t {
+                 LANGUAGE_NKSP = 0 ///< NKSP stands for "Is Not KSP" (default). Refer to the <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language/Reference/">NKSP Reference Manual</a> for details about this script language.
+             };
+             String         Name;        ///< Arbitrary name of the script, which may be displayed i.e. in an instrument editor.
+             Compression_t  Compression; ///< Whether the script was/should be compressed, and if so, which compression algorithm shall be used.
+             Encoding_t     Encoding;    ///< Format the script's source code text is encoded with.
+             Language_t     Language;    ///< Programming language and dialect the script is written in.
+             bool           Bypass;      ///< Global bypass: if enabled, this script shall not be executed by the sampler for any instrument.
+             String GetScriptAsText();
+             void   SetScriptAsText(const String& text);
+             void   SetGroup(ScriptGroup* pGroup);
+             ScriptGroup* GetGroup() const;
+             void   CopyAssign(const Script* orig);
+         protected:
+             Script(ScriptGroup* group, RIFF::Chunk* ckScri);
+             virtual ~Script();
+             void UpdateChunks(progress_t* pProgress);
+             void RemoveAllScriptReferences();
+             friend class ScriptGroup;
+             friend class Instrument;
+         private:
+             ScriptGroup*          pGroup;
+             RIFF::Chunk*          pChunk; ///< 'Scri' chunk
+             std::vector<uint8_t>  data;
+             uint32_t              crc; ///< CRC-32 checksum of the raw script data
+     };
+     /** @brief Group of instrument scripts (gig format extension).
+      *
+      * This class is simply used to sort a bunch of real-time instrument scripts
+      * into individual groups. This allows instrument designers and script
+      * developers to keep scripts in a certain order while working with a larger
+      * amount of scripts in an instrument editor.
+      *
+      * This is an extension of the GigaStudio format, thus a feature which was
+      * not available in the GigaStudio 4 software. It is currently only
+      * supported by LinuxSampler and gigedit.
+      */
+     class ScriptGroup {
+         public:
+             String   Name; ///< Name of this script group. For example to be displayed in an instrument editor.
+             Script*  GetScript(uint index);
+             Script*  AddScript();
+             void     DeleteScript(Script* pScript);
+         protected:
+             ScriptGroup(File* file, RIFF::List* lstRTIS);
+             virtual ~ScriptGroup();
+             void LoadScripts();
+             void UpdateChunks(progress_t* pProgress);
+             friend class Script;
+             friend class File;
+         private:
+             File*                pFile;
+             RIFF::List*          pList; ///< 'RTIS' list chunk
+             std::list<Script*>*  pScripts;
+     };
+     /** @brief Provides access to a Gigasampler/GigaStudio instrument.
+      *
+      * This class provides access to Gigasampler/GigaStudio instruments
+      * contained in .gig files. A gig instrument is merely a set of keyboard
+      * ranges (called Region), plus some additional global informations about
+      * the instrument. The major part of the actual instrument definition used
+      * for the synthesis of the instrument is contained in the respective Region
+      * object (or actually in the respective DimensionRegion object being, see
+      * description of Region for details).
+      *
+      * Since the gig format was designed as extension to the DLS file format,
+      * this class is derived from the DLS::Instrument class. So also refer to
+      * DLS::Instrument for additional informations, class attributes and
+      * methods.
+      */
      class Instrument : protected DLS::Instrument {
          public:
              // derived attributes from DLS::Resource
-Line 692 
 namespace gig {
+Line 1170 
 namespace gig {
              Region*   GetNextRegion();
              Region*   AddRegion();
              void      DeleteRegion(Region* pRegion);
-             virtual void UpdateChunks();
+             void      MoveTo(Instrument* dst);
+             virtual void UpdateChunks(progress_t* pProgress);
+             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);
+             // real-time instrument script methods
+             Script*   GetScriptOfSlot(uint index);
+             void      AddScriptSlot(Script* pScript, bool bypass = false);
+             void      SwapScriptSlots(uint index1, uint index2);
+             void      RemoveScriptSlot(uint index);
+             void      RemoveScript(Script* pScript);
+             uint      ScriptSlotCount() const;
+             bool      IsScriptSlotBypassed(uint index);
+             void      SetScriptSlotBypassed(uint index, bool bBypass);
          protected:
              Region*   RegionKeyTable[128]; ///< fast lookup for the corresponding Region of a MIDI key
              Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
             ~Instrument();
+             void CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples);
              void UpdateRegionKeyTable();
+             void LoadScripts();
+             void UpdateScriptFileOffsets();
              friend class File;
              friend class Region; // so Region can call UpdateRegionKeyTable()
          private:
+             struct _ScriptPooolEntry {
+                 uint32_t fileOffset;
+                 bool     bypass;
+             };
+             struct _ScriptPooolRef {
+                 Script*  script;
+                 bool     bypass;
+             };
              MidiRule** pMidiRules;
+             std::vector<_ScriptPooolEntry> scriptPoolFileOffsets;
+             std::vector<_ScriptPooolRef>* pScriptRefs;
      };
-     /** @brief Group of Gigasampler objects
+     /** @brief Group of Gigasampler samples
       *
-      * Groups help to organize a huge collection of Gigasampler objects.
+      * Groups help to organize a huge collection of Gigasampler samples.
       * 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.
-Line 733 
 namespace gig {
+Line 1235 
 namespace gig {
          protected:
              Group(File* file, RIFF::Chunk* ck3gnm);
              virtual ~Group();
-             virtual void UpdateChunks();
+             virtual void UpdateChunks(progress_t* pProgress);
              void MoveAll();
              friend class File;
          private:
              File*        pFile;
-             RIFF::Chunk* pNameChunk;
+             RIFF::Chunk* pNameChunk; ///< '3gnm' chunk
      };
-     /** Parses Gigasampler files and provides abstract access to the data. */
+     /** @brief Provides convenient access to Gigasampler/GigaStudio .gig files.
+      *
+      * This is the entry class for accesing a Gigasampler/GigaStudio (.gig) file
+      * with libgig. It allows you to open existing .gig files, modifying them
+      * and saving them persistently either under the same file name or under a
+      * different location.
+      *
+      * A .gig file is merely a monolithic file. That means samples and the
+      * defintion of the virtual instruments are contained in the same file. A
+      * .gig file contains an arbitrary amount of samples, and an arbitrary
+      * amount of instruments which are referencing those samples. It is also
+      * possible to store samples in .gig files not being referenced by any
+      * instrument. This is not an error from the file format's point of view and
+      * it is actually often used in practice during the design phase of new gig
+      * instruments.
+      *
+      * So on toplevel of the gig file format you have:
+      *
+      * - A set of samples (see Sample).
+      * - A set of virtual instruments (see Instrument).
+      *
+      * And as extension to the original GigaStudio format, we added:
+      *
+      * - Real-time instrument scripts (see Script).
+      *
+      * Note that the latter however is only supported by libgig, gigedit and
+      * LinuxSampler. Scripts are not supported by the original GigaStudio
+      * software.
+      *
+      * All released Gigasampler/GigaStudio file format versions are supported
+      * (so from first Gigasampler version up to including GigaStudio 4).
+      *
+      * Since the gig format was designed as extension to the DLS file format,
+      * this class is derived from the DLS::File class. So also refer to
+      * DLS::File for additional informations, class attributes and methods.
+      */
      class File : protected DLS::File {
          public:
              static const DLS::version_t VERSION_2;
-Line 759 
 namespace gig {
+Line 1296 
 namespace gig {
              // derived methods from DLS::File
              using DLS::File::Save;
              using DLS::File::GetFileName;
+             using DLS::File::SetFileName;
              // 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.
+             Sample*     GetSample(uint index);
              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*      GetGroup(String name);
              Group*      AddGroup();
              void        DeleteGroup(Group* pGroup);
              void        DeleteGroupOnly(Group* pGroup);
              void        SetAutoLoad(bool b);
              bool        GetAutoLoad();
+             void        AddContentOf(File* pFile);
+             ScriptGroup* GetScriptGroup(uint index);
+             ScriptGroup* GetScriptGroup(const String& name);
+             ScriptGroup* AddScriptGroup();
+             void        DeleteScriptGroup(ScriptGroup* pGroup);
              virtual    ~File();
-             virtual void UpdateChunks();
+             virtual void UpdateChunks(progress_t* pProgress);
          protected:
              // overridden protected methods from DLS::File
              virtual void LoadSamples();
              virtual void LoadInstruments();
              virtual void LoadGroups();
+             virtual void UpdateFileOffsets();
              // own protected methods
              virtual void LoadSamples(progress_t* pProgress);
              virtual void LoadInstruments(progress_t* pProgress);
+             virtual void LoadScriptGroups();
              void SetSampleChecksum(Sample* pSample, uint32_t crc);
+             uint32_t GetSampleChecksum(Sample* pSample);
+             uint32_t GetSampleChecksumByIndex(int index);
+             bool VerifySampleChecksumTable();
+             bool RebuildSampleChecksumTable();
+             int  GetWaveTableIndexOf(gig::Sample* pSample);
              friend class Region;
              friend class Sample;
+             friend class Instrument;
              friend class Group; // so Group can access protected member pRIFF
+             friend class ScriptGroup; // so ScriptGroup can access protected member pRIFF
          private:
              std::list<Group*>*          pGroups;
              std::list<Group*>::iterator GroupsIterator;
              bool                        bAutoLoad;
+             std::list<ScriptGroup*>*    pScriptGroups;
      };
      /**
-Line 813 
 namespace gig {
+Line 1369 
 namespace gig {
              void PrintMessage();
      };
+ #if HAVE_RTTI
+     size_t countEnum(const std::type_info& type);
+     const char* enumKey(const std::type_info& type, size_t value);
+     bool        enumKey(const std::type_info& type, String key);
+     const char** enumKeys(const std::type_info& type);
+ #endif // HAVE_RTTI
+     size_t countEnum(String typeName);
+     const char* enumKey(String typeName, size_t value);
+     bool        enumKey(String typeName, String key);
+     const char** enumKeys(String typeName);
+     size_t enumValue(String key);
      String libraryName();
      String libraryVersion();

 Legend:



Removed from v.2334
 


changed lines


 
Added in v.3173
 Legend:



Removed from v.2334
 


changed lines


 
Added in v.3173
-Removed from v.2334
+Added in v.3173

	ViewVC Help
Powered by ViewVC