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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 310 - (hide annotations) (download) (as text)
Fri Nov 26 00:14:50 2004 UTC (19 years, 4 months ago) by capela
File MIME type: text/x-c++hdr
File size: 46406 byte(s)
* gig.h oneliner forward declaration of gig::Region.
* Fixed man pages automake install rule.
* Doxygen documentation fix (make docs).

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