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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3446 - (hide annotations) (download) (as text)
Sun Dec 23 21:47:26 2018 UTC (5 years, 3 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 94337 byte(s)
* GIG FORMAT EXTENSION: Added attribute
  DimensionRegion::NoNoteOffReleaseTrigger which allows to disable the
  regular behaviour of playing release trigger sample on MIDI note-off
  events.
* Bumped version (4.1.0.svn8).

1 schoenebeck 2 /***************************************************************************
2     * *
3 schoenebeck 933 * libgig - C++ cross-platform Gigasampler format file access library *
4 schoenebeck 2 * *
5 schoenebeck 3414 * Copyright (C) 2003-2018 by Christian Schoenebeck *
6 schoenebeck 384 * <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 schoenebeck 2584 #include <vector>
29 schoenebeck 2
30 schoenebeck 3169 #ifndef __has_feature
31     # define __has_feature(x) 0
32     #endif
33     #ifndef HAVE_RTTI
34     # if __GXX_RTTI || __has_feature(cxx_rtti) || _CPPRTTI
35     # define HAVE_RTTI 1
36     # else
37     # define HAVE_RTTI 0
38     # endif
39     #endif
40     #if HAVE_RTTI
41     # include <typeinfo>
42 schoenebeck 3173 #else
43     # warning No RTTI available!
44 schoenebeck 3169 #endif
45    
46 schoenebeck 11 #if WORDS_BIGENDIAN
47 schoenebeck 2 # define LIST_TYPE_3PRG 0x33707267
48     # define LIST_TYPE_3EWL 0x3365776C
49 schoenebeck 929 # define LIST_TYPE_3GRI 0x33677269
50     # define LIST_TYPE_3GNL 0x33676E6C
51 schoenebeck 2584 # define LIST_TYPE_3LS 0x334c5320 // own gig format extension
52     # define LIST_TYPE_RTIS 0x52544953 // own gig format extension
53 schoenebeck 2 # define CHUNK_ID_3GIX 0x33676978
54     # define CHUNK_ID_3EWA 0x33657761
55     # define CHUNK_ID_3LNK 0x336C6E6B
56     # define CHUNK_ID_3EWG 0x33657767
57     # define CHUNK_ID_EWAV 0x65776176
58 schoenebeck 929 # define CHUNK_ID_3GNM 0x33676E6D
59 persson 1199 # define CHUNK_ID_EINF 0x65696E66
60     # define CHUNK_ID_3CRC 0x33637263
61 schoenebeck 2584 # define CHUNK_ID_SCRI 0x53637269 // own gig format extension
62     # define CHUNK_ID_LSNM 0x4c534e4d // own gig format extension
63     # define CHUNK_ID_SCSL 0x5343534c // own gig format extension
64 schoenebeck 3323 # define CHUNK_ID_LSDE 0x4c534445 // own gig format extension
65 schoenebeck 2 #else // little endian
66     # define LIST_TYPE_3PRG 0x67727033
67     # define LIST_TYPE_3EWL 0x6C776533
68 schoenebeck 929 # define LIST_TYPE_3GRI 0x69726733
69     # define LIST_TYPE_3GNL 0x6C6E6733
70 schoenebeck 2584 # define LIST_TYPE_3LS 0x20534c33 // own gig format extension
71     # define LIST_TYPE_RTIS 0x53495452 // own gig format extension
72 schoenebeck 2 # define CHUNK_ID_3GIX 0x78696733
73     # define CHUNK_ID_3EWA 0x61776533
74     # define CHUNK_ID_3LNK 0x6B6E6C33
75     # define CHUNK_ID_3EWG 0x67776533
76     # define CHUNK_ID_EWAV 0x76617765
77 schoenebeck 929 # define CHUNK_ID_3GNM 0x6D6E6733
78 persson 1199 # define CHUNK_ID_EINF 0x666E6965
79     # define CHUNK_ID_3CRC 0x63726333
80 schoenebeck 2584 # define CHUNK_ID_SCRI 0x69726353 // own gig format extension
81     # define CHUNK_ID_LSNM 0x4d4e534c // own gig format extension
82     # define CHUNK_ID_SCSL 0x4c534353 // own gig format extension
83 schoenebeck 3323 # define CHUNK_ID_LSDE 0x4544534c // own gig format extension
84 schoenebeck 2 #endif // WORDS_BIGENDIAN
85    
86 schoenebeck 3169 #ifndef GIG_DECLARE_ENUM
87     # define GIG_DECLARE_ENUM(type, ...) enum type { __VA_ARGS__ }
88     #endif
89    
90 schoenebeck 3140 // just symbol prototyping (since Serialization.h not included by default here)
91     namespace Serialization { class Archive; }
92    
93 schoenebeck 2699 /** Gigasampler/GigaStudio specific classes and definitions */
94 schoenebeck 2 namespace gig {
95    
96     typedef std::string String;
97 schoenebeck 2682 typedef RIFF::progress_t progress_t;
98 schoenebeck 2912 typedef RIFF::file_offset_t file_offset_t;
99 schoenebeck 2
100     /** Lower and upper limit of a range. */
101     struct range_t {
102     uint8_t low; ///< Low value of range.
103     uint8_t high; ///< High value of range.
104     };
105    
106     /** Pointer address and size of a buffer. */
107     struct buffer_t {
108     void* pStart; ///< Points to the beginning of the buffer.
109 schoenebeck 2912 file_offset_t Size; ///< Size of the actual data in the buffer in bytes.
110     file_offset_t 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. :)
111 schoenebeck 384 buffer_t() {
112     pStart = NULL;
113     Size = 0;
114     NullExtensionSize = 0;
115     }
116 schoenebeck 2 };
117    
118 schoenebeck 3169 /** Standard types of sample loops.
119     *
120 schoenebeck 3181 * @see enumCount(), enumKey(), enumKeys(), enumValue()
121 schoenebeck 3169 */
122     GIG_DECLARE_ENUM(loop_type_t,
123 schoenebeck 3398 loop_type_normal = 0x00000000, /**< Loop forward (normal) */
124     loop_type_bidirectional = 0x00000001, /**< Alternating loop (forward/backward, also known as Ping Pong) */
125     loop_type_backward = 0x00000002 /**< Loop backward (reverse) */
126 schoenebeck 3169 );
127 schoenebeck 2
128 schoenebeck 3169 /** Society of Motion Pictures and Television E time format.
129     *
130 schoenebeck 3181 * @see enumCount(), enumKey(), enumKeys(), enumValue()
131 schoenebeck 3169 */
132     GIG_DECLARE_ENUM(smpte_format_t,
133 schoenebeck 3398 smpte_format_no_offset = 0x00000000, /**< no SMPTE offset */
134     smpte_format_24_frames = 0x00000018, /**< 24 frames per second */
135     smpte_format_25_frames = 0x00000019, /**< 25 frames per second */
136     smpte_format_30_frames_dropping = 0x0000001D, /**< 30 frames per second with frame dropping (30 drop) */
137     smpte_format_30_frames = 0x0000001E /**< 30 frames per second */
138 schoenebeck 3169 );
139 schoenebeck 2
140 schoenebeck 3169 /** Defines the shape of a function graph.
141     *
142 schoenebeck 3181 * @see enumCount(), enumKey(), enumKeys(), enumValue()
143 schoenebeck 3169 */
144     GIG_DECLARE_ENUM(curve_type_t,
145 schoenebeck 3398 curve_type_nonlinear = 0, /**< Non-linear curve type. */
146     curve_type_linear = 1, /**< Linear curve type. */
147     curve_type_special = 2, /**< Special curve type. */
148     curve_type_unknown = 0xffffffff /**< Unknown curve type. */
149 schoenebeck 3169 );
150 schoenebeck 2
151 schoenebeck 3169 /** Dimensions allow to bypass one of the following controllers.
152     *
153 schoenebeck 3181 * @see enumCount(), enumKey(), enumKeys(), enumValue()
154 schoenebeck 3169 */
155     GIG_DECLARE_ENUM(dim_bypass_ctrl_t,
156 schoenebeck 3398 dim_bypass_ctrl_none, /**< No controller bypass. */
157     dim_bypass_ctrl_94, /**< Effect 4 Depth (MIDI Controller 94) */
158     dim_bypass_ctrl_95 /**< Effect 5 Depth (MIDI Controller 95) */
159 schoenebeck 3169 );
160 schoenebeck 2
161 schoenebeck 3169 /** Defines how LFO3 is controlled by.
162     *
163 schoenebeck 3181 * @see enumCount(), enumKey(), enumKeys(), enumValue()
164 schoenebeck 3169 */
165     GIG_DECLARE_ENUM(lfo3_ctrl_t,
166 schoenebeck 3398 lfo3_ctrl_internal = 0x00, /**< Only internally controlled. */
167     lfo3_ctrl_modwheel = 0x01, /**< Only controlled by external modulation wheel. */
168     lfo3_ctrl_aftertouch = 0x02, /**< Only controlled by aftertouch controller. */
169     lfo3_ctrl_internal_modwheel = 0x03, /**< Controlled internally and by external modulation wheel. */
170     lfo3_ctrl_internal_aftertouch = 0x04 /**< Controlled internally and by aftertouch controller. */
171 schoenebeck 3169 );
172 schoenebeck 2
173 schoenebeck 3169 /** Defines how LFO2 is controlled by.
174     *
175 schoenebeck 3181 * @see enumCount(), enumKey(), enumKeys(), enumValue()
176 schoenebeck 3169 */
177     GIG_DECLARE_ENUM(lfo2_ctrl_t,
178 schoenebeck 3398 lfo2_ctrl_internal = 0x00, /**< Only internally controlled. */
179     lfo2_ctrl_modwheel = 0x01, /**< Only controlled by external modulation wheel. */
180     lfo2_ctrl_foot = 0x02, /**< Only controlled by external foot controller. */
181     lfo2_ctrl_internal_modwheel = 0x03, /**< Controlled internally and by external modulation wheel. */
182     lfo2_ctrl_internal_foot = 0x04 /**< Controlled internally and by external foot controller. */
183 schoenebeck 3169 );
184 schoenebeck 2
185 schoenebeck 3169 /** Defines how LFO1 is controlled by.
186     *
187 schoenebeck 3181 * @see enumCount(), enumKey(), enumKeys(), enumValue()
188 schoenebeck 3169 */
189     GIG_DECLARE_ENUM(lfo1_ctrl_t,
190 schoenebeck 3398 lfo1_ctrl_internal = 0x00, /**< Only internally controlled. */
191     lfo1_ctrl_modwheel = 0x01, /**< Only controlled by external modulation wheel. */
192     lfo1_ctrl_breath = 0x02, /**< Only controlled by external breath controller. */
193     lfo1_ctrl_internal_modwheel = 0x03, /**< Controlled internally and by external modulation wheel. */
194     lfo1_ctrl_internal_breath = 0x04 /**< Controlled internally and by external breath controller. */
195 schoenebeck 3169 );
196 schoenebeck 2
197 schoenebeck 3169 /** Defines how the filter cutoff frequency is controlled by.
198     *
199 schoenebeck 3181 * @see enumCount(), enumKey(), enumKeys(), enumValue()
200 schoenebeck 3169 */
201     GIG_DECLARE_ENUM(vcf_cutoff_ctrl_t,
202 schoenebeck 3398 vcf_cutoff_ctrl_none = 0x00, /**< No MIDI controller assigned for filter cutoff frequency. */
203     vcf_cutoff_ctrl_none2 = 0x01, /**< The difference between none and none2 is unknown */
204     vcf_cutoff_ctrl_modwheel = 0x81, /**< Modulation Wheel (MIDI Controller 1) */
205     vcf_cutoff_ctrl_effect1 = 0x8c, /**< Effect Controller 1 (Coarse, MIDI Controller 12) */
206     vcf_cutoff_ctrl_effect2 = 0x8d, /**< Effect Controller 2 (Coarse, MIDI Controller 13) */
207     vcf_cutoff_ctrl_breath = 0x82, /**< Breath Controller (Coarse, MIDI Controller 2) */
208     vcf_cutoff_ctrl_foot = 0x84, /**< Foot Pedal (Coarse, MIDI Controller 4) */
209     vcf_cutoff_ctrl_sustainpedal = 0xc0, /**< Sustain Pedal (MIDI Controller 64) */
210     vcf_cutoff_ctrl_softpedal = 0xc3, /**< Soft Pedal (MIDI Controller 67) */
211     vcf_cutoff_ctrl_genpurpose7 = 0xd2, /**< General Purpose Controller 7 (Button, MIDI Controller 82) */
212     vcf_cutoff_ctrl_genpurpose8 = 0xd3, /**< General Purpose Controller 8 (Button, MIDI Controller 83) */
213     vcf_cutoff_ctrl_aftertouch = 0x80 /**< Key Pressure */
214 schoenebeck 3169 );
215 schoenebeck 2
216 schoenebeck 3169 /** Defines how the filter resonance is controlled by.
217     *
218 schoenebeck 3181 * @see enumCount(), enumKey(), enumKeys(), enumValue()
219 schoenebeck 3169 */
220     GIG_DECLARE_ENUM(vcf_res_ctrl_t,
221 schoenebeck 3398 vcf_res_ctrl_none = 0xffffffff, /**< No MIDI controller assigned for filter resonance. */
222     vcf_res_ctrl_genpurpose3 = 0, /**< General Purpose Controller 3 (Slider, MIDI Controller 18) */
223     vcf_res_ctrl_genpurpose4 = 1, /**< General Purpose Controller 4 (Slider, MIDI Controller 19) */
224     vcf_res_ctrl_genpurpose5 = 2, /**< General Purpose Controller 5 (Button, MIDI Controller 80) */
225     vcf_res_ctrl_genpurpose6 = 3 /**< General Purpose Controller 6 (Button, MIDI Controller 81) */
226 schoenebeck 3169 );
227 schoenebeck 55
228 schoenebeck 36 /**
229     * Defines a controller that has a certain contrained influence on a
230     * particular synthesis parameter (used to define attenuation controller,
231     * EG1 controller and EG2 controller).
232     *
233     * You should use the respective <i>typedef</i> (means either
234     * attenuation_ctrl_t, eg1_ctrl_t or eg2_ctrl_t) in your code!
235     */
236     struct leverage_ctrl_t {
237 schoenebeck 3169 /** Defines possible controllers.
238     *
239 schoenebeck 3181 * @see enumCount(), enumKey(), enumKeys(), enumValue()
240 schoenebeck 3169 */
241     GIG_DECLARE_ENUM(type_t,
242 schoenebeck 3398 type_none = 0x00, /**< No controller defined */
243     type_channelaftertouch = 0x2f, /**< Channel Key Pressure */
244     type_velocity = 0xff, /**< Key Velocity */
245     type_controlchange = 0xfe /**< Ordinary MIDI control change controller, see field 'controller_number' */
246 schoenebeck 3169 );
247 schoenebeck 55
248 schoenebeck 36 type_t type; ///< Controller type
249     uint controller_number; ///< MIDI controller number if this controller is a control change controller, 0 otherwise
250 schoenebeck 3138
251     void serialize(Serialization::Archive* archive);
252 schoenebeck 36 };
253 schoenebeck 55
254 schoenebeck 36 /**
255     * Defines controller influencing attenuation.
256     *
257     * @see leverage_ctrl_t
258     */
259     typedef leverage_ctrl_t attenuation_ctrl_t;
260 schoenebeck 55
261 schoenebeck 36 /**
262     * Defines controller influencing envelope generator 1.
263     *
264     * @see leverage_ctrl_t
265     */
266     typedef leverage_ctrl_t eg1_ctrl_t;
267 schoenebeck 55
268 schoenebeck 36 /**
269     * Defines controller influencing envelope generator 2.
270     *
271     * @see leverage_ctrl_t
272     */
273     typedef leverage_ctrl_t eg2_ctrl_t;
274 schoenebeck 2
275     /**
276     * Defines the type of dimension, that is how the dimension zones (and
277     * thus how the dimension regions are selected by. The number of
278     * dimension zones is always a power of two. All dimensions can have up
279     * to 32 zones (except the layer dimension with only up to 8 zones and
280     * the samplechannel dimension which currently allows only 2 zones).
281 schoenebeck 3169 *
282 schoenebeck 3181 * @see enumCount(), enumKey(), enumKeys(), enumValue()
283 schoenebeck 2 */
284 schoenebeck 3169 GIG_DECLARE_ENUM(dimension_t,
285 schoenebeck 3398 dimension_none = 0x00, /**< Dimension not in use. */
286     dimension_samplechannel = 0x80, /**< If used sample has more than one channel (thus is not mono). */
287     dimension_layer = 0x81, /**< For layering of up to 8 instruments (and eventually crossfading of 2 or 4 layers). */
288     dimension_velocity = 0x82, /**< Key Velocity (this is the only dimension in gig2 where the ranges can exactly be defined). */
289     dimension_channelaftertouch = 0x83, /**< Channel Key Pressure */
290     dimension_releasetrigger = 0x84, /**< Special dimension for triggering samples on releasing a key. */
291     dimension_keyboard = 0x85, /**< Dimension for keyswitching */
292     dimension_roundrobin = 0x86, /**< Different samples triggered each time a note is played, dimension regions selected in sequence */
293     dimension_random = 0x87, /**< Different samples triggered each time a note is played, random order */
294     dimension_smartmidi = 0x88, /**< For MIDI tools like legato and repetition mode */
295     dimension_roundrobinkeyboard = 0x89, /**< Different samples triggered each time a note is played, any key advances the counter */
296     dimension_modwheel = 0x01, /**< Modulation Wheel (MIDI Controller 1) */
297     dimension_breath = 0x02, /**< Breath Controller (Coarse, MIDI Controller 2) */
298     dimension_foot = 0x04, /**< Foot Pedal (Coarse, MIDI Controller 4) */
299     dimension_portamentotime = 0x05, /**< Portamento Time (Coarse, MIDI Controller 5) */
300     dimension_effect1 = 0x0c, /**< Effect Controller 1 (Coarse, MIDI Controller 12) */
301     dimension_effect2 = 0x0d, /**< Effect Controller 2 (Coarse, MIDI Controller 13) */
302     dimension_genpurpose1 = 0x10, /**< General Purpose Controller 1 (Slider, MIDI Controller 16) */
303     dimension_genpurpose2 = 0x11, /**< General Purpose Controller 2 (Slider, MIDI Controller 17) */
304     dimension_genpurpose3 = 0x12, /**< General Purpose Controller 3 (Slider, MIDI Controller 18) */
305     dimension_genpurpose4 = 0x13, /**< General Purpose Controller 4 (Slider, MIDI Controller 19) */
306     dimension_sustainpedal = 0x40, /**< Sustain Pedal (MIDI Controller 64) */
307     dimension_portamento = 0x41, /**< Portamento (MIDI Controller 65) */
308     dimension_sostenutopedal = 0x42, /**< Sostenuto Pedal (MIDI Controller 66) */
309     dimension_softpedal = 0x43, /**< Soft Pedal (MIDI Controller 67) */
310     dimension_genpurpose5 = 0x30, /**< General Purpose Controller 5 (Button, MIDI Controller 80) */
311     dimension_genpurpose6 = 0x31, /**< General Purpose Controller 6 (Button, MIDI Controller 81) */
312     dimension_genpurpose7 = 0x32, /**< General Purpose Controller 7 (Button, MIDI Controller 82) */
313     dimension_genpurpose8 = 0x33, /**< General Purpose Controller 8 (Button, MIDI Controller 83) */
314     dimension_effect1depth = 0x5b, /**< Effect 1 Depth (MIDI Controller 91) */
315     dimension_effect2depth = 0x5c, /**< Effect 2 Depth (MIDI Controller 92) */
316     dimension_effect3depth = 0x5d, /**< Effect 3 Depth (MIDI Controller 93) */
317     dimension_effect4depth = 0x5e, /**< Effect 4 Depth (MIDI Controller 94) */
318     dimension_effect5depth = 0x5f /**< Effect 5 Depth (MIDI Controller 95) */
319 schoenebeck 3169 );
320 schoenebeck 2
321     /**
322     * Intended for internal usage: will be used to convert a dimension value
323     * into the corresponding dimension bit number.
324 schoenebeck 3169 *
325 schoenebeck 3181 * @see enumCount(), enumKey(), enumKeys(), enumValue()
326 schoenebeck 2 */
327 schoenebeck 3169 GIG_DECLARE_ENUM(split_type_t,
328 schoenebeck 3398 split_type_normal, /**< dimension value between 0-127 */
329     split_type_bit /**< dimension values are already the sought bit number */
330 schoenebeck 3169 );
331 schoenebeck 2
332     /** General dimension definition. */
333     struct dimension_def_t {
334     dimension_t dimension; ///< Specifies which source (usually a MIDI controller) is associated with the dimension.
335     uint8_t bits; ///< Number of "bits" (1 bit = 2 splits/zones, 2 bit = 4 splits/zones, 3 bit = 8 splits/zones,...).
336     uint8_t zones; ///< Number of zones the dimension has.
337     split_type_t split_type; ///< Intended for internal usage: will be used to convert a dimension value into the corresponding dimension bit number.
338 persson 774 float zone_size; ///< Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only, 0 otherwise.
339 schoenebeck 2 };
340    
341 schoenebeck 3169 /** Defines which frequencies are filtered by the VCF.
342     *
343 schoenebeck 3181 * @see enumCount(), enumKey(), enumKeys(), enumValue()
344 schoenebeck 3169 */
345     GIG_DECLARE_ENUM(vcf_type_t,
346 schoenebeck 3398 vcf_type_lowpass = 0x00, /**< Standard lowpass filter type. */
347     vcf_type_lowpassturbo = 0xff, /**< More poles than normal lowpass. */
348     vcf_type_bandpass = 0x01, /**< Bandpass filter type. */
349     vcf_type_highpass = 0x02, /**< Highpass filter type. */
350 schoenebeck 3399 vcf_type_bandreject = 0x03 /**< Band reject filter type. */
351 schoenebeck 3169 );
352 schoenebeck 2
353 schoenebeck 345 /**
354     * Defines the envelope of a crossfade.
355     *
356     * Note: The default value for crossfade points is 0,0,0,0. Layers with
357     * such a default value should be treated as if they would not have a
358 schoenebeck 353 * crossfade.
359 schoenebeck 345 */
360 schoenebeck 2 struct crossfade_t {
361     #if WORDS_BIGENDIAN
362 schoenebeck 345 uint8_t out_end; ///< End postition of fade out.
363     uint8_t out_start; ///< Start position of fade out.
364     uint8_t in_end; ///< End position of fade in.
365 schoenebeck 2 uint8_t in_start; ///< Start position of fade in.
366 schoenebeck 345 #else // little endian
367     uint8_t in_start; ///< Start position of fade in.
368 schoenebeck 2 uint8_t in_end; ///< End position of fade in.
369     uint8_t out_start; ///< Start position of fade out.
370     uint8_t out_end; ///< End postition of fade out.
371     #endif // WORDS_BIGENDIAN
372 schoenebeck 3138
373     void serialize(Serialization::Archive* archive);
374 schoenebeck 2 };
375    
376 schoenebeck 24 /** Reflects the current playback state for a sample. */
377     struct playback_state_t {
378 schoenebeck 2912 file_offset_t position; ///< Current position within the sample.
379 schoenebeck 24 bool reverse; ///< If playback direction is currently backwards (in case there is a pingpong or reverse loop defined).
380 schoenebeck 2912 file_offset_t loop_cycles_left; ///< How many times the loop has still to be passed, this value will be decremented with each loop cycle.
381 schoenebeck 24 };
382    
383 schoenebeck 3323 /**
384 schoenebeck 3324 * Defines behavior options for envelope generators (gig format extension).
385 schoenebeck 3323 *
386     * These options allow to override the precise default behavior of the
387     * envelope generators' state machines.
388     *
389     * @b Note: These EG options are an extension to the original gig file
390     * format, so these options are not available with the original
391     * Gigasampler/GigaStudio software! Currently only LinuxSampler and gigedit
392     * support these EG options!
393     *
394     * Adding these options to the original gig file format was necessary,
395     * because the precise state machine behavior of envelope generators of the
396     * gig format (and thus the default EG behavior if not explicitly overridden
397     * here) deviates from common, expected behavior of envelope generators in
398     * general, if i.e. compared with EGs of hardware synthesizers. For example
399     * with the gig format, the attack and decay stages will be aborted as soon
400     * as a note-off is received. Most other EG implementations in the industry
401     * however always run the attack and decay stages to their full duration,
402     * even if an early note-off arrives. The latter behavior is intentionally
403     * implemented in most other products, because it is required to resemble
404     * percussive sounds in a realistic manner.
405     */
406     struct eg_opt_t {
407     bool AttackCancel; ///< Whether the "attack" stage is cancelled when receiving a note-off (default: @c true).
408     bool AttackHoldCancel; ///< Whether the "attack hold" stage is cancelled when receiving a note-off (default: @c true).
409 schoenebeck 3324 bool Decay1Cancel; ///< Whether the "decay 1" stage is cancelled when receiving a note-off (default: @c true).
410     bool Decay2Cancel; ///< Whether the "decay 2" stage is cancelled when receiving a note-off (default: @c true).
411 schoenebeck 3323 bool ReleaseCancel; ///< Whether the "release" stage is cancelled when receiving a note-on (default: @c true).
412    
413     eg_opt_t();
414     void serialize(Serialization::Archive* archive);
415     };
416    
417 schoenebeck 3442 /** @brief Defines behaviour of release triggered sample(s) on sustain pedal up event.
418     *
419     * This option defines whether a sustain pedal up event (CC#64) would cause
420     * release triggered samples to be played (if any).
421     *
422     * @b Note: This option is an extension to the original gig file format,
423     * so this option is not available with the original Gigasampler/GigaStudio
424     * software! Currently only LinuxSampler and gigedit support this option!
425     *
426     * By default (which equals the original Gigasampler/GigaStudio behaviour)
427     * no release triggered samples are played if the sustain pedal is released.
428     * So usually in the gig format release triggered samples are only played
429     * on MIDI note-off events.
430     *
431     * @see enumCount(), enumKey(), enumKeys(), enumValue()
432     */
433     GIG_DECLARE_ENUM(sust_rel_trg_t,
434     sust_rel_trg_none = 0x00, /**< No release triggered sample(s) are played on sustain pedal up (default). */
435     sust_rel_trg_maxvelocity = 0x01, /**< Play release trigger sample(s) on sustain pedal up, and simply use 127 as MIDI velocity for playback. */
436 schoenebeck 3443 sust_rel_trg_keyvelocity = 0x02 /**< Play release trigger sample(s) on sustain pedal up, and use the key's last MIDI note-on velocity for playback. */
437 schoenebeck 3442 );
438    
439 schoenebeck 2 // just symbol prototyping
440     class File;
441     class Instrument;
442     class Sample;
443 capela 310 class Region;
444 schoenebeck 929 class Group;
445 schoenebeck 2584 class Script;
446     class ScriptGroup;
447 schoenebeck 2
448 schoenebeck 2699 /** @brief Encapsulates articulation informations of a dimension region.
449 schoenebeck 2 *
450 schoenebeck 2699 * This is the most important data object of the Gigasampler / GigaStudio
451     * format. A DimensionRegion provides the link to the sample to be played
452     * and all required articulation informations to be interpreted for playing
453     * back the sample and processing it appropriately by the sampler software.
454     * Every Region of a Gigasampler Instrument has at least one dimension
455     * region (exactly then when the Region has no dimension defined). Many
456     * Regions though provide more than one DimensionRegion, which reflect
457     * different playing "cases". For example a different sample might be played
458     * if a certain pedal is pressed down, or if the note was triggered with
459     * different velocity.
460 schoenebeck 2 *
461 schoenebeck 2699 * One instance of a DimensionRegion reflects exactly one particular case
462     * while playing an instrument (for instance "note between C3 and E3 was
463     * triggered AND note on velocity was between 20 and 42 AND modulation wheel
464     * controller is between 80 and 127). The DimensionRegion defines what to do
465     * under that one particular case, that is which sample to play back and how
466     * to play that sample back exactly and how to process it. So a
467     * DimensionRegion object is always linked to exactly one sample. It may
468     * however also link to no sample at all, for defining a "silence" case
469     * where nothing shall be played (for example when note on velocity was
470     * below 6).
471 schoenebeck 2 *
472 schoenebeck 2699 * Note that a DimensionRegion object only defines "what to do", but it does
473     * not define "when to do it". To actually resolve which DimensionRegion to
474     * pick under which situation, you need to refer to the DimensionRegions'
475     * parent Region object. The Region object contains the necessary
476     * "Dimension" definitions, which in turn define which DimensionRegion is
477     * associated with which playing case exactly.
478     *
479     * The Gigasampler/GigaStudio format defines 3 Envelope Generators and 3
480     * Low Frequency Oscillators:
481     *
482 schoenebeck 2 * - EG1 and LFO1, both controlling sample amplitude
483     * - EG2 and LFO2, both controlling filter cutoff frequency
484     * - EG3 and LFO3, both controlling sample pitch
485 schoenebeck 2699 *
486     * Since the gig format was designed as extension to the DLS file format,
487     * this class is derived from the DLS::Sampler class. So also refer to
488     * DLS::Sampler for additional informations, class attributes and methods.
489 schoenebeck 2 */
490     class DimensionRegion : protected DLS::Sampler {
491     public:
492 schoenebeck 2543 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). Only for gig2, for gig3 and above the DimensionUpperLimits are used instead.
493 schoenebeck 2 Sample* pSample; ///< Points to the Sample which is assigned to the dimension region.
494     // Sample Amplitude EG/LFO
495     uint16_t EG1PreAttack; ///< Preattack value of the sample amplitude EG (0 - 1000 permille).
496     double EG1Attack; ///< Attack time of the sample amplitude EG (0.000 - 60.000s).
497     double EG1Decay1; ///< Decay time of the sample amplitude EG (0.000 - 60.000s).
498     double EG1Decay2; ///< Only if <i>EG1InfiniteSustain == false</i>: 2nd decay stage time of the sample amplitude EG (0.000 - 60.000s).
499     bool EG1InfiniteSustain; ///< If <i>true</i>, instead of going into Decay2 phase, Decay1 level will be hold until note will be released.
500     uint16_t EG1Sustain; ///< Sustain value of the sample amplitude EG (0 - 1000 permille).
501     double EG1Release; ///< Release time of the sample amplitude EG (0.000 - 60.000s).
502     bool EG1Hold; ///< If <i>true</i>, Decay1 stage should be postponed until the sample reached the sample loop start.
503     eg1_ctrl_t EG1Controller; ///< MIDI Controller which has influence on sample amplitude EG parameters (attack, decay, release).
504     bool EG1ControllerInvert; ///< Invert values coming from defined EG1 controller.
505 schoenebeck 36 uint8_t EG1ControllerAttackInfluence; ///< Amount EG1 Controller has influence on the EG1 Attack time (0 - 3, where 0 means off).
506     uint8_t EG1ControllerDecayInfluence; ///< Amount EG1 Controller has influence on the EG1 Decay time (0 - 3, where 0 means off).
507     uint8_t EG1ControllerReleaseInfluence; ///< Amount EG1 Controller has influence on the EG1 Release time (0 - 3, where 0 means off).
508 schoenebeck 2 double LFO1Frequency; ///< Frequency of the sample amplitude LFO (0.10 - 10.00 Hz).
509     uint16_t LFO1InternalDepth; ///< Firm pitch of the sample amplitude LFO (0 - 1200 cents).
510     uint16_t LFO1ControlDepth; ///< Controller depth influencing sample amplitude LFO pitch (0 - 1200 cents).
511     lfo1_ctrl_t LFO1Controller; ///< MIDI Controller which controls sample amplitude LFO.
512     bool LFO1FlipPhase; ///< Inverts phase of the sample amplitude LFO wave.
513     bool LFO1Sync; ///< If set to <i>true</i> only one LFO should be used for all voices.
514     // Filter Cutoff Frequency EG/LFO
515     uint16_t EG2PreAttack; ///< Preattack value of the filter cutoff EG (0 - 1000 permille).
516     double EG2Attack; ///< Attack time of the filter cutoff EG (0.000 - 60.000s).
517     double EG2Decay1; ///< Decay time of the filter cutoff EG (0.000 - 60.000s).
518     double EG2Decay2; ///< Only if <i>EG2InfiniteSustain == false</i>: 2nd stage decay time of the filter cutoff EG (0.000 - 60.000s).
519     bool EG2InfiniteSustain; ///< If <i>true</i>, instead of going into Decay2 phase, Decay1 level will be hold until note will be released.
520     uint16_t EG2Sustain; ///< Sustain value of the filter cutoff EG (0 - 1000 permille).
521     double EG2Release; ///< Release time of the filter cutoff EG (0.000 - 60.000s).
522     eg2_ctrl_t EG2Controller; ///< MIDI Controller which has influence on filter cutoff EG parameters (attack, decay, release).
523     bool EG2ControllerInvert; ///< Invert values coming from defined EG2 controller.
524 schoenebeck 36 uint8_t EG2ControllerAttackInfluence; ///< Amount EG2 Controller has influence on the EG2 Attack time (0 - 3, where 0 means off).
525     uint8_t EG2ControllerDecayInfluence; ///< Amount EG2 Controller has influence on the EG2 Decay time (0 - 3, where 0 means off).
526     uint8_t EG2ControllerReleaseInfluence; ///< Amount EG2 Controller has influence on the EG2 Release time (0 - 3, where 0 means off).
527 schoenebeck 2 double LFO2Frequency; ///< Frequency of the filter cutoff LFO (0.10 - 10.00 Hz).
528     uint16_t LFO2InternalDepth; ///< Firm pitch of the filter cutoff LFO (0 - 1200 cents).
529     uint16_t LFO2ControlDepth; ///< Controller depth influencing filter cutoff LFO pitch (0 - 1200).
530     lfo2_ctrl_t LFO2Controller; ///< MIDI Controlle which controls the filter cutoff LFO.
531     bool LFO2FlipPhase; ///< Inverts phase of the filter cutoff LFO wave.
532     bool LFO2Sync; ///< If set to <i>true</i> only one LFO should be used for all voices.
533     // Sample Pitch EG/LFO
534     double EG3Attack; ///< Attack time of the sample pitch EG (0.000 - 10.000s).
535     int16_t EG3Depth; ///< Depth of the sample pitch EG (-1200 - +1200).
536     double LFO3Frequency; ///< Frequency of the sample pitch LFO (0.10 - 10.00 Hz).
537     int16_t LFO3InternalDepth; ///< Firm depth of the sample pitch LFO (-1200 - +1200 cents).
538     int16_t LFO3ControlDepth; ///< Controller depth of the sample pitch LFO (-1200 - +1200 cents).
539     lfo3_ctrl_t LFO3Controller; ///< MIDI Controller which controls the sample pitch LFO.
540     bool LFO3Sync; ///< If set to <i>true</i> only one LFO should be used for all voices.
541     // Filter
542     bool VCFEnabled; ///< If filter should be used.
543     vcf_type_t VCFType; ///< Defines the general filter characteristic (lowpass, highpass, bandpass, etc.).
544 schoenebeck 1358 vcf_cutoff_ctrl_t VCFCutoffController; ///< Specifies which external controller has influence on the filter cutoff frequency. @deprecated Don't alter directly, use SetVCFCutoffController() instead!
545 persson 728 bool VCFCutoffControllerInvert; ///< Inverts values coming from the defined cutoff controller
546 schoenebeck 2 uint8_t VCFCutoff; ///< Max. cutoff frequency.
547 schoenebeck 1358 curve_type_t VCFVelocityCurve; ///< Defines a transformation curve for the incoming velocity values, affecting the VCF. @deprecated Don't alter directly, use SetVCFVelocityCurve() instead!
548     uint8_t VCFVelocityScale; ///< (0-127) Amount velocity controls VCF cutoff frequency (only if no other VCF cutoff controller is defined, otherwise this is the minimum cutoff). @deprecated Don't alter directly, use SetVCFVelocityScale() instead!
549     uint8_t VCFVelocityDynamicRange; ///< 0x04 = lowest, 0x00 = highest . @deprecated Don't alter directly, use SetVCFVelocityDynamicRange() instead!
550 schoenebeck 2 uint8_t VCFResonance; ///< Firm internal filter resonance weight.
551     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).
552     vcf_res_ctrl_t VCFResonanceController; ///< Specifies which external controller has influence on the filter resonance Q.
553     bool VCFKeyboardTracking; ///< If <i>true</i>: VCF cutoff frequence will be dependend to the note key position relative to the defined breakpoint value.
554     uint8_t VCFKeyboardTrackingBreakpoint; ///< See VCFKeyboardTracking (0 - 127).
555     // Key Velocity Transformations
556 schoenebeck 1358 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). @deprecated Don't alter directly, use SetVelocityResponseCurve() instead!
557     uint8_t VelocityResponseDepth; ///< Dynamic range of velocity affecting amplitude (0 - 4) (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead). @deprecated Don't alter directly, use SetVelocityResponseDepth() instead!
558     uint8_t VelocityResponseCurveScaling; ///< 0 - 127 (usually you don't have to interpret this parameter, use GetVelocityAttenuation() instead). @deprecated Don't alter directly, use SetVelocityResponseCurveScaling() instead!
559     curve_type_t ReleaseVelocityResponseCurve; ///< Defines a transformation curve to the incoming release veloctiy values affecting envelope times. @deprecated Don't alter directly, use SetReleaseVelocityResponseCurve() instead!
560     uint8_t ReleaseVelocityResponseDepth; ///< Dynamic range of release velocity affecting envelope time (0 - 4). @deprecated Don't alter directly, use SetReleaseVelocityResponseDepth() instead!
561 schoenebeck 2 uint8_t ReleaseTriggerDecay; ///< 0 - 8
562     // Mix / Layer
563     crossfade_t Crossfade;
564     bool PitchTrack; ///< If <i>true</i>: sample will be pitched according to the key position (this will be disabled for drums for example).
565     dim_bypass_ctrl_t DimensionBypass; ///< If defined, the MIDI controller can switch on/off the dimension in realtime.
566     int8_t Pan; ///< Panorama / Balance (-64..0..63 <-> left..middle..right)
567     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.
568 schoenebeck 36 attenuation_ctrl_t AttenuationController; ///< MIDI Controller which has influence on the volume level of the sample (or entire sample group).
569     bool InvertAttenuationController; ///< Inverts the values coming from the defined Attenuation Controller.
570     uint8_t AttenuationControllerThreshold;///< 0-127
571 schoenebeck 2 uint8_t ChannelOffset; ///< Audio output where the audio signal of the dimension region should be routed to (0 - 9).
572     bool SustainDefeat; ///< If <i>true</i>: Sustain pedal will not hold a note.
573     bool MSDecode; ///< Gigastudio flag: defines if Mid Side Recordings should be decoded.
574     uint16_t SampleStartOffset; ///< Number of samples the sample start should be moved (0 - 2000).
575 persson 406 double SampleAttenuation; ///< Sample volume (calculated from DLS::Sampler::Gain)
576 schoenebeck 2547 uint8_t DimensionUpperLimits[8]; ///< gig3: defines the upper limit of the dimension values for this dimension region. In case you wondered why this is defined on DimensionRegion level and not on Region level: the zone sizes (upper limits) of the velocity dimension can indeed differ in the individual dimension regions, depending on which zones of the other dimension types are currently selected. So this is exceptional for the velocity dimension only. All other dimension types have the same dimension zone sizes for every single DimensionRegion (of the sample Region).
577 schoenebeck 3327 eg_opt_t EG1Options; ///< [gig extension]: Behavior options which should be used for envelope generator 1 (volume amplitude EG).
578     eg_opt_t EG2Options; ///< [gig extension]: Behavior options which should be used for envelope generator 2 (filter cutoff EG).
579 schoenebeck 3442 sust_rel_trg_t SustainReleaseTrigger; ///< [gig extension]: Whether a sustain pedal up event shall play release trigger sample.
580 schoenebeck 3446 bool NoNoteOffReleaseTrigger; ///< [gig extension]: If @c true then don't play a release trigger sample on MIDI note-off events.
581 persson 406
582 schoenebeck 2 // derived attributes from DLS::Sampler
583 persson 2334 using DLS::Sampler::UnityNote;
584     using DLS::Sampler::FineTune;
585     using DLS::Sampler::Gain;
586     using DLS::Sampler::SampleLoops;
587     using DLS::Sampler::pSampleLoops;
588 schoenebeck 2
589 schoenebeck 809 // own methods
590 schoenebeck 16 double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
591 persson 613 double GetVelocityRelease(uint8_t MIDIKeyVelocity);
592 persson 728 double GetVelocityCutoff(uint8_t MIDIKeyVelocity);
593 schoenebeck 1358 void SetVelocityResponseCurve(curve_type_t curve);
594     void SetVelocityResponseDepth(uint8_t depth);
595     void SetVelocityResponseCurveScaling(uint8_t scaling);
596     void SetReleaseVelocityResponseCurve(curve_type_t curve);
597     void SetReleaseVelocityResponseDepth(uint8_t depth);
598     void SetVCFCutoffController(vcf_cutoff_ctrl_t controller);
599     void SetVCFVelocityCurve(curve_type_t curve);
600     void SetVCFVelocityDynamicRange(uint8_t range);
601     void SetVCFVelocityScale(uint8_t scaling);
602 schoenebeck 1316 Region* GetParent() const;
603 schoenebeck 1155 // derived methods
604 persson 2334 using DLS::Sampler::AddSampleLoop;
605     using DLS::Sampler::DeleteSampleLoop;
606 schoenebeck 809 // overridden methods
607 schoenebeck 1358 virtual void SetGain(int32_t gain);
608 schoenebeck 2682 virtual void UpdateChunks(progress_t* pProgress);
609 schoenebeck 2394 virtual void CopyAssign(const DimensionRegion* orig);
610 schoenebeck 16 protected:
611 persson 858 uint8_t* VelocityTable; ///< For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number.
612 schoenebeck 1316 DimensionRegion(Region* pParent, RIFF::List* _3ewl);
613 persson 1301 DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);
614 schoenebeck 16 ~DimensionRegion();
615 schoenebeck 2482 void CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples);
616 schoenebeck 3138 void serialize(Serialization::Archive* archive);
617 schoenebeck 16 friend class Region;
618 schoenebeck 3138 friend class Serialization::Archive;
619 schoenebeck 16 private:
620 schoenebeck 36 typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller
621 schoenebeck 2540 // official leverage controllers as they were defined in the original Gigasampler/GigaStudio format:
622 schoenebeck 36 _lev_ctrl_none = 0x00,
623     _lev_ctrl_modwheel = 0x03, ///< Modulation Wheel (MIDI Controller 1)
624     _lev_ctrl_breath = 0x05, ///< Breath Controller (Coarse, MIDI Controller 2)
625     _lev_ctrl_foot = 0x07, ///< Foot Pedal (Coarse, MIDI Controller 4)
626     _lev_ctrl_effect1 = 0x0d, ///< Effect Controller 1 (Coarse, MIDI Controller 12)
627     _lev_ctrl_effect2 = 0x0f, ///< Effect Controller 2 (Coarse, MIDI Controller 13)
628     _lev_ctrl_genpurpose1 = 0x11, ///< General Purpose Controller 1 (Slider, MIDI Controller 16)
629     _lev_ctrl_genpurpose2 = 0x13, ///< General Purpose Controller 2 (Slider, MIDI Controller 17)
630     _lev_ctrl_genpurpose3 = 0x15, ///< General Purpose Controller 3 (Slider, MIDI Controller 18)
631     _lev_ctrl_genpurpose4 = 0x17, ///< General Purpose Controller 4 (Slider, MIDI Controller 19)
632     _lev_ctrl_portamentotime = 0x0b, ///< Portamento Time (Coarse, MIDI Controller 5)
633     _lev_ctrl_sustainpedal = 0x01, ///< Sustain Pedal (MIDI Controller 64)
634     _lev_ctrl_portamento = 0x19, ///< Portamento (MIDI Controller 65)
635     _lev_ctrl_sostenutopedal = 0x1b, ///< Sostenuto Pedal (MIDI Controller 66)
636     _lev_ctrl_softpedal = 0x09, ///< Soft Pedal (MIDI Controller 67)
637     _lev_ctrl_genpurpose5 = 0x1d, ///< General Purpose Controller 5 (Button, MIDI Controller 80)
638     _lev_ctrl_genpurpose6 = 0x1f, ///< General Purpose Controller 6 (Button, MIDI Controller 81)
639     _lev_ctrl_genpurpose7 = 0x21, ///< General Purpose Controller 7 (Button, MIDI Controller 82)
640     _lev_ctrl_genpurpose8 = 0x23, ///< General Purpose Controller 8 (Button, MIDI Controller 83)
641     _lev_ctrl_effect1depth = 0x25, ///< Effect 1 Depth (MIDI Controller 91)
642     _lev_ctrl_effect2depth = 0x27, ///< Effect 2 Depth (MIDI Controller 92)
643     _lev_ctrl_effect3depth = 0x29, ///< Effect 3 Depth (MIDI Controller 93)
644     _lev_ctrl_effect4depth = 0x2b, ///< Effect 4 Depth (MIDI Controller 94)
645     _lev_ctrl_effect5depth = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)
646     _lev_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure
647 schoenebeck 2540 _lev_ctrl_velocity = 0xff, ///< Key Velocity
648    
649     // format extension (these controllers are so far only supported by LinuxSampler & gigedit) they will *NOT* work with Gigasampler/GigaStudio !
650     // (the assigned values here are their official MIDI CC number plus the highest bit set):
651     _lev_ctrl_CC3_EXT = 0x83, ///< MIDI Controller 3 [gig format extension]
652    
653     _lev_ctrl_CC6_EXT = 0x86, ///< Data Entry MSB (MIDI Controller 6) [gig format extension]
654     _lev_ctrl_CC7_EXT = 0x87, ///< Channel Volume (MIDI Controller 7) [gig format extension]
655     _lev_ctrl_CC8_EXT = 0x88, ///< Balance (MIDI Controller 8) [gig format extension]
656     _lev_ctrl_CC9_EXT = 0x89, ///< MIDI Controller 9 [gig format extension]
657     _lev_ctrl_CC10_EXT = 0x8a, ///< Pan (MIDI Controller 10) [gig format extension]
658     _lev_ctrl_CC11_EXT = 0x8b, ///< Expression Controller (MIDI Controller 11) [gig format extension]
659    
660     _lev_ctrl_CC14_EXT = 0x8e, ///< MIDI Controller 14 [gig format extension]
661     _lev_ctrl_CC15_EXT = 0x8f, ///< MIDI Controller 15 [gig format extension]
662    
663     _lev_ctrl_CC20_EXT = 0x94, ///< MIDI Controller 20 [gig format extension]
664     _lev_ctrl_CC21_EXT = 0x95, ///< MIDI Controller 21 [gig format extension]
665     _lev_ctrl_CC22_EXT = 0x96, ///< MIDI Controller 22 [gig format extension]
666     _lev_ctrl_CC23_EXT = 0x97, ///< MIDI Controller 23 [gig format extension]
667     _lev_ctrl_CC24_EXT = 0x98, ///< MIDI Controller 24 [gig format extension]
668     _lev_ctrl_CC25_EXT = 0x99, ///< MIDI Controller 25 [gig format extension]
669     _lev_ctrl_CC26_EXT = 0x9a, ///< MIDI Controller 26 [gig format extension]
670     _lev_ctrl_CC27_EXT = 0x9b, ///< MIDI Controller 27 [gig format extension]
671     _lev_ctrl_CC28_EXT = 0x9c, ///< MIDI Controller 28 [gig format extension]
672     _lev_ctrl_CC29_EXT = 0x9d, ///< MIDI Controller 29 [gig format extension]
673     _lev_ctrl_CC30_EXT = 0x9e, ///< MIDI Controller 30 [gig format extension]
674     _lev_ctrl_CC31_EXT = 0x9f, ///< MIDI Controller 31 [gig format extension]
675    
676     _lev_ctrl_CC68_EXT = 0xc4, ///< Legato Footswitch (MIDI Controller 68) [gig format extension]
677     _lev_ctrl_CC69_EXT = 0xc5, ///< Hold 2 (MIDI Controller 69) [gig format extension]
678     _lev_ctrl_CC70_EXT = 0xc6, ///< Sound Ctrl. 1 - Sound Variation (MIDI Controller 70) [gig format extension]
679     _lev_ctrl_CC71_EXT = 0xc7, ///< Sound Ctrl. 2 - Timbre (MIDI Controller 71) [gig format extension]
680     _lev_ctrl_CC72_EXT = 0xc8, ///< Sound Ctrl. 3 - Release Time (MIDI Controller 72) [gig format extension]
681     _lev_ctrl_CC73_EXT = 0xc9, ///< Sound Ctrl. 4 - Attack Time (MIDI Controller 73) [gig format extension]
682     _lev_ctrl_CC74_EXT = 0xca, ///< Sound Ctrl. 5 - Brightness (MIDI Controller 74) [gig format extension]
683     _lev_ctrl_CC75_EXT = 0xcb, ///< Sound Ctrl. 6 - Decay Time (MIDI Controller 75) [gig format extension]
684     _lev_ctrl_CC76_EXT = 0xcc, ///< Sound Ctrl. 7 - Vibrato Rate (MIDI Controller 76) [gig format extension]
685     _lev_ctrl_CC77_EXT = 0xcd, ///< Sound Ctrl. 8 - Vibrato Depth (MIDI Controller 77) [gig format extension]
686     _lev_ctrl_CC78_EXT = 0xce, ///< Sound Ctrl. 9 - Vibrato Delay (MIDI Controller 78) [gig format extension]
687     _lev_ctrl_CC79_EXT = 0xcf, ///< Sound Ctrl. 10 (MIDI Controller 79) [gig format extension]
688    
689     _lev_ctrl_CC84_EXT = 0xd4, ///< Portamento Control (MIDI Controller 84) [gig format extension]
690     _lev_ctrl_CC85_EXT = 0xd5, ///< MIDI Controller 85 [gig format extension]
691     _lev_ctrl_CC86_EXT = 0xd6, ///< MIDI Controller 86 [gig format extension]
692     _lev_ctrl_CC87_EXT = 0xd7, ///< MIDI Controller 87 [gig format extension]
693    
694     _lev_ctrl_CC89_EXT = 0xd9, ///< MIDI Controller 89 [gig format extension]
695     _lev_ctrl_CC90_EXT = 0xda, ///< MIDI Controller 90 [gig format extension]
696    
697     _lev_ctrl_CC96_EXT = 0xe0, ///< Data Increment (MIDI Controller 96) [gig format extension]
698     _lev_ctrl_CC97_EXT = 0xe1, ///< Data Decrement (MIDI Controller 97) [gig format extension]
699    
700     _lev_ctrl_CC102_EXT = 0xe6, ///< MIDI Controller 102 [gig format extension]
701     _lev_ctrl_CC103_EXT = 0xe7, ///< MIDI Controller 103 [gig format extension]
702     _lev_ctrl_CC104_EXT = 0xe8, ///< MIDI Controller 104 [gig format extension]
703     _lev_ctrl_CC105_EXT = 0xe9, ///< MIDI Controller 105 [gig format extension]
704     _lev_ctrl_CC106_EXT = 0xea, ///< MIDI Controller 106 [gig format extension]
705     _lev_ctrl_CC107_EXT = 0xeb, ///< MIDI Controller 107 [gig format extension]
706     _lev_ctrl_CC108_EXT = 0xec, ///< MIDI Controller 108 [gig format extension]
707     _lev_ctrl_CC109_EXT = 0xed, ///< MIDI Controller 109 [gig format extension]
708     _lev_ctrl_CC110_EXT = 0xee, ///< MIDI Controller 110 [gig format extension]
709     _lev_ctrl_CC111_EXT = 0xef, ///< MIDI Controller 111 [gig format extension]
710     _lev_ctrl_CC112_EXT = 0xf0, ///< MIDI Controller 112 [gig format extension]
711     _lev_ctrl_CC113_EXT = 0xf1, ///< MIDI Controller 113 [gig format extension]
712     _lev_ctrl_CC114_EXT = 0xf2, ///< MIDI Controller 114 [gig format extension]
713     _lev_ctrl_CC115_EXT = 0xf3, ///< MIDI Controller 115 [gig format extension]
714     _lev_ctrl_CC116_EXT = 0xf4, ///< MIDI Controller 116 [gig format extension]
715     _lev_ctrl_CC117_EXT = 0xf5, ///< MIDI Controller 117 [gig format extension]
716     _lev_ctrl_CC118_EXT = 0xf6, ///< MIDI Controller 118 [gig format extension]
717     _lev_ctrl_CC119_EXT = 0xf7 ///< MIDI Controller 119 [gig format extension]
718 schoenebeck 55 } _lev_ctrl_t;
719 schoenebeck 16 typedef std::map<uint32_t, double*> VelocityTableMap;
720    
721 schoenebeck 2922 static size_t Instances; ///< Number of DimensionRegion instances.
722 schoenebeck 16 static VelocityTableMap* pVelocityTables; ///< Contains the tables corresponding to the various velocity parameters (VelocityResponseCurve and VelocityResponseDepth).
723     double* pVelocityAttenuationTable; ///< Points to the velocity table corresponding to the velocity parameters of this DimensionRegion.
724 persson 613 double* pVelocityReleaseTable; ///< Points to the velocity table corresponding to the release velocity parameters of this DimensionRegion
725 persson 728 double* pVelocityCutoffTable; ///< Points to the velocity table corresponding to the filter velocity parameters of this DimensionRegion
726 schoenebeck 1316 Region* pRegion;
727 schoenebeck 55
728 schoenebeck 36 leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
729 schoenebeck 809 _lev_ctrl_t EncodeLeverageController(leverage_ctrl_t DecodedController);
730 schoenebeck 1358 double* GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth);
731     double* GetCutoffVelocityTable(curve_type_t vcfVelocityCurve, uint8_t vcfVelocityDynamicRange, uint8_t vcfVelocityScale, vcf_cutoff_ctrl_t vcfCutoffController);
732 persson 613 double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
733 schoenebeck 308 double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
734 schoenebeck 2 };
735    
736 schoenebeck 2699 /** @brief Encapsulates sample waves of Gigasampler/GigaStudio files used for playback.
737 schoenebeck 809 *
738 schoenebeck 2699 * This class provides access to the actual audio sample data of a
739     * Gigasampler/GigaStudio file. Along to the actual sample data, it also
740     * provides access to the sample's meta informations like bit depth,
741     * sample rate, encoding type, but also loop informations. The latter may be
742     * used by instruments for resembling sounds with arbitary note lengths.
743     *
744 schoenebeck 809 * In case you created a new sample with File::AddSample(), you should
745     * first update all attributes with the desired meta informations
746     * (amount of channels, bit depth, sample rate, etc.), then call
747     * Resize() with the desired sample size, followed by File::Save(), this
748     * will create the mandatory RIFF chunk which will hold the sample wave
749     * data and / or resize the file so you will be able to Write() the
750     * sample data directly to disk.
751 schoenebeck 1154 *
752     * @e Caution: for gig synthesis, most looping relevant information are
753     * retrieved from the respective DimensionRegon instead from the Sample
754     * itself. This was made for allowing different loop definitions for the
755     * same sample under different conditions.
756 schoenebeck 2699 *
757     * Since the gig format was designed as extension to the DLS file format,
758     * this class is derived from the DLS::Sample class. So also refer to
759     * DLS::Sample for additional informations, class attributes and methods.
760 schoenebeck 809 */
761 schoenebeck 2 class Sample : public DLS::Sample {
762     public:
763     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.
764     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.
765 schoenebeck 809 uint32_t SamplePeriod; ///< Specifies the duration of time that passes during the playback of one sample in nanoseconds (normally equal to 1 / Samples Per Second, where Samples Per Second is the value found in the format chunk), don't bother to update this attribute, it won't be saved.
766 schoenebeck 2 uint32_t MIDIUnityNote; ///< Specifies the musical note at which the sample will be played at it's original sample rate.
767 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.
768 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.
769     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).
770 schoenebeck 1154 uint32_t Loops; ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: Number of defined sample loops. So far only seen single loops in gig files - please report if you encounter more!)
771 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.
772 schoenebeck 1154 loop_type_t LoopType; ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The type field defines how the waveform samples will be looped.)
773     uint32_t LoopStart; ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: 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].)
774     uint32_t LoopEnd; ///< @e Caution: Use the respective field in the DimensionRegion instead of this one! (Intended purpose: The end value specifies the offset [in sample points] in the waveform data which represents the end of the loop [only if Loops > 0].)
775     uint32_t LoopSize; ///< @e Caution: Use the respective fields in the DimensionRegion instead of this one! (Intended purpose: Length of the looping area [in sample points] which is equivalent to @code LoopEnd - LoopStart @endcode.)
776     uint32_t LoopFraction; ///< The fractional value specifies a fraction of a sample at which to loop. 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.
777     uint32_t LoopPlayCount; ///< Number of times the loop should be played (a value of 0 = infinite).
778 schoenebeck 2 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).
779 persson 437 uint32_t TruncatedBits; ///< For 24-bit compressed samples only: number of bits truncated during compression (0, 4 or 6)
780     bool Dithered; ///< For 24-bit compressed samples only: if dithering was used during compression with bit reduction
781 schoenebeck 2
782     // own methods
783     buffer_t LoadSampleData();
784 schoenebeck 2912 buffer_t LoadSampleData(file_offset_t SampleCount);
785 schoenebeck 2 buffer_t LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
786 schoenebeck 2912 buffer_t LoadSampleDataWithNullSamplesExtension(file_offset_t SampleCount, uint NullSamplesCount);
787 schoenebeck 2 buffer_t GetCache();
788 schoenebeck 384 // own static methods
789 schoenebeck 2912 static buffer_t CreateDecompressionBuffer(file_offset_t MaxReadSize);
790 schoenebeck 384 static void DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
791 schoenebeck 2 // overridden methods
792     void ReleaseSampleData();
793 schoenebeck 2922 void Resize(file_offset_t NewSize);
794 schoenebeck 2912 file_offset_t SetPos(file_offset_t SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
795     file_offset_t GetPos() const;
796     file_offset_t Read(void* pBuffer, file_offset_t SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
797     file_offset_t ReadAndLoop(void* pBuffer, file_offset_t SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL);
798     file_offset_t Write(void* pBuffer, file_offset_t SampleCount);
799 schoenebeck 930 Group* GetGroup() const;
800 schoenebeck 2682 virtual void UpdateChunks(progress_t* pProgress);
801 schoenebeck 2482 void CopyAssignMeta(const Sample* orig);
802     void CopyAssignWave(const Sample* orig);
803 schoenebeck 2989 uint32_t GetWaveDataCRC32Checksum();
804     bool VerifyWaveData(uint32_t* pActually = NULL);
805 schoenebeck 2 protected:
806 schoenebeck 2922 static size_t Instances; ///< Number of instances of class Sample.
807 schoenebeck 384 static buffer_t InternalDecompressionBuffer; ///< Buffer used for decompression as well as for truncation of 24 Bit -> 16 Bit samples.
808 schoenebeck 930 Group* pGroup; ///< pointer to the Group this sample belongs to (always not-NULL)
809 schoenebeck 2912 file_offset_t FrameOffset; ///< Current offset (sample points) in current sample frame (for decompression only).
810     file_offset_t* FrameTable; ///< For positioning within compressed samples only: stores the offset values for each frame.
811     file_offset_t SamplePos; ///< For compressed samples only: stores the current position (in sample points).
812     file_offset_t SamplesInLastFrame; ///< For compressed samples only: length of the last sample frame.
813     file_offset_t WorstCaseFrameSize; ///< For compressed samples only: size (in bytes) of the largest possible sample frame.
814     file_offset_t SamplesPerFrame; ///< For compressed samples only: number of samples in a full sample frame.
815 schoenebeck 2 buffer_t RAMCache; ///< Buffers samples (already uncompressed) in RAM.
816 persson 666 unsigned long FileNo; ///< File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)
817 schoenebeck 809 RIFF::Chunk* pCk3gix;
818     RIFF::Chunk* pCkSmpl;
819 schoenebeck 2989 uint32_t crc; ///< Reflects CRC-32 checksum of the raw sample data at the last time when the sample's raw wave form data has been modified consciously by the user by calling Write().
820 schoenebeck 2
821 schoenebeck 2989 Sample(File* pFile, RIFF::List* waveList, file_offset_t WavePoolOffset, unsigned long fileNo = 0, int index = -1);
822 schoenebeck 2 ~Sample();
823 schoenebeck 2985 uint32_t CalculateWaveDataChecksum();
824 persson 365
825     // Guess size (in bytes) of a compressed sample
826 schoenebeck 2912 inline file_offset_t GuessSize(file_offset_t samples) {
827 persson 365 // 16 bit: assume all frames are compressed - 1 byte
828     // per sample and 5 bytes header per 2048 samples
829    
830     // 24 bit: assume next best compression rate - 1.5
831     // bytes per sample and 13 bytes header per 256
832     // samples
833 schoenebeck 2912 const file_offset_t size =
834 persson 365 BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
835     : samples + (samples >> 10) * 5;
836     // Double for stereo and add one worst case sample
837     // frame
838     return (Channels == 2 ? size << 1 : size) + WorstCaseFrameSize;
839     }
840 schoenebeck 384
841     // Worst case amount of sample points that can be read with the
842     // given decompression buffer.
843 schoenebeck 2912 inline file_offset_t WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
844     return (file_offset_t) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
845 schoenebeck 384 }
846 schoenebeck 2 private:
847     void ScanCompressedSample();
848     friend class File;
849     friend class Region;
850 schoenebeck 930 friend class Group; // allow to modify protected member pGroup
851 schoenebeck 2 };
852    
853     // TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions)
854 schoenebeck 2699 /** @brief Defines Region information of a Gigasampler/GigaStudio instrument.
855 schoenebeck 2547 *
856 schoenebeck 2699 * A Region reflects a consecutive area (key range) on the keyboard. The
857     * individual regions in the gig format may not overlap with other regions
858     * (of the same instrument that is). Further, in the gig format a Region is
859     * merely a container for DimensionRegions (a.k.a. "Cases"). The Region
860     * itself does not provide the sample mapping or articulation informations
861     * used, even though the data structures of regions indeed provide such
862     * informations. The latter is however just of historical nature, because
863     * the gig file format was derived from the DLS file format.
864 schoenebeck 2547 *
865     * Each Region consists of at least one or more DimensionRegions. The actual
866     * amount of DimensionRegions depends on which kind of "dimensions" are
867     * defined for this region, and on the split / zone amount for each of those
868     * dimensions.
869 schoenebeck 2699 *
870     * Since the gig format was designed as extension to the DLS file format,
871     * this class is derived from the DLS::Region class. So also refer to
872     * DLS::Region for additional informations, class attributes and methods.
873 schoenebeck 2547 */
874 schoenebeck 2 class Region : public DLS::Region {
875     public:
876 schoenebeck 809 unsigned int Dimensions; ///< Number of defined dimensions, do not alter!
877 schoenebeck 926 dimension_def_t pDimensionDefinitions[8]; ///< Defines the five (gig2) or eight (gig3) possible dimensions (the dimension's controller and number of bits/splits). Use AddDimension() and DeleteDimension() to create a new dimension or delete an existing one.
878 schoenebeck 809 uint32_t DimensionRegions; ///< Total number of DimensionRegions this Region contains, do not alter!
879 schoenebeck 926 DimensionRegion* pDimensionRegions[256]; ///< Pointer array to the 32 (gig2) or 256 (gig3) 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). Use AddDimension() and DeleteDimension() to create a new dimension or delete an existing one (which will create or delete the respective dimension region(s) automatically).
880 schoenebeck 809 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. Do not alter this value!
881 schoenebeck 2
882 schoenebeck 1335 // own methods
883 schoenebeck 347 DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
884     DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
885 schoenebeck 2599 int GetDimensionRegionIndexByValue(const uint DimValues[8]);
886 schoenebeck 2 Sample* GetSample();
887 schoenebeck 809 void AddDimension(dimension_def_t* pDimDef);
888     void DeleteDimension(dimension_def_t* pDimDef);
889 schoenebeck 2547 dimension_def_t* GetDimensionDefinition(dimension_t type);
890 schoenebeck 2555 void DeleteDimensionZone(dimension_t type, int zone);
891     void SplitDimensionZone(dimension_t type, int zone);
892 schoenebeck 2639 void SetDimensionType(dimension_t oldType, dimension_t newType);
893 schoenebeck 1335 // overridden methods
894     virtual void SetKeyRange(uint16_t Low, uint16_t High);
895 schoenebeck 2682 virtual void UpdateChunks(progress_t* pProgress);
896 schoenebeck 2394 virtual void CopyAssign(const Region* orig);
897 schoenebeck 2 protected:
898     Region(Instrument* pInstrument, RIFF::List* rgnList);
899     void LoadDimensionRegions(RIFF::List* rgn);
900 persson 858 void UpdateVelocityTable();
901 schoenebeck 515 Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
902 schoenebeck 2482 void CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples);
903 schoenebeck 2555 DimensionRegion* GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase);
904 schoenebeck 2 ~Region();
905     friend class Instrument;
906     };
907    
908 schoenebeck 2699 /** @brief Abstract base class for all MIDI rules.
909     *
910     * Note: Instead of using MIDI rules, we recommend you using real-time
911     * instrument scripts instead. Read about the reasons below.
912     *
913     * MIDI Rules (also called "iMIDI rules" or "intelligent MIDI rules") were
914     * introduced with GigaStudio 4 as an attempt to increase the power of
915     * potential user controls over sounds. At that point other samplers already
916     * supported certain powerful user control features, which were not possible
917     * with GigaStudio yet. For example triggering new notes by MIDI CC
918     * controller.
919     *
920     * Such extended features however were usually implemented by other samplers
921     * by requiring the sound designer to write an instrument script which the
922     * designer would then bundle with the respective instrument file. Such
923     * scripts are essentially text files, using a very specific programming
924     * language for the purpose of controlling the sampler in real-time. Since
925     * however musicians are not typically keen to writing such cumbersome
926     * script files, the GigaStudio designers decided to implement such extended
927     * features completely without instrument scripts. Instead they created a
928     * set of rules, which could be defined and altered conveniently by mouse
929     * clicks in GSt's instrument editor application. The downside of this
930     * overall approach however, was that those MIDI rules were very limited in
931     * practice. As sound designer you easily came across the possiblities such
932     * MIDI rules were able to offer.
933     *
934     * Due to such severe use case constraints, support for MIDI rules is quite
935     * limited in libgig. At the moment only the "Control Trigger", "Alternator"
936     * and the "Legato" MIDI rules are supported by libgig. Consequently the
937     * graphical instrument editor application gigedit just supports the
938     * "Control Trigger" and "Legato" MIDI rules, and LinuxSampler even does not
939     * support any MIDI rule type at all and LinuxSampler probably will not
940     * support MIDI rules in future either.
941     *
942     * Instead of using MIDI rules, we introduced real-time instrument scripts
943     * as extension to the original GigaStudio file format. This script based
944     * solution is much more powerful than MIDI rules and is already supported
945     * by libgig, gigedit and LinuxSampler.
946     *
947     * @deprecated Just provided for backward compatiblity, use Script for new
948     * instruments instead.
949     */
950 persson 1627 class MidiRule {
951     public:
952     virtual ~MidiRule() { }
953 persson 2450 protected:
954     virtual void UpdateChunks(uint8_t* pData) const = 0;
955     friend class Instrument;
956 persson 1627 };
957    
958 schoenebeck 2699 /** @brief MIDI rule for triggering notes by control change events.
959     *
960     * A "Control Trigger MIDI rule" allows to trigger new notes by sending MIDI
961     * control change events to the sampler.
962     *
963     * Note: "Control Trigger" MIDI rules are only supported by gigedit, but not
964     * by LinuxSampler. We recommend you using real-time instrument scripts
965     * instead. Read more about the details and reasons for this in the
966     * description of the MidiRule base class.
967     *
968     * @deprecated Just provided for backward compatiblity, use Script for new
969     * instruments instead. See description of MidiRule for details.
970     */
971 persson 1627 class MidiRuleCtrlTrigger : public MidiRule {
972     public:
973     uint8_t ControllerNumber; ///< MIDI controller number.
974     uint8_t Triggers; ///< Number of triggers.
975     struct trigger_t {
976     uint8_t TriggerPoint; ///< The CC value to pass for the note to be triggered.
977     bool Descending; ///< If the change in CC value should be downwards.
978     uint8_t VelSensitivity; ///< How sensitive the velocity should be to the speed of the controller change.
979     uint8_t Key; ///< Key to trigger.
980     bool NoteOff; ///< If a note off should be triggered instead of a note on.
981     uint8_t Velocity; ///< Velocity of the note to trigger. 255 means that velocity should depend on the speed of the controller change.
982     bool OverridePedal; ///< If a note off should be triggered even if the sustain pedal is down.
983     } pTriggers[32];
984    
985     protected:
986     MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg);
987 persson 2450 MidiRuleCtrlTrigger();
988     void UpdateChunks(uint8_t* pData) const;
989 persson 1627 friend class Instrument;
990     };
991    
992 schoenebeck 2699 /** @brief MIDI rule for instruments with legato samples.
993     *
994     * A "Legato MIDI rule" allows playing instruments resembling the legato
995     * playing technique. In the past such legato articulations were tried to be
996     * simulated by pitching the samples of the instrument. However since
997     * usually a high amount of pitch is needed for legatos, this always sounded
998     * very artificial and unrealistic. The "Legato MIDI rule" thus uses another
999     * approach. Instead of pitching the samples, it allows the sound designer
1000     * to bundle separate, additional samples for the individual legato
1001     * situations and the legato rules defined which samples to be played in
1002     * which situation.
1003     *
1004     * Note: "Legato MIDI rules" are only supported by gigedit, but not
1005     * by LinuxSampler. We recommend you using real-time instrument scripts
1006     * instead. Read more about the details and reasons for this in the
1007     * description of the MidiRule base class.
1008     *
1009     * @deprecated Just provided for backward compatiblity, use Script for new
1010     * instruments instead. See description of MidiRule for details.
1011     */
1012 persson 2450 class MidiRuleLegato : public MidiRule {
1013     public:
1014     uint8_t LegatoSamples; ///< Number of legato samples per key in each direction (always 12)
1015     bool BypassUseController; ///< If a controller should be used to bypass the sustain note
1016     uint8_t BypassKey; ///< Key to be used to bypass the sustain note
1017     uint8_t BypassController; ///< Controller to be used to bypass the sustain note
1018     uint16_t ThresholdTime; ///< Maximum time (ms) between two notes that should be played legato
1019     uint16_t ReleaseTime; ///< Release time
1020     range_t KeyRange; ///< Key range for legato notes
1021     uint8_t ReleaseTriggerKey; ///< Key triggering release samples
1022     uint8_t AltSustain1Key; ///< Key triggering alternate sustain samples
1023     uint8_t AltSustain2Key; ///< Key triggering a second set of alternate sustain samples
1024    
1025     protected:
1026     MidiRuleLegato(RIFF::Chunk* _3ewg);
1027     MidiRuleLegato();
1028     void UpdateChunks(uint8_t* pData) const;
1029     friend class Instrument;
1030     };
1031    
1032 schoenebeck 2699 /** @brief MIDI rule to automatically cycle through specified sequences of different articulations.
1033     *
1034     * The instrument must be using the smartmidi dimension.
1035     *
1036     * Note: "Alternator" MIDI rules are neither supported by gigedit nor by
1037     * LinuxSampler. We recommend you using real-time instrument scripts
1038     * instead. Read more about the details and reasons for this in the
1039     * description of the MidiRule base class.
1040     *
1041     * @deprecated Just provided for backward compatiblity, use Script for new
1042     * instruments instead. See description of MidiRule for details.
1043     */
1044 persson 2450 class MidiRuleAlternator : public MidiRule {
1045     public:
1046     uint8_t Articulations; ///< Number of articulations in the instrument
1047     String pArticulations[32]; ///< Names of the articulations
1048    
1049     range_t PlayRange; ///< Key range of the playable keys in the instrument
1050    
1051     uint8_t Patterns; ///< Number of alternator patterns
1052     struct pattern_t {
1053     String Name; ///< Name of the pattern
1054     int Size; ///< Number of steps in the pattern
1055     const uint8_t& operator[](int i) const { /// Articulation to play
1056     return data[i];
1057     }
1058     uint8_t& operator[](int i) {
1059     return data[i];
1060     }
1061     private:
1062     uint8_t data[32];
1063     } pPatterns[32]; ///< A pattern is a sequence of articulation numbers
1064    
1065     typedef enum {
1066     selector_none,
1067     selector_key_switch,
1068     selector_controller
1069     } selector_t;
1070     selector_t Selector; ///< Method by which pattern is chosen
1071     range_t KeySwitchRange; ///< Key range for key switch selector
1072     uint8_t Controller; ///< CC number for controller selector
1073    
1074     bool Polyphonic; ///< If alternator should step forward only when all notes are off
1075     bool Chained; ///< If all patterns should be chained together
1076    
1077     protected:
1078     MidiRuleAlternator(RIFF::Chunk* _3ewg);
1079     MidiRuleAlternator();
1080     void UpdateChunks(uint8_t* pData) const;
1081     friend class Instrument;
1082     };
1083    
1084 schoenebeck 2699 /** @brief A MIDI rule not yet implemented by libgig.
1085     *
1086     * This class is currently used as a place holder by libgig for MIDI rule
1087     * types which are not supported by libgig yet.
1088     *
1089     * Note: Support for missing MIDI rule types are probably never added to
1090     * libgig. We recommend you using real-time instrument scripts instead.
1091     * Read more about the details and reasons for this in the description of
1092     * the MidiRule base class.
1093     *
1094     * @deprecated Just provided for backward compatiblity, use Script for new
1095     * instruments instead. See description of MidiRule for details.
1096     */
1097 persson 2450 class MidiRuleUnknown : public MidiRule {
1098     protected:
1099     MidiRuleUnknown() { }
1100     void UpdateChunks(uint8_t* pData) const { }
1101     friend class Instrument;
1102     };
1103    
1104 schoenebeck 2584 /** @brief Real-time instrument script (gig format extension).
1105     *
1106     * Real-time instrument scripts are user supplied small programs which can
1107     * be used by instrument designers to create custom behaviors and features
1108     * not available in the stock sampler engine. Features which might be very
1109     * exotic or specific for the respective instrument.
1110     *
1111     * This is an extension of the GigaStudio format, thus a feature which was
1112     * not available in the GigaStudio 4 software. It is currently only
1113 schoenebeck 2699 * supported by LinuxSampler and gigedit. Scripts will not load with the
1114     * original GigaStudio software.
1115 schoenebeck 2761 *
1116     * You find more informations about Instrument Scripts on the LinuxSampler
1117     * documentation site:
1118     *
1119     * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/">About Instrument Scripts in General</a>
1120     * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language">Introduction to the NKSP Script Language</a>
1121     * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language/Reference/">NKSP Reference Manual</a>
1122     * - <a href="http://doc.linuxsampler.org/Gigedit/Managing_Scripts">Using Instrument Scripts with Gigedit</a>
1123 schoenebeck 2584 */
1124     class Script {
1125     public:
1126     enum Encoding_t {
1127     ENCODING_ASCII = 0 ///< Standard 8 bit US ASCII character encoding (default).
1128     };
1129     enum Compression_t {
1130     COMPRESSION_NONE = 0 ///< Is not compressed at all (default).
1131     };
1132     enum Language_t {
1133 schoenebeck 2762 LANGUAGE_NKSP = 0 ///< NKSP stands for "Is Not KSP" (default). Refer to the <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language/Reference/">NKSP Reference Manual</a> for details about this script language.
1134 schoenebeck 2584 };
1135    
1136     String Name; ///< Arbitrary name of the script, which may be displayed i.e. in an instrument editor.
1137     Compression_t Compression; ///< Whether the script was/should be compressed, and if so, which compression algorithm shall be used.
1138     Encoding_t Encoding; ///< Format the script's source code text is encoded with.
1139     Language_t Language; ///< Programming language and dialect the script is written in.
1140     bool Bypass; ///< Global bypass: if enabled, this script shall not be executed by the sampler for any instrument.
1141    
1142     String GetScriptAsText();
1143     void SetScriptAsText(const String& text);
1144     void SetGroup(ScriptGroup* pGroup);
1145 schoenebeck 2601 ScriptGroup* GetGroup() const;
1146 schoenebeck 3117 void CopyAssign(const Script* orig);
1147 schoenebeck 2584 protected:
1148     Script(ScriptGroup* group, RIFF::Chunk* ckScri);
1149     virtual ~Script();
1150 schoenebeck 2682 void UpdateChunks(progress_t* pProgress);
1151 schoenebeck 2584 void RemoveAllScriptReferences();
1152     friend class ScriptGroup;
1153     friend class Instrument;
1154     private:
1155     ScriptGroup* pGroup;
1156     RIFF::Chunk* pChunk; ///< 'Scri' chunk
1157     std::vector<uint8_t> data;
1158     uint32_t crc; ///< CRC-32 checksum of the raw script data
1159     };
1160    
1161     /** @brief Group of instrument scripts (gig format extension).
1162     *
1163     * This class is simply used to sort a bunch of real-time instrument scripts
1164     * into individual groups. This allows instrument designers and script
1165     * developers to keep scripts in a certain order while working with a larger
1166     * amount of scripts in an instrument editor.
1167     *
1168     * This is an extension of the GigaStudio format, thus a feature which was
1169     * not available in the GigaStudio 4 software. It is currently only
1170     * supported by LinuxSampler and gigedit.
1171     */
1172     class ScriptGroup {
1173     public:
1174     String Name; ///< Name of this script group. For example to be displayed in an instrument editor.
1175    
1176     Script* GetScript(uint index);
1177     Script* AddScript();
1178     void DeleteScript(Script* pScript);
1179     protected:
1180     ScriptGroup(File* file, RIFF::List* lstRTIS);
1181     virtual ~ScriptGroup();
1182     void LoadScripts();
1183 schoenebeck 2682 void UpdateChunks(progress_t* pProgress);
1184 schoenebeck 2584 friend class Script;
1185     friend class File;
1186     private:
1187     File* pFile;
1188     RIFF::List* pList; ///< 'RTIS' list chunk
1189     std::list<Script*>* pScripts;
1190     };
1191    
1192 schoenebeck 2699 /** @brief Provides access to a Gigasampler/GigaStudio instrument.
1193     *
1194     * This class provides access to Gigasampler/GigaStudio instruments
1195     * contained in .gig files. A gig instrument is merely a set of keyboard
1196     * ranges (called Region), plus some additional global informations about
1197     * the instrument. The major part of the actual instrument definition used
1198     * for the synthesis of the instrument is contained in the respective Region
1199     * object (or actually in the respective DimensionRegion object being, see
1200     * description of Region for details).
1201     *
1202     * Since the gig format was designed as extension to the DLS file format,
1203     * this class is derived from the DLS::Instrument class. So also refer to
1204     * DLS::Instrument for additional informations, class attributes and
1205     * methods.
1206     */
1207 schoenebeck 2 class Instrument : protected DLS::Instrument {
1208     public:
1209     // derived attributes from DLS::Resource
1210 persson 2334 using DLS::Resource::pInfo;
1211     using DLS::Resource::pDLSID;
1212 schoenebeck 2 // derived attributes from DLS::Instrument
1213 persson 2334 using DLS::Instrument::IsDrum;
1214     using DLS::Instrument::MIDIBank;
1215     using DLS::Instrument::MIDIBankCoarse;
1216     using DLS::Instrument::MIDIBankFine;
1217     using DLS::Instrument::MIDIProgram;
1218     using DLS::Instrument::Regions;
1219 schoenebeck 2 // own attributes
1220     int32_t Attenuation; ///< in dB
1221     uint16_t EffectSend;
1222     int16_t FineTune; ///< in cents
1223     uint16_t PitchbendRange; ///< Number of semitones pitchbend controller can pitch (default is 2).
1224     bool PianoReleaseMode;
1225     range_t DimensionKeyRange; ///< 0-127 (where 0 means C1 and 127 means G9)
1226    
1227    
1228     // derived methods from DLS::Resource
1229 persson 2334 using DLS::Resource::GetParent;
1230 schoenebeck 2 // overridden methods
1231     Region* GetFirstRegion();
1232     Region* GetNextRegion();
1233 schoenebeck 809 Region* AddRegion();
1234     void DeleteRegion(Region* pRegion);
1235 schoenebeck 2700 void MoveTo(Instrument* dst);
1236 schoenebeck 2682 virtual void UpdateChunks(progress_t* pProgress);
1237 schoenebeck 2394 virtual void CopyAssign(const Instrument* orig);
1238 schoenebeck 2 // own methods
1239     Region* GetRegion(unsigned int Key);
1240 persson 1678 MidiRule* GetMidiRule(int i);
1241 persson 2450 MidiRuleCtrlTrigger* AddMidiRuleCtrlTrigger();
1242     MidiRuleLegato* AddMidiRuleLegato();
1243     MidiRuleAlternator* AddMidiRuleAlternator();
1244     void DeleteMidiRule(int i);
1245 schoenebeck 2584 // real-time instrument script methods
1246     Script* GetScriptOfSlot(uint index);
1247     void AddScriptSlot(Script* pScript, bool bypass = false);
1248     void SwapScriptSlots(uint index1, uint index2);
1249     void RemoveScriptSlot(uint index);
1250     void RemoveScript(Script* pScript);
1251     uint ScriptSlotCount() const;
1252     bool IsScriptSlotBypassed(uint index);
1253     void SetScriptSlotBypassed(uint index, bool bBypass);
1254 schoenebeck 2 protected:
1255     Region* RegionKeyTable[128]; ///< fast lookup for the corresponding Region of a MIDI key
1256    
1257 schoenebeck 515 Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
1258 schoenebeck 2 ~Instrument();
1259 schoenebeck 2482 void CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples);
1260 schoenebeck 809 void UpdateRegionKeyTable();
1261 schoenebeck 2584 void LoadScripts();
1262 schoenebeck 2609 void UpdateScriptFileOffsets();
1263 schoenebeck 2 friend class File;
1264 schoenebeck 1335 friend class Region; // so Region can call UpdateRegionKeyTable()
1265 persson 1627 private:
1266 schoenebeck 2584 struct _ScriptPooolEntry {
1267     uint32_t fileOffset;
1268     bool bypass;
1269     };
1270     struct _ScriptPooolRef {
1271     Script* script;
1272     bool bypass;
1273     };
1274 persson 1678 MidiRule** pMidiRules;
1275 schoenebeck 2584 std::vector<_ScriptPooolEntry> scriptPoolFileOffsets;
1276     std::vector<_ScriptPooolRef>* pScriptRefs;
1277 schoenebeck 2 };
1278    
1279 schoenebeck 2699 /** @brief Group of Gigasampler samples
1280 schoenebeck 929 *
1281 schoenebeck 2699 * Groups help to organize a huge collection of Gigasampler samples.
1282 schoenebeck 929 * Groups are not concerned at all for the synthesis, but they help
1283     * sound library developers when working on complex instruments with an
1284     * instrument editor (as long as that instrument editor supports it ;-).
1285     *
1286 schoenebeck 930 * A sample is always assigned to exactly one Group. This also means
1287     * there is always at least one Group in a .gig file, no matter if you
1288     * created one yet or not.
1289 schoenebeck 929 */
1290     class Group {
1291     public:
1292     String Name; ///< Stores the name of this Group.
1293 schoenebeck 930
1294     Sample* GetFirstSample();
1295     Sample* GetNextSample();
1296     void AddSample(Sample* pSample);
1297 schoenebeck 929 protected:
1298 schoenebeck 930 Group(File* file, RIFF::Chunk* ck3gnm);
1299 schoenebeck 929 virtual ~Group();
1300 schoenebeck 2682 virtual void UpdateChunks(progress_t* pProgress);
1301 schoenebeck 930 void MoveAll();
1302 schoenebeck 929 friend class File;
1303     private:
1304 schoenebeck 930 File* pFile;
1305 schoenebeck 2467 RIFF::Chunk* pNameChunk; ///< '3gnm' chunk
1306 schoenebeck 929 };
1307    
1308 schoenebeck 2699 /** @brief Provides convenient access to Gigasampler/GigaStudio .gig files.
1309     *
1310     * This is the entry class for accesing a Gigasampler/GigaStudio (.gig) file
1311     * with libgig. It allows you to open existing .gig files, modifying them
1312     * and saving them persistently either under the same file name or under a
1313     * different location.
1314     *
1315     * A .gig file is merely a monolithic file. That means samples and the
1316     * defintion of the virtual instruments are contained in the same file. A
1317     * .gig file contains an arbitrary amount of samples, and an arbitrary
1318     * amount of instruments which are referencing those samples. It is also
1319     * possible to store samples in .gig files not being referenced by any
1320     * instrument. This is not an error from the file format's point of view and
1321     * it is actually often used in practice during the design phase of new gig
1322     * instruments.
1323     *
1324     * So on toplevel of the gig file format you have:
1325     *
1326     * - A set of samples (see Sample).
1327     * - A set of virtual instruments (see Instrument).
1328     *
1329     * And as extension to the original GigaStudio format, we added:
1330     *
1331     * - Real-time instrument scripts (see Script).
1332     *
1333     * Note that the latter however is only supported by libgig, gigedit and
1334     * LinuxSampler. Scripts are not supported by the original GigaStudio
1335     * software.
1336     *
1337     * All released Gigasampler/GigaStudio file format versions are supported
1338     * (so from first Gigasampler version up to including GigaStudio 4).
1339     *
1340     * Since the gig format was designed as extension to the DLS file format,
1341     * this class is derived from the DLS::File class. So also refer to
1342     * DLS::File for additional informations, class attributes and methods.
1343     */
1344 schoenebeck 2 class File : protected DLS::File {
1345     public:
1346 persson 1199 static const DLS::version_t VERSION_2;
1347     static const DLS::version_t VERSION_3;
1348 schoenebeck 3440 static const DLS::version_t VERSION_4;
1349 persson 1199
1350 schoenebeck 2 // derived attributes from DLS::Resource
1351 persson 2334 using DLS::Resource::pInfo;
1352     using DLS::Resource::pDLSID;
1353 schoenebeck 2 // derived attributes from DLS::File
1354 persson 2334 using DLS::File::pVersion;
1355     using DLS::File::Instruments;
1356 schoenebeck 2
1357     // derived methods from DLS::Resource
1358 persson 2334 using DLS::Resource::GetParent;
1359 schoenebeck 809 // derived methods from DLS::File
1360 persson 2334 using DLS::File::Save;
1361     using DLS::File::GetFileName;
1362 schoenebeck 2482 using DLS::File::SetFileName;
1363 schoenebeck 2 // overridden methods
1364 schoenebeck 809 File();
1365 schoenebeck 2 File(RIFF::File* pRIFF);
1366 schoenebeck 515 Sample* GetFirstSample(progress_t* pProgress = NULL); ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise.
1367 schoenebeck 2 Sample* GetNextSample(); ///< Returns a pointer to the next <i>Sample</i> object of the file, <i>NULL</i> otherwise.
1368 schoenebeck 2482 Sample* GetSample(uint index);
1369 schoenebeck 809 Sample* AddSample();
1370 schoenebeck 3414 size_t CountSamples();
1371 schoenebeck 809 void DeleteSample(Sample* pSample);
1372 schoenebeck 929 Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
1373 schoenebeck 2 Instrument* GetNextInstrument(); ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
1374 schoenebeck 515 Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
1375 schoenebeck 809 Instrument* AddInstrument();
1376 schoenebeck 2394 Instrument* AddDuplicateInstrument(const Instrument* orig);
1377 schoenebeck 3414 size_t CountInstruments();
1378 schoenebeck 809 void DeleteInstrument(Instrument* pInstrument);
1379 schoenebeck 929 Group* GetFirstGroup(); ///< Returns a pointer to the first <i>Group</i> object of the file, <i>NULL</i> otherwise.
1380     Group* GetNextGroup(); ///< Returns a pointer to the next <i>Group</i> object of the file, <i>NULL</i> otherwise.
1381     Group* GetGroup(uint index);
1382 schoenebeck 2543 Group* GetGroup(String name);
1383 schoenebeck 929 Group* AddGroup();
1384     void DeleteGroup(Group* pGroup);
1385 schoenebeck 1081 void DeleteGroupOnly(Group* pGroup);
1386 schoenebeck 1524 void SetAutoLoad(bool b);
1387     bool GetAutoLoad();
1388 schoenebeck 2482 void AddContentOf(File* pFile);
1389 schoenebeck 2584 ScriptGroup* GetScriptGroup(uint index);
1390     ScriptGroup* GetScriptGroup(const String& name);
1391     ScriptGroup* AddScriptGroup();
1392     void DeleteScriptGroup(ScriptGroup* pGroup);
1393 schoenebeck 929 virtual ~File();
1394 schoenebeck 2682 virtual void UpdateChunks(progress_t* pProgress);
1395 schoenebeck 2 protected:
1396 schoenebeck 823 // overridden protected methods from DLS::File
1397     virtual void LoadSamples();
1398     virtual void LoadInstruments();
1399 schoenebeck 929 virtual void LoadGroups();
1400 schoenebeck 2609 virtual void UpdateFileOffsets();
1401 schoenebeck 823 // own protected methods
1402     virtual void LoadSamples(progress_t* pProgress);
1403     virtual void LoadInstruments(progress_t* pProgress);
1404 schoenebeck 2584 virtual void LoadScriptGroups();
1405 persson 1199 void SetSampleChecksum(Sample* pSample, uint32_t crc);
1406 schoenebeck 2985 uint32_t GetSampleChecksum(Sample* pSample);
1407 schoenebeck 2989 uint32_t GetSampleChecksumByIndex(int index);
1408 schoenebeck 2985 bool VerifySampleChecksumTable();
1409     bool RebuildSampleChecksumTable();
1410     int GetWaveTableIndexOf(gig::Sample* pSample);
1411 schoenebeck 2 friend class Region;
1412 schoenebeck 929 friend class Sample;
1413 schoenebeck 2700 friend class Instrument;
1414 schoenebeck 930 friend class Group; // so Group can access protected member pRIFF
1415 schoenebeck 2584 friend class ScriptGroup; // so ScriptGroup can access protected member pRIFF
1416 schoenebeck 929 private:
1417     std::list<Group*>* pGroups;
1418     std::list<Group*>::iterator GroupsIterator;
1419 schoenebeck 1524 bool bAutoLoad;
1420 schoenebeck 2584 std::list<ScriptGroup*>* pScriptGroups;
1421 schoenebeck 2 };
1422    
1423 schoenebeck 1093 /**
1424     * Will be thrown whenever a gig specific error occurs while trying to
1425     * access a Gigasampler File. Note: In your application you should
1426     * better catch for RIFF::Exception rather than this one, except you
1427     * explicitly want to catch and handle gig::Exception, DLS::Exception
1428     * and RIFF::Exception independently, which usually shouldn't be
1429     * necessary though.
1430     */
1431 schoenebeck 2 class Exception : public DLS::Exception {
1432     public:
1433 schoenebeck 3198 Exception(String format, ...);
1434     Exception(String format, va_list arg);
1435 schoenebeck 2 void PrintMessage();
1436 schoenebeck 3198 protected:
1437     Exception();
1438 schoenebeck 2 };
1439    
1440 schoenebeck 3169 #if HAVE_RTTI
1441 schoenebeck 3181 size_t enumCount(const std::type_info& type);
1442 schoenebeck 3173 const char* enumKey(const std::type_info& type, size_t value);
1443     bool enumKey(const std::type_info& type, String key);
1444     const char** enumKeys(const std::type_info& type);
1445     #endif // HAVE_RTTI
1446 schoenebeck 3181 size_t enumCount(String typeName);
1447 schoenebeck 3169 const char* enumKey(String typeName, size_t value);
1448     bool enumKey(String typeName, String key);
1449     const char** enumKeys(String typeName);
1450     size_t enumValue(String key);
1451    
1452 schoenebeck 518 String libraryName();
1453     String libraryVersion();
1454    
1455 schoenebeck 2 } // namespace gig
1456    
1457     #endif // __GIG_H__

  ViewVC Help
Powered by ViewVC