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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 353 - (show annotations) (download) (as text)
Sat Jan 29 14:25:35 2005 UTC (15 years, 6 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 46544 byte(s)
tiny API doc fix (regarding keyswitching and crossfades)

1 /***************************************************************************
2 * *
3 * libgig - C++ cross-platform Gigasampler format file loader library *
4 * *
5 * Copyright (C) 2003, 2004 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 #include <math.h>
30 #include <string.h>
31
32 /// Initial size of the sample buffer which is used for decompression of
33 /// compressed sample wave streams - this value should always be bigger than
34 /// the biggest sample piece expected to be read by the sampler engine,
35 /// otherwise the buffer size will be raised at runtime and thus the buffer
36 /// reallocated which is time consuming and unefficient.
37 #define INITIAL_SAMPLE_BUFFER_SIZE 512000 // 512 kB
38
39 #if WORDS_BIGENDIAN
40 # define LIST_TYPE_3PRG 0x33707267
41 # define LIST_TYPE_3EWL 0x3365776C
42 # define CHUNK_ID_SMPL 0x736D706C
43 # define CHUNK_ID_3GIX 0x33676978
44 # define CHUNK_ID_3EWA 0x33657761
45 # define CHUNK_ID_3LNK 0x336C6E6B
46 # define CHUNK_ID_3EWG 0x33657767
47 # define CHUNK_ID_EWAV 0x65776176
48 #else // little endian
49 # define LIST_TYPE_3PRG 0x67727033
50 # define LIST_TYPE_3EWL 0x6C776533
51 # define CHUNK_ID_SMPL 0x6C706D73
52 # define CHUNK_ID_3GIX 0x78696733
53 # define CHUNK_ID_3EWA 0x61776533
54 # define CHUNK_ID_3LNK 0x6B6E6C33
55 # define CHUNK_ID_3EWG 0x67776533
56 # define CHUNK_ID_EWAV 0x76617765
57 #endif // WORDS_BIGENDIAN
58
59 /** (so far) every exponential paramater in the gig format has a basis of 1.000000008813822 */
60 #define GIG_EXP_DECODE(x) (pow(1.000000008813822, x))
61 #define GIG_PITCH_TRACK_EXTRACT(x) (!(x & 0x01))
62 #define GIG_VCF_RESONANCE_CTRL_EXTRACT(x) ((x >> 4) & 0x03)
63 #define GIG_EG_CTR_ATTACK_INFLUENCE_EXTRACT(x) ((x >> 1) & 0x03)
64 #define GIG_EG_CTR_DECAY_INFLUENCE_EXTRACT(x) ((x >> 3) & 0x03)
65 #define GIG_EG_CTR_RELEASE_INFLUENCE_EXTRACT(x) ((x >> 5) & 0x03)
66
67 /** Gigasampler specific classes and definitions */
68 namespace gig {
69
70 typedef std::string String;
71
72 /** Lower and upper limit of a range. */
73 struct range_t {
74 uint8_t low; ///< Low value of range.
75 uint8_t high; ///< High value of range.
76 };
77
78 /** Pointer address and size of a buffer. */
79 struct buffer_t {
80 void* pStart; ///< Points to the beginning of the buffer.
81 unsigned long Size; ///< Size of the actual data in the buffer in bytes.
82 unsigned long NullExtensionSize; ///< The buffer might be bigger than the actual data, if that's the case that unused space at the end of the buffer is filled with NULLs and NullExtensionSize reflects that unused buffer space in bytes. Those NULL extensions are mandatory for differential algorithms that have to take the following data words into account, thus have to access past the buffer's boundary. If you don't know what I'm talking about, just forget this variable. :)
83 };
84
85 /** Standard types of sample loops. */
86 typedef enum {
87 loop_type_normal = 0x00000000, ///< Loop forward (normal)
88 loop_type_bidirectional = 0x00000001, ///< Alternating loop (forward/backward, also known as Ping Pong)
89 loop_type_backward = 0x00000002 ///< Loop backward (reverse)
90 } loop_type_t;
91
92 /** Society of Motion Pictures and Television E time format. */
93 typedef enum {
94 smpte_format_no_offset = 0x00000000, ///< no SMPTE offset
95 smpte_format_24_frames = 0x00000018, ///< 24 frames per second
96 smpte_format_25_frames = 0x00000019, ///< 25 frames per second
97 smpte_format_30_frames_dropping = 0x0000001D, ///< 30 frames per second with frame dropping (30 drop)
98 smpte_format_30_frames = 0x0000001E ///< 30 frames per second
99 } smpte_format_t;
100
101 /** Defines the shape of a function graph. */
102 typedef enum {
103 curve_type_nonlinear = 0,
104 curve_type_linear = 1,
105 curve_type_special = 2,
106 curve_type_unknown = 0xffffffff
107 } curve_type_t;
108
109 /** Dimensions allow to bypass one of the following controllers. */
110 typedef enum {
111 dim_bypass_ctrl_none,
112 dim_bypass_ctrl_94, ///< Effect 4 Depth (MIDI Controller 94)
113 dim_bypass_ctrl_95 ///< Effect 5 Depth (MIDI Controller 95)
114 } dim_bypass_ctrl_t;
115
116 /** Defines how LFO3 is controlled by. */
117 typedef enum {
118 lfo3_ctrl_internal = 0x00, ///< Only internally controlled.
119 lfo3_ctrl_modwheel = 0x01, ///< Only controlled by external modulation wheel.
120 lfo3_ctrl_aftertouch = 0x02, ///< Only controlled by aftertouch controller.
121 lfo3_ctrl_internal_modwheel = 0x03, ///< Controlled internally and by external modulation wheel.
122 lfo3_ctrl_internal_aftertouch = 0x04 ///< Controlled internally and by aftertouch controller.
123 } lfo3_ctrl_t;
124
125 /** Defines how LFO2 is controlled by. */
126 typedef enum {
127 lfo2_ctrl_internal = 0x00, ///< Only internally controlled.
128 lfo2_ctrl_modwheel = 0x01, ///< Only controlled by external modulation wheel.
129 lfo2_ctrl_foot = 0x02, ///< Only controlled by external foot controller.
130 lfo2_ctrl_internal_modwheel = 0x03, ///< Controlled internally and by external modulation wheel.
131 lfo2_ctrl_internal_foot = 0x04 ///< Controlled internally and by external foot controller.
132 } lfo2_ctrl_t;
133
134 /** Defines how LFO1 is controlled by. */
135 typedef enum {
136 lfo1_ctrl_internal = 0x00, ///< Only internally controlled.
137 lfo1_ctrl_modwheel = 0x01, ///< Only controlled by external modulation wheel.
138 lfo1_ctrl_breath = 0x02, ///< Only controlled by external breath controller.
139 lfo1_ctrl_internal_modwheel = 0x03, ///< Controlled internally and by external modulation wheel.
140 lfo1_ctrl_internal_breath = 0x04 ///< Controlled internally and by external breath controller.
141 } lfo1_ctrl_t;
142
143 /** Defines how the filter cutoff frequency is controlled by. */
144 typedef enum {
145 vcf_cutoff_ctrl_none = 0x00,
146 vcf_cutoff_ctrl_modwheel = 0x81, ///< Modulation Wheel (MIDI Controller 1)
147 vcf_cutoff_ctrl_effect1 = 0x8c, ///< Effect Controller 1 (Coarse, MIDI Controller 12)
148 vcf_cutoff_ctrl_effect2 = 0x8d, ///< Effect Controller 2 (Coarse, MIDI Controller 13)
149 vcf_cutoff_ctrl_breath = 0x82, ///< Breath Controller (Coarse, MIDI Controller 2)
150 vcf_cutoff_ctrl_foot = 0x84, ///< Foot Pedal (Coarse, MIDI Controller 4)
151 vcf_cutoff_ctrl_sustainpedal = 0xc0, ///< Sustain Pedal (MIDI Controller 64)
152 vcf_cutoff_ctrl_softpedal = 0xc3, ///< Soft Pedal (MIDI Controller 67)
153 vcf_cutoff_ctrl_genpurpose7 = 0xd2, ///< General Purpose Controller 7 (Button, MIDI Controller 82)
154 vcf_cutoff_ctrl_genpurpose8 = 0xd3, ///< General Purpose Controller 8 (Button, MIDI Controller 83)
155 vcf_cutoff_ctrl_aftertouch = 0x80 ///< Key Pressure
156 } vcf_cutoff_ctrl_t;
157
158 /** Defines how the filter resonance is controlled by. */
159 typedef enum {
160 vcf_res_ctrl_none = 0xffffffff,
161 vcf_res_ctrl_genpurpose3 = 0, ///< General Purpose Controller 3 (Slider, MIDI Controller 18)
162 vcf_res_ctrl_genpurpose4 = 1, ///< General Purpose Controller 4 (Slider, MIDI Controller 19)
163 vcf_res_ctrl_genpurpose5 = 2, ///< General Purpose Controller 5 (Button, MIDI Controller 80)
164 vcf_res_ctrl_genpurpose6 = 3 ///< General Purpose Controller 6 (Button, MIDI Controller 81)
165 } vcf_res_ctrl_t;
166
167 /**
168 * Defines a controller that has a certain contrained influence on a
169 * particular synthesis parameter (used to define attenuation controller,
170 * EG1 controller and EG2 controller).
171 *
172 * You should use the respective <i>typedef</i> (means either
173 * attenuation_ctrl_t, eg1_ctrl_t or eg2_ctrl_t) in your code!
174 */
175 struct leverage_ctrl_t {
176 typedef enum {
177 type_none = 0x00, ///< No controller defined
178 type_channelaftertouch = 0x2f, ///< Channel Key Pressure
179 type_velocity = 0xff, ///< Key Velocity
180 type_controlchange = 0xfe ///< Ordinary MIDI control change controller, see field 'controller_number'
181 } type_t;
182
183 type_t type; ///< Controller type
184 uint controller_number; ///< MIDI controller number if this controller is a control change controller, 0 otherwise
185 };
186
187 /**
188 * Defines controller influencing attenuation.
189 *
190 * @see leverage_ctrl_t
191 */
192 typedef leverage_ctrl_t attenuation_ctrl_t;
193
194 /**
195 * Defines controller influencing envelope generator 1.
196 *
197 * @see leverage_ctrl_t
198 */
199 typedef leverage_ctrl_t eg1_ctrl_t;
200
201 /**
202 * Defines controller influencing envelope generator 2.
203 *
204 * @see leverage_ctrl_t
205 */
206 typedef leverage_ctrl_t eg2_ctrl_t;
207
208 /**
209 * Defines the type of dimension, that is how the dimension zones (and
210 * thus how the dimension regions are selected by. The number of
211 * dimension zones is always a power of two. All dimensions can have up
212 * to 32 zones (except the layer dimension with only up to 8 zones and
213 * the samplechannel dimension which currently allows only 2 zones).
214 */
215 typedef enum {
216 dimension_none = 0x00, ///< Dimension not in use.
217 dimension_samplechannel = 0x80, ///< If used sample has more than one channel (thus is not mono).
218 dimension_layer = 0x81, ///< For layering of up to 8 instruments (and eventually crossfading of 2 or 4 layers).
219 dimension_velocity = 0x82, ///< Key Velocity (this is the only dimension where the ranges can exactly be defined).
220 dimension_channelaftertouch = 0x83, ///< Channel Key Pressure
221 dimension_releasetrigger = 0x84, ///< Special dimension for triggering samples on releasing a key.
222 dimension_keyboard = 0x85, ///< Dimension for keyswitching
223 dimension_modwheel = 0x01, ///< Modulation Wheel (MIDI Controller 1)
224 dimension_breath = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)
225 dimension_foot = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)
226 dimension_portamentotime = 0x05, ///< Portamento Time (Coarse, MIDI Controller 5)
227 dimension_effect1 = 0x0c, ///< Effect Controller 1 (Coarse, MIDI Controller 12)
228 dimension_effect2 = 0x0d, ///< Effect Controller 2 (Coarse, MIDI Controller 13)
229 dimension_genpurpose1 = 0x10, ///< General Purpose Controller 1 (Slider, MIDI Controller 16)
230 dimension_genpurpose2 = 0x11, ///< General Purpose Controller 2 (Slider, MIDI Controller 17)
231 dimension_genpurpose3 = 0x12, ///< General Purpose Controller 3 (Slider, MIDI Controller 18)
232 dimension_genpurpose4 = 0x13, ///< General Purpose Controller 4 (Slider, MIDI Controller 19)
233 dimension_sustainpedal = 0x40, ///< Sustain Pedal (MIDI Controller 64)
234 dimension_portamento = 0x41, ///< Portamento (MIDI Controller 65)
235 dimension_sostenutopedal = 0x42, ///< Sostenuto Pedal (MIDI Controller 66)
236 dimension_softpedal = 0x43, ///< Soft Pedal (MIDI Controller 67)
237 dimension_genpurpose5 = 0x30, ///< General Purpose Controller 5 (Button, MIDI Controller 80)
238 dimension_genpurpose6 = 0x31, ///< General Purpose Controller 6 (Button, MIDI Controller 81)
239 dimension_genpurpose7 = 0x32, ///< General Purpose Controller 7 (Button, MIDI Controller 82)
240 dimension_genpurpose8 = 0x33, ///< General Purpose Controller 8 (Button, MIDI Controller 83)
241 dimension_effect1depth = 0x5b, ///< Effect 1 Depth (MIDI Controller 91)
242 dimension_effect2depth = 0x5c, ///< Effect 2 Depth (MIDI Controller 92)
243 dimension_effect3depth = 0x5d, ///< Effect 3 Depth (MIDI Controller 93)
244 dimension_effect4depth = 0x5e, ///< Effect 4 Depth (MIDI Controller 94)
245 dimension_effect5depth = 0x5f ///< Effect 5 Depth (MIDI Controller 95)
246 } dimension_t;
247
248 /**
249 * Intended for internal usage: will be used to convert a dimension value
250 * into the corresponding dimension bit number.
251 */
252 typedef enum {
253 split_type_normal, ///< dimension value between 0-127, no custom range of zones
254 split_type_customvelocity, ///< a velocity dimension split with custom range definition for each zone (if a velocity dimension split has no custom defined zone ranges then it's also just of type split_type_normal)
255 split_type_bit ///< dimension values are already the sought bit number
256 } split_type_t;
257
258 /** General dimension definition. */
259 struct dimension_def_t {
260 dimension_t dimension; ///< Specifies which source (usually a MIDI controller) is associated with the dimension.
261 uint8_t bits; ///< Number of "bits" (1 bit = 2 splits/zones, 2 bit = 4 splits/zones, 3 bit = 8 splits/zones,...).
262 uint8_t zones; ///< Number of zones the dimension has.
263 split_type_t split_type; ///< Intended for internal usage: will be used to convert a dimension value into the corresponding dimension bit number.
264 range_t* ranges; ///< Intended for internal usage: Points to the beginning of a range_t array which reflects the value ranges of each dimension zone (only if custom defined ranges are defined, is NULL otherwise).
265 unsigned int 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 // just symbol prototyping
306 class File;
307 class Instrument;
308 class Sample;
309 class Region;
310
311 /** Encapsulates articulation information of a dimension region.
312 *
313 * Every Gigasampler Instrument has at least one dimension region
314 * (exactly then when it has no dimension defined).
315 *
316 * Gigasampler provides three Envelope Generators and Low Frequency
317 * Oscillators:
318 *
319 * - EG1 and LFO1, both controlling sample amplitude
320 * - EG2 and LFO2, both controlling filter cutoff frequency
321 * - EG3 and LFO3, both controlling sample pitch
322 */
323 class DimensionRegion : protected DLS::Sampler {
324 public:
325 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).
326 Sample* pSample; ///< Points to the Sample which is assigned to the dimension region.
327 // Sample Amplitude EG/LFO
328 uint16_t EG1PreAttack; ///< Preattack value of the sample amplitude EG (0 - 1000 permille).
329 double EG1Attack; ///< Attack time of the sample amplitude EG (0.000 - 60.000s).
330 double EG1Decay1; ///< Decay time of the sample amplitude EG (0.000 - 60.000s).
331 double EG1Decay2; ///< Only if <i>EG1InfiniteSustain == false</i>: 2nd decay stage time of the sample amplitude EG (0.000 - 60.000s).
332 bool EG1InfiniteSustain; ///< If <i>true</i>, instead of going into Decay2 phase, Decay1 level will be hold until note will be released.
333 uint16_t EG1Sustain; ///< Sustain value of the sample amplitude EG (0 - 1000 permille).
334 double EG1Release; ///< Release time of the sample amplitude EG (0.000 - 60.000s).
335 bool EG1Hold; ///< If <i>true</i>, Decay1 stage should be postponed until the sample reached the sample loop start.
336 eg1_ctrl_t EG1Controller; ///< MIDI Controller which has influence on sample amplitude EG parameters (attack, decay, release).
337 bool EG1ControllerInvert; ///< Invert values coming from defined EG1 controller.
338 uint8_t EG1ControllerAttackInfluence; ///< Amount EG1 Controller has influence on the EG1 Attack time (0 - 3, where 0 means off).
339 uint8_t EG1ControllerDecayInfluence; ///< Amount EG1 Controller has influence on the EG1 Decay time (0 - 3, where 0 means off).
340 uint8_t EG1ControllerReleaseInfluence; ///< Amount EG1 Controller has influence on the EG1 Release time (0 - 3, where 0 means off).
341 double LFO1Frequency; ///< Frequency of the sample amplitude LFO (0.10 - 10.00 Hz).
342 uint16_t LFO1InternalDepth; ///< Firm pitch of the sample amplitude LFO (0 - 1200 cents).
343 uint16_t LFO1ControlDepth; ///< Controller depth influencing sample amplitude LFO pitch (0 - 1200 cents).
344 lfo1_ctrl_t LFO1Controller; ///< MIDI Controller which controls sample amplitude LFO.
345 bool LFO1FlipPhase; ///< Inverts phase of the sample amplitude LFO wave.
346 bool LFO1Sync; ///< If set to <i>true</i> only one LFO should be used for all voices.
347 // Filter Cutoff Frequency EG/LFO
348 uint16_t EG2PreAttack; ///< Preattack value of the filter cutoff EG (0 - 1000 permille).
349 double EG2Attack; ///< Attack time of the filter cutoff EG (0.000 - 60.000s).
350 double EG2Decay1; ///< Decay time of the filter cutoff EG (0.000 - 60.000s).
351 double EG2Decay2; ///< Only if <i>EG2InfiniteSustain == false</i>: 2nd stage decay time of the filter cutoff EG (0.000 - 60.000s).
352 bool EG2InfiniteSustain; ///< If <i>true</i>, instead of going into Decay2 phase, Decay1 level will be hold until note will be released.
353 uint16_t EG2Sustain; ///< Sustain value of the filter cutoff EG (0 - 1000 permille).
354 double EG2Release; ///< Release time of the filter cutoff EG (0.000 - 60.000s).
355 eg2_ctrl_t EG2Controller; ///< MIDI Controller which has influence on filter cutoff EG parameters (attack, decay, release).
356 bool EG2ControllerInvert; ///< Invert values coming from defined EG2 controller.
357 uint8_t EG2ControllerAttackInfluence; ///< Amount EG2 Controller has influence on the EG2 Attack time (0 - 3, where 0 means off).
358 uint8_t EG2ControllerDecayInfluence; ///< Amount EG2 Controller has influence on the EG2 Decay time (0 - 3, where 0 means off).
359 uint8_t EG2ControllerReleaseInfluence; ///< Amount EG2 Controller has influence on the EG2 Release time (0 - 3, where 0 means off).
360 double LFO2Frequency; ///< Frequency of the filter cutoff LFO (0.10 - 10.00 Hz).
361 uint16_t LFO2InternalDepth; ///< Firm pitch of the filter cutoff LFO (0 - 1200 cents).
362 uint16_t LFO2ControlDepth; ///< Controller depth influencing filter cutoff LFO pitch (0 - 1200).
363 lfo2_ctrl_t LFO2Controller; ///< MIDI Controlle which controls the filter cutoff LFO.
364 bool LFO2FlipPhase; ///< Inverts phase of the filter cutoff LFO wave.
365 bool LFO2Sync; ///< If set to <i>true</i> only one LFO should be used for all voices.
366 // Sample Pitch EG/LFO
367 double EG3Attack; ///< Attack time of the sample pitch EG (0.000 - 10.000s).
368 int16_t EG3Depth; ///< Depth of the sample pitch EG (-1200 - +1200).
369 double LFO3Frequency; ///< Frequency of the sample pitch LFO (0.10 - 10.00 Hz).
370 int16_t LFO3InternalDepth; ///< Firm depth of the sample pitch LFO (-1200 - +1200 cents).
371 int16_t LFO3ControlDepth; ///< Controller depth of the sample pitch LFO (-1200 - +1200 cents).
372 lfo3_ctrl_t LFO3Controller; ///< MIDI Controller which controls the sample pitch LFO.
373 bool LFO3Sync; ///< If set to <i>true</i> only one LFO should be used for all voices.
374 // Filter
375 bool VCFEnabled; ///< If filter should be used.
376 vcf_type_t VCFType; ///< Defines the general filter characteristic (lowpass, highpass, bandpass, etc.).
377 vcf_cutoff_ctrl_t VCFCutoffController; ///< Specifies which external controller has influence on the filter cutoff frequency.
378 uint8_t VCFCutoff; ///< Max. cutoff frequency.
379 curve_type_t VCFVelocityCurve; ///< Defines a transformation curve for the incoming velocity values, affecting the VCF.
380 uint8_t VCFVelocityScale; ///< (0-127) Amount velocity controls VCF cutoff frequency (only if no other VCF cutoff controller is defined).
381 uint8_t VCFVelocityDynamicRange; ///< 0x04 = lowest, 0x00 = highest
382 uint8_t VCFResonance; ///< Firm internal filter resonance weight.
383 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).
384 vcf_res_ctrl_t VCFResonanceController; ///< Specifies which external controller has influence on the filter resonance Q.
385 bool VCFKeyboardTracking; ///< If <i>true</i>: VCF cutoff frequence will be dependend to the note key position relative to the defined breakpoint value.
386 uint8_t VCFKeyboardTrackingBreakpoint; ///< See VCFKeyboardTracking (0 - 127).
387 // Key Velocity Transformations
388 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).
389 uint8_t VelocityResponseDepth; ///< Dynamic range of velocity affecting amplitude (0 - 4) (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead).
390 uint8_t VelocityResponseCurveScaling; ///< 0 - 127 (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead)
391 curve_type_t ReleaseVelocityResponseCurve; ///< Defines a transformation curve to the incoming release veloctiy values affecting envelope times.
392 uint8_t ReleaseVelocityResponseDepth; ///< Dynamic range of release velocity affecting envelope time (0 - 4).
393 uint8_t ReleaseTriggerDecay; ///< 0 - 8
394 // Mix / Layer
395 crossfade_t Crossfade;
396 bool PitchTrack; ///< If <i>true</i>: sample will be pitched according to the key position (this will be disabled for drums for example).
397 dim_bypass_ctrl_t DimensionBypass; ///< If defined, the MIDI controller can switch on/off the dimension in realtime.
398 int8_t Pan; ///< Panorama / Balance (-64..0..63 <-> left..middle..right)
399 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.
400 attenuation_ctrl_t AttenuationController; ///< MIDI Controller which has influence on the volume level of the sample (or entire sample group).
401 bool InvertAttenuationController; ///< Inverts the values coming from the defined Attenuation Controller.
402 uint8_t AttenuationControllerThreshold;///< 0-127
403 uint8_t ChannelOffset; ///< Audio output where the audio signal of the dimension region should be routed to (0 - 9).
404 bool SustainDefeat; ///< If <i>true</i>: Sustain pedal will not hold a note.
405 bool MSDecode; ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.
406 uint16_t SampleStartOffset; ///< Number of samples the sample start should be moved (0 - 2000).
407 // derived attributes from DLS::Sampler
408 DLS::Sampler::UnityNote;
409 DLS::Sampler::FineTune;
410 DLS::Sampler::Gain;
411 DLS::Sampler::SampleLoops;
412 DLS::Sampler::pSampleLoops;
413
414 // Methods
415 double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
416 protected:
417 DimensionRegion(RIFF::List* _3ewl);
418 ~DimensionRegion();
419 friend class Region;
420 private:
421 typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller
422 _lev_ctrl_none = 0x00,
423 _lev_ctrl_modwheel = 0x03, ///< Modulation Wheel (MIDI Controller 1)
424 _lev_ctrl_breath = 0x05, ///< Breath Controller (Coarse, MIDI Controller 2)
425 _lev_ctrl_foot = 0x07, ///< Foot Pedal (Coarse, MIDI Controller 4)
426 _lev_ctrl_effect1 = 0x0d, ///< Effect Controller 1 (Coarse, MIDI Controller 12)
427 _lev_ctrl_effect2 = 0x0f, ///< Effect Controller 2 (Coarse, MIDI Controller 13)
428 _lev_ctrl_genpurpose1 = 0x11, ///< General Purpose Controller 1 (Slider, MIDI Controller 16)
429 _lev_ctrl_genpurpose2 = 0x13, ///< General Purpose Controller 2 (Slider, MIDI Controller 17)
430 _lev_ctrl_genpurpose3 = 0x15, ///< General Purpose Controller 3 (Slider, MIDI Controller 18)
431 _lev_ctrl_genpurpose4 = 0x17, ///< General Purpose Controller 4 (Slider, MIDI Controller 19)
432 _lev_ctrl_portamentotime = 0x0b, ///< Portamento Time (Coarse, MIDI Controller 5)
433 _lev_ctrl_sustainpedal = 0x01, ///< Sustain Pedal (MIDI Controller 64)
434 _lev_ctrl_portamento = 0x19, ///< Portamento (MIDI Controller 65)
435 _lev_ctrl_sostenutopedal = 0x1b, ///< Sostenuto Pedal (MIDI Controller 66)
436 _lev_ctrl_softpedal = 0x09, ///< Soft Pedal (MIDI Controller 67)
437 _lev_ctrl_genpurpose5 = 0x1d, ///< General Purpose Controller 5 (Button, MIDI Controller 80)
438 _lev_ctrl_genpurpose6 = 0x1f, ///< General Purpose Controller 6 (Button, MIDI Controller 81)
439 _lev_ctrl_genpurpose7 = 0x21, ///< General Purpose Controller 7 (Button, MIDI Controller 82)
440 _lev_ctrl_genpurpose8 = 0x23, ///< General Purpose Controller 8 (Button, MIDI Controller 83)
441 _lev_ctrl_effect1depth = 0x25, ///< Effect 1 Depth (MIDI Controller 91)
442 _lev_ctrl_effect2depth = 0x27, ///< Effect 2 Depth (MIDI Controller 92)
443 _lev_ctrl_effect3depth = 0x29, ///< Effect 3 Depth (MIDI Controller 93)
444 _lev_ctrl_effect4depth = 0x2b, ///< Effect 4 Depth (MIDI Controller 94)
445 _lev_ctrl_effect5depth = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)
446 _lev_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure
447 _lev_ctrl_velocity = 0xff ///< Key Velocity
448 } _lev_ctrl_t;
449 typedef std::map<uint32_t, double*> VelocityTableMap;
450
451 static uint Instances; ///< Number of DimensionRegion instances.
452 static VelocityTableMap* pVelocityTables; ///< Contains the tables corresponding to the various velocity parameters (VelocityResponseCurve and VelocityResponseDepth).
453 double* pVelocityAttenuationTable; ///< Points to the velocity table corresponding to the velocity parameters of this DimensionRegion.
454
455 leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
456 double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
457 };
458
459 /** Encapsulates sample waves used for playback. */
460 class Sample : public DLS::Sample {
461 public:
462 uint16_t SampleGroup;
463 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.
464 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.
465 uint32_t SamplePeriod; ///< Specifies the duration of time that passes during the playback of one sample in nanoseconds (normally equal to 1 / Samplers Per Second, where Samples Per Second is the value found in the format chunk).
466 uint32_t MIDIUnityNote; ///< Specifies the musical note at which the sample will be played at it's original sample rate.
467 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.
468 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.
469 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).
470 uint32_t Loops; ///< Number of defined sample loops (so far only seen single loops in gig files - please report me if you encounter more!).
471 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.
472 loop_type_t LoopType; ///< The type field defines how the waveform samples will be looped (only if Loops > 0).
473 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).
474 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).
475 uint32_t LoopSize; ///< Length of the looping area (in sample points) which is equivalent to <i>LoopEnd - LoopStart</i>.
476 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.
477 uint32_t LoopPlayCount; ///< Number of times the loop should be played (only if Loops > 0, a value of 0 = infinite).
478 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).
479
480 // own methods
481 buffer_t LoadSampleData();
482 buffer_t LoadSampleData(unsigned long SampleCount);
483 buffer_t LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
484 buffer_t LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);
485 buffer_t GetCache();
486 // overridden methods
487 void ReleaseSampleData();
488 unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
489 unsigned long GetPos();
490 unsigned long Read(void* pBuffer, unsigned long SampleCount);
491 unsigned long ReadAndLoop(void* pBuffer, unsigned long SampleCount, playback_state_t* pPlaybackState);
492 protected:
493 static unsigned int Instances; ///< Number of instances of class Sample.
494 static unsigned long DecompressionBufferSize; ///< Current size of the decompression buffer.
495 static void* pDecompressionBuffer; ///< Small buffer used for decompression only.
496 unsigned long FrameOffset; ///< Current offset (sample points) in current sample frame (for decompression only).
497 unsigned long* FrameTable; ///< For positioning within compressed samples only: stores the offset values for each frame.
498 unsigned long SamplePos; ///< For compressed samples only: stores the current position (in sample points).
499 buffer_t RAMCache; ///< Buffers samples (already uncompressed) in RAM.
500
501 Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);
502 ~Sample();
503 /**
504 * Swaps the order of the data words in the given memory area
505 * with a granularity given by \a WordSize.
506 *
507 * @param pData - pointer to the memory area to be swapped
508 * @param AreaSize - size of the memory area to be swapped (in bytes)
509 * @param WordSize - size of the data words (in bytes)
510 */
511 inline void SwapMemoryArea(void* pData, unsigned long AreaSize, uint WordSize) {
512 switch (WordSize) { // TODO: unefficient
513 case 1: {
514 uint8_t* pDst = (uint8_t*) pData;
515 uint8_t cache;
516 unsigned long lo = 0, hi = AreaSize - 1;
517 for (; lo < hi; hi--, lo++) {
518 cache = pDst[lo];
519 pDst[lo] = pDst[hi];
520 pDst[hi] = cache;
521 }
522 break;
523 }
524 case 2: {
525 uint16_t* pDst = (uint16_t*) pData;
526 uint16_t cache;
527 unsigned long lo = 0, hi = (AreaSize >> 1) - 1;
528 for (; lo < hi; hi--, lo++) {
529 cache = pDst[lo];
530 pDst[lo] = pDst[hi];
531 pDst[hi] = cache;
532 }
533 break;
534 }
535 case 4: {
536 uint32_t* pDst = (uint32_t*) pData;
537 uint32_t cache;
538 unsigned long lo = 0, hi = (AreaSize >> 2) - 1;
539 for (; lo < hi; hi--, lo++) {
540 cache = pDst[lo];
541 pDst[lo] = pDst[hi];
542 pDst[hi] = cache;
543 }
544 break;
545 }
546 default: {
547 uint8_t* pCache = new uint8_t[WordSize]; // TODO: unefficient
548 unsigned long lo = 0, hi = AreaSize - WordSize;
549 for (; lo < hi; hi -= WordSize, lo += WordSize) {
550 memcpy(pCache, (uint8_t*) pData + lo, WordSize);
551 memcpy((uint8_t*) pData + lo, (uint8_t*) pData + hi, WordSize);
552 memcpy((uint8_t*) pData + hi, pCache, WordSize);
553 }
554 delete[] pCache;
555 break;
556 }
557 }
558 }
559 inline long Min(long A, long B) {
560 return (A > B) ? B : A;
561 }
562 inline long Abs(long val) { return (val > 0) ? val : -val; }
563 private:
564 void ScanCompressedSample();
565 friend class File;
566 friend class Region;
567 };
568
569 // TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions)
570 /** Defines <i>Region</i> information of an <i>Instrument</i>. */
571 class Region : public DLS::Region {
572 public:
573 unsigned int Dimensions; ///< Number of defined dimensions.
574 dimension_def_t pDimensionDefinitions[8]; ///< Defines the five (gig2) or eight (gig3) possible dimensions (the dimension's controller and number of bits/splits).
575 uint32_t DimensionRegions; ///< Total number of DimensionRegions this Region contains.
576 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).
577 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.
578
579 DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
580 DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
581 Sample* GetSample();
582 protected:
583 uint8_t VelocityTable[128]; ///< For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number.
584
585 Region(Instrument* pInstrument, RIFF::List* rgnList);
586 void LoadDimensionRegions(RIFF::List* rgn);
587 Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex);
588 ~Region();
589 friend class Instrument;
590 };
591
592 /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */
593 class Instrument : protected DLS::Instrument {
594 public:
595 // derived attributes from DLS::Resource
596 DLS::Resource::pInfo;
597 DLS::Resource::pDLSID;
598 // derived attributes from DLS::Instrument
599 DLS::Instrument::IsDrum;
600 DLS::Instrument::MIDIBank;
601 DLS::Instrument::MIDIBankCoarse;
602 DLS::Instrument::MIDIBankFine;
603 DLS::Instrument::MIDIProgram;
604 DLS::Instrument::Regions;
605 // own attributes
606 int32_t Attenuation; ///< in dB
607 uint16_t EffectSend;
608 int16_t FineTune; ///< in cents
609 uint16_t PitchbendRange; ///< Number of semitones pitchbend controller can pitch (default is 2).
610 bool PianoReleaseMode;
611 range_t DimensionKeyRange; ///< 0-127 (where 0 means C1 and 127 means G9)
612
613
614 // derived methods from DLS::Resource
615 DLS::Resource::GetParent;
616 // overridden methods
617 Region* GetFirstRegion();
618 Region* GetNextRegion();
619 // own methods
620 Region* GetRegion(unsigned int Key);
621 protected:
622 Region** pRegions; ///< Pointer array to the regions
623 Region* RegionKeyTable[128]; ///< fast lookup for the corresponding Region of a MIDI key
624 int RegionIndex;
625
626 Instrument(File* pFile, RIFF::List* insList);
627 ~Instrument();
628 friend class File;
629 };
630
631 // TODO: <3gnm> chunk not added yet (just contains the names of the sample groups)
632 /** Parses Gigasampler files and provides abstract access to the data. */
633 class File : protected DLS::File {
634 public:
635 // derived attributes from DLS::Resource
636 DLS::Resource::pInfo;
637 DLS::Resource::pDLSID;
638 // derived attributes from DLS::File
639 DLS::File::pVersion;
640 DLS::File::Instruments;
641
642 // derived methods from DLS::Resource
643 DLS::Resource::GetParent;
644 // overridden methods
645 File(RIFF::File* pRIFF);
646 Sample* GetFirstSample(); ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise.
647 Sample* GetNextSample(); ///< Returns a pointer to the next <i>Sample</i> object of the file, <i>NULL</i> otherwise.
648 Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
649 Instrument* GetNextInstrument(); ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
650 Instrument* GetInstrument(uint index);
651 ~File();
652 protected:
653 typedef std::list<Sample*> SampleList;
654 typedef std::list<Instrument*> InstrumentList;
655
656 SampleList* pSamples;
657 SampleList::iterator SamplesIterator;
658 InstrumentList* pInstruments;
659 InstrumentList::iterator InstrumentsIterator;
660
661 void LoadSamples();
662 void LoadInstruments();
663 friend class Region;
664 };
665
666 /** Will be thrown whenever a gig specific error occurs while trying to access a Gigasampler File. */
667 class Exception : public DLS::Exception {
668 public:
669 Exception(String Message);
670 void PrintMessage();
671 };
672
673 } // namespace gig
674
675 #endif // __GIG_H__

  ViewVC Help
Powered by ViewVC