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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 11 - (hide annotations) (download) (as text)
Sun Nov 16 17:47:00 2003 UTC (20 years, 4 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 39626 byte(s)
* src/gig.cpp: fixed bug in decompression algorithm which caused it not to
  detect the end of a stream
* various endian corrections (successfully tested now on ppc)
* minor adjustments to avoid compile errors on some systems
  (using now pow() instead of powl() and --pedantic g++ compiler switch)
* src/RIFF.cpp, src/RIFF.h: added additional API documentation

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

  ViewVC Help
Powered by ViewVC