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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 36 - (show annotations) (download) (as text)
Wed Mar 10 21:34:28 2004 UTC (20 years ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 46331 byte(s)
* src/gig.h: changed interface for 'attenuation_ctrl_t', 'eg1_ctrl_t' and
  'eg2_ctrl_t': replaced the huge enumeration by a structure which reflects
  the MIDI controller number in case of an ordinary control change
  controller (this saves a huge switch-case block in the application of the
  library customer)
* src/gig.h: renamed following attributes in class 'DimensionRegion':
 'AttenuationContol' -> 'AttenuationController',
 'InvertAttenuationControl' -> 'InvertAttenuationController',
 'AttenuationControlTreshold' -> 'AttenuationControllerThreshold'
* src/gig.cpp: minor fix in API documentation for method
  'GetVelocityAttenuation()' in class 'DimensionRegion'

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

  ViewVC Help
Powered by ViewVC