/[svn]/libgig/trunk/src/gig.h
ViewVC logotype

Annotation of /libgig/trunk/src/gig.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 774 - (hide annotations) (download) (as text)
Sun Sep 18 12:41:56 2005 UTC (18 years, 5 months ago) by persson
File MIME type: text/x-c++hdr
File size: 51587 byte(s)
* support for the gig v3 feature to have a number of dimension splits
  not equal to a power of two

1 schoenebeck 2 /***************************************************************************
2     * *
3     * libgig - C++ cross-platform Gigasampler format file loader library *
4     * *
5 schoenebeck 384 * Copyright (C) 2003-2005 by Christian Schoenebeck *
6     * <cuse@users.sourceforge.net> *
7 schoenebeck 2 * *
8     * This library is free software; you can redistribute it and/or modify *
9     * it under the terms of the GNU General Public License as published by *
10     * the Free Software Foundation; either version 2 of the License, or *
11     * (at your option) any later version. *
12     * *
13     * This library is distributed in the hope that it will be useful, *
14     * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16     * GNU General Public License for more details. *
17     * *
18     * You should have received a copy of the GNU General Public License *
19     * along with this library; if not, write to the Free Software *
20     * Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21     * MA 02111-1307 USA *
22     ***************************************************************************/
23    
24     #ifndef __GIG_H__
25     #define __GIG_H__
26    
27     #include "DLS.h"
28    
29     #include <math.h>
30     #include <string.h>
31    
32     /// Initial size of the sample buffer which is used for decompression of
33     /// compressed sample wave streams - this value should always be bigger than
34     /// the biggest sample piece expected to be read by the sampler engine,
35     /// otherwise the buffer size will be raised at runtime and thus the buffer
36     /// reallocated which is time consuming and unefficient.
37     #define INITIAL_SAMPLE_BUFFER_SIZE 512000 // 512 kB
38    
39 schoenebeck 11 #if WORDS_BIGENDIAN
40 schoenebeck 2 # define LIST_TYPE_3PRG 0x33707267
41     # define LIST_TYPE_3EWL 0x3365776C
42     # define CHUNK_ID_SMPL 0x736D706C
43     # define CHUNK_ID_3GIX 0x33676978
44     # define CHUNK_ID_3EWA 0x33657761
45     # define CHUNK_ID_3LNK 0x336C6E6B
46     # define CHUNK_ID_3EWG 0x33657767
47     # define CHUNK_ID_EWAV 0x65776176
48     #else // little endian
49     # define LIST_TYPE_3PRG 0x67727033
50     # define LIST_TYPE_3EWL 0x6C776533
51     # define CHUNK_ID_SMPL 0x6C706D73
52     # define CHUNK_ID_3GIX 0x78696733
53     # define CHUNK_ID_3EWA 0x61776533
54     # define CHUNK_ID_3LNK 0x6B6E6C33
55     # define CHUNK_ID_3EWG 0x67776533
56     # define CHUNK_ID_EWAV 0x76617765
57     #endif // WORDS_BIGENDIAN
58    
59     /** (so far) every exponential paramater in the gig format has a basis of 1.000000008813822 */
60 schoenebeck 16 #define GIG_EXP_DECODE(x) (pow(1.000000008813822, x))
61     #define GIG_PITCH_TRACK_EXTRACT(x) (!(x & 0x01))
62     #define GIG_VCF_RESONANCE_CTRL_EXTRACT(x) ((x >> 4) & 0x03)
63     #define GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(x) ((x >> 1) & 0x03)
64     #define GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(x) ((x >> 3) & 0x03)
65     #define GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(x) ((x >> 5) & 0x03)
66 schoenebeck 2
67     /** Gigasampler specific classes and definitions */
68     namespace gig {
69    
70     typedef std::string String;
71    
72     /** Lower and upper limit of a range. */
73     struct range_t {
74     uint8_t low; ///< Low value of range.
75     uint8_t high; ///< High value of range.
76     };
77    
78     /** Pointer address and size of a buffer. */
79     struct buffer_t {
80     void* pStart; ///< Points to the beginning of the buffer.
81     unsigned long Size; ///< Size of the actual data in the buffer in bytes.
82     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. :)
83 schoenebeck 384 buffer_t() {
84     pStart = NULL;
85     Size = 0;
86     NullExtensionSize = 0;
87     }
88 schoenebeck 2 };
89    
90     /** Standard types of sample loops. */
91     typedef enum {
92     loop_type_normal = 0x00000000, ///< Loop forward (normal)
93     loop_type_bidirectional = 0x00000001, ///< Alternating loop (forward/backward, also known as Ping Pong)
94     loop_type_backward = 0x00000002 ///< Loop backward (reverse)
95     } loop_type_t;
96    
97     /** Society of Motion Pictures and Television E time format. */
98     typedef enum {
99     smpte_format_no_offset = 0x00000000, ///< no SMPTE offset
100     smpte_format_24_frames = 0x00000018, ///< 24 frames per second
101     smpte_format_25_frames = 0x00000019, ///< 25 frames per second
102     smpte_format_30_frames_dropping = 0x0000001D, ///< 30 frames per second with frame dropping (30 drop)
103     smpte_format_30_frames = 0x0000001E ///< 30 frames per second
104     } smpte_format_t;
105    
106     /** Defines the shape of a function graph. */
107     typedef enum {
108     curve_type_nonlinear = 0,
109     curve_type_linear = 1,
110     curve_type_special = 2,
111     curve_type_unknown = 0xffffffff
112     } curve_type_t;
113    
114     /** Dimensions allow to bypass one of the following controllers. */
115     typedef enum {
116     dim_bypass_ctrl_none,
117     dim_bypass_ctrl_94, ///< Effect 4 Depth (MIDI Controller 94)
118     dim_bypass_ctrl_95 ///< Effect 5 Depth (MIDI Controller 95)
119     } dim_bypass_ctrl_t;
120    
121     /** Defines how LFO3 is controlled by. */
122     typedef enum {
123     lfo3_ctrl_internal = 0x00, ///< Only internally controlled.
124     lfo3_ctrl_modwheel = 0x01, ///< Only controlled by external modulation wheel.
125     lfo3_ctrl_aftertouch = 0x02, ///< Only controlled by aftertouch controller.
126     lfo3_ctrl_internal_modwheel = 0x03, ///< Controlled internally and by external modulation wheel.
127     lfo3_ctrl_internal_aftertouch = 0x04 ///< Controlled internally and by aftertouch controller.
128     } lfo3_ctrl_t;
129    
130     /** Defines how LFO2 is controlled by. */
131     typedef enum {
132     lfo2_ctrl_internal = 0x00, ///< Only internally controlled.
133     lfo2_ctrl_modwheel = 0x01, ///< Only controlled by external modulation wheel.
134     lfo2_ctrl_foot = 0x02, ///< Only controlled by external foot controller.
135     lfo2_ctrl_internal_modwheel = 0x03, ///< Controlled internally and by external modulation wheel.
136     lfo2_ctrl_internal_foot = 0x04 ///< Controlled internally and by external foot controller.
137     } lfo2_ctrl_t;
138    
139     /** Defines how LFO1 is controlled by. */
140     typedef enum {
141     lfo1_ctrl_internal = 0x00, ///< Only internally controlled.
142     lfo1_ctrl_modwheel = 0x01, ///< Only controlled by external modulation wheel.
143     lfo1_ctrl_breath = 0x02, ///< Only controlled by external breath controller.
144     lfo1_ctrl_internal_modwheel = 0x03, ///< Controlled internally and by external modulation wheel.
145     lfo1_ctrl_internal_breath = 0x04 ///< Controlled internally and by external breath controller.
146     } lfo1_ctrl_t;
147    
148     /** Defines how the filter cutoff frequency is controlled by. */
149     typedef enum {
150     vcf_cutoff_ctrl_none = 0x00,
151 persson 773 vcf_cutoff_ctrl_none2 = 0x01, ///< The difference betwheen none and none2 is unknown
152 schoenebeck 2 vcf_cutoff_ctrl_modwheel = 0x81, ///< Modulation Wheel (MIDI Controller 1)
153     vcf_cutoff_ctrl_effect1 = 0x8c, ///< Effect Controller 1 (Coarse, MIDI Controller 12)
154     vcf_cutoff_ctrl_effect2 = 0x8d, ///< Effect Controller 2 (Coarse, MIDI Controller 13)
155     vcf_cutoff_ctrl_breath = 0x82, ///< Breath Controller (Coarse, MIDI Controller 2)
156     vcf_cutoff_ctrl_foot = 0x84, ///< Foot Pedal (Coarse, MIDI Controller 4)
157     vcf_cutoff_ctrl_sustainpedal = 0xc0, ///< Sustain Pedal (MIDI Controller 64)
158     vcf_cutoff_ctrl_softpedal = 0xc3, ///< Soft Pedal (MIDI Controller 67)
159     vcf_cutoff_ctrl_genpurpose7 = 0xd2, ///< General Purpose Controller 7 (Button, MIDI Controller 82)
160     vcf_cutoff_ctrl_genpurpose8 = 0xd3, ///< General Purpose Controller 8 (Button, MIDI Controller 83)
161     vcf_cutoff_ctrl_aftertouch = 0x80 ///< Key Pressure
162     } vcf_cutoff_ctrl_t;
163    
164     /** Defines how the filter resonance is controlled by. */
165     typedef enum {
166     vcf_res_ctrl_none = 0xffffffff,
167     vcf_res_ctrl_genpurpose3 = 0, ///< General Purpose Controller 3 (Slider, MIDI Controller 18)
168     vcf_res_ctrl_genpurpose4 = 1, ///< General Purpose Controller 4 (Slider, MIDI Controller 19)
169     vcf_res_ctrl_genpurpose5 = 2, ///< General Purpose Controller 5 (Button, MIDI Controller 80)
170     vcf_res_ctrl_genpurpose6 = 3 ///< General Purpose Controller 6 (Button, MIDI Controller 81)
171     } vcf_res_ctrl_t;
172 schoenebeck 55
173 schoenebeck 36 /**
174     * Defines a controller that has a certain contrained influence on a
175     * particular synthesis parameter (used to define attenuation controller,
176     * EG1 controller and EG2 controller).
177     *
178     * You should use the respective <i>typedef</i> (means either
179     * attenuation_ctrl_t, eg1_ctrl_t or eg2_ctrl_t) in your code!
180     */
181     struct leverage_ctrl_t {
182     typedef enum {
183     type_none = 0x00, ///< No controller defined
184     type_channelaftertouch = 0x2f, ///< Channel Key Pressure
185     type_velocity = 0xff, ///< Key Velocity
186     type_controlchange = 0xfe ///< Ordinary MIDI control change controller, see field 'controller_number'
187     } type_t;
188 schoenebeck 55
189 schoenebeck 36 type_t type; ///< Controller type
190     uint controller_number; ///< MIDI controller number if this controller is a control change controller, 0 otherwise
191     };
192 schoenebeck 55
193 schoenebeck 36 /**
194     * Defines controller influencing attenuation.
195     *
196     * @see leverage_ctrl_t
197     */
198     typedef leverage_ctrl_t attenuation_ctrl_t;
199 schoenebeck 55
200 schoenebeck 36 /**
201     * Defines controller influencing envelope generator 1.
202     *
203     * @see leverage_ctrl_t
204     */
205     typedef leverage_ctrl_t eg1_ctrl_t;
206 schoenebeck 55
207 schoenebeck 36 /**
208     * Defines controller influencing envelope generator 2.
209     *
210     * @see leverage_ctrl_t
211     */
212     typedef leverage_ctrl_t eg2_ctrl_t;
213 schoenebeck 2
214     /**
215     * Defines the type of dimension, that is how the dimension zones (and
216     * thus how the dimension regions are selected by. The number of
217     * dimension zones is always a power of two. All dimensions can have up
218     * to 32 zones (except the layer dimension with only up to 8 zones and
219     * the samplechannel dimension which currently allows only 2 zones).
220     */
221     typedef enum {
222     dimension_none = 0x00, ///< Dimension not in use.
223     dimension_samplechannel = 0x80, ///< If used sample has more than one channel (thus is not mono).
224     dimension_layer = 0x81, ///< For layering of up to 8 instruments (and eventually crossfading of 2 or 4 layers).
225     dimension_velocity = 0x82, ///< Key Velocity (this is the only dimension where the ranges can exactly be defined).
226     dimension_channelaftertouch = 0x83, ///< Channel Key Pressure
227     dimension_releasetrigger = 0x84, ///< Special dimension for triggering samples on releasing a key.
228 schoenebeck 353 dimension_keyboard = 0x85, ///< Dimension for keyswitching
229 persson 437 dimension_roundrobin = 0x86, ///< Different samples triggered each time a note is played, dimension regions selected in sequence
230     dimension_random = 0x87, ///< Different samples triggered each time a note is played, random order
231 schoenebeck 2 dimension_modwheel = 0x01, ///< Modulation Wheel (MIDI Controller 1)
232     dimension_breath = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)
233     dimension_foot = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)
234     dimension_portamentotime = 0x05, ///< Portamento Time (Coarse, MIDI Controller 5)
235     dimension_effect1 = 0x0c, ///< Effect Controller 1 (Coarse, MIDI Controller 12)
236     dimension_effect2 = 0x0d, ///< Effect Controller 2 (Coarse, MIDI Controller 13)
237     dimension_genpurpose1 = 0x10, ///< General Purpose Controller 1 (Slider, MIDI Controller 16)
238     dimension_genpurpose2 = 0x11, ///< General Purpose Controller 2 (Slider, MIDI Controller 17)
239     dimension_genpurpose3 = 0x12, ///< General Purpose Controller 3 (Slider, MIDI Controller 18)
240     dimension_genpurpose4 = 0x13, ///< General Purpose Controller 4 (Slider, MIDI Controller 19)
241     dimension_sustainpedal = 0x40, ///< Sustain Pedal (MIDI Controller 64)
242     dimension_portamento = 0x41, ///< Portamento (MIDI Controller 65)
243     dimension_sostenutopedal = 0x42, ///< Sostenuto Pedal (MIDI Controller 66)
244     dimension_softpedal = 0x43, ///< Soft Pedal (MIDI Controller 67)
245     dimension_genpurpose5 = 0x30, ///< General Purpose Controller 5 (Button, MIDI Controller 80)
246     dimension_genpurpose6 = 0x31, ///< General Purpose Controller 6 (Button, MIDI Controller 81)
247     dimension_genpurpose7 = 0x32, ///< General Purpose Controller 7 (Button, MIDI Controller 82)
248     dimension_genpurpose8 = 0x33, ///< General Purpose Controller 8 (Button, MIDI Controller 83)
249     dimension_effect1depth = 0x5b, ///< Effect 1 Depth (MIDI Controller 91)
250     dimension_effect2depth = 0x5c, ///< Effect 2 Depth (MIDI Controller 92)
251     dimension_effect3depth = 0x5d, ///< Effect 3 Depth (MIDI Controller 93)
252     dimension_effect4depth = 0x5e, ///< Effect 4 Depth (MIDI Controller 94)
253     dimension_effect5depth = 0x5f ///< Effect 5 Depth (MIDI Controller 95)
254     } dimension_t;
255    
256     /**
257     * Intended for internal usage: will be used to convert a dimension value
258     * into the corresponding dimension bit number.
259     */
260     typedef enum {
261     split_type_normal, ///< dimension value between 0-127, no custom range of zones
262     split_type_customvelocity, ///< a velocity dimension split with custom range definition for each zone (if a velocity dimension split has no custom defined zone ranges then it's also just of type split_type_normal)
263     split_type_bit ///< dimension values are already the sought bit number
264     } split_type_t;
265    
266     /** General dimension definition. */
267     struct dimension_def_t {
268     dimension_t dimension; ///< Specifies which source (usually a MIDI controller) is associated with the dimension.
269     uint8_t bits; ///< Number of "bits" (1 bit = 2 splits/zones, 2 bit = 4 splits/zones, 3 bit = 8 splits/zones,...).
270     uint8_t zones; ///< Number of zones the dimension has.
271     split_type_t split_type; ///< Intended for internal usage: will be used to convert a dimension value into the corresponding dimension bit number.
272     range_t* ranges; ///< Intended for internal usage: Points to the beginning of a range_t array which reflects the value ranges of each dimension zone (only if custom defined ranges are defined, is NULL otherwise).
273 persson 774 float zone_size; ///< Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only, 0 otherwise.
274 schoenebeck 2 };
275    
276     /** Defines which frequencies are filtered by the VCF. */
277     typedef enum {
278     vcf_type_lowpass = 0x00,
279     vcf_type_lowpassturbo = 0xff, ///< More poles than normal lowpass
280     vcf_type_bandpass = 0x01,
281     vcf_type_highpass = 0x02,
282     vcf_type_bandreject = 0x03
283     } vcf_type_t;
284    
285 schoenebeck 345 /**
286     * Defines the envelope of a crossfade.
287     *
288     * Note: The default value for crossfade points is 0,0,0,0. Layers with
289     * such a default value should be treated as if they would not have a
290 schoenebeck 353 * crossfade.
291 schoenebeck 345 */
292 schoenebeck 2 struct crossfade_t {
293     #if WORDS_BIGENDIAN
294 schoenebeck 345 uint8_t out_end; ///< End postition of fade out.
295     uint8_t out_start; ///< Start position of fade out.
296     uint8_t in_end; ///< End position of fade in.
297 schoenebeck 2 uint8_t in_start; ///< Start position of fade in.
298 schoenebeck 345 #else // little endian
299     uint8_t in_start; ///< Start position of fade in.
300 schoenebeck 2 uint8_t in_end; ///< End position of fade in.
301     uint8_t out_start; ///< Start position of fade out.
302     uint8_t out_end; ///< End postition of fade out.
303     #endif // WORDS_BIGENDIAN
304     };
305    
306 schoenebeck 24 /** Reflects the current playback state for a sample. */
307     struct playback_state_t {
308     unsigned long position; ///< Current position within the sample.
309     bool reverse; ///< If playback direction is currently backwards (in case there is a pingpong or reverse loop defined).
310     unsigned long loop_cycles_left; ///< How many times the loop has still to be passed, this value will be decremented with each loop cycle.
311     };
312    
313 schoenebeck 515 /**
314     * @brief Used for indicating the progress of a certain task.
315     *
316     * The function pointer argument has to be supplied with a valid
317     * function of the given signature which will then be called on
318 schoenebeck 516 * progress changes. An equivalent progress_t structure will be passed
319     * back as argument to the callback function on each progress change.
320     * The factor field of the supplied progress_t structure will then
321     * reflect the current progress as value between 0.0 and 1.0. You might
322     * want to use the custom field for data needed in your callback
323     * function.
324 schoenebeck 515 */
325     struct progress_t {
326 schoenebeck 516 void (*callback)(progress_t*); ///< Callback function pointer which has to be assigned to a function for progress notification.
327     float factor; ///< Reflects current progress as value between 0.0 and 1.0.
328     void* custom; ///< This pointer can be used for arbitrary data.
329     float __range_min; ///< Only for internal usage, do not modify!
330     float __range_max; ///< Only for internal usage, do not modify!
331 schoenebeck 515 progress_t();
332     };
333    
334 schoenebeck 2 // just symbol prototyping
335     class File;
336     class Instrument;
337     class Sample;
338 capela 310 class Region;
339 schoenebeck 2
340     /** Encapsulates articulation information of a dimension region.
341     *
342     * Every Gigasampler Instrument has at least one dimension region
343     * (exactly then when it has no dimension defined).
344     *
345     * Gigasampler provides three Envelope Generators and Low Frequency
346     * Oscillators:
347     *
348     * - EG1 and LFO1, both controlling sample amplitude
349     * - EG2 and LFO2, both controlling filter cutoff frequency
350     * - EG3 and LFO3, both controlling sample pitch
351     */
352     class DimensionRegion : protected DLS::Sampler {
353     public:
354     uint8_t VelocityUpperLimit; ///< Defines the upper velocity value limit of a velocity split (only if an user defined limit was set, thus a value not equal to 128/NumberOfSplits, else this value is 0).
355     Sample* pSample; ///< Points to the Sample which is assigned to the dimension region.
356     // Sample Amplitude EG/LFO
357     uint16_t EG1PreAttack; ///< Preattack value of the sample amplitude EG (0 - 1000 permille).
358     double EG1Attack; ///< Attack time of the sample amplitude EG (0.000 - 60.000s).
359     double EG1Decay1; ///< Decay time of the sample amplitude EG (0.000 - 60.000s).
360     double EG1Decay2; ///< Only if <i>EG1InfiniteSustain == false</i>: 2nd decay stage time of the sample amplitude EG (0.000 - 60.000s).
361     bool EG1InfiniteSustain; ///< If <i>true</i>, instead of going into Decay2 phase, Decay1 level will be hold until note will be released.
362     uint16_t EG1Sustain; ///< Sustain value of the sample amplitude EG (0 - 1000 permille).
363     double EG1Release; ///< Release time of the sample amplitude EG (0.000 - 60.000s).
364     bool EG1Hold; ///< If <i>true</i>, Decay1 stage should be postponed until the sample reached the sample loop start.
365     eg1_ctrl_t EG1Controller; ///< MIDI Controller which has influence on sample amplitude EG parameters (attack, decay, release).
366     bool EG1ControllerInvert; ///< Invert values coming from defined EG1 controller.
367 schoenebeck 36 uint8_t EG1ControllerAttackInfluence; ///< Amount EG1 Controller has influence on the EG1 Attack time (0 - 3, where 0 means off).
368     uint8_t EG1ControllerDecayInfluence; ///< Amount EG1 Controller has influence on the EG1 Decay time (0 - 3, where 0 means off).
369     uint8_t EG1ControllerReleaseInfluence; ///< Amount EG1 Controller has influence on the EG1 Release time (0 - 3, where 0 means off).
370 schoenebeck 2 double LFO1Frequency; ///< Frequency of the sample amplitude LFO (0.10 - 10.00 Hz).
371     uint16_t LFO1InternalDepth; ///< Firm pitch of the sample amplitude LFO (0 - 1200 cents).
372     uint16_t LFO1ControlDepth; ///< Controller depth influencing sample amplitude LFO pitch (0 - 1200 cents).
373     lfo1_ctrl_t LFO1Controller; ///< MIDI Controller which controls sample amplitude LFO.
374     bool LFO1FlipPhase; ///< Inverts phase of the sample amplitude LFO wave.
375     bool LFO1Sync; ///< If set to <i>true</i> only one LFO should be used for all voices.
376     // Filter Cutoff Frequency EG/LFO
377     uint16_t EG2PreAttack; ///< Preattack value of the filter cutoff EG (0 - 1000 permille).
378     double EG2Attack; ///< Attack time of the filter cutoff EG (0.000 - 60.000s).
379     double EG2Decay1; ///< Decay time of the filter cutoff EG (0.000 - 60.000s).
380     double EG2Decay2; ///< Only if <i>EG2InfiniteSustain == false</i>: 2nd stage decay time of the filter cutoff EG (0.000 - 60.000s).
381     bool EG2InfiniteSustain; ///< If <i>true</i>, instead of going into Decay2 phase, Decay1 level will be hold until note will be released.
382     uint16_t EG2Sustain; ///< Sustain value of the filter cutoff EG (0 - 1000 permille).
383     double EG2Release; ///< Release time of the filter cutoff EG (0.000 - 60.000s).
384     eg2_ctrl_t EG2Controller; ///< MIDI Controller which has influence on filter cutoff EG parameters (attack, decay, release).
385     bool EG2ControllerInvert; ///< Invert values coming from defined EG2 controller.
386 schoenebeck 36 uint8_t EG2ControllerAttackInfluence; ///< Amount EG2 Controller has influence on the EG2 Attack time (0 - 3, where 0 means off).
387     uint8_t EG2ControllerDecayInfluence; ///< Amount EG2 Controller has influence on the EG2 Decay time (0 - 3, where 0 means off).
388     uint8_t EG2ControllerReleaseInfluence; ///< Amount EG2 Controller has influence on the EG2 Release time (0 - 3, where 0 means off).
389 schoenebeck 2 double LFO2Frequency; ///< Frequency of the filter cutoff LFO (0.10 - 10.00 Hz).
390     uint16_t LFO2InternalDepth; ///< Firm pitch of the filter cutoff LFO (0 - 1200 cents).
391     uint16_t LFO2ControlDepth; ///< Controller depth influencing filter cutoff LFO pitch (0 - 1200).
392     lfo2_ctrl_t LFO2Controller; ///< MIDI Controlle which controls the filter cutoff LFO.
393     bool LFO2FlipPhase; ///< Inverts phase of the filter cutoff LFO wave.
394     bool LFO2Sync; ///< If set to <i>true</i> only one LFO should be used for all voices.
395     // Sample Pitch EG/LFO
396     double EG3Attack; ///< Attack time of the sample pitch EG (0.000 - 10.000s).
397     int16_t EG3Depth; ///< Depth of the sample pitch EG (-1200 - +1200).
398     double LFO3Frequency; ///< Frequency of the sample pitch LFO (0.10 - 10.00 Hz).
399     int16_t LFO3InternalDepth; ///< Firm depth of the sample pitch LFO (-1200 - +1200 cents).
400     int16_t LFO3ControlDepth; ///< Controller depth of the sample pitch LFO (-1200 - +1200 cents).
401     lfo3_ctrl_t LFO3Controller; ///< MIDI Controller which controls the sample pitch LFO.
402     bool LFO3Sync; ///< If set to <i>true</i> only one LFO should be used for all voices.
403     // Filter
404     bool VCFEnabled; ///< If filter should be used.
405     vcf_type_t VCFType; ///< Defines the general filter characteristic (lowpass, highpass, bandpass, etc.).
406     vcf_cutoff_ctrl_t VCFCutoffController; ///< Specifies which external controller has influence on the filter cutoff frequency.
407 persson 728 bool VCFCutoffControllerInvert; ///< Inverts values coming from the defined cutoff controller
408 schoenebeck 2 uint8_t VCFCutoff; ///< Max. cutoff frequency.
409     curve_type_t VCFVelocityCurve; ///< Defines a transformation curve for the incoming velocity values, affecting the VCF.
410 persson 728 uint8_t VCFVelocityScale; ///< (0-127) Amount velocity controls VCF cutoff frequency (only if no other VCF cutoff controller is defined, otherwise this is the minimum cutoff).
411 schoenebeck 2 uint8_t VCFVelocityDynamicRange; ///< 0x04 = lowest, 0x00 = highest
412     uint8_t VCFResonance; ///< Firm internal filter resonance weight.
413     bool VCFResonanceDynamic; ///< If <i>true</i>: Increases the resonance Q according to changes of controllers that actually control the VCF cutoff frequency (EG2, ext. VCF MIDI controller).
414     vcf_res_ctrl_t VCFResonanceController; ///< Specifies which external controller has influence on the filter resonance Q.
415     bool VCFKeyboardTracking; ///< If <i>true</i>: VCF cutoff frequence will be dependend to the note key position relative to the defined breakpoint value.
416     uint8_t VCFKeyboardTrackingBreakpoint; ///< See VCFKeyboardTracking (0 - 127).
417     // Key Velocity Transformations
418 schoenebeck 231 curve_type_t VelocityResponseCurve; ///< Defines a transformation curve to the incoming velocity values affecting amplitude (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead).
419     uint8_t VelocityResponseDepth; ///< Dynamic range of velocity affecting amplitude (0 - 4) (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead).
420     uint8_t VelocityResponseCurveScaling; ///< 0 - 127 (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead)
421 schoenebeck 2 curve_type_t ReleaseVelocityResponseCurve; ///< Defines a transformation curve to the incoming release veloctiy values affecting envelope times.
422     uint8_t ReleaseVelocityResponseDepth; ///< Dynamic range of release velocity affecting envelope time (0 - 4).
423     uint8_t ReleaseTriggerDecay; ///< 0 - 8
424     // Mix / Layer
425     crossfade_t Crossfade;
426     bool PitchTrack; ///< If <i>true</i>: sample will be pitched according to the key position (this will be disabled for drums for example).
427     dim_bypass_ctrl_t DimensionBypass; ///< If defined, the MIDI controller can switch on/off the dimension in realtime.
428     int8_t Pan; ///< Panorama / Balance (-64..0..63 <-> left..middle..right)
429     bool SelfMask; ///< If <i>true</i>: high velocity notes will stop low velocity notes at the same note, with that you can save voices that wouldn't be audible anyway.
430 schoenebeck 36 attenuation_ctrl_t AttenuationController; ///< MIDI Controller which has influence on the volume level of the sample (or entire sample group).
431     bool InvertAttenuationController; ///< Inverts the values coming from the defined Attenuation Controller.
432     uint8_t AttenuationControllerThreshold;///< 0-127
433 schoenebeck 2 uint8_t ChannelOffset; ///< Audio output where the audio signal of the dimension region should be routed to (0 - 9).
434     bool SustainDefeat; ///< If <i>true</i>: Sustain pedal will not hold a note.
435     bool MSDecode; ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.
436     uint16_t SampleStartOffset; ///< Number of samples the sample start should be moved (0 - 2000).
437 persson 406 double SampleAttenuation; ///< Sample volume (calculated from DLS::Sampler::Gain)
438    
439 schoenebeck 2 // derived attributes from DLS::Sampler
440     DLS::Sampler::UnityNote;
441     DLS::Sampler::FineTune;
442     DLS::Sampler::Gain;
443     DLS::Sampler::SampleLoops;
444     DLS::Sampler::pSampleLoops;
445    
446 schoenebeck 16 // Methods
447     double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
448 persson 613 double GetVelocityRelease(uint8_t MIDIKeyVelocity);
449 persson 728 double GetVelocityCutoff(uint8_t MIDIKeyVelocity);
450 persson 613
451 schoenebeck 16 protected:
452 schoenebeck 2 DimensionRegion(RIFF::List* _3ewl);
453 schoenebeck 16 ~DimensionRegion();
454     friend class Region;
455     private:
456 schoenebeck 36 typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller
457     _lev_ctrl_none = 0x00,
458     _lev_ctrl_modwheel = 0x03, ///< Modulation Wheel (MIDI Controller 1)
459     _lev_ctrl_breath = 0x05, ///< Breath Controller (Coarse, MIDI Controller 2)
460     _lev_ctrl_foot = 0x07, ///< Foot Pedal (Coarse, MIDI Controller 4)
461     _lev_ctrl_effect1 = 0x0d, ///< Effect Controller 1 (Coarse, MIDI Controller 12)
462     _lev_ctrl_effect2 = 0x0f, ///< Effect Controller 2 (Coarse, MIDI Controller 13)
463     _lev_ctrl_genpurpose1 = 0x11, ///< General Purpose Controller 1 (Slider, MIDI Controller 16)
464     _lev_ctrl_genpurpose2 = 0x13, ///< General Purpose Controller 2 (Slider, MIDI Controller 17)
465     _lev_ctrl_genpurpose3 = 0x15, ///< General Purpose Controller 3 (Slider, MIDI Controller 18)
466     _lev_ctrl_genpurpose4 = 0x17, ///< General Purpose Controller 4 (Slider, MIDI Controller 19)
467     _lev_ctrl_portamentotime = 0x0b, ///< Portamento Time (Coarse, MIDI Controller 5)
468     _lev_ctrl_sustainpedal = 0x01, ///< Sustain Pedal (MIDI Controller 64)
469     _lev_ctrl_portamento = 0x19, ///< Portamento (MIDI Controller 65)
470     _lev_ctrl_sostenutopedal = 0x1b, ///< Sostenuto Pedal (MIDI Controller 66)
471     _lev_ctrl_softpedal = 0x09, ///< Soft Pedal (MIDI Controller 67)
472     _lev_ctrl_genpurpose5 = 0x1d, ///< General Purpose Controller 5 (Button, MIDI Controller 80)
473     _lev_ctrl_genpurpose6 = 0x1f, ///< General Purpose Controller 6 (Button, MIDI Controller 81)
474     _lev_ctrl_genpurpose7 = 0x21, ///< General Purpose Controller 7 (Button, MIDI Controller 82)
475     _lev_ctrl_genpurpose8 = 0x23, ///< General Purpose Controller 8 (Button, MIDI Controller 83)
476     _lev_ctrl_effect1depth = 0x25, ///< Effect 1 Depth (MIDI Controller 91)
477     _lev_ctrl_effect2depth = 0x27, ///< Effect 2 Depth (MIDI Controller 92)
478     _lev_ctrl_effect3depth = 0x29, ///< Effect 3 Depth (MIDI Controller 93)
479     _lev_ctrl_effect4depth = 0x2b, ///< Effect 4 Depth (MIDI Controller 94)
480     _lev_ctrl_effect5depth = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)
481     _lev_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure
482     _lev_ctrl_velocity = 0xff ///< Key Velocity
483 schoenebeck 55 } _lev_ctrl_t;
484 schoenebeck 16 typedef std::map<uint32_t, double*> VelocityTableMap;
485    
486     static uint Instances; ///< Number of DimensionRegion instances.
487     static VelocityTableMap* pVelocityTables; ///< Contains the tables corresponding to the various velocity parameters (VelocityResponseCurve and VelocityResponseDepth).
488     double* pVelocityAttenuationTable; ///< Points to the velocity table corresponding to the velocity parameters of this DimensionRegion.
489 persson 613 double* pVelocityReleaseTable; ///< Points to the velocity table corresponding to the release velocity parameters of this DimensionRegion
490 persson 728 double* pVelocityCutoffTable; ///< Points to the velocity table corresponding to the filter velocity parameters of this DimensionRegion
491 schoenebeck 55
492 schoenebeck 36 leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
493 persson 613 double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
494 schoenebeck 308 double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
495 schoenebeck 2 };
496    
497     /** Encapsulates sample waves used for playback. */
498     class Sample : public DLS::Sample {
499     public:
500     uint16_t SampleGroup;
501     uint32_t Manufacturer; ///< Specifies the MIDI Manufacturer's Association (MMA) Manufacturer code for the sampler intended to receive this file's waveform. If no particular manufacturer is to be specified, a value of 0 should be used.
502     uint32_t Product; ///< Specifies the MIDI model ID defined by the manufacturer corresponding to the Manufacturer field. If no particular manufacturer's product is to be specified, a value of 0 should be used.
503     uint32_t SamplePeriod; ///< Specifies the duration of time that passes during the playback of one sample in nanoseconds (normally equal to 1 / Samplers Per Second, where Samples Per Second is the value found in the format chunk).
504     uint32_t MIDIUnityNote; ///< Specifies the musical note at which the sample will be played at it's original sample rate.
505 schoenebeck 21 uint32_t FineTune; ///< Specifies the fraction of a semitone up from the specified MIDI unity note field. A value of 0x80000000 means 1/2 semitone (50 cents) and a value of 0x00000000 means no fine tuning between semitones.
506 schoenebeck 2 smpte_format_t SMPTEFormat; ///< Specifies the Society of Motion Pictures and Television E time format used in the following <i>SMPTEOffset</i> field. If a value of 0 is set, <i>SMPTEOffset</i> should also be set to 0.
507     uint32_t SMPTEOffset; ///< The SMPTE Offset value specifies the time offset to be used for the synchronization / calibration to the first sample in the waveform. This value uses a format of 0xhhmmssff where hh is a signed value that specifies the number of hours (-23 to 23), mm is an unsigned value that specifies the number of minutes (0 to 59), ss is an unsigned value that specifies the number of seconds (0 to 59) and ff is an unsigned value that specifies the number of frames (0 to -1).
508     uint32_t Loops; ///< Number of defined sample loops (so far only seen single loops in gig files - please report me if you encounter more!).
509 schoenebeck 21 uint32_t LoopID; ///< Specifies the unique ID that corresponds to one of the defined cue points in the cue point list (only if Loops > 0), as the Gigasampler format only allows one loop definition at the moment, this attribute isn't really useful for anything.
510 schoenebeck 2 loop_type_t LoopType; ///< The type field defines how the waveform samples will be looped (only if Loops > 0).
511 schoenebeck 21 uint32_t LoopStart; ///< The start value specifies the offset (in sample points) in the waveform data of the first sample to be played in the loop (only if Loops > 0).
512     uint32_t LoopEnd; ///< The end value specifies the offset (in sample points) in the waveform data which represents the end of the loop (only if Loops > 0).
513     uint32_t LoopSize; ///< Length of the looping area (in sample points) which is equivalent to <i>LoopEnd - LoopStart</i>.
514 schoenebeck 2 uint32_t LoopFraction; ///< The fractional value specifies a fraction of a sample at which to loop (only if Loops > 0). This allows a loop to be fine tuned at a resolution greater than one sample. A value of 0 means no fraction, a value of 0x80000000 means 1/2 of a sample length. 0xFFFFFFFF is the smallest fraction of a sample that can be represented.
515     uint32_t LoopPlayCount; ///< Number of times the loop should be played (only if Loops > 0, a value of 0 = infinite).
516     bool Compressed; ///< If the sample wave is compressed (probably just interesting for instrument and sample editors, as this library already handles the decompression in it's sample access methods anyway).
517 persson 437 uint32_t TruncatedBits; ///< For 24-bit compressed samples only: number of bits truncated during compression (0, 4 or 6)
518     bool Dithered; ///< For 24-bit compressed samples only: if dithering was used during compression with bit reduction
519 schoenebeck 2
520     // own methods
521     buffer_t LoadSampleData();
522     buffer_t LoadSampleData(unsigned long SampleCount);
523     buffer_t LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
524     buffer_t LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);
525     buffer_t GetCache();
526 schoenebeck 384 // own static methods
527     static buffer_t CreateDecompressionBuffer(unsigned long MaxReadSize);
528     static void DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
529 schoenebeck 2 // overridden methods
530     void ReleaseSampleData();
531     unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
532     unsigned long GetPos();
533 schoenebeck 384 unsigned long Read(void* pBuffer, unsigned long SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
534     unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState, buffer_t* pExternalDecompressionBuffer = NULL);
535 schoenebeck 2 protected:
536     static unsigned int Instances; ///< Number of instances of class Sample.
537 schoenebeck 384 static buffer_t InternalDecompressionBuffer; ///< Buffer used for decompression as well as for truncation of 24 Bit -> 16 Bit samples.
538 schoenebeck 2 unsigned long FrameOffset; ///< Current offset (sample points) in current sample frame (for decompression only).
539     unsigned long* FrameTable; ///< For positioning within compressed samples only: stores the offset values for each frame.
540     unsigned long SamplePos; ///< For compressed samples only: stores the current position (in sample points).
541 persson 365 unsigned long SamplesInLastFrame; ///< For compressed samples only: length of the last sample frame.
542     unsigned long WorstCaseFrameSize; ///< For compressed samples only: size (in bytes) of the largest possible sample frame.
543     unsigned long SamplesPerFrame; ///< For compressed samples only: number of samples in a full sample frame.
544 schoenebeck 2 buffer_t RAMCache; ///< Buffers samples (already uncompressed) in RAM.
545 persson 666 unsigned long FileNo; ///< File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)
546 schoenebeck 2
547 persson 666 Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset, unsigned long fileNo = 0);
548 schoenebeck 2 ~Sample();
549 schoenebeck 24 /**
550     * Swaps the order of the data words in the given memory area
551     * with a granularity given by \a WordSize.
552     *
553     * @param pData - pointer to the memory area to be swapped
554     * @param AreaSize - size of the memory area to be swapped (in bytes)
555     * @param WordSize - size of the data words (in bytes)
556     */
557     inline void SwapMemoryArea(void* pData, unsigned long AreaSize, uint WordSize) {
558     switch (WordSize) { // TODO: unefficient
559     case 1: {
560     uint8_t* pDst = (uint8_t*) pData;
561     uint8_t cache;
562     unsigned long lo = 0, hi = AreaSize - 1;
563     for (; lo < hi; hi--, lo++) {
564     cache = pDst[lo];
565     pDst[lo] = pDst[hi];
566     pDst[hi] = cache;
567     }
568     break;
569     }
570     case 2: {
571     uint16_t* pDst = (uint16_t*) pData;
572     uint16_t cache;
573     unsigned long lo = 0, hi = (AreaSize >> 1) - 1;
574     for (; lo < hi; hi--, lo++) {
575     cache = pDst[lo];
576     pDst[lo] = pDst[hi];
577     pDst[hi] = cache;
578     }
579     break;
580     }
581     case 4: {
582     uint32_t* pDst = (uint32_t*) pData;
583     uint32_t cache;
584     unsigned long lo = 0, hi = (AreaSize >> 2) - 1;
585     for (; lo < hi; hi--, lo++) {
586     cache = pDst[lo];
587     pDst[lo] = pDst[hi];
588     pDst[hi] = cache;
589     }
590     break;
591     }
592     default: {
593     uint8_t* pCache = new uint8_t[WordSize]; // TODO: unefficient
594     unsigned long lo = 0, hi = AreaSize - WordSize;
595     for (; lo < hi; hi -= WordSize, lo += WordSize) {
596     memcpy(pCache, (uint8_t*) pData + lo, WordSize);
597     memcpy((uint8_t*) pData + lo, (uint8_t*) pData + hi, WordSize);
598     memcpy((uint8_t*) pData + hi, pCache, WordSize);
599     }
600     delete[] pCache;
601     break;
602     }
603     }
604     }
605     inline long Min(long A, long B) {
606     return (A > B) ? B : A;
607     }
608     inline long Abs(long val) { return (val > 0) ? val : -val; }
609 persson 365
610     // Guess size (in bytes) of a compressed sample
611     inline unsigned long GuessSize(unsigned long samples) {
612     // 16 bit: assume all frames are compressed - 1 byte
613     // per sample and 5 bytes header per 2048 samples
614    
615     // 24 bit: assume next best compression rate - 1.5
616     // bytes per sample and 13 bytes header per 256
617     // samples
618     const unsigned long size =
619     BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
620     : samples + (samples >> 10) * 5;
621     // Double for stereo and add one worst case sample
622     // frame
623     return (Channels == 2 ? size << 1 : size) + WorstCaseFrameSize;
624     }
625 schoenebeck 384
626     // Worst case amount of sample points that can be read with the
627     // given decompression buffer.
628     inline unsigned long WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
629     return (unsigned long) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
630     }
631 schoenebeck 2 private:
632     void ScanCompressedSample();
633     friend class File;
634     friend class Region;
635     };
636    
637     // TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions)
638     /** Defines <i>Region</i> information of an <i>Instrument</i>. */
639     class Region : public DLS::Region {
640     public:
641     unsigned int Dimensions; ///< Number of defined dimensions.
642 schoenebeck 347 dimension_def_t pDimensionDefinitions[8]; ///< Defines the five (gig2) or eight (gig3) possible dimensions (the dimension's controller and number of bits/splits).
643 schoenebeck 2 uint32_t DimensionRegions; ///< Total number of DimensionRegions this Region contains.
644 schoenebeck 347 DimensionRegion* pDimensionRegions[256]; ///< Pointer array to the 32 (gig2) or 256 (gig3) possible dimension regions (reflects NULL for dimension regions not in use). Avoid to access the array directly and better use GetDimensionRegionByValue() instead, but of course in some cases it makes sense to use the array (e.g. iterating through all DimensionRegions).
645 schoenebeck 282 unsigned int Layers; ///< Amount of defined layers (1 - 32). A value of 1 actually means no layering, a value > 1 means there is Layer dimension. The same information can of course also be obtained by accessing pDimensionDefinitions.
646 schoenebeck 2
647 schoenebeck 347 DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
648     DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
649 schoenebeck 2 Sample* GetSample();
650     protected:
651     uint8_t VelocityTable[128]; ///< For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number.
652    
653     Region(Instrument* pInstrument, RIFF::List* rgnList);
654     void LoadDimensionRegions(RIFF::List* rgn);
655 schoenebeck 515 Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
656 schoenebeck 2 ~Region();
657     friend class Instrument;
658     };
659    
660     /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */
661     class Instrument : protected DLS::Instrument {
662     public:
663     // derived attributes from DLS::Resource
664     DLS::Resource::pInfo;
665     DLS::Resource::pDLSID;
666     // derived attributes from DLS::Instrument
667     DLS::Instrument::IsDrum;
668     DLS::Instrument::MIDIBank;
669     DLS::Instrument::MIDIBankCoarse;
670     DLS::Instrument::MIDIBankFine;
671     DLS::Instrument::MIDIProgram;
672     DLS::Instrument::Regions;
673     // own attributes
674     int32_t Attenuation; ///< in dB
675     uint16_t EffectSend;
676     int16_t FineTune; ///< in cents
677     uint16_t PitchbendRange; ///< Number of semitones pitchbend controller can pitch (default is 2).
678     bool PianoReleaseMode;
679     range_t DimensionKeyRange; ///< 0-127 (where 0 means C1 and 127 means G9)
680    
681    
682     // derived methods from DLS::Resource
683     DLS::Resource::GetParent;
684     // overridden methods
685     Region* GetFirstRegion();
686     Region* GetNextRegion();
687     // own methods
688     Region* GetRegion(unsigned int Key);
689     protected:
690     Region** pRegions; ///< Pointer array to the regions
691     Region* RegionKeyTable[128]; ///< fast lookup for the corresponding Region of a MIDI key
692     int RegionIndex;
693    
694 schoenebeck 515 Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
695 schoenebeck 2 ~Instrument();
696     friend class File;
697     };
698    
699     // TODO: <3gnm> chunk not added yet (just contains the names of the sample groups)
700     /** Parses Gigasampler files and provides abstract access to the data. */
701     class File : protected DLS::File {
702     public:
703     // derived attributes from DLS::Resource
704     DLS::Resource::pInfo;
705     DLS::Resource::pDLSID;
706     // derived attributes from DLS::File
707     DLS::File::pVersion;
708     DLS::File::Instruments;
709    
710     // derived methods from DLS::Resource
711     DLS::Resource::GetParent;
712     // overridden methods
713     File(RIFF::File* pRIFF);
714 schoenebeck 515 Sample* GetFirstSample(progress_t* pProgress = NULL); ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise.
715 schoenebeck 2 Sample* GetNextSample(); ///< Returns a pointer to the next <i>Sample</i> object of the file, <i>NULL</i> otherwise.
716     Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
717     Instrument* GetNextInstrument(); ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
718 schoenebeck 515 Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
719 schoenebeck 350 ~File();
720 schoenebeck 2 protected:
721     typedef std::list<Sample*> SampleList;
722     typedef std::list<Instrument*> InstrumentList;
723    
724     SampleList* pSamples;
725     SampleList::iterator SamplesIterator;
726     InstrumentList* pInstruments;
727     InstrumentList::iterator InstrumentsIterator;
728    
729 schoenebeck 515 void LoadSamples(progress_t* pProgress = NULL);
730     void LoadInstruments(progress_t* pProgress = NULL);
731 schoenebeck 2 friend class Region;
732 persson 666
733     std::list<RIFF::File*> ExtensionFiles;
734 schoenebeck 2 };
735    
736     /** Will be thrown whenever a gig specific error occurs while trying to access a Gigasampler File. */
737     class Exception : public DLS::Exception {
738     public:
739     Exception(String Message);
740     void PrintMessage();
741     };
742    
743 schoenebeck 518 String libraryName();
744     String libraryVersion();
745    
746 schoenebeck 2 } // namespace gig
747    
748     #endif // __GIG_H__

  ViewVC Help
Powered by ViewVC