/[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 2922 by schoenebeck, Wed May 18 18:04:49 2016 UTC revision 3446 by schoenebeck, Sun Dec 23 21:47:26 2018 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-2016 by Christian Schoenebeck                      *   *   Copyright (C) 2003-2018 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    #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 */  /** Gigasampler/GigaStudio specific classes and definitions */
94  namespace gig {  namespace gig {
95    
# Line 90  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.      /** Dimensions allow to bypass one of the following controllers.
152          lfo3_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.       *
153          lfo3_ctrl_aftertouch          = 0x02, ///< Only controlled by aftertouch controller.       * @see enumCount(), enumKey(), enumKeys(), enumValue()
154          lfo3_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.       */
155          lfo3_ctrl_internal_aftertouch = 0x04  ///< Controlled internally and by aftertouch controller.      GIG_DECLARE_ENUM(dim_bypass_ctrl_t,
156      } lfo3_ctrl_t;          dim_bypass_ctrl_none, /**< No controller bypass. */
157            dim_bypass_ctrl_94,   /**< Effect 4 Depth (MIDI Controller 94) */
158      /** Defines how LFO2 is controlled by. */          dim_bypass_ctrl_95    /**< Effect 5 Depth (MIDI Controller 95) */
159      typedef enum {      );
160          lfo2_ctrl_internal            = 0x00, ///< Only internally controlled.  
161          lfo2_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.      /** Defines how LFO3 is controlled by.
162          lfo2_ctrl_foot                = 0x02, ///< Only controlled by external foot controller.       *
163          lfo2_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.       * @see enumCount(), enumKey(), enumKeys(), enumValue()
164          lfo2_ctrl_internal_foot       = 0x04  ///< Controlled internally and by external foot controller.       */
165      } lfo2_ctrl_t;      GIG_DECLARE_ENUM(lfo3_ctrl_t,
166            lfo3_ctrl_internal            = 0x00, /**< Only internally controlled. */
167      /** Defines how LFO1 is controlled by. */          lfo3_ctrl_modwheel            = 0x01, /**< Only controlled by external modulation wheel. */
168      typedef enum {          lfo3_ctrl_aftertouch          = 0x02, /**< Only controlled by aftertouch controller. */
169          lfo1_ctrl_internal            = 0x00, ///< Only internally controlled.          lfo3_ctrl_internal_modwheel   = 0x03, /**< Controlled internally and by external modulation wheel. */
170          lfo1_ctrl_modwheel            = 0x01, ///< Only controlled by external modulation wheel.          lfo3_ctrl_internal_aftertouch = 0x04  /**< Controlled internally and by aftertouch controller. */
171          lfo1_ctrl_breath              = 0x02, ///< Only controlled by external breath controller.      );
172          lfo1_ctrl_internal_modwheel   = 0x03, ///< Controlled internally and by external modulation wheel.  
173          lfo1_ctrl_internal_breath     = 0x04  ///< Controlled internally and by external breath controller.      /** Defines how LFO2 is controlled by.
174      } lfo1_ctrl_t;       *
175         * @see enumCount(), enumKey(), enumKeys(), enumValue()
176      /** Defines how the filter cutoff frequency is controlled by. */       */
177      typedef enum {      GIG_DECLARE_ENUM(lfo2_ctrl_t,
178          vcf_cutoff_ctrl_none         = 0x00,          lfo2_ctrl_internal            = 0x00, /**< Only internally controlled. */
179          vcf_cutoff_ctrl_none2        = 0x01,  ///< The difference between none and none2 is unknown          lfo2_ctrl_modwheel            = 0x01, /**< Only controlled by external modulation wheel. */
180          vcf_cutoff_ctrl_modwheel     = 0x81,  ///< Modulation Wheel (MIDI Controller 1)          lfo2_ctrl_foot                = 0x02, /**< Only controlled by external foot controller. */
181          vcf_cutoff_ctrl_effect1      = 0x8c,  ///< Effect Controller 1 (Coarse, MIDI Controller 12)          lfo2_ctrl_internal_modwheel   = 0x03, /**< Controlled internally and by external modulation wheel. */
182          vcf_cutoff_ctrl_effect2      = 0x8d,  ///< Effect Controller 2 (Coarse, MIDI Controller 13)          lfo2_ctrl_internal_foot       = 0x04  /**< Controlled internally and by external foot controller. */
183          vcf_cutoff_ctrl_breath       = 0x82,  ///< Breath Controller (Coarse, MIDI Controller 2)      );
184          vcf_cutoff_ctrl_foot         = 0x84,  ///< Foot Pedal (Coarse, MIDI Controller 4)  
185          vcf_cutoff_ctrl_sustainpedal = 0xc0,  ///< Sustain Pedal (MIDI Controller 64)      /** Defines how LFO1 is controlled by.
186          vcf_cutoff_ctrl_softpedal    = 0xc3,  ///< Soft Pedal (MIDI Controller 67)       *
187          vcf_cutoff_ctrl_genpurpose7  = 0xd2,  ///< General Purpose Controller 7 (Button, MIDI Controller 82)       * @see enumCount(), enumKey(), enumKeys(), enumValue()
188          vcf_cutoff_ctrl_genpurpose8  = 0xd3,  ///< General Purpose Controller 8 (Button, MIDI Controller 83)       */
189          vcf_cutoff_ctrl_aftertouch   = 0x80   ///< Key Pressure      GIG_DECLARE_ENUM(lfo1_ctrl_t,
190      } vcf_cutoff_ctrl_t;          lfo1_ctrl_internal            = 0x00, /**< Only internally controlled. */
191            lfo1_ctrl_modwheel            = 0x01, /**< Only controlled by external modulation wheel. */
192      /** Defines how the filter resonance is controlled by. */          lfo1_ctrl_breath              = 0x02, /**< Only controlled by external breath controller. */
193      typedef enum {          lfo1_ctrl_internal_modwheel   = 0x03, /**< Controlled internally and by external modulation wheel. */
194          vcf_res_ctrl_none        = 0xffffffff,          lfo1_ctrl_internal_breath     = 0x04  /**< Controlled internally and by external breath controller. */
195          vcf_res_ctrl_genpurpose3 = 0,           ///< General Purpose Controller 3 (Slider, MIDI Controller 18)      );
196          vcf_res_ctrl_genpurpose4 = 1,           ///< General Purpose Controller 4 (Slider, MIDI Controller 19)  
197          vcf_res_ctrl_genpurpose5 = 2,           ///< General Purpose Controller 5 (Button, MIDI Controller 80)      /** Defines how the filter cutoff frequency is controlled by.
198          vcf_res_ctrl_genpurpose6 = 3            ///< General Purpose Controller 6 (Button, MIDI Controller 81)       *
199      } vcf_res_ctrl_t;       * @see enumCount(), enumKey(), enumKeys(), enumValue()
200         */
201        GIG_DECLARE_ENUM(vcf_cutoff_ctrl_t,
202            vcf_cutoff_ctrl_none         = 0x00,  /**< No MIDI controller assigned for filter cutoff frequency. */
203            vcf_cutoff_ctrl_none2        = 0x01,  /**< The difference between none and none2 is unknown */
204            vcf_cutoff_ctrl_modwheel     = 0x81,  /**< Modulation Wheel (MIDI Controller 1) */
205            vcf_cutoff_ctrl_effect1      = 0x8c,  /**< Effect Controller 1 (Coarse, MIDI Controller 12) */
206            vcf_cutoff_ctrl_effect2      = 0x8d,  /**< Effect Controller 2 (Coarse, MIDI Controller 13) */
207            vcf_cutoff_ctrl_breath       = 0x82,  /**< Breath Controller (Coarse, MIDI Controller 2) */
208            vcf_cutoff_ctrl_foot         = 0x84,  /**< Foot Pedal (Coarse, MIDI Controller 4) */
209            vcf_cutoff_ctrl_sustainpedal = 0xc0,  /**< Sustain Pedal (MIDI Controller 64) */
210            vcf_cutoff_ctrl_softpedal    = 0xc3,  /**< Soft Pedal (MIDI Controller 67) */
211            vcf_cutoff_ctrl_genpurpose7  = 0xd2,  /**< General Purpose Controller 7 (Button, MIDI Controller 82) */
212            vcf_cutoff_ctrl_genpurpose8  = 0xd3,  /**< General Purpose Controller 8 (Button, MIDI Controller 83) */
213            vcf_cutoff_ctrl_aftertouch   = 0x80   /**< Key Pressure */
214        );
215    
216        /** Defines how the filter resonance is controlled by.
217         *
218         * @see enumCount(), enumKey(), enumKeys(), enumValue()
219         */
220        GIG_DECLARE_ENUM(vcf_res_ctrl_t,
221            vcf_res_ctrl_none        = 0xffffffff,  /**< No MIDI controller assigned for filter resonance. */
222            vcf_res_ctrl_genpurpose3 = 0,           /**< General Purpose Controller 3 (Slider, MIDI Controller 18) */
223            vcf_res_ctrl_genpurpose4 = 1,           /**< General Purpose Controller 4 (Slider, MIDI Controller 19) */
224            vcf_res_ctrl_genpurpose5 = 2,           /**< General Purpose Controller 5 (Button, MIDI Controller 80) */
225            vcf_res_ctrl_genpurpose6 = 3            /**< General Purpose Controller 6 (Button, MIDI Controller 81) */
226        );
227    
228      /**      /**
229       * Defines a controller that has a certain contrained influence on a       * Defines a controller that has a certain contrained influence on a
# Line 182  namespace gig { Line 234  namespace gig {
234       * 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!
235       */       */
236      struct leverage_ctrl_t {      struct leverage_ctrl_t {
237          typedef enum {          /** Defines possible controllers.
238              type_none              = 0x00, ///< No controller defined           *
239              type_channelaftertouch = 0x2f, ///< Channel Key Pressure           * @see enumCount(), enumKey(), enumKeys(), enumValue()
240              type_velocity          = 0xff, ///< Key Velocity           */
241              type_controlchange     = 0xfe  ///< Ordinary MIDI control change controller, see field 'controller_number'          GIG_DECLARE_ENUM(type_t,
242          } type_t;              type_none              = 0x00, /**< No controller defined */
243                type_channelaftertouch = 0x2f, /**< Channel Key Pressure */
244                type_velocity          = 0xff, /**< Key Velocity */
245                type_controlchange     = 0xfe  /**< Ordinary MIDI control change controller, see field 'controller_number' */
246            );
247    
248          type_t type;              ///< Controller type          type_t type;              ///< Controller type
249          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
250    
251            void serialize(Serialization::Archive* archive);
252      };      };
253    
254      /**      /**
# Line 220  namespace gig { Line 278  namespace gig {
278       * 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
279       * 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
280       * the samplechannel dimension which currently allows only 2 zones).       * the samplechannel dimension which currently allows only 2 zones).
281         *
282         * @see enumCount(), enumKey(), enumKeys(), enumValue()
283       */       */
284      typedef enum {      GIG_DECLARE_ENUM(dimension_t,
285          dimension_none              = 0x00, ///< Dimension not in use.          dimension_none              = 0x00, /**< Dimension not in use. */
286          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). */
287          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). */
288          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). */
289          dimension_channelaftertouch = 0x83, ///< Channel Key Pressure          dimension_channelaftertouch = 0x83, /**< Channel Key Pressure */
290          dimension_releasetrigger    = 0x84, ///< Special dimension for triggering samples on releasing a key.          dimension_releasetrigger    = 0x84, /**< Special dimension for triggering samples on releasing a key. */
291          dimension_keyboard          = 0x85, ///< Dimension for keyswitching          dimension_keyboard          = 0x85, /**< Dimension for keyswitching */
292          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 */
293          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 */
294          dimension_smartmidi         = 0x88, ///< For MIDI tools like legato and repetition mode          dimension_smartmidi         = 0x88, /**< For MIDI tools like legato and repetition mode */
295          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 */
296          dimension_modwheel          = 0x01, ///< Modulation Wheel (MIDI Controller 1)          dimension_modwheel          = 0x01, /**< Modulation Wheel (MIDI Controller 1) */
297          dimension_breath            = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)          dimension_breath            = 0x02, /**< Breath Controller (Coarse, MIDI Controller 2) */
298          dimension_foot              = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)          dimension_foot              = 0x04, /**< Foot Pedal (Coarse, MIDI Controller 4) */
299          dimension_portamentotime    = 0x05, ///< Portamento Time (Coarse, MIDI Controller 5)          dimension_portamentotime    = 0x05, /**< Portamento Time (Coarse, MIDI Controller 5) */
300          dimension_effect1           = 0x0c, ///< Effect Controller 1 (Coarse, MIDI Controller 12)          dimension_effect1           = 0x0c, /**< Effect Controller 1 (Coarse, MIDI Controller 12) */
301          dimension_effect2           = 0x0d, ///< Effect Controller 2 (Coarse, MIDI Controller 13)          dimension_effect2           = 0x0d, /**< Effect Controller 2 (Coarse, MIDI Controller 13) */
302          dimension_genpurpose1       = 0x10, ///< General Purpose Controller 1 (Slider, MIDI Controller 16)          dimension_genpurpose1       = 0x10, /**< General Purpose Controller 1 (Slider, MIDI Controller 16) */
303          dimension_genpurpose2       = 0x11, ///< General Purpose Controller 2 (Slider, MIDI Controller 17)          dimension_genpurpose2       = 0x11, /**< General Purpose Controller 2 (Slider, MIDI Controller 17) */
304          dimension_genpurpose3       = 0x12, ///< General Purpose Controller 3 (Slider, MIDI Controller 18)          dimension_genpurpose3       = 0x12, /**< General Purpose Controller 3 (Slider, MIDI Controller 18) */
305          dimension_genpurpose4       = 0x13, ///< General Purpose Controller 4 (Slider, MIDI Controller 19)          dimension_genpurpose4       = 0x13, /**< General Purpose Controller 4 (Slider, MIDI Controller 19) */
306          dimension_sustainpedal      = 0x40, ///< Sustain Pedal (MIDI Controller 64)          dimension_sustainpedal      = 0x40, /**< Sustain Pedal (MIDI Controller 64) */
307          dimension_portamento        = 0x41, ///< Portamento (MIDI Controller 65)          dimension_portamento        = 0x41, /**< Portamento (MIDI Controller 65) */
308          dimension_sostenutopedal    = 0x42, ///< Sostenuto Pedal (MIDI Controller 66)          dimension_sostenutopedal    = 0x42, /**< Sostenuto Pedal (MIDI Controller 66) */
309          dimension_softpedal         = 0x43, ///< Soft Pedal (MIDI Controller 67)          dimension_softpedal         = 0x43, /**< Soft Pedal (MIDI Controller 67) */
310          dimension_genpurpose5       = 0x30, ///< General Purpose Controller 5 (Button, MIDI Controller 80)          dimension_genpurpose5       = 0x30, /**< General Purpose Controller 5 (Button, MIDI Controller 80) */
311          dimension_genpurpose6       = 0x31, ///< General Purpose Controller 6 (Button, MIDI Controller 81)          dimension_genpurpose6       = 0x31, /**< General Purpose Controller 6 (Button, MIDI Controller 81) */
312          dimension_genpurpose7       = 0x32, ///< General Purpose Controller 7 (Button, MIDI Controller 82)          dimension_genpurpose7       = 0x32, /**< General Purpose Controller 7 (Button, MIDI Controller 82) */
313          dimension_genpurpose8       = 0x33, ///< General Purpose Controller 8 (Button, MIDI Controller 83)          dimension_genpurpose8       = 0x33, /**< General Purpose Controller 8 (Button, MIDI Controller 83) */
314          dimension_effect1depth      = 0x5b, ///< Effect 1 Depth (MIDI Controller 91)          dimension_effect1depth      = 0x5b, /**< Effect 1 Depth (MIDI Controller 91) */
315          dimension_effect2depth      = 0x5c, ///< Effect 2 Depth (MIDI Controller 92)          dimension_effect2depth      = 0x5c, /**< Effect 2 Depth (MIDI Controller 92) */
316          dimension_effect3depth      = 0x5d, ///< Effect 3 Depth (MIDI Controller 93)          dimension_effect3depth      = 0x5d, /**< Effect 3 Depth (MIDI Controller 93) */
317          dimension_effect4depth      = 0x5e, ///< Effect 4 Depth (MIDI Controller 94)          dimension_effect4depth      = 0x5e, /**< Effect 4 Depth (MIDI Controller 94) */
318          dimension_effect5depth      = 0x5f  ///< Effect 5 Depth (MIDI Controller 95)          dimension_effect5depth      = 0x5f  /**< Effect 5 Depth (MIDI Controller 95) */
319      } dimension_t;      );
320    
321      /**      /**
322       * Intended for internal usage: will be used to convert a dimension value       * Intended for internal usage: will be used to convert a dimension value
323       * into the corresponding dimension bit number.       * into the corresponding dimension bit number.
324         *
325         * @see enumCount(), enumKey(), enumKeys(), enumValue()
326       */       */
327      typedef enum {      GIG_DECLARE_ENUM(split_type_t,
328          split_type_normal,         ///< dimension value between 0-127          split_type_normal,         /**< dimension value between 0-127 */
329          split_type_bit             ///< dimension values are already the sought bit number          split_type_bit             /**< dimension values are already the sought bit number */
330      } split_type_t;      );
331    
332      /** General dimension definition. */      /** General dimension definition. */
333      struct dimension_def_t {      struct dimension_def_t {
# Line 276  namespace gig { Line 338  namespace gig {
338          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.
339      };      };
340    
341      /** Defines which frequencies are filtered by the VCF. */      /** Defines which frequencies are filtered by the VCF.
342      typedef enum {       *
343          vcf_type_lowpass      = 0x00,       * @see enumCount(), enumKey(), enumKeys(), enumValue()
344          vcf_type_lowpassturbo = 0xff, ///< More poles than normal lowpass       */
345          vcf_type_bandpass     = 0x01,      GIG_DECLARE_ENUM(vcf_type_t,
346          vcf_type_highpass     = 0x02,          vcf_type_lowpass      = 0x00, /**< Standard lowpass filter type. */
347          vcf_type_bandreject   = 0x03          vcf_type_lowpassturbo = 0xff, /**< More poles than normal lowpass. */
348      } vcf_type_t;          vcf_type_bandpass     = 0x01, /**< Bandpass filter type. */
349            vcf_type_highpass     = 0x02, /**< Highpass filter type. */
350            vcf_type_bandreject   = 0x03  /**< Band reject filter type. */
351        );
352    
353      /**      /**
354       * Defines the envelope of a crossfade.       * Defines the envelope of a crossfade.
# Line 304  namespace gig { Line 369  namespace gig {
369          uint8_t out_start;  ///< Start position of fade out.          uint8_t out_start;  ///< Start position of fade out.
370          uint8_t out_end;    ///< End postition of fade out.          uint8_t out_end;    ///< End postition of fade out.
371          #endif // WORDS_BIGENDIAN          #endif // WORDS_BIGENDIAN
372    
373            void serialize(Serialization::Archive* archive);
374      };      };
375    
376      /** Reflects the current playback state for a sample. */      /** Reflects the current playback state for a sample. */
# Line 313  namespace gig { Line 380  namespace gig {
380          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.
381      };      };
382    
383        /**
384         * Defines behavior options for envelope generators (gig format extension).
385         *
386         * These options allow to override the precise default behavior of the
387         * envelope generators' state machines.
388         *
389         * @b Note: These EG options are an extension to the original gig file
390         * format, so these options are not available with the original
391         * Gigasampler/GigaStudio software! Currently only LinuxSampler and gigedit
392         * support these EG options!
393         *
394         * Adding these options to the original gig file format was necessary,
395         * because the precise state machine behavior of envelope generators of the
396         * gig format (and thus the default EG behavior if not explicitly overridden
397         * here) deviates from common, expected behavior of envelope generators in
398         * general, if i.e. compared with EGs of hardware synthesizers. For example
399         * with the gig format, the attack and decay stages will be aborted as soon
400         * as a note-off is received. Most other EG implementations in the industry
401         * however always run the attack and decay stages to their full duration,
402         * even if an early note-off arrives. The latter behavior is intentionally
403         * implemented in most other products, because it is required to resemble
404         * percussive sounds in a realistic manner.
405         */
406        struct eg_opt_t {
407            bool AttackCancel;     ///< Whether the "attack" stage is cancelled when receiving a note-off (default: @c true).
408            bool AttackHoldCancel; ///< Whether the "attack hold" stage is cancelled when receiving a note-off (default: @c true).
409            bool Decay1Cancel;     ///< Whether the "decay 1" stage is cancelled when receiving a note-off (default: @c true).
410            bool Decay2Cancel;     ///< Whether the "decay 2" stage is cancelled when receiving a note-off (default: @c true).
411            bool ReleaseCancel;    ///< Whether the "release" stage is cancelled when receiving a note-on (default: @c true).
412    
413            eg_opt_t();
414            void serialize(Serialization::Archive* archive);
415        };
416    
417        /** @brief Defines behaviour of release triggered sample(s) on sustain pedal up event.
418         *
419         * This option defines whether a sustain pedal up event (CC#64) would cause
420         * release triggered samples to be played (if any).
421         *
422         * @b Note: This option is an extension to the original gig file format,
423         * so this option is not available with the original Gigasampler/GigaStudio
424         * software! Currently only LinuxSampler and gigedit support this option!
425         *
426         * By default (which equals the original Gigasampler/GigaStudio behaviour)
427         * no release triggered samples are played if the sustain pedal is released.
428         * So usually in the gig format release triggered samples are only played
429         * on MIDI note-off events.
430         *
431         * @see enumCount(), enumKey(), enumKeys(), enumValue()
432         */
433        GIG_DECLARE_ENUM(sust_rel_trg_t,
434            sust_rel_trg_none        = 0x00, /**< No release triggered sample(s) are played on sustain pedal up (default). */
435            sust_rel_trg_maxvelocity = 0x01, /**< Play release trigger sample(s) on sustain pedal up, and simply use 127 as MIDI velocity for playback. */
436            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. */
437        );
438    
439      // just symbol prototyping      // just symbol prototyping
440      class File;      class File;
441      class Instrument;      class Instrument;
# Line 451  namespace gig { Line 574  namespace gig {
574              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).
575              double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)              double             SampleAttenuation;             ///< Sample volume (calculated from DLS::Sampler::Gain)
576              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).
577                eg_opt_t           EG1Options;                    ///< [gig extension]: Behavior options which should be used for envelope generator 1 (volume amplitude EG).
578                eg_opt_t           EG2Options;                    ///< [gig extension]: Behavior options which should be used for envelope generator 2 (filter cutoff EG).
579                sust_rel_trg_t     SustainReleaseTrigger;         ///< [gig extension]: Whether a sustain pedal up event shall play release trigger sample.
580                bool               NoNoteOffReleaseTrigger;       ///< [gig extension]: If @c true then don't play a release trigger sample on MIDI note-off events.
581    
582              // derived attributes from DLS::Sampler              // derived attributes from DLS::Sampler
583              using DLS::Sampler::UnityNote;              using DLS::Sampler::UnityNote;
# Line 486  namespace gig { Line 613  namespace gig {
613              DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);              DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);
614             ~DimensionRegion();             ~DimensionRegion();
615              void CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples);              void CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples);
616                void serialize(Serialization::Archive* archive);
617              friend class Region;              friend class Region;
618                friend class Serialization::Archive;
619          private:          private:
620              typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller              typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller
621                  // 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 671  namespace gig { Line 800  namespace gig {
800              virtual void  UpdateChunks(progress_t* pProgress);              virtual void  UpdateChunks(progress_t* pProgress);
801              void CopyAssignMeta(const Sample* orig);              void CopyAssignMeta(const Sample* orig);
802              void CopyAssignWave(const Sample* orig);              void CopyAssignWave(const Sample* orig);
803                uint32_t GetWaveDataCRC32Checksum();
804                bool VerifyWaveData(uint32_t* pActually = NULL);
805          protected:          protected:
806              static size_t        Instances;               ///< Number of instances of class Sample.              static size_t        Instances;               ///< Number of instances of class Sample.
807              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.
# Line 685  namespace gig { Line 816  namespace gig {
816              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)
817              RIFF::Chunk*         pCk3gix;              RIFF::Chunk*         pCk3gix;
818              RIFF::Chunk*         pCkSmpl;              RIFF::Chunk*         pCkSmpl;
819              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().
820    
821              Sample(File* pFile, RIFF::List* waveList, file_offset_t WavePoolOffset, unsigned long fileNo = 0);              Sample(File* pFile, RIFF::List* waveList, file_offset_t WavePoolOffset, unsigned long fileNo = 0, int index = -1);
822             ~Sample();             ~Sample();
823                uint32_t CalculateWaveDataChecksum();
824    
825              // Guess size (in bytes) of a compressed sample              // Guess size (in bytes) of a compressed sample
826              inline file_offset_t GuessSize(file_offset_t samples) {              inline file_offset_t GuessSize(file_offset_t samples) {
# Line 1011  namespace gig { Line 1143  namespace gig {
1143              void   SetScriptAsText(const String& text);              void   SetScriptAsText(const String& text);
1144              void   SetGroup(ScriptGroup* pGroup);              void   SetGroup(ScriptGroup* pGroup);
1145              ScriptGroup* GetGroup() const;              ScriptGroup* GetGroup() const;
1146                void   CopyAssign(const Script* orig);
1147          protected:          protected:
1148              Script(ScriptGroup* group, RIFF::Chunk* ckScri);              Script(ScriptGroup* group, RIFF::Chunk* ckScri);
1149              virtual ~Script();              virtual ~Script();
# Line 1212  namespace gig { Line 1345  namespace gig {
1345          public:          public:
1346              static const DLS::version_t VERSION_2;              static const DLS::version_t VERSION_2;
1347              static const DLS::version_t VERSION_3;              static const DLS::version_t VERSION_3;
1348                static const DLS::version_t VERSION_4;
1349    
1350              // derived attributes from DLS::Resource              // derived attributes from DLS::Resource
1351              using DLS::Resource::pInfo;              using DLS::Resource::pInfo;
# Line 1233  namespace gig { Line 1367  namespace gig {
1367              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.
1368              Sample*     GetSample(uint index);              Sample*     GetSample(uint index);
1369              Sample*     AddSample();              Sample*     AddSample();
1370                size_t      CountSamples();
1371              void        DeleteSample(Sample* pSample);              void        DeleteSample(Sample* pSample);
1372              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.
1373              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.
1374              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);              Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
1375              Instrument* AddInstrument();              Instrument* AddInstrument();
1376              Instrument* AddDuplicateInstrument(const Instrument* orig);              Instrument* AddDuplicateInstrument(const Instrument* orig);
1377                size_t      CountInstruments();
1378              void        DeleteInstrument(Instrument* pInstrument);              void        DeleteInstrument(Instrument* pInstrument);
1379              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.
1380              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 1267  namespace gig { Line 1403  namespace gig {
1403              virtual void LoadInstruments(progress_t* pProgress);              virtual void LoadInstruments(progress_t* pProgress);
1404              virtual void LoadScriptGroups();              virtual void LoadScriptGroups();
1405              void SetSampleChecksum(Sample* pSample, uint32_t crc);              void SetSampleChecksum(Sample* pSample, uint32_t crc);
1406                uint32_t GetSampleChecksum(Sample* pSample);
1407                uint32_t GetSampleChecksumByIndex(int index);
1408                bool VerifySampleChecksumTable();
1409                bool RebuildSampleChecksumTable();
1410                int  GetWaveTableIndexOf(gig::Sample* pSample);
1411              friend class Region;              friend class Region;
1412              friend class Sample;              friend class Sample;
1413              friend class Instrument;              friend class Instrument;
# Line 1289  namespace gig { Line 1430  namespace gig {
1430       */       */
1431      class Exception : public DLS::Exception {      class Exception : public DLS::Exception {
1432          public:          public:
1433              Exception(String Message);              Exception(String format, ...);
1434                Exception(String format, va_list arg);
1435              void PrintMessage();              void PrintMessage();
1436            protected:
1437                Exception();
1438      };      };
1439    
1440    #if HAVE_RTTI
1441        size_t enumCount(const std::type_info& type);
1442        const char* enumKey(const std::type_info& type, size_t value);
1443        bool        enumKey(const std::type_info& type, String key);
1444        const char** enumKeys(const std::type_info& type);
1445    #endif // HAVE_RTTI
1446        size_t enumCount(String typeName);
1447        const char* enumKey(String typeName, size_t value);
1448        bool        enumKey(String typeName, String key);
1449        const char** enumKeys(String typeName);
1450        size_t enumValue(String key);
1451    
1452      String libraryName();      String libraryName();
1453      String libraryVersion();      String libraryVersion();
1454    
Legend:
Removed from v.2922  
changed lines
  Added in v.3446
  ViewVC Help
Powered by ViewVC