/[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 3181 by schoenebeck, Sun May 14 17:08:42 2017 UTC revision 3623 by schoenebeck, Wed Oct 2 16:30:29 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-2017 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 61  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 79  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  #ifndef GIG_DECLARE_ENUM  #ifndef GIG_DECLARE_ENUM
# Line 118  namespace gig { Line 120  namespace gig {
120       * @see enumCount(), enumKey(), enumKeys(), enumValue()       * @see enumCount(), enumKey(), enumKeys(), enumValue()
121       */       */
122      GIG_DECLARE_ENUM(loop_type_t,      GIG_DECLARE_ENUM(loop_type_t,
123          loop_type_normal        = 0x00000000,  ///< Loop forward (normal)          loop_type_normal        = 0x00000000,  /**< Loop forward (normal) */
124          loop_type_bidirectional = 0x00000001,  ///< Alternating loop (forward/backward, also known as Ping Pong)          loop_type_bidirectional = 0x00000001,  /**< Alternating loop (forward/backward, also known as Ping Pong) */
125          loop_type_backward      = 0x00000002   ///< Loop backward (reverse)          loop_type_backward      = 0x00000002   /**< Loop backward (reverse) */
126      );      );
127    
128      /** Society of Motion Pictures and Television E time format.      /** Society of Motion Pictures and Television E time format.
# Line 128  namespace gig { Line 130  namespace gig {
130       * @see enumCount(), enumKey(), enumKeys(), enumValue()       * @see enumCount(), enumKey(), enumKeys(), enumValue()
131       */       */
132      GIG_DECLARE_ENUM(smpte_format_t,      GIG_DECLARE_ENUM(smpte_format_t,
133          smpte_format_no_offset          = 0x00000000,  ///< no SMPTE offset          smpte_format_no_offset          = 0x00000000,  /**< no SMPTE offset */
134          smpte_format_24_frames          = 0x00000018,  ///< 24 frames per second          smpte_format_24_frames          = 0x00000018,  /**< 24 frames per second */
135          smpte_format_25_frames          = 0x00000019,  ///< 25 frames per second          smpte_format_25_frames          = 0x00000019,  /**< 25 frames per second */
136          smpte_format_30_frames_dropping = 0x0000001D,  ///< 30 frames per second with frame dropping (30 drop)          smpte_format_30_frames_dropping = 0x0000001D,  /**< 30 frames per second with frame dropping (30 drop) */
137          smpte_format_30_frames          = 0x0000001E   ///< 30 frames per second          smpte_format_30_frames          = 0x0000001E   /**< 30 frames per second */
138      );      );
139    
140      /** Defines the shape of a function graph.      /** Defines the shape of a function graph.
# Line 140  namespace gig { Line 142  namespace gig {
142       * @see enumCount(), enumKey(), enumKeys(), enumValue()       * @see enumCount(), enumKey(), enumKeys(), enumValue()
143       */       */
144      GIG_DECLARE_ENUM(curve_type_t,      GIG_DECLARE_ENUM(curve_type_t,
145          curve_type_nonlinear = 0,          curve_type_nonlinear = 0,          /**< Non-linear curve type. */
146          curve_type_linear    = 1,          curve_type_linear    = 1,          /**< Linear curve type. */
147          curve_type_special   = 2,          curve_type_special   = 2,          /**< Special curve type. */
148          curve_type_unknown   = 0xffffffff          curve_type_unknown   = 0xffffffff  /**< Unknown curve type. */
149        );
150    
151        /** Defines the wave form type used by an LFO (gig format extension).
152         *
153         * This is a gig format extension. The original Gigasampler/GigaStudio
154         * software always used a sine (sinus) wave form for all its 3 LFOs, so this
155         * was not configurable in the original gig format. Accordingly setting any
156         * other wave form than sine (sinus) will be ignored by the original
157         * Gigasampler/GigaStudio software.
158         *
159         * @see enumCount(), enumKey(), enumKeys(), enumValue()
160         */
161        GIG_DECLARE_ENUM(lfo_wave_t,
162            lfo_wave_sine     = 0,  /**< Sine (sinus) wave form (this is the default wave form). */
163            lfo_wave_triangle = 1,  /**< Triangle wave form. */
164            lfo_wave_saw      = 2,  /**< Saw (up) wave form (saw down wave form can be achieved by flipping the phase). */
165            lfo_wave_square   = 3,  /**< Square wave form. */
166      );      );
167    
168      /** Dimensions allow to bypass one of the following controllers.      /** Dimensions allow to bypass one of the following controllers.
# Line 151  namespace gig { Line 170  namespace gig {
170       * @see enumCount(), enumKey(), enumKeys(), enumValue()       * @see enumCount(), enumKey(), enumKeys(), enumValue()
171       */       */
172      GIG_DECLARE_ENUM(dim_bypass_ctrl_t,      GIG_DECLARE_ENUM(dim_bypass_ctrl_t,
173          dim_bypass_ctrl_none,          dim_bypass_ctrl_none, /**< No controller bypass. */
174          dim_bypass_ctrl_94,   ///< Effect 4 Depth (MIDI Controller 94)          dim_bypass_ctrl_94,   /**< Effect 4 Depth (MIDI Controller 94) */
175          dim_bypass_ctrl_95    ///< Effect 5 Depth (MIDI Controller 95)          dim_bypass_ctrl_95    /**< Effect 5 Depth (MIDI Controller 95) */
176      );      );
177    
178      /** Defines how LFO3 is controlled by.      /** Defines how LFO3 is controlled by.
# Line 161  namespace gig { Line 180  namespace gig {
180       * @see enumCount(), enumKey(), enumKeys(), enumValue()       * @see enumCount(), enumKey(), enumKeys(), enumValue()
181       */       */
182      GIG_DECLARE_ENUM(lfo3_ctrl_t,      GIG_DECLARE_ENUM(lfo3_ctrl_t,
183          lfo3_ctrl_internal            = 0x00, ///< Only internally controlled.          lfo3_ctrl_internal            = 0x00, /**< Only internally controlled. */
184          lfo3_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.          lfo3_ctrl_modwheel            = 0x01, /**< Only controlled by external modulation wheel. */
185          lfo3_ctrl_aftertouch          = 0x02, ///< Only controlled by aftertouch controller.          lfo3_ctrl_aftertouch          = 0x02, /**< Only controlled by aftertouch controller. */
186          lfo3_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.          lfo3_ctrl_internal_modwheel   = 0x03, /**< Controlled internally and by external modulation wheel. */
187          lfo3_ctrl_internal_aftertouch = 0x04  ///< Controlled internally and by aftertouch controller.          lfo3_ctrl_internal_aftertouch = 0x04  /**< Controlled internally and by aftertouch controller. */
188      );      );
189    
190      /** Defines how LFO2 is controlled by.      /** Defines how LFO2 is controlled by.
# Line 173  namespace gig { Line 192  namespace gig {
192       * @see enumCount(), enumKey(), enumKeys(), enumValue()       * @see enumCount(), enumKey(), enumKeys(), enumValue()
193       */       */
194      GIG_DECLARE_ENUM(lfo2_ctrl_t,      GIG_DECLARE_ENUM(lfo2_ctrl_t,
195          lfo2_ctrl_internal            = 0x00, ///< Only internally controlled.          lfo2_ctrl_internal            = 0x00, /**< Only internally controlled. */
196          lfo2_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.          lfo2_ctrl_modwheel            = 0x01, /**< Only controlled by external modulation wheel. */
197          lfo2_ctrl_foot                = 0x02, ///< Only controlled by external foot controller.          lfo2_ctrl_foot                = 0x02, /**< Only controlled by external foot controller. */
198          lfo2_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.          lfo2_ctrl_internal_modwheel   = 0x03, /**< Controlled internally and by external modulation wheel. */
199          lfo2_ctrl_internal_foot       = 0x04  ///< Controlled internally and by external foot controller.          lfo2_ctrl_internal_foot       = 0x04  /**< Controlled internally and by external foot controller. */
200      );      );
201    
202      /** Defines how LFO1 is controlled by.      /** Defines how LFO1 is controlled by.
# Line 185  namespace gig { Line 204  namespace gig {
204       * @see enumCount(), enumKey(), enumKeys(), enumValue()       * @see enumCount(), enumKey(), enumKeys(), enumValue()
205       */       */
206      GIG_DECLARE_ENUM(lfo1_ctrl_t,      GIG_DECLARE_ENUM(lfo1_ctrl_t,
207          lfo1_ctrl_internal            = 0x00, ///< Only internally controlled.          lfo1_ctrl_internal            = 0x00, /**< Only internally controlled. */
208          lfo1_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.          lfo1_ctrl_modwheel            = 0x01, /**< Only controlled by external modulation wheel. */
209          lfo1_ctrl_breath              = 0x02, ///< Only controlled by external breath controller.          lfo1_ctrl_breath              = 0x02, /**< Only controlled by external breath controller. */
210          lfo1_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.          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.          lfo1_ctrl_internal_breath     = 0x04  /**< Controlled internally and by external breath controller. */
212      );      );
213    
214      /** Defines how the filter cutoff frequency is controlled by.      /** Defines how the filter cutoff frequency is controlled by.
# Line 197  namespace gig { Line 216  namespace gig {
216       * @see enumCount(), enumKey(), enumKeys(), enumValue()       * @see enumCount(), enumKey(), enumKeys(), enumValue()
217       */       */
218      GIG_DECLARE_ENUM(vcf_cutoff_ctrl_t,      GIG_DECLARE_ENUM(vcf_cutoff_ctrl_t,
219          vcf_cutoff_ctrl_none         = 0x00,          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          vcf_cutoff_ctrl_none2        = 0x01,  /**< The difference between none and none2 is unknown */
221          vcf_cutoff_ctrl_modwheel     = 0x81,  ///< Modulation Wheel (MIDI Controller 1)          vcf_cutoff_ctrl_modwheel     = 0x81,  /**< Modulation Wheel (MIDI Controller 1) */
222          vcf_cutoff_ctrl_effect1      = 0x8c,  ///< Effect Controller 1 (Coarse, MIDI Controller 12)          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)          vcf_cutoff_ctrl_effect2      = 0x8d,  /**< Effect Controller 2 (Coarse, MIDI Controller 13) */
224          vcf_cutoff_ctrl_breath       = 0x82,  ///< Breath Controller (Coarse, MIDI Controller 2)          vcf_cutoff_ctrl_breath       = 0x82,  /**< Breath Controller (Coarse, MIDI Controller 2) */
225          vcf_cutoff_ctrl_foot         = 0x84,  ///< Foot Pedal (Coarse, MIDI Controller 4)          vcf_cutoff_ctrl_foot         = 0x84,  /**< Foot Pedal (Coarse, MIDI Controller 4) */
226          vcf_cutoff_ctrl_sustainpedal = 0xc0,  ///< Sustain Pedal (MIDI Controller 64)          vcf_cutoff_ctrl_sustainpedal = 0xc0,  /**< Sustain Pedal (MIDI Controller 64) */
227          vcf_cutoff_ctrl_softpedal    = 0xc3,  ///< Soft Pedal (MIDI Controller 67)          vcf_cutoff_ctrl_softpedal    = 0xc3,  /**< Soft Pedal (MIDI Controller 67) */
228          vcf_cutoff_ctrl_genpurpose7  = 0xd2,  ///< General Purpose Controller 7 (Button, MIDI Controller 82)          vcf_cutoff_ctrl_genpurpose7  = 0xd2,  /**< General Purpose Controller 7 (Button, MIDI Controller 82) */
229          vcf_cutoff_ctrl_genpurpose8  = 0xd3,  ///< General Purpose Controller 8 (Button, MIDI Controller 83)          vcf_cutoff_ctrl_genpurpose8  = 0xd3,  /**< General Purpose Controller 8 (Button, MIDI Controller 83) */
230          vcf_cutoff_ctrl_aftertouch   = 0x80   ///< Key Pressure          vcf_cutoff_ctrl_aftertouch   = 0x80   /**< Key Pressure */
231      );      );
232    
233      /** Defines how the filter resonance is controlled by.      /** Defines how the filter resonance is controlled by.
# Line 216  namespace gig { Line 235  namespace gig {
235       * @see enumCount(), enumKey(), enumKeys(), enumValue()       * @see enumCount(), enumKey(), enumKeys(), enumValue()
236       */       */
237      GIG_DECLARE_ENUM(vcf_res_ctrl_t,      GIG_DECLARE_ENUM(vcf_res_ctrl_t,
238          vcf_res_ctrl_none        = 0xffffffff,          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)          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)          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)          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)          vcf_res_ctrl_genpurpose6 = 3            /**< General Purpose Controller 6 (Button, MIDI Controller 81) */
243      );      );
244    
245      /**      /**
# Line 237  namespace gig { Line 256  namespace gig {
256           * @see enumCount(), enumKey(), enumKeys(), enumValue()           * @see enumCount(), enumKey(), enumKeys(), enumValue()
257           */           */
258          GIG_DECLARE_ENUM(type_t,          GIG_DECLARE_ENUM(type_t,
259              type_none              = 0x00, ///< No controller defined              type_none              = 0x00, /**< No controller defined */
260              type_channelaftertouch = 0x2f, ///< Channel Key Pressure              type_channelaftertouch = 0x2f, /**< Channel Key Pressure */
261              type_velocity          = 0xff, ///< Key Velocity              type_velocity          = 0xff, /**< Key Velocity */
262              type_controlchange     = 0xfe  ///< Ordinary MIDI control change controller, see field 'controller_number'              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
# Line 280  namespace gig { Line 299  namespace gig {
299       * @see enumCount(), enumKey(), enumKeys(), enumValue()       * @see enumCount(), enumKey(), enumKeys(), enumValue()
300       */       */
301      GIG_DECLARE_ENUM(dimension_t,      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      );      );
337    
338      /**      /**
# Line 323  namespace gig { Line 342  namespace gig {
342       * @see enumCount(), enumKey(), enumKeys(), enumValue()       * @see enumCount(), enumKey(), enumKeys(), enumValue()
343       */       */
344      GIG_DECLARE_ENUM(split_type_t,      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      );      );
348    
349      /** General dimension definition. */      /** General dimension definition. */
# Line 341  namespace gig { Line 360  namespace gig {
360       * @see enumCount(), enumKey(), enumKeys(), enumValue()       * @see enumCount(), enumKey(), enumKeys(), enumValue()
361       */       */
362      GIG_DECLARE_ENUM(vcf_type_t,      GIG_DECLARE_ENUM(vcf_type_t,
363          vcf_type_lowpass      = 0x00,          vcf_type_lowpass      = 0x00, /**< Standard lowpass filter type. */
364          vcf_type_lowpassturbo = 0xff, ///< More poles than normal lowpass          vcf_type_lowpassturbo = 0xff, /**< More poles than normal lowpass. */
365          vcf_type_bandpass     = 0x01,          vcf_type_bandpass     = 0x01, /**< Bandpass filter type. */
366          vcf_type_highpass     = 0x02,          vcf_type_highpass     = 0x02, /**< Highpass filter type. */
367          vcf_type_bandreject   = 0x03          vcf_type_bandreject   = 0x03  /**< Band reject filter type. */
368      );      );
369    
370      /**      /**
# Line 378  namespace gig { Line 397  namespace gig {
397          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.          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.
398      };      };
399    
400        /**
401         * Defines behavior options for envelope generators (gig format extension).
402         *
403         * These options allow to override the precise default behavior of the
404         * envelope generators' state machines.
405         *
406         * @b Note: These EG options are an extension to the original gig file
407         * format, so these options are not available with the original
408         * Gigasampler/GigaStudio software! Currently only LinuxSampler and gigedit
409         * support these EG options!
410         *
411         * Adding these options to the original gig file format was necessary,
412         * because the precise state machine behavior of envelope generators of the
413         * gig format (and thus the default EG behavior if not explicitly overridden
414         * here) deviates from common, expected behavior of envelope generators in
415         * general, if i.e. compared with EGs of hardware synthesizers. For example
416         * with the gig format, the attack and decay stages will be aborted as soon
417         * as a note-off is received. Most other EG implementations in the industry
418         * however always run the attack and decay stages to their full duration,
419         * even if an early note-off arrives. The latter behavior is intentionally
420         * implemented in most other products, because it is required to resemble
421         * percussive sounds in a realistic manner.
422         */
423        struct eg_opt_t {
424            bool AttackCancel;     ///< Whether the "attack" stage is cancelled when receiving a note-off (default: @c true).
425            bool AttackHoldCancel; ///< Whether the "attack hold" stage is cancelled when receiving a note-off (default: @c true).
426            bool Decay1Cancel;     ///< Whether the "decay 1" stage is cancelled when receiving a note-off (default: @c true).
427            bool Decay2Cancel;     ///< Whether the "decay 2" stage is cancelled when receiving a note-off (default: @c true).
428            bool ReleaseCancel;    ///< Whether the "release" stage is cancelled when receiving a note-on (default: @c true).
429    
430            eg_opt_t();
431            void serialize(Serialization::Archive* archive);
432        };
433    
434        /** @brief Defines behaviour of release triggered sample(s) on sustain pedal up event.
435         *
436         * This option defines whether a sustain pedal up event (CC#64) would cause
437         * release triggered samples to be played (if any).
438         *
439         * @b Note: This option is an extension to the original gig file format,
440         * so this option is not available with the original Gigasampler/GigaStudio
441         * software! Currently only LinuxSampler and gigedit support this option!
442         *
443         * By default (which equals the original Gigasampler/GigaStudio behaviour)
444         * no release triggered samples are played if the sustain pedal is released.
445         * So usually in the gig format release triggered samples are only played
446         * on MIDI note-off events.
447         *
448         * @see enumCount(), enumKey(), enumKeys(), enumValue()
449         */
450        GIG_DECLARE_ENUM(sust_rel_trg_t,
451            sust_rel_trg_none        = 0x00, /**< No release triggered sample(s) are played on sustain pedal up (default). */
452            sust_rel_trg_maxvelocity = 0x01, /**< Play release trigger sample(s) on sustain pedal up, and simply use 127 as MIDI velocity for playback. */
453            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. */
454        );
455    
456      // just symbol prototyping      // just symbol prototyping
457      class File;      class File;
458      class Instrument;      class Instrument;
# Line 447  namespace gig { Line 522  namespace gig {
522              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).
523              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).
524              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).
525                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).
526              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).
527                double             LFO1Phase;                     ///< [gig extension]: Phase displacement of the amplitude LFO's wave form (0.0° - 360.0°).
528              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).
529              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).
530              lfo1_ctrl_t        LFO1Controller;                ///< MIDI Controller which controls sample amplitude LFO.              lfo1_ctrl_t        LFO1Controller;                ///< MIDI Controller which controls sample amplitude LFO.
531              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.
532              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.
533              // Filter Cutoff Frequency EG/LFO              // Filter Cutoff Frequency EG/LFO
534              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 466  namespace gig { Line 543  namespace gig {
543              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).
544              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).
545              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).
546                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).
547              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).
548                double             LFO2Phase;                     ///< [gig extension]: Phase displacement of the filter cutoff LFO's wave form (0.0° - 360.0°).
549              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).
550              uint16_t           LFO2ControlDepth;              ///< Controller depth influencing filter cutoff LFO pitch (0 - 1200).              uint16_t           LFO2ControlDepth;              ///< Controller depth influencing filter cutoff LFO pitch (0 - 1200).
551              lfo2_ctrl_t        LFO2Controller;                ///< MIDI Controlle which controls the filter cutoff LFO.              lfo2_ctrl_t        LFO2Controller;                ///< MIDI Controlle which controls the filter cutoff LFO.
552              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.
553              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.
554              // Sample Pitch EG/LFO              // Sample Pitch EG/LFO
555              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).
556              int16_t            EG3Depth;                      ///< Depth of the sample pitch EG (-1200 - +1200).              int16_t            EG3Depth;                      ///< Depth of the sample pitch EG (-1200 - +1200).
557                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).
558              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).
559                double             LFO3Phase;                     ///< [gig extension]: Phase displacement of the pitch LFO's wave form (0.0° - 360.0°).
560              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).
561              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).
562              lfo3_ctrl_t        LFO3Controller;                ///< MIDI Controller which controls the sample pitch LFO.              lfo3_ctrl_t        LFO3Controller;                ///< MIDI Controller which controls the sample pitch LFO.
563                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).
564              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.
565              // Filter              // Filter
566              bool               VCFEnabled;                    ///< If filter should be used.              bool               VCFEnabled;                    ///< If filter should be used.
# Line 516  namespace gig { Line 598  namespace gig {
598              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).
599              double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)              double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)
600              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).
601                eg_opt_t           EG1Options;                    ///< [gig extension]: Behavior options which should be used for envelope generator 1 (volume amplitude EG).
602                eg_opt_t           EG2Options;                    ///< [gig extension]: Behavior options which should be used for envelope generator 2 (filter cutoff EG).
603                sust_rel_trg_t     SustainReleaseTrigger;         ///< [gig extension]: Whether a sustain pedal up event shall play release trigger sample.
604                bool               NoNoteOffReleaseTrigger;       ///< [gig extension]: If @c true then don't play a release trigger sample on MIDI note-off events.
605    
606              // derived attributes from DLS::Sampler              // derived attributes from DLS::Sampler
607              using DLS::Sampler::UnityNote;              using DLS::Sampler::UnityNote;
# Line 542  namespace gig { Line 628  namespace gig {
628              using DLS::Sampler::AddSampleLoop;              using DLS::Sampler::AddSampleLoop;
629              using DLS::Sampler::DeleteSampleLoop;              using DLS::Sampler::DeleteSampleLoop;
630              // overridden methods              // overridden methods
631              virtual void SetGain(int32_t gain);              virtual void SetGain(int32_t gain) OVERRIDE;
632              virtual void UpdateChunks(progress_t* pProgress);              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
633              virtual void CopyAssign(const DimensionRegion* orig);              virtual void CopyAssign(const DimensionRegion* orig);
634          protected:          protected:
635              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 669  namespace gig { Line 755  namespace gig {
755              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);
756              double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);              double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
757              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
758                bool UsesAnyGigFormatExtension() const;
759      };      };
760    
761      /** @brief Encapsulates sample waves of Gigasampler/GigaStudio files used for playback.      /** @brief Encapsulates sample waves of Gigasampler/GigaStudio files used for playback.
# Line 735  namespace gig { Line 822  namespace gig {
822              file_offset_t ReadAndLoop(void* pBuffer, file_offset_t 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);
823              file_offset_t Write(void* pBuffer, file_offset_t SampleCount);              file_offset_t Write(void* pBuffer, file_offset_t SampleCount);
824              Group*        GetGroup() const;              Group*        GetGroup() const;
825              virtual void  UpdateChunks(progress_t* pProgress);              virtual void  UpdateChunks(progress_t* pProgress) OVERRIDE;
826              void CopyAssignMeta(const Sample* orig);              void CopyAssignMeta(const Sample* orig);
827              void CopyAssignWave(const Sample* orig);              void CopyAssignWave(const Sample* orig);
828              uint32_t GetWaveDataCRC32Checksum();              uint32_t GetWaveDataCRC32Checksum();
# Line 829  namespace gig { Line 916  namespace gig {
916              void             SplitDimensionZone(dimension_t type, int zone);              void             SplitDimensionZone(dimension_t type, int zone);
917              void             SetDimensionType(dimension_t oldType, dimension_t newType);              void             SetDimensionType(dimension_t oldType, dimension_t newType);
918              // overridden methods              // overridden methods
919              virtual void     SetKeyRange(uint16_t Low, uint16_t High);              virtual void     SetKeyRange(uint16_t Low, uint16_t High) OVERRIDE;
920              virtual void     UpdateChunks(progress_t* pProgress);              virtual void     UpdateChunks(progress_t* pProgress) OVERRIDE;
921              virtual void     CopyAssign(const Region* orig);              virtual void     CopyAssign(const Region* orig);
922          protected:          protected:
923              Region(Instrument* pInstrument, RIFF::List* rgnList);              Region(Instrument* pInstrument, RIFF::List* rgnList);
# Line 923  namespace gig { Line 1010  namespace gig {
1010          protected:          protected:
1011              MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg);              MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg);
1012              MidiRuleCtrlTrigger();              MidiRuleCtrlTrigger();
1013              void UpdateChunks(uint8_t* pData) const;              void UpdateChunks(uint8_t* pData) const OVERRIDE;
1014              friend class Instrument;              friend class Instrument;
1015      };      };
1016    
# Line 963  namespace gig { Line 1050  namespace gig {
1050          protected:          protected:
1051              MidiRuleLegato(RIFF::Chunk* _3ewg);              MidiRuleLegato(RIFF::Chunk* _3ewg);
1052              MidiRuleLegato();              MidiRuleLegato();
1053              void UpdateChunks(uint8_t* pData) const;              void UpdateChunks(uint8_t* pData) const OVERRIDE;
1054              friend class Instrument;              friend class Instrument;
1055      };      };
1056    
# Line 1015  namespace gig { Line 1102  namespace gig {
1102          protected:          protected:
1103              MidiRuleAlternator(RIFF::Chunk* _3ewg);              MidiRuleAlternator(RIFF::Chunk* _3ewg);
1104              MidiRuleAlternator();              MidiRuleAlternator();
1105              void UpdateChunks(uint8_t* pData) const;              void UpdateChunks(uint8_t* pData) const OVERRIDE;
1106              friend class Instrument;              friend class Instrument;
1107      };      };
1108    
# Line 1035  namespace gig { Line 1122  namespace gig {
1122      class MidiRuleUnknown : public MidiRule {      class MidiRuleUnknown : public MidiRule {
1123          protected:          protected:
1124              MidiRuleUnknown() { }              MidiRuleUnknown() { }
1125              void UpdateChunks(uint8_t* pData) const { }              void UpdateChunks(uint8_t* pData) const OVERRIDE { }
1126              friend class Instrument;              friend class Instrument;
1127      };      };
1128    
# Line 1059  namespace gig { Line 1146  namespace gig {
1146       * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language/Reference/">NKSP Reference Manual</a>       * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language/Reference/">NKSP Reference Manual</a>
1147       * - <a href="http://doc.linuxsampler.org/Gigedit/Managing_Scripts">Using Instrument Scripts with Gigedit</a>       * - <a href="http://doc.linuxsampler.org/Gigedit/Managing_Scripts">Using Instrument Scripts with Gigedit</a>
1148       */       */
1149      class Script {      class Script : protected DLS::Storage {
1150          public:          public:
1151              enum Encoding_t {              enum Encoding_t {
1152                  ENCODING_ASCII = 0 ///< Standard 8 bit US ASCII character encoding (default).                  ENCODING_ASCII = 0 ///< Standard 8 bit US ASCII character encoding (default).
# Line 1085  namespace gig { Line 1172  namespace gig {
1172          protected:          protected:
1173              Script(ScriptGroup* group, RIFF::Chunk* ckScri);              Script(ScriptGroup* group, RIFF::Chunk* ckScri);
1174              virtual ~Script();              virtual ~Script();
1175              void UpdateChunks(progress_t* pProgress);              void UpdateChunks(progress_t* pProgress) OVERRIDE;
1176                void DeleteChunks() OVERRIDE;
1177              void RemoveAllScriptReferences();              void RemoveAllScriptReferences();
1178              friend class ScriptGroup;              friend class ScriptGroup;
1179              friend class Instrument;              friend class Instrument;
# Line 1107  namespace gig { Line 1195  namespace gig {
1195       * not available in the GigaStudio 4 software. It is currently only       * not available in the GigaStudio 4 software. It is currently only
1196       * supported by LinuxSampler and gigedit.       * supported by LinuxSampler and gigedit.
1197       */       */
1198      class ScriptGroup {      class ScriptGroup : protected DLS::Storage {
1199          public:          public:
1200              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.
1201    
# Line 1118  namespace gig { Line 1206  namespace gig {
1206              ScriptGroup(File* file, RIFF::List* lstRTIS);              ScriptGroup(File* file, RIFF::List* lstRTIS);
1207              virtual ~ScriptGroup();              virtual ~ScriptGroup();
1208              void LoadScripts();              void LoadScripts();
1209              void UpdateChunks(progress_t* pProgress);              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
1210                virtual void DeleteChunks() OVERRIDE;
1211              friend class Script;              friend class Script;
1212              friend class File;              friend class File;
1213          private:          private:
# Line 1171  namespace gig { Line 1260  namespace gig {
1260              Region*   AddRegion();              Region*   AddRegion();
1261              void      DeleteRegion(Region* pRegion);              void      DeleteRegion(Region* pRegion);
1262              void      MoveTo(Instrument* dst);              void      MoveTo(Instrument* dst);
1263              virtual void UpdateChunks(progress_t* pProgress);              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
1264              virtual void CopyAssign(const Instrument* orig);              virtual void CopyAssign(const Instrument* orig);
1265              // own methods              // own methods
1266              Region*   GetRegion(unsigned int Key);              Region*   GetRegion(unsigned int Key);
# Line 1225  namespace gig { Line 1314  namespace gig {
1314       * 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
1315       * created one yet or not.       * created one yet or not.
1316       */       */
1317      class Group {      class Group : public DLS::Storage {
1318          public:          public:
1319              String Name; ///< Stores the name of this Group.              String Name; ///< Stores the name of this Group.
1320    
# Line 1235  namespace gig { Line 1324  namespace gig {
1324          protected:          protected:
1325              Group(File* file, RIFF::Chunk* ck3gnm);              Group(File* file, RIFF::Chunk* ck3gnm);
1326              virtual ~Group();              virtual ~Group();
1327              virtual void UpdateChunks(progress_t* pProgress);              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
1328                virtual void DeleteChunks() OVERRIDE;
1329              void MoveAll();              void MoveAll();
1330              friend class File;              friend class File;
1331          private:          private:
# Line 1283  namespace gig { Line 1373  namespace gig {
1373          public:          public:
1374              static const DLS::version_t VERSION_2;              static const DLS::version_t VERSION_2;
1375              static const DLS::version_t VERSION_3;              static const DLS::version_t VERSION_3;
1376                static const DLS::version_t VERSION_4;
1377    
1378              // derived attributes from DLS::Resource              // derived attributes from DLS::Resource
1379              using DLS::Resource::pInfo;              using DLS::Resource::pInfo;
# Line 1297  namespace gig { Line 1388  namespace gig {
1388              using DLS::File::Save;              using DLS::File::Save;
1389              using DLS::File::GetFileName;              using DLS::File::GetFileName;
1390              using DLS::File::SetFileName;              using DLS::File::SetFileName;
1391                using DLS::File::GetRiffFile;
1392              // overridden  methods              // overridden  methods
1393              File();              File();
1394              File(RIFF::File* pRIFF);              File(RIFF::File* pRIFF);
# Line 1304  namespace gig { Line 1396  namespace gig {
1396              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.
1397              Sample*     GetSample(uint index);              Sample*     GetSample(uint index);
1398              Sample*     AddSample();              Sample*     AddSample();
1399                size_t      CountSamples();
1400              void        DeleteSample(Sample* pSample);              void        DeleteSample(Sample* pSample);
1401              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.
1402              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.
1403              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
1404              Instrument* AddInstrument();              Instrument* AddInstrument();
1405              Instrument* AddDuplicateInstrument(const Instrument* orig);              Instrument* AddDuplicateInstrument(const Instrument* orig);
1406                size_t      CountInstruments();
1407              void        DeleteInstrument(Instrument* pInstrument);              void        DeleteInstrument(Instrument* pInstrument);
1408              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.
1409              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 1326  namespace gig { Line 1420  namespace gig {
1420              ScriptGroup* AddScriptGroup();              ScriptGroup* AddScriptGroup();
1421              void        DeleteScriptGroup(ScriptGroup* pGroup);              void        DeleteScriptGroup(ScriptGroup* pGroup);
1422              virtual    ~File();              virtual    ~File();
1423              virtual void UpdateChunks(progress_t* pProgress);              virtual void UpdateChunks(progress_t* pProgress) OVERRIDE;
1424          protected:          protected:
1425              // overridden protected methods from DLS::File              // overridden protected methods from DLS::File
1426              virtual void LoadSamples();              virtual void LoadSamples() OVERRIDE;
1427              virtual void LoadInstruments();              virtual void LoadInstruments() OVERRIDE;
1428              virtual void LoadGroups();              virtual void LoadGroups();
1429              virtual void UpdateFileOffsets();              virtual void UpdateFileOffsets() OVERRIDE;
1430              // own protected methods              // own protected methods
1431              virtual void LoadSamples(progress_t* pProgress);              virtual void LoadSamples(progress_t* pProgress);
1432              virtual void LoadInstruments(progress_t* pProgress);              virtual void LoadInstruments(progress_t* pProgress);
# Line 1365  namespace gig { Line 1459  namespace gig {
1459       */       */
1460      class Exception : public DLS::Exception {      class Exception : public DLS::Exception {
1461          public:          public:
1462              Exception(String Message);              Exception(String format, ...);
1463                Exception(String format, va_list arg);
1464              void PrintMessage();              void PrintMessage();
1465            protected:
1466                Exception();
1467      };      };
1468    
1469  #if HAVE_RTTI  #if HAVE_RTTI

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

  ViewVC Help
Powered by ViewVC