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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1524 - (show annotations) (download) (as text)
Sun Nov 25 17:29:37 2007 UTC (12 years, 9 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 55551 byte(s)
* src/gig.cpp, src/gig.h:
  added File::SetAutoLoad() and File::GetAutoLoad() for allowing
  applications to retrieve very superficial informations like amount of
  instruments and their names in a very fast way

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

  ViewVC Help
Powered by ViewVC