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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 21 - (show annotations) (download) (as text)
Thu Dec 25 01:09:08 2003 UTC (17 years, 2 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 41254 byte(s)
* gig.h, gig.cpp:
  changes in class 'Sample':
  - fixed loop attributes which reflected wrong values
  - attributes 'LoopStart' and 'LoopEnd' are now measured in sample points
    instead of byte offset
  - renamed misleading attribute name 'MIDIPitchFraction' to 'FineTune'
  - added attribute 'LoopSize'
  changes in class 'File':
  - added method GetInstrument(uint index)

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 /** Defines how attenuation (=gain / VCA) is controlled by. */
172 typedef enum {
173 attenuation_ctrl_none = 0x00,
174 attenuation_ctrl_modwheel = 0x03, ///< Modulation Wheel (MIDI Controller 1)
175 attenuation_ctrl_breath = 0x05, ///< Breath Controller (Coarse, MIDI Controller 2)
176 attenuation_ctrl_foot = 0x07, ///< Foot Pedal (Coarse, MIDI Controller 4)
177 attenuation_ctrl_effect1 = 0x0d, ///< Effect Controller 1 (Coarse, MIDI Controller 12)
178 attenuation_ctrl_effect2 = 0x0f, ///< Effect Controller 2 (Coarse, MIDI Controller 13)
179 attenuation_ctrl_genpurpose1 = 0x11, ///< General Purpose Controller 1 (Slider, MIDI Controller 16)
180 attenuation_ctrl_genpurpose2 = 0x13, ///< General Purpose Controller 2 (Slider, MIDI Controller 17)
181 attenuation_ctrl_genpurpose3 = 0x15, ///< General Purpose Controller 3 (Slider, MIDI Controller 18)
182 attenuation_ctrl_genpurpose4 = 0x17, ///< General Purpose Controller 4 (Slider, MIDI Controller 19)
183 attenuation_ctrl_portamentotime = 0x0b, ///< Portamento Time (Coarse, MIDI Controller 5)
184 attenuation_ctrl_sustainpedal = 0x01, ///< Sustain Pedal (MIDI Controller 64)
185 attenuation_ctrl_portamento = 0x19, ///< Portamento (MIDI Controller 65)
186 attenuation_ctrl_sostenutopedal = 0x1b, ///< Sostenuto Pedal (MIDI Controller 66)
187 attenuation_ctrl_softpedal = 0x09, ///< Soft Pedal (MIDI Controller 67)
188 attenuation_ctrl_genpurpose5 = 0x1d, ///< General Purpose Controller 5 (Button, MIDI Controller 80)
189 attenuation_ctrl_genpurpose6 = 0x1f, ///< General Purpose Controller 6 (Button, MIDI Controller 81)
190 attenuation_ctrl_genpurpose7 = 0x21, ///< General Purpose Controller 7 (Button, MIDI Controller 82)
191 attenuation_ctrl_genpurpose8 = 0x23, ///< General Purpose Controller 8 (Button, MIDI Controller 83)
192 attenuation_ctrl_effect1depth = 0x25, ///< Effect 1 Depth (MIDI Controller 91)
193 attenuation_ctrl_effect2depth = 0x27, ///< Effect 2 Depth (MIDI Controller 92)
194 attenuation_ctrl_effect3depth = 0x29, ///< Effect 3 Depth (MIDI Controller 93)
195 attenuation_ctrl_effect4depth = 0x2b, ///< Effect 4 Depth (MIDI Controller 94)
196 attenuation_ctrl_effect5depth = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)
197 attenuation_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure
198 attenuation_ctrl_velocity = 0xff ///< Key Velocity
199 } attenuation_ctrl_t, eg1_ctrl_t, eg2_ctrl_t;
200
201 /**
202 * Defines the type of dimension, that is how the dimension zones (and
203 * thus how the dimension regions are selected by. The number of
204 * dimension zones is always a power of two. All dimensions can have up
205 * to 32 zones (except the layer dimension with only up to 8 zones and
206 * the samplechannel dimension which currently allows only 2 zones).
207 */
208 typedef enum {
209 dimension_none = 0x00, ///< Dimension not in use.
210 dimension_samplechannel = 0x80, ///< If used sample has more than one channel (thus is not mono).
211 dimension_layer = 0x81, ///< For layering of up to 8 instruments (and eventually crossfading of 2 or 4 layers).
212 dimension_velocity = 0x82, ///< Key Velocity (this is the only dimension where the ranges can exactly be defined).
213 dimension_channelaftertouch = 0x83, ///< Channel Key Pressure
214 dimension_releasetrigger = 0x84, ///< Special dimension for triggering samples on releasing a key.
215 dimension_keyboard = 0x85, ///< Key Position
216 dimension_modwheel = 0x01, ///< Modulation Wheel (MIDI Controller 1)
217 dimension_breath = 0x02, ///< Breath Controller (Coarse, MIDI Controller 2)
218 dimension_foot = 0x04, ///< Foot Pedal (Coarse, MIDI Controller 4)
219 dimension_portamentotime = 0x05, ///< Portamento Time (Coarse, MIDI Controller 5)
220 dimension_effect1 = 0x0c, ///< Effect Controller 1 (Coarse, MIDI Controller 12)
221 dimension_effect2 = 0x0d, ///< Effect Controller 2 (Coarse, MIDI Controller 13)
222 dimension_genpurpose1 = 0x10, ///< General Purpose Controller 1 (Slider, MIDI Controller 16)
223 dimension_genpurpose2 = 0x11, ///< General Purpose Controller 2 (Slider, MIDI Controller 17)
224 dimension_genpurpose3 = 0x12, ///< General Purpose Controller 3 (Slider, MIDI Controller 18)
225 dimension_genpurpose4 = 0x13, ///< General Purpose Controller 4 (Slider, MIDI Controller 19)
226 dimension_sustainpedal = 0x40, ///< Sustain Pedal (MIDI Controller 64)
227 dimension_portamento = 0x41, ///< Portamento (MIDI Controller 65)
228 dimension_sostenutopedal = 0x42, ///< Sostenuto Pedal (MIDI Controller 66)
229 dimension_softpedal = 0x43, ///< Soft Pedal (MIDI Controller 67)
230 dimension_genpurpose5 = 0x30, ///< General Purpose Controller 5 (Button, MIDI Controller 80)
231 dimension_genpurpose6 = 0x31, ///< General Purpose Controller 6 (Button, MIDI Controller 81)
232 dimension_genpurpose7 = 0x32, ///< General Purpose Controller 7 (Button, MIDI Controller 82)
233 dimension_genpurpose8 = 0x33, ///< General Purpose Controller 8 (Button, MIDI Controller 83)
234 dimension_effect1depth = 0x5b, ///< Effect 1 Depth (MIDI Controller 91)
235 dimension_effect2depth = 0x5c, ///< Effect 2 Depth (MIDI Controller 92)
236 dimension_effect3depth = 0x5d, ///< Effect 3 Depth (MIDI Controller 93)
237 dimension_effect4depth = 0x5e, ///< Effect 4 Depth (MIDI Controller 94)
238 dimension_effect5depth = 0x5f ///< Effect 5 Depth (MIDI Controller 95)
239 } dimension_t;
240
241 /**
242 * Intended for internal usage: will be used to convert a dimension value
243 * into the corresponding dimension bit number.
244 */
245 typedef enum {
246 split_type_normal, ///< dimension value between 0-127, no custom range of zones
247 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)
248 split_type_bit ///< dimension values are already the sought bit number
249 } split_type_t;
250
251 /** General dimension definition. */
252 struct dimension_def_t {
253 dimension_t dimension; ///< Specifies which source (usually a MIDI controller) is associated with the dimension.
254 uint8_t bits; ///< Number of "bits" (1 bit = 2 splits/zones, 2 bit = 4 splits/zones, 3 bit = 8 splits/zones,...).
255 uint8_t zones; ///< Number of zones the dimension has.
256 split_type_t split_type; ///< Intended for internal usage: will be used to convert a dimension value into the corresponding dimension bit number.
257 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).
258 unsigned int zone_size; ///< Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only, 0 otherwise.
259 };
260
261 /** Defines which frequencies are filtered by the VCF. */
262 typedef enum {
263 vcf_type_lowpass = 0x00,
264 vcf_type_lowpassturbo = 0xff, ///< More poles than normal lowpass
265 vcf_type_bandpass = 0x01,
266 vcf_type_highpass = 0x02,
267 vcf_type_bandreject = 0x03
268 } vcf_type_t;
269
270 /** Defines the envelope of a crossfade. */
271 struct crossfade_t {
272 #if WORDS_BIGENDIAN
273 uint8_t in_start; ///< Start position of fade in.
274 uint8_t in_end; ///< End position of fade in.
275 uint8_t out_start; ///< Start position of fade out.
276 uint8_t out_end; ///< End postition of fade out.
277 #else // little endian
278 uint8_t out_end; ///< End postition of fade out.
279 uint8_t out_start; ///< Start position of fade out.
280 uint8_t in_end; ///< End position of fade in.
281 uint8_t in_start; ///< Start position of fade in.
282 #endif // WORDS_BIGENDIAN
283 };
284
285 // just symbol prototyping
286 class File;
287 class Instrument;
288 class Sample;
289
290 /** Encapsulates articulation information of a dimension region.
291 *
292 * Every Gigasampler Instrument has at least one dimension region
293 * (exactly then when it has no dimension defined).
294 *
295 * Gigasampler provides three Envelope Generators and Low Frequency
296 * Oscillators:
297 *
298 * - EG1 and LFO1, both controlling sample amplitude
299 * - EG2 and LFO2, both controlling filter cutoff frequency
300 * - EG3 and LFO3, both controlling sample pitch
301 */
302 class DimensionRegion : protected DLS::Sampler {
303 public:
304 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).
305 Sample* pSample; ///< Points to the Sample which is assigned to the dimension region.
306 // Sample Amplitude EG/LFO
307 uint16_t EG1PreAttack; ///< Preattack value of the sample amplitude EG (0 - 1000 permille).
308 double EG1Attack; ///< Attack time of the sample amplitude EG (0.000 - 60.000s).
309 double EG1Decay1; ///< Decay time of the sample amplitude EG (0.000 - 60.000s).
310 double EG1Decay2; ///< Only if <i>EG1InfiniteSustain == false</i>: 2nd decay stage time of the sample amplitude EG (0.000 - 60.000s).
311 bool EG1InfiniteSustain; ///< If <i>true</i>, instead of going into Decay2 phase, Decay1 level will be hold until note will be released.
312 uint16_t EG1Sustain; ///< Sustain value of the sample amplitude EG (0 - 1000 permille).
313 double EG1Release; ///< Release time of the sample amplitude EG (0.000 - 60.000s).
314 bool EG1Hold; ///< If <i>true</i>, Decay1 stage should be postponed until the sample reached the sample loop start.
315 eg1_ctrl_t EG1Controller; ///< MIDI Controller which has influence on sample amplitude EG parameters (attack, decay, release).
316 bool EG1ControllerInvert; ///< Invert values coming from defined EG1 controller.
317 uint8_t EG1ControllerAttackInfluence; ///< Amount EG1 Controller has influence on the EG1 Attack time.
318 uint8_t EG1ControllerDecayInfluence; ///< Amount EG1 Controller has influence on the EG1 Decay time.
319 uint8_t EG1ControllerReleaseInfluence; ///< Amount EG1 Controller has influence on the EG1 Release time.
320 double LFO1Frequency; ///< Frequency of the sample amplitude LFO (0.10 - 10.00 Hz).
321 uint16_t LFO1InternalDepth; ///< Firm pitch of the sample amplitude LFO (0 - 1200 cents).
322 uint16_t LFO1ControlDepth; ///< Controller depth influencing sample amplitude LFO pitch (0 - 1200 cents).
323 lfo1_ctrl_t LFO1Controller; ///< MIDI Controller which controls sample amplitude LFO.
324 bool LFO1FlipPhase; ///< Inverts phase of the sample amplitude LFO wave.
325 bool LFO1Sync; ///< If set to <i>true</i> only one LFO should be used for all voices.
326 // Filter Cutoff Frequency EG/LFO
327 uint16_t EG2PreAttack; ///< Preattack value of the filter cutoff EG (0 - 1000 permille).
328 double EG2Attack; ///< Attack time of the filter cutoff EG (0.000 - 60.000s).
329 double EG2Decay1; ///< Decay time of the filter cutoff EG (0.000 - 60.000s).
330 double EG2Decay2; ///< Only if <i>EG2InfiniteSustain == false</i>: 2nd stage decay time of the filter cutoff EG (0.000 - 60.000s).
331 bool EG2InfiniteSustain; ///< If <i>true</i>, instead of going into Decay2 phase, Decay1 level will be hold until note will be released.
332 uint16_t EG2Sustain; ///< Sustain value of the filter cutoff EG (0 - 1000 permille).
333 double EG2Release; ///< Release time of the filter cutoff EG (0.000 - 60.000s).
334 eg2_ctrl_t EG2Controller; ///< MIDI Controller which has influence on filter cutoff EG parameters (attack, decay, release).
335 bool EG2ControllerInvert; ///< Invert values coming from defined EG2 controller.
336 uint8_t EG2ControllerAttackInfluence; ///< Amount EG2 Controller has influence on the EG2 Attack time.
337 uint8_t EG2ControllerDecayInfluence; ///< Amount EG2 Controller has influence on the EG2 Decay time.
338 uint8_t EG2ControllerReleaseInfluence; ///< Amount EG2 Controller has influence on the EG2 Release time.
339 double LFO2Frequency; ///< Frequency of the filter cutoff LFO (0.10 - 10.00 Hz).
340 uint16_t LFO2InternalDepth; ///< Firm pitch of the filter cutoff LFO (0 - 1200 cents).
341 uint16_t LFO2ControlDepth; ///< Controller depth influencing filter cutoff LFO pitch (0 - 1200).
342 lfo2_ctrl_t LFO2Controller; ///< MIDI Controlle which controls the filter cutoff LFO.
343 bool LFO2FlipPhase; ///< Inverts phase of the filter cutoff LFO wave.
344 bool LFO2Sync; ///< If set to <i>true</i> only one LFO should be used for all voices.
345 // Sample Pitch EG/LFO
346 double EG3Attack; ///< Attack time of the sample pitch EG (0.000 - 10.000s).
347 int16_t EG3Depth; ///< Depth of the sample pitch EG (-1200 - +1200).
348 double LFO3Frequency; ///< Frequency of the sample pitch LFO (0.10 - 10.00 Hz).
349 int16_t LFO3InternalDepth; ///< Firm depth of the sample pitch LFO (-1200 - +1200 cents).
350 int16_t LFO3ControlDepth; ///< Controller depth of the sample pitch LFO (-1200 - +1200 cents).
351 lfo3_ctrl_t LFO3Controller; ///< MIDI Controller which controls the sample pitch LFO.
352 bool LFO3Sync; ///< If set to <i>true</i> only one LFO should be used for all voices.
353 // Filter
354 bool VCFEnabled; ///< If filter should be used.
355 vcf_type_t VCFType; ///< Defines the general filter characteristic (lowpass, highpass, bandpass, etc.).
356 vcf_cutoff_ctrl_t VCFCutoffController; ///< Specifies which external controller has influence on the filter cutoff frequency.
357 uint8_t VCFCutoff; ///< Max. cutoff frequency.
358 curve_type_t VCFVelocityCurve; ///< Defines a transformation curve for the incoming velocity values, affecting the VCF.
359 uint8_t VCFVelocityScale; ///< (0-127) Amount velocity controls VCF cutoff frequency (only if no other VCF cutoff controller is defined).
360 uint8_t VCFVelocityDynamicRange; ///< 0x04 = lowest, 0x00 = highest
361 uint8_t VCFResonance; ///< Firm internal filter resonance weight.
362 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).
363 vcf_res_ctrl_t VCFResonanceController; ///< Specifies which external controller has influence on the filter resonance Q.
364 bool VCFKeyboardTracking; ///< If <i>true</i>: VCF cutoff frequence will be dependend to the note key position relative to the defined breakpoint value.
365 uint8_t VCFKeyboardTrackingBreakpoint; ///< See VCFKeyboardTracking (0 - 127).
366 // Key Velocity Transformations
367 curve_type_t VelocityResponseCurve; ///< Defines a transformation curve to the incoming velocity values affecting amplitude.
368 uint8_t VelocityResponseDepth; ///< Dynamic range of velocity affecting amplitude (0 - 4).
369 uint8_t VelocityResponseCurveScaling; ///< 0 - 127
370 curve_type_t ReleaseVelocityResponseCurve; ///< Defines a transformation curve to the incoming release veloctiy values affecting envelope times.
371 uint8_t ReleaseVelocityResponseDepth; ///< Dynamic range of release velocity affecting envelope time (0 - 4).
372 uint8_t ReleaseTriggerDecay; ///< 0 - 8
373 // Mix / Layer
374 crossfade_t Crossfade;
375 bool PitchTrack; ///< If <i>true</i>: sample will be pitched according to the key position (this will be disabled for drums for example).
376 dim_bypass_ctrl_t DimensionBypass; ///< If defined, the MIDI controller can switch on/off the dimension in realtime.
377 int8_t Pan; ///< Panorama / Balance (-64..0..63 <-> left..middle..right)
378 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.
379 attenuation_ctrl_t AttenuationControl; ///< MIDI Controller which has influence on the volume level of the sample (or entire sample group).
380 bool InvertAttenuationControl; ///< Inverts the values coming from the defined Attenuation Controller.
381 uint8_t AttenuationControlTreshold; ///< 0-127
382 uint8_t ChannelOffset; ///< Audio output where the audio signal of the dimension region should be routed to (0 - 9).
383 bool SustainDefeat; ///< If <i>true</i>: Sustain pedal will not hold a note.
384 bool MSDecode; ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.
385 uint16_t SampleStartOffset; ///< Number of samples the sample start should be moved (0 - 2000).
386 // derived attributes from DLS::Sampler
387 DLS::Sampler::UnityNote;
388 DLS::Sampler::FineTune;
389 DLS::Sampler::Gain;
390 DLS::Sampler::SampleLoops;
391 DLS::Sampler::pSampleLoops;
392
393 // Methods
394 double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
395 protected:
396 DimensionRegion(RIFF::List* _3ewl);
397 ~DimensionRegion();
398 friend class Region;
399 private:
400 typedef std::map<uint32_t, double*> VelocityTableMap;
401
402 static uint Instances; ///< Number of DimensionRegion instances.
403 static VelocityTableMap* pVelocityTables; ///< Contains the tables corresponding to the various velocity parameters (VelocityResponseCurve and VelocityResponseDepth).
404 double* pVelocityAttenuationTable; ///< Points to the velocity table corresponding to the velocity parameters of this DimensionRegion.
405 };
406
407 /** Encapsulates sample waves used for playback. */
408 class Sample : public DLS::Sample {
409 public:
410 uint16_t SampleGroup;
411 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.
412 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.
413 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).
414 uint32_t MIDIUnityNote; ///< Specifies the musical note at which the sample will be played at it's original sample rate.
415 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.
416 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.
417 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).
418 uint32_t Loops; ///< Number of defined sample loops (so far only seen single loops in gig files - please report me if you encounter more!).
419 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.
420 loop_type_t LoopType; ///< The type field defines how the waveform samples will be looped (only if Loops > 0).
421 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).
422 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).
423 uint32_t LoopSize; ///< Length of the looping area (in sample points) which is equivalent to <i>LoopEnd - LoopStart</i>.
424 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.
425 uint32_t LoopPlayCount; ///< Number of times the loop should be played (only if Loops > 0, a value of 0 = infinite).
426 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).
427
428 // own methods
429 buffer_t LoadSampleData();
430 buffer_t LoadSampleData(unsigned long SampleCount);
431 buffer_t LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
432 buffer_t LoadSampleDataWithNullSamplesExtension(unsigned long SampleCount, uint NullSamplesCount);
433 buffer_t GetCache();
434 // overridden methods
435 void ReleaseSampleData();
436 unsigned long SetPos(unsigned long SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
437 unsigned long GetPos();
438 unsigned long Read(void* pBuffer, unsigned long SampleCount);
439 protected:
440 static unsigned int Instances; ///< Number of instances of class Sample.
441 static unsigned long DecompressionBufferSize; ///< Current size of the decompression buffer.
442 static void* pDecompressionBuffer; ///< Small buffer used for decompression only.
443 unsigned long FrameOffset; ///< Current offset (sample points) in current sample frame (for decompression only).
444 unsigned long* FrameTable; ///< For positioning within compressed samples only: stores the offset values for each frame.
445 unsigned long SamplePos; ///< For compressed samples only: stores the current position (in sample points).
446 buffer_t RAMCache; ///< Buffers samples (already uncompressed) in RAM.
447
448 Sample(File* pFile, RIFF::List* waveList, unsigned long WavePoolOffset);
449 ~Sample();
450 private:
451 void ScanCompressedSample();
452 friend class File;
453 friend class Region;
454 };
455
456 // TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions)
457 /** Defines <i>Region</i> information of an <i>Instrument</i>. */
458 class Region : public DLS::Region {
459 public:
460 unsigned int Dimensions; ///< Number of defined dimensions.
461 dimension_def_t pDimensionDefinitions[5]; ///< Defines the five possible dimensions (the dimension's controller and number of bits/splits).
462 uint32_t DimensionRegions; ///< Total number of DimensionRegions this Region contains.
463 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).
464
465 DimensionRegion* GetDimensionRegionByValue(uint Dim4Val, uint Dim3Val, uint Dim2Val, uint Dim1Val, uint Dim0Val);
466 DimensionRegion* GetDimensionRegionByBit(uint8_t Dim4Bit, uint8_t Dim3Bit, uint8_t Dim2Bit, uint8_t Dim1Bit, uint8_t Dim0Bit);
467 Sample* GetSample();
468 protected:
469 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.
470
471 Region(Instrument* pInstrument, RIFF::List* rgnList);
472 void LoadDimensionRegions(RIFF::List* rgn);
473 Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex);
474 ~Region();
475 friend class Instrument;
476 };
477
478 /** Provides all neccessary information for the synthesis of an <i>Instrument</i>. */
479 class Instrument : protected DLS::Instrument {
480 public:
481 // derived attributes from DLS::Resource
482 DLS::Resource::pInfo;
483 DLS::Resource::pDLSID;
484 // derived attributes from DLS::Instrument
485 DLS::Instrument::IsDrum;
486 DLS::Instrument::MIDIBank;
487 DLS::Instrument::MIDIBankCoarse;
488 DLS::Instrument::MIDIBankFine;
489 DLS::Instrument::MIDIProgram;
490 DLS::Instrument::Regions;
491 // own attributes
492 int32_t Attenuation; ///< in dB
493 uint16_t EffectSend;
494 int16_t FineTune; ///< in cents
495 uint16_t PitchbendRange; ///< Number of semitones pitchbend controller can pitch (default is 2).
496 bool PianoReleaseMode;
497 range_t DimensionKeyRange; ///< 0-127 (where 0 means C1 and 127 means G9)
498
499
500 // derived methods from DLS::Resource
501 DLS::Resource::GetParent;
502 // overridden methods
503 Region* GetFirstRegion();
504 Region* GetNextRegion();
505 // own methods
506 Region* GetRegion(unsigned int Key);
507 protected:
508 Region** pRegions; ///< Pointer array to the regions
509 Region* RegionKeyTable[128]; ///< fast lookup for the corresponding Region of a MIDI key
510 int RegionIndex;
511
512 Instrument(File* pFile, RIFF::List* insList);
513 ~Instrument();
514 friend class File;
515 };
516
517 // TODO: <3gnm> chunk not added yet (just contains the names of the sample groups)
518 /** Parses Gigasampler files and provides abstract access to the data. */
519 class File : protected DLS::File {
520 public:
521 // derived attributes from DLS::Resource
522 DLS::Resource::pInfo;
523 DLS::Resource::pDLSID;
524 // derived attributes from DLS::File
525 DLS::File::pVersion;
526 DLS::File::Instruments;
527
528 // derived methods from DLS::Resource
529 DLS::Resource::GetParent;
530 // overridden methods
531 File(RIFF::File* pRIFF);
532 Sample* GetFirstSample(); ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise.
533 Sample* GetNextSample(); ///< Returns a pointer to the next <i>Sample</i> object of the file, <i>NULL</i> otherwise.
534 Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
535 Instrument* GetNextInstrument(); ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
536 Instrument* GetInstrument(uint index);
537 ~File() {};
538 protected:
539 typedef std::list<Sample*> SampleList;
540 typedef std::list<Instrument*> InstrumentList;
541
542 SampleList* pSamples;
543 SampleList::iterator SamplesIterator;
544 InstrumentList* pInstruments;
545 InstrumentList::iterator InstrumentsIterator;
546
547 void LoadSamples();
548 void LoadInstruments();
549 friend class Region;
550 };
551
552 /** Will be thrown whenever a gig specific error occurs while trying to access a Gigasampler File. */
553 class Exception : public DLS::Exception {
554 public:
555 Exception(String Message);
556 void PrintMessage();
557 };
558
559 } // namespace gig
560
561 #endif // __GIG_H__

  ViewVC Help
Powered by ViewVC