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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 231 - (show annotations) (download) (as text)
Sun Sep 5 00:46:28 2004 UTC (19 years, 6 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 46571 byte(s)
* src/gig.h, src/gig.cpp: fixed / improved accuracy of all three velocity
  to volume transformation functions (a.k.a. 'nonlinear','linear',
  'special'), denormals are filtered from the velocity to volume tables
* src/gigdump.cpp: added printout of velocity response curve parameters

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

  ViewVC Help
Powered by ViewVC