/[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 2700 by schoenebeck, Mon Jan 12 23:22:29 2015 UTC revision 3952 by schoenebeck, Sat Jun 19 09:10:33 2021 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-2015 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2021 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 26  Line 26 
26    
27  #include "DLS.h"  #include "DLS.h"
28  #include <vector>  #include <vector>
29    #include <array> // since C++11
30    
31    #ifndef __has_feature
32    # define __has_feature(x) 0
33    #endif
34    #ifndef HAVE_RTTI
35    # if __GXX_RTTI || __has_feature(cxx_rtti) || _CPPRTTI
36    #  define HAVE_RTTI 1
37    # else
38    #  define HAVE_RTTI 0
39    # endif
40    #endif
41    #if HAVE_RTTI
42    # include <typeinfo>
43    #else
44    # warning No RTTI available!
45    #endif
46    
47  #if WORDS_BIGENDIAN  #if WORDS_BIGENDIAN
48  # define LIST_TYPE_3PRG 0x33707267  # define LIST_TYPE_3PRG 0x33707267
# Line 34  Line 51 
51  # define LIST_TYPE_3GNL 0x33676E6C  # define LIST_TYPE_3GNL 0x33676E6C
52  # define LIST_TYPE_3LS  0x334c5320 // own gig format extension  # define LIST_TYPE_3LS  0x334c5320 // own gig format extension
53  # define LIST_TYPE_RTIS 0x52544953 // own gig format extension  # define LIST_TYPE_RTIS 0x52544953 // own gig format extension
54    # define LIST_TYPE_3DNM 0x33646e6d
55  # define CHUNK_ID_3GIX  0x33676978  # define CHUNK_ID_3GIX  0x33676978
56  # define CHUNK_ID_3EWA  0x33657761  # define CHUNK_ID_3EWA  0x33657761
57  # define CHUNK_ID_3LNK  0x336C6E6B  # define CHUNK_ID_3LNK  0x336C6E6B
# Line 45  Line 63 
63  # define CHUNK_ID_SCRI  0x53637269 // own gig format extension  # define CHUNK_ID_SCRI  0x53637269 // own gig format extension
64  # define CHUNK_ID_LSNM  0x4c534e4d // own gig format extension  # define CHUNK_ID_LSNM  0x4c534e4d // own gig format extension
65  # define CHUNK_ID_SCSL  0x5343534c // own gig format extension  # define CHUNK_ID_SCSL  0x5343534c // own gig format extension
66    # define CHUNK_ID_SCPV  0x53435056 // own gig format extension
67    # define CHUNK_ID_LSDE  0x4c534445 // own gig format extension
68    # define CHUNK_ID_3DDP  0x33646470
69  #else  // little endian  #else  // little endian
70  # define LIST_TYPE_3PRG 0x67727033  # define LIST_TYPE_3PRG 0x67727033
71  # define LIST_TYPE_3EWL 0x6C776533  # define LIST_TYPE_3EWL 0x6C776533
# Line 52  Line 73 
73  # define LIST_TYPE_3GNL 0x6C6E6733  # define LIST_TYPE_3GNL 0x6C6E6733
74  # define LIST_TYPE_3LS  0x20534c33 // own gig format extension  # define LIST_TYPE_3LS  0x20534c33 // own gig format extension
75  # define LIST_TYPE_RTIS 0x53495452 // own gig format extension  # define LIST_TYPE_RTIS 0x53495452 // own gig format extension
76    # define LIST_TYPE_3DNM 0x6d6e6433
77  # define CHUNK_ID_3GIX  0x78696733  # define CHUNK_ID_3GIX  0x78696733
78  # define CHUNK_ID_3EWA  0x61776533  # define CHUNK_ID_3EWA  0x61776533
79  # define CHUNK_ID_3LNK  0x6B6E6C33  # define CHUNK_ID_3LNK  0x6B6E6C33
# Line 63  Line 85 
85  # define CHUNK_ID_SCRI  0x69726353 // own gig format extension  # define CHUNK_ID_SCRI  0x69726353 // own gig format extension
86  # define CHUNK_ID_LSNM  0x4d4e534c // own gig format extension  # define CHUNK_ID_LSNM  0x4d4e534c // own gig format extension
87  # define CHUNK_ID_SCSL  0x4c534353 // own gig format extension  # define CHUNK_ID_SCSL  0x4c534353 // own gig format extension
88    # define CHUNK_ID_SCPV  0x56504353 // own gig format extension
89    # define CHUNK_ID_LSDE  0x4544534c // own gig format extension
90    # define CHUNK_ID_3DDP  0x70646433
91  #endif // WORDS_BIGENDIAN  #endif // WORDS_BIGENDIAN
92    
93    #ifndef GIG_DECLARE_ENUM
94    # define GIG_DECLARE_ENUM(type, ...) enum type { __VA_ARGS__ }
95    #endif
96    
97    // just symbol prototyping (since Serialization.h not included by default here)
98    namespace Serialization { class Archive; }
99    
100  /** Gigasampler/GigaStudio specific classes and definitions */  /** Gigasampler/GigaStudio specific classes and definitions */
101  namespace gig {  namespace gig {
102    
103      typedef std::string String;      typedef std::string String;
104      typedef RIFF::progress_t progress_t;      typedef RIFF::progress_t progress_t;
105        typedef RIFF::file_offset_t file_offset_t;
106    
107      /** Lower and upper limit of a range. */      /** Lower and upper limit of a range. */
108      struct range_t {      struct range_t {
# Line 80  namespace gig { Line 113  namespace gig {
113      /** Pointer address and size of a buffer. */      /** Pointer address and size of a buffer. */
114      struct buffer_t {      struct buffer_t {
115          void*         pStart;            ///< Points to the beginning of the buffer.          void*         pStart;            ///< Points to the beginning of the buffer.
116          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.
117          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. :)
118          buffer_t() {          buffer_t() {
119              pStart            = NULL;              pStart            = NULL;
120              Size              = 0;              Size              = 0;
# Line 89  namespace gig { Line 122  namespace gig {
122          }          }
123      };      };
124    
125      /** Standard types of sample loops. */      /** Standard types of sample loops.
126      typedef enum {       *
127          loop_type_normal        = 0x00000000,  ///< Loop forward (normal)       * @see enumCount(), enumKey(), enumKeys(), enumValue()
128          loop_type_bidirectional = 0x00000001,  ///< Alternating loop (forward/backward, also known as Ping Pong)       */
129          loop_type_backward      = 0x00000002   ///< Loop backward (reverse)      GIG_DECLARE_ENUM(loop_type_t,
130      } loop_type_t;          loop_type_normal        = 0x00000000,  /**< Loop forward (normal) */
131            loop_type_bidirectional = 0x00000001,  /**< Alternating loop (forward/backward, also known as Ping Pong) */
132      /** Society of Motion Pictures and Television E time format. */          loop_type_backward      = 0x00000002   /**< Loop backward (reverse) */
133      typedef enum {      );
134          smpte_format_no_offset          = 0x00000000,  ///< no SMPTE offset  
135          smpte_format_24_frames          = 0x00000018,  ///< 24 frames per second      /** Society of Motion Pictures and Television E time format.
136          smpte_format_25_frames          = 0x00000019,  ///< 25 frames per second       *
137          smpte_format_30_frames_dropping = 0x0000001D,  ///< 30 frames per second with frame dropping (30 drop)       * @see enumCount(), enumKey(), enumKeys(), enumValue()
138          smpte_format_30_frames          = 0x0000001E   ///< 30 frames per second       */
139      } smpte_format_t;      GIG_DECLARE_ENUM(smpte_format_t,
140            smpte_format_no_offset          = 0x00000000,  /**< no SMPTE offset */
141      /** Defines the shape of a function graph. */          smpte_format_24_frames          = 0x00000018,  /**< 24 frames per second */
142      typedef enum {          smpte_format_25_frames          = 0x00000019,  /**< 25 frames per second */
143          curve_type_nonlinear = 0,          smpte_format_30_frames_dropping = 0x0000001D,  /**< 30 frames per second with frame dropping (30 drop) */
144          curve_type_linear    = 1,          smpte_format_30_frames          = 0x0000001E   /**< 30 frames per second */
145          curve_type_special   = 2,      );
146          curve_type_unknown   = 0xffffffff  
147      } curve_type_t;      /** Defines the shape of a function graph.
148         *
149      /** Dimensions allow to bypass one of the following controllers. */       * @see enumCount(), enumKey(), enumKeys(), enumValue()
150      typedef enum {       */
151          dim_bypass_ctrl_none,      GIG_DECLARE_ENUM(curve_type_t,
152          dim_bypass_ctrl_94,   ///< Effect 4 Depth (MIDI Controller 94)          curve_type_nonlinear = 0,          /**< Non-linear curve type. */
153          dim_bypass_ctrl_95    ///< Effect 5 Depth (MIDI Controller 95)          curve_type_linear    = 1,          /**< Linear curve type. */
154      } dim_bypass_ctrl_t;          curve_type_special   = 2,          /**< Special curve type. */
155            curve_type_unknown   = 0xffffffff  /**< Unknown curve type. */
156      /** Defines how LFO3 is controlled by. */      );
157      typedef enum {  
158          lfo3_ctrl_internal            = 0x00, ///< Only internally controlled.      /** Defines the wave form type used by an LFO (gig format extension).
159          lfo3_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.       *
160          lfo3_ctrl_aftertouch          = 0x02, ///< Only controlled by aftertouch controller.       * This is a gig format extension. The original Gigasampler/GigaStudio
161          lfo3_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.       * software always used a sine (sinus) wave form for all its 3 LFOs, so this
162          lfo3_ctrl_internal_aftertouch = 0x04  ///< Controlled internally and by aftertouch controller.       * was not configurable in the original gig format. Accordingly setting any
163      } lfo3_ctrl_t;       * other wave form than sine (sinus) will be ignored by the original
164         * Gigasampler/GigaStudio software.
165      /** Defines how LFO2 is controlled by. */       *
166      typedef enum {       * @see enumCount(), enumKey(), enumKeys(), enumValue()
167          lfo2_ctrl_internal            = 0x00, ///< Only internally controlled.       */
168          lfo2_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.      GIG_DECLARE_ENUM(lfo_wave_t,
169          lfo2_ctrl_foot                = 0x02, ///< Only controlled by external foot controller.          lfo_wave_sine     = 0,  /**< Sine (sinus) wave form (this is the default wave form). */
170          lfo2_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.          lfo_wave_triangle = 1,  /**< Triangle wave form. */
171          lfo2_ctrl_internal_foot       = 0x04  ///< Controlled internally and by external foot controller.          lfo_wave_saw      = 2,  /**< Saw (up) wave form (saw down wave form can be achieved by flipping the phase). */
172      } lfo2_ctrl_t;          lfo_wave_square   = 3,  /**< Square wave form. */
173        );
174      /** Defines how LFO1 is controlled by. */  
175      typedef enum {      /** Dimensions allow to bypass one of the following controllers.
176          lfo1_ctrl_internal            = 0x00, ///< Only internally controlled.       *
177          lfo1_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.       * @see enumCount(), enumKey(), enumKeys(), enumValue()
178          lfo1_ctrl_breath              = 0x02, ///< Only controlled by external breath controller.       */
179          lfo1_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.      GIG_DECLARE_ENUM(dim_bypass_ctrl_t,
180          lfo1_ctrl_internal_breath     = 0x04  ///< Controlled internally and by external breath controller.          dim_bypass_ctrl_none, /**< No controller bypass. */
181      } lfo1_ctrl_t;          dim_bypass_ctrl_94,   /**< Effect 4 Depth (MIDI Controller 94) */
182            dim_bypass_ctrl_95    /**< Effect 5 Depth (MIDI Controller 95) */
183      /** Defines how the filter cutoff frequency is controlled by. */      );
184      typedef enum {  
185          vcf_cutoff_ctrl_none         = 0x00,      /** Defines how LFO3 is controlled by.
186          vcf_cutoff_ctrl_none2        = 0x01,  ///< The difference between none and none2 is unknown       *
187          vcf_cutoff_ctrl_modwheel     = 0x81,  ///< Modulation Wheel (MIDI Controller 1)       * @see enumCount(), enumKey(), enumKeys(), enumValue()
188          vcf_cutoff_ctrl_effect1      = 0x8c,  ///< Effect Controller 1 (Coarse, MIDI Controller 12)       */
189          vcf_cutoff_ctrl_effect2      = 0x8d,  ///< Effect Controller 2 (Coarse, MIDI Controller 13)      GIG_DECLARE_ENUM(lfo3_ctrl_t,
190          vcf_cutoff_ctrl_breath       = 0x82,  ///< Breath Controller (Coarse, MIDI Controller 2)          lfo3_ctrl_internal            = 0x00, /**< Only internally controlled. */
191          vcf_cutoff_ctrl_foot         = 0x84,  ///< Foot Pedal (Coarse, MIDI Controller 4)          lfo3_ctrl_modwheel            = 0x01, /**< Only controlled by external modulation wheel. */
192          vcf_cutoff_ctrl_sustainpedal = 0xc0,  ///< Sustain Pedal (MIDI Controller 64)          lfo3_ctrl_aftertouch          = 0x02, /**< Only controlled by aftertouch controller. */
193          vcf_cutoff_ctrl_softpedal    = 0xc3,  ///< Soft Pedal (MIDI Controller 67)          lfo3_ctrl_internal_modwheel   = 0x03, /**< Controlled internally and by external modulation wheel. */
194          vcf_cutoff_ctrl_genpurpose7  = 0xd2,  ///< General Purpose Controller 7 (Button, MIDI Controller 82)          lfo3_ctrl_internal_aftertouch = 0x04  /**< Controlled internally and by aftertouch controller. */
195          vcf_cutoff_ctrl_genpurpose8  = 0xd3,  ///< General Purpose Controller 8 (Button, MIDI Controller 83)      );
196          vcf_cutoff_ctrl_aftertouch   = 0x80   ///< Key Pressure  
197      } vcf_cutoff_ctrl_t;      /** Defines how LFO2 is controlled by.
198         *
199      /** Defines how the filter resonance is controlled by. */       * @see enumCount(), enumKey(), enumKeys(), enumValue()
200      typedef enum {       */
201          vcf_res_ctrl_none        = 0xffffffff,      GIG_DECLARE_ENUM(lfo2_ctrl_t,
202          vcf_res_ctrl_genpurpose3 = 0,           ///< General Purpose Controller 3 (Slider, MIDI Controller 18)          lfo2_ctrl_internal            = 0x00, /**< Only internally controlled. */
203          vcf_res_ctrl_genpurpose4 = 1,           ///< General Purpose Controller 4 (Slider, MIDI Controller 19)          lfo2_ctrl_modwheel            = 0x01, /**< Only controlled by external modulation wheel. */
204          vcf_res_ctrl_genpurpose5 = 2,           ///< General Purpose Controller 5 (Button, MIDI Controller 80)          lfo2_ctrl_foot                = 0x02, /**< Only controlled by external foot controller. */
205          vcf_res_ctrl_genpurpose6 = 3            ///< General Purpose Controller 6 (Button, MIDI Controller 81)          lfo2_ctrl_internal_modwheel   = 0x03, /**< Controlled internally and by external modulation wheel. */
206      } vcf_res_ctrl_t;          lfo2_ctrl_internal_foot       = 0x04  /**< Controlled internally and by external foot controller. */
207        );
208    
209        /** Defines how LFO1 is controlled by.
210         *
211         * @see enumCount(), enumKey(), enumKeys(), enumValue()
212         */
213        GIG_DECLARE_ENUM(lfo1_ctrl_t,
214            lfo1_ctrl_internal            = 0x00, /**< Only internally controlled. */
215            lfo1_ctrl_modwheel            = 0x01, /**< Only controlled by external modulation wheel. */
216            lfo1_ctrl_breath              = 0x02, /**< Only controlled by external breath controller. */
217            lfo1_ctrl_internal_modwheel   = 0x03, /**< Controlled internally and by external modulation wheel. */
218            lfo1_ctrl_internal_breath     = 0x04  /**< Controlled internally and by external breath controller. */
219        );
220    
221        /** Defines how the filter cutoff frequency is controlled by.
222         *
223         * @see enumCount(), enumKey(), enumKeys(), enumValue()
224         */
225        GIG_DECLARE_ENUM(vcf_cutoff_ctrl_t,
226            vcf_cutoff_ctrl_none         = 0x00,  /**< No MIDI controller assigned for filter cutoff frequency. */
227            vcf_cutoff_ctrl_none2        = 0x01,  /**< The difference between none and none2 is unknown */
228            vcf_cutoff_ctrl_modwheel     = 0x81,  /**< Modulation Wheel (MIDI Controller 1) */
229            vcf_cutoff_ctrl_effect1      = 0x8c,  /**< Effect Controller 1 (Coarse, MIDI Controller 12) */
230            vcf_cutoff_ctrl_effect2      = 0x8d,  /**< Effect Controller 2 (Coarse, MIDI Controller 13) */
231            vcf_cutoff_ctrl_breath       = 0x82,  /**< Breath Controller (Coarse, MIDI Controller 2) */
232            vcf_cutoff_ctrl_foot         = 0x84,  /**< Foot Pedal (Coarse, MIDI Controller 4) */
233            vcf_cutoff_ctrl_sustainpedal = 0xc0,  /**< Sustain Pedal (MIDI Controller 64) */
234            vcf_cutoff_ctrl_softpedal    = 0xc3,  /**< Soft Pedal (MIDI Controller 67) */
235            vcf_cutoff_ctrl_genpurpose7  = 0xd2,  /**< General Purpose Controller 7 (Button, MIDI Controller 82) */
236            vcf_cutoff_ctrl_genpurpose8  = 0xd3,  /**< General Purpose Controller 8 (Button, MIDI Controller 83) */
237            vcf_cutoff_ctrl_aftertouch   = 0x80   /**< Key Pressure */
238        );
239    
240        /** Defines how the filter resonance is controlled by.
241         *
242         * @see enumCount(), enumKey(), enumKeys(), enumValue()
243         */
244        GIG_DECLARE_ENUM(vcf_res_ctrl_t,
245            vcf_res_ctrl_none        = 0xffffffff,  /**< No MIDI controller assigned for filter resonance. */
246            vcf_res_ctrl_genpurpose3 = 0,           /**< General Purpose Controller 3 (Slider, MIDI Controller 18) */
247            vcf_res_ctrl_genpurpose4 = 1,           /**< General Purpose Controller 4 (Slider, MIDI Controller 19) */
248            vcf_res_ctrl_genpurpose5 = 2,           /**< General Purpose Controller 5 (Button, MIDI Controller 80) */
249            vcf_res_ctrl_genpurpose6 = 3            /**< General Purpose Controller 6 (Button, MIDI Controller 81) */
250        );
251    
252      /**      /**
253       * Defines a controller that has a certain contrained influence on a       * Defines a controller that has a certain contrained influence on a
# Line 181  namespace gig { Line 258  namespace gig {
258       * 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!
259       */       */
260      struct leverage_ctrl_t {      struct leverage_ctrl_t {
261          typedef enum {          /** Defines possible controllers.
262              type_none              = 0x00, ///< No controller defined           *
263              type_channelaftertouch = 0x2f, ///< Channel Key Pressure           * @see enumCount(), enumKey(), enumKeys(), enumValue()
264              type_velocity          = 0xff, ///< Key Velocity           */
265              type_controlchange     = 0xfe  ///< Ordinary MIDI control change controller, see field 'controller_number'          GIG_DECLARE_ENUM(type_t,
266          } type_t;              type_none              = 0x00, /**< No controller defined */
267                type_channelaftertouch = 0x2f, /**< Channel Key Pressure */
268                type_velocity          = 0xff, /**< Key Velocity */
269                type_controlchange     = 0xfe  /**< Ordinary MIDI control change controller, see field 'controller_number' */
270            );
271    
272          type_t type;              ///< Controller type          type_t type;              ///< Controller type
273          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
274    
275            void serialize(Serialization::Archive* archive);
276      };      };
277    
278      /**      /**
# Line 219  namespace gig { Line 302  namespace gig {
302       * 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
303       * 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
304       * the samplechannel dimension which currently allows only 2 zones).       * the samplechannel dimension which currently allows only 2 zones).
305         *
306         * @see enumCount(), enumKey(), enumKeys(), enumValue()
307       */       */
308      typedef enum {      GIG_DECLARE_ENUM(dimension_t,
309          dimension_none              = 0x00, ///< Dimension not in use.          dimension_none              = 0x00, /**< Dimension not in use. */
310          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). */
311          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). */
312          dimension_velocity          = 0x82, ///< Key Velocity (this is the only dimension in gig2 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). */
313          dimension_channelaftertouch = 0x83, ///< Channel Key Pressure          dimension_channelaftertouch = 0x83, /**< Channel Key Pressure */
314          dimension_releasetrigger    = 0x84, ///< Special dimension for triggering samples on releasing a key.          dimension_releasetrigger    = 0x84, /**< Special dimension for triggering samples on releasing a key. */
315          dimension_keyboard          = 0x85, ///< Dimension for keyswitching          dimension_keyboard          = 0x85, /**< Dimension for keyswitching */
316          dimension_roundrobin        = 0x86, ///< Different samples triggered each time a note is played, dimension regions selected in sequence          dimension_roundrobin        = 0x86, /**< Different samples triggered each time a note is played, dimension regions selected in sequence */
317          dimension_random            = 0x87, ///< Different samples triggered each time a note is played, random order          dimension_random            = 0x87, /**< Different samples triggered each time a note is played, random order */
318          dimension_smartmidi         = 0x88, ///< For MIDI tools like legato and repetition mode          dimension_smartmidi         = 0x88, /**< For MIDI tools like legato and repetition mode */
319          dimension_roundrobinkeyboard = 0x89, ///< Different samples triggered each time a note is played, any key advances the counter          dimension_roundrobinkeyboard = 0x89, /**< Different samples triggered each time a note is played, any key advances the counter */
320          dimension_modwheel          = 0x01, ///< Modulation Wheel (MIDI Controller 1)          dimension_modwheel          = 0x01, /**< Modulation Wheel (MIDI Controller 1) */
321          dimension_breath            = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)          dimension_breath            = 0x02, /**< Breath Controller (Coarse, MIDI Controller 2) */
322          dimension_foot              = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)          dimension_foot              = 0x04, /**< Foot Pedal (Coarse, MIDI Controller 4) */
323          dimension_portamentotime    = 0x05, ///< Portamento Time (Coarse, MIDI Controller 5)          dimension_portamentotime    = 0x05, /**< Portamento Time (Coarse, MIDI Controller 5) */
324          dimension_effect1           = 0x0c, ///< Effect Controller 1 (Coarse, MIDI Controller 12)          dimension_effect1           = 0x0c, /**< Effect Controller 1 (Coarse, MIDI Controller 12) */
325          dimension_effect2           = 0x0d, ///< Effect Controller 2 (Coarse, MIDI Controller 13)          dimension_effect2           = 0x0d, /**< Effect Controller 2 (Coarse, MIDI Controller 13) */
326          dimension_genpurpose1       = 0x10, ///< General Purpose Controller 1 (Slider, MIDI Controller 16)          dimension_genpurpose1       = 0x10, /**< General Purpose Controller 1 (Slider, MIDI Controller 16) */
327          dimension_genpurpose2       = 0x11, ///< General Purpose Controller 2 (Slider, MIDI Controller 17)          dimension_genpurpose2       = 0x11, /**< General Purpose Controller 2 (Slider, MIDI Controller 17) */
328          dimension_genpurpose3       = 0x12, ///< General Purpose Controller 3 (Slider, MIDI Controller 18)          dimension_genpurpose3       = 0x12, /**< General Purpose Controller 3 (Slider, MIDI Controller 18) */
329          dimension_genpurpose4       = 0x13, ///< General Purpose Controller 4 (Slider, MIDI Controller 19)          dimension_genpurpose4       = 0x13, /**< General Purpose Controller 4 (Slider, MIDI Controller 19) */
330          dimension_sustainpedal      = 0x40, ///< Sustain Pedal (MIDI Controller 64)          dimension_sustainpedal      = 0x40, /**< Sustain Pedal (MIDI Controller 64) */
331          dimension_portamento        = 0x41, ///< Portamento (MIDI Controller 65)          dimension_portamento        = 0x41, /**< Portamento (MIDI Controller 65) */
332          dimension_sostenutopedal    = 0x42, ///< Sostenuto Pedal (MIDI Controller 66)          dimension_sostenutopedal    = 0x42, /**< Sostenuto Pedal (MIDI Controller 66) */
333          dimension_softpedal         = 0x43, ///< Soft Pedal (MIDI Controller 67)          dimension_softpedal         = 0x43, /**< Soft Pedal (MIDI Controller 67) */
334          dimension_genpurpose5       = 0x30, ///< General Purpose Controller 5 (Button, MIDI Controller 80)          dimension_genpurpose5       = 0x30, /**< General Purpose Controller 5 (Button, MIDI Controller 80) */
335          dimension_genpurpose6       = 0x31, ///< General Purpose Controller 6 (Button, MIDI Controller 81)          dimension_genpurpose6       = 0x31, /**< General Purpose Controller 6 (Button, MIDI Controller 81) */
336          dimension_genpurpose7       = 0x32, ///< General Purpose Controller 7 (Button, MIDI Controller 82)          dimension_genpurpose7       = 0x32, /**< General Purpose Controller 7 (Button, MIDI Controller 82) */
337          dimension_genpurpose8       = 0x33, ///< General Purpose Controller 8 (Button, MIDI Controller 83)          dimension_genpurpose8       = 0x33, /**< General Purpose Controller 8 (Button, MIDI Controller 83) */
338          dimension_effect1depth      = 0x5b, ///< Effect 1 Depth (MIDI Controller 91)          dimension_effect1depth      = 0x5b, /**< Effect 1 Depth (MIDI Controller 91) */
339          dimension_effect2depth      = 0x5c, ///< Effect 2 Depth (MIDI Controller 92)          dimension_effect2depth      = 0x5c, /**< Effect 2 Depth (MIDI Controller 92) */
340          dimension_effect3depth      = 0x5d, ///< Effect 3 Depth (MIDI Controller 93)          dimension_effect3depth      = 0x5d, /**< Effect 3 Depth (MIDI Controller 93) */
341          dimension_effect4depth      = 0x5e, ///< Effect 4 Depth (MIDI Controller 94)          dimension_effect4depth      = 0x5e, /**< Effect 4 Depth (MIDI Controller 94) */
342          dimension_effect5depth      = 0x5f  ///< Effect 5 Depth (MIDI Controller 95)          dimension_effect5depth      = 0x5f  /**< Effect 5 Depth (MIDI Controller 95) */
343      } dimension_t;      );
344    
345      /**      /**
346       * Intended for internal usage: will be used to convert a dimension value       * Intended for internal usage: will be used to convert a dimension value
347       * into the corresponding dimension bit number.       * into the corresponding dimension bit number.
348         *
349         * @see enumCount(), enumKey(), enumKeys(), enumValue()
350       */       */
351      typedef enum {      GIG_DECLARE_ENUM(split_type_t,
352          split_type_normal,         ///< dimension value between 0-127          split_type_normal,         /**< dimension value between 0-127 */
353          split_type_bit             ///< dimension values are already the sought bit number          split_type_bit             /**< dimension values are already the sought bit number */
354      } split_type_t;      );
355    
356      /** General dimension definition. */      /** General dimension definition. */
357      struct dimension_def_t {      struct dimension_def_t {
# Line 275  namespace gig { Line 362  namespace gig {
362          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.
363      };      };
364    
365      /** Defines which frequencies are filtered by the VCF. */      /** Audio filter types.
366      typedef enum {       *
367          vcf_type_lowpass      = 0x00,       * The first 5 filter types are the ones which exist in GigaStudio, and
368          vcf_type_lowpassturbo = 0xff, ///< More poles than normal lowpass       * which are very accurately modeled on LinuxSampler side such that they
369          vcf_type_bandpass     = 0x01,       * would sound with LinuxSampler exactly as with GigaStudio.
370          vcf_type_highpass     = 0x02,       *
371          vcf_type_bandreject   = 0x03       * The other filter types listed here are extensions to the gig format and
372      } vcf_type_t;       * are LinuxSampler specific filter type implementations. Note that none of
373         * these are duplicates of the GigaStudio filter types. For instance
374         * @c vcf_type_lowpass (GigaStudio) and @c vcf_type_lowpass_2p
375         * (LinuxSampler) are both lowpass filters with 2 poles, however they do
376         * sound differently.
377         *
378         * @see enumCount(), enumKey(), enumKeys(), enumValue()
379         */
380        GIG_DECLARE_ENUM(vcf_type_t,
381            vcf_type_lowpass       = 0x00, /**< Standard lowpass filter type (GigaStudio). */
382            vcf_type_lowpassturbo  = 0xff, /**< More poles than normal lowpass (GigaStudio). */
383            vcf_type_bandpass      = 0x01, /**< Bandpass filter type (GigaStudio). */
384            vcf_type_highpass      = 0x02, /**< Highpass filter type (GigaStudio). */
385            vcf_type_bandreject    = 0x03, /**< Band reject filter type (GigaStudio). */
386            vcf_type_lowpass_1p    = 0x11, /**< [gig extension]: 1-pole lowpass filter type (LinuxSampler). */
387            vcf_type_lowpass_2p    = 0x12, /**< [gig extension]: 2-pole lowpass filter type (LinuxSampler). */
388            vcf_type_lowpass_4p    = 0x14, /**< [gig extension]: 4-pole lowpass filter type (LinuxSampler). */
389            vcf_type_lowpass_6p    = 0x16, /**< [gig extension]: 6-pole lowpass filter type (LinuxSampler). */
390            vcf_type_highpass_1p   = 0x21, /**< [gig extension]: 1-pole highpass filter type (LinuxSampler). */
391            vcf_type_highpass_2p   = 0x22, /**< [gig extension]: 2-pole highpass filter type (LinuxSampler). */
392            vcf_type_highpass_4p   = 0x24, /**< [gig extension]: 4-pole highpass filter type (LinuxSampler). */
393            vcf_type_highpass_6p   = 0x26, /**< [gig extension]: 6-pole highpass filter type (LinuxSampler). */
394            vcf_type_bandpass_2p   = 0x32, /**< [gig extension]: 2-pole bandpass filter type (LinuxSampler). */
395            vcf_type_bandreject_2p = 0x42  /**< [gig extension]: 2-pole bandreject filter type (LinuxSampler). */
396        );
397    
398      /**      /**
399       * Defines the envelope of a crossfade.       * Defines the envelope of a crossfade.
# Line 303  namespace gig { Line 414  namespace gig {
414          uint8_t out_start;  ///< Start position of fade out.          uint8_t out_start;  ///< Start position of fade out.
415          uint8_t out_end;    ///< End postition of fade out.          uint8_t out_end;    ///< End postition of fade out.
416          #endif // WORDS_BIGENDIAN          #endif // WORDS_BIGENDIAN
417    
418            void serialize(Serialization::Archive* archive);
419      };      };
420    
421      /** Reflects the current playback state for a sample. */      /** Reflects the current playback state for a sample. */
422      struct playback_state_t {      struct playback_state_t {
423          unsigned long position;          ///< Current position within the sample.          file_offset_t position;          ///< Current position within the sample.
424          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).
425          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.
426        };
427    
428        /**
429         * Defines behavior options for envelope generators (gig format extension).
430         *
431         * These options allow to override the precise default behavior of the
432         * envelope generators' state machines.
433         *
434         * @b Note: These EG options are an extension to the original gig file
435         * format, so these options are not available with the original
436         * Gigasampler/GigaStudio software! Currently only LinuxSampler and gigedit
437         * support these EG options!
438         *
439         * Adding these options to the original gig file format was necessary,
440         * because the precise state machine behavior of envelope generators of the
441         * gig format (and thus the default EG behavior if not explicitly overridden
442         * here) deviates from common, expected behavior of envelope generators in
443         * general, if i.e. compared with EGs of hardware synthesizers. For example
444         * with the gig format, the attack and decay stages will be aborted as soon
445         * as a note-off is received. Most other EG implementations in the industry
446         * however always run the attack and decay stages to their full duration,
447         * even if an early note-off arrives. The latter behavior is intentionally
448         * implemented in most other products, because it is required to resemble
449         * percussive sounds in a realistic manner.
450         */
451        struct eg_opt_t {
452            bool AttackCancel;     ///< Whether the "attack" stage is cancelled when receiving a note-off (default: @c true).
453            bool AttackHoldCancel; ///< Whether the "attack hold" stage is cancelled when receiving a note-off (default: @c true).
454            bool Decay1Cancel;     ///< Whether the "decay 1" stage is cancelled when receiving a note-off (default: @c true).
455            bool Decay2Cancel;     ///< Whether the "decay 2" stage is cancelled when receiving a note-off (default: @c true).
456            bool ReleaseCancel;    ///< Whether the "release" stage is cancelled when receiving a note-on (default: @c true).
457    
458            eg_opt_t();
459            void serialize(Serialization::Archive* archive);
460      };      };
461    
462        /** @brief Defines behaviour of release triggered sample(s) on sustain pedal up event.
463         *
464         * This option defines whether a sustain pedal up event (CC#64) would cause
465         * release triggered samples to be played (if any).
466         *
467         * @b Note: This option is an extension to the original gig file format,
468         * so this option is not available with the original Gigasampler/GigaStudio
469         * software! Currently only LinuxSampler and gigedit support this option!
470         *
471         * By default (which equals the original Gigasampler/GigaStudio behaviour)
472         * no release triggered samples are played if the sustain pedal is released.
473         * So usually in the gig format release triggered samples are only played
474         * on MIDI note-off events.
475         *
476         * @see enumCount(), enumKey(), enumKeys(), enumValue()
477         */
478        GIG_DECLARE_ENUM(sust_rel_trg_t,
479            sust_rel_trg_none        = 0x00, /**< No release triggered sample(s) are played on sustain pedal up (default). */
480            sust_rel_trg_maxvelocity = 0x01, /**< Play release trigger sample(s) on sustain pedal up, and simply use 127 as MIDI velocity for playback. */
481            sust_rel_trg_keyvelocity = 0x02  /**< Play release trigger sample(s) on sustain pedal up, and use the key`s last MIDI note-on velocity for playback. */
482        );
483    
484      // just symbol prototyping      // just symbol prototyping
485      class File;      class File;
486      class Instrument;      class Instrument;
# Line 381  namespace gig { Line 550  namespace gig {
550              uint8_t            EG1ControllerAttackInfluence;  ///< Amount EG1 Controller has influence on the EG1 Attack time (0 - 3, where 0 means off).              uint8_t            EG1ControllerAttackInfluence;  ///< Amount EG1 Controller has influence on the EG1 Attack time (0 - 3, where 0 means off).
551              uint8_t            EG1ControllerDecayInfluence;   ///< Amount EG1 Controller has influence on the EG1 Decay time (0 - 3, where 0 means off).              uint8_t            EG1ControllerDecayInfluence;   ///< Amount EG1 Controller has influence on the EG1 Decay time (0 - 3, where 0 means off).
552              uint8_t            EG1ControllerReleaseInfluence; ///< Amount EG1 Controller has influence on the EG1 Release time (0 - 3, where 0 means off).              uint8_t            EG1ControllerReleaseInfluence; ///< Amount EG1 Controller has influence on the EG1 Release time (0 - 3, where 0 means off).
553                lfo_wave_t         LFO1WaveForm;                  ///< [gig extension]: The fundamental wave form to be used by the amplitude LFO, e.g. sine, triangle, saw, square (default: sine).
554              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).
555                double             LFO1Phase;                     ///< [gig extension]: Phase displacement of the amplitude LFO's wave form (0.0° - 360.0°).
556              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).
557              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).
558              lfo1_ctrl_t        LFO1Controller;                ///< MIDI Controller which controls sample amplitude LFO.              lfo1_ctrl_t        LFO1Controller;                ///< MIDI Controller which controls sample amplitude LFO.
559              bool               LFO1FlipPhase;                 ///< Inverts phase of the sample amplitude LFO wave.              bool               LFO1FlipPhase;                 ///< Inverts the polarity of the sample amplitude LFO wave, so it flips the wave form vertically.
560              bool               LFO1Sync;                      ///< If set to <i>true</i> only one LFO should be used for all voices.              bool               LFO1Sync;                      ///< If set to <i>true</i> only one LFO should be used for all voices.
561              // Filter Cutoff Frequency EG/LFO              // Filter Cutoff Frequency EG/LFO
562              uint16_t           EG2PreAttack;                  ///< Preattack value of the filter cutoff EG (0 - 1000 permille).              uint16_t           EG2PreAttack;                  ///< Preattack value of the filter cutoff EG (0 - 1000 permille).
# Line 400  namespace gig { Line 571  namespace gig {
571              uint8_t            EG2ControllerAttackInfluence;  ///< Amount EG2 Controller has influence on the EG2 Attack time (0 - 3, where 0 means off).              uint8_t            EG2ControllerAttackInfluence;  ///< Amount EG2 Controller has influence on the EG2 Attack time (0 - 3, where 0 means off).
572              uint8_t            EG2ControllerDecayInfluence;   ///< Amount EG2 Controller has influence on the EG2 Decay time (0 - 3, where 0 means off).              uint8_t            EG2ControllerDecayInfluence;   ///< Amount EG2 Controller has influence on the EG2 Decay time (0 - 3, where 0 means off).
573              uint8_t            EG2ControllerReleaseInfluence; ///< Amount EG2 Controller has influence on the EG2 Release time (0 - 3, where 0 means off).              uint8_t            EG2ControllerReleaseInfluence; ///< Amount EG2 Controller has influence on the EG2 Release time (0 - 3, where 0 means off).
574                lfo_wave_t         LFO2WaveForm;                  ///< [gig extension]: The fundamental wave form to be used by the filter cutoff LFO, e.g. sine, triangle, saw, square (default: sine).
575              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).
576                double             LFO2Phase;                     ///< [gig extension]: Phase displacement of the filter cutoff LFO's wave form (0.0° - 360.0°).
577              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).
578              uint16_t           LFO2ControlDepth;              ///< Controller depth influencing filter cutoff LFO pitch (0 - 1200).              uint16_t           LFO2ControlDepth;              ///< Controller depth influencing filter cutoff LFO pitch (0 - 1200).
579              lfo2_ctrl_t        LFO2Controller;                ///< MIDI Controlle which controls the filter cutoff LFO.              lfo2_ctrl_t        LFO2Controller;                ///< MIDI Controlle which controls the filter cutoff LFO.
580              bool               LFO2FlipPhase;                 ///< Inverts phase of the filter cutoff LFO wave.              bool               LFO2FlipPhase;                 ///< Inverts the polarity of the filter cutoff LFO wave, so it flips the wave form vertically.
581              bool               LFO2Sync;                      ///< If set to <i>true</i> only one LFO should be used for all voices.              bool               LFO2Sync;                      ///< If set to <i>true</i> only one LFO should be used for all voices.
582              // Sample Pitch EG/LFO              // Sample Pitch EG/LFO
583              double             EG3Attack;                     ///< Attack time of the sample pitch EG (0.000 - 10.000s).              double             EG3Attack;                     ///< Attack time of the sample pitch EG (0.000 - 10.000s).
584              int16_t            EG3Depth;                      ///< Depth of the sample pitch EG (-1200 - +1200).              int16_t            EG3Depth;                      ///< Depth of the sample pitch EG (-1200 - +1200).
585                lfo_wave_t         LFO3WaveForm;                  ///< [gig extension]: The fundamental wave form to be used by the pitch LFO, e.g. sine, triangle, saw, square (default: sine).
586              double             LFO3Frequency;                 ///< Frequency of the sample pitch LFO (0.10 - 10.00 Hz).              double             LFO3Frequency;                 ///< Frequency of the sample pitch LFO (0.10 - 10.00 Hz).
587                double             LFO3Phase;                     ///< [gig extension]: Phase displacement of the pitch LFO's wave form (0.0° - 360.0°).
588              int16_t            LFO3InternalDepth;             ///< Firm depth of the sample pitch LFO (-1200 - +1200 cents).              int16_t            LFO3InternalDepth;             ///< Firm depth of the sample pitch LFO (-1200 - +1200 cents).
589              int16_t            LFO3ControlDepth;              ///< Controller depth of the sample pitch LFO (-1200 - +1200 cents).              int16_t            LFO3ControlDepth;              ///< Controller depth of the sample pitch LFO (-1200 - +1200 cents).
590              lfo3_ctrl_t        LFO3Controller;                ///< MIDI Controller which controls the sample pitch LFO.              lfo3_ctrl_t        LFO3Controller;                ///< MIDI Controller which controls the sample pitch LFO.
591                bool               LFO3FlipPhase;                 ///< [gig extension]: Inverts the polarity of the pitch LFO wave, so it flips the wave form vertically (@b NOTE: this setting for LFO3 is a gig format extension; flipping the polarity was only available for LFO1 and LFO2 in the original Gigasampler/GigaStudio software).
592              bool               LFO3Sync;                      ///< If set to <i>true</i> only one LFO should be used for all voices.              bool               LFO3Sync;                      ///< If set to <i>true</i> only one LFO should be used for all voices.
593              // Filter              // Filter
594              bool               VCFEnabled;                    ///< If filter should be used.              bool               VCFEnabled;                    ///< If filter should be used.
# Line 450  namespace gig { Line 626  namespace gig {
626              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).
627              double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)              double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)
628              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).              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).
629                eg_opt_t           EG1Options;                    ///< [gig extension]: Behavior options which should be used for envelope generator 1 (volume amplitude EG).
630                eg_opt_t           EG2Options;                    ///< [gig extension]: Behavior options which should be used for envelope generator 2 (filter cutoff EG).
631                sust_rel_trg_t     SustainReleaseTrigger;         ///< [gig extension]: Whether a sustain pedal up event shall play release trigger sample.
632                bool               NoNoteOffReleaseTrigger;       ///< [gig extension]: If @c true then don't play a release trigger sample on MIDI note-off events.
633    
634              // derived attributes from DLS::Sampler              // derived attributes from DLS::Sampler
635              using DLS::Sampler::UnityNote;              using DLS::Sampler::UnityNote;
# Line 476  namespace gig { Line 656  namespace gig {
656              using DLS::Sampler::AddSampleLoop;              using DLS::Sampler::AddSampleLoop;
657              using DLS::Sampler::DeleteSampleLoop;              using DLS::Sampler::DeleteSampleLoop;
658              // overridden methods              // overridden methods
659              virtual void SetGain(int32_t gain);              virtual void SetGain(int32_t gain) OVERRIDE;
660              virtual void UpdateChunks(progress_t* pProgress);              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
661              virtual void CopyAssign(const DimensionRegion* orig);              virtual void CopyAssign(const DimensionRegion* orig);
662          protected:          protected:
663              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 485  namespace gig { Line 665  namespace gig {
665              DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);              DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);
666             ~DimensionRegion();             ~DimensionRegion();
667              void CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples);              void CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples);
668                void serialize(Serialization::Archive* archive);
669              friend class Region;              friend class Region;
670                friend class Serialization::Archive;
671          private:          private:
672              typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller              typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller
673                  // 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 588  namespace gig { Line 770  namespace gig {
770              } _lev_ctrl_t;              } _lev_ctrl_t;
771              typedef std::map<uint32_t, double*> VelocityTableMap;              typedef std::map<uint32_t, double*> VelocityTableMap;
772    
773              static uint              Instances;                  ///< Number of DimensionRegion instances.              static size_t            Instances;                  ///< Number of DimensionRegion instances.
774              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).
775              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.
776              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 601  namespace gig { Line 783  namespace gig {
783              double* GetCutoffVelocityTable(curve_type_t vcfVelocityCurve, uint8_t vcfVelocityDynamicRange, uint8_t vcfVelocityScale, vcf_cutoff_ctrl_t vcfCutoffController);              double* GetCutoffVelocityTable(curve_type_t vcfVelocityCurve, uint8_t vcfVelocityDynamicRange, uint8_t vcfVelocityScale, vcf_cutoff_ctrl_t vcfCutoffController);
784              double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);              double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
785              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
786                bool UsesAnyGigFormatExtension() const;
787      };      };
788    
789      /** @brief Encapsulates sample waves of Gigasampler/GigaStudio files used for playback.      /** @brief Encapsulates sample waves of Gigasampler/GigaStudio files used for playback.
# Line 651  namespace gig { Line 834  namespace gig {
834    
835              // own methods              // own methods
836              buffer_t      LoadSampleData();              buffer_t      LoadSampleData();
837              buffer_t      LoadSampleData(unsigned long SampleCount);              buffer_t      LoadSampleData(file_offset_t SampleCount);
838              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
839              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(file_offset_t SampleCount, uint NullSamplesCount);
840              buffer_t      GetCache();              buffer_t      GetCache();
841              // own static methods              // own static methods
842              static buffer_t CreateDecompressionBuffer(unsigned long MaxReadSize);              static buffer_t CreateDecompressionBuffer(file_offset_t MaxReadSize);
843              static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);              static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
844              // overridden methods              // overridden methods
845              void          ReleaseSampleData();              void          ReleaseSampleData();
846              void          Resize(int iNewSize);              void          Resize(file_offset_t NewSize);
847              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);
848              unsigned long GetPos() const;              file_offset_t GetPos() const;
849              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);
850              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);
851              unsigned long Write(void* pBuffer, unsigned long SampleCount);              file_offset_t Write(void* pBuffer, file_offset_t SampleCount);
852              Group*        GetGroup() const;              Group*        GetGroup() const;
853              virtual void  UpdateChunks(progress_t* pProgress);              virtual void  UpdateChunks(progress_t* pProgress) OVERRIDE;
854              void CopyAssignMeta(const Sample* orig);              void CopyAssignMeta(const Sample* orig);
855              void CopyAssignWave(const Sample* orig);              void CopyAssignWave(const Sample* orig);
856                uint32_t GetWaveDataCRC32Checksum();
857                bool VerifyWaveData(uint32_t* pActually = NULL);
858          protected:          protected:
859              static unsigned int  Instances;               ///< Number of instances of class Sample.              static size_t        Instances;               ///< Number of instances of class Sample.
860              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 of samples, and only if no external decompression buffer was supplied.
861              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)
862              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).
863              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.
864              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).
865              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.
866              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.
867              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.
868              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.
869              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)
870              RIFF::Chunk*         pCk3gix;              RIFF::Chunk*         pCk3gix;
871              RIFF::Chunk*         pCkSmpl;              RIFF::Chunk*         pCkSmpl;
872              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().
873    
874              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);
875             ~Sample();             ~Sample();
876                uint32_t CalculateWaveDataChecksum();
877    
878              // Guess size (in bytes) of a compressed sample              // Guess size (in bytes) of a compressed sample
879              inline unsigned long GuessSize(unsigned long samples) {              inline file_offset_t GuessSize(file_offset_t samples) {
880                  // 16 bit: assume all frames are compressed - 1 byte                  // 16 bit: assume all frames are compressed - 1 byte
881                  // per sample and 5 bytes header per 2048 samples                  // per sample and 5 bytes header per 2048 samples
882    
883                  // 24 bit: assume next best compression rate - 1.5                  // 24 bit: assume next best compression rate - 1.5
884                  // bytes per sample and 13 bytes header per 256                  // bytes per sample and 13 bytes header per 256
885                  // samples                  // samples
886                  const unsigned long size =                  const file_offset_t size =
887                      BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13                      BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
888                                     : samples + (samples >> 10) * 5;                                     : samples + (samples >> 10) * 5;
889                  // Double for stereo and add one worst case sample                  // Double for stereo and add one worst case sample
# Line 707  namespace gig { Line 893  namespace gig {
893    
894              // Worst case amount of sample points that can be read with the              // Worst case amount of sample points that can be read with the
895              // given decompression buffer.              // given decompression buffer.
896              inline unsigned long WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {              inline file_offset_t WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
897                  return (unsigned long) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);                  return (file_offset_t) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
898              }              }
899          private:          private:
900              void ScanCompressedSample();              void ScanCompressedSample();
# Line 758  namespace gig { Line 944  namespace gig {
944              void             SplitDimensionZone(dimension_t type, int zone);              void             SplitDimensionZone(dimension_t type, int zone);
945              void             SetDimensionType(dimension_t oldType, dimension_t newType);              void             SetDimensionType(dimension_t oldType, dimension_t newType);
946              // overridden methods              // overridden methods
947              virtual void     SetKeyRange(uint16_t Low, uint16_t High);              virtual void     SetKeyRange(uint16_t Low, uint16_t High) OVERRIDE;
948              virtual void     UpdateChunks(progress_t* pProgress);              virtual void     UpdateChunks(progress_t* pProgress) OVERRIDE;
949              virtual void     CopyAssign(const Region* orig);              virtual void     CopyAssign(const Region* orig);
950          protected:          protected:
951              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
# Line 770  namespace gig { Line 956  namespace gig {
956              DimensionRegion* GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase);              DimensionRegion* GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase);
957             ~Region();             ~Region();
958              friend class Instrument;              friend class Instrument;
959            private:
960                bool UsesAnyGigFormatExtension() const;
961      };      };
962    
963      /** @brief Abstract base class for all MIDI rules.      /** @brief Abstract base class for all MIDI rules.
# Line 852  namespace gig { Line 1040  namespace gig {
1040          protected:          protected:
1041              MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg);              MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg);
1042              MidiRuleCtrlTrigger();              MidiRuleCtrlTrigger();
1043              void UpdateChunks(uint8_t* pData) const;              void UpdateChunks(uint8_t* pData) const OVERRIDE;
1044              friend class Instrument;              friend class Instrument;
1045      };      };
1046    
# Line 892  namespace gig { Line 1080  namespace gig {
1080          protected:          protected:
1081              MidiRuleLegato(RIFF::Chunk* _3ewg);              MidiRuleLegato(RIFF::Chunk* _3ewg);
1082              MidiRuleLegato();              MidiRuleLegato();
1083              void UpdateChunks(uint8_t* pData) const;              void UpdateChunks(uint8_t* pData) const OVERRIDE;
1084              friend class Instrument;              friend class Instrument;
1085      };      };
1086    
# Line 944  namespace gig { Line 1132  namespace gig {
1132          protected:          protected:
1133              MidiRuleAlternator(RIFF::Chunk* _3ewg);              MidiRuleAlternator(RIFF::Chunk* _3ewg);
1134              MidiRuleAlternator();              MidiRuleAlternator();
1135              void UpdateChunks(uint8_t* pData) const;              void UpdateChunks(uint8_t* pData) const OVERRIDE;
1136              friend class Instrument;              friend class Instrument;
1137      };      };
1138    
# Line 964  namespace gig { Line 1152  namespace gig {
1152      class MidiRuleUnknown : public MidiRule {      class MidiRuleUnknown : public MidiRule {
1153          protected:          protected:
1154              MidiRuleUnknown() { }              MidiRuleUnknown() { }
1155              void UpdateChunks(uint8_t* pData) const { }              void UpdateChunks(uint8_t* pData) const OVERRIDE { }
1156              friend class Instrument;              friend class Instrument;
1157      };      };
1158    
# Line 979  namespace gig { Line 1167  namespace gig {
1167       * not available in the GigaStudio 4 software. It is currently only       * not available in the GigaStudio 4 software. It is currently only
1168       * supported by LinuxSampler and gigedit. Scripts will not load with the       * supported by LinuxSampler and gigedit. Scripts will not load with the
1169       * original GigaStudio software.       * original GigaStudio software.
1170         *
1171         * You find more informations about Instrument Scripts on the LinuxSampler
1172         * documentation site:
1173         *
1174         * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/">About Instrument Scripts in General</a>
1175         * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language">Introduction to the NKSP Script Language</a>
1176         * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language/Reference/">NKSP Reference Manual</a>
1177         * - <a href="http://doc.linuxsampler.org/Gigedit/Managing_Scripts">Using Instrument Scripts with Gigedit</a>
1178       */       */
1179      class Script {      class Script : protected DLS::Storage {
1180          public:          public:
1181              enum Encoding_t {              enum Encoding_t {
1182                  ENCODING_ASCII = 0 ///< Standard 8 bit US ASCII character encoding (default).                  ENCODING_ASCII = 0 ///< Standard 8 bit US ASCII character encoding (default).
# Line 989  namespace gig { Line 1185  namespace gig {
1185                  COMPRESSION_NONE = 0 ///< Is not compressed at all (default).                  COMPRESSION_NONE = 0 ///< Is not compressed at all (default).
1186              };              };
1187              enum Language_t {              enum Language_t {
1188                  LANGUAGE_NKSP = 0 ///< NKSP stands for "Is Not KSP" (default).                  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.
1189              };              };
1190    
1191              String         Name;        ///< Arbitrary name of the script, which may be displayed i.e. in an instrument editor.              String         Name;        ///< Arbitrary name of the script, which may be displayed i.e. in an instrument editor.
# Line 997  namespace gig { Line 1193  namespace gig {
1193              Encoding_t     Encoding;    ///< Format the script's source code text is encoded with.              Encoding_t     Encoding;    ///< Format the script's source code text is encoded with.
1194              Language_t     Language;    ///< Programming language and dialect the script is written in.              Language_t     Language;    ///< Programming language and dialect the script is written in.
1195              bool           Bypass;      ///< Global bypass: if enabled, this script shall not be executed by the sampler for any instrument.              bool           Bypass;      ///< Global bypass: if enabled, this script shall not be executed by the sampler for any instrument.
1196                uint8_t        Uuid[16];    ///< Persistent Universally Unique Identifier of this script, which remains identical after any changes to this script.
1197    
1198              String GetScriptAsText();              String GetScriptAsText();
1199              void   SetScriptAsText(const String& text);              void   SetScriptAsText(const String& text);
1200              void   SetGroup(ScriptGroup* pGroup);              void   SetGroup(ScriptGroup* pGroup);
1201              ScriptGroup* GetGroup() const;              ScriptGroup* GetGroup() const;
1202                void   CopyAssign(const Script* orig);
1203          protected:          protected:
1204              Script(ScriptGroup* group, RIFF::Chunk* ckScri);              Script(ScriptGroup* group, RIFF::Chunk* ckScri);
1205              virtual ~Script();              virtual ~Script();
1206              void UpdateChunks(progress_t* pProgress);              void UpdateChunks(progress_t* pProgress) OVERRIDE;
1207                void DeleteChunks() OVERRIDE;
1208              void RemoveAllScriptReferences();              void RemoveAllScriptReferences();
1209                void GenerateUuid();
1210              friend class ScriptGroup;              friend class ScriptGroup;
1211              friend class Instrument;              friend class Instrument;
1212          private:          private:
# Line 1027  namespace gig { Line 1227  namespace gig {
1227       * not available in the GigaStudio 4 software. It is currently only       * not available in the GigaStudio 4 software. It is currently only
1228       * supported by LinuxSampler and gigedit.       * supported by LinuxSampler and gigedit.
1229       */       */
1230      class ScriptGroup {      class ScriptGroup : protected DLS::Storage {
1231          public:          public:
1232              String   Name; ///< Name of this script group. For example to be displayed in an instrument editor.              String   Name; ///< Name of this script group. For example to be displayed in an instrument editor.
1233    
1234              Script*  GetScript(uint index);              Script*  GetScript(size_t index);
1235              Script*  AddScript();              Script*  AddScript();
1236              void     DeleteScript(Script* pScript);              void     DeleteScript(Script* pScript);
1237          protected:          protected:
1238              ScriptGroup(File* file, RIFF::List* lstRTIS);              ScriptGroup(File* file, RIFF::List* lstRTIS);
1239              virtual ~ScriptGroup();              virtual ~ScriptGroup();
1240              void LoadScripts();              void LoadScripts();
1241              void UpdateChunks(progress_t* pProgress);              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
1242                virtual void DeleteChunks() OVERRIDE;
1243              friend class Script;              friend class Script;
1244              friend class File;              friend class File;
1245          private:          private:
1246              File*                pFile;              File*                pFile;
1247              RIFF::List*          pList; ///< 'RTIS' list chunk              RIFF::List*          pList; ///< 'RTIS' list chunk
1248              std::list<Script*>*  pScripts;              std::vector<Script*>* pScripts;
1249      };      };
1250    
1251      /** @brief Provides access to a Gigasampler/GigaStudio instrument.      /** @brief Provides access to a Gigasampler/GigaStudio instrument.
# Line 1086  namespace gig { Line 1287  namespace gig {
1287              // derived methods from DLS::Resource              // derived methods from DLS::Resource
1288              using DLS::Resource::GetParent;              using DLS::Resource::GetParent;
1289              // overridden methods              // overridden methods
1290              Region*   GetFirstRegion();              Region*   GetRegionAt(size_t pos);
1291              Region*   GetNextRegion();              Region*   GetFirstRegion() LIBGIG_DEPRECATED_API("Use GetRegionAt() instead.");
1292                Region*   GetNextRegion() LIBGIG_DEPRECATED_API("Use GetRegionAt() instead.");
1293              Region*   AddRegion();              Region*   AddRegion();
1294              void      DeleteRegion(Region* pRegion);              void      DeleteRegion(Region* pRegion);
1295              void      MoveTo(Instrument* dst);              void      MoveTo(Instrument* dst);
1296              virtual void UpdateChunks(progress_t* pProgress);              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
1297              virtual void CopyAssign(const Instrument* orig);              virtual void CopyAssign(const Instrument* orig);
1298              // own methods              // own methods
1299              Region*   GetRegion(unsigned int Key);              Region*   GetRegion(unsigned int Key);
# Line 1101  namespace gig { Line 1303  namespace gig {
1303              MidiRuleAlternator*  AddMidiRuleAlternator();              MidiRuleAlternator*  AddMidiRuleAlternator();
1304              void      DeleteMidiRule(int i);              void      DeleteMidiRule(int i);
1305              // real-time instrument script methods              // real-time instrument script methods
1306              Script*   GetScriptOfSlot(uint index);              Script*   GetScriptOfSlot(size_t index);
1307              void      AddScriptSlot(Script* pScript, bool bypass = false);              void      AddScriptSlot(Script* pScript, bool bypass = false);
1308              void      SwapScriptSlots(uint index1, uint index2);              void      SwapScriptSlots(uint index1, uint index2);
1309              void      RemoveScriptSlot(uint index);              void      RemoveScriptSlot(uint index);
# Line 1109  namespace gig { Line 1311  namespace gig {
1311              uint      ScriptSlotCount() const;              uint      ScriptSlotCount() const;
1312              bool      IsScriptSlotBypassed(uint index);              bool      IsScriptSlotBypassed(uint index);
1313              void      SetScriptSlotBypassed(uint index, bool bBypass);              void      SetScriptSlotBypassed(uint index, bool bBypass);
1314                bool      IsScriptPatchVariableSet(int slot, String variable);
1315                std::map<String,String> GetScriptPatchVariables(int slot);
1316                String    GetScriptPatchVariable(int slot, String variable);
1317                void      SetScriptPatchVariable(int slot, String variable, String value);
1318                void      UnsetScriptPatchVariable(int slot = -1, String variable = "");
1319          protected:          protected:
1320              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
1321    
# Line 1129  namespace gig { Line 1336  namespace gig {
1336                  Script*  script;                  Script*  script;
1337                  bool     bypass;                  bool     bypass;
1338              };              };
1339                typedef std::array<uint8_t,16> _UUID;
1340                typedef std::map<String,String> _PatchVars;
1341                typedef std::map<int,_PatchVars> _VarsBySlot;
1342                typedef std::map<_UUID,_VarsBySlot> _VarsByScript;
1343              MidiRule** pMidiRules;              MidiRule** pMidiRules;
1344              std::vector<_ScriptPooolEntry> scriptPoolFileOffsets;              std::vector<_ScriptPooolEntry> scriptPoolFileOffsets;
1345              std::vector<_ScriptPooolRef>* pScriptRefs;              std::vector<_ScriptPooolRef>* pScriptRefs;
1346                _VarsByScript scriptVars;
1347    
1348                _VarsByScript stripScriptVars();
1349                bool ReferencesScriptWithUuid(const _UUID& uuid);
1350                bool UsesAnyGigFormatExtension() const;
1351      };      };
1352    
1353      /** @brief Group of Gigasampler samples      /** @brief Group of Gigasampler samples
# Line 1145  namespace gig { Line 1361  namespace gig {
1361       * 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
1362       * created one yet or not.       * created one yet or not.
1363       */       */
1364      class Group {      class Group : public DLS::Storage {
1365          public:          public:
1366              String Name; ///< Stores the name of this Group.              String Name; ///< Stores the name of this Group.
1367    
1368              Sample* GetFirstSample();              Sample* GetSample(size_t index);
1369              Sample* GetNextSample();              Sample* GetFirstSample() LIBGIG_DEPRECATED_API("Use GetSample() instead.");
1370                Sample* GetNextSample() LIBGIG_DEPRECATED_API("Use GetSample() instead.");
1371              void AddSample(Sample* pSample);              void AddSample(Sample* pSample);
1372          protected:          protected:
1373              Group(File* file, RIFF::Chunk* ck3gnm);              Group(File* file, RIFF::Chunk* ck3gnm);
1374              virtual ~Group();              virtual ~Group();
1375              virtual void UpdateChunks(progress_t* pProgress);              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
1376                virtual void DeleteChunks() OVERRIDE;
1377              void MoveAll();              void MoveAll();
1378              friend class File;              friend class File;
1379          private:          private:
1380              File*        pFile;              File*        pFile;
1381              RIFF::Chunk* pNameChunk; ///< '3gnm' chunk              RIFF::Chunk* pNameChunk; ///< '3gnm' chunk
1382                size_t       SamplesIterator; ///< Used by GetFirstSample(), GetNextSample() only.
1383      };      };
1384    
1385      /** @brief Provides convenient access to Gigasampler/GigaStudio .gig files.      /** @brief Provides convenient access to Gigasampler/GigaStudio .gig files.
# Line 1203  namespace gig { Line 1422  namespace gig {
1422          public:          public:
1423              static const DLS::version_t VERSION_2;              static const DLS::version_t VERSION_2;
1424              static const DLS::version_t VERSION_3;              static const DLS::version_t VERSION_3;
1425                static const DLS::version_t VERSION_4;
1426    
1427              // derived attributes from DLS::Resource              // derived attributes from DLS::Resource
1428              using DLS::Resource::pInfo;              using DLS::Resource::pInfo;
# Line 1217  namespace gig { Line 1437  namespace gig {
1437              using DLS::File::Save;              using DLS::File::Save;
1438              using DLS::File::GetFileName;              using DLS::File::GetFileName;
1439              using DLS::File::SetFileName;              using DLS::File::SetFileName;
1440                using DLS::File::GetRiffFile;
1441              // overridden  methods              // overridden  methods
1442              File();              File();
1443              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
1444              Sample*     GetFirstSample(progress_t* pProgress = NULL); ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise.              Sample*     GetFirstSample(progress_t* pProgress = NULL) LIBGIG_DEPRECATED_API("Use GetSample() instead.");
1445              Sample*     GetNextSample();      ///< Returns a pointer to the next <i>Sample</i> object of the file, <i>NULL</i> otherwise.              Sample*     GetNextSample() LIBGIG_DEPRECATED_API("Use GetSample() instead.");
1446              Sample*     GetSample(uint index);              Sample*     GetSample(size_t index, progress_t* pProgress = NULL);
1447              Sample*     AddSample();              Sample*     AddSample();
1448                size_t      CountSamples();
1449              void        DeleteSample(Sample* pSample);              void        DeleteSample(Sample* pSample);
1450              Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</i> object of the file, <i>NULL</i> otherwise.              Instrument* GetFirstInstrument() LIBGIG_DEPRECATED_API("Use GetInstrument() instead.");
1451              Instrument* GetNextInstrument();  ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise.              Instrument* GetNextInstrument() LIBGIG_DEPRECATED_API("Use GetInstrument() instead.");
1452              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);              Instrument* GetInstrument(size_t index, progress_t* pProgress = NULL);
1453              Instrument* AddInstrument();              Instrument* AddInstrument();
1454              Instrument* AddDuplicateInstrument(const Instrument* orig);              Instrument* AddDuplicateInstrument(const Instrument* orig);
1455                size_t      CountInstruments();
1456              void        DeleteInstrument(Instrument* pInstrument);              void        DeleteInstrument(Instrument* pInstrument);
1457              Group*      GetFirstGroup(); ///< Returns a pointer to the first <i>Group</i> object of the file, <i>NULL</i> otherwise.              Group*      GetFirstGroup() LIBGIG_DEPRECATED_API("Use GetGroup() instead.");
1458              Group*      GetNextGroup();  ///< Returns a pointer to the next <i>Group</i> object of the file, <i>NULL</i> otherwise.              Group*      GetNextGroup() LIBGIG_DEPRECATED_API("Use GetGroup() instead.");
1459              Group*      GetGroup(uint index);              Group*      GetGroup(size_t index);
1460              Group*      GetGroup(String name);              Group*      GetGroup(String name);
1461              Group*      AddGroup();              Group*      AddGroup();
1462              void        DeleteGroup(Group* pGroup);              void        DeleteGroup(Group* pGroup);
# Line 1241  namespace gig { Line 1464  namespace gig {
1464              void        SetAutoLoad(bool b);              void        SetAutoLoad(bool b);
1465              bool        GetAutoLoad();              bool        GetAutoLoad();
1466              void        AddContentOf(File* pFile);              void        AddContentOf(File* pFile);
1467              ScriptGroup* GetScriptGroup(uint index);              ScriptGroup* GetScriptGroup(size_t index);
1468              ScriptGroup* GetScriptGroup(const String& name);              ScriptGroup* GetScriptGroup(const String& name);
1469              ScriptGroup* AddScriptGroup();              ScriptGroup* AddScriptGroup();
1470              void        DeleteScriptGroup(ScriptGroup* pGroup);              void        DeleteScriptGroup(ScriptGroup* pGroup);
1471              virtual    ~File();              virtual    ~File();
1472              virtual void UpdateChunks(progress_t* pProgress);              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
1473          protected:          protected:
1474              // overridden protected methods from DLS::File              // overridden protected methods from DLS::File
1475              virtual void LoadSamples();              virtual void LoadSamples() OVERRIDE;
1476              virtual void LoadInstruments();              virtual void LoadInstruments() OVERRIDE;
1477              virtual void LoadGroups();              virtual void LoadGroups();
1478              virtual void UpdateFileOffsets();              virtual void UpdateFileOffsets() OVERRIDE;
1479              // own protected methods              // own protected methods
1480              virtual void LoadSamples(progress_t* pProgress);              virtual void LoadSamples(progress_t* pProgress);
1481              virtual void LoadInstruments(progress_t* pProgress);              virtual void LoadInstruments(progress_t* pProgress);
1482              virtual void LoadScriptGroups();              virtual void LoadScriptGroups();
1483              void SetSampleChecksum(Sample* pSample, uint32_t crc);              void SetSampleChecksum(Sample* pSample, uint32_t crc);
1484                uint32_t GetSampleChecksum(Sample* pSample);
1485                uint32_t GetSampleChecksumByIndex(int index);
1486                bool VerifySampleChecksumTable();
1487                bool RebuildSampleChecksumTable();
1488                int  GetWaveTableIndexOf(gig::Sample* pSample);
1489              friend class Region;              friend class Region;
1490              friend class Sample;              friend class Sample;
1491              friend class Instrument;              friend class Instrument;
1492              friend class Group; // so Group can access protected member pRIFF              friend class Group; // so Group can access protected member pRIFF
1493              friend class ScriptGroup; // so ScriptGroup can access protected member pRIFF              friend class ScriptGroup; // so ScriptGroup can access protected member pRIFF
1494          private:          private:
1495              std::list<Group*>*          pGroups;              std::vector<Group*>*          pGroups;
1496              std::list<Group*>::iterator GroupsIterator;              std::vector<Group*>::iterator GroupsIterator;
1497              bool                        bAutoLoad;              bool                        bAutoLoad;
1498              std::list<ScriptGroup*>*    pScriptGroups;              std::vector<ScriptGroup*>*    pScriptGroups;
1499    
1500                bool UsesAnyGigFormatExtension() const;
1501      };      };
1502    
1503      /**      /**
# Line 1280  namespace gig { Line 1510  namespace gig {
1510       */       */
1511      class Exception : public DLS::Exception {      class Exception : public DLS::Exception {
1512          public:          public:
1513              Exception(String Message);              Exception(String format, ...);
1514                Exception(String format, va_list arg);
1515              void PrintMessage();              void PrintMessage();
1516            protected:
1517                Exception();
1518      };      };
1519    
1520    #if HAVE_RTTI
1521        size_t enumCount(const std::type_info& type);
1522        const char* enumKey(const std::type_info& type, size_t value);
1523        bool        enumKey(const std::type_info& type, String key);
1524        const char** enumKeys(const std::type_info& type);
1525    #endif // HAVE_RTTI
1526        size_t enumCount(String typeName);
1527        const char* enumKey(String typeName, size_t value);
1528        bool        enumKey(String typeName, String key);
1529        const char** enumKeys(String typeName);
1530        size_t enumValue(String key);
1531    
1532      String libraryName();      String libraryName();
1533      String libraryVersion();      String libraryVersion();
1534    
Legend:
Removed from v.2700  
changed lines
  Added in v.3952
  ViewVC Help
Powered by ViewVC