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

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

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

revision 16 by schoenebeck, Sat Nov 29 14:56:16 2003 UTC revision 2682 by schoenebeck, Mon Dec 29 16:25:51 2014 UTC
# Line 1  Line 1 
1  /***************************************************************************  /***************************************************************************
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file loader library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003 by Christian Schoenebeck                           *   *   Copyright (C) 2003-2014 by Christian Schoenebeck                      *
6   *                         <cuse@users.sourceforge.net>                    *   *                              <cuse@users.sourceforge.net>               *
7   *                                                                         *   *                                                                         *
8   *   This library is free software; you can redistribute it and/or modify  *   *   This library is free software; you can redistribute it and/or modify  *
9   *   it under the terms of the GNU General Public License as published by  *   *   it under the terms of the GNU General Public License as published by  *
# Line 25  Line 25 
25  #define __GIG_H__  #define __GIG_H__
26    
27  #include "DLS.h"  #include "DLS.h"
28    #include <vector>
 #include <math.h>  
 #include <string.h>  
   
 /// Initial size of the sample buffer which is used for decompression of  
 /// compressed sample wave streams - this value should always be bigger than  
 /// the biggest sample piece expected to be read by the sampler engine,  
 /// otherwise the buffer size will be raised at runtime and thus the buffer  
 /// reallocated which is time consuming and unefficient.  
 #define INITIAL_SAMPLE_BUFFER_SIZE              512000 // 512 kB  
29    
30  #if WORDS_BIGENDIAN  #if WORDS_BIGENDIAN
31  # define LIST_TYPE_3PRG 0x33707267  # define LIST_TYPE_3PRG 0x33707267
32  # define LIST_TYPE_3EWL 0x3365776C  # define LIST_TYPE_3EWL 0x3365776C
33  # define CHUNK_ID_SMPL  0x736D706C  # define LIST_TYPE_3GRI 0x33677269
34    # define LIST_TYPE_3GNL 0x33676E6C
35    # define LIST_TYPE_3LS  0x334c5320 // own gig format extension
36    # define LIST_TYPE_RTIS 0x52544953 // own gig format extension
37  # define CHUNK_ID_3GIX  0x33676978  # define CHUNK_ID_3GIX  0x33676978
38  # define CHUNK_ID_3EWA  0x33657761  # define CHUNK_ID_3EWA  0x33657761
39  # define CHUNK_ID_3LNK  0x336C6E6B  # define CHUNK_ID_3LNK  0x336C6E6B
40  # define CHUNK_ID_3EWG  0x33657767  # define CHUNK_ID_3EWG  0x33657767
41  # define CHUNK_ID_EWAV  0x65776176  # define CHUNK_ID_EWAV  0x65776176
42    # define CHUNK_ID_3GNM  0x33676E6D
43    # define CHUNK_ID_EINF  0x65696E66
44    # define CHUNK_ID_3CRC  0x33637263
45    # define CHUNK_ID_SCRI  0x53637269 // own gig format extension
46    # define CHUNK_ID_LSNM  0x4c534e4d // own gig format extension
47    # define CHUNK_ID_SCSL  0x5343534c // own gig format extension
48  #else  // little endian  #else  // little endian
49  # define LIST_TYPE_3PRG 0x67727033  # define LIST_TYPE_3PRG 0x67727033
50  # define LIST_TYPE_3EWL 0x6C776533  # define LIST_TYPE_3EWL 0x6C776533
51  # define CHUNK_ID_SMPL  0x6C706D73  # define LIST_TYPE_3GRI 0x69726733
52    # define LIST_TYPE_3GNL 0x6C6E6733
53    # define LIST_TYPE_3LS  0x20534c33 // own gig format extension
54    # define LIST_TYPE_RTIS 0x53495452 // own gig format extension
55  # define CHUNK_ID_3GIX  0x78696733  # define CHUNK_ID_3GIX  0x78696733
56  # define CHUNK_ID_3EWA  0x61776533  # define CHUNK_ID_3EWA  0x61776533
57  # define CHUNK_ID_3LNK  0x6B6E6C33  # define CHUNK_ID_3LNK  0x6B6E6C33
58  # define CHUNK_ID_3EWG  0x67776533  # define CHUNK_ID_3EWG  0x67776533
59  # define CHUNK_ID_EWAV  0x76617765  # define CHUNK_ID_EWAV  0x76617765
60    # define CHUNK_ID_3GNM  0x6D6E6733
61    # define CHUNK_ID_EINF  0x666E6965
62    # define CHUNK_ID_3CRC  0x63726333
63    # define CHUNK_ID_SCRI  0x69726353 // own gig format extension
64    # define CHUNK_ID_LSNM  0x4d4e534c // own gig format extension
65    # define CHUNK_ID_SCSL  0x4c534353 // own gig format extension
66  #endif // WORDS_BIGENDIAN  #endif // WORDS_BIGENDIAN
67    
 /** (so far) every exponential paramater in the gig format has a basis of 1.000000008813822 */  
 #define GIG_EXP_DECODE(x)                                       (pow(1.000000008813822, x))  
 #define GIG_PITCH_TRACK_EXTRACT(x)                              (!(x & 0x01))  
 #define GIG_VCF_RESONANCE_CTRL_EXTRACT(x)                       ((x >> 4) & 0x03)  
 #define GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(x)                  ((x >> 1) & 0x03)  
 #define GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(x)                   ((x >> 3) & 0x03)  
 #define GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(x)                 ((x >> 5) & 0x03)  
 //TODO: the transformation functions are not very accurate compared to the original ones  
 #define GIG_VELOCITY_TRANSFORM_NONLINEAR(x,dynamic,scale)       ((1.0-1.0/pow(x,1.0/(129.0-x))) * (1.0+scale/20.0) + (5.0-dynamic)*pow(x/300.0* (1.0+2.0*scale/128.0),2))  
 #define GIG_VELOCITY_TRANSFORM_LINEAR(x,dynamic,scale)          ((1.0+scale*3.0/128.0)/110.0*x+(5.0-dynamic)/5.0+(5.0-dynamic)*scale)  
 #define GIG_VELOCITY_TRANSFORM_SPECIAL(x,dynamic,scale)         ((1.0+9.0*scale/129.0)*(1.0-1.0/pow(x,1.0/(129.0-x))+pow(3.0*x/pow(129,2),2)+pow((5.0-dynamic)*x/500.0,2)))  
   
68  /** Gigasampler specific classes and definitions */  /** Gigasampler specific classes and definitions */
69  namespace gig {  namespace gig {
70    
71      typedef std::string String;      typedef std::string String;
72        typedef RIFF::progress_t progress_t;
73    
74      /** Lower and upper limit of a range. */      /** Lower and upper limit of a range. */
75      struct range_t {      struct range_t {
# Line 84  namespace gig { Line 82  namespace gig {
82          void*         pStart;            ///< Points to the beginning of the buffer.          void*         pStart;            ///< Points to the beginning of the buffer.
83          unsigned long Size;              ///< Size of the actual data in the buffer in bytes.          unsigned long Size;              ///< Size of the actual data in the buffer in bytes.
84          unsigned long NullExtensionSize; ///< The buffer might be bigger than the actual data, if that's the case that unused space at the end of the buffer is filled with NULLs and NullExtensionSize reflects that unused buffer space in bytes. Those NULL extensions are mandatory for differential algorithms that have to take the following data words into account, thus have to access past the buffer's boundary. If you don't know what I'm talking about, just forget this variable. :)          unsigned long NullExtensionSize; ///< The buffer might be bigger than the actual data, if that's the case that unused space at the end of the buffer is filled with NULLs and NullExtensionSize reflects that unused buffer space in bytes. Those NULL extensions are mandatory for differential algorithms that have to take the following data words into account, thus have to access past the buffer's boundary. If you don't know what I'm talking about, just forget this variable. :)
85            buffer_t() {
86                pStart            = NULL;
87                Size              = 0;
88                NullExtensionSize = 0;
89            }
90      };      };
91    
92      /** Standard types of sample loops. */      /** Standard types of sample loops. */
# Line 147  namespace gig { Line 150  namespace gig {
150      /** Defines how the filter cutoff frequency is controlled by. */      /** Defines how the filter cutoff frequency is controlled by. */
151      typedef enum {      typedef enum {
152          vcf_cutoff_ctrl_none         = 0x00,          vcf_cutoff_ctrl_none         = 0x00,
153            vcf_cutoff_ctrl_none2        = 0x01,  ///< The difference between none and none2 is unknown
154          vcf_cutoff_ctrl_modwheel     = 0x81,  ///< Modulation Wheel (MIDI Controller 1)          vcf_cutoff_ctrl_modwheel     = 0x81,  ///< Modulation Wheel (MIDI Controller 1)
155          vcf_cutoff_ctrl_effect1      = 0x8c,  ///< Effect Controller 1 (Coarse, MIDI Controller 12)          vcf_cutoff_ctrl_effect1      = 0x8c,  ///< Effect Controller 1 (Coarse, MIDI Controller 12)
156          vcf_cutoff_ctrl_effect2      = 0x8d,  ///< Effect Controller 2 (Coarse, MIDI Controller 13)          vcf_cutoff_ctrl_effect2      = 0x8d,  ///< Effect Controller 2 (Coarse, MIDI Controller 13)
# Line 168  namespace gig { Line 172  namespace gig {
172          vcf_res_ctrl_genpurpose6 = 3            ///< General Purpose Controller 6 (Button, MIDI Controller 81)          vcf_res_ctrl_genpurpose6 = 3            ///< General Purpose Controller 6 (Button, MIDI Controller 81)
173      } vcf_res_ctrl_t;      } vcf_res_ctrl_t;
174    
175      /** Defines how attenuation (=gain / VCA) is controlled by. */      /**
176      typedef enum {       * Defines a controller that has a certain contrained influence on a
177          attenuation_ctrl_none              = 0x00,       * particular synthesis parameter (used to define attenuation controller,
178          attenuation_ctrl_modwheel          = 0x03, ///< Modulation Wheel (MIDI Controller 1)       * EG1 controller and EG2 controller).
179          attenuation_ctrl_breath            = 0x05, ///< Breath Controller (Coarse, MIDI Controller 2)       *
180          attenuation_ctrl_foot              = 0x07, ///< Foot Pedal (Coarse, MIDI Controller 4)       * You should use the respective <i>typedef</i> (means either
181          attenuation_ctrl_effect1           = 0x0d, ///< Effect Controller 1 (Coarse, MIDI Controller 12)       * attenuation_ctrl_t, eg1_ctrl_t or eg2_ctrl_t) in your code!
182          attenuation_ctrl_effect2           = 0x0f, ///< Effect Controller 2 (Coarse, MIDI Controller 13)       */
183          attenuation_ctrl_genpurpose1       = 0x11, ///< General Purpose Controller 1 (Slider, MIDI Controller 16)      struct leverage_ctrl_t {
184          attenuation_ctrl_genpurpose2       = 0x13, ///< General Purpose Controller 2 (Slider, MIDI Controller 17)          typedef enum {
185          attenuation_ctrl_genpurpose3       = 0x15, ///< General Purpose Controller 3 (Slider, MIDI Controller 18)              type_none              = 0x00, ///< No controller defined
186          attenuation_ctrl_genpurpose4       = 0x17, ///< General Purpose Controller 4 (Slider, MIDI Controller 19)              type_channelaftertouch = 0x2f, ///< Channel Key Pressure
187          attenuation_ctrl_portamentotime    = 0x0b, ///< Portamento Time (Coarse, MIDI Controller 5)              type_velocity          = 0xff, ///< Key Velocity
188          attenuation_ctrl_sustainpedal      = 0x01, ///< Sustain Pedal (MIDI Controller 64)              type_controlchange     = 0xfe  ///< Ordinary MIDI control change controller, see field 'controller_number'
189          attenuation_ctrl_portamento        = 0x19, ///< Portamento (MIDI Controller 65)          } type_t;
190          attenuation_ctrl_sostenutopedal    = 0x1b, ///< Sostenuto Pedal (MIDI Controller 66)  
191          attenuation_ctrl_softpedal         = 0x09, ///< Soft Pedal (MIDI Controller 67)          type_t type;              ///< Controller type
192          attenuation_ctrl_genpurpose5       = 0x1d, ///< General Purpose Controller 5 (Button, MIDI Controller 80)          uint   controller_number; ///< MIDI controller number if this controller is a control change controller, 0 otherwise
193          attenuation_ctrl_genpurpose6       = 0x1f, ///< General Purpose Controller 6 (Button, MIDI Controller 81)      };
194          attenuation_ctrl_genpurpose7       = 0x21, ///< General Purpose Controller 7 (Button, MIDI Controller 82)  
195          attenuation_ctrl_genpurpose8       = 0x23, ///< General Purpose Controller 8 (Button, MIDI Controller 83)      /**
196          attenuation_ctrl_effect1depth      = 0x25, ///< Effect 1 Depth (MIDI Controller 91)       * Defines controller influencing attenuation.
197          attenuation_ctrl_effect2depth      = 0x27, ///< Effect 2 Depth (MIDI Controller 92)       *
198          attenuation_ctrl_effect3depth      = 0x29, ///< Effect 3 Depth (MIDI Controller 93)       * @see leverage_ctrl_t
199          attenuation_ctrl_effect4depth      = 0x2b, ///< Effect 4 Depth (MIDI Controller 94)       */
200          attenuation_ctrl_effect5depth      = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)      typedef leverage_ctrl_t attenuation_ctrl_t;
201          attenuation_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure  
202          attenuation_ctrl_velocity          = 0xff  ///< Key Velocity      /**
203      } attenuation_ctrl_t, eg1_ctrl_t, eg2_ctrl_t;       * Defines controller influencing envelope generator 1.
204         *
205         * @see leverage_ctrl_t
206         */
207        typedef leverage_ctrl_t eg1_ctrl_t;
208    
209        /**
210         * Defines controller influencing envelope generator 2.
211         *
212         * @see leverage_ctrl_t
213         */
214        typedef leverage_ctrl_t eg2_ctrl_t;
215    
216      /**      /**
217       * Defines the type of dimension, that is how the dimension zones (and       * Defines the type of dimension, that is how the dimension zones (and
# Line 209  namespace gig { Line 224  namespace gig {
224          dimension_none              = 0x00, ///< Dimension not in use.          dimension_none              = 0x00, ///< Dimension not in use.
225          dimension_samplechannel     = 0x80, ///< If used sample has more than one channel (thus is not mono).          dimension_samplechannel     = 0x80, ///< If used sample has more than one channel (thus is not mono).
226          dimension_layer             = 0x81, ///< For layering of up to 8 instruments (and eventually crossfading of 2 or 4 layers).          dimension_layer             = 0x81, ///< For layering of up to 8 instruments (and eventually crossfading of 2 or 4 layers).
227          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).
228          dimension_channelaftertouch = 0x83, ///< Channel Key Pressure          dimension_channelaftertouch = 0x83, ///< Channel Key Pressure
229          dimension_releasetrigger    = 0x84, ///< Special dimension for triggering samples on releasing a key.          dimension_releasetrigger    = 0x84, ///< Special dimension for triggering samples on releasing a key.
230          dimension_keyboard          = 0x85, ///< Key Position          dimension_keyboard          = 0x85, ///< Dimension for keyswitching
231            dimension_roundrobin        = 0x86, ///< Different samples triggered each time a note is played, dimension regions selected in sequence
232            dimension_random            = 0x87, ///< Different samples triggered each time a note is played, random order
233            dimension_smartmidi         = 0x88, ///< For MIDI tools like legato and repetition mode
234            dimension_roundrobinkeyboard = 0x89, ///< Different samples triggered each time a note is played, any key advances the counter
235          dimension_modwheel          = 0x01, ///< Modulation Wheel (MIDI Controller 1)          dimension_modwheel          = 0x01, ///< Modulation Wheel (MIDI Controller 1)
236          dimension_breath            = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)          dimension_breath            = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)
237          dimension_foot              = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)          dimension_foot              = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)
# Line 243  namespace gig { Line 262  namespace gig {
262       * into the corresponding dimension bit number.       * into the corresponding dimension bit number.
263       */       */
264      typedef enum {      typedef enum {
265          split_type_normal,         ///< dimension value between 0-127, no custom range of zones          split_type_normal,         ///< dimension value between 0-127
         split_type_customvelocity, ///< a velocity dimension split with custom range definition for each zone (if a velocity dimension split has no custom defined zone ranges then it's also just of type split_type_normal)  
266          split_type_bit             ///< dimension values are already the sought bit number          split_type_bit             ///< dimension values are already the sought bit number
267      } split_type_t;      } split_type_t;
268    
# Line 254  namespace gig { Line 272  namespace gig {
272          uint8_t      bits;       ///< Number of "bits" (1 bit = 2 splits/zones, 2 bit = 4 splits/zones, 3 bit = 8 splits/zones,...).          uint8_t      bits;       ///< Number of "bits" (1 bit = 2 splits/zones, 2 bit = 4 splits/zones, 3 bit = 8 splits/zones,...).
273          uint8_t      zones;      ///< Number of zones the dimension has.          uint8_t      zones;      ///< Number of zones the dimension has.
274          split_type_t split_type; ///< Intended for internal usage: will be used to convert a dimension value into the corresponding dimension bit number.          split_type_t split_type; ///< Intended for internal usage: will be used to convert a dimension value into the corresponding dimension bit number.
275          range_t*     ranges;     ///< Intended for internal usage: Points to the beginning of a range_t array which reflects the value ranges of each dimension zone (only if custom defined ranges are defined, is NULL otherwise).          float        zone_size;  ///< Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only, 0 otherwise.
         unsigned int zone_size;  ///< Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only, 0 otherwise.  
276      };      };
277    
278      /** Defines which frequencies are filtered by the VCF. */      /** Defines which frequencies are filtered by the VCF. */
# Line 267  namespace gig { Line 284  namespace gig {
284          vcf_type_bandreject   = 0x03          vcf_type_bandreject   = 0x03
285      } vcf_type_t;      } vcf_type_t;
286    
287      /** Defines the envelope of a crossfade. */      /**
288         * Defines the envelope of a crossfade.
289         *
290         * Note: The default value for crossfade points is 0,0,0,0. Layers with
291         * such a default value should be treated as if they would not have a
292         * crossfade.
293         */
294      struct crossfade_t {      struct crossfade_t {
295          #if WORDS_BIGENDIAN          #if WORDS_BIGENDIAN
         uint8_t in_start;   ///< Start position of fade in.  
         uint8_t in_end;     ///< End position of fade in.  
         uint8_t out_start;  ///< Start position of fade out.  
         uint8_t out_end;    ///< End postition of fade out.  
         #else // little endian  
296          uint8_t out_end;    ///< End postition of fade out.          uint8_t out_end;    ///< End postition of fade out.
297          uint8_t out_start;  ///< Start position of fade out.          uint8_t out_start;  ///< Start position of fade out.
298          uint8_t in_end;     ///< End position of fade in.          uint8_t in_end;     ///< End position of fade in.
299          uint8_t in_start;   ///< Start position of fade in.          uint8_t in_start;   ///< Start position of fade in.
300            #else // little endian
301            uint8_t in_start;   ///< Start position of fade in.
302            uint8_t in_end;     ///< End position of fade in.
303            uint8_t out_start;  ///< Start position of fade out.
304            uint8_t out_end;    ///< End postition of fade out.
305          #endif // WORDS_BIGENDIAN          #endif // WORDS_BIGENDIAN
306      };      };
307    
308        /** Reflects the current playback state for a sample. */
309        struct playback_state_t {
310            unsigned long position;          ///< Current position within the sample.
311            bool          reverse;           ///< If playback direction is currently backwards (in case there is a pingpong or reverse loop defined).
312            unsigned long loop_cycles_left;  ///< How many times the loop has still to be passed, this value will be decremented with each loop cycle.
313        };
314    
315      // just symbol prototyping      // just symbol prototyping
316      class File;      class File;
317      class Instrument;      class Instrument;
318      class Sample;      class Sample;
319        class Region;
320        class Group;
321        class Script;
322        class ScriptGroup;
323    
324      /** Encapsulates articulation information of a dimension region.      /** @brief Encapsulates articulation information of a dimension region.
325       *       *
326       *  Every Gigasampler Instrument has at least one dimension region       *  Every Gigasampler Instrument has at least one dimension region
327       *  (exactly then when it has no dimension defined).       *  (exactly then when it has no dimension defined).
# Line 301  namespace gig { Line 335  namespace gig {
335       */       */
336      class DimensionRegion : protected DLS::Sampler {      class DimensionRegion : protected DLS::Sampler {
337          public:          public:
338              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, for gig3 and above the DimensionUpperLimits are used instead.
339              Sample*            pSample;                       ///< Points to the Sample which is assigned to the dimension region.              Sample*            pSample;                       ///< Points to the Sample which is assigned to the dimension region.
340              // Sample Amplitude EG/LFO              // Sample Amplitude EG/LFO
341              uint16_t           EG1PreAttack;                  ///< Preattack value of the sample amplitude EG (0 - 1000 permille).              uint16_t           EG1PreAttack;                  ///< Preattack value of the sample amplitude EG (0 - 1000 permille).
# Line 314  namespace gig { Line 348  namespace gig {
348              bool               EG1Hold;                       ///< If <i>true</i>, Decay1 stage should be postponed until the sample reached the sample loop start.              bool               EG1Hold;                       ///< If <i>true</i>, Decay1 stage should be postponed until the sample reached the sample loop start.
349              eg1_ctrl_t         EG1Controller;                 ///< MIDI Controller which has influence on sample amplitude EG parameters (attack, decay, release).              eg1_ctrl_t         EG1Controller;                 ///< MIDI Controller which has influence on sample amplitude EG parameters (attack, decay, release).
350              bool               EG1ControllerInvert;           ///< Invert values coming from defined EG1 controller.              bool               EG1ControllerInvert;           ///< Invert values coming from defined EG1 controller.
351              uint8_t            EG1ControllerAttackInfluence;  ///< Amount EG1 Controller has influence on the EG1 Attack time.              uint8_t            EG1ControllerAttackInfluence;  ///< Amount EG1 Controller has influence on the EG1 Attack time (0 - 3, where 0 means off).
352              uint8_t            EG1ControllerDecayInfluence;   ///< Amount EG1 Controller has influence on the EG1 Decay time.              uint8_t            EG1ControllerDecayInfluence;   ///< Amount EG1 Controller has influence on the EG1 Decay time (0 - 3, where 0 means off).
353              uint8_t            EG1ControllerReleaseInfluence; ///< Amount EG1 Controller has influence on the EG1 Release time.              uint8_t            EG1ControllerReleaseInfluence; ///< Amount EG1 Controller has influence on the EG1 Release time (0 - 3, where 0 means off).
354              double             LFO1Frequency;                 ///< Frequency of the sample amplitude LFO (0.10 - 10.00 Hz).              double             LFO1Frequency;                 ///< Frequency of the sample amplitude LFO (0.10 - 10.00 Hz).
355              uint16_t           LFO1InternalDepth;             ///< Firm pitch of the sample amplitude LFO (0 - 1200 cents).              uint16_t           LFO1InternalDepth;             ///< Firm pitch of the sample amplitude LFO (0 - 1200 cents).
356              uint16_t           LFO1ControlDepth;              ///< Controller depth influencing sample amplitude LFO pitch (0 - 1200 cents).              uint16_t           LFO1ControlDepth;              ///< Controller depth influencing sample amplitude LFO pitch (0 - 1200 cents).
# Line 333  namespace gig { Line 367  namespace gig {
367              double             EG2Release;                    ///< Release time of the filter cutoff EG (0.000 - 60.000s).              double             EG2Release;                    ///< Release time of the filter cutoff EG (0.000 - 60.000s).
368              eg2_ctrl_t         EG2Controller;                 ///< MIDI Controller which has influence on filter cutoff EG parameters (attack, decay, release).              eg2_ctrl_t         EG2Controller;                 ///< MIDI Controller which has influence on filter cutoff EG parameters (attack, decay, release).
369              bool               EG2ControllerInvert;           ///< Invert values coming from defined EG2 controller.              bool               EG2ControllerInvert;           ///< Invert values coming from defined EG2 controller.
370              uint8_t            EG2ControllerAttackInfluence;  ///< Amount EG2 Controller has influence on the EG2 Attack time.              uint8_t            EG2ControllerAttackInfluence;  ///< Amount EG2 Controller has influence on the EG2 Attack time (0 - 3, where 0 means off).
371              uint8_t            EG2ControllerDecayInfluence;   ///< Amount EG2 Controller has influence on the EG2 Decay time.              uint8_t            EG2ControllerDecayInfluence;   ///< Amount EG2 Controller has influence on the EG2 Decay time (0 - 3, where 0 means off).
372              uint8_t            EG2ControllerReleaseInfluence; ///< Amount EG2 Controller has influence on the EG2 Release time.              uint8_t            EG2ControllerReleaseInfluence; ///< Amount EG2 Controller has influence on the EG2 Release time (0 - 3, where 0 means off).
373              double             LFO2Frequency;                 ///< Frequency of the filter cutoff LFO (0.10 - 10.00 Hz).              double             LFO2Frequency;                 ///< Frequency of the filter cutoff LFO (0.10 - 10.00 Hz).
374              uint16_t           LFO2InternalDepth;             ///< Firm pitch of the filter cutoff LFO (0 - 1200 cents).              uint16_t           LFO2InternalDepth;             ///< Firm pitch of the filter cutoff LFO (0 - 1200 cents).
375              uint16_t           LFO2ControlDepth;              ///< Controller depth influencing filter cutoff LFO pitch (0 - 1200).              uint16_t           LFO2ControlDepth;              ///< Controller depth influencing filter cutoff LFO pitch (0 - 1200).
# Line 353  namespace gig { Line 387  namespace gig {
387              // Filter              // Filter
388              bool               VCFEnabled;                    ///< If filter should be used.              bool               VCFEnabled;                    ///< If filter should be used.
389              vcf_type_t         VCFType;                       ///< Defines the general filter characteristic (lowpass, highpass, bandpass, etc.).              vcf_type_t         VCFType;                       ///< Defines the general filter characteristic (lowpass, highpass, bandpass, etc.).
390              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!
391                bool               VCFCutoffControllerInvert;     ///< Inverts values coming from the defined cutoff controller
392              uint8_t            VCFCutoff;                     ///< Max. cutoff frequency.              uint8_t            VCFCutoff;                     ///< Max. cutoff frequency.
393              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!
394              uint8_t            VCFVelocityScale;              ///< (0-127) Amount velocity controls VCF cutoff frequency (only if no other VCF cutoff controller is defined).              uint8_t            VCFVelocityScale;              ///< (0-127) Amount velocity controls VCF cutoff frequency (only if no other VCF cutoff controller is defined, otherwise this is the minimum cutoff). @deprecated Don't alter directly, use SetVCFVelocityScale() instead!
395              uint8_t            VCFVelocityDynamicRange;       ///< 0x04 = lowest, 0x00 = highest              uint8_t            VCFVelocityDynamicRange;       ///< 0x04 = lowest, 0x00 = highest . @deprecated Don't alter directly, use SetVCFVelocityDynamicRange() instead!
396              uint8_t            VCFResonance;                  ///< Firm internal filter resonance weight.              uint8_t            VCFResonance;                  ///< Firm internal filter resonance weight.
397              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).              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).
398              vcf_res_ctrl_t     VCFResonanceController;        ///< Specifies which external controller has influence on the filter resonance Q.              vcf_res_ctrl_t     VCFResonanceController;        ///< Specifies which external controller has influence on the filter resonance Q.
399              bool               VCFKeyboardTracking;           ///< If <i>true</i>: VCF cutoff frequence will be dependend to the note key position relative to the defined breakpoint value.              bool               VCFKeyboardTracking;           ///< If <i>true</i>: VCF cutoff frequence will be dependend to the note key position relative to the defined breakpoint value.
400              uint8_t            VCFKeyboardTrackingBreakpoint; ///< See VCFKeyboardTracking (0 - 127).              uint8_t            VCFKeyboardTrackingBreakpoint; ///< See VCFKeyboardTracking (0 - 127).
401              // Key Velocity Transformations              // Key Velocity Transformations
402              curve_type_t       VelocityResponseCurve;         ///< Defines a transformation curve to the incoming velocity values affecting amplitude.              curve_type_t       VelocityResponseCurve;         ///< Defines a transformation curve to the incoming velocity values affecting amplitude (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead). @deprecated Don't alter directly, use SetVelocityResponseCurve() instead!
403              uint8_t            VelocityResponseDepth;         ///< Dynamic range of velocity affecting amplitude (0 - 4).              uint8_t            VelocityResponseDepth;         ///< Dynamic range of velocity affecting amplitude (0 - 4) (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead). @deprecated Don't alter directly, use SetVelocityResponseDepth() instead!
404              uint8_t            VelocityResponseCurveScaling;  ///< 0 - 127              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!
405              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!
406              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!
407              uint8_t            ReleaseTriggerDecay;           ///< 0 - 8              uint8_t            ReleaseTriggerDecay;           ///< 0 - 8
408              // Mix / Layer              // Mix / Layer
409              crossfade_t        Crossfade;              crossfade_t        Crossfade;
# Line 376  namespace gig { Line 411  namespace gig {
411              dim_bypass_ctrl_t  DimensionBypass;               ///< If defined, the MIDI controller can switch on/off the dimension in realtime.              dim_bypass_ctrl_t  DimensionBypass;               ///< If defined, the MIDI controller can switch on/off the dimension in realtime.
412              int8_t             Pan;                           ///< Panorama / Balance (-64..0..63 <-> left..middle..right)              int8_t             Pan;                           ///< Panorama / Balance (-64..0..63 <-> left..middle..right)
413              bool               SelfMask;                      ///< If <i>true</i>: high velocity notes will stop low velocity notes at the same note, with that you can save voices that wouldn't be audible anyway.              bool               SelfMask;                      ///< If <i>true</i>: high velocity notes will stop low velocity notes at the same note, with that you can save voices that wouldn't be audible anyway.
414              attenuation_ctrl_t AttenuationControl;            ///< MIDI Controller which has influence on the volume level of the sample (or entire sample group).              attenuation_ctrl_t AttenuationController;         ///< MIDI Controller which has influence on the volume level of the sample (or entire sample group).
415              bool               InvertAttenuationControl;      ///< Inverts the values coming from the defined Attenuation Controller.              bool               InvertAttenuationController;   ///< Inverts the values coming from the defined Attenuation Controller.
416              uint8_t            AttenuationControlTreshold;    ///< 0-127              uint8_t            AttenuationControllerThreshold;///< 0-127
417              uint8_t            ChannelOffset;                 ///< Audio output where the audio signal of the dimension region should be routed to (0 - 9).              uint8_t            ChannelOffset;                 ///< Audio output where the audio signal of the dimension region should be routed to (0 - 9).
418              bool               SustainDefeat;                 ///< If <i>true</i>: Sustain pedal will not hold a note.              bool               SustainDefeat;                 ///< If <i>true</i>: Sustain pedal will not hold a note.
419              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.              bool               MSDecode;                      ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.
420              uint16_t           SampleStartOffset;             ///< Number of samples the sample start should be moved (0 - 2000).              uint16_t           SampleStartOffset;             ///< Number of samples the sample start should be moved (0 - 2000).
421                double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)
422                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).
423    
424              // derived attributes from DLS::Sampler              // derived attributes from DLS::Sampler
425              DLS::Sampler::UnityNote;              using DLS::Sampler::UnityNote;
426              DLS::Sampler::FineTune;              using DLS::Sampler::FineTune;
427              DLS::Sampler::Gain;              using DLS::Sampler::Gain;
428              DLS::Sampler::SampleLoops;              using DLS::Sampler::SampleLoops;
429              DLS::Sampler::pSampleLoops;              using DLS::Sampler::pSampleLoops;
430    
431              // Methods              // own methods
432              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);              double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
433                double GetVelocityRelease(uint8_t MIDIKeyVelocity);
434                double GetVelocityCutoff(uint8_t MIDIKeyVelocity);
435                void SetVelocityResponseCurve(curve_type_t curve);
436                void SetVelocityResponseDepth(uint8_t depth);
437                void SetVelocityResponseCurveScaling(uint8_t scaling);
438                void SetReleaseVelocityResponseCurve(curve_type_t curve);
439                void SetReleaseVelocityResponseDepth(uint8_t depth);
440                void SetVCFCutoffController(vcf_cutoff_ctrl_t controller);
441                void SetVCFVelocityCurve(curve_type_t curve);
442                void SetVCFVelocityDynamicRange(uint8_t range);
443                void SetVCFVelocityScale(uint8_t scaling);
444                Region* GetParent() const;
445                // derived methods
446                using DLS::Sampler::AddSampleLoop;
447                using DLS::Sampler::DeleteSampleLoop;
448                // overridden methods
449                virtual void SetGain(int32_t gain);
450                virtual void UpdateChunks(progress_t* pProgress);
451                virtual void CopyAssign(const DimensionRegion* orig);
452          protected:          protected:
453              DimensionRegion(RIFF::List* _3ewl);              uint8_t* VelocityTable; ///< For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number.
454                DimensionRegion(Region* pParent, RIFF::List* _3ewl);
455                DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);
456             ~DimensionRegion();             ~DimensionRegion();
457                void CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples);
458              friend class Region;              friend class Region;
459          private:          private:
460                typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller
461                    // official leverage controllers as they were defined in the original Gigasampler/GigaStudio format:
462                    _lev_ctrl_none              = 0x00,
463                    _lev_ctrl_modwheel          = 0x03, ///< Modulation Wheel (MIDI Controller 1)
464                    _lev_ctrl_breath            = 0x05, ///< Breath Controller (Coarse, MIDI Controller 2)
465                    _lev_ctrl_foot              = 0x07, ///< Foot Pedal (Coarse, MIDI Controller 4)
466                    _lev_ctrl_effect1           = 0x0d, ///< Effect Controller 1 (Coarse, MIDI Controller 12)
467                    _lev_ctrl_effect2           = 0x0f, ///< Effect Controller 2 (Coarse, MIDI Controller 13)
468                    _lev_ctrl_genpurpose1       = 0x11, ///< General Purpose Controller 1 (Slider, MIDI Controller 16)
469                    _lev_ctrl_genpurpose2       = 0x13, ///< General Purpose Controller 2 (Slider, MIDI Controller 17)
470                    _lev_ctrl_genpurpose3       = 0x15, ///< General Purpose Controller 3 (Slider, MIDI Controller 18)
471                    _lev_ctrl_genpurpose4       = 0x17, ///< General Purpose Controller 4 (Slider, MIDI Controller 19)
472                    _lev_ctrl_portamentotime    = 0x0b, ///< Portamento Time (Coarse, MIDI Controller 5)
473                    _lev_ctrl_sustainpedal      = 0x01, ///< Sustain Pedal (MIDI Controller 64)
474                    _lev_ctrl_portamento        = 0x19, ///< Portamento (MIDI Controller 65)
475                    _lev_ctrl_sostenutopedal    = 0x1b, ///< Sostenuto Pedal (MIDI Controller 66)
476                    _lev_ctrl_softpedal         = 0x09, ///< Soft Pedal (MIDI Controller 67)
477                    _lev_ctrl_genpurpose5       = 0x1d, ///< General Purpose Controller 5 (Button, MIDI Controller 80)
478                    _lev_ctrl_genpurpose6       = 0x1f, ///< General Purpose Controller 6 (Button, MIDI Controller 81)
479                    _lev_ctrl_genpurpose7       = 0x21, ///< General Purpose Controller 7 (Button, MIDI Controller 82)
480                    _lev_ctrl_genpurpose8       = 0x23, ///< General Purpose Controller 8 (Button, MIDI Controller 83)
481                    _lev_ctrl_effect1depth      = 0x25, ///< Effect 1 Depth (MIDI Controller 91)
482                    _lev_ctrl_effect2depth      = 0x27, ///< Effect 2 Depth (MIDI Controller 92)
483                    _lev_ctrl_effect3depth      = 0x29, ///< Effect 3 Depth (MIDI Controller 93)
484                    _lev_ctrl_effect4depth      = 0x2b, ///< Effect 4 Depth (MIDI Controller 94)
485                    _lev_ctrl_effect5depth      = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)
486                    _lev_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure
487                    _lev_ctrl_velocity          = 0xff, ///< Key Velocity
488    
489                    // format extension (these controllers are so far only supported by LinuxSampler & gigedit) they will *NOT* work with Gigasampler/GigaStudio !
490                    // (the assigned values here are their official MIDI CC number plus the highest bit set):
491                    _lev_ctrl_CC3_EXT           = 0x83, ///< MIDI Controller 3 [gig format extension]
492    
493                    _lev_ctrl_CC6_EXT           = 0x86, ///< Data Entry MSB (MIDI Controller 6) [gig format extension]
494                    _lev_ctrl_CC7_EXT           = 0x87, ///< Channel Volume (MIDI Controller 7) [gig format extension]
495                    _lev_ctrl_CC8_EXT           = 0x88, ///< Balance (MIDI Controller 8) [gig format extension]
496                    _lev_ctrl_CC9_EXT           = 0x89, ///< MIDI Controller 9 [gig format extension]
497                    _lev_ctrl_CC10_EXT          = 0x8a, ///< Pan (MIDI Controller 10) [gig format extension]
498                    _lev_ctrl_CC11_EXT          = 0x8b, ///< Expression Controller (MIDI Controller 11) [gig format extension]
499    
500                    _lev_ctrl_CC14_EXT          = 0x8e, ///< MIDI Controller 14 [gig format extension]
501                    _lev_ctrl_CC15_EXT          = 0x8f, ///< MIDI Controller 15 [gig format extension]
502    
503                    _lev_ctrl_CC20_EXT          = 0x94, ///< MIDI Controller 20 [gig format extension]
504                    _lev_ctrl_CC21_EXT          = 0x95, ///< MIDI Controller 21 [gig format extension]
505                    _lev_ctrl_CC22_EXT          = 0x96, ///< MIDI Controller 22 [gig format extension]
506                    _lev_ctrl_CC23_EXT          = 0x97, ///< MIDI Controller 23 [gig format extension]
507                    _lev_ctrl_CC24_EXT          = 0x98, ///< MIDI Controller 24 [gig format extension]
508                    _lev_ctrl_CC25_EXT          = 0x99, ///< MIDI Controller 25 [gig format extension]
509                    _lev_ctrl_CC26_EXT          = 0x9a, ///< MIDI Controller 26 [gig format extension]
510                    _lev_ctrl_CC27_EXT          = 0x9b, ///< MIDI Controller 27 [gig format extension]
511                    _lev_ctrl_CC28_EXT          = 0x9c, ///< MIDI Controller 28 [gig format extension]
512                    _lev_ctrl_CC29_EXT          = 0x9d, ///< MIDI Controller 29 [gig format extension]
513                    _lev_ctrl_CC30_EXT          = 0x9e, ///< MIDI Controller 30 [gig format extension]
514                    _lev_ctrl_CC31_EXT          = 0x9f, ///< MIDI Controller 31 [gig format extension]
515    
516                    _lev_ctrl_CC68_EXT          = 0xc4, ///< Legato Footswitch (MIDI Controller 68) [gig format extension]
517                    _lev_ctrl_CC69_EXT          = 0xc5, ///< Hold 2 (MIDI Controller 69) [gig format extension]
518                    _lev_ctrl_CC70_EXT          = 0xc6, ///< Sound Ctrl. 1 - Sound Variation (MIDI Controller 70) [gig format extension]
519                    _lev_ctrl_CC71_EXT          = 0xc7, ///< Sound Ctrl. 2 - Timbre (MIDI Controller 71) [gig format extension]
520                    _lev_ctrl_CC72_EXT          = 0xc8, ///< Sound Ctrl. 3 - Release Time (MIDI Controller 72) [gig format extension]
521                    _lev_ctrl_CC73_EXT          = 0xc9, ///< Sound Ctrl. 4 - Attack Time (MIDI Controller 73) [gig format extension]
522                    _lev_ctrl_CC74_EXT          = 0xca, ///< Sound Ctrl. 5 - Brightness (MIDI Controller 74) [gig format extension]
523                    _lev_ctrl_CC75_EXT          = 0xcb, ///< Sound Ctrl. 6 - Decay Time (MIDI Controller 75) [gig format extension]
524                    _lev_ctrl_CC76_EXT          = 0xcc, ///< Sound Ctrl. 7 - Vibrato Rate (MIDI Controller 76) [gig format extension]
525                    _lev_ctrl_CC77_EXT          = 0xcd, ///< Sound Ctrl. 8 - Vibrato Depth (MIDI Controller 77) [gig format extension]
526                    _lev_ctrl_CC78_EXT          = 0xce, ///< Sound Ctrl. 9 - Vibrato Delay (MIDI Controller 78) [gig format extension]
527                    _lev_ctrl_CC79_EXT          = 0xcf, ///< Sound Ctrl. 10 (MIDI Controller 79) [gig format extension]
528    
529                    _lev_ctrl_CC84_EXT          = 0xd4, ///< Portamento Control (MIDI Controller 84) [gig format extension]
530                    _lev_ctrl_CC85_EXT          = 0xd5, ///< MIDI Controller 85 [gig format extension]
531                    _lev_ctrl_CC86_EXT          = 0xd6, ///< MIDI Controller 86 [gig format extension]
532                    _lev_ctrl_CC87_EXT          = 0xd7, ///< MIDI Controller 87 [gig format extension]
533    
534                    _lev_ctrl_CC89_EXT          = 0xd9, ///< MIDI Controller 89 [gig format extension]
535                    _lev_ctrl_CC90_EXT          = 0xda, ///< MIDI Controller 90 [gig format extension]
536    
537                    _lev_ctrl_CC96_EXT          = 0xe0, ///< Data Increment (MIDI Controller 96) [gig format extension]
538                    _lev_ctrl_CC97_EXT          = 0xe1, ///< Data Decrement (MIDI Controller 97) [gig format extension]
539    
540                    _lev_ctrl_CC102_EXT         = 0xe6, ///< MIDI Controller 102 [gig format extension]
541                    _lev_ctrl_CC103_EXT         = 0xe7, ///< MIDI Controller 103 [gig format extension]
542                    _lev_ctrl_CC104_EXT         = 0xe8, ///< MIDI Controller 104 [gig format extension]
543                    _lev_ctrl_CC105_EXT         = 0xe9, ///< MIDI Controller 105 [gig format extension]
544                    _lev_ctrl_CC106_EXT         = 0xea, ///< MIDI Controller 106 [gig format extension]
545                    _lev_ctrl_CC107_EXT         = 0xeb, ///< MIDI Controller 107 [gig format extension]
546                    _lev_ctrl_CC108_EXT         = 0xec, ///< MIDI Controller 108 [gig format extension]
547                    _lev_ctrl_CC109_EXT         = 0xed, ///< MIDI Controller 109 [gig format extension]
548                    _lev_ctrl_CC110_EXT         = 0xee, ///< MIDI Controller 110 [gig format extension]
549                    _lev_ctrl_CC111_EXT         = 0xef, ///< MIDI Controller 111 [gig format extension]
550                    _lev_ctrl_CC112_EXT         = 0xf0, ///< MIDI Controller 112 [gig format extension]
551                    _lev_ctrl_CC113_EXT         = 0xf1, ///< MIDI Controller 113 [gig format extension]
552                    _lev_ctrl_CC114_EXT         = 0xf2, ///< MIDI Controller 114 [gig format extension]
553                    _lev_ctrl_CC115_EXT         = 0xf3, ///< MIDI Controller 115 [gig format extension]
554                    _lev_ctrl_CC116_EXT         = 0xf4, ///< MIDI Controller 116 [gig format extension]
555                    _lev_ctrl_CC117_EXT         = 0xf5, ///< MIDI Controller 117 [gig format extension]
556                    _lev_ctrl_CC118_EXT         = 0xf6, ///< MIDI Controller 118 [gig format extension]
557                    _lev_ctrl_CC119_EXT         = 0xf7  ///< MIDI Controller 119 [gig format extension]
558                } _lev_ctrl_t;
559              typedef std::map<uint32_t, double*> VelocityTableMap;              typedef std::map<uint32_t, double*> VelocityTableMap;
560    
561              static uint              Instances;                  ///< Number of DimensionRegion instances.              static uint              Instances;                  ///< Number of DimensionRegion instances.
562              static VelocityTableMap* pVelocityTables;            ///< Contains the tables corresponding to the various velocity parameters (VelocityResponseCurve and VelocityResponseDepth).              static VelocityTableMap* pVelocityTables;            ///< Contains the tables corresponding to the various velocity parameters (VelocityResponseCurve and VelocityResponseDepth).
563              double*                  pVelocityAttenuationTable;  ///< Points to the velocity table corresponding to the velocity parameters of this DimensionRegion.              double*                  pVelocityAttenuationTable;  ///< Points to the velocity table corresponding to the velocity parameters of this DimensionRegion.
564                double*                  pVelocityReleaseTable;      ///< Points to the velocity table corresponding to the release velocity parameters of this DimensionRegion
565                double*                  pVelocityCutoffTable;       ///< Points to the velocity table corresponding to the filter velocity parameters of this DimensionRegion
566                Region*                  pRegion;
567    
568                leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
569                _lev_ctrl_t     EncodeLeverageController(leverage_ctrl_t DecodedController);
570                double* GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth);
571                double* GetCutoffVelocityTable(curve_type_t vcfVelocityCurve, uint8_t vcfVelocityDynamicRange, uint8_t vcfVelocityScale, vcf_cutoff_ctrl_t vcfCutoffController);
572                double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
573                double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
574      };      };
575    
576      /** Encapsulates sample waves used for playback. */      /** @brief Encapsulates sample waves used for playback.
577         *
578         * In case you created a new sample with File::AddSample(), you should
579         * first update all attributes with the desired meta informations
580         * (amount of channels, bit depth, sample rate, etc.), then call
581         * Resize() with the desired sample size, followed by File::Save(), this
582         * will create the mandatory RIFF chunk which will hold the sample wave
583         * data and / or resize the file so you will be able to Write() the
584         * sample data directly to disk.
585         *
586         * @e Caution: for gig synthesis, most looping relevant information are
587         * retrieved from the respective DimensionRegon instead from the Sample
588         * itself. This was made for allowing different loop definitions for the
589         * same sample under different conditions.
590         */
591      class Sample : public DLS::Sample {      class Sample : public DLS::Sample {
592          public:          public:
             uint16_t       SampleGroup;  
593              uint32_t       Manufacturer;      ///< Specifies the MIDI Manufacturer's Association (MMA) Manufacturer code for the sampler intended to receive this file's waveform. If no particular manufacturer is to be specified, a value of 0 should be used.              uint32_t       Manufacturer;      ///< Specifies the MIDI Manufacturer's Association (MMA) Manufacturer code for the sampler intended to receive this file's waveform. If no particular manufacturer is to be specified, a value of 0 should be used.
594              uint32_t       Product;           ///< Specifies the MIDI model ID defined by the manufacturer corresponding to the Manufacturer field. If no particular manufacturer's product is to be specified, a value of 0 should be used.              uint32_t       Product;           ///< Specifies the MIDI model ID defined by the manufacturer corresponding to the Manufacturer field. If no particular manufacturer's product is to be specified, a value of 0 should be used.
595              uint32_t       SamplePeriod;      ///< Specifies the duration of time that passes during the playback of one sample in nanoseconds (normally equal to 1 / Samplers Per Second, where Samples Per Second is the value found in the format chunk).              uint32_t       SamplePeriod;      ///< Specifies the duration of time that passes during the playback of one sample in nanoseconds (normally equal to 1 / Samples Per Second, where Samples Per Second is the value found in the format chunk), don't bother to update this attribute, it won't be saved.
596              uint32_t       MIDIUnityNote;     ///< Specifies the musical note at which the sample will be played at it's original sample rate.              uint32_t       MIDIUnityNote;     ///< Specifies the musical note at which the sample will be played at it's original sample rate.
597              uint32_t       MIDIPitchFraction; ///< Specifies the fraction of a semitone up from the specified MIDI unity note field. A value of 0x80000000 means 1/2 semitone (50 cents) and a value of 0x00000000 means no fine tuning between semitones.              uint32_t       FineTune;          ///< Specifies the fraction of a semitone up from the specified MIDI unity note field. A value of 0x80000000 means 1/2 semitone (50 cents) and a value of 0x00000000 means no fine tuning between semitones.
598              smpte_format_t SMPTEFormat;       ///< Specifies the Society of Motion Pictures and Television E time format used in the following <i>SMPTEOffset</i> field. If a value of 0 is set, <i>SMPTEOffset</i> should also be set to 0.              smpte_format_t SMPTEFormat;       ///< Specifies the Society of Motion Pictures and Television E time format used in the following <i>SMPTEOffset</i> field. If a value of 0 is set, <i>SMPTEOffset</i> should also be set to 0.
599              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       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).
600              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!)
601              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).              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.
602              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.)
603              uint32_t       LoopStart;         ///< The start value specifies the byte offset into 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].)
604              uint32_t       LoopEnd;           ///< The end value specifies the byte offset into the waveform data of the last sample to be played in 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].)
605              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       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.)
606              uint32_t       LoopPlayCount;     ///< Number of times the loop should be played (only if Loops > 0, a value of 0 = infinite).              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.
607                uint32_t       LoopPlayCount;     ///< Number of times the loop should be played (a value of 0 = infinite).
608              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).              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).
609                uint32_t       TruncatedBits;     ///< For 24-bit compressed samples only: number of bits truncated during compression (0, 4 or 6)
610                bool           Dithered;          ///< For 24-bit compressed samples only: if dithering was used during compression with bit reduction
611    
612              // own methods              // own methods
613              buffer_t      LoadSampleData();              buffer_t      LoadSampleData();
# Line 430  namespace gig { Line 615  namespace gig {
615              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
616              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);
617              buffer_t      GetCache();              buffer_t      GetCache();
618                // own static methods
619                static buffer_t CreateDecompressionBuffer(unsigned long MaxReadSize);
620                static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
621              // overridden methods              // overridden methods
622              void          ReleaseSampleData();              void          ReleaseSampleData();
623                void          Resize(int iNewSize);
624              unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);              unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
625              unsigned long GetPos();              unsigned long GetPos() const;
626              unsigned long Read(void* pBuffer, unsigned long SampleCount);              unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
627                unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL);
628                unsigned long Write(void* pBuffer, unsigned long SampleCount);
629                Group*        GetGroup() const;
630                virtual void  UpdateChunks(progress_t* pProgress);
631                void CopyAssignMeta(const Sample* orig);
632                void CopyAssignWave(const Sample* orig);
633          protected:          protected:
634              static unsigned int  Instances;               ///< Number of instances of class Sample.              static unsigned int  Instances;               ///< Number of instances of class Sample.
635              static unsigned long DecompressionBufferSize; ///< Current size of the decompression buffer.              static buffer_t      InternalDecompressionBuffer; ///< Buffer used for decompression as well as for truncation of 24 Bit -> 16 Bit samples.
636              static void*         pDecompressionBuffer;    ///< Small buffer used for decompression only.              Group*               pGroup;                  ///< pointer to the Group this sample belongs to (always not-NULL)
637              unsigned long        FrameOffset;             ///< Current offset (sample points) in current sample frame (for decompression only).              unsigned long        FrameOffset;             ///< Current offset (sample points) in current sample frame (for decompression only).
638              unsigned long*       FrameTable;              ///< For positioning within compressed samples only: stores the offset values for each frame.              unsigned long*       FrameTable;              ///< For positioning within compressed samples only: stores the offset values for each frame.
639              unsigned long        SamplePos;               ///< For compressed samples only: stores the current position (in sample points).              unsigned long        SamplePos;               ///< For compressed samples only: stores the current position (in sample points).
640                unsigned long        SamplesInLastFrame;      ///< For compressed samples only: length of the last sample frame.
641                unsigned long        WorstCaseFrameSize;      ///< For compressed samples only: size (in bytes) of the largest possible sample frame.
642                unsigned long        SamplesPerFrame;         ///< For compressed samples only: number of samples in a full sample frame.
643              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.
644                unsigned long        FileNo;                  ///< File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)
645                RIFF::Chunk*         pCk3gix;
646                RIFF::Chunk*         pCkSmpl;
647                uint32_t             crc;                     ///< CRC-32 checksum of the raw sample data
648    
649              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo = 0);
650             ~Sample();             ~Sample();
651    
652                // Guess size (in bytes) of a compressed sample
653                inline unsigned long GuessSize(unsigned long samples) {
654                    // 16 bit: assume all frames are compressed - 1 byte
655                    // per sample and 5 bytes header per 2048 samples
656    
657                    // 24 bit: assume next best compression rate - 1.5
658                    // bytes per sample and 13 bytes header per 256
659                    // samples
660                    const unsigned long size =
661                        BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
662                                       : samples + (samples >> 10) * 5;
663                    // Double for stereo and add one worst case sample
664                    // frame
665                    return (Channels == 2 ? size << 1 : size) + WorstCaseFrameSize;
666                }
667    
668                // Worst case amount of sample points that can be read with the
669                // given decompression buffer.
670                inline unsigned long WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
671                    return (unsigned long) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
672                }
673          private:          private:
674              void ScanCompressedSample();              void ScanCompressedSample();
675              friend class File;              friend class File;
676              friend class Region;              friend class Region;
677                friend class Group; // allow to modify protected member pGroup
678      };      };
679    
680      // TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions)      // TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions)
681      /** Defines <i>Region</i> information of an <i>Instrument</i>. */      /** @brief Defines Region information of an Instrument.
682         *
683         * A Region reflects a consecutive area on the keyboard. The individual
684         * regions in the gig format may not overlap with other regions (of the same
685         * instrument). Further, in the gig format a Region is merely a container
686         * for DimensionRegions (a.k.a. "Cases"). The Region itself does not provide
687         * the sample mapping or articulation informations used, even though the
688         * data structures indeed provide such informations. The latter is however
689         * just of historical nature, because the gig format was derived from the
690         * DLS format.
691         *
692         * Each Region consists of at least one or more DimensionRegions. The actual
693         * amount of DimensionRegions depends on which kind of "dimensions" are
694         * defined for this region, and on the split / zone amount for each of those
695         * dimensions.
696         */
697      class Region : public DLS::Region {      class Region : public DLS::Region {
698          public:          public:
699              unsigned int            Dimensions;               ///< Number of defined dimensions.              unsigned int            Dimensions;               ///< Number of defined dimensions, do not alter!
700              dimension_def_t         pDimensionDefinitions[5]; ///< Defines the five possible dimensions (the dimension's controller and number of bits/splits).              dimension_def_t         pDimensionDefinitions[8]; ///< Defines the five (gig2) or eight (gig3) possible dimensions (the dimension's controller and number of bits/splits). Use AddDimension() and DeleteDimension() to create a new dimension or delete an existing one.
701              uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains.              uint32_t                DimensionRegions;         ///< Total number of DimensionRegions this Region contains, do not alter!
702              DimensionRegion*        pDimensionRegions[32];    ///< Pointer array to the 32 possible dimension regions (reflects NULL for dimension regions not in use). Avoid to access the array directly and better use GetDimensionRegionByValue() instead, but of course in some cases it makes sense to use the array (e.g. iterating through all DimensionRegions).              DimensionRegion*        pDimensionRegions[256];   ///< Pointer array to the 32 (gig2) or 256 (gig3) possible dimension regions (reflects NULL for dimension regions not in use). Avoid to access the array directly and better use GetDimensionRegionByValue() instead, but of course in some cases it makes sense to use the array (e.g. iterating through all DimensionRegions). 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).
703                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!
704    
705              DimensionRegion* GetDimensionRegionByValue(uint Dim4Val, uint Dim3Val, uint Dim2Val, uint Dim1Val, uint Dim0Val);              // own methods
706              DimensionRegion* GetDimensionRegionByBit(uint8_t Dim4Bit, uint8_t Dim3Bit, uint8_t Dim2Bit, uint8_t Dim1Bit, uint8_t Dim0Bit);              DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
707                DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
708                int              GetDimensionRegionIndexByValue(const uint DimValues[8]);
709              Sample*          GetSample();              Sample*          GetSample();
710                void             AddDimension(dimension_def_t* pDimDef);
711                void             DeleteDimension(dimension_def_t* pDimDef);
712                dimension_def_t* GetDimensionDefinition(dimension_t type);
713                void             DeleteDimensionZone(dimension_t type, int zone);
714                void             SplitDimensionZone(dimension_t type, int zone);
715                void             SetDimensionType(dimension_t oldType, dimension_t newType);
716                // overridden methods
717                virtual void     SetKeyRange(uint16_t Low, uint16_t High);
718                virtual void     UpdateChunks(progress_t* pProgress);
719                virtual void     CopyAssign(const Region* orig);
720          protected:          protected:
             uint8_t VelocityTable[128]; ///< For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number.  
   
721              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
722              void LoadDimensionRegions(RIFF::List* rgn);              void LoadDimensionRegions(RIFF::List* rgn);
723              Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex);              void UpdateVelocityTable();
724                Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
725                void CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples);
726                DimensionRegion* GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase);
727             ~Region();             ~Region();
728              friend class Instrument;              friend class Instrument;
729      };      };
730    
731        /** Abstract base class for all MIDI rules. */
732        class MidiRule {
733            public:
734                virtual ~MidiRule() { }
735            protected:
736                virtual void UpdateChunks(uint8_t* pData) const = 0;
737                friend class Instrument;
738        };
739    
740        /** MIDI rule for triggering notes by control change events. */
741        class MidiRuleCtrlTrigger : public MidiRule {
742            public:
743                uint8_t ControllerNumber;   ///< MIDI controller number.
744                uint8_t Triggers;           ///< Number of triggers.
745                struct trigger_t {
746                    uint8_t TriggerPoint;   ///< The CC value to pass for the note to be triggered.
747                    bool    Descending;     ///< If the change in CC value should be downwards.
748                    uint8_t VelSensitivity; ///< How sensitive the velocity should be to the speed of the controller change.
749                    uint8_t Key;            ///< Key to trigger.
750                    bool    NoteOff;        ///< If a note off should be triggered instead of a note on.
751                    uint8_t Velocity;       ///< Velocity of the note to trigger. 255 means that velocity should depend on the speed of the controller change.
752                    bool    OverridePedal;  ///< If a note off should be triggered even if the sustain pedal is down.
753                } pTriggers[32];
754    
755            protected:
756                MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg);
757                MidiRuleCtrlTrigger();
758                void UpdateChunks(uint8_t* pData) const;
759                friend class Instrument;
760        };
761    
762        /** MIDI rule for instruments with legato samples. */
763        class MidiRuleLegato : public MidiRule {
764            public:
765                uint8_t LegatoSamples;     ///< Number of legato samples per key in each direction (always 12)
766                bool BypassUseController;  ///< If a controller should be used to bypass the sustain note
767                uint8_t BypassKey;         ///< Key to be used to bypass the sustain note
768                uint8_t BypassController;  ///< Controller to be used to bypass the sustain note
769                uint16_t ThresholdTime;    ///< Maximum time (ms) between two notes that should be played legato
770                uint16_t ReleaseTime;      ///< Release time
771                range_t KeyRange;          ///< Key range for legato notes
772                uint8_t ReleaseTriggerKey; ///< Key triggering release samples
773                uint8_t AltSustain1Key;    ///< Key triggering alternate sustain samples
774                uint8_t AltSustain2Key;    ///< Key triggering a second set of alternate sustain samples
775    
776            protected:
777                MidiRuleLegato(RIFF::Chunk* _3ewg);
778                MidiRuleLegato();
779                void UpdateChunks(uint8_t* pData) const;
780                friend class Instrument;
781        };
782    
783        /** MIDI rule to automatically cycle through specified sequences of different articulations. The instrument must be using the smartmidi dimension. */
784        class MidiRuleAlternator : public MidiRule {
785            public:
786                uint8_t Articulations;     ///< Number of articulations in the instrument
787                String pArticulations[32]; ///< Names of the articulations
788    
789                range_t PlayRange;         ///< Key range of the playable keys in the instrument
790    
791                uint8_t Patterns;          ///< Number of alternator patterns
792                struct pattern_t {
793                    String Name;           ///< Name of the pattern
794                    int Size;              ///< Number of steps in the pattern
795                    const uint8_t& operator[](int i) const { /// Articulation to play
796                        return data[i];
797                    }
798                    uint8_t& operator[](int i) {
799                        return data[i];
800                    }
801                private:
802                    uint8_t data[32];
803                } pPatterns[32];           ///< A pattern is a sequence of articulation numbers
804    
805                typedef enum {
806                    selector_none,
807                    selector_key_switch,
808                    selector_controller
809                } selector_t;
810                selector_t Selector;       ///< Method by which pattern is chosen
811                range_t KeySwitchRange;    ///< Key range for key switch selector
812                uint8_t Controller;        ///< CC number for controller selector
813    
814                bool Polyphonic;           ///< If alternator should step forward only when all notes are off
815                bool Chained;              ///< If all patterns should be chained together
816    
817            protected:
818                MidiRuleAlternator(RIFF::Chunk* _3ewg);
819                MidiRuleAlternator();
820                void UpdateChunks(uint8_t* pData) const;
821                friend class Instrument;
822        };
823    
824        /** A MIDI rule not yet implemented by libgig. */
825        class MidiRuleUnknown : public MidiRule {
826            protected:
827                MidiRuleUnknown() { }
828                void UpdateChunks(uint8_t* pData) const { }
829                friend class Instrument;
830        };
831    
832        /** @brief Real-time instrument script (gig format extension).
833         *
834         * Real-time instrument scripts are user supplied small programs which can
835         * be used by instrument designers to create custom behaviors and features
836         * not available in the stock sampler engine. Features which might be very
837         * exotic or specific for the respective instrument.
838         *
839         * This is an extension of the GigaStudio format, thus a feature which was
840         * not available in the GigaStudio 4 software. It is currently only
841         * supported by LinuxSampler and gigedit.
842         */
843        class Script {
844            public:
845                enum Encoding_t {
846                    ENCODING_ASCII = 0 ///< Standard 8 bit US ASCII character encoding (default).
847                };
848                enum Compression_t {
849                    COMPRESSION_NONE = 0 ///< Is not compressed at all (default).
850                };
851                enum Language_t {
852                    LANGUAGE_NKSP = 0 ///< NKSP stands for "Is Not KSP" (default).
853                };
854    
855                String         Name;        ///< Arbitrary name of the script, which may be displayed i.e. in an instrument editor.
856                Compression_t  Compression; ///< Whether the script was/should be compressed, and if so, which compression algorithm shall be used.
857                Encoding_t     Encoding;    ///< Format the script's source code text is encoded with.
858                Language_t     Language;    ///< Programming language and dialect the script is written in.
859                bool           Bypass;      ///< Global bypass: if enabled, this script shall not be executed by the sampler for any instrument.
860    
861                String GetScriptAsText();
862                void   SetScriptAsText(const String& text);
863                void   SetGroup(ScriptGroup* pGroup);
864                ScriptGroup* GetGroup() const;
865            protected:
866                Script(ScriptGroup* group, RIFF::Chunk* ckScri);
867                virtual ~Script();
868                void UpdateChunks(progress_t* pProgress);
869                void RemoveAllScriptReferences();
870                friend class ScriptGroup;
871                friend class Instrument;
872            private:
873                ScriptGroup*          pGroup;
874                RIFF::Chunk*          pChunk; ///< 'Scri' chunk
875                std::vector<uint8_t>  data;
876                uint32_t              crc; ///< CRC-32 checksum of the raw script data
877        };
878    
879        /** @brief Group of instrument scripts (gig format extension).
880         *
881         * This class is simply used to sort a bunch of real-time instrument scripts
882         * into individual groups. This allows instrument designers and script
883         * developers to keep scripts in a certain order while working with a larger
884         * amount of scripts in an instrument editor.
885         *
886         * This is an extension of the GigaStudio format, thus a feature which was
887         * not available in the GigaStudio 4 software. It is currently only
888         * supported by LinuxSampler and gigedit.
889         */
890        class ScriptGroup {
891            public:
892                String   Name; ///< Name of this script group. For example to be displayed in an instrument editor.
893    
894                Script*  GetScript(uint index);
895                Script*  AddScript();
896                void     DeleteScript(Script* pScript);
897            protected:
898                ScriptGroup(File* file, RIFF::List* lstRTIS);
899                virtual ~ScriptGroup();
900                void LoadScripts();
901                void UpdateChunks(progress_t* pProgress);
902                friend class Script;
903                friend class File;
904            private:
905                File*                pFile;
906                RIFF::List*          pList; ///< 'RTIS' list chunk
907                std::list<Script*>*  pScripts;
908        };
909    
910      /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */      /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */
911      class Instrument : protected DLS::Instrument {      class Instrument : protected DLS::Instrument {
912          public:          public:
913              // derived attributes from DLS::Resource              // derived attributes from DLS::Resource
914              DLS::Resource::pInfo;              using DLS::Resource::pInfo;
915              DLS::Resource::pDLSID;              using DLS::Resource::pDLSID;
916              // derived attributes from DLS::Instrument              // derived attributes from DLS::Instrument
917              DLS::Instrument::IsDrum;              using DLS::Instrument::IsDrum;
918              DLS::Instrument::MIDIBank;              using DLS::Instrument::MIDIBank;
919              DLS::Instrument::MIDIBankCoarse;              using DLS::Instrument::MIDIBankCoarse;
920              DLS::Instrument::MIDIBankFine;              using DLS::Instrument::MIDIBankFine;
921              DLS::Instrument::MIDIProgram;              using DLS::Instrument::MIDIProgram;
922              DLS::Instrument::Regions;              using DLS::Instrument::Regions;
923              // own attributes              // own attributes
924              int32_t   Attenuation;       ///< in dB              int32_t   Attenuation;       ///< in dB
925              uint16_t  EffectSend;              uint16_t  EffectSend;
# Line 497  namespace gig { Line 930  namespace gig {
930    
931    
932              // derived methods from DLS::Resource              // derived methods from DLS::Resource
933              DLS::Resource::GetParent;              using DLS::Resource::GetParent;
934              // overridden methods              // overridden methods
935              Region*   GetFirstRegion();              Region*   GetFirstRegion();
936              Region*   GetNextRegion();              Region*   GetNextRegion();
937                Region*   AddRegion();
938                void      DeleteRegion(Region* pRegion);
939                virtual void UpdateChunks(progress_t* pProgress);
940                virtual void CopyAssign(const Instrument* orig);
941              // own methods              // own methods
942              Region*   GetRegion(unsigned int Key);              Region*   GetRegion(unsigned int Key);
943                MidiRule* GetMidiRule(int i);
944                MidiRuleCtrlTrigger* AddMidiRuleCtrlTrigger();
945                MidiRuleLegato*      AddMidiRuleLegato();
946                MidiRuleAlternator*  AddMidiRuleAlternator();
947                void      DeleteMidiRule(int i);
948                // real-time instrument script methods
949                Script*   GetScriptOfSlot(uint index);
950                void      AddScriptSlot(Script* pScript, bool bypass = false);
951                void      SwapScriptSlots(uint index1, uint index2);
952                void      RemoveScriptSlot(uint index);
953                void      RemoveScript(Script* pScript);
954                uint      ScriptSlotCount() const;
955                bool      IsScriptSlotBypassed(uint index);
956                void      SetScriptSlotBypassed(uint index, bool bBypass);
957          protected:          protected:
             Region**  pRegions;            ///< Pointer array to the regions  
958              Region*   RegionKeyTable[128]; ///< fast lookup for the corresponding Region of a MIDI key              Region*   RegionKeyTable[128]; ///< fast lookup for the corresponding Region of a MIDI key
             int       RegionIndex;  
959    
960              Instrument(File* pFile, RIFF::List* insList);              Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
961             ~Instrument();             ~Instrument();
962                void CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples);
963                void UpdateRegionKeyTable();
964                void LoadScripts();
965                void UpdateScriptFileOffsets();
966              friend class File;              friend class File;
967                friend class Region; // so Region can call UpdateRegionKeyTable()
968            private:
969                struct _ScriptPooolEntry {
970                    uint32_t fileOffset;
971                    bool     bypass;
972                };
973                struct _ScriptPooolRef {
974                    Script*  script;
975                    bool     bypass;
976                };
977                MidiRule** pMidiRules;
978                std::vector<_ScriptPooolEntry> scriptPoolFileOffsets;
979                std::vector<_ScriptPooolRef>* pScriptRefs;
980        };
981    
982        /** @brief Group of Gigasampler objects
983         *
984         * Groups help to organize a huge collection of Gigasampler objects.
985         * Groups are not concerned at all for the synthesis, but they help
986         * sound library developers when working on complex instruments with an
987         * instrument editor (as long as that instrument editor supports it ;-).
988         *
989         * At the moment, it seems as only samples can be grouped together in
990         * the Gigasampler format yet. If this is false in the meantime, please
991         * tell us !
992         *
993         * A sample is always assigned to exactly one Group. This also means
994         * there is always at least one Group in a .gig file, no matter if you
995         * created one yet or not.
996         */
997        class Group {
998            public:
999                String Name; ///< Stores the name of this Group.
1000    
1001                Sample* GetFirstSample();
1002                Sample* GetNextSample();
1003                void AddSample(Sample* pSample);
1004            protected:
1005                Group(File* file, RIFF::Chunk* ck3gnm);
1006                virtual ~Group();
1007                virtual void UpdateChunks(progress_t* pProgress);
1008                void MoveAll();
1009                friend class File;
1010            private:
1011                File*        pFile;
1012                RIFF::Chunk* pNameChunk; ///< '3gnm' chunk
1013      };      };
1014    
     // TODO: <3gnm> chunk not added yet (just contains the names of the sample groups)  
1015      /** Parses Gigasampler files and provides abstract access to the data. */      /** Parses Gigasampler files and provides abstract access to the data. */
1016      class File : protected DLS::File {      class File : protected DLS::File {
1017          public:          public:
1018                static const DLS::version_t VERSION_2;
1019                static const DLS::version_t VERSION_3;
1020    
1021              // derived attributes from DLS::Resource              // derived attributes from DLS::Resource
1022              DLS::Resource::pInfo;              using DLS::Resource::pInfo;
1023              DLS::Resource::pDLSID;              using DLS::Resource::pDLSID;
1024              // derived attributes from DLS::File              // derived attributes from DLS::File
1025              DLS::File::pVersion;              using DLS::File::pVersion;
1026              DLS::File::Instruments;              using DLS::File::Instruments;
1027    
1028              // derived methods from DLS::Resource              // derived methods from DLS::Resource
1029              DLS::Resource::GetParent;              using DLS::Resource::GetParent;
1030                // derived methods from DLS::File
1031                using DLS::File::Save;
1032                using DLS::File::GetFileName;
1033                using DLS::File::SetFileName;
1034              // overridden  methods              // overridden  methods
1035                File();
1036              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
1037              Sample*     GetFirstSample();     ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise.              Sample*     GetFirstSample(progress_t* pProgress = NULL); ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise.
1038              Sample*     GetNextSample();      ///< Returns a pointer to the next <i>Sample</i> object of the file, <i>NULL</i> otherwise.              Sample*     GetNextSample();      ///< Returns a pointer to the next <i>Sample</i> object of the file, <i>NULL</i> otherwise.
1039                Sample*     GetSample(uint index);
1040                Sample*     AddSample();
1041                void        DeleteSample(Sample* pSample);
1042              Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</i> object of the file, <i>NULL</i> otherwise.              Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
1043              Instrument* GetNextInstrument();  ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise.              Instrument* GetNextInstrument();  ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
1044             ~File() {};              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
1045                Instrument* AddInstrument();
1046                Instrument* AddDuplicateInstrument(const Instrument* orig);
1047                void        DeleteInstrument(Instrument* pInstrument);
1048                Group*      GetFirstGroup(); ///< Returns a pointer to the first <i>Group</i> object of the file, <i>NULL</i> otherwise.
1049                Group*      GetNextGroup();  ///< Returns a pointer to the next <i>Group</i> object of the file, <i>NULL</i> otherwise.
1050                Group*      GetGroup(uint index);
1051                Group*      GetGroup(String name);
1052                Group*      AddGroup();
1053                void        DeleteGroup(Group* pGroup);
1054                void        DeleteGroupOnly(Group* pGroup);
1055                void        SetAutoLoad(bool b);
1056                bool        GetAutoLoad();
1057                void        AddContentOf(File* pFile);
1058                ScriptGroup* GetScriptGroup(uint index);
1059                ScriptGroup* GetScriptGroup(const String& name);
1060                ScriptGroup* AddScriptGroup();
1061                void        DeleteScriptGroup(ScriptGroup* pGroup);
1062                virtual    ~File();
1063                virtual void UpdateChunks(progress_t* pProgress);
1064          protected:          protected:
1065              typedef std::list<Sample*>     SampleList;              // overridden protected methods from DLS::File
1066              typedef std::list<Instrument*> InstrumentList;              virtual void LoadSamples();
1067                virtual void LoadInstruments();
1068              SampleList*              pSamples;              virtual void LoadGroups();
1069              SampleList::iterator     SamplesIterator;              virtual void UpdateFileOffsets();
1070              InstrumentList*          pInstruments;              // own protected methods
1071              InstrumentList::iterator InstrumentsIterator;              virtual void LoadSamples(progress_t* pProgress);
1072                virtual void LoadInstruments(progress_t* pProgress);
1073              void LoadSamples();              virtual void LoadScriptGroups();
1074              void LoadInstruments();              void SetSampleChecksum(Sample* pSample, uint32_t crc);
1075              friend class Region;              friend class Region;
1076                friend class Sample;
1077                friend class Group; // so Group can access protected member pRIFF
1078                friend class ScriptGroup; // so ScriptGroup can access protected member pRIFF
1079            private:
1080                std::list<Group*>*          pGroups;
1081                std::list<Group*>::iterator GroupsIterator;
1082                bool                        bAutoLoad;
1083                std::list<ScriptGroup*>*    pScriptGroups;
1084      };      };
1085    
1086      /** Will be thrown whenever a gig specific error occurs while trying to access a Gigasampler File. */      /**
1087         * Will be thrown whenever a gig specific error occurs while trying to
1088         * access a Gigasampler File. Note: In your application you should
1089         * better catch for RIFF::Exception rather than this one, except you
1090         * explicitly want to catch and handle gig::Exception, DLS::Exception
1091         * and RIFF::Exception independently, which usually shouldn't be
1092         * necessary though.
1093         */
1094      class Exception : public DLS::Exception {      class Exception : public DLS::Exception {
1095          public:          public:
1096              Exception(String Message);              Exception(String Message);
1097              void PrintMessage();              void PrintMessage();
1098      };      };
1099    
1100        String libraryName();
1101        String libraryVersion();
1102    
1103  } // namespace gig  } // namespace gig
1104    
1105  #endif // __GIG_H__  #endif // __GIG_H__

Legend:
Removed from v.16  
changed lines
  Added in v.2682

  ViewVC Help
Powered by ViewVC