/[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 2682 by schoenebeck, Mon Dec 29 16:25:51 2014 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-2014 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  /** Gigasampler specific classes and definitions */  #ifndef GIG_DECLARE_ENUM
87    # define GIG_DECLARE_ENUM(type, ...) enum type { __VA_ARGS__ }
88    #endif
89    
90    // just symbol prototyping (since Serialization.h not included by default here)
91    namespace Serialization { class Archive; }
92    
93    /** Gigasampler/GigaStudio specific classes and definitions */
94  namespace gig {  namespace gig {
95    
96      typedef std::string String;      typedef std::string String;
97      typedef RIFF::progress_t progress_t;      typedef RIFF::progress_t progress_t;
98        typedef RIFF::file_offset_t file_offset_t;
99    
100      /** Lower and upper limit of a range. */      /** Lower and upper limit of a range. */
101      struct range_t {      struct range_t {
# Line 80  namespace gig { Line 106  namespace gig {
106      /** Pointer address and size of a buffer. */      /** Pointer address and size of a buffer. */
107      struct buffer_t {      struct buffer_t {
108          void*         pStart;            ///< Points to the beginning of the buffer.          void*         pStart;            ///< Points to the beginning of the buffer.
109          unsigned long Size;              ///< Size of the actual data in the buffer in bytes.          file_offset_t Size;              ///< Size of the actual data in the buffer in bytes.
110          unsigned long NullExtensionSize; ///< The buffer might be bigger than the actual data, if that's the case that unused space at the end of the buffer is filled with NULLs and NullExtensionSize reflects that unused buffer space in bytes. Those NULL extensions are mandatory for differential algorithms that have to take the following data words into account, thus have to access past the buffer's boundary. If you don't know what I'm talking about, just forget this variable. :)          file_offset_t NullExtensionSize; ///< The buffer might be bigger than the actual data, if that's the case that unused space at the end of the buffer is filled with NULLs and NullExtensionSize reflects that unused buffer space in bytes. Those NULL extensions are mandatory for differential algorithms that have to take the following data words into account, thus have to access past the buffer's boundary. If you don't know what I'm talking about, just forget this variable. :)
111          buffer_t() {          buffer_t() {
112              pStart            = NULL;              pStart            = NULL;
113              Size              = 0;              Size              = 0;
# Line 89  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 181  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 219  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 275  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 303  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. */
377      struct playback_state_t {      struct playback_state_t {
378          unsigned long position;          ///< Current position within the sample.          file_offset_t position;          ///< Current position within the sample.
379          bool          reverse;           ///< If playback direction is currently backwards (in case there is a pingpong or reverse loop defined).          bool          reverse;           ///< If playback direction is currently backwards (in case there is a pingpong or reverse loop defined).
380          unsigned long loop_cycles_left;  ///< How many times the loop has still to be passed, this value will be decremented with each loop cycle.          file_offset_t loop_cycles_left;  ///< How many times the loop has still to be passed, this value will be decremented with each loop cycle.
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 321  namespace gig { Line 445  namespace gig {
445      class Script;      class Script;
446      class ScriptGroup;      class ScriptGroup;
447    
448      /** @brief Encapsulates articulation information of a dimension region.      /** @brief Encapsulates articulation informations of a dimension region.
449       *       *
450       *  Every Gigasampler Instrument has at least one dimension region       * This is the most important data object of the Gigasampler / GigaStudio
451       *  (exactly then when it has no dimension defined).       * format. A DimensionRegion provides the link to the sample to be played
452         * and all required articulation informations to be interpreted for playing
453         * back the sample and processing it appropriately by the sampler software.
454         * Every Region of a Gigasampler Instrument has at least one dimension
455         * region (exactly then when the Region has no dimension defined). Many
456         * Regions though provide more than one DimensionRegion, which reflect
457         * different playing "cases". For example a different sample might be played
458         * if a certain pedal is pressed down, or if the note was triggered with
459         * different velocity.
460       *       *
461       *  Gigasampler provides three Envelope Generators and Low Frequency       * One instance of a DimensionRegion reflects exactly one particular case
462       *  Oscillators:       * while playing an instrument (for instance "note between C3 and E3 was
463         * triggered AND note on velocity was between 20 and 42 AND modulation wheel
464         * controller is between 80 and 127). The DimensionRegion defines what to do
465         * under that one particular case, that is which sample to play back and how
466         * to play that sample back exactly and how to process it. So a
467         * DimensionRegion object is always linked to exactly one sample. It may
468         * however also link to no sample at all, for defining a "silence" case
469         * where nothing shall be played (for example when note on velocity was
470         * below 6).
471         *
472         * Note that a DimensionRegion object only defines "what to do", but it does
473         * not define "when to do it". To actually resolve which DimensionRegion to
474         * pick under which situation, you need to refer to the DimensionRegions'
475         * parent Region object. The Region object contains the necessary
476         * "Dimension" definitions, which in turn define which DimensionRegion is
477         * associated with which playing case exactly.
478         *
479         * The Gigasampler/GigaStudio format defines 3 Envelope Generators and 3
480         * Low Frequency Oscillators:
481       *       *
482       *  - EG1 and LFO1, both controlling sample amplitude       *  - EG1 and LFO1, both controlling sample amplitude
483       *  - EG2 and LFO2, both controlling filter cutoff frequency       *  - EG2 and LFO2, both controlling filter cutoff frequency
484       *  - EG3 and LFO3, both controlling sample pitch       *  - EG3 and LFO3, both controlling sample pitch
485         *
486         * Since the gig format was designed as extension to the DLS file format,
487         * this class is derived from the DLS::Sampler class. So also refer to
488         * DLS::Sampler for additional informations, class attributes and methods.
489       */       */
490      class DimensionRegion : protected DLS::Sampler {      class DimensionRegion : protected DLS::Sampler {
491          public:          public:
# Line 420  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 455  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 558  namespace gig { Line 718  namespace gig {
718              } _lev_ctrl_t;              } _lev_ctrl_t;
719              typedef std::map<uint32_t, double*> VelocityTableMap;              typedef std::map<uint32_t, double*> VelocityTableMap;
720    
721              static uint              Instances;                  ///< Number of DimensionRegion instances.              static size_t            Instances;                  ///< Number of DimensionRegion instances.
722              static VelocityTableMap* pVelocityTables;            ///< Contains the tables corresponding to the various velocity parameters (VelocityResponseCurve and VelocityResponseDepth).              static VelocityTableMap* pVelocityTables;            ///< Contains the tables corresponding to the various velocity parameters (VelocityResponseCurve and VelocityResponseDepth).
723              double*                  pVelocityAttenuationTable;  ///< Points to the velocity table corresponding to the velocity parameters of this DimensionRegion.              double*                  pVelocityAttenuationTable;  ///< Points to the velocity table corresponding to the velocity parameters of this DimensionRegion.
724              double*                  pVelocityReleaseTable;      ///< Points to the velocity table corresponding to the release velocity parameters of this DimensionRegion              double*                  pVelocityReleaseTable;      ///< Points to the velocity table corresponding to the release velocity parameters of this DimensionRegion
# Line 573  namespace gig { Line 733  namespace gig {
733              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);              double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
734      };      };
735    
736      /** @brief Encapsulates sample waves used for playback.      /** @brief Encapsulates sample waves of Gigasampler/GigaStudio files used for playback.
737         *
738         * This class provides access to the actual audio sample data of a
739         * Gigasampler/GigaStudio file. Along to the actual sample data, it also
740         * provides access to the sample's meta informations like bit depth,
741         * sample rate, encoding type, but also loop informations. The latter may be
742         * used by instruments for resembling sounds with arbitary note lengths.
743       *       *
744       * In case you created a new sample with File::AddSample(), you should       * In case you created a new sample with File::AddSample(), you should
745       * first update all attributes with the desired meta informations       * first update all attributes with the desired meta informations
# Line 587  namespace gig { Line 753  namespace gig {
753       * retrieved from the respective DimensionRegon instead from the Sample       * retrieved from the respective DimensionRegon instead from the Sample
754       * itself. This was made for allowing different loop definitions for the       * itself. This was made for allowing different loop definitions for the
755       * same sample under different conditions.       * same sample under different conditions.
756         *
757         * Since the gig format was designed as extension to the DLS file format,
758         * this class is derived from the DLS::Sample class. So also refer to
759         * DLS::Sample for additional informations, class attributes and methods.
760       */       */
761      class Sample : public DLS::Sample {      class Sample : public DLS::Sample {
762          public:          public:
# Line 611  namespace gig { Line 781  namespace gig {
781    
782              // own methods              // own methods
783              buffer_t      LoadSampleData();              buffer_t      LoadSampleData();
784              buffer_t      LoadSampleData(unsigned long SampleCount);              buffer_t      LoadSampleData(file_offset_t SampleCount);
785              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
786              buffer_t      LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);              buffer_t      LoadSampleDataWithNullSamplesExtension(file_offset_t SampleCount, uint NullSamplesCount);
787              buffer_t      GetCache();              buffer_t      GetCache();
788              // own static methods              // own static methods
789              static buffer_t CreateDecompressionBuffer(unsigned long MaxReadSize);              static buffer_t CreateDecompressionBuffer(file_offset_t MaxReadSize);
790              static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);              static void     DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
791              // overridden methods              // overridden methods
792              void          ReleaseSampleData();              void          ReleaseSampleData();
793              void          Resize(int iNewSize);              void          Resize(file_offset_t NewSize);
794              unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);              file_offset_t SetPos(file_offset_t SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
795              unsigned long GetPos() const;              file_offset_t GetPos() const;
796              unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);              file_offset_t Read(void* pBuffer, file_offset_t SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
797              unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL);              file_offset_t ReadAndLoop(void* pBuffer, file_offset_t SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL);
798              unsigned long Write(void* pBuffer, unsigned long SampleCount);              file_offset_t Write(void* pBuffer, file_offset_t SampleCount);
799              Group*        GetGroup() const;              Group*        GetGroup() const;
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 unsigned int  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.
808              Group*               pGroup;                  ///< pointer to the Group this sample belongs to (always not-NULL)              Group*               pGroup;                  ///< pointer to the Group this sample belongs to (always not-NULL)
809              unsigned long        FrameOffset;             ///< Current offset (sample points) in current sample frame (for decompression only).              file_offset_t        FrameOffset;             ///< Current offset (sample points) in current sample frame (for decompression only).
810              unsigned long*       FrameTable;              ///< For positioning within compressed samples only: stores the offset values for each frame.              file_offset_t*       FrameTable;              ///< For positioning within compressed samples only: stores the offset values for each frame.
811              unsigned long        SamplePos;               ///< For compressed samples only: stores the current position (in sample points).              file_offset_t        SamplePos;               ///< For compressed samples only: stores the current position (in sample points).
812              unsigned long        SamplesInLastFrame;      ///< For compressed samples only: length of the last sample frame.              file_offset_t        SamplesInLastFrame;      ///< For compressed samples only: length of the last sample frame.
813              unsigned long        WorstCaseFrameSize;      ///< For compressed samples only: size (in bytes) of the largest possible sample frame.              file_offset_t        WorstCaseFrameSize;      ///< For compressed samples only: size (in bytes) of the largest possible sample frame.
814              unsigned long        SamplesPerFrame;         ///< For compressed samples only: number of samples in a full sample frame.              file_offset_t        SamplesPerFrame;         ///< For compressed samples only: number of samples in a full sample frame.
815              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.              buffer_t             RAMCache;                ///< Buffers samples (already uncompressed) in RAM.
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, unsigned long 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 unsigned long GuessSize(unsigned long samples) {              inline file_offset_t GuessSize(file_offset_t samples) {
827                  // 16 bit: assume all frames are compressed - 1 byte                  // 16 bit: assume all frames are compressed - 1 byte
828                  // per sample and 5 bytes header per 2048 samples                  // per sample and 5 bytes header per 2048 samples
829    
830                  // 24 bit: assume next best compression rate - 1.5                  // 24 bit: assume next best compression rate - 1.5
831                  // bytes per sample and 13 bytes header per 256                  // bytes per sample and 13 bytes header per 256
832                  // samples                  // samples
833                  const unsigned long size =                  const file_offset_t size =
834                      BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13                      BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
835                                     : samples + (samples >> 10) * 5;                                     : samples + (samples >> 10) * 5;
836                  // Double for stereo and add one worst case sample                  // Double for stereo and add one worst case sample
# Line 667  namespace gig { Line 840  namespace gig {
840    
841              // Worst case amount of sample points that can be read with the              // Worst case amount of sample points that can be read with the
842              // given decompression buffer.              // given decompression buffer.
843              inline unsigned long WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {              inline file_offset_t WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
844                  return (unsigned long) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);                  return (file_offset_t) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
845              }              }
846          private:          private:
847              void ScanCompressedSample();              void ScanCompressedSample();
# Line 678  namespace gig { Line 851  namespace gig {
851      };      };
852    
853      // TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions)      // TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions)
854      /** @brief Defines Region information of an Instrument.      /** @brief Defines Region information of a Gigasampler/GigaStudio instrument.
855       *       *
856       * A Region reflects a consecutive area on the keyboard. The individual       * A Region reflects a consecutive area (key range) on the keyboard. The
857       * regions in the gig format may not overlap with other regions (of the same       * individual regions in the gig format may not overlap with other regions
858       * instrument). Further, in the gig format a Region is merely a container       * (of the same instrument that is). Further, in the gig format a Region is
859       * for DimensionRegions (a.k.a. "Cases"). The Region itself does not provide       * merely a container for DimensionRegions (a.k.a. "Cases"). The Region
860       * the sample mapping or articulation informations used, even though the       * itself does not provide the sample mapping or articulation informations
861       * data structures indeed provide such informations. The latter is however       * used, even though the data structures of regions indeed provide such
862       * just of historical nature, because the gig format was derived from the       * informations. The latter is however just of historical nature, because
863       * DLS format.       * the gig file format was derived from the DLS file format.
864       *       *
865       * Each Region consists of at least one or more DimensionRegions. The actual       * Each Region consists of at least one or more DimensionRegions. The actual
866       * amount of DimensionRegions depends on which kind of "dimensions" are       * amount of DimensionRegions depends on which kind of "dimensions" are
867       * defined for this region, and on the split / zone amount for each of those       * defined for this region, and on the split / zone amount for each of those
868       * dimensions.       * dimensions.
869         *
870         * Since the gig format was designed as extension to the DLS file format,
871         * this class is derived from the DLS::Region class. So also refer to
872         * DLS::Region for additional informations, class attributes and methods.
873       */       */
874      class Region : public DLS::Region {      class Region : public DLS::Region {
875          public:          public:
# Line 728  namespace gig { Line 905  namespace gig {
905              friend class Instrument;              friend class Instrument;
906      };      };
907    
908      /** Abstract base class for all MIDI rules. */      /** @brief Abstract base class for all MIDI rules.
909         *
910         * Note: Instead of using MIDI rules, we recommend you using real-time
911         * instrument scripts instead. Read about the reasons below.
912         *
913         * MIDI Rules (also called "iMIDI rules" or "intelligent MIDI rules") were
914         * introduced with GigaStudio 4 as an attempt to increase the power of
915         * potential user controls over sounds. At that point other samplers already
916         * supported certain powerful user control features, which were not possible
917         * with GigaStudio yet. For example triggering new notes by MIDI CC
918         * controller.
919         *
920         * Such extended features however were usually implemented by other samplers
921         * by requiring the sound designer to write an instrument script which the
922         * designer would then bundle with the respective instrument file. Such
923         * scripts are essentially text files, using a very specific programming
924         * language for the purpose of controlling the sampler in real-time. Since
925         * however musicians are not typically keen to writing such cumbersome
926         * script files, the GigaStudio designers decided to implement such extended
927         * features completely without instrument scripts. Instead they created a
928         * set of rules, which could be defined and altered conveniently by mouse
929         * clicks in GSt's instrument editor application. The downside of this
930         * overall approach however, was that those MIDI rules were very limited in
931         * practice. As sound designer you easily came across the possiblities such
932         * MIDI rules were able to offer.
933         *
934         * Due to such severe use case constraints, support for MIDI rules is quite
935         * limited in libgig. At the moment only the "Control Trigger", "Alternator"
936         * and the "Legato" MIDI rules are supported by libgig. Consequently the
937         * graphical instrument editor application gigedit just supports the
938         * "Control Trigger" and "Legato" MIDI rules, and LinuxSampler even does not
939         * support any MIDI rule type at all and LinuxSampler probably will not
940         * support MIDI rules in future either.
941         *
942         * Instead of using MIDI rules, we introduced real-time instrument scripts
943         * as extension to the original GigaStudio file format. This script based
944         * solution is much more powerful than MIDI rules and is already supported
945         * by libgig, gigedit and LinuxSampler.
946         *
947         * @deprecated Just provided for backward compatiblity, use Script for new
948         *             instruments instead.
949         */
950      class MidiRule {      class MidiRule {
951          public:          public:
952              virtual ~MidiRule() { }              virtual ~MidiRule() { }
# Line 737  namespace gig { Line 955  namespace gig {
955              friend class Instrument;              friend class Instrument;
956      };      };
957    
958      /** MIDI rule for triggering notes by control change events. */      /** @brief MIDI rule for triggering notes by control change events.
959         *
960         * A "Control Trigger MIDI rule" allows to trigger new notes by sending MIDI
961         * control change events to the sampler.
962         *
963         * Note: "Control Trigger" MIDI rules are only supported by gigedit, but not
964         * by LinuxSampler. We recommend you using real-time instrument scripts
965         * instead. Read more about the details and reasons for this in the
966         * description of the MidiRule base class.
967         *
968         * @deprecated Just provided for backward compatiblity, use Script for new
969         *             instruments instead. See description of MidiRule for details.
970         */
971      class MidiRuleCtrlTrigger : public MidiRule {      class MidiRuleCtrlTrigger : public MidiRule {
972          public:          public:
973              uint8_t ControllerNumber;   ///< MIDI controller number.              uint8_t ControllerNumber;   ///< MIDI controller number.
# Line 759  namespace gig { Line 989  namespace gig {
989              friend class Instrument;              friend class Instrument;
990      };      };
991    
992      /** MIDI rule for instruments with legato samples. */      /** @brief MIDI rule for instruments with legato samples.
993         *
994         * A "Legato MIDI rule" allows playing instruments resembling the legato
995         * playing technique. In the past such legato articulations were tried to be
996         * simulated by pitching the samples of the instrument. However since
997         * usually a high amount of pitch is needed for legatos, this always sounded
998         * very artificial and unrealistic. The "Legato MIDI rule" thus uses another
999         * approach. Instead of pitching the samples, it allows the sound designer
1000         * to bundle separate, additional samples for the individual legato
1001         * situations and the legato rules defined which samples to be played in
1002         * which situation.
1003         *
1004         * Note: "Legato MIDI rules" are only supported by gigedit, but not
1005         * by LinuxSampler. We recommend you using real-time instrument scripts
1006         * instead. Read more about the details and reasons for this in the
1007         * description of the MidiRule base class.
1008         *
1009         * @deprecated Just provided for backward compatiblity, use Script for new
1010         *             instruments instead. See description of MidiRule for details.
1011         */
1012      class MidiRuleLegato : public MidiRule {      class MidiRuleLegato : public MidiRule {
1013          public:          public:
1014              uint8_t LegatoSamples;     ///< Number of legato samples per key in each direction (always 12)              uint8_t LegatoSamples;     ///< Number of legato samples per key in each direction (always 12)
# Line 780  namespace gig { Line 1029  namespace gig {
1029              friend class Instrument;              friend class Instrument;
1030      };      };
1031    
1032      /** MIDI rule to automatically cycle through specified sequences of different articulations. The instrument must be using the smartmidi dimension. */      /** @brief MIDI rule to automatically cycle through specified sequences of different articulations.
1033         *
1034         * The instrument must be using the smartmidi dimension.
1035         *
1036         * Note: "Alternator" MIDI rules are neither supported by gigedit nor by
1037         * LinuxSampler. We recommend you using real-time instrument scripts
1038         * instead. Read more about the details and reasons for this in the
1039         * description of the MidiRule base class.
1040         *
1041         * @deprecated Just provided for backward compatiblity, use Script for new
1042         *             instruments instead. See description of MidiRule for details.
1043         */
1044      class MidiRuleAlternator : public MidiRule {      class MidiRuleAlternator : public MidiRule {
1045          public:          public:
1046              uint8_t Articulations;     ///< Number of articulations in the instrument              uint8_t Articulations;     ///< Number of articulations in the instrument
# Line 821  namespace gig { Line 1081  namespace gig {
1081              friend class Instrument;              friend class Instrument;
1082      };      };
1083    
1084      /** A MIDI rule not yet implemented by libgig. */      /** @brief A MIDI rule not yet implemented by libgig.
1085         *
1086         * This class is currently used as a place holder by libgig for MIDI rule
1087         * types which are not supported by libgig yet.
1088         *
1089         * Note: Support for missing MIDI rule types are probably never added to
1090         * libgig. We recommend you using real-time instrument scripts instead.
1091         * Read more about the details and reasons for this in the description of
1092         * the MidiRule base class.
1093         *
1094         * @deprecated Just provided for backward compatiblity, use Script for new
1095         *             instruments instead. See description of MidiRule for details.
1096         */
1097      class MidiRuleUnknown : public MidiRule {      class MidiRuleUnknown : public MidiRule {
1098          protected:          protected:
1099              MidiRuleUnknown() { }              MidiRuleUnknown() { }
# Line 838  namespace gig { Line 1110  namespace gig {
1110       *       *
1111       * This is an extension of the GigaStudio format, thus a feature which was       * This is an extension of the GigaStudio format, thus a feature which was
1112       * not available in the GigaStudio 4 software. It is currently only       * not available in the GigaStudio 4 software. It is currently only
1113       * supported by LinuxSampler and gigedit.       * supported by LinuxSampler and gigedit. Scripts will not load with the
1114         * original GigaStudio software.
1115         *
1116         * You find more informations about Instrument Scripts on the LinuxSampler
1117         * documentation site:
1118         *
1119         * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/">About Instrument Scripts in General</a>
1120         * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language">Introduction to the NKSP Script Language</a>
1121         * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language/Reference/">NKSP Reference Manual</a>
1122         * - <a href="http://doc.linuxsampler.org/Gigedit/Managing_Scripts">Using Instrument Scripts with Gigedit</a>
1123       */       */
1124      class Script {      class Script {
1125          public:          public:
# Line 849  namespace gig { Line 1130  namespace gig {
1130                  COMPRESSION_NONE = 0 ///< Is not compressed at all (default).                  COMPRESSION_NONE = 0 ///< Is not compressed at all (default).
1131              };              };
1132              enum Language_t {              enum Language_t {
1133                  LANGUAGE_NKSP = 0 ///< NKSP stands for "Is Not KSP" (default).                  LANGUAGE_NKSP = 0 ///< NKSP stands for "Is Not KSP" (default). Refer to the <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language/Reference/">NKSP Reference Manual</a> for details about this script language.
1134              };              };
1135    
1136              String         Name;        ///< Arbitrary name of the script, which may be displayed i.e. in an instrument editor.              String         Name;        ///< Arbitrary name of the script, which may be displayed i.e. in an instrument editor.
# Line 862  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 907  namespace gig { Line 1189  namespace gig {
1189              std::list<Script*>*  pScripts;              std::list<Script*>*  pScripts;
1190      };      };
1191    
1192      /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */      /** @brief Provides access to a Gigasampler/GigaStudio instrument.
1193         *
1194         * This class provides access to Gigasampler/GigaStudio instruments
1195         * contained in .gig files. A gig instrument is merely a set of keyboard
1196         * ranges (called Region), plus some additional global informations about
1197         * the instrument. The major part of the actual instrument definition used
1198         * for the synthesis of the instrument is contained in the respective Region
1199         * object (or actually in the respective DimensionRegion object being, see
1200         * description of Region for details).
1201         *
1202         * Since the gig format was designed as extension to the DLS file format,
1203         * this class is derived from the DLS::Instrument class. So also refer to
1204         * DLS::Instrument for additional informations, class attributes and
1205         * methods.
1206         */
1207      class Instrument : protected DLS::Instrument {      class Instrument : protected DLS::Instrument {
1208          public:          public:
1209              // derived attributes from DLS::Resource              // derived attributes from DLS::Resource
# Line 936  namespace gig { Line 1232  namespace gig {
1232              Region*   GetNextRegion();              Region*   GetNextRegion();
1233              Region*   AddRegion();              Region*   AddRegion();
1234              void      DeleteRegion(Region* pRegion);              void      DeleteRegion(Region* pRegion);
1235                void      MoveTo(Instrument* dst);
1236              virtual void UpdateChunks(progress_t* pProgress);              virtual void UpdateChunks(progress_t* pProgress);
1237              virtual void CopyAssign(const Instrument* orig);              virtual void CopyAssign(const Instrument* orig);
1238              // own methods              // own methods
# Line 979  namespace gig { Line 1276  namespace gig {
1276              std::vector<_ScriptPooolRef>* pScriptRefs;              std::vector<_ScriptPooolRef>* pScriptRefs;
1277      };      };
1278    
1279      /** @brief Group of Gigasampler objects      /** @brief Group of Gigasampler samples
1280       *       *
1281       * Groups help to organize a huge collection of Gigasampler objects.       * Groups help to organize a huge collection of Gigasampler samples.
1282       * Groups are not concerned at all for the synthesis, but they help       * Groups are not concerned at all for the synthesis, but they help
1283       * sound library developers when working on complex instruments with an       * sound library developers when working on complex instruments with an
1284       * instrument editor (as long as that instrument editor supports it ;-).       * instrument editor (as long as that instrument editor supports it ;-).
1285       *       *
      * At the moment, it seems as only samples can be grouped together in  
      * the Gigasampler format yet. If this is false in the meantime, please  
      * tell us !  
      *  
1286       * A sample is always assigned to exactly one Group. This also means       * A sample is always assigned to exactly one Group. This also means
1287       * 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
1288       * created one yet or not.       * created one yet or not.
# Line 1012  namespace gig { Line 1305  namespace gig {
1305              RIFF::Chunk* pNameChunk; ///< '3gnm' chunk              RIFF::Chunk* pNameChunk; ///< '3gnm' chunk
1306      };      };
1307    
1308      /** Parses Gigasampler files and provides abstract access to the data. */      /** @brief Provides convenient access to Gigasampler/GigaStudio .gig files.
1309         *
1310         * This is the entry class for accesing a Gigasampler/GigaStudio (.gig) file
1311         * with libgig. It allows you to open existing .gig files, modifying them
1312         * and saving them persistently either under the same file name or under a
1313         * different location.
1314         *
1315         * A .gig file is merely a monolithic file. That means samples and the
1316         * defintion of the virtual instruments are contained in the same file. A
1317         * .gig file contains an arbitrary amount of samples, and an arbitrary
1318         * amount of instruments which are referencing those samples. It is also
1319         * possible to store samples in .gig files not being referenced by any
1320         * instrument. This is not an error from the file format's point of view and
1321         * it is actually often used in practice during the design phase of new gig
1322         * instruments.
1323         *
1324         * So on toplevel of the gig file format you have:
1325         *
1326         * - A set of samples (see Sample).
1327         * - A set of virtual instruments (see Instrument).
1328         *
1329         * And as extension to the original GigaStudio format, we added:
1330         *
1331         * - Real-time instrument scripts (see Script).
1332         *
1333         * Note that the latter however is only supported by libgig, gigedit and
1334         * LinuxSampler. Scripts are not supported by the original GigaStudio
1335         * software.
1336         *
1337         * All released Gigasampler/GigaStudio file format versions are supported
1338         * (so from first Gigasampler version up to including GigaStudio 4).
1339         *
1340         * Since the gig format was designed as extension to the DLS file format,
1341         * this class is derived from the DLS::File class. So also refer to
1342         * DLS::File for additional informations, class attributes and methods.
1343         */
1344      class File : protected DLS::File {      class File : protected DLS::File {
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 1038  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 1072  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;
1414              friend class Group; // so Group can access protected member pRIFF              friend class Group; // so Group can access protected member pRIFF
1415              friend class ScriptGroup; // so ScriptGroup can access protected member pRIFF              friend class ScriptGroup; // so ScriptGroup can access protected member pRIFF
1416          private:          private:
# Line 1093  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.2682  
changed lines
  Added in v.3446
  ViewVC Help
Powered by ViewVC