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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 406 - (show annotations) (download) (as text)
Wed Feb 23 19:11:07 2005 UTC (16 years, 7 months ago) by persson
File MIME type: text/x-c++hdr
File size: 48600 byte(s)
* src/gig.h, src/gig.cpp: added pre-calculated sample attenuation
  parameter
* src/gigdump: added output of Gain and SampleStartOffset

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

  ViewVC Help
Powered by ViewVC