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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3442 - (show annotations) (download) (as text)
Sat Dec 22 18:59:29 2018 UTC (2 years, 10 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 94176 byte(s)
* GIG FORMAT EXTENSION: Added attribute
  DimensionRegion::SustainReleaseTrigger which allows to define whether
  a sustain pedal up event shall cause a release trigger sample to be
  played (default: don't play release trigger sample by sustain pedal).
* Bumped version (4.1.0.svn7).

1 /***************************************************************************
2 * *
3 * libgig - C++ cross-platform Gigasampler format file access library *
4 * *
5 * Copyright (C) 2003-2018 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
30 #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 #else
43 # warning No RTTI available!
44 #endif
45
46 #if WORDS_BIGENDIAN
47 # define LIST_TYPE_3PRG 0x33707267
48 # define LIST_TYPE_3EWL 0x3365776C
49 # define LIST_TYPE_3GRI 0x33677269
50 # define LIST_TYPE_3GNL 0x33676E6C
51 # define LIST_TYPE_3LS 0x334c5320 // own gig format extension
52 # define LIST_TYPE_RTIS 0x52544953 // own gig format extension
53 # 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 # define CHUNK_ID_3GNM 0x33676E6D
59 # define CHUNK_ID_EINF 0x65696E66
60 # define CHUNK_ID_3CRC 0x33637263
61 # 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 # define CHUNK_ID_LSDE 0x4c534445 // own gig format extension
65 #else // little endian
66 # define LIST_TYPE_3PRG 0x67727033
67 # define LIST_TYPE_3EWL 0x6C776533
68 # define LIST_TYPE_3GRI 0x69726733
69 # define LIST_TYPE_3GNL 0x6C6E6733
70 # define LIST_TYPE_3LS 0x20534c33 // own gig format extension
71 # define LIST_TYPE_RTIS 0x53495452 // own gig format extension
72 # 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 # define CHUNK_ID_3GNM 0x6D6E6733
78 # define CHUNK_ID_EINF 0x666E6965
79 # define CHUNK_ID_3CRC 0x63726333
80 # 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 # define CHUNK_ID_LSDE 0x4544534c // own gig format extension
84 #endif // WORDS_BIGENDIAN
85
86 #ifndef GIG_DECLARE_ENUM
87 # define GIG_DECLARE_ENUM(type, ...) enum type { __VA_ARGS__ }
88 #endif
89
90 // just symbol prototyping (since Serialization.h not included by default here)
91 namespace Serialization { class Archive; }
92
93 /** Gigasampler/GigaStudio specific classes and definitions */
94 namespace gig {
95
96 typedef std::string String;
97 typedef RIFF::progress_t progress_t;
98 typedef RIFF::file_offset_t file_offset_t;
99
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 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 buffer_t() {
112 pStart = NULL;
113 Size = 0;
114 NullExtensionSize = 0;
115 }
116 };
117
118 /** Standard types of sample loops.
119 *
120 * @see enumCount(), enumKey(), enumKeys(), enumValue()
121 */
122 GIG_DECLARE_ENUM(loop_type_t,
123 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 );
127
128 /** Society of Motion Pictures and Television E time format.
129 *
130 * @see enumCount(), enumKey(), enumKeys(), enumValue()
131 */
132 GIG_DECLARE_ENUM(smpte_format_t,
133 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 );
139
140 /** Defines the shape of a function graph.
141 *
142 * @see enumCount(), enumKey(), enumKeys(), enumValue()
143 */
144 GIG_DECLARE_ENUM(curve_type_t,
145 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 );
150
151 /** Dimensions allow to bypass one of the following controllers.
152 *
153 * @see enumCount(), enumKey(), enumKeys(), enumValue()
154 */
155 GIG_DECLARE_ENUM(dim_bypass_ctrl_t,
156 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 );
160
161 /** Defines how LFO3 is controlled by.
162 *
163 * @see enumCount(), enumKey(), enumKeys(), enumValue()
164 */
165 GIG_DECLARE_ENUM(lfo3_ctrl_t,
166 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 );
172
173 /** Defines how LFO2 is controlled by.
174 *
175 * @see enumCount(), enumKey(), enumKeys(), enumValue()
176 */
177 GIG_DECLARE_ENUM(lfo2_ctrl_t,
178 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 );
184
185 /** Defines how LFO1 is controlled by.
186 *
187 * @see enumCount(), enumKey(), enumKeys(), enumValue()
188 */
189 GIG_DECLARE_ENUM(lfo1_ctrl_t,
190 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 );
196
197 /** Defines how the filter cutoff frequency is controlled by.
198 *
199 * @see enumCount(), enumKey(), enumKeys(), enumValue()
200 */
201 GIG_DECLARE_ENUM(vcf_cutoff_ctrl_t,
202 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 );
215
216 /** Defines how the filter resonance is controlled by.
217 *
218 * @see enumCount(), enumKey(), enumKeys(), enumValue()
219 */
220 GIG_DECLARE_ENUM(vcf_res_ctrl_t,
221 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 );
227
228 /**
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 /** Defines possible controllers.
238 *
239 * @see enumCount(), enumKey(), enumKeys(), enumValue()
240 */
241 GIG_DECLARE_ENUM(type_t,
242 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 );
247
248 type_t type; ///< Controller type
249 uint controller_number; ///< MIDI controller number if this controller is a control change controller, 0 otherwise
250
251 void serialize(Serialization::Archive* archive);
252 };
253
254 /**
255 * Defines controller influencing attenuation.
256 *
257 * @see leverage_ctrl_t
258 */
259 typedef leverage_ctrl_t attenuation_ctrl_t;
260
261 /**
262 * Defines controller influencing envelope generator 1.
263 *
264 * @see leverage_ctrl_t
265 */
266 typedef leverage_ctrl_t eg1_ctrl_t;
267
268 /**
269 * Defines controller influencing envelope generator 2.
270 *
271 * @see leverage_ctrl_t
272 */
273 typedef leverage_ctrl_t eg2_ctrl_t;
274
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 *
282 * @see enumCount(), enumKey(), enumKeys(), enumValue()
283 */
284 GIG_DECLARE_ENUM(dimension_t,
285 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 );
320
321 /**
322 * Intended for internal usage: will be used to convert a dimension value
323 * into the corresponding dimension bit number.
324 *
325 * @see enumCount(), enumKey(), enumKeys(), enumValue()
326 */
327 GIG_DECLARE_ENUM(split_type_t,
328 split_type_normal, /**< dimension value between 0-127 */
329 split_type_bit /**< dimension values are already the sought bit number */
330 );
331
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 float zone_size; ///< Intended for internal usage: reflects the size of each zone (128/zones) for normal split types only, 0 otherwise.
339 };
340
341 /** Defines which frequencies are filtered by the VCF.
342 *
343 * @see enumCount(), enumKey(), enumKeys(), enumValue()
344 */
345 GIG_DECLARE_ENUM(vcf_type_t,
346 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 vcf_type_bandreject = 0x03 /**< Band reject filter type. */
351 );
352
353 /**
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 * crossfade.
359 */
360 struct crossfade_t {
361 #if WORDS_BIGENDIAN
362 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 uint8_t in_start; ///< Start position of fade in.
366 #else // little endian
367 uint8_t in_start; ///< Start position of fade in.
368 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
373 void serialize(Serialization::Archive* archive);
374 };
375
376 /** Reflects the current playback state for a sample. */
377 struct playback_state_t {
378 file_offset_t position; ///< Current position within the sample.
379 bool reverse; ///< If playback direction is currently backwards (in case there is a pingpong or reverse loop defined).
380 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 };
382
383 /**
384 * Defines behavior options for envelope generators (gig format extension).
385 *
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 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 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 /** @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 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 );
438
439 // just symbol prototyping
440 class File;
441 class Instrument;
442 class Sample;
443 class Region;
444 class Group;
445 class Script;
446 class ScriptGroup;
447
448 /** @brief Encapsulates articulation informations of a dimension region.
449 *
450 * 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 *
461 * 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 *
472 * 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 * - 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 *
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 */
490 class DimensionRegion : protected DLS::Sampler {
491 public:
492 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 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 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 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 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 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 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 bool VCFCutoffControllerInvert; ///< Inverts values coming from the defined cutoff controller
546 uint8_t VCFCutoff; ///< Max. cutoff frequency.
547 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 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 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 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 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 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 double SampleAttenuation; ///< Sample volume (calculated from DLS::Sampler::Gain)
576 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 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 sust_rel_trg_t SustainReleaseTrigger; ///< [gig extension]: Whether a sustain pedal up event shall play release trigger sample.
580
581 // derived attributes from DLS::Sampler
582 using DLS::Sampler::UnityNote;
583 using DLS::Sampler::FineTune;
584 using DLS::Sampler::Gain;
585 using DLS::Sampler::SampleLoops;
586 using DLS::Sampler::pSampleLoops;
587
588 // own methods
589 double GetVelocityAttenuation(uint8_t MIDIKeyVelocity);
590 double GetVelocityRelease(uint8_t MIDIKeyVelocity);
591 double GetVelocityCutoff(uint8_t MIDIKeyVelocity);
592 void SetVelocityResponseCurve(curve_type_t curve);
593 void SetVelocityResponseDepth(uint8_t depth);
594 void SetVelocityResponseCurveScaling(uint8_t scaling);
595 void SetReleaseVelocityResponseCurve(curve_type_t curve);
596 void SetReleaseVelocityResponseDepth(uint8_t depth);
597 void SetVCFCutoffController(vcf_cutoff_ctrl_t controller);
598 void SetVCFVelocityCurve(curve_type_t curve);
599 void SetVCFVelocityDynamicRange(uint8_t range);
600 void SetVCFVelocityScale(uint8_t scaling);
601 Region* GetParent() const;
602 // derived methods
603 using DLS::Sampler::AddSampleLoop;
604 using DLS::Sampler::DeleteSampleLoop;
605 // overridden methods
606 virtual void SetGain(int32_t gain);
607 virtual void UpdateChunks(progress_t* pProgress);
608 virtual void CopyAssign(const DimensionRegion* orig);
609 protected:
610 uint8_t* VelocityTable; ///< For velocity dimensions with custom defined zone ranges only: used for fast converting from velocity MIDI value to dimension bit number.
611 DimensionRegion(Region* pParent, RIFF::List* _3ewl);
612 DimensionRegion(RIFF::List* _3ewl, const DimensionRegion& src);
613 ~DimensionRegion();
614 void CopyAssign(const DimensionRegion* orig, const std::map<Sample*,Sample*>* mSamples);
615 void serialize(Serialization::Archive* archive);
616 friend class Region;
617 friend class Serialization::Archive;
618 private:
619 typedef enum { ///< Used to decode attenuation, EG1 and EG2 controller
620 // official leverage controllers as they were defined in the original Gigasampler/GigaStudio format:
621 _lev_ctrl_none = 0x00,
622 _lev_ctrl_modwheel = 0x03, ///< Modulation Wheel (MIDI Controller 1)
623 _lev_ctrl_breath = 0x05, ///< Breath Controller (Coarse, MIDI Controller 2)
624 _lev_ctrl_foot = 0x07, ///< Foot Pedal (Coarse, MIDI Controller 4)
625 _lev_ctrl_effect1 = 0x0d, ///< Effect Controller 1 (Coarse, MIDI Controller 12)
626 _lev_ctrl_effect2 = 0x0f, ///< Effect Controller 2 (Coarse, MIDI Controller 13)
627 _lev_ctrl_genpurpose1 = 0x11, ///< General Purpose Controller 1 (Slider, MIDI Controller 16)
628 _lev_ctrl_genpurpose2 = 0x13, ///< General Purpose Controller 2 (Slider, MIDI Controller 17)
629 _lev_ctrl_genpurpose3 = 0x15, ///< General Purpose Controller 3 (Slider, MIDI Controller 18)
630 _lev_ctrl_genpurpose4 = 0x17, ///< General Purpose Controller 4 (Slider, MIDI Controller 19)
631 _lev_ctrl_portamentotime = 0x0b, ///< Portamento Time (Coarse, MIDI Controller 5)
632 _lev_ctrl_sustainpedal = 0x01, ///< Sustain Pedal (MIDI Controller 64)
633 _lev_ctrl_portamento = 0x19, ///< Portamento (MIDI Controller 65)
634 _lev_ctrl_sostenutopedal = 0x1b, ///< Sostenuto Pedal (MIDI Controller 66)
635 _lev_ctrl_softpedal = 0x09, ///< Soft Pedal (MIDI Controller 67)
636 _lev_ctrl_genpurpose5 = 0x1d, ///< General Purpose Controller 5 (Button, MIDI Controller 80)
637 _lev_ctrl_genpurpose6 = 0x1f, ///< General Purpose Controller 6 (Button, MIDI Controller 81)
638 _lev_ctrl_genpurpose7 = 0x21, ///< General Purpose Controller 7 (Button, MIDI Controller 82)
639 _lev_ctrl_genpurpose8 = 0x23, ///< General Purpose Controller 8 (Button, MIDI Controller 83)
640 _lev_ctrl_effect1depth = 0x25, ///< Effect 1 Depth (MIDI Controller 91)
641 _lev_ctrl_effect2depth = 0x27, ///< Effect 2 Depth (MIDI Controller 92)
642 _lev_ctrl_effect3depth = 0x29, ///< Effect 3 Depth (MIDI Controller 93)
643 _lev_ctrl_effect4depth = 0x2b, ///< Effect 4 Depth (MIDI Controller 94)
644 _lev_ctrl_effect5depth = 0x2d, ///< Effect 5 Depth (MIDI Controller 95)
645 _lev_ctrl_channelaftertouch = 0x2f, ///< Channel Key Pressure
646 _lev_ctrl_velocity = 0xff, ///< Key Velocity
647
648 // format extension (these controllers are so far only supported by LinuxSampler & gigedit) they will *NOT* work with Gigasampler/GigaStudio !
649 // (the assigned values here are their official MIDI CC number plus the highest bit set):
650 _lev_ctrl_CC3_EXT = 0x83, ///< MIDI Controller 3 [gig format extension]
651
652 _lev_ctrl_CC6_EXT = 0x86, ///< Data Entry MSB (MIDI Controller 6) [gig format extension]
653 _lev_ctrl_CC7_EXT = 0x87, ///< Channel Volume (MIDI Controller 7) [gig format extension]
654 _lev_ctrl_CC8_EXT = 0x88, ///< Balance (MIDI Controller 8) [gig format extension]
655 _lev_ctrl_CC9_EXT = 0x89, ///< MIDI Controller 9 [gig format extension]
656 _lev_ctrl_CC10_EXT = 0x8a, ///< Pan (MIDI Controller 10) [gig format extension]
657 _lev_ctrl_CC11_EXT = 0x8b, ///< Expression Controller (MIDI Controller 11) [gig format extension]
658
659 _lev_ctrl_CC14_EXT = 0x8e, ///< MIDI Controller 14 [gig format extension]
660 _lev_ctrl_CC15_EXT = 0x8f, ///< MIDI Controller 15 [gig format extension]
661
662 _lev_ctrl_CC20_EXT = 0x94, ///< MIDI Controller 20 [gig format extension]
663 _lev_ctrl_CC21_EXT = 0x95, ///< MIDI Controller 21 [gig format extension]
664 _lev_ctrl_CC22_EXT = 0x96, ///< MIDI Controller 22 [gig format extension]
665 _lev_ctrl_CC23_EXT = 0x97, ///< MIDI Controller 23 [gig format extension]
666 _lev_ctrl_CC24_EXT = 0x98, ///< MIDI Controller 24 [gig format extension]
667 _lev_ctrl_CC25_EXT = 0x99, ///< MIDI Controller 25 [gig format extension]
668 _lev_ctrl_CC26_EXT = 0x9a, ///< MIDI Controller 26 [gig format extension]
669 _lev_ctrl_CC27_EXT = 0x9b, ///< MIDI Controller 27 [gig format extension]
670 _lev_ctrl_CC28_EXT = 0x9c, ///< MIDI Controller 28 [gig format extension]
671 _lev_ctrl_CC29_EXT = 0x9d, ///< MIDI Controller 29 [gig format extension]
672 _lev_ctrl_CC30_EXT = 0x9e, ///< MIDI Controller 30 [gig format extension]
673 _lev_ctrl_CC31_EXT = 0x9f, ///< MIDI Controller 31 [gig format extension]
674
675 _lev_ctrl_CC68_EXT = 0xc4, ///< Legato Footswitch (MIDI Controller 68) [gig format extension]
676 _lev_ctrl_CC69_EXT = 0xc5, ///< Hold 2 (MIDI Controller 69) [gig format extension]
677 _lev_ctrl_CC70_EXT = 0xc6, ///< Sound Ctrl. 1 - Sound Variation (MIDI Controller 70) [gig format extension]
678 _lev_ctrl_CC71_EXT = 0xc7, ///< Sound Ctrl. 2 - Timbre (MIDI Controller 71) [gig format extension]
679 _lev_ctrl_CC72_EXT = 0xc8, ///< Sound Ctrl. 3 - Release Time (MIDI Controller 72) [gig format extension]
680 _lev_ctrl_CC73_EXT = 0xc9, ///< Sound Ctrl. 4 - Attack Time (MIDI Controller 73) [gig format extension]
681 _lev_ctrl_CC74_EXT = 0xca, ///< Sound Ctrl. 5 - Brightness (MIDI Controller 74) [gig format extension]
682 _lev_ctrl_CC75_EXT = 0xcb, ///< Sound Ctrl. 6 - Decay Time (MIDI Controller 75) [gig format extension]
683 _lev_ctrl_CC76_EXT = 0xcc, ///< Sound Ctrl. 7 - Vibrato Rate (MIDI Controller 76) [gig format extension]
684 _lev_ctrl_CC77_EXT = 0xcd, ///< Sound Ctrl. 8 - Vibrato Depth (MIDI Controller 77) [gig format extension]
685 _lev_ctrl_CC78_EXT = 0xce, ///< Sound Ctrl. 9 - Vibrato Delay (MIDI Controller 78) [gig format extension]
686 _lev_ctrl_CC79_EXT = 0xcf, ///< Sound Ctrl. 10 (MIDI Controller 79) [gig format extension]
687
688 _lev_ctrl_CC84_EXT = 0xd4, ///< Portamento Control (MIDI Controller 84) [gig format extension]
689 _lev_ctrl_CC85_EXT = 0xd5, ///< MIDI Controller 85 [gig format extension]
690 _lev_ctrl_CC86_EXT = 0xd6, ///< MIDI Controller 86 [gig format extension]
691 _lev_ctrl_CC87_EXT = 0xd7, ///< MIDI Controller 87 [gig format extension]
692
693 _lev_ctrl_CC89_EXT = 0xd9, ///< MIDI Controller 89 [gig format extension]
694 _lev_ctrl_CC90_EXT = 0xda, ///< MIDI Controller 90 [gig format extension]
695
696 _lev_ctrl_CC96_EXT = 0xe0, ///< Data Increment (MIDI Controller 96) [gig format extension]
697 _lev_ctrl_CC97_EXT = 0xe1, ///< Data Decrement (MIDI Controller 97) [gig format extension]
698
699 _lev_ctrl_CC102_EXT = 0xe6, ///< MIDI Controller 102 [gig format extension]
700 _lev_ctrl_CC103_EXT = 0xe7, ///< MIDI Controller 103 [gig format extension]
701 _lev_ctrl_CC104_EXT = 0xe8, ///< MIDI Controller 104 [gig format extension]
702 _lev_ctrl_CC105_EXT = 0xe9, ///< MIDI Controller 105 [gig format extension]
703 _lev_ctrl_CC106_EXT = 0xea, ///< MIDI Controller 106 [gig format extension]
704 _lev_ctrl_CC107_EXT = 0xeb, ///< MIDI Controller 107 [gig format extension]
705 _lev_ctrl_CC108_EXT = 0xec, ///< MIDI Controller 108 [gig format extension]
706 _lev_ctrl_CC109_EXT = 0xed, ///< MIDI Controller 109 [gig format extension]
707 _lev_ctrl_CC110_EXT = 0xee, ///< MIDI Controller 110 [gig format extension]
708 _lev_ctrl_CC111_EXT = 0xef, ///< MIDI Controller 111 [gig format extension]
709 _lev_ctrl_CC112_EXT = 0xf0, ///< MIDI Controller 112 [gig format extension]
710 _lev_ctrl_CC113_EXT = 0xf1, ///< MIDI Controller 113 [gig format extension]
711 _lev_ctrl_CC114_EXT = 0xf2, ///< MIDI Controller 114 [gig format extension]
712 _lev_ctrl_CC115_EXT = 0xf3, ///< MIDI Controller 115 [gig format extension]
713 _lev_ctrl_CC116_EXT = 0xf4, ///< MIDI Controller 116 [gig format extension]
714 _lev_ctrl_CC117_EXT = 0xf5, ///< MIDI Controller 117 [gig format extension]
715 _lev_ctrl_CC118_EXT = 0xf6, ///< MIDI Controller 118 [gig format extension]
716 _lev_ctrl_CC119_EXT = 0xf7 ///< MIDI Controller 119 [gig format extension]
717 } _lev_ctrl_t;
718 typedef std::map<uint32_t, double*> VelocityTableMap;
719
720 static size_t Instances; ///< Number of DimensionRegion instances.
721 static VelocityTableMap* pVelocityTables; ///< Contains the tables corresponding to the various velocity parameters (VelocityResponseCurve and VelocityResponseDepth).
722 double* pVelocityAttenuationTable; ///< Points to the velocity table corresponding to the velocity parameters of this DimensionRegion.
723 double* pVelocityReleaseTable; ///< Points to the velocity table corresponding to the release velocity parameters of this DimensionRegion
724 double* pVelocityCutoffTable; ///< Points to the velocity table corresponding to the filter velocity parameters of this DimensionRegion
725 Region* pRegion;
726
727 leverage_ctrl_t DecodeLeverageController(_lev_ctrl_t EncodedController);
728 _lev_ctrl_t EncodeLeverageController(leverage_ctrl_t DecodedController);
729 double* GetReleaseVelocityTable(curve_type_t releaseVelocityResponseCurve, uint8_t releaseVelocityResponseDepth);
730 double* GetCutoffVelocityTable(curve_type_t vcfVelocityCurve, uint8_t vcfVelocityDynamicRange, uint8_t vcfVelocityScale, vcf_cutoff_ctrl_t vcfCutoffController);
731 double* GetVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
732 double* CreateVelocityTable(curve_type_t curveType, uint8_t depth, uint8_t scaling);
733 };
734
735 /** @brief Encapsulates sample waves of Gigasampler/GigaStudio files used for playback.
736 *
737 * This class provides access to the actual audio sample data of a
738 * Gigasampler/GigaStudio file. Along to the actual sample data, it also
739 * provides access to the sample's meta informations like bit depth,
740 * sample rate, encoding type, but also loop informations. The latter may be
741 * used by instruments for resembling sounds with arbitary note lengths.
742 *
743 * In case you created a new sample with File::AddSample(), you should
744 * first update all attributes with the desired meta informations
745 * (amount of channels, bit depth, sample rate, etc.), then call
746 * Resize() with the desired sample size, followed by File::Save(), this
747 * will create the mandatory RIFF chunk which will hold the sample wave
748 * data and / or resize the file so you will be able to Write() the
749 * sample data directly to disk.
750 *
751 * @e Caution: for gig synthesis, most looping relevant information are
752 * retrieved from the respective DimensionRegon instead from the Sample
753 * itself. This was made for allowing different loop definitions for the
754 * same sample under different conditions.
755 *
756 * Since the gig format was designed as extension to the DLS file format,
757 * this class is derived from the DLS::Sample class. So also refer to
758 * DLS::Sample for additional informations, class attributes and methods.
759 */
760 class Sample : public DLS::Sample {
761 public:
762 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.
763 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.
764 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.
765 uint32_t MIDIUnityNote; ///< Specifies the musical note at which the sample will be played at it's original sample rate.
766 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.
767 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.
768 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).
769 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!)
770 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.
771 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.)
772 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].)
773 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].)
774 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.)
775 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.
776 uint32_t LoopPlayCount; ///< Number of times the loop should be played (a value of 0 = infinite).
777 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).
778 uint32_t TruncatedBits; ///< For 24-bit compressed samples only: number of bits truncated during compression (0, 4 or 6)
779 bool Dithered; ///< For 24-bit compressed samples only: if dithering was used during compression with bit reduction
780
781 // own methods
782 buffer_t LoadSampleData();
783 buffer_t LoadSampleData(file_offset_t SampleCount);
784 buffer_t LoadSampleDataWithNullSamplesExtension(uint NullSamplesCount);
785 buffer_t LoadSampleDataWithNullSamplesExtension(file_offset_t SampleCount, uint NullSamplesCount);
786 buffer_t GetCache();
787 // own static methods
788 static buffer_t CreateDecompressionBuffer(file_offset_t MaxReadSize);
789 static void DestroyDecompressionBuffer(buffer_t& DecompressionBuffer);
790 // overridden methods
791 void ReleaseSampleData();
792 void Resize(file_offset_t NewSize);
793 file_offset_t SetPos(file_offset_t SampleCount, RIFF::stream_whence_t Whence = RIFF::stream_start);
794 file_offset_t GetPos() const;
795 file_offset_t Read(void* pBuffer, file_offset_t SampleCount, buffer_t* pExternalDecompressionBuffer = NULL);
796 file_offset_t ReadAndLoop(void* pBuffer, file_offset_t SampleCount, playback_state_t* pPlaybackState, DimensionRegion* pDimRgn, buffer_t* pExternalDecompressionBuffer = NULL);
797 file_offset_t Write(void* pBuffer, file_offset_t SampleCount);
798 Group* GetGroup() const;
799 virtual void UpdateChunks(progress_t* pProgress);
800 void CopyAssignMeta(const Sample* orig);
801 void CopyAssignWave(const Sample* orig);
802 uint32_t GetWaveDataCRC32Checksum();
803 bool VerifyWaveData(uint32_t* pActually = NULL);
804 protected:
805 static size_t Instances; ///< Number of instances of class Sample.
806 static buffer_t InternalDecompressionBuffer; ///< Buffer used for decompression as well as for truncation of 24 Bit -> 16 Bit samples.
807 Group* pGroup; ///< pointer to the Group this sample belongs to (always not-NULL)
808 file_offset_t FrameOffset; ///< Current offset (sample points) in current sample frame (for decompression only).
809 file_offset_t* FrameTable; ///< For positioning within compressed samples only: stores the offset values for each frame.
810 file_offset_t SamplePos; ///< For compressed samples only: stores the current position (in sample points).
811 file_offset_t SamplesInLastFrame; ///< For compressed samples only: length of the last sample frame.
812 file_offset_t WorstCaseFrameSize; ///< For compressed samples only: size (in bytes) of the largest possible sample frame.
813 file_offset_t SamplesPerFrame; ///< For compressed samples only: number of samples in a full sample frame.
814 buffer_t RAMCache; ///< Buffers samples (already uncompressed) in RAM.
815 unsigned long FileNo; ///< File number (> 0 when sample is stored in an extension file, 0 when it's in the gig)
816 RIFF::Chunk* pCk3gix;
817 RIFF::Chunk* pCkSmpl;
818 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().
819
820 Sample(File* pFile, RIFF::List* waveList, file_offset_t WavePoolOffset, unsigned long fileNo = 0, int index = -1);
821 ~Sample();
822 uint32_t CalculateWaveDataChecksum();
823
824 // Guess size (in bytes) of a compressed sample
825 inline file_offset_t GuessSize(file_offset_t samples) {
826 // 16 bit: assume all frames are compressed - 1 byte
827 // per sample and 5 bytes header per 2048 samples
828
829 // 24 bit: assume next best compression rate - 1.5
830 // bytes per sample and 13 bytes header per 256
831 // samples
832 const file_offset_t size =
833 BitDepth == 24 ? samples + (samples >> 1) + (samples >> 8) * 13
834 : samples + (samples >> 10) * 5;
835 // Double for stereo and add one worst case sample
836 // frame
837 return (Channels == 2 ? size << 1 : size) + WorstCaseFrameSize;
838 }
839
840 // Worst case amount of sample points that can be read with the
841 // given decompression buffer.
842 inline file_offset_t WorstCaseMaxSamples(buffer_t* pDecompressionBuffer) {
843 return (file_offset_t) ((float)pDecompressionBuffer->Size / (float)WorstCaseFrameSize * (float)SamplesPerFrame);
844 }
845 private:
846 void ScanCompressedSample();
847 friend class File;
848 friend class Region;
849 friend class Group; // allow to modify protected member pGroup
850 };
851
852 // TODO: <3dnl> list not used yet - not important though (just contains optional descriptions for the dimensions)
853 /** @brief Defines Region information of a Gigasampler/GigaStudio instrument.
854 *
855 * A Region reflects a consecutive area (key range) on the keyboard. The
856 * individual regions in the gig format may not overlap with other regions
857 * (of the same instrument that is). Further, in the gig format a Region is
858 * merely a container for DimensionRegions (a.k.a. "Cases"). The Region
859 * itself does not provide the sample mapping or articulation informations
860 * used, even though the data structures of regions indeed provide such
861 * informations. The latter is however just of historical nature, because
862 * the gig file format was derived from the DLS file format.
863 *
864 * Each Region consists of at least one or more DimensionRegions. The actual
865 * amount of DimensionRegions depends on which kind of "dimensions" are
866 * defined for this region, and on the split / zone amount for each of those
867 * dimensions.
868 *
869 * Since the gig format was designed as extension to the DLS file format,
870 * this class is derived from the DLS::Region class. So also refer to
871 * DLS::Region for additional informations, class attributes and methods.
872 */
873 class Region : public DLS::Region {
874 public:
875 unsigned int Dimensions; ///< Number of defined dimensions, do not alter!
876 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.
877 uint32_t DimensionRegions; ///< Total number of DimensionRegions this Region contains, do not alter!
878 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).
879 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!
880
881 // own methods
882 DimensionRegion* GetDimensionRegionByValue(const uint DimValues[8]);
883 DimensionRegion* GetDimensionRegionByBit(const uint8_t DimBits[8]);
884 int GetDimensionRegionIndexByValue(const uint DimValues[8]);
885 Sample* GetSample();
886 void AddDimension(dimension_def_t* pDimDef);
887 void DeleteDimension(dimension_def_t* pDimDef);
888 dimension_def_t* GetDimensionDefinition(dimension_t type);
889 void DeleteDimensionZone(dimension_t type, int zone);
890 void SplitDimensionZone(dimension_t type, int zone);
891 void SetDimensionType(dimension_t oldType, dimension_t newType);
892 // overridden methods
893 virtual void SetKeyRange(uint16_t Low, uint16_t High);
894 virtual void UpdateChunks(progress_t* pProgress);
895 virtual void CopyAssign(const Region* orig);
896 protected:
897 Region(Instrument* pInstrument, RIFF::List* rgnList);
898 void LoadDimensionRegions(RIFF::List* rgn);
899 void UpdateVelocityTable();
900 Sample* GetSampleFromWavePool(unsigned int WavePoolTableIndex, progress_t* pProgress = NULL);
901 void CopyAssign(const Region* orig, const std::map<Sample*,Sample*>* mSamples);
902 DimensionRegion* GetDimensionRegionByBit(const std::map<dimension_t,int>& DimCase);
903 ~Region();
904 friend class Instrument;
905 };
906
907 /** @brief Abstract base class for all MIDI rules.
908 *
909 * Note: Instead of using MIDI rules, we recommend you using real-time
910 * instrument scripts instead. Read about the reasons below.
911 *
912 * MIDI Rules (also called "iMIDI rules" or "intelligent MIDI rules") were
913 * introduced with GigaStudio 4 as an attempt to increase the power of
914 * potential user controls over sounds. At that point other samplers already
915 * supported certain powerful user control features, which were not possible
916 * with GigaStudio yet. For example triggering new notes by MIDI CC
917 * controller.
918 *
919 * Such extended features however were usually implemented by other samplers
920 * by requiring the sound designer to write an instrument script which the
921 * designer would then bundle with the respective instrument file. Such
922 * scripts are essentially text files, using a very specific programming
923 * language for the purpose of controlling the sampler in real-time. Since
924 * however musicians are not typically keen to writing such cumbersome
925 * script files, the GigaStudio designers decided to implement such extended
926 * features completely without instrument scripts. Instead they created a
927 * set of rules, which could be defined and altered conveniently by mouse
928 * clicks in GSt's instrument editor application. The downside of this
929 * overall approach however, was that those MIDI rules were very limited in
930 * practice. As sound designer you easily came across the possiblities such
931 * MIDI rules were able to offer.
932 *
933 * Due to such severe use case constraints, support for MIDI rules is quite
934 * limited in libgig. At the moment only the "Control Trigger", "Alternator"
935 * and the "Legato" MIDI rules are supported by libgig. Consequently the
936 * graphical instrument editor application gigedit just supports the
937 * "Control Trigger" and "Legato" MIDI rules, and LinuxSampler even does not
938 * support any MIDI rule type at all and LinuxSampler probably will not
939 * support MIDI rules in future either.
940 *
941 * Instead of using MIDI rules, we introduced real-time instrument scripts
942 * as extension to the original GigaStudio file format. This script based
943 * solution is much more powerful than MIDI rules and is already supported
944 * by libgig, gigedit and LinuxSampler.
945 *
946 * @deprecated Just provided for backward compatiblity, use Script for new
947 * instruments instead.
948 */
949 class MidiRule {
950 public:
951 virtual ~MidiRule() { }
952 protected:
953 virtual void UpdateChunks(uint8_t* pData) const = 0;
954 friend class Instrument;
955 };
956
957 /** @brief MIDI rule for triggering notes by control change events.
958 *
959 * A "Control Trigger MIDI rule" allows to trigger new notes by sending MIDI
960 * control change events to the sampler.
961 *
962 * Note: "Control Trigger" MIDI rules are only supported by gigedit, but not
963 * by LinuxSampler. We recommend you using real-time instrument scripts
964 * instead. Read more about the details and reasons for this in the
965 * description of the MidiRule base class.
966 *
967 * @deprecated Just provided for backward compatiblity, use Script for new
968 * instruments instead. See description of MidiRule for details.
969 */
970 class MidiRuleCtrlTrigger : public MidiRule {
971 public:
972 uint8_t ControllerNumber; ///< MIDI controller number.
973 uint8_t Triggers; ///< Number of triggers.
974 struct trigger_t {
975 uint8_t TriggerPoint; ///< The CC value to pass for the note to be triggered.
976 bool Descending; ///< If the change in CC value should be downwards.
977 uint8_t VelSensitivity; ///< How sensitive the velocity should be to the speed of the controller change.
978 uint8_t Key; ///< Key to trigger.
979 bool NoteOff; ///< If a note off should be triggered instead of a note on.
980 uint8_t Velocity; ///< Velocity of the note to trigger. 255 means that velocity should depend on the speed of the controller change.
981 bool OverridePedal; ///< If a note off should be triggered even if the sustain pedal is down.
982 } pTriggers[32];
983
984 protected:
985 MidiRuleCtrlTrigger(RIFF::Chunk* _3ewg);
986 MidiRuleCtrlTrigger();
987 void UpdateChunks(uint8_t* pData) const;
988 friend class Instrument;
989 };
990
991 /** @brief MIDI rule for instruments with legato samples.
992 *
993 * A "Legato MIDI rule" allows playing instruments resembling the legato
994 * playing technique. In the past such legato articulations were tried to be
995 * simulated by pitching the samples of the instrument. However since
996 * usually a high amount of pitch is needed for legatos, this always sounded
997 * very artificial and unrealistic. The "Legato MIDI rule" thus uses another
998 * approach. Instead of pitching the samples, it allows the sound designer
999 * to bundle separate, additional samples for the individual legato
1000 * situations and the legato rules defined which samples to be played in
1001 * which situation.
1002 *
1003 * Note: "Legato MIDI rules" are only supported by gigedit, but not
1004 * by LinuxSampler. We recommend you using real-time instrument scripts
1005 * instead. Read more about the details and reasons for this in the
1006 * description of the MidiRule base class.
1007 *
1008 * @deprecated Just provided for backward compatiblity, use Script for new
1009 * instruments instead. See description of MidiRule for details.
1010 */
1011 class MidiRuleLegato : public MidiRule {
1012 public:
1013 uint8_t LegatoSamples; ///< Number of legato samples per key in each direction (always 12)
1014 bool BypassUseController; ///< If a controller should be used to bypass the sustain note
1015 uint8_t BypassKey; ///< Key to be used to bypass the sustain note
1016 uint8_t BypassController; ///< Controller to be used to bypass the sustain note
1017 uint16_t ThresholdTime; ///< Maximum time (ms) between two notes that should be played legato
1018 uint16_t ReleaseTime; ///< Release time
1019 range_t KeyRange; ///< Key range for legato notes
1020 uint8_t ReleaseTriggerKey; ///< Key triggering release samples
1021 uint8_t AltSustain1Key; ///< Key triggering alternate sustain samples
1022 uint8_t AltSustain2Key; ///< Key triggering a second set of alternate sustain samples
1023
1024 protected:
1025 MidiRuleLegato(RIFF::Chunk* _3ewg);
1026 MidiRuleLegato();
1027 void UpdateChunks(uint8_t* pData) const;
1028 friend class Instrument;
1029 };
1030
1031 /** @brief MIDI rule to automatically cycle through specified sequences of different articulations.
1032 *
1033 * The instrument must be using the smartmidi dimension.
1034 *
1035 * Note: "Alternator" MIDI rules are neither supported by gigedit nor by
1036 * LinuxSampler. We recommend you using real-time instrument scripts
1037 * instead. Read more about the details and reasons for this in the
1038 * description of the MidiRule base class.
1039 *
1040 * @deprecated Just provided for backward compatiblity, use Script for new
1041 * instruments instead. See description of MidiRule for details.
1042 */
1043 class MidiRuleAlternator : public MidiRule {
1044 public:
1045 uint8_t Articulations; ///< Number of articulations in the instrument
1046 String pArticulations[32]; ///< Names of the articulations
1047
1048 range_t PlayRange; ///< Key range of the playable keys in the instrument
1049
1050 uint8_t Patterns; ///< Number of alternator patterns
1051 struct pattern_t {
1052 String Name; ///< Name of the pattern
1053 int Size; ///< Number of steps in the pattern
1054 const uint8_t& operator[](int i) const { /// Articulation to play
1055 return data[i];
1056 }
1057 uint8_t& operator[](int i) {
1058 return data[i];
1059 }
1060 private:
1061 uint8_t data[32];
1062 } pPatterns[32]; ///< A pattern is a sequence of articulation numbers
1063
1064 typedef enum {
1065 selector_none,
1066 selector_key_switch,
1067 selector_controller
1068 } selector_t;
1069 selector_t Selector; ///< Method by which pattern is chosen
1070 range_t KeySwitchRange; ///< Key range for key switch selector
1071 uint8_t Controller; ///< CC number for controller selector
1072
1073 bool Polyphonic; ///< If alternator should step forward only when all notes are off
1074 bool Chained; ///< If all patterns should be chained together
1075
1076 protected:
1077 MidiRuleAlternator(RIFF::Chunk* _3ewg);
1078 MidiRuleAlternator();
1079 void UpdateChunks(uint8_t* pData) const;
1080 friend class Instrument;
1081 };
1082
1083 /** @brief A MIDI rule not yet implemented by libgig.
1084 *
1085 * This class is currently used as a place holder by libgig for MIDI rule
1086 * types which are not supported by libgig yet.
1087 *
1088 * Note: Support for missing MIDI rule types are probably never added to
1089 * libgig. We recommend you using real-time instrument scripts instead.
1090 * Read more about the details and reasons for this in the description of
1091 * the MidiRule base class.
1092 *
1093 * @deprecated Just provided for backward compatiblity, use Script for new
1094 * instruments instead. See description of MidiRule for details.
1095 */
1096 class MidiRuleUnknown : public MidiRule {
1097 protected:
1098 MidiRuleUnknown() { }
1099 void UpdateChunks(uint8_t* pData) const { }
1100 friend class Instrument;
1101 };
1102
1103 /** @brief Real-time instrument script (gig format extension).
1104 *
1105 * Real-time instrument scripts are user supplied small programs which can
1106 * be used by instrument designers to create custom behaviors and features
1107 * not available in the stock sampler engine. Features which might be very
1108 * exotic or specific for the respective instrument.
1109 *
1110 * This is an extension of the GigaStudio format, thus a feature which was
1111 * not available in the GigaStudio 4 software. It is currently only
1112 * supported by LinuxSampler and gigedit. Scripts will not load with the
1113 * original GigaStudio software.
1114 *
1115 * You find more informations about Instrument Scripts on the LinuxSampler
1116 * documentation site:
1117 *
1118 * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/">About Instrument Scripts in General</a>
1119 * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language">Introduction to the NKSP Script Language</a>
1120 * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language/Reference/">NKSP Reference Manual</a>
1121 * - <a href="http://doc.linuxsampler.org/Gigedit/Managing_Scripts">Using Instrument Scripts with Gigedit</a>
1122 */
1123 class Script {
1124 public:
1125 enum Encoding_t {
1126 ENCODING_ASCII = 0 ///< Standard 8 bit US ASCII character encoding (default).
1127 };
1128 enum Compression_t {
1129 COMPRESSION_NONE = 0 ///< Is not compressed at all (default).
1130 };
1131 enum Language_t {
1132 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.
1133 };
1134
1135 String Name; ///< Arbitrary name of the script, which may be displayed i.e. in an instrument editor.
1136 Compression_t Compression; ///< Whether the script was/should be compressed, and if so, which compression algorithm shall be used.
1137 Encoding_t Encoding; ///< Format the script's source code text is encoded with.
1138 Language_t Language; ///< Programming language and dialect the script is written in.
1139 bool Bypass; ///< Global bypass: if enabled, this script shall not be executed by the sampler for any instrument.
1140
1141 String GetScriptAsText();
1142 void SetScriptAsText(const String& text);
1143 void SetGroup(ScriptGroup* pGroup);
1144 ScriptGroup* GetGroup() const;
1145 void CopyAssign(const Script* orig);
1146 protected:
1147 Script(ScriptGroup* group, RIFF::Chunk* ckScri);
1148 virtual ~Script();
1149 void UpdateChunks(progress_t* pProgress);
1150 void RemoveAllScriptReferences();
1151 friend class ScriptGroup;
1152 friend class Instrument;
1153 private:
1154 ScriptGroup* pGroup;
1155 RIFF::Chunk* pChunk; ///< 'Scri' chunk
1156 std::vector<uint8_t> data;
1157 uint32_t crc; ///< CRC-32 checksum of the raw script data
1158 };
1159
1160 /** @brief Group of instrument scripts (gig format extension).
1161 *
1162 * This class is simply used to sort a bunch of real-time instrument scripts
1163 * into individual groups. This allows instrument designers and script
1164 * developers to keep scripts in a certain order while working with a larger
1165 * amount of scripts in an instrument editor.
1166 *
1167 * This is an extension of the GigaStudio format, thus a feature which was
1168 * not available in the GigaStudio 4 software. It is currently only
1169 * supported by LinuxSampler and gigedit.
1170 */
1171 class ScriptGroup {
1172 public:
1173 String Name; ///< Name of this script group. For example to be displayed in an instrument editor.
1174
1175 Script* GetScript(uint index);
1176 Script* AddScript();
1177 void DeleteScript(Script* pScript);
1178 protected:
1179 ScriptGroup(File* file, RIFF::List* lstRTIS);
1180 virtual ~ScriptGroup();
1181 void LoadScripts();
1182 void UpdateChunks(progress_t* pProgress);
1183 friend class Script;
1184 friend class File;
1185 private:
1186 File* pFile;
1187 RIFF::List* pList; ///< 'RTIS' list chunk
1188 std::list<Script*>* pScripts;
1189 };
1190
1191 /** @brief Provides access to a Gigasampler/GigaStudio instrument.
1192 *
1193 * This class provides access to Gigasampler/GigaStudio instruments
1194 * contained in .gig files. A gig instrument is merely a set of keyboard
1195 * ranges (called Region), plus some additional global informations about
1196 * the instrument. The major part of the actual instrument definition used
1197 * for the synthesis of the instrument is contained in the respective Region
1198 * object (or actually in the respective DimensionRegion object being, see
1199 * description of Region for details).
1200 *
1201 * Since the gig format was designed as extension to the DLS file format,
1202 * this class is derived from the DLS::Instrument class. So also refer to
1203 * DLS::Instrument for additional informations, class attributes and
1204 * methods.
1205 */
1206 class Instrument : protected DLS::Instrument {
1207 public:
1208 // derived attributes from DLS::Resource
1209 using DLS::Resource::pInfo;
1210 using DLS::Resource::pDLSID;
1211 // derived attributes from DLS::Instrument
1212 using DLS::Instrument::IsDrum;
1213 using DLS::Instrument::MIDIBank;
1214 using DLS::Instrument::MIDIBankCoarse;
1215 using DLS::Instrument::MIDIBankFine;
1216 using DLS::Instrument::MIDIProgram;
1217 using DLS::Instrument::Regions;
1218 // own attributes
1219 int32_t Attenuation; ///< in dB
1220 uint16_t EffectSend;
1221 int16_t FineTune; ///< in cents
1222 uint16_t PitchbendRange; ///< Number of semitones pitchbend controller can pitch (default is 2).
1223 bool PianoReleaseMode;
1224 range_t DimensionKeyRange; ///< 0-127 (where 0 means C1 and 127 means G9)
1225
1226
1227 // derived methods from DLS::Resource
1228 using DLS::Resource::GetParent;
1229 // overridden methods
1230 Region* GetFirstRegion();
1231 Region* GetNextRegion();
1232 Region* AddRegion();
1233 void DeleteRegion(Region* pRegion);
1234 void MoveTo(Instrument* dst);
1235 virtual void UpdateChunks(progress_t* pProgress);
1236 virtual void CopyAssign(const Instrument* orig);
1237 // own methods
1238 Region* GetRegion(unsigned int Key);
1239 MidiRule* GetMidiRule(int i);
1240 MidiRuleCtrlTrigger* AddMidiRuleCtrlTrigger();
1241 MidiRuleLegato* AddMidiRuleLegato();
1242 MidiRuleAlternator* AddMidiRuleAlternator();
1243 void DeleteMidiRule(int i);
1244 // real-time instrument script methods
1245 Script* GetScriptOfSlot(uint index);
1246 void AddScriptSlot(Script* pScript, bool bypass = false);
1247 void SwapScriptSlots(uint index1, uint index2);
1248 void RemoveScriptSlot(uint index);
1249 void RemoveScript(Script* pScript);
1250 uint ScriptSlotCount() const;
1251 bool IsScriptSlotBypassed(uint index);
1252 void SetScriptSlotBypassed(uint index, bool bBypass);
1253 protected:
1254 Region* RegionKeyTable[128]; ///< fast lookup for the corresponding Region of a MIDI key
1255
1256 Instrument(File* pFile, RIFF::List* insList, progress_t* pProgress = NULL);
1257 ~Instrument();
1258 void CopyAssign(const Instrument* orig, const std::map<Sample*,Sample*>* mSamples);
1259 void UpdateRegionKeyTable();
1260 void LoadScripts();
1261 void UpdateScriptFileOffsets();
1262 friend class File;
1263 friend class Region; // so Region can call UpdateRegionKeyTable()
1264 private:
1265 struct _ScriptPooolEntry {
1266 uint32_t fileOffset;
1267 bool bypass;
1268 };
1269 struct _ScriptPooolRef {
1270 Script* script;
1271 bool bypass;
1272 };
1273 MidiRule** pMidiRules;
1274 std::vector<_ScriptPooolEntry> scriptPoolFileOffsets;
1275 std::vector<_ScriptPooolRef>* pScriptRefs;
1276 };
1277
1278 /** @brief Group of Gigasampler samples
1279 *
1280 * Groups help to organize a huge collection of Gigasampler samples.
1281 * Groups are not concerned at all for the synthesis, but they help
1282 * sound library developers when working on complex instruments with an
1283 * instrument editor (as long as that instrument editor supports it ;-).
1284 *
1285 * A sample is always assigned to exactly one Group. This also means
1286 * there is always at least one Group in a .gig file, no matter if you
1287 * created one yet or not.
1288 */
1289 class Group {
1290 public:
1291 String Name; ///< Stores the name of this Group.
1292
1293 Sample* GetFirstSample();
1294 Sample* GetNextSample();
1295 void AddSample(Sample* pSample);
1296 protected:
1297 Group(File* file, RIFF::Chunk* ck3gnm);
1298 virtual ~Group();
1299 virtual void UpdateChunks(progress_t* pProgress);
1300 void MoveAll();
1301 friend class File;
1302 private:
1303 File* pFile;
1304 RIFF::Chunk* pNameChunk; ///< '3gnm' chunk
1305 };
1306
1307 /** @brief Provides convenient access to Gigasampler/GigaStudio .gig files.
1308 *
1309 * This is the entry class for accesing a Gigasampler/GigaStudio (.gig) file
1310 * with libgig. It allows you to open existing .gig files, modifying them
1311 * and saving them persistently either under the same file name or under a
1312 * different location.
1313 *
1314 * A .gig file is merely a monolithic file. That means samples and the
1315 * defintion of the virtual instruments are contained in the same file. A
1316 * .gig file contains an arbitrary amount of samples, and an arbitrary
1317 * amount of instruments which are referencing those samples. It is also
1318 * possible to store samples in .gig files not being referenced by any
1319 * instrument. This is not an error from the file format's point of view and
1320 * it is actually often used in practice during the design phase of new gig
1321 * instruments.
1322 *
1323 * So on toplevel of the gig file format you have:
1324 *
1325 * - A set of samples (see Sample).
1326 * - A set of virtual instruments (see Instrument).
1327 *
1328 * And as extension to the original GigaStudio format, we added:
1329 *
1330 * - Real-time instrument scripts (see Script).
1331 *
1332 * Note that the latter however is only supported by libgig, gigedit and
1333 * LinuxSampler. Scripts are not supported by the original GigaStudio
1334 * software.
1335 *
1336 * All released Gigasampler/GigaStudio file format versions are supported
1337 * (so from first Gigasampler version up to including GigaStudio 4).
1338 *
1339 * Since the gig format was designed as extension to the DLS file format,
1340 * this class is derived from the DLS::File class. So also refer to
1341 * DLS::File for additional informations, class attributes and methods.
1342 */
1343 class File : protected DLS::File {
1344 public:
1345 static const DLS::version_t VERSION_2;
1346 static const DLS::version_t VERSION_3;
1347 static const DLS::version_t VERSION_4;
1348
1349 // derived attributes from DLS::Resource
1350 using DLS::Resource::pInfo;
1351 using DLS::Resource::pDLSID;
1352 // derived attributes from DLS::File
1353 using DLS::File::pVersion;
1354 using DLS::File::Instruments;
1355
1356 // derived methods from DLS::Resource
1357 using DLS::Resource::GetParent;
1358 // derived methods from DLS::File
1359 using DLS::File::Save;
1360 using DLS::File::GetFileName;
1361 using DLS::File::SetFileName;
1362 // overridden methods
1363 File();
1364 File(RIFF::File* pRIFF);
1365 Sample* GetFirstSample(progress_t* pProgress = NULL); ///< Returns a pointer to the first <i>Sample</i> object of the file, <i>NULL</i> otherwise.
1366 Sample* GetNextSample(); ///< Returns a pointer to the next <i>Sample</i> object of the file, <i>NULL</i> otherwise.
1367 Sample* GetSample(uint index);
1368 Sample* AddSample();
1369 size_t CountSamples();
1370 void DeleteSample(Sample* pSample);
1371 Instrument* GetFirstInstrument(); ///< Returns a pointer to the first <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
1372 Instrument* GetNextInstrument(); ///< Returns a pointer to the next <i>Instrument</i> object of the file, <i>NULL</i> otherwise.
1373 Instrument* GetInstrument(uint index, progress_t* pProgress = NULL);
1374 Instrument* AddInstrument();
1375 Instrument* AddDuplicateInstrument(const Instrument* orig);
1376 size_t CountInstruments();
1377 void DeleteInstrument(Instrument* pInstrument);
1378 Group* GetFirstGroup(); ///< Returns a pointer to the first <i>Group</i> object of the file, <i>NULL</i> otherwise.
1379 Group* GetNextGroup(); ///< Returns a pointer to the next <i>Group</i> object of the file, <i>NULL</i> otherwise.
1380 Group* GetGroup(uint index);
1381 Group* GetGroup(String name);
1382 Group* AddGroup();
1383 void DeleteGroup(Group* pGroup);
1384 void DeleteGroupOnly(Group* pGroup);
1385 void SetAutoLoad(bool b);
1386 bool GetAutoLoad();
1387 void AddContentOf(File* pFile);
1388 ScriptGroup* GetScriptGroup(uint index);
1389 ScriptGroup* GetScriptGroup(const String& name);
1390 ScriptGroup* AddScriptGroup();
1391 void DeleteScriptGroup(ScriptGroup* pGroup);
1392 virtual ~File();
1393 virtual void UpdateChunks(progress_t* pProgress);
1394 protected:
1395 // overridden protected methods from DLS::File
1396 virtual void LoadSamples();
1397 virtual void LoadInstruments();
1398 virtual void LoadGroups();
1399 virtual void UpdateFileOffsets();
1400 // own protected methods
1401 virtual void LoadSamples(progress_t* pProgress);
1402 virtual void LoadInstruments(progress_t* pProgress);
1403 virtual void LoadScriptGroups();
1404 void SetSampleChecksum(Sample* pSample, uint32_t crc);
1405 uint32_t GetSampleChecksum(Sample* pSample);
1406 uint32_t GetSampleChecksumByIndex(int index);
1407 bool VerifySampleChecksumTable();
1408 bool RebuildSampleChecksumTable();
1409 int GetWaveTableIndexOf(gig::Sample* pSample);
1410 friend class Region;
1411 friend class Sample;
1412 friend class Instrument;
1413 friend class Group; // so Group can access protected member pRIFF
1414 friend class ScriptGroup; // so ScriptGroup can access protected member pRIFF
1415 private:
1416 std::list<Group*>* pGroups;
1417 std::list<Group*>::iterator GroupsIterator;
1418 bool bAutoLoad;
1419 std::list<ScriptGroup*>* pScriptGroups;
1420 };
1421
1422 /**
1423 * Will be thrown whenever a gig specific error occurs while trying to
1424 * access a Gigasampler File. Note: In your application you should
1425 * better catch for RIFF::Exception rather than this one, except you
1426 * explicitly want to catch and handle gig::Exception, DLS::Exception
1427 * and RIFF::Exception independently, which usually shouldn't be
1428 * necessary though.
1429 */
1430 class Exception : public DLS::Exception {
1431 public:
1432 Exception(String format, ...);
1433 Exception(String format, va_list arg);
1434 void PrintMessage();
1435 protected:
1436 Exception();
1437 };
1438
1439 #if HAVE_RTTI
1440 size_t enumCount(const std::type_info& type);
1441 const char* enumKey(const std::type_info& type, size_t value);
1442 bool enumKey(const std::type_info& type, String key);
1443 const char** enumKeys(const std::type_info& type);
1444 #endif // HAVE_RTTI
1445 size_t enumCount(String typeName);
1446 const char* enumKey(String typeName, size_t value);
1447 bool enumKey(String typeName, String key);
1448 const char** enumKeys(String typeName);
1449 size_t enumValue(String key);
1450
1451 String libraryName();
1452 String libraryVersion();
1453
1454 } // namespace gig
1455
1456 #endif // __GIG_H__

  ViewVC Help
Powered by ViewVC