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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 930 - (hide annotations) (download) (as text)
Sun Oct 29 17:57:20 2006 UTC (17 years, 3 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 51323 byte(s)
* src/gig.cpp, src/gig.h: fixed behavior regarding the newly added support
  for sample groups, the initial implementation assumed a group index of 0
  in the .gig file to mean "no group assigned" and thus the possibility
  that there might not be a group at all, but in fact the .gig format
  assumes always at least one group (the default group), thus a group index
  of 0 means "member of default group"

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

  ViewVC Help
Powered by ViewVC