/[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 2599 by schoenebeck, Sat Jun 7 00:00:10 2014 UTC revision 3645 by schoenebeck, Sun Dec 8 22:59:11 2019 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-2019 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 27  Line 27 
27  #include "DLS.h"  #include "DLS.h"
28  #include <vector>  #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
# Line 45  Line 61 
61  # define CHUNK_ID_SCRI  0x53637269 // own gig format extension  # define CHUNK_ID_SCRI  0x53637269 // own gig format extension
62  # define CHUNK_ID_LSNM  0x4c534e4d // own gig format extension  # define CHUNK_ID_LSNM  0x4c534e4d // own gig format extension
63  # define CHUNK_ID_SCSL  0x5343534c // own gig format extension  # define CHUNK_ID_SCSL  0x5343534c // own gig format extension
64    # define CHUNK_ID_LSDE  0x4c534445 // own gig format extension
65  #else  // little endian  #else  // little endian
66  # define LIST_TYPE_3PRG 0x67727033  # define LIST_TYPE_3PRG 0x67727033
67  # define LIST_TYPE_3EWL 0x6C776533  # define LIST_TYPE_3EWL 0x6C776533
# Line 63  Line 80 
80  # define CHUNK_ID_SCRI  0x69726353 // own gig format extension  # define CHUNK_ID_SCRI  0x69726353 // own gig format extension
81  # define CHUNK_ID_LSNM  0x4d4e534c // own gig format extension  # define CHUNK_ID_LSNM  0x4d4e534c // own gig format extension
82  # define CHUNK_ID_SCSL  0x4c534353 // own gig format extension  # define CHUNK_ID_SCSL  0x4c534353 // own gig format extension
83    # define CHUNK_ID_LSDE  0x4544534c // own gig format extension
84  #endif // WORDS_BIGENDIAN  #endif // WORDS_BIGENDIAN
85    
86  /** Gigasampler specific classes and definitions */  #ifndef GIG_DECLARE_ENUM
87    # define GIG_DECLARE_ENUM(type, ...) enum type { __VA_ARGS__ }
88    #endif
89    
90    // just symbol prototyping (since Serialization.h not included by default here)
91    namespace Serialization { class Archive; }
92    
93    /** Gigasampler/GigaStudio specific classes and definitions */
94  namespace gig {  namespace gig {
95    
96      typedef std::string String;      typedef std::string String;
97        typedef RIFF::progress_t progress_t;
98        typedef RIFF::file_offset_t file_offset_t;
99    
100      /** Lower and upper limit of a range. */      /** Lower and upper limit of a range. */
101      struct range_t {      struct range_t {
# Line 79  namespace gig { Line 106  namespace gig {
106      /** Pointer address and size of a buffer. */      /** Pointer address and size of a buffer. */
107      struct buffer_t {      struct buffer_t {
108          void*         pStart;            ///< Points to the beginning of the buffer.          void*         pStart;            ///< Points to the beginning of the buffer.
109          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.
110          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. :)
111          buffer_t() {          buffer_t() {
112              pStart            = NULL;              pStart            = NULL;
113              Size              = 0;              Size              = 0;
# Line 88  namespace gig { Line 115  namespace gig {
115          }          }
116      };      };
117    
118      /** Standard types of sample loops. */      /** Standard types of sample loops.
119      typedef enum {       *
120          loop_type_normal        = 0x00000000,  ///< Loop forward (normal)       * @see enumCount(), enumKey(), enumKeys(), enumValue()
121          loop_type_bidirectional = 0x00000001,  ///< Alternating loop (forward/backward, also known as Ping Pong)       */
122          loop_type_backward      = 0x00000002   ///< Loop backward (reverse)      GIG_DECLARE_ENUM(loop_type_t,
123      } loop_type_t;          loop_type_normal        = 0x00000000,  /**< Loop forward (normal) */
124            loop_type_bidirectional = 0x00000001,  /**< Alternating loop (forward/backward, also known as Ping Pong) */
125      /** Society of Motion Pictures and Television E time format. */          loop_type_backward      = 0x00000002   /**< Loop backward (reverse) */
126      typedef enum {      );
127          smpte_format_no_offset          = 0x00000000,  ///< no SMPTE offset  
128          smpte_format_24_frames          = 0x00000018,  ///< 24 frames per second      /** Society of Motion Pictures and Television E time format.
129          smpte_format_25_frames          = 0x00000019,  ///< 25 frames per second       *
130          smpte_format_30_frames_dropping = 0x0000001D,  ///< 30 frames per second with frame dropping (30 drop)       * @see enumCount(), enumKey(), enumKeys(), enumValue()
131          smpte_format_30_frames          = 0x0000001E   ///< 30 frames per second       */
132      } smpte_format_t;      GIG_DECLARE_ENUM(smpte_format_t,
133            smpte_format_no_offset          = 0x00000000,  /**< no SMPTE offset */
134      /** Defines the shape of a function graph. */          smpte_format_24_frames          = 0x00000018,  /**< 24 frames per second */
135      typedef enum {          smpte_format_25_frames          = 0x00000019,  /**< 25 frames per second */
136          curve_type_nonlinear = 0,          smpte_format_30_frames_dropping = 0x0000001D,  /**< 30 frames per second with frame dropping (30 drop) */
137          curve_type_linear    = 1,          smpte_format_30_frames          = 0x0000001E   /**< 30 frames per second */
138          curve_type_special   = 2,      );
139          curve_type_unknown   = 0xffffffff  
140      } curve_type_t;      /** Defines the shape of a function graph.
141         *
142      /** Dimensions allow to bypass one of the following controllers. */       * @see enumCount(), enumKey(), enumKeys(), enumValue()
143      typedef enum {       */
144          dim_bypass_ctrl_none,      GIG_DECLARE_ENUM(curve_type_t,
145          dim_bypass_ctrl_94,   ///< Effect 4 Depth (MIDI Controller 94)          curve_type_nonlinear = 0,          /**< Non-linear curve type. */
146          dim_bypass_ctrl_95    ///< Effect 5 Depth (MIDI Controller 95)          curve_type_linear    = 1,          /**< Linear curve type. */
147      } dim_bypass_ctrl_t;          curve_type_special   = 2,          /**< Special curve type. */
148            curve_type_unknown   = 0xffffffff  /**< Unknown curve type. */
149      /** Defines how LFO3 is controlled by. */      );
150      typedef enum {  
151          lfo3_ctrl_internal            = 0x00, ///< Only internally controlled.      /** Defines the wave form type used by an LFO (gig format extension).
152          lfo3_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.       *
153          lfo3_ctrl_aftertouch          = 0x02, ///< Only controlled by aftertouch controller.       * This is a gig format extension. The original Gigasampler/GigaStudio
154          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
155          lfo3_ctrl_internal_aftertouch = 0x04  ///< Controlled internally and by aftertouch controller.       * was not configurable in the original gig format. Accordingly setting any
156      } lfo3_ctrl_t;       * other wave form than sine (sinus) will be ignored by the original
157         * Gigasampler/GigaStudio software.
158      /** Defines how LFO2 is controlled by. */       *
159      typedef enum {       * @see enumCount(), enumKey(), enumKeys(), enumValue()
160          lfo2_ctrl_internal            = 0x00, ///< Only internally controlled.       */
161          lfo2_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.      GIG_DECLARE_ENUM(lfo_wave_t,
162          lfo2_ctrl_foot                = 0x02, ///< Only controlled by external foot controller.          lfo_wave_sine     = 0,  /**< Sine (sinus) wave form (this is the default wave form). */
163          lfo2_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.          lfo_wave_triangle = 1,  /**< Triangle wave form. */
164          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). */
165      } lfo2_ctrl_t;          lfo_wave_square   = 3,  /**< Square wave form. */
166        );
167      /** Defines how LFO1 is controlled by. */  
168      typedef enum {      /** Dimensions allow to bypass one of the following controllers.
169          lfo1_ctrl_internal            = 0x00, ///< Only internally controlled.       *
170          lfo1_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.       * @see enumCount(), enumKey(), enumKeys(), enumValue()
171          lfo1_ctrl_breath              = 0x02, ///< Only controlled by external breath controller.       */
172          lfo1_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.      GIG_DECLARE_ENUM(dim_bypass_ctrl_t,
173          lfo1_ctrl_internal_breath     = 0x04  ///< Controlled internally and by external breath controller.          dim_bypass_ctrl_none, /**< No controller bypass. */
174      } lfo1_ctrl_t;          dim_bypass_ctrl_94,   /**< Effect 4 Depth (MIDI Controller 94) */
175            dim_bypass_ctrl_95    /**< Effect 5 Depth (MIDI Controller 95) */
176      /** Defines how the filter cutoff frequency is controlled by. */      );
177      typedef enum {  
178          vcf_cutoff_ctrl_none         = 0x00,      /** Defines how LFO3 is controlled by.
179          vcf_cutoff_ctrl_none2        = 0x01,  ///< The difference between none and none2 is unknown       *
180          vcf_cutoff_ctrl_modwheel     = 0x81,  ///< Modulation Wheel (MIDI Controller 1)       * @see enumCount(), enumKey(), enumKeys(), enumValue()
181          vcf_cutoff_ctrl_effect1      = 0x8c,  ///< Effect Controller 1 (Coarse, MIDI Controller 12)       */
182          vcf_cutoff_ctrl_effect2      = 0x8d,  ///< Effect Controller 2 (Coarse, MIDI Controller 13)      GIG_DECLARE_ENUM(lfo3_ctrl_t,
183          vcf_cutoff_ctrl_breath       = 0x82,  ///< Breath Controller (Coarse, MIDI Controller 2)          lfo3_ctrl_internal            = 0x00, /**< Only internally controlled. */
184          vcf_cutoff_ctrl_foot         = 0x84,  ///< Foot Pedal (Coarse, MIDI Controller 4)          lfo3_ctrl_modwheel            = 0x01, /**< Only controlled by external modulation wheel. */
185          vcf_cutoff_ctrl_sustainpedal = 0xc0,  ///< Sustain Pedal (MIDI Controller 64)          lfo3_ctrl_aftertouch          = 0x02, /**< Only controlled by aftertouch controller. */
186          vcf_cutoff_ctrl_softpedal    = 0xc3,  ///< Soft Pedal (MIDI Controller 67)          lfo3_ctrl_internal_modwheel   = 0x03, /**< Controlled internally and by external modulation wheel. */
187          vcf_cutoff_ctrl_genpurpose7  = 0xd2,  ///< General Purpose Controller 7 (Button, MIDI Controller 82)          lfo3_ctrl_internal_aftertouch = 0x04  /**< Controlled internally and by aftertouch controller. */
188          vcf_cutoff_ctrl_genpurpose8  = 0xd3,  ///< General Purpose Controller 8 (Button, MIDI Controller 83)      );
189          vcf_cutoff_ctrl_aftertouch   = 0x80   ///< Key Pressure  
190      } vcf_cutoff_ctrl_t;      /** Defines how LFO2 is controlled by.
191         *
192      /** Defines how the filter resonance is controlled by. */       * @see enumCount(), enumKey(), enumKeys(), enumValue()
193      typedef enum {       */
194          vcf_res_ctrl_none        = 0xffffffff,      GIG_DECLARE_ENUM(lfo2_ctrl_t,
195          vcf_res_ctrl_genpurpose3 = 0,           ///< General Purpose Controller 3 (Slider, MIDI Controller 18)          lfo2_ctrl_internal            = 0x00, /**< Only internally controlled. */
196          vcf_res_ctrl_genpurpose4 = 1,           ///< General Purpose Controller 4 (Slider, MIDI Controller 19)          lfo2_ctrl_modwheel            = 0x01, /**< Only controlled by external modulation wheel. */
197          vcf_res_ctrl_genpurpose5 = 2,           ///< General Purpose Controller 5 (Button, MIDI Controller 80)          lfo2_ctrl_foot                = 0x02, /**< Only controlled by external foot controller. */
198          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. */
199      } vcf_res_ctrl_t;          lfo2_ctrl_internal_foot       = 0x04  /**< Controlled internally and by external foot controller. */
200        );
201    
202        /** Defines how LFO1 is controlled by.
203         *
204         * @see enumCount(), enumKey(), enumKeys(), enumValue()
205         */
206        GIG_DECLARE_ENUM(lfo1_ctrl_t,
207            lfo1_ctrl_internal            = 0x00, /**< Only internally controlled. */
208            lfo1_ctrl_modwheel            = 0x01, /**< Only controlled by external modulation wheel. */
209            lfo1_ctrl_breath              = 0x02, /**< Only controlled by external breath controller. */
210            lfo1_ctrl_internal_modwheel   = 0x03, /**< Controlled internally and by external modulation wheel. */
211            lfo1_ctrl_internal_breath     = 0x04  /**< Controlled internally and by external breath controller. */
212        );
213    
214        /** Defines how the filter cutoff frequency is controlled by.
215         *
216         * @see enumCount(), enumKey(), enumKeys(), enumValue()
217         */
218        GIG_DECLARE_ENUM(vcf_cutoff_ctrl_t,
219            vcf_cutoff_ctrl_none         = 0x00,  /**< No MIDI controller assigned for filter cutoff frequency. */
220            vcf_cutoff_ctrl_none2        = 0x01,  /**< The difference between none and none2 is unknown */
221            vcf_cutoff_ctrl_modwheel     = 0x81,  /**< Modulation Wheel (MIDI Controller 1) */
222            vcf_cutoff_ctrl_effect1      = 0x8c,  /**< Effect Controller 1 (Coarse, MIDI Controller 12) */
223            vcf_cutoff_ctrl_effect2      = 0x8d,  /**< Effect Controller 2 (Coarse, MIDI Controller 13) */
224            vcf_cutoff_ctrl_breath       = 0x82,  /**< Breath Controller (Coarse, MIDI Controller 2) */
225            vcf_cutoff_ctrl_foot         = 0x84,  /**< Foot Pedal (Coarse, MIDI Controller 4) */
226            vcf_cutoff_ctrl_sustainpedal = 0xc0,  /**< Sustain Pedal (MIDI Controller 64) */
227            vcf_cutoff_ctrl_softpedal    = 0xc3,  /**< Soft Pedal (MIDI Controller 67) */
228            vcf_cutoff_ctrl_genpurpose7  = 0xd2,  /**< General Purpose Controller 7 (Button, MIDI Controller 82) */
229            vcf_cutoff_ctrl_genpurpose8  = 0xd3,  /**< General Purpose Controller 8 (Button, MIDI Controller 83) */
230            vcf_cutoff_ctrl_aftertouch   = 0x80   /**< Key Pressure */
231        );
232    
233        /** Defines how the filter resonance is controlled by.
234         *
235         * @see enumCount(), enumKey(), enumKeys(), enumValue()
236         */
237        GIG_DECLARE_ENUM(vcf_res_ctrl_t,
238            vcf_res_ctrl_none        = 0xffffffff,  /**< No MIDI controller assigned for filter resonance. */
239            vcf_res_ctrl_genpurpose3 = 0,           /**< General Purpose Controller 3 (Slider, MIDI Controller 18) */
240            vcf_res_ctrl_genpurpose4 = 1,           /**< General Purpose Controller 4 (Slider, MIDI Controller 19) */
241            vcf_res_ctrl_genpurpose5 = 2,           /**< General Purpose Controller 5 (Button, MIDI Controller 80) */
242            vcf_res_ctrl_genpurpose6 = 3            /**< General Purpose Controller 6 (Button, MIDI Controller 81) */
243        );
244    
245      /**      /**
246       * Defines a controller that has a certain contrained influence on a       * Defines a controller that has a certain contrained influence on a
# Line 180  namespace gig { Line 251  namespace gig {
251       * 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!
252       */       */
253      struct leverage_ctrl_t {      struct leverage_ctrl_t {
254          typedef enum {          /** Defines possible controllers.
255              type_none              = 0x00, ///< No controller defined           *
256              type_channelaftertouch = 0x2f, ///< Channel Key Pressure           * @see enumCount(), enumKey(), enumKeys(), enumValue()
257              type_velocity          = 0xff, ///< Key Velocity           */
258              type_controlchange     = 0xfe  ///< Ordinary MIDI control change controller, see field 'controller_number'          GIG_DECLARE_ENUM(type_t,
259          } type_t;              type_none              = 0x00, /**< No controller defined */
260                type_channelaftertouch = 0x2f, /**< Channel Key Pressure */
261                type_velocity          = 0xff, /**< Key Velocity */
262                type_controlchange     = 0xfe  /**< Ordinary MIDI control change controller, see field 'controller_number' */
263            );
264    
265          type_t type;              ///< Controller type          type_t type;              ///< Controller type
266          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
267    
268            void serialize(Serialization::Archive* archive);
269      };      };
270    
271      /**      /**
# Line 218  namespace gig { Line 295  namespace gig {
295       * 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
296       * 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
297       * the samplechannel dimension which currently allows only 2 zones).       * the samplechannel dimension which currently allows only 2 zones).
298         *
299         * @see enumCount(), enumKey(), enumKeys(), enumValue()
300       */       */
301      typedef enum {      GIG_DECLARE_ENUM(dimension_t,
302          dimension_none              = 0x00, ///< Dimension not in use.          dimension_none              = 0x00, /**< Dimension not in use. */
303          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). */
304          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). */
305          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). */
306          dimension_channelaftertouch = 0x83, ///< Channel Key Pressure          dimension_channelaftertouch = 0x83, /**< Channel Key Pressure */
307          dimension_releasetrigger    = 0x84, ///< Special dimension for triggering samples on releasing a key.          dimension_releasetrigger    = 0x84, /**< Special dimension for triggering samples on releasing a key. */
308          dimension_keyboard          = 0x85, ///< Dimension for keyswitching          dimension_keyboard          = 0x85, /**< Dimension for keyswitching */
309          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 */
310          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 */
311          dimension_smartmidi         = 0x88, ///< For MIDI tools like legato and repetition mode          dimension_smartmidi         = 0x88, /**< For MIDI tools like legato and repetition mode */
312          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 */
313          dimension_modwheel          = 0x01, ///< Modulation Wheel (MIDI Controller 1)          dimension_modwheel          = 0x01, /**< Modulation Wheel (MIDI Controller 1) */
314          dimension_breath            = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)          dimension_breath            = 0x02, /**< Breath Controller (Coarse, MIDI Controller 2) */
315          dimension_foot              = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)          dimension_foot              = 0x04, /**< Foot Pedal (Coarse, MIDI Controller 4) */
316          dimension_portamentotime    = 0x05, ///< Portamento Time (Coarse, MIDI Controller 5)          dimension_portamentotime    = 0x05, /**< Portamento Time (Coarse, MIDI Controller 5) */
317          dimension_effect1           = 0x0c, ///< Effect Controller 1 (Coarse, MIDI Controller 12)          dimension_effect1           = 0x0c, /**< Effect Controller 1 (Coarse, MIDI Controller 12) */
318          dimension_effect2           = 0x0d, ///< Effect Controller 2 (Coarse, MIDI Controller 13)          dimension_effect2           = 0x0d, /**< Effect Controller 2 (Coarse, MIDI Controller 13) */
319          dimension_genpurpose1       = 0x10, ///< General Purpose Controller 1 (Slider, MIDI Controller 16)          dimension_genpurpose1       = 0x10, /**< General Purpose Controller 1 (Slider, MIDI Controller 16) */
320          dimension_genpurpose2       = 0x11, ///< General Purpose Controller 2 (Slider, MIDI Controller 17)          dimension_genpurpose2       = 0x11, /**< General Purpose Controller 2 (Slider, MIDI Controller 17) */
321          dimension_genpurpose3       = 0x12, ///< General Purpose Controller 3 (Slider, MIDI Controller 18)          dimension_genpurpose3       = 0x12, /**< General Purpose Controller 3 (Slider, MIDI Controller 18) */
322          dimension_genpurpose4       = 0x13, ///< General Purpose Controller 4 (Slider, MIDI Controller 19)          dimension_genpurpose4       = 0x13, /**< General Purpose Controller 4 (Slider, MIDI Controller 19) */
323          dimension_sustainpedal      = 0x40, ///< Sustain Pedal (MIDI Controller 64)          dimension_sustainpedal      = 0x40, /**< Sustain Pedal (MIDI Controller 64) */
324          dimension_portamento        = 0x41, ///< Portamento (MIDI Controller 65)          dimension_portamento        = 0x41, /**< Portamento (MIDI Controller 65) */
325          dimension_sostenutopedal    = 0x42, ///< Sostenuto Pedal (MIDI Controller 66)          dimension_sostenutopedal    = 0x42, /**< Sostenuto Pedal (MIDI Controller 66) */
326          dimension_softpedal         = 0x43, ///< Soft Pedal (MIDI Controller 67)          dimension_softpedal         = 0x43, /**< Soft Pedal (MIDI Controller 67) */
327          dimension_genpurpose5       = 0x30, ///< General Purpose Controller 5 (Button, MIDI Controller 80)          dimension_genpurpose5       = 0x30, /**< General Purpose Controller 5 (Button, MIDI Controller 80) */
328          dimension_genpurpose6       = 0x31, ///< General Purpose Controller 6 (Button, MIDI Controller 81)          dimension_genpurpose6       = 0x31, /**< General Purpose Controller 6 (Button, MIDI Controller 81) */
329          dimension_genpurpose7       = 0x32, ///< General Purpose Controller 7 (Button, MIDI Controller 82)          dimension_genpurpose7       = 0x32, /**< General Purpose Controller 7 (Button, MIDI Controller 82) */
330          dimension_genpurpose8       = 0x33, ///< General Purpose Controller 8 (Button, MIDI Controller 83)          dimension_genpurpose8       = 0x33, /**< General Purpose Controller 8 (Button, MIDI Controller 83) */
331          dimension_effect1depth      = 0x5b, ///< Effect 1 Depth (MIDI Controller 91)          dimension_effect1depth      = 0x5b, /**< Effect 1 Depth (MIDI Controller 91) */
332          dimension_effect2depth      = 0x5c, ///< Effect 2 Depth (MIDI Controller 92)          dimension_effect2depth      = 0x5c, /**< Effect 2 Depth (MIDI Controller 92) */
333          dimension_effect3depth      = 0x5d, ///< Effect 3 Depth (MIDI Controller 93)          dimension_effect3depth      = 0x5d, /**< Effect 3 Depth (MIDI Controller 93) */
334          dimension_effect4depth      = 0x5e, ///< Effect 4 Depth (MIDI Controller 94)          dimension_effect4depth      = 0x5e, /**< Effect 4 Depth (MIDI Controller 94) */
335          dimension_effect5depth      = 0x5f  ///< Effect 5 Depth (MIDI Controller 95)          dimension_effect5depth      = 0x5f  /**< Effect 5 Depth (MIDI Controller 95) */
336      } dimension_t;      );
337    
338      /**      /**
339       * Intended for internal usage: will be used to convert a dimension value       * Intended for internal usage: will be used to convert a dimension value
340       * into the corresponding dimension bit number.       * into the corresponding dimension bit number.
341         *
342         * @see enumCount(), enumKey(), enumKeys(), enumValue()
343       */       */
344      typedef enum {      GIG_DECLARE_ENUM(split_type_t,
345          split_type_normal,         ///< dimension value between 0-127          split_type_normal,         /**< dimension value between 0-127 */
346          split_type_bit             ///< dimension values are already the sought bit number          split_type_bit             /**< dimension values are already the sought bit number */
347      } split_type_t;      );
348    
349      /** General dimension definition. */      /** General dimension definition. */
350      struct dimension_def_t {      struct dimension_def_t {
# Line 274  namespace gig { Line 355  namespace gig {
355          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.
356      };      };
357    
358      /** Defines which frequencies are filtered by the VCF. */      /** Audio filter types.
359      typedef enum {       *
360          vcf_type_lowpass      = 0x00,       * The first 5 filter types are the ones which exist in GigaStudio, and
361          vcf_type_lowpassturbo = 0xff, ///< More poles than normal lowpass       * which are very accurately modeled on LinuxSampler side such that they
362          vcf_type_bandpass     = 0x01,       * would sound with LinuxSampler exactly as with GigaStudio.
363          vcf_type_highpass     = 0x02,       *
364          vcf_type_bandreject   = 0x03       * The other filter types listed here are extensions to the gig format and
365      } vcf_type_t;       * are LinuxSampler specific filter type implementations. Note that none of
366         * these are duplicates of the GigaStudio filter types. For instance
367         * @c vcf_type_lowpass (GigaStudio) and @c vcf_type_lowpass_2p
368         * (LinuxSampler) are both lowpass filters with 2 poles, however they do
369         * sound differently.
370         *
371         * @see enumCount(), enumKey(), enumKeys(), enumValue()
372         */
373        GIG_DECLARE_ENUM(vcf_type_t,
374            vcf_type_lowpass       = 0x00, /**< Standard lowpass filter type (GigaStudio). */
375            vcf_type_lowpassturbo  = 0xff, /**< More poles than normal lowpass (GigaStudio). */
376            vcf_type_bandpass      = 0x01, /**< Bandpass filter type (GigaStudio). */
377            vcf_type_highpass      = 0x02, /**< Highpass filter type (GigaStudio). */
378            vcf_type_bandreject    = 0x03, /**< Band reject filter type (GigaStudio). */
379            vcf_type_lowpass_1p    = 0x11, /**< [gig extension]: 1-pole lowpass filter type (LinuxSampler). */
380            vcf_type_lowpass_2p    = 0x12, /**< [gig extension]: 2-pole lowpass filter type (LinuxSampler). */
381            vcf_type_lowpass_4p    = 0x14, /**< [gig extension]: 4-pole lowpass filter type (LinuxSampler). */
382            vcf_type_lowpass_6p    = 0x16, /**< [gig extension]: 6-pole lowpass filter type (LinuxSampler). */
383            vcf_type_highpass_1p   = 0x21, /**< [gig extension]: 1-pole highpass filter type (LinuxSampler). */
384            vcf_type_highpass_2p   = 0x22, /**< [gig extension]: 2-pole highpass filter type (LinuxSampler). */
385            vcf_type_highpass_4p   = 0x24, /**< [gig extension]: 4-pole highpass filter type (LinuxSampler). */
386            vcf_type_highpass_6p   = 0x26, /**< [gig extension]: 6-pole highpass filter type (LinuxSampler). */
387            vcf_type_bandpass_2p   = 0x32, /**< [gig extension]: 2-pole bandpass filter type (LinuxSampler). */
388            vcf_type_bandreject_2p = 0x42  /**< [gig extension]: 2-pole bandreject filter type (LinuxSampler). */
389        );
390    
391      /**      /**
392       * Defines the envelope of a crossfade.       * Defines the envelope of a crossfade.
# Line 302  namespace gig { Line 407  namespace gig {
407          uint8_t out_start;  ///< Start position of fade out.          uint8_t out_start;  ///< Start position of fade out.
408          uint8_t out_end;    ///< End postition of fade out.          uint8_t out_end;    ///< End postition of fade out.
409          #endif // WORDS_BIGENDIAN          #endif // WORDS_BIGENDIAN
410    
411            void serialize(Serialization::Archive* archive);
412      };      };
413    
414      /** Reflects the current playback state for a sample. */      /** Reflects the current playback state for a sample. */
415      struct playback_state_t {      struct playback_state_t {
416          unsigned long position;          ///< Current position within the sample.          file_offset_t position;          ///< Current position within the sample.
417          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).
418          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.
419      };      };
420    
421      /**      /**
422       * @brief Used for indicating the progress of a certain task.       * Defines behavior options for envelope generators (gig format extension).
423       *       *
424       * The function pointer argument has to be supplied with a valid       * These options allow to override the precise default behavior of the
425       * function of the given signature which will then be called on       * envelope generators' state machines.
426       * progress changes. An equivalent progress_t structure will be passed       *
427       * back as argument to the callback function on each progress change.       * @b Note: These EG options are an extension to the original gig file
428       * The factor field of the supplied progress_t structure will then       * format, so these options are not available with the original
429       * reflect the current progress as value between 0.0 and 1.0. You might       * Gigasampler/GigaStudio software! Currently only LinuxSampler and gigedit
430       * want to use the custom field for data needed in your callback       * support these EG options!
431       * function.       *
432       */       * Adding these options to the original gig file format was necessary,
433      struct progress_t {       * because the precise state machine behavior of envelope generators of the
434          void (*callback)(progress_t*); ///< Callback function pointer which has to be assigned to a function for progress notification.       * gig format (and thus the default EG behavior if not explicitly overridden
435          float factor;                  ///< Reflects current progress as value between 0.0 and 1.0.       * here) deviates from common, expected behavior of envelope generators in
436          void* custom;                  ///< This pointer can be used for arbitrary data.       * general, if i.e. compared with EGs of hardware synthesizers. For example
437          float __range_min;             ///< Only for internal usage, do not modify!       * with the gig format, the attack and decay stages will be aborted as soon
438          float __range_max;             ///< Only for internal usage, do not modify!       * as a note-off is received. Most other EG implementations in the industry
439          progress_t();       * however always run the attack and decay stages to their full duration,
440         * even if an early note-off arrives. The latter behavior is intentionally
441         * implemented in most other products, because it is required to resemble
442         * percussive sounds in a realistic manner.
443         */
444        struct eg_opt_t {
445            bool AttackCancel;     ///< Whether the "attack" stage is cancelled when receiving a note-off (default: @c true).
446            bool AttackHoldCancel; ///< Whether the "attack hold" stage is cancelled when receiving a note-off (default: @c true).
447            bool Decay1Cancel;     ///< Whether the "decay 1" stage is cancelled when receiving a note-off (default: @c true).
448            bool Decay2Cancel;     ///< Whether the "decay 2" stage is cancelled when receiving a note-off (default: @c true).
449            bool ReleaseCancel;    ///< Whether the "release" stage is cancelled when receiving a note-on (default: @c true).
450    
451            eg_opt_t();
452            void serialize(Serialization::Archive* archive);
453      };      };
454    
455        /** @brief Defines behaviour of release triggered sample(s) on sustain pedal up event.
456         *
457         * This option defines whether a sustain pedal up event (CC#64) would cause
458         * release triggered samples to be played (if any).
459         *
460         * @b Note: This option is an extension to the original gig file format,
461         * so this option is not available with the original Gigasampler/GigaStudio
462         * software! Currently only LinuxSampler and gigedit support this option!
463         *
464         * By default (which equals the original Gigasampler/GigaStudio behaviour)
465         * no release triggered samples are played if the sustain pedal is released.
466         * So usually in the gig format release triggered samples are only played
467         * on MIDI note-off events.
468         *
469         * @see enumCount(), enumKey(), enumKeys(), enumValue()
470         */
471        GIG_DECLARE_ENUM(sust_rel_trg_t,
472            sust_rel_trg_none        = 0x00, /**< No release triggered sample(s) are played on sustain pedal up (default). */
473            sust_rel_trg_maxvelocity = 0x01, /**< Play release trigger sample(s) on sustain pedal up, and simply use 127 as MIDI velocity for playback. */
474            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. */
475        );
476    
477      // just symbol prototyping      // just symbol prototyping
478      class File;      class File;
479      class Instrument;      class Instrument;
# Line 341  namespace gig { Line 483  namespace gig {
483      class Script;      class Script;
484      class ScriptGroup;      class ScriptGroup;
485    
486      /** @brief Encapsulates articulation information of a dimension region.      /** @brief Encapsulates articulation informations of a dimension region.
487         *
488         * This is the most important data object of the Gigasampler / GigaStudio
489         * format. A DimensionRegion provides the link to the sample to be played
490         * and all required articulation informations to be interpreted for playing
491         * back the sample and processing it appropriately by the sampler software.
492         * Every Region of a Gigasampler Instrument has at least one dimension
493         * region (exactly then when the Region has no dimension defined). Many
494         * Regions though provide more than one DimensionRegion, which reflect
495         * different playing "cases". For example a different sample might be played
496         * if a certain pedal is pressed down, or if the note was triggered with
497         * different velocity.
498       *       *
499       *  Every Gigasampler Instrument has at least one dimension region       * One instance of a DimensionRegion reflects exactly one particular case
500       *  (exactly then when it has no dimension defined).       * while playing an instrument (for instance "note between C3 and E3 was
501         * triggered AND note on velocity was between 20 and 42 AND modulation wheel
502         * controller is between 80 and 127). The DimensionRegion defines what to do
503         * under that one particular case, that is which sample to play back and how
504         * to play that sample back exactly and how to process it. So a
505         * DimensionRegion object is always linked to exactly one sample. It may
506         * however also link to no sample at all, for defining a "silence" case
507         * where nothing shall be played (for example when note on velocity was
508         * below 6).
509       *       *
510       *  Gigasampler provides three Envelope Generators and Low Frequency       * Note that a DimensionRegion object only defines "what to do", but it does
511       *  Oscillators:       * not define "when to do it". To actually resolve which DimensionRegion to
512         * pick under which situation, you need to refer to the DimensionRegions'
513         * parent Region object. The Region object contains the necessary
514         * "Dimension" definitions, which in turn define which DimensionRegion is
515         * associated with which playing case exactly.
516         *
517         * The Gigasampler/GigaStudio format defines 3 Envelope Generators and 3
518         * Low Frequency Oscillators:
519       *       *
520       *  - EG1 and LFO1, both controlling sample amplitude       *  - EG1 and LFO1, both controlling sample amplitude
521       *  - EG2 and LFO2, both controlling filter cutoff frequency       *  - EG2 and LFO2, both controlling filter cutoff frequency
522       *  - EG3 and LFO3, both controlling sample pitch       *  - EG3 and LFO3, both controlling sample pitch
523         *
524         * Since the gig format was designed as extension to the DLS file format,
525         * this class is derived from the DLS::Sampler class. So also refer to
526         * DLS::Sampler for additional informations, class attributes and methods.
527       */       */
528      class DimensionRegion : protected DLS::Sampler {      class DimensionRegion : protected DLS::Sampler {
529          public:          public:
# Line 371  namespace gig { Line 543  namespace gig {
543              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).
544              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).
545              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).
546                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).
547              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).
548                double             LFO1Phase;                     ///< [gig extension]: Phase displacement of the amplitude LFO's wave form (0.0° - 360.0°).
549              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).
550              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).
551              lfo1_ctrl_t        LFO1Controller;                ///< MIDI Controller which controls sample amplitude LFO.              lfo1_ctrl_t        LFO1Controller;                ///< MIDI Controller which controls sample amplitude LFO.
552              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.
553              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.
554              // Filter Cutoff Frequency EG/LFO              // Filter Cutoff Frequency EG/LFO
555              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 390  namespace gig { Line 564  namespace gig {
564              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).
565              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).
566              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).
567                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).
568              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).
569                double             LFO2Phase;                     ///< [gig extension]: Phase displacement of the filter cutoff LFO's wave form (0.0° - 360.0°).
570              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).
571              uint16_t           LFO2ControlDepth;              ///< Controller depth influencing filter cutoff LFO pitch (0 - 1200).              uint16_t           LFO2ControlDepth;              ///< Controller depth influencing filter cutoff LFO pitch (0 - 1200).
572              lfo2_ctrl_t        LFO2Controller;                ///< MIDI Controlle which controls the filter cutoff LFO.              lfo2_ctrl_t        LFO2Controller;                ///< MIDI Controlle which controls the filter cutoff LFO.
573              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.
574              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.
575              // Sample Pitch EG/LFO              // Sample Pitch EG/LFO
576              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).
577              int16_t            EG3Depth;                      ///< Depth of the sample pitch EG (-1200 - +1200).              int16_t            EG3Depth;                      ///< Depth of the sample pitch EG (-1200 - +1200).
578                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).
579              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).
580                double             LFO3Phase;                     ///< [gig extension]: Phase displacement of the pitch LFO's wave form (0.0° - 360.0°).
581              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).
582              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).
583              lfo3_ctrl_t        LFO3Controller;                ///< MIDI Controller which controls the sample pitch LFO.              lfo3_ctrl_t        LFO3Controller;                ///< MIDI Controller which controls the sample pitch LFO.
584                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).
585              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.
586              // Filter              // Filter
587              bool               VCFEnabled;                    ///< If filter should be used.              bool               VCFEnabled;                    ///< If filter should be used.
# Line 440  namespace gig { Line 619  namespace gig {
619              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).
620              double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)              double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)
621              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).
622                eg_opt_t           EG1Options;                    ///< [gig extension]: Behavior options which should be used for envelope generator 1 (volume amplitude EG).
623                eg_opt_t           EG2Options;                    ///< [gig extension]: Behavior options which should be used for envelope generator 2 (filter cutoff EG).
624                sust_rel_trg_t     SustainReleaseTrigger;         ///< [gig extension]: Whether a sustain pedal up event shall play release trigger sample.
625                bool               NoNoteOffReleaseTrigger;       ///< [gig extension]: If @c true then don't play a release trigger sample on MIDI note-off events.
626    
627              // derived attributes from DLS::Sampler              // derived attributes from DLS::Sampler
628              using DLS::Sampler::UnityNote;              using DLS::Sampler::UnityNote;
# Line 466  namespace gig { Line 649  namespace gig {
649              using DLS::Sampler::AddSampleLoop;              using DLS::Sampler::AddSampleLoop;
650              using DLS::Sampler::DeleteSampleLoop;              using DLS::Sampler::DeleteSampleLoop;
651              // overridden methods              // overridden methods
652              virtual void SetGain(int32_t gain);              virtual void SetGain(int32_t gain) OVERRIDE;
653              virtual void UpdateChunks();              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
654              virtual void CopyAssign(const DimensionRegion* orig);              virtual void CopyAssign(const DimensionRegion* orig);
655          protected:          protected:
656              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 475  namespace gig { Line 658  namespace gig {
658              DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);              DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);
659             ~DimensionRegion();             ~DimensionRegion();
660              void CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples);              void CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples);
661                void serialize(Serialization::Archive* archive);
662              friend class Region;              friend class Region;
663                friend class Serialization::Archive;
664          private:          private:
665              typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller              typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller
666                  // 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 578  namespace gig { Line 763  namespace gig {
763              } _lev_ctrl_t;              } _lev_ctrl_t;
764              typedef std::map<uint32_t, double*> VelocityTableMap;              typedef std::map<uint32_t, double*> VelocityTableMap;
765    
766              static uint              Instances;                  ///< Number of DimensionRegion instances.              static size_t            Instances;                  ///< Number of DimensionRegion instances.
767              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).
768              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.
769              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 591  namespace gig { Line 776  namespace gig {
776              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);
777              double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);              double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
778              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
779                bool UsesAnyGigFormatExtension() const;
780      };      };
781    
782      /** @brief Encapsulates sample waves used for playback.      /** @brief Encapsulates sample waves of Gigasampler/GigaStudio files used for playback.
783         *
784         * This class provides access to the actual audio sample data of a
785         * Gigasampler/GigaStudio file. Along to the actual sample data, it also
786         * provides access to the sample's meta informations like bit depth,
787         * sample rate, encoding type, but also loop informations. The latter may be
788         * used by instruments for resembling sounds with arbitary note lengths.
789       *       *
790       * In case you created a new sample with File::AddSample(), you should       * In case you created a new sample with File::AddSample(), you should
791       * first update all attributes with the desired meta informations       * first update all attributes with the desired meta informations
# Line 607  namespace gig { Line 799  namespace gig {
799       * retrieved from the respective DimensionRegon instead from the Sample       * retrieved from the respective DimensionRegon instead from the Sample
800       * itself. This was made for allowing different loop definitions for the       * itself. This was made for allowing different loop definitions for the
801       * same sample under different conditions.       * same sample under different conditions.
802         *
803         * Since the gig format was designed as extension to the DLS file format,
804         * this class is derived from the DLS::Sample class. So also refer to
805         * DLS::Sample for additional informations, class attributes and methods.
806       */       */
807      class Sample : public DLS::Sample {      class Sample : public DLS::Sample {
808          public:          public:
# Line 631  namespace gig { Line 827  namespace gig {
827    
828              // own methods              // own methods
829              buffer_t      LoadSampleData();              buffer_t      LoadSampleData();
830              buffer_t      LoadSampleData(unsigned long SampleCount);              buffer_t      LoadSampleData(file_offset_t SampleCount);
831              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
832              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(file_offset_t SampleCount, uint NullSamplesCount);
833              buffer_t      GetCache();              buffer_t      GetCache();
834              // own static methods              // own static methods
835              static buffer_t CreateDecompressionBuffer(unsigned long MaxReadSize);              static buffer_t CreateDecompressionBuffer(file_offset_t MaxReadSize);
836              static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);              static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
837              // overridden methods              // overridden methods
838              void          ReleaseSampleData();              void          ReleaseSampleData();
839              void          Resize(int iNewSize);              void          Resize(file_offset_t NewSize);
840              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);
841              unsigned long GetPos() const;              file_offset_t GetPos() const;
842              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);
843              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);
844              unsigned long Write(void* pBuffer, unsigned long SampleCount);              file_offset_t Write(void* pBuffer, file_offset_t SampleCount);
845              Group*        GetGroup() const;              Group*        GetGroup() const;
846              virtual void  UpdateChunks();              virtual void  UpdateChunks(progress_t* pProgress) OVERRIDE;
847              void CopyAssignMeta(const Sample* orig);              void CopyAssignMeta(const Sample* orig);
848              void CopyAssignWave(const Sample* orig);              void CopyAssignWave(const Sample* orig);
849                uint32_t GetWaveDataCRC32Checksum();
850                bool VerifyWaveData(uint32_t* pActually = NULL);
851          protected:          protected:
852              static unsigned int  Instances;               ///< Number of instances of class Sample.              static size_t        Instances;               ///< Number of instances of class Sample.
853              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.
854              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)
855              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).
856              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.
857              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).
858              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.
859              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.
860              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.
861              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.
862              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)
863              RIFF::Chunk*         pCk3gix;              RIFF::Chunk*         pCk3gix;
864              RIFF::Chunk*         pCkSmpl;              RIFF::Chunk*         pCkSmpl;
865              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().
866    
867              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);
868             ~Sample();             ~Sample();
869                uint32_t CalculateWaveDataChecksum();
870    
871              // Guess size (in bytes) of a compressed sample              // Guess size (in bytes) of a compressed sample
872              inline unsigned long GuessSize(unsigned long samples) {              inline file_offset_t GuessSize(file_offset_t samples) {
873                  // 16 bit: assume all frames are compressed - 1 byte                  // 16 bit: assume all frames are compressed - 1 byte
874                  // per sample and 5 bytes header per 2048 samples                  // per sample and 5 bytes header per 2048 samples
875    
876                  // 24 bit: assume next best compression rate - 1.5                  // 24 bit: assume next best compression rate - 1.5
877                  // bytes per sample and 13 bytes header per 256                  // bytes per sample and 13 bytes header per 256
878                  // samples                  // samples
879                  const unsigned long size =                  const file_offset_t size =
880                      BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13                      BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
881                                     : samples + (samples >> 10) * 5;                                     : samples + (samples >> 10) * 5;
882                  // Double for stereo and add one worst case sample                  // Double for stereo and add one worst case sample
# Line 687  namespace gig { Line 886  namespace gig {
886    
887              // Worst case amount of sample points that can be read with the              // Worst case amount of sample points that can be read with the
888              // given decompression buffer.              // given decompression buffer.
889              inline unsigned long WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {              inline file_offset_t WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
890                  return (unsigned long) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);                  return (file_offset_t) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
891              }              }
892          private:          private:
893              void ScanCompressedSample();              void ScanCompressedSample();
# Line 698  namespace gig { Line 897  namespace gig {
897      };      };
898    
899      // 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)
900      /** @brief Defines Region information of an Instrument.      /** @brief Defines Region information of a Gigasampler/GigaStudio instrument.
901       *       *
902       * A Region reflects a consecutive area on the keyboard. The individual       * A Region reflects a consecutive area (key range) on the keyboard. The
903       * 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
904       * 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
905       * for DimensionRegions (a.k.a. "Cases"). The Region itself does not provide       * merely a container for DimensionRegions (a.k.a. "Cases"). The Region
906       * the sample mapping or articulation informations used, even though the       * itself does not provide the sample mapping or articulation informations
907       * data structures indeed provide such informations. The latter is however       * used, even though the data structures of regions indeed provide such
908       * just of historical nature, because the gig format was derived from the       * informations. The latter is however just of historical nature, because
909       * DLS format.       * the gig file format was derived from the DLS file format.
910       *       *
911       * Each Region consists of at least one or more DimensionRegions. The actual       * Each Region consists of at least one or more DimensionRegions. The actual
912       * amount of DimensionRegions depends on which kind of "dimensions" are       * amount of DimensionRegions depends on which kind of "dimensions" are
913       * 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
914       * dimensions.       * dimensions.
915         *
916         * Since the gig format was designed as extension to the DLS file format,
917         * this class is derived from the DLS::Region class. So also refer to
918         * DLS::Region for additional informations, class attributes and methods.
919       */       */
920      class Region : public DLS::Region {      class Region : public DLS::Region {
921          public:          public:
# Line 732  namespace gig { Line 935  namespace gig {
935              dimension_def_t* GetDimensionDefinition(dimension_t type);              dimension_def_t* GetDimensionDefinition(dimension_t type);
936              void             DeleteDimensionZone(dimension_t type, int zone);              void             DeleteDimensionZone(dimension_t type, int zone);
937              void             SplitDimensionZone(dimension_t type, int zone);              void             SplitDimensionZone(dimension_t type, int zone);
938                void             SetDimensionType(dimension_t oldType, dimension_t newType);
939              // overridden methods              // overridden methods
940              virtual void     SetKeyRange(uint16_t Low, uint16_t High);              virtual void     SetKeyRange(uint16_t Low, uint16_t High) OVERRIDE;
941              virtual void     UpdateChunks();              virtual void     UpdateChunks(progress_t* pProgress) OVERRIDE;
942              virtual void     CopyAssign(const Region* orig);              virtual void     CopyAssign(const Region* orig);
943          protected:          protected:
944              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
# Line 747  namespace gig { Line 951  namespace gig {
951              friend class Instrument;              friend class Instrument;
952      };      };
953    
954      /** Abstract base class for all MIDI rules. */      /** @brief Abstract base class for all MIDI rules.
955         *
956         * Note: Instead of using MIDI rules, we recommend you using real-time
957         * instrument scripts instead. Read about the reasons below.
958         *
959         * MIDI Rules (also called "iMIDI rules" or "intelligent MIDI rules") were
960         * introduced with GigaStudio 4 as an attempt to increase the power of
961         * potential user controls over sounds. At that point other samplers already
962         * supported certain powerful user control features, which were not possible
963         * with GigaStudio yet. For example triggering new notes by MIDI CC
964         * controller.
965         *
966         * Such extended features however were usually implemented by other samplers
967         * by requiring the sound designer to write an instrument script which the
968         * designer would then bundle with the respective instrument file. Such
969         * scripts are essentially text files, using a very specific programming
970         * language for the purpose of controlling the sampler in real-time. Since
971         * however musicians are not typically keen to writing such cumbersome
972         * script files, the GigaStudio designers decided to implement such extended
973         * features completely without instrument scripts. Instead they created a
974         * set of rules, which could be defined and altered conveniently by mouse
975         * clicks in GSt's instrument editor application. The downside of this
976         * overall approach however, was that those MIDI rules were very limited in
977         * practice. As sound designer you easily came across the possiblities such
978         * MIDI rules were able to offer.
979         *
980         * Due to such severe use case constraints, support for MIDI rules is quite
981         * limited in libgig. At the moment only the "Control Trigger", "Alternator"
982         * and the "Legato" MIDI rules are supported by libgig. Consequently the
983         * graphical instrument editor application gigedit just supports the
984         * "Control Trigger" and "Legato" MIDI rules, and LinuxSampler even does not
985         * support any MIDI rule type at all and LinuxSampler probably will not
986         * support MIDI rules in future either.
987         *
988         * Instead of using MIDI rules, we introduced real-time instrument scripts
989         * as extension to the original GigaStudio file format. This script based
990         * solution is much more powerful than MIDI rules and is already supported
991         * by libgig, gigedit and LinuxSampler.
992         *
993         * @deprecated Just provided for backward compatiblity, use Script for new
994         *             instruments instead.
995         */
996      class MidiRule {      class MidiRule {
997          public:          public:
998              virtual ~MidiRule() { }              virtual ~MidiRule() { }
# Line 756  namespace gig { Line 1001  namespace gig {
1001              friend class Instrument;              friend class Instrument;
1002      };      };
1003    
1004      /** MIDI rule for triggering notes by control change events. */      /** @brief MIDI rule for triggering notes by control change events.
1005         *
1006         * A "Control Trigger MIDI rule" allows to trigger new notes by sending MIDI
1007         * control change events to the sampler.
1008         *
1009         * Note: "Control Trigger" MIDI rules are only supported by gigedit, but not
1010         * by LinuxSampler. We recommend you using real-time instrument scripts
1011         * instead. Read more about the details and reasons for this in the
1012         * description of the MidiRule base class.
1013         *
1014         * @deprecated Just provided for backward compatiblity, use Script for new
1015         *             instruments instead. See description of MidiRule for details.
1016         */
1017      class MidiRuleCtrlTrigger : public MidiRule {      class MidiRuleCtrlTrigger : public MidiRule {
1018          public:          public:
1019              uint8_t ControllerNumber;   ///< MIDI controller number.              uint8_t ControllerNumber;   ///< MIDI controller number.
# Line 774  namespace gig { Line 1031  namespace gig {
1031          protected:          protected:
1032              MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg);              MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg);
1033              MidiRuleCtrlTrigger();              MidiRuleCtrlTrigger();
1034              void UpdateChunks(uint8_t* pData) const;              void UpdateChunks(uint8_t* pData) const OVERRIDE;
1035              friend class Instrument;              friend class Instrument;
1036      };      };
1037    
1038      /** MIDI rule for instruments with legato samples. */      /** @brief MIDI rule for instruments with legato samples.
1039         *
1040         * A "Legato MIDI rule" allows playing instruments resembling the legato
1041         * playing technique. In the past such legato articulations were tried to be
1042         * simulated by pitching the samples of the instrument. However since
1043         * usually a high amount of pitch is needed for legatos, this always sounded
1044         * very artificial and unrealistic. The "Legato MIDI rule" thus uses another
1045         * approach. Instead of pitching the samples, it allows the sound designer
1046         * to bundle separate, additional samples for the individual legato
1047         * situations and the legato rules defined which samples to be played in
1048         * which situation.
1049         *
1050         * Note: "Legato MIDI rules" are only supported by gigedit, but not
1051         * by LinuxSampler. We recommend you using real-time instrument scripts
1052         * instead. Read more about the details and reasons for this in the
1053         * description of the MidiRule base class.
1054         *
1055         * @deprecated Just provided for backward compatiblity, use Script for new
1056         *             instruments instead. See description of MidiRule for details.
1057         */
1058      class MidiRuleLegato : public MidiRule {      class MidiRuleLegato : public MidiRule {
1059          public:          public:
1060              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 795  namespace gig { Line 1071  namespace gig {
1071          protected:          protected:
1072              MidiRuleLegato(RIFF::Chunk* _3ewg);              MidiRuleLegato(RIFF::Chunk* _3ewg);
1073              MidiRuleLegato();              MidiRuleLegato();
1074              void UpdateChunks(uint8_t* pData) const;              void UpdateChunks(uint8_t* pData) const OVERRIDE;
1075              friend class Instrument;              friend class Instrument;
1076      };      };
1077    
1078      /** 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.
1079         *
1080         * The instrument must be using the smartmidi dimension.
1081         *
1082         * Note: "Alternator" MIDI rules are neither supported by gigedit nor by
1083         * LinuxSampler. We recommend you using real-time instrument scripts
1084         * instead. Read more about the details and reasons for this in the
1085         * description of the MidiRule base class.
1086         *
1087         * @deprecated Just provided for backward compatiblity, use Script for new
1088         *             instruments instead. See description of MidiRule for details.
1089         */
1090      class MidiRuleAlternator : public MidiRule {      class MidiRuleAlternator : public MidiRule {
1091          public:          public:
1092              uint8_t Articulations;     ///< Number of articulations in the instrument              uint8_t Articulations;     ///< Number of articulations in the instrument
# Line 836  namespace gig { Line 1123  namespace gig {
1123          protected:          protected:
1124              MidiRuleAlternator(RIFF::Chunk* _3ewg);              MidiRuleAlternator(RIFF::Chunk* _3ewg);
1125              MidiRuleAlternator();              MidiRuleAlternator();
1126              void UpdateChunks(uint8_t* pData) const;              void UpdateChunks(uint8_t* pData) const OVERRIDE;
1127              friend class Instrument;              friend class Instrument;
1128      };      };
1129    
1130      /** A MIDI rule not yet implemented by libgig. */      /** @brief A MIDI rule not yet implemented by libgig.
1131         *
1132         * This class is currently used as a place holder by libgig for MIDI rule
1133         * types which are not supported by libgig yet.
1134         *
1135         * Note: Support for missing MIDI rule types are probably never added to
1136         * libgig. We recommend you using real-time instrument scripts instead.
1137         * Read more about the details and reasons for this in the description of
1138         * the MidiRule base class.
1139         *
1140         * @deprecated Just provided for backward compatiblity, use Script for new
1141         *             instruments instead. See description of MidiRule for details.
1142         */
1143      class MidiRuleUnknown : public MidiRule {      class MidiRuleUnknown : public MidiRule {
1144          protected:          protected:
1145              MidiRuleUnknown() { }              MidiRuleUnknown() { }
1146              void UpdateChunks(uint8_t* pData) const { }              void UpdateChunks(uint8_t* pData) const OVERRIDE { }
1147              friend class Instrument;              friend class Instrument;
1148      };      };
1149    
# Line 857  namespace gig { Line 1156  namespace gig {
1156       *       *
1157       * This is an extension of the GigaStudio format, thus a feature which was       * This is an extension of the GigaStudio format, thus a feature which was
1158       * not available in the GigaStudio 4 software. It is currently only       * not available in the GigaStudio 4 software. It is currently only
1159       * supported by LinuxSampler and gigedit.       * supported by LinuxSampler and gigedit. Scripts will not load with the
1160         * original GigaStudio software.
1161         *
1162         * You find more informations about Instrument Scripts on the LinuxSampler
1163         * documentation site:
1164         *
1165         * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/">About Instrument Scripts in General</a>
1166         * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language">Introduction to the NKSP Script Language</a>
1167         * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language/Reference/">NKSP Reference Manual</a>
1168         * - <a href="http://doc.linuxsampler.org/Gigedit/Managing_Scripts">Using Instrument Scripts with Gigedit</a>
1169       */       */
1170      class Script {      class Script : protected DLS::Storage {
1171          public:          public:
1172              enum Encoding_t {              enum Encoding_t {
1173                  ENCODING_ASCII = 0 ///< Standard 8 bit US ASCII character encoding (default).                  ENCODING_ASCII = 0 ///< Standard 8 bit US ASCII character encoding (default).
# Line 868  namespace gig { Line 1176  namespace gig {
1176                  COMPRESSION_NONE = 0 ///< Is not compressed at all (default).                  COMPRESSION_NONE = 0 ///< Is not compressed at all (default).
1177              };              };
1178              enum Language_t {              enum Language_t {
1179                  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.
1180              };              };
1181    
1182              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 880  namespace gig { Line 1188  namespace gig {
1188              String GetScriptAsText();              String GetScriptAsText();
1189              void   SetScriptAsText(const String& text);              void   SetScriptAsText(const String& text);
1190              void   SetGroup(ScriptGroup* pGroup);              void   SetGroup(ScriptGroup* pGroup);
1191                ScriptGroup* GetGroup() const;
1192                void   CopyAssign(const Script* orig);
1193          protected:          protected:
1194              Script(ScriptGroup* group, RIFF::Chunk* ckScri);              Script(ScriptGroup* group, RIFF::Chunk* ckScri);
1195              virtual ~Script();              virtual ~Script();
1196              void UpdateChunks();              void UpdateChunks(progress_t* pProgress) OVERRIDE;
1197                void DeleteChunks() OVERRIDE;
1198              void RemoveAllScriptReferences();              void RemoveAllScriptReferences();
1199              friend class ScriptGroup;              friend class ScriptGroup;
1200              friend class Instrument;              friend class Instrument;
# Line 905  namespace gig { Line 1216  namespace gig {
1216       * not available in the GigaStudio 4 software. It is currently only       * not available in the GigaStudio 4 software. It is currently only
1217       * supported by LinuxSampler and gigedit.       * supported by LinuxSampler and gigedit.
1218       */       */
1219      class ScriptGroup {      class ScriptGroup : protected DLS::Storage {
1220          public:          public:
1221              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.
1222    
# Line 916  namespace gig { Line 1227  namespace gig {
1227              ScriptGroup(File* file, RIFF::List* lstRTIS);              ScriptGroup(File* file, RIFF::List* lstRTIS);
1228              virtual ~ScriptGroup();              virtual ~ScriptGroup();
1229              void LoadScripts();              void LoadScripts();
1230              void UpdateChunks();              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
1231                virtual void DeleteChunks() OVERRIDE;
1232              friend class Script;              friend class Script;
1233              friend class File;              friend class File;
1234          private:          private:
# Line 925  namespace gig { Line 1237  namespace gig {
1237              std::list<Script*>*  pScripts;              std::list<Script*>*  pScripts;
1238      };      };
1239    
1240      /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */      /** @brief Provides access to a Gigasampler/GigaStudio instrument.
1241         *
1242         * This class provides access to Gigasampler/GigaStudio instruments
1243         * contained in .gig files. A gig instrument is merely a set of keyboard
1244         * ranges (called Region), plus some additional global informations about
1245         * the instrument. The major part of the actual instrument definition used
1246         * for the synthesis of the instrument is contained in the respective Region
1247         * object (or actually in the respective DimensionRegion object being, see
1248         * description of Region for details).
1249         *
1250         * Since the gig format was designed as extension to the DLS file format,
1251         * this class is derived from the DLS::Instrument class. So also refer to
1252         * DLS::Instrument for additional informations, class attributes and
1253         * methods.
1254         */
1255      class Instrument : protected DLS::Instrument {      class Instrument : protected DLS::Instrument {
1256          public:          public:
1257              // derived attributes from DLS::Resource              // derived attributes from DLS::Resource
# Line 954  namespace gig { Line 1280  namespace gig {
1280              Region*   GetNextRegion();              Region*   GetNextRegion();
1281              Region*   AddRegion();              Region*   AddRegion();
1282              void      DeleteRegion(Region* pRegion);              void      DeleteRegion(Region* pRegion);
1283              virtual void UpdateChunks();              void      MoveTo(Instrument* dst);
1284                virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
1285              virtual void CopyAssign(const Instrument* orig);              virtual void CopyAssign(const Instrument* orig);
1286              // own methods              // own methods
1287              Region*   GetRegion(unsigned int Key);              Region*   GetRegion(unsigned int Key);
# Line 980  namespace gig { Line 1307  namespace gig {
1307              void CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples);              void CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples);
1308              void UpdateRegionKeyTable();              void UpdateRegionKeyTable();
1309              void LoadScripts();              void LoadScripts();
1310                void UpdateScriptFileOffsets();
1311              friend class File;              friend class File;
1312              friend class Region; // so Region can call UpdateRegionKeyTable()              friend class Region; // so Region can call UpdateRegionKeyTable()
1313          private:          private:
# Line 996  namespace gig { Line 1324  namespace gig {
1324              std::vector<_ScriptPooolRef>* pScriptRefs;              std::vector<_ScriptPooolRef>* pScriptRefs;
1325      };      };
1326    
1327      /** @brief Group of Gigasampler objects      /** @brief Group of Gigasampler samples
1328       *       *
1329       * Groups help to organize a huge collection of Gigasampler objects.       * Groups help to organize a huge collection of Gigasampler samples.
1330       * Groups are not concerned at all for the synthesis, but they help       * Groups are not concerned at all for the synthesis, but they help
1331       * sound library developers when working on complex instruments with an       * sound library developers when working on complex instruments with an
1332       * instrument editor (as long as that instrument editor supports it ;-).       * instrument editor (as long as that instrument editor supports it ;-).
1333       *       *
      * 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 !  
      *  
1334       * A sample is always assigned to exactly one Group. This also means       * A sample is always assigned to exactly one Group. This also means
1335       * 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
1336       * created one yet or not.       * created one yet or not.
1337       */       */
1338      class Group {      class Group : public DLS::Storage {
1339          public:          public:
1340              String Name; ///< Stores the name of this Group.              String Name; ///< Stores the name of this Group.
1341    
# Line 1021  namespace gig { Line 1345  namespace gig {
1345          protected:          protected:
1346              Group(File* file, RIFF::Chunk* ck3gnm);              Group(File* file, RIFF::Chunk* ck3gnm);
1347              virtual ~Group();              virtual ~Group();
1348              virtual void UpdateChunks();              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
1349                virtual void DeleteChunks() OVERRIDE;
1350              void MoveAll();              void MoveAll();
1351              friend class File;              friend class File;
1352          private:          private:
# Line 1029  namespace gig { Line 1354  namespace gig {
1354              RIFF::Chunk* pNameChunk; ///< '3gnm' chunk              RIFF::Chunk* pNameChunk; ///< '3gnm' chunk
1355      };      };
1356    
1357      /** Parses Gigasampler files and provides abstract access to the data. */      /** @brief Provides convenient access to Gigasampler/GigaStudio .gig files.
1358         *
1359         * This is the entry class for accesing a Gigasampler/GigaStudio (.gig) file
1360         * with libgig. It allows you to open existing .gig files, modifying them
1361         * and saving them persistently either under the same file name or under a
1362         * different location.
1363         *
1364         * A .gig file is merely a monolithic file. That means samples and the
1365         * defintion of the virtual instruments are contained in the same file. A
1366         * .gig file contains an arbitrary amount of samples, and an arbitrary
1367         * amount of instruments which are referencing those samples. It is also
1368         * possible to store samples in .gig files not being referenced by any
1369         * instrument. This is not an error from the file format's point of view and
1370         * it is actually often used in practice during the design phase of new gig
1371         * instruments.
1372         *
1373         * So on toplevel of the gig file format you have:
1374         *
1375         * - A set of samples (see Sample).
1376         * - A set of virtual instruments (see Instrument).
1377         *
1378         * And as extension to the original GigaStudio format, we added:
1379         *
1380         * - Real-time instrument scripts (see Script).
1381         *
1382         * Note that the latter however is only supported by libgig, gigedit and
1383         * LinuxSampler. Scripts are not supported by the original GigaStudio
1384         * software.
1385         *
1386         * All released Gigasampler/GigaStudio file format versions are supported
1387         * (so from first Gigasampler version up to including GigaStudio 4).
1388         *
1389         * Since the gig format was designed as extension to the DLS file format,
1390         * this class is derived from the DLS::File class. So also refer to
1391         * DLS::File for additional informations, class attributes and methods.
1392         */
1393      class File : protected DLS::File {      class File : protected DLS::File {
1394          public:          public:
1395              static const DLS::version_t VERSION_2;              static const DLS::version_t VERSION_2;
1396              static const DLS::version_t VERSION_3;              static const DLS::version_t VERSION_3;
1397                static const DLS::version_t VERSION_4;
1398    
1399              // derived attributes from DLS::Resource              // derived attributes from DLS::Resource
1400              using DLS::Resource::pInfo;              using DLS::Resource::pInfo;
# Line 1048  namespace gig { Line 1409  namespace gig {
1409              using DLS::File::Save;              using DLS::File::Save;
1410              using DLS::File::GetFileName;              using DLS::File::GetFileName;
1411              using DLS::File::SetFileName;              using DLS::File::SetFileName;
1412                using DLS::File::GetRiffFile;
1413              // overridden  methods              // overridden  methods
1414              File();              File();
1415              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
# Line 1055  namespace gig { Line 1417  namespace gig {
1417              Sample*     GetNextSample();      ///< Returns a pointer to the next <i>Sample</i> object of the file, <i>NULL</i> otherwise.              Sample*     GetNextSample();      ///< Returns a pointer to the next <i>Sample</i> object of the file, <i>NULL</i> otherwise.
1418              Sample*     GetSample(uint index);              Sample*     GetSample(uint index);
1419              Sample*     AddSample();              Sample*     AddSample();
1420                size_t      CountSamples();
1421              void        DeleteSample(Sample* pSample);              void        DeleteSample(Sample* pSample);
1422              Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</i> object of the file, <i>NULL</i> otherwise.              Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
1423              Instrument* GetNextInstrument();  ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise.              Instrument* GetNextInstrument();  ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
1424              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
1425              Instrument* AddInstrument();              Instrument* AddInstrument();
1426              Instrument* AddDuplicateInstrument(const Instrument* orig);              Instrument* AddDuplicateInstrument(const Instrument* orig);
1427                size_t      CountInstruments();
1428              void        DeleteInstrument(Instrument* pInstrument);              void        DeleteInstrument(Instrument* pInstrument);
1429              Group*      GetFirstGroup(); ///< Returns a pointer to the first <i>Group</i> object of the file, <i>NULL</i> otherwise.              Group*      GetFirstGroup(); ///< Returns a pointer to the first <i>Group</i> object of the file, <i>NULL</i> otherwise.
1430              Group*      GetNextGroup();  ///< Returns a pointer to the next <i>Group</i> object of the file, <i>NULL</i> otherwise.              Group*      GetNextGroup();  ///< Returns a pointer to the next <i>Group</i> object of the file, <i>NULL</i> otherwise.
# Line 1077  namespace gig { Line 1441  namespace gig {
1441              ScriptGroup* AddScriptGroup();              ScriptGroup* AddScriptGroup();
1442              void        DeleteScriptGroup(ScriptGroup* pGroup);              void        DeleteScriptGroup(ScriptGroup* pGroup);
1443              virtual    ~File();              virtual    ~File();
1444              virtual void UpdateChunks();              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
1445          protected:          protected:
1446              // overridden protected methods from DLS::File              // overridden protected methods from DLS::File
1447              virtual void LoadSamples();              virtual void LoadSamples() OVERRIDE;
1448              virtual void LoadInstruments();              virtual void LoadInstruments() OVERRIDE;
1449              virtual void LoadGroups();              virtual void LoadGroups();
1450                virtual void UpdateFileOffsets() OVERRIDE;
1451              // own protected methods              // own protected methods
1452              virtual void LoadSamples(progress_t* pProgress);              virtual void LoadSamples(progress_t* pProgress);
1453              virtual void LoadInstruments(progress_t* pProgress);              virtual void LoadInstruments(progress_t* pProgress);
1454              virtual void LoadScriptGroups();              virtual void LoadScriptGroups();
1455              void SetSampleChecksum(Sample* pSample, uint32_t crc);              void SetSampleChecksum(Sample* pSample, uint32_t crc);
1456                uint32_t GetSampleChecksum(Sample* pSample);
1457                uint32_t GetSampleChecksumByIndex(int index);
1458                bool VerifySampleChecksumTable();
1459                bool RebuildSampleChecksumTable();
1460                int  GetWaveTableIndexOf(gig::Sample* pSample);
1461              friend class Region;              friend class Region;
1462              friend class Sample;              friend class Sample;
1463                friend class Instrument;
1464              friend class Group; // so Group can access protected member pRIFF              friend class Group; // so Group can access protected member pRIFF
1465              friend class ScriptGroup; // so ScriptGroup can access protected member pRIFF              friend class ScriptGroup; // so ScriptGroup can access protected member pRIFF
1466          private:          private:
# Line 1109  namespace gig { Line 1480  namespace gig {
1480       */       */
1481      class Exception : public DLS::Exception {      class Exception : public DLS::Exception {
1482          public:          public:
1483              Exception(String Message);              Exception(String format, ...);
1484                Exception(String format, va_list arg);
1485              void PrintMessage();              void PrintMessage();
1486            protected:
1487                Exception();
1488      };      };
1489    
1490    #if HAVE_RTTI
1491        size_t enumCount(const std::type_info& type);
1492        const char* enumKey(const std::type_info& type, size_t value);
1493        bool        enumKey(const std::type_info& type, String key);
1494        const char** enumKeys(const std::type_info& type);
1495    #endif // HAVE_RTTI
1496        size_t enumCount(String typeName);
1497        const char* enumKey(String typeName, size_t value);
1498        bool        enumKey(String typeName, String key);
1499        const char** enumKeys(String typeName);
1500        size_t enumValue(String key);
1501    
1502      String libraryName();      String libraryName();
1503      String libraryVersion();      String libraryVersion();
1504    

Legend:
Removed from v.2599  
changed lines
  Added in v.3645

  ViewVC Help
Powered by ViewVC