/[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 2555 by schoenebeck, Fri May 16 23:08:42 2014 UTC revision 3181 by schoenebeck, Sun May 14 17:08:42 2017 UTC
# Line 2  Line 2 
2   *                                                                         *   *                                                                         *
3   *   libgig - C++ cross-platform Gigasampler format file access library    *   *   libgig - C++ cross-platform Gigasampler format file access library    *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003-2014 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2017 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  *
# Line 25  Line 25 
25  #define __GIG_H__  #define __GIG_H__
26    
27  #include "DLS.h"  #include "DLS.h"
28    #include <vector>
29    
30    #ifndef __has_feature
31    # define __has_feature(x) 0
32    #endif
33    #ifndef HAVE_RTTI
34    # if __GXX_RTTI || __has_feature(cxx_rtti) || _CPPRTTI
35    #  define HAVE_RTTI 1
36    # else
37    #  define HAVE_RTTI 0
38    # endif
39    #endif
40    #if HAVE_RTTI
41    # include <typeinfo>
42    #else
43    # warning No RTTI available!
44    #endif
45    
46  #if WORDS_BIGENDIAN  #if WORDS_BIGENDIAN
47  # define LIST_TYPE_3PRG 0x33707267  # define LIST_TYPE_3PRG 0x33707267
48  # define LIST_TYPE_3EWL 0x3365776C  # define LIST_TYPE_3EWL 0x3365776C
49  # define LIST_TYPE_3GRI 0x33677269  # define LIST_TYPE_3GRI 0x33677269
50  # define LIST_TYPE_3GNL 0x33676E6C  # define LIST_TYPE_3GNL 0x33676E6C
51    # define LIST_TYPE_3LS  0x334c5320 // own gig format extension
52    # define LIST_TYPE_RTIS 0x52544953 // own gig format extension
53  # define CHUNK_ID_3GIX  0x33676978  # define CHUNK_ID_3GIX  0x33676978
54  # define CHUNK_ID_3EWA  0x33657761  # define CHUNK_ID_3EWA  0x33657761
55  # define CHUNK_ID_3LNK  0x336C6E6B  # define CHUNK_ID_3LNK  0x336C6E6B
# Line 39  Line 58 
58  # define CHUNK_ID_3GNM  0x33676E6D  # define CHUNK_ID_3GNM  0x33676E6D
59  # define CHUNK_ID_EINF  0x65696E66  # define CHUNK_ID_EINF  0x65696E66
60  # define CHUNK_ID_3CRC  0x33637263  # define CHUNK_ID_3CRC  0x33637263
61    # define CHUNK_ID_SCRI  0x53637269 // own gig format extension
62    # define CHUNK_ID_LSNM  0x4c534e4d // own gig format extension
63    # define CHUNK_ID_SCSL  0x5343534c // own gig format extension
64  #else  // little endian  #else  // little endian
65  # define LIST_TYPE_3PRG 0x67727033  # define LIST_TYPE_3PRG 0x67727033
66  # define LIST_TYPE_3EWL 0x6C776533  # define LIST_TYPE_3EWL 0x6C776533
67  # define LIST_TYPE_3GRI 0x69726733  # define LIST_TYPE_3GRI 0x69726733
68  # define LIST_TYPE_3GNL 0x6C6E6733  # define LIST_TYPE_3GNL 0x6C6E6733
69    # define LIST_TYPE_3LS  0x20534c33 // own gig format extension
70    # define LIST_TYPE_RTIS 0x53495452 // own gig format extension
71  # define CHUNK_ID_3GIX  0x78696733  # define CHUNK_ID_3GIX  0x78696733
72  # define CHUNK_ID_3EWA  0x61776533  # define CHUNK_ID_3EWA  0x61776533
73  # define CHUNK_ID_3LNK  0x6B6E6C33  # define CHUNK_ID_3LNK  0x6B6E6C33
# Line 52  Line 76 
76  # define CHUNK_ID_3GNM  0x6D6E6733  # define CHUNK_ID_3GNM  0x6D6E6733
77  # define CHUNK_ID_EINF  0x666E6965  # define CHUNK_ID_EINF  0x666E6965
78  # define CHUNK_ID_3CRC  0x63726333  # define CHUNK_ID_3CRC  0x63726333
79    # define CHUNK_ID_SCRI  0x69726353 // own gig format extension
80    # define CHUNK_ID_LSNM  0x4d4e534c // own gig format extension
81    # define CHUNK_ID_SCSL  0x4c534353 // own gig format extension
82  #endif // WORDS_BIGENDIAN  #endif // WORDS_BIGENDIAN
83    
84  /** Gigasampler specific classes and definitions */  #ifndef GIG_DECLARE_ENUM
85    # define GIG_DECLARE_ENUM(type, ...) enum type { __VA_ARGS__ }
86    #endif
87    
88    // just symbol prototyping (since Serialization.h not included by default here)
89    namespace Serialization { class Archive; }
90    
91    /** Gigasampler/GigaStudio specific classes and definitions */
92  namespace gig {  namespace gig {
93    
94      typedef std::string String;      typedef std::string String;
95        typedef RIFF::progress_t progress_t;
96        typedef RIFF::file_offset_t file_offset_t;
97    
98      /** Lower and upper limit of a range. */      /** Lower and upper limit of a range. */
99      struct range_t {      struct range_t {
# Line 68  namespace gig { Line 104  namespace gig {
104      /** Pointer address and size of a buffer. */      /** Pointer address and size of a buffer. */
105      struct buffer_t {      struct buffer_t {
106          void*         pStart;            ///< Points to the beginning of the buffer.          void*         pStart;            ///< Points to the beginning of the buffer.
107          unsigned long Size;              ///< Size of the actual data in the buffer in bytes.          file_offset_t Size;              ///< Size of the actual data in the buffer in bytes.
108          unsigned long NullExtensionSize; ///< The buffer might be bigger than the actual data, if that's the case that unused space at the end of the buffer is filled with NULLs and NullExtensionSize reflects that unused buffer space in bytes. Those NULL extensions are mandatory for differential algorithms that have to take the following data words into account, thus have to access past the buffer's boundary. If you don't know what I'm talking about, just forget this variable. :)          file_offset_t NullExtensionSize; ///< The buffer might be bigger than the actual data, if that's the case that unused space at the end of the buffer is filled with NULLs and NullExtensionSize reflects that unused buffer space in bytes. Those NULL extensions are mandatory for differential algorithms that have to take the following data words into account, thus have to access past the buffer's boundary. If you don't know what I'm talking about, just forget this variable. :)
109          buffer_t() {          buffer_t() {
110              pStart            = NULL;              pStart            = NULL;
111              Size              = 0;              Size              = 0;
# Line 77  namespace gig { Line 113  namespace gig {
113          }          }
114      };      };
115    
116      /** Standard types of sample loops. */      /** Standard types of sample loops.
117      typedef enum {       *
118         * @see enumCount(), enumKey(), enumKeys(), enumValue()
119         */
120        GIG_DECLARE_ENUM(loop_type_t,
121          loop_type_normal        = 0x00000000,  ///< Loop forward (normal)          loop_type_normal        = 0x00000000,  ///< Loop forward (normal)
122          loop_type_bidirectional = 0x00000001,  ///< Alternating loop (forward/backward, also known as Ping Pong)          loop_type_bidirectional = 0x00000001,  ///< Alternating loop (forward/backward, also known as Ping Pong)
123          loop_type_backward      = 0x00000002   ///< Loop backward (reverse)          loop_type_backward      = 0x00000002   ///< Loop backward (reverse)
124      } loop_type_t;      );
125    
126      /** Society of Motion Pictures and Television E time format. */      /** Society of Motion Pictures and Television E time format.
127      typedef enum {       *
128         * @see enumCount(), enumKey(), enumKeys(), enumValue()
129         */
130        GIG_DECLARE_ENUM(smpte_format_t,
131          smpte_format_no_offset          = 0x00000000,  ///< no SMPTE offset          smpte_format_no_offset          = 0x00000000,  ///< no SMPTE offset
132          smpte_format_24_frames          = 0x00000018,  ///< 24 frames per second          smpte_format_24_frames          = 0x00000018,  ///< 24 frames per second
133          smpte_format_25_frames          = 0x00000019,  ///< 25 frames per second          smpte_format_25_frames          = 0x00000019,  ///< 25 frames per second
134          smpte_format_30_frames_dropping = 0x0000001D,  ///< 30 frames per second with frame dropping (30 drop)          smpte_format_30_frames_dropping = 0x0000001D,  ///< 30 frames per second with frame dropping (30 drop)
135          smpte_format_30_frames          = 0x0000001E   ///< 30 frames per second          smpte_format_30_frames          = 0x0000001E   ///< 30 frames per second
136      } smpte_format_t;      );
137    
138      /** Defines the shape of a function graph. */      /** Defines the shape of a function graph.
139      typedef enum {       *
140         * @see enumCount(), enumKey(), enumKeys(), enumValue()
141         */
142        GIG_DECLARE_ENUM(curve_type_t,
143          curve_type_nonlinear = 0,          curve_type_nonlinear = 0,
144          curve_type_linear    = 1,          curve_type_linear    = 1,
145          curve_type_special   = 2,          curve_type_special   = 2,
146          curve_type_unknown   = 0xffffffff          curve_type_unknown   = 0xffffffff
147      } curve_type_t;      );
148    
149      /** Dimensions allow to bypass one of the following controllers. */      /** Dimensions allow to bypass one of the following controllers.
150      typedef enum {       *
151         * @see enumCount(), enumKey(), enumKeys(), enumValue()
152         */
153        GIG_DECLARE_ENUM(dim_bypass_ctrl_t,
154          dim_bypass_ctrl_none,          dim_bypass_ctrl_none,
155          dim_bypass_ctrl_94,   ///< Effect 4 Depth (MIDI Controller 94)          dim_bypass_ctrl_94,   ///< Effect 4 Depth (MIDI Controller 94)
156          dim_bypass_ctrl_95    ///< Effect 5 Depth (MIDI Controller 95)          dim_bypass_ctrl_95    ///< Effect 5 Depth (MIDI Controller 95)
157      } dim_bypass_ctrl_t;      );
158    
159      /** Defines how LFO3 is controlled by. */      /** Defines how LFO3 is controlled by.
160      typedef enum {       *
161         * @see enumCount(), enumKey(), enumKeys(), enumValue()
162         */
163        GIG_DECLARE_ENUM(lfo3_ctrl_t,
164          lfo3_ctrl_internal            = 0x00, ///< Only internally controlled.          lfo3_ctrl_internal            = 0x00, ///< Only internally controlled.
165          lfo3_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.          lfo3_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.
166          lfo3_ctrl_aftertouch          = 0x02, ///< Only controlled by aftertouch controller.          lfo3_ctrl_aftertouch          = 0x02, ///< Only controlled by aftertouch controller.
167          lfo3_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.          lfo3_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.
168          lfo3_ctrl_internal_aftertouch = 0x04  ///< Controlled internally and by aftertouch controller.          lfo3_ctrl_internal_aftertouch = 0x04  ///< Controlled internally and by aftertouch controller.
169      } lfo3_ctrl_t;      );
170    
171      /** Defines how LFO2 is controlled by. */      /** Defines how LFO2 is controlled by.
172      typedef enum {       *
173         * @see enumCount(), enumKey(), enumKeys(), enumValue()
174         */
175        GIG_DECLARE_ENUM(lfo2_ctrl_t,
176          lfo2_ctrl_internal            = 0x00, ///< Only internally controlled.          lfo2_ctrl_internal            = 0x00, ///< Only internally controlled.
177          lfo2_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.          lfo2_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.
178          lfo2_ctrl_foot                = 0x02, ///< Only controlled by external foot controller.          lfo2_ctrl_foot                = 0x02, ///< Only controlled by external foot controller.
179          lfo2_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.          lfo2_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.
180          lfo2_ctrl_internal_foot       = 0x04  ///< Controlled internally and by external foot controller.          lfo2_ctrl_internal_foot       = 0x04  ///< Controlled internally and by external foot controller.
181      } lfo2_ctrl_t;      );
182    
183      /** Defines how LFO1 is controlled by. */      /** Defines how LFO1 is controlled by.
184      typedef enum {       *
185         * @see enumCount(), enumKey(), enumKeys(), enumValue()
186         */
187        GIG_DECLARE_ENUM(lfo1_ctrl_t,
188          lfo1_ctrl_internal            = 0x00, ///< Only internally controlled.          lfo1_ctrl_internal            = 0x00, ///< Only internally controlled.
189          lfo1_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.          lfo1_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.
190          lfo1_ctrl_breath              = 0x02, ///< Only controlled by external breath controller.          lfo1_ctrl_breath              = 0x02, ///< Only controlled by external breath controller.
191          lfo1_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.          lfo1_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.
192          lfo1_ctrl_internal_breath     = 0x04  ///< Controlled internally and by external breath controller.          lfo1_ctrl_internal_breath     = 0x04  ///< Controlled internally and by external breath controller.
193      } lfo1_ctrl_t;      );
194    
195      /** Defines how the filter cutoff frequency is controlled by. */      /** Defines how the filter cutoff frequency is controlled by.
196      typedef enum {       *
197         * @see enumCount(), enumKey(), enumKeys(), enumValue()
198         */
199        GIG_DECLARE_ENUM(vcf_cutoff_ctrl_t,
200          vcf_cutoff_ctrl_none         = 0x00,          vcf_cutoff_ctrl_none         = 0x00,
201          vcf_cutoff_ctrl_none2        = 0x01,  ///< The difference between none and none2 is unknown          vcf_cutoff_ctrl_none2        = 0x01,  ///< The difference between none and none2 is unknown
202          vcf_cutoff_ctrl_modwheel     = 0x81,  ///< Modulation Wheel (MIDI Controller 1)          vcf_cutoff_ctrl_modwheel     = 0x81,  ///< Modulation Wheel (MIDI Controller 1)
# Line 149  namespace gig { Line 209  namespace gig {
209          vcf_cutoff_ctrl_genpurpose7  = 0xd2,  ///< General Purpose Controller 7 (Button, MIDI Controller 82)          vcf_cutoff_ctrl_genpurpose7  = 0xd2,  ///< General Purpose Controller 7 (Button, MIDI Controller 82)
210          vcf_cutoff_ctrl_genpurpose8  = 0xd3,  ///< General Purpose Controller 8 (Button, MIDI Controller 83)          vcf_cutoff_ctrl_genpurpose8  = 0xd3,  ///< General Purpose Controller 8 (Button, MIDI Controller 83)
211          vcf_cutoff_ctrl_aftertouch   = 0x80   ///< Key Pressure          vcf_cutoff_ctrl_aftertouch   = 0x80   ///< Key Pressure
212      } vcf_cutoff_ctrl_t;      );
213    
214      /** Defines how the filter resonance is controlled by. */      /** Defines how the filter resonance is controlled by.
215      typedef enum {       *
216         * @see enumCount(), enumKey(), enumKeys(), enumValue()
217         */
218        GIG_DECLARE_ENUM(vcf_res_ctrl_t,
219          vcf_res_ctrl_none        = 0xffffffff,          vcf_res_ctrl_none        = 0xffffffff,
220          vcf_res_ctrl_genpurpose3 = 0,           ///< General Purpose Controller 3 (Slider, MIDI Controller 18)          vcf_res_ctrl_genpurpose3 = 0,           ///< General Purpose Controller 3 (Slider, MIDI Controller 18)
221          vcf_res_ctrl_genpurpose4 = 1,           ///< General Purpose Controller 4 (Slider, MIDI Controller 19)          vcf_res_ctrl_genpurpose4 = 1,           ///< General Purpose Controller 4 (Slider, MIDI Controller 19)
222          vcf_res_ctrl_genpurpose5 = 2,           ///< General Purpose Controller 5 (Button, MIDI Controller 80)          vcf_res_ctrl_genpurpose5 = 2,           ///< General Purpose Controller 5 (Button, MIDI Controller 80)
223          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)
224      } vcf_res_ctrl_t;      );
225    
226      /**      /**
227       * Defines a controller that has a certain contrained influence on a       * Defines a controller that has a certain contrained influence on a
# Line 169  namespace gig { Line 232  namespace gig {
232       * attenuation_ctrl_t, eg1_ctrl_t or eg2_ctrl_t) in your code!       * attenuation_ctrl_t, eg1_ctrl_t or eg2_ctrl_t) in your code!
233       */       */
234      struct leverage_ctrl_t {      struct leverage_ctrl_t {
235          typedef enum {          /** Defines possible controllers.
236             *
237             * @see enumCount(), enumKey(), enumKeys(), enumValue()
238             */
239            GIG_DECLARE_ENUM(type_t,
240              type_none              = 0x00, ///< No controller defined              type_none              = 0x00, ///< No controller defined
241              type_channelaftertouch = 0x2f, ///< Channel Key Pressure              type_channelaftertouch = 0x2f, ///< Channel Key Pressure
242              type_velocity          = 0xff, ///< Key Velocity              type_velocity          = 0xff, ///< Key Velocity
243              type_controlchange     = 0xfe  ///< Ordinary MIDI control change controller, see field 'controller_number'              type_controlchange     = 0xfe  ///< Ordinary MIDI control change controller, see field 'controller_number'
244          } type_t;          );
245    
246          type_t type;              ///< Controller type          type_t type;              ///< Controller type
247          uint   controller_number; ///< MIDI controller number if this controller is a control change controller, 0 otherwise          uint   controller_number; ///< MIDI controller number if this controller is a control change controller, 0 otherwise
248    
249            void serialize(Serialization::Archive* archive);
250      };      };
251    
252      /**      /**
# Line 207  namespace gig { Line 276  namespace gig {
276       * dimension zones is always a power of two. All dimensions can have up       * dimension zones is always a power of two. All dimensions can have up
277       * to 32 zones (except the layer dimension with only up to 8 zones and       * to 32 zones (except the layer dimension with only up to 8 zones and
278       * the samplechannel dimension which currently allows only 2 zones).       * the samplechannel dimension which currently allows only 2 zones).
279         *
280         * @see enumCount(), enumKey(), enumKeys(), enumValue()
281       */       */
282      typedef enum {      GIG_DECLARE_ENUM(dimension_t,
283          dimension_none              = 0x00, ///< Dimension not in use.          dimension_none              = 0x00, ///< Dimension not in use.
284          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).
285          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).
# Line 243  namespace gig { Line 314  namespace gig {
314          dimension_effect3depth      = 0x5d, ///< Effect 3 Depth (MIDI Controller 93)          dimension_effect3depth      = 0x5d, ///< Effect 3 Depth (MIDI Controller 93)
315          dimension_effect4depth      = 0x5e, ///< Effect 4 Depth (MIDI Controller 94)          dimension_effect4depth      = 0x5e, ///< Effect 4 Depth (MIDI Controller 94)
316          dimension_effect5depth      = 0x5f  ///< Effect 5 Depth (MIDI Controller 95)          dimension_effect5depth      = 0x5f  ///< Effect 5 Depth (MIDI Controller 95)
317      } dimension_t;      );
318    
319      /**      /**
320       * Intended for internal usage: will be used to convert a dimension value       * Intended for internal usage: will be used to convert a dimension value
321       * into the corresponding dimension bit number.       * into the corresponding dimension bit number.
322         *
323         * @see enumCount(), enumKey(), enumKeys(), enumValue()
324       */       */
325      typedef enum {      GIG_DECLARE_ENUM(split_type_t,
326          split_type_normal,         ///< dimension value between 0-127          split_type_normal,         ///< dimension value between 0-127
327          split_type_bit             ///< dimension values are already the sought bit number          split_type_bit             ///< dimension values are already the sought bit number
328      } split_type_t;      );
329    
330      /** General dimension definition. */      /** General dimension definition. */
331      struct dimension_def_t {      struct dimension_def_t {
# Line 263  namespace gig { Line 336  namespace gig {
336          float        zone_size;  ///< Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only, 0 otherwise.          float        zone_size;  ///< Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only, 0 otherwise.
337      };      };
338    
339      /** Defines which frequencies are filtered by the VCF. */      /** Defines which frequencies are filtered by the VCF.
340      typedef enum {       *
341         * @see enumCount(), enumKey(), enumKeys(), enumValue()
342         */
343        GIG_DECLARE_ENUM(vcf_type_t,
344          vcf_type_lowpass      = 0x00,          vcf_type_lowpass      = 0x00,
345          vcf_type_lowpassturbo = 0xff, ///< More poles than normal lowpass          vcf_type_lowpassturbo = 0xff, ///< More poles than normal lowpass
346          vcf_type_bandpass     = 0x01,          vcf_type_bandpass     = 0x01,
347          vcf_type_highpass     = 0x02,          vcf_type_highpass     = 0x02,
348          vcf_type_bandreject   = 0x03          vcf_type_bandreject   = 0x03
349      } vcf_type_t;      );
350    
351      /**      /**
352       * Defines the envelope of a crossfade.       * Defines the envelope of a crossfade.
# Line 291  namespace gig { Line 367  namespace gig {
367          uint8_t out_start;  ///< Start position of fade out.          uint8_t out_start;  ///< Start position of fade out.
368          uint8_t out_end;    ///< End postition of fade out.          uint8_t out_end;    ///< End postition of fade out.
369          #endif // WORDS_BIGENDIAN          #endif // WORDS_BIGENDIAN
370    
371            void serialize(Serialization::Archive* archive);
372      };      };
373    
374      /** Reflects the current playback state for a sample. */      /** Reflects the current playback state for a sample. */
375      struct playback_state_t {      struct playback_state_t {
376          unsigned long position;          ///< Current position within the sample.          file_offset_t position;          ///< Current position within the sample.
377          bool          reverse;           ///< If playback direction is currently backwards (in case there is a pingpong or reverse loop defined).          bool          reverse;           ///< If playback direction is currently backwards (in case there is a pingpong or reverse loop defined).
378          unsigned long loop_cycles_left;  ///< How many times the loop has still to be passed, this value will be decremented with each loop cycle.          file_offset_t loop_cycles_left;  ///< How many times the loop has still to be passed, this value will be decremented with each loop cycle.
     };  
   
     /**  
      * @brief Used for indicating the progress of a certain task.  
      *  
      * The function pointer argument has to be supplied with a valid  
      * function of the given signature which will then be called on  
      * progress changes. An equivalent progress_t structure will be passed  
      * back as argument to the callback function on each progress change.  
      * The factor field of the supplied progress_t structure will then  
      * reflect the current progress as value between 0.0 and 1.0. You might  
      * want to use the custom field for data needed in your callback  
      * function.  
      */  
     struct progress_t {  
         void (*callback)(progress_t*); ///< Callback function pointer which has to be assigned to a function for progress notification.  
         float factor;                  ///< Reflects current progress as value between 0.0 and 1.0.  
         void* custom;                  ///< This pointer can be used for arbitrary data.  
         float __range_min;             ///< Only for internal usage, do not modify!  
         float __range_max;             ///< Only for internal usage, do not modify!  
         progress_t();  
379      };      };
380    
381      // just symbol prototyping      // just symbol prototyping
# Line 327  namespace gig { Line 384  namespace gig {
384      class Sample;      class Sample;
385      class Region;      class Region;
386      class Group;      class Group;
387        class Script;
388        class ScriptGroup;
389    
390      /** @brief Encapsulates articulation information of a dimension region.      /** @brief Encapsulates articulation informations of a dimension region.
391       *       *
392       *  Every Gigasampler Instrument has at least one dimension region       * This is the most important data object of the Gigasampler / GigaStudio
393       *  (exactly then when it has no dimension defined).       * format. A DimensionRegion provides the link to the sample to be played
394         * and all required articulation informations to be interpreted for playing
395         * back the sample and processing it appropriately by the sampler software.
396         * Every Region of a Gigasampler Instrument has at least one dimension
397         * region (exactly then when the Region has no dimension defined). Many
398         * Regions though provide more than one DimensionRegion, which reflect
399         * different playing "cases". For example a different sample might be played
400         * if a certain pedal is pressed down, or if the note was triggered with
401         * different velocity.
402       *       *
403       *  Gigasampler provides three Envelope Generators and Low Frequency       * One instance of a DimensionRegion reflects exactly one particular case
404       *  Oscillators:       * while playing an instrument (for instance "note between C3 and E3 was
405         * triggered AND note on velocity was between 20 and 42 AND modulation wheel
406         * controller is between 80 and 127). The DimensionRegion defines what to do
407         * under that one particular case, that is which sample to play back and how
408         * to play that sample back exactly and how to process it. So a
409         * DimensionRegion object is always linked to exactly one sample. It may
410         * however also link to no sample at all, for defining a "silence" case
411         * where nothing shall be played (for example when note on velocity was
412         * below 6).
413         *
414         * Note that a DimensionRegion object only defines "what to do", but it does
415         * not define "when to do it". To actually resolve which DimensionRegion to
416         * pick under which situation, you need to refer to the DimensionRegions'
417         * parent Region object. The Region object contains the necessary
418         * "Dimension" definitions, which in turn define which DimensionRegion is
419         * associated with which playing case exactly.
420         *
421         * The Gigasampler/GigaStudio format defines 3 Envelope Generators and 3
422         * Low Frequency Oscillators:
423       *       *
424       *  - EG1 and LFO1, both controlling sample amplitude       *  - EG1 and LFO1, both controlling sample amplitude
425       *  - EG2 and LFO2, both controlling filter cutoff frequency       *  - EG2 and LFO2, both controlling filter cutoff frequency
426       *  - EG3 and LFO3, both controlling sample pitch       *  - EG3 and LFO3, both controlling sample pitch
427         *
428         * Since the gig format was designed as extension to the DLS file format,
429         * this class is derived from the DLS::Sampler class. So also refer to
430         * DLS::Sampler for additional informations, class attributes and methods.
431       */       */
432      class DimensionRegion : protected DLS::Sampler {      class DimensionRegion : protected DLS::Sampler {
433          public:          public:
# Line 454  namespace gig { Line 543  namespace gig {
543              using DLS::Sampler::DeleteSampleLoop;              using DLS::Sampler::DeleteSampleLoop;
544              // overridden methods              // overridden methods
545              virtual void SetGain(int32_t gain);              virtual void SetGain(int32_t gain);
546              virtual void UpdateChunks();              virtual void UpdateChunks(progress_t* pProgress);
547              virtual void CopyAssign(const DimensionRegion* orig);              virtual void CopyAssign(const DimensionRegion* orig);
548          protected:          protected:
549              uint8_t* VelocityTable; ///< For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number.              uint8_t* VelocityTable; ///< For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number.
# Line 462  namespace gig { Line 551  namespace gig {
551              DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);              DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);
552             ~DimensionRegion();             ~DimensionRegion();
553              void CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples);              void CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples);
554                void serialize(Serialization::Archive* archive);
555              friend class Region;              friend class Region;
556                friend class Serialization::Archive;
557          private:          private:
558              typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller              typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller
559                  // official leverage controllers as they were defined in the original Gigasampler/GigaStudio format:                  // official leverage controllers as they were defined in the original Gigasampler/GigaStudio format:
# Line 565  namespace gig { Line 656  namespace gig {
656              } _lev_ctrl_t;              } _lev_ctrl_t;
657              typedef std::map<uint32_t, double*> VelocityTableMap;              typedef std::map<uint32_t, double*> VelocityTableMap;
658    
659              static uint              Instances;                  ///< Number of DimensionRegion instances.              static size_t            Instances;                  ///< Number of DimensionRegion instances.
660              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).
661              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.
662              double*                  pVelocityReleaseTable;      ///< Points to the velocity table corresponding to the release velocity parameters of this DimensionRegion              double*                  pVelocityReleaseTable;      ///< Points to the velocity table corresponding to the release velocity parameters of this DimensionRegion
# Line 580  namespace gig { Line 671  namespace gig {
671              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
672      };      };
673    
674      /** @brief Encapsulates sample waves used for playback.      /** @brief Encapsulates sample waves of Gigasampler/GigaStudio files used for playback.
675         *
676         * This class provides access to the actual audio sample data of a
677         * Gigasampler/GigaStudio file. Along to the actual sample data, it also
678         * provides access to the sample's meta informations like bit depth,
679         * sample rate, encoding type, but also loop informations. The latter may be
680         * used by instruments for resembling sounds with arbitary note lengths.
681       *       *
682       * In case you created a new sample with File::AddSample(), you should       * In case you created a new sample with File::AddSample(), you should
683       * first update all attributes with the desired meta informations       * first update all attributes with the desired meta informations
# Line 594  namespace gig { Line 691  namespace gig {
691       * retrieved from the respective DimensionRegon instead from the Sample       * retrieved from the respective DimensionRegon instead from the Sample
692       * itself. This was made for allowing different loop definitions for the       * itself. This was made for allowing different loop definitions for the
693       * same sample under different conditions.       * same sample under different conditions.
694         *
695         * Since the gig format was designed as extension to the DLS file format,
696         * this class is derived from the DLS::Sample class. So also refer to
697         * DLS::Sample for additional informations, class attributes and methods.
698       */       */
699      class Sample : public DLS::Sample {      class Sample : public DLS::Sample {
700          public:          public:
# Line 618  namespace gig { Line 719  namespace gig {
719    
720              // own methods              // own methods
721              buffer_t      LoadSampleData();              buffer_t      LoadSampleData();
722              buffer_t      LoadSampleData(unsigned long SampleCount);              buffer_t      LoadSampleData(file_offset_t SampleCount);
723              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
724              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(file_offset_t SampleCount, uint NullSamplesCount);
725              buffer_t      GetCache();              buffer_t      GetCache();
726              // own static methods              // own static methods
727              static buffer_t CreateDecompressionBuffer(unsigned long MaxReadSize);              static buffer_t CreateDecompressionBuffer(file_offset_t MaxReadSize);
728              static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);              static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
729              // overridden methods              // overridden methods
730              void          ReleaseSampleData();              void          ReleaseSampleData();
731              void          Resize(int iNewSize);              void          Resize(file_offset_t NewSize);
732              unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);              file_offset_t SetPos(file_offset_t SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
733              unsigned long GetPos() const;              file_offset_t GetPos() const;
734              unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);              file_offset_t Read(void* pBuffer, file_offset_t SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
735              unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL);              file_offset_t ReadAndLoop(void* pBuffer, file_offset_t SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL);
736              unsigned long Write(void* pBuffer, unsigned long SampleCount);              file_offset_t Write(void* pBuffer, file_offset_t SampleCount);
737              Group*        GetGroup() const;              Group*        GetGroup() const;
738              virtual void  UpdateChunks();              virtual void  UpdateChunks(progress_t* pProgress);
739              void CopyAssignMeta(const Sample* orig);              void CopyAssignMeta(const Sample* orig);
740              void CopyAssignWave(const Sample* orig);              void CopyAssignWave(const Sample* orig);
741                uint32_t GetWaveDataCRC32Checksum();
742                bool VerifyWaveData(uint32_t* pActually = NULL);
743          protected:          protected:
744              static unsigned int  Instances;               ///< Number of instances of class Sample.              static size_t        Instances;               ///< Number of instances of class Sample.
745              static buffer_t      InternalDecompressionBuffer; ///< Buffer used for decompression as well as for truncation of 24 Bit -> 16 Bit samples.              static buffer_t      InternalDecompressionBuffer; ///< Buffer used for decompression as well as for truncation of 24 Bit -> 16 Bit samples.
746              Group*               pGroup;                  ///< pointer to the Group this sample belongs to (always not-NULL)              Group*               pGroup;                  ///< pointer to the Group this sample belongs to (always not-NULL)
747              unsigned long        FrameOffset;             ///< Current offset (sample points) in current sample frame (for decompression only).              file_offset_t        FrameOffset;             ///< Current offset (sample points) in current sample frame (for decompression only).
748              unsigned long*       FrameTable;              ///< For positioning within compressed samples only: stores the offset values for each frame.              file_offset_t*       FrameTable;              ///< For positioning within compressed samples only: stores the offset values for each frame.
749              unsigned long        SamplePos;               ///< For compressed samples only: stores the current position (in sample points).              file_offset_t        SamplePos;               ///< For compressed samples only: stores the current position (in sample points).
750              unsigned long        SamplesInLastFrame;      ///< For compressed samples only: length of the last sample frame.              file_offset_t        SamplesInLastFrame;      ///< For compressed samples only: length of the last sample frame.
751              unsigned long        WorstCaseFrameSize;      ///< For compressed samples only: size (in bytes) of the largest possible sample frame.              file_offset_t        WorstCaseFrameSize;      ///< For compressed samples only: size (in bytes) of the largest possible sample frame.
752              unsigned long        SamplesPerFrame;         ///< For compressed samples only: number of samples in a full sample frame.              file_offset_t        SamplesPerFrame;         ///< For compressed samples only: number of samples in a full sample frame.
753              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.
754              unsigned long        FileNo;                  ///< File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)              unsigned long        FileNo;                  ///< File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)
755              RIFF::Chunk*         pCk3gix;              RIFF::Chunk*         pCk3gix;
756              RIFF::Chunk*         pCkSmpl;              RIFF::Chunk*         pCkSmpl;
757              uint32_t             crc;                     ///< CRC-32 checksum of the raw sample data              uint32_t             crc;                     ///< Reflects CRC-32 checksum of the raw sample data at the last time when the sample's raw wave form data has been modified consciously by the user by calling Write().
758    
759              Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo = 0);              Sample(File* pFile, RIFF::List* waveList, file_offset_t WavePoolOffset, unsigned long fileNo = 0, int index = -1);
760             ~Sample();             ~Sample();
761                uint32_t CalculateWaveDataChecksum();
762    
763              // Guess size (in bytes) of a compressed sample              // Guess size (in bytes) of a compressed sample
764              inline unsigned long GuessSize(unsigned long samples) {              inline file_offset_t GuessSize(file_offset_t samples) {
765                  // 16 bit: assume all frames are compressed - 1 byte                  // 16 bit: assume all frames are compressed - 1 byte
766                  // per sample and 5 bytes header per 2048 samples                  // per sample and 5 bytes header per 2048 samples
767    
768                  // 24 bit: assume next best compression rate - 1.5                  // 24 bit: assume next best compression rate - 1.5
769                  // bytes per sample and 13 bytes header per 256                  // bytes per sample and 13 bytes header per 256
770                  // samples                  // samples
771                  const unsigned long size =                  const file_offset_t size =
772                      BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13                      BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
773                                     : samples + (samples >> 10) * 5;                                     : samples + (samples >> 10) * 5;
774                  // Double for stereo and add one worst case sample                  // Double for stereo and add one worst case sample
# Line 674  namespace gig { Line 778  namespace gig {
778    
779              // Worst case amount of sample points that can be read with the              // Worst case amount of sample points that can be read with the
780              // given decompression buffer.              // given decompression buffer.
781              inline unsigned long WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {              inline file_offset_t WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
782                  return (unsigned long) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);                  return (file_offset_t) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
783              }              }
784          private:          private:
785              void ScanCompressedSample();              void ScanCompressedSample();
# Line 685  namespace gig { Line 789  namespace gig {
789      };      };
790    
791      // 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)
792      /** @brief Defines Region information of an Instrument.      /** @brief Defines Region information of a Gigasampler/GigaStudio instrument.
793       *       *
794       * A Region reflects a consecutive area on the keyboard. The individual       * A Region reflects a consecutive area (key range) on the keyboard. The
795       * regions in the gig format may not overlap with other regions (of the same       * individual regions in the gig format may not overlap with other regions
796       * instrument). Further, in the gig format a Region is merely a container       * (of the same instrument that is). Further, in the gig format a Region is
797       * for DimensionRegions (a.k.a. "Cases"). The Region itself does not provide       * merely a container for DimensionRegions (a.k.a. "Cases"). The Region
798       * the sample mapping or articulation informations used, even though the       * itself does not provide the sample mapping or articulation informations
799       * data structures indeed provide such informations. The latter is however       * used, even though the data structures of regions indeed provide such
800       * just of historical nature, because the gig format was derived from the       * informations. The latter is however just of historical nature, because
801       * DLS format.       * the gig file format was derived from the DLS file format.
802       *       *
803       * Each Region consists of at least one or more DimensionRegions. The actual       * Each Region consists of at least one or more DimensionRegions. The actual
804       * amount of DimensionRegions depends on which kind of "dimensions" are       * amount of DimensionRegions depends on which kind of "dimensions" are
805       * defined for this region, and on the split / zone amount for each of those       * defined for this region, and on the split / zone amount for each of those
806       * dimensions.       * dimensions.
807         *
808         * Since the gig format was designed as extension to the DLS file format,
809         * this class is derived from the DLS::Region class. So also refer to
810         * DLS::Region for additional informations, class attributes and methods.
811       */       */
812      class Region : public DLS::Region {      class Region : public DLS::Region {
813          public:          public:
# Line 712  namespace gig { Line 820  namespace gig {
820              // own methods              // own methods
821              DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);              DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
822              DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);              DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
823                int              GetDimensionRegionIndexByValue(const uint DimValues[8]);
824              Sample*          GetSample();              Sample*          GetSample();
825              void             AddDimension(dimension_def_t* pDimDef);              void             AddDimension(dimension_def_t* pDimDef);
826              void             DeleteDimension(dimension_def_t* pDimDef);              void             DeleteDimension(dimension_def_t* pDimDef);
827              dimension_def_t* GetDimensionDefinition(dimension_t type);              dimension_def_t* GetDimensionDefinition(dimension_t type);
828              void             DeleteDimensionZone(dimension_t type, int zone);              void             DeleteDimensionZone(dimension_t type, int zone);
829              void             SplitDimensionZone(dimension_t type, int zone);              void             SplitDimensionZone(dimension_t type, int zone);
830                void             SetDimensionType(dimension_t oldType, dimension_t newType);
831              // overridden methods              // overridden methods
832              virtual void     SetKeyRange(uint16_t Low, uint16_t High);              virtual void     SetKeyRange(uint16_t Low, uint16_t High);
833              virtual void     UpdateChunks();              virtual void     UpdateChunks(progress_t* pProgress);
834              virtual void     CopyAssign(const Region* orig);              virtual void     CopyAssign(const Region* orig);
835          protected:          protected:
836              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
# Line 733  namespace gig { Line 843  namespace gig {
843              friend class Instrument;              friend class Instrument;
844      };      };
845    
846      /** Abstract base class for all MIDI rules. */      /** @brief Abstract base class for all MIDI rules.
847         *
848         * Note: Instead of using MIDI rules, we recommend you using real-time
849         * instrument scripts instead. Read about the reasons below.
850         *
851         * MIDI Rules (also called "iMIDI rules" or "intelligent MIDI rules") were
852         * introduced with GigaStudio 4 as an attempt to increase the power of
853         * potential user controls over sounds. At that point other samplers already
854         * supported certain powerful user control features, which were not possible
855         * with GigaStudio yet. For example triggering new notes by MIDI CC
856         * controller.
857         *
858         * Such extended features however were usually implemented by other samplers
859         * by requiring the sound designer to write an instrument script which the
860         * designer would then bundle with the respective instrument file. Such
861         * scripts are essentially text files, using a very specific programming
862         * language for the purpose of controlling the sampler in real-time. Since
863         * however musicians are not typically keen to writing such cumbersome
864         * script files, the GigaStudio designers decided to implement such extended
865         * features completely without instrument scripts. Instead they created a
866         * set of rules, which could be defined and altered conveniently by mouse
867         * clicks in GSt's instrument editor application. The downside of this
868         * overall approach however, was that those MIDI rules were very limited in
869         * practice. As sound designer you easily came across the possiblities such
870         * MIDI rules were able to offer.
871         *
872         * Due to such severe use case constraints, support for MIDI rules is quite
873         * limited in libgig. At the moment only the "Control Trigger", "Alternator"
874         * and the "Legato" MIDI rules are supported by libgig. Consequently the
875         * graphical instrument editor application gigedit just supports the
876         * "Control Trigger" and "Legato" MIDI rules, and LinuxSampler even does not
877         * support any MIDI rule type at all and LinuxSampler probably will not
878         * support MIDI rules in future either.
879         *
880         * Instead of using MIDI rules, we introduced real-time instrument scripts
881         * as extension to the original GigaStudio file format. This script based
882         * solution is much more powerful than MIDI rules and is already supported
883         * by libgig, gigedit and LinuxSampler.
884         *
885         * @deprecated Just provided for backward compatiblity, use Script for new
886         *             instruments instead.
887         */
888      class MidiRule {      class MidiRule {
889          public:          public:
890              virtual ~MidiRule() { }              virtual ~MidiRule() { }
# Line 742  namespace gig { Line 893  namespace gig {
893              friend class Instrument;              friend class Instrument;
894      };      };
895    
896      /** MIDI rule for triggering notes by control change events. */      /** @brief MIDI rule for triggering notes by control change events.
897         *
898         * A "Control Trigger MIDI rule" allows to trigger new notes by sending MIDI
899         * control change events to the sampler.
900         *
901         * Note: "Control Trigger" MIDI rules are only supported by gigedit, but not
902         * by LinuxSampler. We recommend you using real-time instrument scripts
903         * instead. Read more about the details and reasons for this in the
904         * description of the MidiRule base class.
905         *
906         * @deprecated Just provided for backward compatiblity, use Script for new
907         *             instruments instead. See description of MidiRule for details.
908         */
909      class MidiRuleCtrlTrigger : public MidiRule {      class MidiRuleCtrlTrigger : public MidiRule {
910          public:          public:
911              uint8_t ControllerNumber;   ///< MIDI controller number.              uint8_t ControllerNumber;   ///< MIDI controller number.
# Line 764  namespace gig { Line 927  namespace gig {
927              friend class Instrument;              friend class Instrument;
928      };      };
929    
930      /** MIDI rule for instruments with legato samples. */      /** @brief MIDI rule for instruments with legato samples.
931         *
932         * A "Legato MIDI rule" allows playing instruments resembling the legato
933         * playing technique. In the past such legato articulations were tried to be
934         * simulated by pitching the samples of the instrument. However since
935         * usually a high amount of pitch is needed for legatos, this always sounded
936         * very artificial and unrealistic. The "Legato MIDI rule" thus uses another
937         * approach. Instead of pitching the samples, it allows the sound designer
938         * to bundle separate, additional samples for the individual legato
939         * situations and the legato rules defined which samples to be played in
940         * which situation.
941         *
942         * Note: "Legato MIDI rules" are only supported by gigedit, but not
943         * by LinuxSampler. We recommend you using real-time instrument scripts
944         * instead. Read more about the details and reasons for this in the
945         * description of the MidiRule base class.
946         *
947         * @deprecated Just provided for backward compatiblity, use Script for new
948         *             instruments instead. See description of MidiRule for details.
949         */
950      class MidiRuleLegato : public MidiRule {      class MidiRuleLegato : public MidiRule {
951          public:          public:
952              uint8_t LegatoSamples;     ///< Number of legato samples per key in each direction (always 12)              uint8_t LegatoSamples;     ///< Number of legato samples per key in each direction (always 12)
# Line 785  namespace gig { Line 967  namespace gig {
967              friend class Instrument;              friend class Instrument;
968      };      };
969    
970      /** MIDI rule to automatically cycle through specified sequences of different articulations. The instrument must be using the smartmidi dimension. */      /** @brief MIDI rule to automatically cycle through specified sequences of different articulations.
971         *
972         * The instrument must be using the smartmidi dimension.
973         *
974         * Note: "Alternator" MIDI rules are neither supported by gigedit nor by
975         * LinuxSampler. We recommend you using real-time instrument scripts
976         * instead. Read more about the details and reasons for this in the
977         * description of the MidiRule base class.
978         *
979         * @deprecated Just provided for backward compatiblity, use Script for new
980         *             instruments instead. See description of MidiRule for details.
981         */
982      class MidiRuleAlternator : public MidiRule {      class MidiRuleAlternator : public MidiRule {
983          public:          public:
984              uint8_t Articulations;     ///< Number of articulations in the instrument              uint8_t Articulations;     ///< Number of articulations in the instrument
# Line 826  namespace gig { Line 1019  namespace gig {
1019              friend class Instrument;              friend class Instrument;
1020      };      };
1021    
1022      /** A MIDI rule not yet implemented by libgig. */      /** @brief A MIDI rule not yet implemented by libgig.
1023         *
1024         * This class is currently used as a place holder by libgig for MIDI rule
1025         * types which are not supported by libgig yet.
1026         *
1027         * Note: Support for missing MIDI rule types are probably never added to
1028         * libgig. We recommend you using real-time instrument scripts instead.
1029         * Read more about the details and reasons for this in the description of
1030         * the MidiRule base class.
1031         *
1032         * @deprecated Just provided for backward compatiblity, use Script for new
1033         *             instruments instead. See description of MidiRule for details.
1034         */
1035      class MidiRuleUnknown : public MidiRule {      class MidiRuleUnknown : public MidiRule {
1036          protected:          protected:
1037              MidiRuleUnknown() { }              MidiRuleUnknown() { }
# Line 834  namespace gig { Line 1039  namespace gig {
1039              friend class Instrument;              friend class Instrument;
1040      };      };
1041    
1042      /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */      /** @brief Real-time instrument script (gig format extension).
1043         *
1044         * Real-time instrument scripts are user supplied small programs which can
1045         * be used by instrument designers to create custom behaviors and features
1046         * not available in the stock sampler engine. Features which might be very
1047         * exotic or specific for the respective instrument.
1048         *
1049         * This is an extension of the GigaStudio format, thus a feature which was
1050         * not available in the GigaStudio 4 software. It is currently only
1051         * supported by LinuxSampler and gigedit. Scripts will not load with the
1052         * original GigaStudio software.
1053         *
1054         * You find more informations about Instrument Scripts on the LinuxSampler
1055         * documentation site:
1056         *
1057         * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/">About Instrument Scripts in General</a>
1058         * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language">Introduction to the NKSP Script Language</a>
1059         * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language/Reference/">NKSP Reference Manual</a>
1060         * - <a href="http://doc.linuxsampler.org/Gigedit/Managing_Scripts">Using Instrument Scripts with Gigedit</a>
1061         */
1062        class Script {
1063            public:
1064                enum Encoding_t {
1065                    ENCODING_ASCII = 0 ///< Standard 8 bit US ASCII character encoding (default).
1066                };
1067                enum Compression_t {
1068                    COMPRESSION_NONE = 0 ///< Is not compressed at all (default).
1069                };
1070                enum Language_t {
1071                    LANGUAGE_NKSP = 0 ///< NKSP stands for "Is Not KSP" (default). Refer to the <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language/Reference/">NKSP Reference Manual</a> for details about this script language.
1072                };
1073    
1074                String         Name;        ///< Arbitrary name of the script, which may be displayed i.e. in an instrument editor.
1075                Compression_t  Compression; ///< Whether the script was/should be compressed, and if so, which compression algorithm shall be used.
1076                Encoding_t     Encoding;    ///< Format the script's source code text is encoded with.
1077                Language_t     Language;    ///< Programming language and dialect the script is written in.
1078                bool           Bypass;      ///< Global bypass: if enabled, this script shall not be executed by the sampler for any instrument.
1079    
1080                String GetScriptAsText();
1081                void   SetScriptAsText(const String& text);
1082                void   SetGroup(ScriptGroup* pGroup);
1083                ScriptGroup* GetGroup() const;
1084                void   CopyAssign(const Script* orig);
1085            protected:
1086                Script(ScriptGroup* group, RIFF::Chunk* ckScri);
1087                virtual ~Script();
1088                void UpdateChunks(progress_t* pProgress);
1089                void RemoveAllScriptReferences();
1090                friend class ScriptGroup;
1091                friend class Instrument;
1092            private:
1093                ScriptGroup*          pGroup;
1094                RIFF::Chunk*          pChunk; ///< 'Scri' chunk
1095                std::vector<uint8_t>  data;
1096                uint32_t              crc; ///< CRC-32 checksum of the raw script data
1097        };
1098    
1099        /** @brief Group of instrument scripts (gig format extension).
1100         *
1101         * This class is simply used to sort a bunch of real-time instrument scripts
1102         * into individual groups. This allows instrument designers and script
1103         * developers to keep scripts in a certain order while working with a larger
1104         * amount of scripts in an instrument editor.
1105         *
1106         * This is an extension of the GigaStudio format, thus a feature which was
1107         * not available in the GigaStudio 4 software. It is currently only
1108         * supported by LinuxSampler and gigedit.
1109         */
1110        class ScriptGroup {
1111            public:
1112                String   Name; ///< Name of this script group. For example to be displayed in an instrument editor.
1113    
1114                Script*  GetScript(uint index);
1115                Script*  AddScript();
1116                void     DeleteScript(Script* pScript);
1117            protected:
1118                ScriptGroup(File* file, RIFF::List* lstRTIS);
1119                virtual ~ScriptGroup();
1120                void LoadScripts();
1121                void UpdateChunks(progress_t* pProgress);
1122                friend class Script;
1123                friend class File;
1124            private:
1125                File*                pFile;
1126                RIFF::List*          pList; ///< 'RTIS' list chunk
1127                std::list<Script*>*  pScripts;
1128        };
1129    
1130        /** @brief Provides access to a Gigasampler/GigaStudio instrument.
1131         *
1132         * This class provides access to Gigasampler/GigaStudio instruments
1133         * contained in .gig files. A gig instrument is merely a set of keyboard
1134         * ranges (called Region), plus some additional global informations about
1135         * the instrument. The major part of the actual instrument definition used
1136         * for the synthesis of the instrument is contained in the respective Region
1137         * object (or actually in the respective DimensionRegion object being, see
1138         * description of Region for details).
1139         *
1140         * Since the gig format was designed as extension to the DLS file format,
1141         * this class is derived from the DLS::Instrument class. So also refer to
1142         * DLS::Instrument for additional informations, class attributes and
1143         * methods.
1144         */
1145      class Instrument : protected DLS::Instrument {      class Instrument : protected DLS::Instrument {
1146          public:          public:
1147              // derived attributes from DLS::Resource              // derived attributes from DLS::Resource
# Line 863  namespace gig { Line 1170  namespace gig {
1170              Region*   GetNextRegion();              Region*   GetNextRegion();
1171              Region*   AddRegion();              Region*   AddRegion();
1172              void      DeleteRegion(Region* pRegion);              void      DeleteRegion(Region* pRegion);
1173              virtual void UpdateChunks();              void      MoveTo(Instrument* dst);
1174                virtual void UpdateChunks(progress_t* pProgress);
1175              virtual void CopyAssign(const Instrument* orig);              virtual void CopyAssign(const Instrument* orig);
1176              // own methods              // own methods
1177              Region*   GetRegion(unsigned int Key);              Region*   GetRegion(unsigned int Key);
# Line 872  namespace gig { Line 1180  namespace gig {
1180              MidiRuleLegato*      AddMidiRuleLegato();              MidiRuleLegato*      AddMidiRuleLegato();
1181              MidiRuleAlternator*  AddMidiRuleAlternator();              MidiRuleAlternator*  AddMidiRuleAlternator();
1182              void      DeleteMidiRule(int i);              void      DeleteMidiRule(int i);
1183                // real-time instrument script methods
1184                Script*   GetScriptOfSlot(uint index);
1185                void      AddScriptSlot(Script* pScript, bool bypass = false);
1186                void      SwapScriptSlots(uint index1, uint index2);
1187                void      RemoveScriptSlot(uint index);
1188                void      RemoveScript(Script* pScript);
1189                uint      ScriptSlotCount() const;
1190                bool      IsScriptSlotBypassed(uint index);
1191                void      SetScriptSlotBypassed(uint index, bool bBypass);
1192          protected:          protected:
1193              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
1194    
# Line 879  namespace gig { Line 1196  namespace gig {
1196             ~Instrument();             ~Instrument();
1197              void CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples);              void CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples);
1198              void UpdateRegionKeyTable();              void UpdateRegionKeyTable();
1199                void LoadScripts();
1200                void UpdateScriptFileOffsets();
1201              friend class File;              friend class File;
1202              friend class Region; // so Region can call UpdateRegionKeyTable()              friend class Region; // so Region can call UpdateRegionKeyTable()
1203          private:          private:
1204                struct _ScriptPooolEntry {
1205                    uint32_t fileOffset;
1206                    bool     bypass;
1207                };
1208                struct _ScriptPooolRef {
1209                    Script*  script;
1210                    bool     bypass;
1211                };
1212              MidiRule** pMidiRules;              MidiRule** pMidiRules;
1213                std::vector<_ScriptPooolEntry> scriptPoolFileOffsets;
1214                std::vector<_ScriptPooolRef>* pScriptRefs;
1215      };      };
1216    
1217      /** @brief Group of Gigasampler objects      /** @brief Group of Gigasampler samples
1218       *       *
1219       * Groups help to organize a huge collection of Gigasampler objects.       * Groups help to organize a huge collection of Gigasampler samples.
1220       * Groups are not concerned at all for the synthesis, but they help       * Groups are not concerned at all for the synthesis, but they help
1221       * sound library developers when working on complex instruments with an       * sound library developers when working on complex instruments with an
1222       * instrument editor (as long as that instrument editor supports it ;-).       * instrument editor (as long as that instrument editor supports it ;-).
1223       *       *
      * At the moment, it seems as only samples can be grouped together in  
      * the Gigasampler format yet. If this is false in the meantime, please  
      * tell us !  
      *  
1224       * A sample is always assigned to exactly one Group. This also means       * A sample is always assigned to exactly one Group. This also means
1225       * there is always at least one Group in a .gig file, no matter if you       * there is always at least one Group in a .gig file, no matter if you
1226       * created one yet or not.       * created one yet or not.
# Line 910  namespace gig { Line 1235  namespace gig {
1235          protected:          protected:
1236              Group(File* file, RIFF::Chunk* ck3gnm);              Group(File* file, RIFF::Chunk* ck3gnm);
1237              virtual ~Group();              virtual ~Group();
1238              virtual void UpdateChunks();              virtual void UpdateChunks(progress_t* pProgress);
1239              void MoveAll();              void MoveAll();
1240              friend class File;              friend class File;
1241          private:          private:
# Line 918  namespace gig { Line 1243  namespace gig {
1243              RIFF::Chunk* pNameChunk; ///< '3gnm' chunk              RIFF::Chunk* pNameChunk; ///< '3gnm' chunk
1244      };      };
1245    
1246      /** Parses Gigasampler files and provides abstract access to the data. */      /** @brief Provides convenient access to Gigasampler/GigaStudio .gig files.
1247         *
1248         * This is the entry class for accesing a Gigasampler/GigaStudio (.gig) file
1249         * with libgig. It allows you to open existing .gig files, modifying them
1250         * and saving them persistently either under the same file name or under a
1251         * different location.
1252         *
1253         * A .gig file is merely a monolithic file. That means samples and the
1254         * defintion of the virtual instruments are contained in the same file. A
1255         * .gig file contains an arbitrary amount of samples, and an arbitrary
1256         * amount of instruments which are referencing those samples. It is also
1257         * possible to store samples in .gig files not being referenced by any
1258         * instrument. This is not an error from the file format's point of view and
1259         * it is actually often used in practice during the design phase of new gig
1260         * instruments.
1261         *
1262         * So on toplevel of the gig file format you have:
1263         *
1264         * - A set of samples (see Sample).
1265         * - A set of virtual instruments (see Instrument).
1266         *
1267         * And as extension to the original GigaStudio format, we added:
1268         *
1269         * - Real-time instrument scripts (see Script).
1270         *
1271         * Note that the latter however is only supported by libgig, gigedit and
1272         * LinuxSampler. Scripts are not supported by the original GigaStudio
1273         * software.
1274         *
1275         * All released Gigasampler/GigaStudio file format versions are supported
1276         * (so from first Gigasampler version up to including GigaStudio 4).
1277         *
1278         * Since the gig format was designed as extension to the DLS file format,
1279         * this class is derived from the DLS::File class. So also refer to
1280         * DLS::File for additional informations, class attributes and methods.
1281         */
1282      class File : protected DLS::File {      class File : protected DLS::File {
1283          public:          public:
1284              static const DLS::version_t VERSION_2;              static const DLS::version_t VERSION_2;
# Line 961  namespace gig { Line 1321  namespace gig {
1321              void        SetAutoLoad(bool b);              void        SetAutoLoad(bool b);
1322              bool        GetAutoLoad();              bool        GetAutoLoad();
1323              void        AddContentOf(File* pFile);              void        AddContentOf(File* pFile);
1324                ScriptGroup* GetScriptGroup(uint index);
1325                ScriptGroup* GetScriptGroup(const String& name);
1326                ScriptGroup* AddScriptGroup();
1327                void        DeleteScriptGroup(ScriptGroup* pGroup);
1328              virtual    ~File();              virtual    ~File();
1329              virtual void UpdateChunks();              virtual void UpdateChunks(progress_t* pProgress);
1330          protected:          protected:
1331              // overridden protected methods from DLS::File              // overridden protected methods from DLS::File
1332              virtual void LoadSamples();              virtual void LoadSamples();
1333              virtual void LoadInstruments();              virtual void LoadInstruments();
1334              virtual void LoadGroups();              virtual void LoadGroups();
1335                virtual void UpdateFileOffsets();
1336              // own protected methods              // own protected methods
1337              virtual void LoadSamples(progress_t* pProgress);              virtual void LoadSamples(progress_t* pProgress);
1338              virtual void LoadInstruments(progress_t* pProgress);              virtual void LoadInstruments(progress_t* pProgress);
1339                virtual void LoadScriptGroups();
1340              void SetSampleChecksum(Sample* pSample, uint32_t crc);              void SetSampleChecksum(Sample* pSample, uint32_t crc);
1341                uint32_t GetSampleChecksum(Sample* pSample);
1342                uint32_t GetSampleChecksumByIndex(int index);
1343                bool VerifySampleChecksumTable();
1344                bool RebuildSampleChecksumTable();
1345                int  GetWaveTableIndexOf(gig::Sample* pSample);
1346              friend class Region;              friend class Region;
1347              friend class Sample;              friend class Sample;
1348                friend class Instrument;
1349              friend class Group; // so Group can access protected member pRIFF              friend class Group; // so Group can access protected member pRIFF
1350                friend class ScriptGroup; // so ScriptGroup can access protected member pRIFF
1351          private:          private:
1352              std::list<Group*>*          pGroups;              std::list<Group*>*          pGroups;
1353              std::list<Group*>::iterator GroupsIterator;              std::list<Group*>::iterator GroupsIterator;
1354              bool                        bAutoLoad;              bool                        bAutoLoad;
1355                std::list<ScriptGroup*>*    pScriptGroups;
1356      };      };
1357    
1358      /**      /**
# Line 995  namespace gig { Line 1369  namespace gig {
1369              void PrintMessage();              void PrintMessage();
1370      };      };
1371    
1372    #if HAVE_RTTI
1373        size_t enumCount(const std::type_info& type);
1374        const char* enumKey(const std::type_info& type, size_t value);
1375        bool        enumKey(const std::type_info& type, String key);
1376        const char** enumKeys(const std::type_info& type);
1377    #endif // HAVE_RTTI
1378        size_t enumCount(String typeName);
1379        const char* enumKey(String typeName, size_t value);
1380        bool        enumKey(String typeName, String key);
1381        const char** enumKeys(String typeName);
1382        size_t enumValue(String key);
1383    
1384      String libraryName();      String libraryName();
1385      String libraryVersion();      String libraryVersion();
1386    

Legend:
Removed from v.2555  
changed lines
  Added in v.3181

  ViewVC Help
Powered by ViewVC