1 /***************************************************************************
2  *                                                                         *
3  *   LinuxSampler - modular, streaming capable sampler                     *
4  *                                                                         *
5  *   Copyright (C) 2008 Anders Dahnielson <anders@dahnielson.com>          *
6  *   Copyright (C) 2009 - 2016 Anders Dahnielson and Grigor Iliev          *
7  *                                                                         *
8  *   This program 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 program 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 program; 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 LIBSFZ_SFZ_H
25 #define LIBSFZ_SFZ_H
26 
27 #include <fstream>
28 #include <iostream>
29 #include <vector>
30 #include <stack>
31 #include <string>
32 #include <stdexcept>
33 
34 #include "../common/SampleFile.h"
35 #include "../common/SampleManager.h"
36 #include "../../common/ArrayList.h"
37 #include "../../common/optional.h"
38 #include "../../common/Exception.h"
39 #include "../../common/Path.h"
40 
41 #define TRIGGER_ATTACK  ((unsigned char) (1 << 0)) // 0x01
42 #define TRIGGER_RELEASE ((unsigned char) (1 << 1)) // 0x02
43 #define TRIGGER_FIRST   ((unsigned char) (1 << 2)) // 0x04
44 #define TRIGGER_LEGATO  ((unsigned char) (1 << 3)) // 0x08
45 
46 #define optional LinuxSampler::optional
47 
48 namespace sfz
49 {
50     // Forward declarations
51     class Articulation;
52     class Region;
53     class Group;
54     class Instrument;
55     class File;
56     class LookupTable;
57     class SampleManager;
58 
59     class Exception : public LinuxSampler::Exception {
60     public:
61     };
62 
63     class Sample : public LinuxSampler::SampleFileBase<Region> {
64         private:
65             int  End;
66             long TotalFrames;
67 
68         public:
69             Sample(String File, bool DontClose = false, uint offset = 0, int end = 0 /* 0 means unspecified */)
70                   : LinuxSampler::SampleFileBase<Region>(File, DontClose)
71             {
72                 Offset = offset;
73                 End = end;
74 
75                 long tfc = LinuxSampler::SampleFileBase<Region>::GetTotalFrameCount();
76                 if (Offset >= tfc) {
77                     std::cerr << "Offset for file '" << this->GetFile() << "' too long (" << Offset << ")" << std::endl;
78                     Offset = 0;
79                 }
80 
81                 if (End == 0 || End > tfc) TotalFrames = tfc;
82                 else if (End == -1 || End < Offset) TotalFrames = 0;
83                 else TotalFrames = End;
84             }
~Sample()85             virtual ~Sample() { }
86 
GetTotalFrameCount()87             virtual long GetTotalFrameCount() { return TotalFrames; }
88 
89             friend class SampleManager;
90     };
91 
92     /** @brief Real-time instrument script (sfz format extension).
93      *
94      * Real-time instrument scripts are user supplied small programs which can
95      * be used by instrument designers to create custom behaviors and features
96      * not available in the stock sampler engine. Features which might be very
97      * exotic or specific for the respective instrument.
98      *
99      * This is an extension of the sfz format, thus a feature which is currently
100      * only supported by LinuxSampler. Scripts will not load with other sfz
101      * players right now. The dedicated sfz opcode for this purpose is:
102      * @code
103      * script=path/to/scriptfile
104      * @endcode
105      * This opcode is recommended to appear in the sfz file's global section,
106      * however ATM the precise location of the opcode is simply ignored.
107      * Currently there may only be one @c script opcode per instrument. Further
108      * @c script opcodes will currently simply be ignored. In future using
109      * multiple @c script opcodes will be supported as well, the scripts will
110      * then be executed by the sampler in the order in which their opcodes
111      * appeared in their sfz file.
112      *
113      * You find more informations about Instrument Scripts on the LinuxSampler
114      * documentation site:
115      *
116      * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/">About Instrument Scripts in General</a>
117      * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language">Introduction to the NKSP Script Language</a>
118      * - <a href="http://doc.linuxsampler.org/Instrument_Scripts/NKSP_Language/Reference/">NKSP Reference Manual</a>
119      */
120     class Script {
121         public:
122             enum Language_t {
123                 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.
124             };
125 
126             Script(LinuxSampler::Path path);
127             Script(String path);
128             virtual ~Script();
129 
130             String     Name() const;    ///< Name of the script (currently returns the file's file name without its path).
131             Language_t Language();      ///< Programming language and dialect the script was written in (currently always returns LANGUAGE_NKSP).
132             String     GetSourceCode(); ///< Reads the script's source code from its script file and returns the entire source code as String.
133         private:
134             LinuxSampler::Path m_path;
135     };
136 
137     // Enumerations
138     enum sw_vel_t    { VEL_CURRENT, VEL_PREVIOUS };
139     enum off_mode_t  { OFF_FAST, OFF_NORMAL };
140     enum loop_mode_t { NO_LOOP, ONE_SHOT, LOOP_CONTINUOUS, LOOP_SUSTAIN, LOOP_UNSET };
141     enum curve_t     { GAIN, POWER };
142     enum filter_t    { LPF_1P, HPF_1P, BPF_1P, BRF_1P, APF_1P,
143                        LPF_2P, HPF_2P, BPF_2P, BRF_2P, PKF_2P,
144                        LPF_4P, HPF_4P,
145                        LPF_6P, HPF_6P };
146 
147     typedef unsigned char trigger_t;
148     typedef unsigned char uint8_t;
149 
150     class SampleManager : public LinuxSampler::SampleManager<Sample, Region> {
151     public:
152         Sample* FindSample(std::string samplePath, uint offset, int end);
153 
154     protected:
OnSampleInUse(Sample * pSample)155         virtual void OnSampleInUse(Sample* pSample) OVERRIDE {
156             pSample->Open();
157         }
158 
OnSampleNotInUse(Sample * pSample)159         virtual void OnSampleNotInUse(Sample* pSample) OVERRIDE {
160             pSample->Close();
161         }
162     };
163 
164     class CC {
165         public:
166             uint8_t   Controller;  ///< MIDI controller number.
167             short int Curve;
168             float     Influence;   ///< Controller Value.
169             float     Smooth;      ///< The speed of parameter change in milliseconds
170             float     Step;
171 
172             CC (
173                 uint8_t   Controller = 0,
174                 float     Influence  = 0,
175                 short int Curve      = -1,
176                 float     Smooth     = 0,
177                 float     Step       = 0
178             ) {
179                 this->Controller = Controller;
180                 this->Influence  = Influence;
181                 this->Curve      = Curve;
182                 this->Smooth     = Smooth;
183                 this->Step       = Step;
184             }
185 
CC(const CC & cc)186             CC(const CC& cc) { Copy(cc); }
187             void operator=(const CC& cc) { Copy(cc); }
188 
Copy(const CC & cc)189             void Copy(const CC& cc) {
190                 Controller = cc.Controller;
191                 Influence  = cc.Influence;
192                 Curve      = cc.Curve;
193                 Smooth     = cc.Smooth;
194                 Step       = cc.Step;
195             }
196     };
197 
198     /////////////////////////////////////////////////////////////
199     // class Articulation
200 
201     // Articulation containing all performance parameters for synthesis
202     class Articulation
203     {
204     public:
205         Articulation();
206         virtual ~Articulation();
207     };
208 
209     class EGNode
210     {
211     public:
212         float time;
213         float level;
214         float shape;
215         float curve;
216         LinuxSampler::ArrayList<CC> time_oncc;
217         LinuxSampler::ArrayList<CC> level_oncc;
218 
219         EGNode();
EGNode(const EGNode & egNode)220         EGNode(const EGNode& egNode) { Copy(egNode); }
221         void operator=(const EGNode& egNode) { Copy(egNode); }
222         void Copy(const EGNode& egNode);
223     };
224 
225     class EqImpl {
226     public:
227         float eq1freq, eq2freq, eq3freq;
228         float eq1bw, eq2bw, eq3bw;
229         float eq1gain, eq2gain, eq3gain;
230         LinuxSampler::ArrayList<CC> eq1freq_oncc;
231         LinuxSampler::ArrayList<CC> eq2freq_oncc;
232         LinuxSampler::ArrayList<CC> eq3freq_oncc;
233         LinuxSampler::ArrayList<CC> eq1bw_oncc;
234         LinuxSampler::ArrayList<CC> eq2bw_oncc;
235         LinuxSampler::ArrayList<CC> eq3bw_oncc;
236         LinuxSampler::ArrayList<CC> eq1gain_oncc;
237         LinuxSampler::ArrayList<CC> eq2gain_oncc;
238         LinuxSampler::ArrayList<CC> eq3gain_oncc;
239 
240         EqImpl();
241 
EqImpl(const EqImpl & eq)242         EqImpl(const EqImpl& eq) { Copy(eq); }
243         void Copy(const EqImpl& eq);
244         bool HasEq();
245     };
246 
247     class EqSmoothStepImpl: public EqImpl {
248     public:
249         LinuxSampler::ArrayList<CC> eq1freq_smoothcc;
250         LinuxSampler::ArrayList<CC> eq2freq_smoothcc;
251         LinuxSampler::ArrayList<CC> eq3freq_smoothcc;
252         LinuxSampler::ArrayList<CC> eq1bw_smoothcc;
253         LinuxSampler::ArrayList<CC> eq2bw_smoothcc;
254         LinuxSampler::ArrayList<CC> eq3bw_smoothcc;
255         LinuxSampler::ArrayList<CC> eq1gain_smoothcc;
256         LinuxSampler::ArrayList<CC> eq2gain_smoothcc;
257         LinuxSampler::ArrayList<CC> eq3gain_smoothcc;
258 
259         LinuxSampler::ArrayList<CC> eq1freq_stepcc;
260         LinuxSampler::ArrayList<CC> eq2freq_stepcc;
261         LinuxSampler::ArrayList<CC> eq3freq_stepcc;
262         LinuxSampler::ArrayList<CC> eq1bw_stepcc;
263         LinuxSampler::ArrayList<CC> eq2bw_stepcc;
264         LinuxSampler::ArrayList<CC> eq3bw_stepcc;
265         LinuxSampler::ArrayList<CC> eq1gain_stepcc;
266         LinuxSampler::ArrayList<CC> eq2gain_stepcc;
267         LinuxSampler::ArrayList<CC> eq3gain_stepcc;
268 
EqSmoothStepImpl()269         EqSmoothStepImpl() { }
EqSmoothStepImpl(const EqSmoothStepImpl & eq)270         EqSmoothStepImpl(const EqSmoothStepImpl& eq) { Copy(eq); }
271 
272         void Copy(const EqSmoothStepImpl& eq);
273         void copySmoothValues();
274         void copyStepValues();
275     };
276 
277     class EG: public EqImpl
278     {
279     public:
280         LinuxSampler::ArrayList<EGNode> node;
281         int sustain;
282         int loop;
283         int loop_count;
284         float amplitude;
285         float volume;
286         float cutoff;
287         int   pitch; // -9600 to 9600 cents
288         float resonance; // 0 to 40 dB
289         float pan; // -100 to 100 %
290         int   pan_curve;
291 
292         LinuxSampler::ArrayList<CC> amplitude_oncc;
293         LinuxSampler::ArrayList<CC> volume_oncc;
294         LinuxSampler::ArrayList<CC> cutoff_oncc; // -9600 to 9600 cents
295         LinuxSampler::ArrayList<CC> pitch_oncc;
296         LinuxSampler::ArrayList<CC> resonance_oncc; // 0 to 40 dB
297         LinuxSampler::ArrayList<CC> pan_oncc; // -100 to 100 %
298         LinuxSampler::ArrayList<CC> pan_curvecc; // used only as temporary buffer during the parsing - values are then moved to pan_oncc
299 
300         EG();
EG(const EG & eg)301         EG(const EG& eg) { Copy(eg); }
302         void operator=(const EG& eg) { Copy(eg); }
303         void Copy(const EG& eg);
304     };
305 
306     class LFO: public EqSmoothStepImpl
307     {
308     public:
309         float delay; // 0 to 100 seconds
310         float freq; // 0 to 20 Hz
311         float fade; // 0 to 100 seconds
312         float phase; // 0 to 360 degrees
313         uint  wave; // 0 to 4294967296
314         float volume; // -144 to 6 dB
315         int   pitch; // -9600 to 9600 cents
316         int   cutoff; // -9600 to 9600 cents
317         float resonance; // 0 to 40 dB
318         float pan; // -100 to 100 %
319 
320         LinuxSampler::ArrayList<CC> delay_oncc; // 0 to 100 seconds
321         LinuxSampler::ArrayList<CC> freq_oncc; // 0 to 20 Hz
322         LinuxSampler::ArrayList<CC> freq_smoothcc; // 0 to ? milliseconds
323         LinuxSampler::ArrayList<CC> freq_stepcc;
324         LinuxSampler::ArrayList<CC> fade_oncc; // 0 to 100 seconds
325         LinuxSampler::ArrayList<CC> phase_oncc; // 0 to 360 degrees
326         LinuxSampler::ArrayList<CC> volume_oncc; // -144 to 6 dB
327         LinuxSampler::ArrayList<CC> volume_smoothcc; // 0 to ? milliseconds
328         LinuxSampler::ArrayList<CC> volume_stepcc;
329         LinuxSampler::ArrayList<CC> pitch_oncc;
330         LinuxSampler::ArrayList<CC> pitch_smoothcc; // 0 to ? milliseconds
331         LinuxSampler::ArrayList<CC> pitch_stepcc;
332         LinuxSampler::ArrayList<CC> pan_oncc; // -100 to 100 %
333         LinuxSampler::ArrayList<CC> pan_smoothcc; // 0 to ? milliseconds
334         LinuxSampler::ArrayList<CC> pan_stepcc;
335         LinuxSampler::ArrayList<CC> cutoff_oncc; // -9600 to 9600 cents
336         LinuxSampler::ArrayList<CC> cutoff_smoothcc; // 0 to ? milliseconds
337         LinuxSampler::ArrayList<CC> cutoff_stepcc;
338         LinuxSampler::ArrayList<CC> resonance_oncc; // 0 to 40 dB
339         LinuxSampler::ArrayList<CC> resonance_smoothcc; // 0 to ? milliseconds
340         LinuxSampler::ArrayList<CC> resonance_stepcc; // 0 to 40 dB
341 
342         LFO();
LFO(const LFO & lfo)343         LFO(const LFO& lfo) { Copy(lfo); }
344         void operator=(const LFO& lfo) { Copy(lfo); }
345         void Copy(const LFO& lfo);
346     };
347 
348     // Fixed size array with copy-on-write semantics
349     template<class T>
350     class Array
351     {
352     private:
353         struct Rep {
354             int refcount;
355             T a[128];
356 
RepRep357             Rep() : refcount(1) { }
releaseRep358             static void release(Rep* rep) {
359                 if (!--rep->refcount) delete rep;
360             }
361         } *ptr;
362     public:
Array()363         Array() : ptr(0) { }
~Array()364         ~Array() { Rep::release(ptr); }
365 
366         Array& operator=(const Array& array) {
367             if (this != &array) {
368                 ptr = array.ptr;
369                 if (ptr) ptr->refcount++;
370             }
371             return *this;
372         }
373 
374         const T& operator[](int i) const { return ptr->a[i]; }
375 
set(int i,const T & v)376         void set(int i, const T& v) {
377             if (!ptr) {
378                 ptr = new Rep;
379             } else if (ptr->refcount > 1 && ptr->a[i] != v) {
380                 Rep* newptr = new Rep(*ptr);
381                 newptr->refcount = 1;
382                 Rep::release(ptr);
383                 ptr = newptr;
384             }
385             ptr->a[i] = v;
386         }
387     };
388 
389     /////////////////////////////////////////////////////////////
390     // class Definition
391 
392     // Base definition used by groups and regions
393     class Definition
394     {
395     public:
396         Definition();
397         virtual ~Definition();
398 
399         // sample definition
400         std::string sample;
401 
402         // input controls
403         int   lochan;    int   hichan;
404         int   lokey;     int   hikey;
405         int   lovel;     int   hivel;
406         Array<int> locc; Array<int> hicc;
407         int   lobend;    int   hibend;
408         float lobpm;     float hibpm;
409         int   lochanaft; int   hichanaft;
410         int   lopolyaft; int   hipolyaft;
411         int   loprog;    int   hiprog;
412         float lorand;    float hirand;
413         float lotimer;   float hitimer;
414 
415         int seq_length;
416         int seq_position;
417 
418         Array<int> start_locc; Array<int> start_hicc;
419         Array<int> stop_locc;  Array<int> stop_hicc;
420 
421         int sw_lokey;    int sw_hikey;
422         int sw_last;
423         int sw_down;
424         int sw_up;
425         int sw_previous;
426         sw_vel_t sw_vel;
427 
428         trigger_t trigger;
429 
430         uint group;
431         uint off_by;
432         off_mode_t off_mode;
433 
434         Array<int> on_locc; Array<int> on_hicc;
435 
436         // sample player
437         optional<int> count;
438         optional<float> delay; optional<float> delay_random; Array<optional<float> > delay_oncc;
439         optional<int> delay_beats; optional<int> stop_beats;
440         optional<int> delay_samples; Array<optional<int> > delay_samples_oncc;
441         int end;
442         optional<float> loop_crossfade;
443         optional<uint> offset; optional<int> offset_random; Array<optional<int> > offset_oncc;
444         loop_mode_t loop_mode;
445         optional<int> loop_start; optional<int> loop_end;
446         optional<int> sync_beats;
447         optional<int> sync_offset;
448 
449         // amplifier
450         float volume;
451         float amplitude;
452         float pan;
453         float width;
454         float position;
455         float amp_keytrack; int amp_keycenter; float amp_veltrack; Array<float> amp_velcurve; float amp_random;
456         float rt_decay;
457         Array<float> gain_oncc;
458         int xfin_lokey; int xfin_hikey;
459         int xfout_lokey; int xfout_hikey;
460         curve_t xf_keycurve;
461         int xfin_lovel; int xfin_hivel;
462         int xfout_lovel; int xfout_hivel;
463         curve_t xf_velcurve;
464         Array<int> xfin_locc; Array<int> xfin_hicc;
465         Array<int> xfout_locc; Array<int> xfout_hicc;
466         curve_t xf_cccurve;
467 
468         // pitch
469         int transpose;
470         int tune;
471         int pitch_keycenter; int pitch_keytrack; int pitch_veltrack; int pitch_random;
472         int bend_up; int bend_down; int bend_step;
473 
474         // filter
475         filter_t fil_type; filter_t fil2_type;
476         optional<float> cutoff; optional<float> cutoff2;
477         LinuxSampler::ArrayList<CC> cutoff_oncc, cutoff2_oncc;
478         LinuxSampler::ArrayList<CC> cutoff_smoothcc, cutoff2_smoothcc;
479         LinuxSampler::ArrayList<CC> cutoff_stepcc, cutoff2_stepcc;
480         LinuxSampler::ArrayList<CC> cutoff_curvecc, cutoff2_curvecc;
481         int cutoff_chanaft; int cutoff2_chanaft;
482         int cutoff_polyaft; int cutoff2_polyaft;
483         float resonance; float resonance2;
484         LinuxSampler::ArrayList<CC> resonance_oncc, resonance2_oncc;
485         LinuxSampler::ArrayList<CC> resonance_smoothcc, resonance2_smoothcc;
486         LinuxSampler::ArrayList<CC> resonance_stepcc, resonance2_stepcc;
487         LinuxSampler::ArrayList<CC> resonance_curvecc, resonance2_curvecc;
488         LinuxSampler::ArrayList<CC> pitch_oncc, pitch_stepcc;
489         LinuxSampler::ArrayList<CC> pitch_smoothcc, pitch_curvecc;
490         int fil_keytrack; int fil2_keytrack;
491         int fil_keycenter; int fil2_keycenter;
492         int fil_veltrack; int fil2_veltrack;
493         int fil_random; int fil2_random;
494 
495         // per voice equalizer
496         float eq1_freq; float eq2_freq; float eq3_freq;
497         Array<float> eq1_freq_oncc; Array<float> eq2_freq_oncc; Array<float> eq3_freq_oncc;
498         float eq1_vel2freq; float eq2_vel2freq; float eq3_vel2freq;
499         float eq1_bw; float eq2_bw; float eq3_bw;
500         Array<float> eq1_bw_oncc; Array<float> eq2_bw_oncc; Array<float> eq3_bw_oncc;
501         float eq1_gain; float eq2_gain; float eq3_gain;
502         Array<float> eq1_gain_oncc; Array<float> eq2_gain_oncc; Array<float> eq3_gain_oncc;
503         float eq1_vel2gain; float eq2_vel2gain; float eq3_vel2gain;
504 
505         //Deprecated (from version 1)
506         float ampeg_delay, ampeg_start, ampeg_attack, ampeg_hold, ampeg_decay, ampeg_sustain, ampeg_release;
507         float ampeg_vel2delay, ampeg_vel2attack, ampeg_vel2hold, ampeg_vel2decay, ampeg_vel2sustain, ampeg_vel2release;
508         LinuxSampler::ArrayList<CC> ampeg_delaycc, ampeg_startcc, ampeg_attackcc, ampeg_holdcc;
509         LinuxSampler::ArrayList<CC> ampeg_decaycc, ampeg_sustaincc, ampeg_releasecc;
510         float fileg_delay, fileg_start, fileg_attack, fileg_hold, fileg_decay, fileg_sustain, fileg_release;
511         float fileg_vel2delay, fileg_vel2attack, fileg_vel2hold, fileg_vel2decay, fileg_vel2sustain, fileg_vel2release;
512         LinuxSampler::ArrayList<CC> fileg_delay_oncc, fileg_start_oncc, fileg_attack_oncc, fileg_hold_oncc;
513         LinuxSampler::ArrayList<CC> fileg_decay_oncc, fileg_sustain_oncc, fileg_release_oncc, fileg_depth_oncc;
514         float pitcheg_delay, pitcheg_start, pitcheg_attack, pitcheg_hold, pitcheg_decay, pitcheg_sustain, pitcheg_release;
515         float pitcheg_vel2delay, pitcheg_vel2attack, pitcheg_vel2hold, pitcheg_vel2decay, pitcheg_vel2sustain, pitcheg_vel2release;
516         int   fileg_depth, pitcheg_depth;
517         LinuxSampler::ArrayList<CC> pitcheg_delay_oncc, pitcheg_start_oncc, pitcheg_attack_oncc, pitcheg_hold_oncc;
518         LinuxSampler::ArrayList<CC> pitcheg_decay_oncc, pitcheg_sustain_oncc, pitcheg_release_oncc, pitcheg_depth_oncc;
519         float amplfo_delay, amplfo_fade, amplfo_freq, amplfo_depth;
520         float fillfo_delay, fillfo_fade, fillfo_freq, fillfo_depth;
521         float pitchlfo_delay, pitchlfo_fade, pitchlfo_freq;
522         int pitchlfo_depth;
523 
524         LinuxSampler::ArrayList<CC> pitchlfo_delay_oncc; // 0 to 100 seconds
525         LinuxSampler::ArrayList<CC> pitchlfo_fade_oncc; // 0 to 100 seconds
526         LinuxSampler::ArrayList<CC> pitchlfo_depthcc; // -1200 to 1200 cents
527         LinuxSampler::ArrayList<CC> pitchlfo_freqcc; // 0 to 20 Hz
528         LinuxSampler::ArrayList<CC> fillfo_delay_oncc; // 0 to 100 seconds
529         LinuxSampler::ArrayList<CC> fillfo_fade_oncc; // 0 to 100 seconds
530         LinuxSampler::ArrayList<CC> fillfo_depthcc;  // -1200 to 1200 cents
531         LinuxSampler::ArrayList<CC> fillfo_freqcc;   // 0 to 20 Hz
532         LinuxSampler::ArrayList<CC> amplfo_delay_oncc; // 0 to 100 seconds
533         LinuxSampler::ArrayList<CC> amplfo_fade_oncc; // 0 to 100 seconds
534         LinuxSampler::ArrayList<CC> amplfo_depthcc;  // -10 to 10 dB
535         LinuxSampler::ArrayList<CC> amplfo_freqcc;   // 0 to 20 Hz
536 
537         // envelope generators
538         LinuxSampler::ArrayList<EG> eg;
539 
540         // low frequency oscillators
541         LinuxSampler::ArrayList<LFO> lfos;
542 
543         LinuxSampler::ArrayList<CC> volume_oncc;
544         LinuxSampler::ArrayList<CC> volume_curvecc; // used only as temporary buffer during the parsing - values are then moved to volume_oncc
545         LinuxSampler::ArrayList<CC> volume_smoothcc; // used only as temporary buffer during the parsing - values are then moved to volume_oncc
546         LinuxSampler::ArrayList<CC> volume_stepcc; // used only as temporary buffer during the parsing - values are then moved to volume_oncc
547 
548         LinuxSampler::ArrayList<CC> pan_oncc; // -100 to 100 %
549         LinuxSampler::ArrayList<CC> pan_curvecc; // used only as temporary buffer during the parsing - values are then moved to pan_oncc
550         LinuxSampler::ArrayList<CC> pan_smoothcc; // used only as temporary buffer during the parsing - values are then moved to pan_oncc
551         LinuxSampler::ArrayList<CC> pan_stepcc; // used only as temporary buffer during the parsing - values are then moved to pan_oncc
552     };
553 
554     class Query {
555     public:
556         uint8_t chan;        // MIDI channel
557         uint8_t key;         // MIDI note
558         uint8_t vel;         // MIDI velocity
559         int bend;            // MIDI pitch bend
560         uint8_t bpm;         // host BPM
561         uint8_t chanaft;     // MIDI channel pressure
562         uint8_t polyaft;     // MIDI polyphonic aftertouch
563         uint8_t prog;        // MIDI program change
564         float rand;          // generated random number
565         trigger_t trig;      // how it was triggered
566         uint8_t* cc;         // all 128 CC values
567         float timer;         // time since previous region in the group was triggered
568         bool* sw;            // state of region key switches, 128 possible values
569         uint8_t last_sw_key; // last key pressed in the key switch range
570         uint8_t prev_sw_key; // previous note value
571 
572         void search(const Instrument* pInstrument);
573         void search(const Instrument* pInstrument, int triggercc);
574         Region* next();
575     private:
576         LinuxSampler::ArrayList<Region*>* pRegionList;
577         int regionIndex;
578     };
579 
580     /////////////////////////////////////////////////////////////
581     // class Region
582 
583     /// Defines Region information of an Instrument
584     class Region :
585         public Definition
586     {
587     public:
588         Region();
589         virtual ~Region();
590 
591         Sample* pSample;
592         Sample* GetSample(bool create = true);
593         void DestroySampleIfNotUsed();
594 
GetParent()595         Region*      GetParent() { return this; }; // needed by EngineBase
GetInstrument()596         Instrument*  GetInstrument() { return pInstrument; }
SetInstrument(Instrument * pInstrument)597         void         SetInstrument(Instrument* pInstrument) { this->pInstrument = pInstrument; }
598 
599         bool HasLoop();
600         uint GetLoopStart();
601         uint GetLoopEnd();
602         uint GetLoopCount();
603 
604         /// Return true if region is triggered by key. Region is
605         /// assumed to come from a search in the lookup table.
606         bool OnKey(const Query& q);
607 
608         /// Return an articulation for the current state
609         Articulation* GetArticulation(int bend, uint8_t bpm, uint8_t chanaft, uint8_t polyaft, uint8_t* cc);
610 
611         // unique region id
612         int id;
613 
614     private:
615         Instrument* pInstrument;
616         int seq_counter;
617     };
618 
619     class Curve {
620         public:
621             float v[128];
Curve()622             Curve() { for (int i = 0; i < 128; i++) v[i] = 0; }
Curve(const Curve & curve)623             Curve(const Curve& curve) { Copy(curve); }
624             void operator=(const Curve& curve) { Copy(curve); }
Copy(const Curve & curve)625             void Copy(const Curve& curve) { for (int i = 0; i < 128; i++) v[i] = curve.v[i]; }
626     };
627 
628     /////////////////////////////////////////////////////////////
629     // class Instrument
630 
631     /// Provides all necessary information for the synthesis of an Instrument
632     class Instrument : public SampleManager
633     {
634     public:
635         Instrument(std::string name = "Unknown", SampleManager* pSampleManager = NULL);
636         virtual ~Instrument();
637 
GetName()638         std::string GetName() { return name; }
GetSampleManager()639         SampleManager* GetSampleManager() { return pSampleManager; }
640 
641         bool DestroyRegion(Region* pRegion);
642         bool HasKeyBinding(uint8_t key);
643         bool HasKeySwitchBinding(uint8_t key);
644 
645         /// List of Regions belonging to this Instrument
646         std::vector<Region*> regions;
647         ::LinuxSampler::ArrayList<Curve> curves;
648         std::vector<Script> scripts;
649         std::map<uint8_t,uint8_t> initialCCValues;
650 
651         friend class File;
652         friend class Query;
653 
654     private:
655         std::string name;
656         std::vector<bool> KeyBindings;
657         std::vector<bool> KeySwitchBindings;
658         SampleManager* pSampleManager;
659         LookupTable* pLookupTable;
660         LookupTable* pLookupTableCC[128];
661     };
662 
663     /////////////////////////////////////////////////////////////
664     // class ContainerDefinition
665 
666     ///A ContainerDefinition is any section of the SFZ files that contains other Definitions (global, master, and group).
667     class ContainerDefinition :
668         public Definition
669     {
670     public:
671         enum section_type {GROUP = 0, MASTER, GLOBAL};
672 
673         ContainerDefinition(section_type type);
674         virtual ~ContainerDefinition();
675 
676         /// Reset all properties to default values
677         void Reset();
678 
679         /// Copy all properties of this object to another Definition
680         void CopyValuesToDefinition(Definition* definition);
681 
682         section_type level;
683     };
684 
685     /////////////////////////////////////////////////////////////
686     // class File
687 
688     /// Parses SFZ files and provides abstract access to the data
689     class File
690     {
691     public:
692         static void copyCurves(LinuxSampler::ArrayList<CC>& curves, LinuxSampler::ArrayList<CC>& dest);
693         static void copySmoothValues(LinuxSampler::ArrayList<CC>& smooths, LinuxSampler::ArrayList<CC>& dest);
694         static void copyStepValues(LinuxSampler::ArrayList<CC>& steps, LinuxSampler::ArrayList<CC>& dest);
695 
696         /// Load an existing SFZ file
697         File(std::string file, SampleManager* pSampleManager = NULL);
698         void parseFile(std::string file, SampleManager* pSampleManager);
699         virtual ~File();
700 
701         /// Returns a pointer to the instrument object
702         Instrument* GetInstrument();
703 
704     private:
705         void  push_header(std::string token);
706         void  push_opcode(std::string token);
707         int parseKey(const std::string& value);
708         EG& eg(int x);
709         EGNode& egnode(int x, int y);
710         LFO& lfo(int x);
711 
712         int   ToInt(const std::string& s) throw(LinuxSampler::Exception);
713         float ToFloat(const std::string& s) throw(LinuxSampler::Exception);
714 
715         int currentLine;
716         std::string currentDir;
717         /// Pointer to the Instrument belonging to this file
718         Instrument* _instrument;
719 
720         // state variables
721         enum section_t { UNKNOWN, REGION, GROUP, MASTER, GLOBAL, CONTROL, CURVE };
722         section_t _current_section;
723         Region* _current_region;
724         std::stack<ContainerDefinition*> _current_containers;
725 
726         static const std::string MACRO_NAME_CHARS;
727         static const std::string MACRO_VALUE_CHARS;
728         std::map<std::string, std::string> _defined_macros;
729 
730         Curve* _current_curve;
731         Definition* pCurDef;
732         int id;
733 
734         // control header directives
735         std::string default_path;
736         int octave_offset;
737         int note_offset;
738     };
739 
740 } // !namespace sfz
741 
742 #endif // !LIBSFZ_SFZ_H
743