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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3961 - (show annotations) (download) (as text)
Sat Jun 19 11:01:40 2021 UTC (3 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 100551 byte(s)
* gig: Changed signature of method
  Instrument::SetScriptPatchVariable(int,String,String) to
  Instrument::SetScriptPatchVariable(size_t,String,String).

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

  ViewVC Help
Powered by ViewVC