/[svn]/linuxsampler/trunk/src/engines/sfz/sfz.h
ViewVC logotype

Contents of /linuxsampler/trunk/src/engines/sfz/sfz.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2232 - (show annotations) (download) (as text)
Mon Aug 8 13:40:04 2011 UTC (6 years, 11 months ago) by iliev
File MIME type: text/x-c++hdr
File size: 22222 byte(s)
* sfz engine: implemented opcode volume_smoothccN

1 /***************************************************************************
2 * *
3 * LinuxSampler - modular, streaming capable sampler *
4 * *
5 * Copyright (C) 2008 Anders Dahnielson <anders@dahnielson.com> *
6 * Copyright (C) 2009 - 2011 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 <string>
31 #include <stdexcept>
32
33 #include "../common/SampleFile.h"
34 #include "../common/SampleManager.h"
35 #include "../../common/ArrayList.h"
36
37 #define TRIGGER_ATTACK ((unsigned char) (1 << 0)) // 0x01
38 #define TRIGGER_RELEASE ((unsigned char) (1 << 1)) // 0x02
39 #define TRIGGER_FIRST ((unsigned char) (1 << 2)) // 0x04
40 #define TRIGGER_LEGATO ((unsigned char) (1 << 3)) // 0x08
41
42 namespace sfz
43 {
44 // Forward declarations
45 class Articulation;
46 class Region;
47 class Group;
48 class Instrument;
49 class File;
50 class LookupTable;
51
52 class Sample : public LinuxSampler::SampleFileBase<Region> {
53 public:
54 Sample(String File, bool DontClose = false, uint offset = 0): LinuxSampler::SampleFileBase<Region>(File, DontClose) {
55 Offset = offset;
56 }
57 virtual ~Sample() { }
58 };
59
60 // Enumerations
61 enum sw_vel_t { VEL_CURRENT, VEL_PREVIOUS };
62 enum off_mode_t { OFF_FAST, OFF_NORMAL };
63 enum loop_mode_t { NO_LOOP, ONE_SHOT, LOOP_CONTINUOUS, LOOP_SUSTAIN, LOOP_UNSET };
64 enum curve_t { GAIN, POWER };
65 enum filter_t { LPF_1P, HPF_1P, BPF_1P, BRF_1P, APF_1P,
66 LPF_2P, HPF_2P, BPF_2P, BRF_2P, PKF_2P,
67 LPF_4P, HPF_4P,
68 LPF_6P, HPF_6P };
69
70 typedef unsigned char trigger_t;
71 typedef unsigned char uint8_t;
72
73 class SampleManager : public LinuxSampler::SampleManager<Sample, Region> {
74 public:
75 Sample* FindSample(std::string samplePath, int offset);
76
77 protected:
78 virtual void OnSampleInUse(Sample* pSample) {
79 pSample->Open();
80 }
81
82 virtual void OnSampleInNotUse(Sample* pSample) {
83 pSample->Close();
84 }
85 };
86
87 class CC {
88 public:
89 uint8_t Controller; ///< MIDI controller number.
90 short int Curve;
91 float Influence; ///< Controller Value.
92 float Smooth; ///< The speed of parameter change in milliseconds
93
94 CC(uint8_t Controller = 0, float Influence = 0.0f, short int Curve = -1, float Smooth = 0) {
95 this->Controller = Controller;
96 this->Influence = Influence;
97 this->Curve = Curve;
98 this->Smooth = Smooth;
99 }
100
101 CC(const CC& cc) { Copy(cc); }
102 void operator=(const CC& cc) { Copy(cc); }
103
104 void Copy(const CC& cc) {
105 Controller = cc.Controller;
106 Influence = cc.Influence;
107 Curve = cc.Curve;
108 Smooth = cc.Smooth;
109 }
110 };
111
112 /////////////////////////////////////////////////////////////
113 // class Exception
114
115 class Exception :
116 public std::runtime_error
117 {
118 public:
119 Exception(const std::string& msg) :
120 runtime_error(msg)
121 {
122 }
123
124 std::string Message()
125 {
126 return what();
127 }
128
129 void PrintMessage()
130 {
131 std::cerr << what() << std::endl << std::flush;
132 }
133 };
134
135 /////////////////////////////////////////////////////////////
136 // class optional
137
138 // Handy class nicked from LinuxSampler...
139 // Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck
140 // Copyright (C) 2005, 2006 Christian Schoenebeck
141
142 class optional_base
143 {
144 public:
145 class nothing_t { public: nothing_t() {} };
146 static const nothing_t nothing;
147 };
148
149 template<class T>
150 class optional :
151 public optional_base
152 {
153 public:
154 optional()
155 {
156 initialized = false;
157 }
158
159 optional(T data)
160 {
161 this->data = data;
162 initialized = true;
163 }
164
165 optional(nothing_t)
166 {
167 initialized = false;
168 }
169
170 template <class T_inner>
171 optional(T_inner data)
172 {
173 this->data = T(data);
174 initialized = true;
175 }
176
177 const T& get() const throw (Exception)
178 {
179 if (!initialized) throw Exception("optional variable not initialized");
180 return data;
181 }
182
183 T& get() throw (Exception)
184 {
185 if (!initialized) throw Exception("optional variable not initialized");
186 return data;
187 }
188
189 void unset()
190 {
191 initialized = false;
192 }
193
194 optional& operator =(const optional& arg) throw (Exception)
195 {
196 if (!arg.initialized) {
197 initialized = false;
198 } else {
199 this->data = arg.data;
200 initialized = true;
201 }
202 return *this;
203 }
204
205 optional& operator =(const T& arg)
206 {
207 this->data = arg;
208 initialized = true;
209 return *this;
210 }
211
212 const T& operator *() const throw (Exception) { return get(); }
213 T& operator *() throw (Exception) { return get(); }
214
215 const T* operator ->() const throw (Exception)
216 {
217 if (!initialized) throw Exception("optional variable not initialized");
218 return &data;
219 }
220
221 T* operator ->() throw (Exception)
222 {
223 if (!initialized) throw Exception("optional variable not initialized");
224 return &data;
225 }
226
227 operator bool() const { return initialized; }
228 bool operator !() const { return !initialized; }
229
230 protected:
231 T data;
232 bool initialized;
233 };
234
235 /////////////////////////////////////////////////////////////
236 // class Articulation
237
238 // Articulation containing all performance parameters for synthesis
239 class Articulation
240 {
241 public:
242 Articulation();
243 virtual ~Articulation();
244 };
245
246 class EGNode
247 {
248 public:
249 float time;
250 float level;
251 float shape;
252 float curve;
253 LinuxSampler::ArrayList<CC> time_oncc;
254 LinuxSampler::ArrayList<CC> level_oncc;
255
256 EGNode();
257 EGNode(const EGNode& egNode) { Copy(egNode); }
258 void operator=(const EGNode& egNode) { Copy(egNode); }
259 void Copy(const EGNode& egNode);
260 };
261
262 class EG
263 {
264 public:
265 LinuxSampler::ArrayList<EGNode> node;
266 int sustain;
267 int loop;
268 int loop_count;
269 float amplitude;
270 float cutoff;
271 EG();
272 EG(const EG& eg) { Copy(eg); }
273 void operator=(const EG& eg) { Copy(eg); }
274 void Copy(const EG& eg);
275 };
276
277 class LFO
278 {
279 public:
280 float delay; // 0 to 100 seconds
281 float freq; // 0 to 20 Hz
282 float fade; // 0 to 100 seconds
283 float phase; // 0 to 360 degrees
284 uint wave; // 0 to 4294967296
285 float volume; // -144 to 6 dB
286 int pitch; // -9600 to 9600 cents
287 int cutoff; // -9600 to 9600 cents
288 float resonance; // 0 to 40 dB
289 float pan; // -100 to 100 %
290
291 LinuxSampler::ArrayList<CC> freq_oncc; // 0 to 20 Hz
292 LinuxSampler::ArrayList<CC> fade_oncc; // 0 to 100 seconds
293 LinuxSampler::ArrayList<CC> phase_oncc; // 0 to 360 degrees
294 LinuxSampler::ArrayList<CC> pitch_oncc;
295
296 LFO();
297 LFO(const LFO& lfo) { Copy(lfo); }
298 void operator=(const LFO& lfo) { Copy(lfo); }
299 void Copy(const LFO& lfo);
300 };
301
302 // Fixed size array with copy-on-write semantics
303 template<class T>
304 class Array
305 {
306 private:
307 struct Rep {
308 int refcount;
309 T a[128];
310
311 Rep() : refcount(1) { }
312 static void release(Rep* rep) {
313 if (!--rep->refcount) delete rep;
314 }
315 } *ptr;
316 public:
317 Array() : ptr(0) { }
318 ~Array() { Rep::release(ptr); }
319
320 Array& operator=(const Array& array) {
321 if (this != &array) {
322 ptr = array.ptr;
323 if (ptr) ptr->refcount++;
324 }
325 return *this;
326 }
327
328 const T& operator[](int i) const { return ptr->a[i]; }
329
330 void set(int i, const T& v) {
331 if (!ptr) {
332 ptr = new Rep;
333 } else if (ptr->refcount > 1 && ptr->a[i] != v) {
334 Rep* newptr = new Rep(*ptr);
335 newptr->refcount = 1;
336 Rep::release(ptr);
337 ptr = newptr;
338 }
339 ptr->a[i] = v;
340 }
341 };
342
343 /////////////////////////////////////////////////////////////
344 // class Definition
345
346 // Base definition used by groups and regions
347 class Definition
348 {
349 public:
350 Definition();
351 virtual ~Definition();
352
353 // sample definition
354 std::string sample;
355
356 // input controls
357 int lochan; int hichan;
358 int lokey; int hikey;
359 int lovel; int hivel;
360 Array<int> locc; Array<int> hicc;
361 int lobend; int hibend;
362 float lobpm; float hibpm;
363 int lochanaft; int hichanaft;
364 int lopolyaft; int hipolyaft;
365 int loprog; int hiprog;
366 float lorand; float hirand;
367 float lotimer; float hitimer;
368
369 int seq_length;
370 int seq_position;
371
372 Array<int> start_locc; Array<int> start_hicc;
373 Array<int> stop_locc; Array<int> stop_hicc;
374
375 int sw_lokey; int sw_hikey;
376 int sw_last;
377 int sw_down;
378 int sw_up;
379 int sw_previous;
380 sw_vel_t sw_vel;
381
382 trigger_t trigger;
383
384 uint group;
385 uint off_by;
386 off_mode_t off_mode;
387
388 Array<int> on_locc; Array<int> on_hicc;
389
390 // sample player
391 optional<int> count;
392 optional<float> delay; optional<float> delay_random; Array<optional<float> > delay_oncc;
393 optional<int> delay_beats; optional<int> stop_beats;
394 optional<int> delay_samples; Array<optional<int> > delay_samples_oncc;
395 optional<int> end;
396 optional<float> loop_crossfade;
397 optional<int> offset; optional<int> offset_random; Array<optional<int> > offset_oncc;
398 loop_mode_t loop_mode;
399 optional<int> loop_start; optional<int> loop_end;
400 optional<int> sync_beats;
401 optional<int> sync_offset;
402
403 // amplifier
404 float volume;
405 float pan;
406 float width;
407 float position;
408 float amp_keytrack; int amp_keycenter; float amp_veltrack; Array<float> amp_velcurve; float amp_random;
409 float rt_decay;
410 Array<float> gain_oncc;
411 int xfin_lokey; int xfin_hikey;
412 int xfout_lokey; int xfout_hikey;
413 curve_t xf_keycurve;
414 int xfin_lovel; int xfin_hivel;
415 int xfout_lovel; int xfout_hivel;
416 curve_t xf_velcurve;
417 Array<int> xfin_locc; Array<int> xfin_hicc;
418 Array<int> xfout_locc; Array<int> xfout_hicc;
419 curve_t xf_cccurve;
420
421 // pitch
422 int transpose;
423 int tune;
424 int pitch_keycenter; int pitch_keytrack; int pitch_veltrack; int pitch_random;
425 int bend_up; int bend_down; int bend_step;
426
427 // filter
428 filter_t fil_type; filter_t fil2_type;
429 optional<float> cutoff; optional<float> cutoff2;
430 Array<int> cutoff_oncc; Array<int> cutoff2_oncc;
431 int cutoff_cc; // TODO: this is just a temporary fix to avoid
432 // looping through the cutoff_oncc array
433 Array<int> cutoff_smoothcc; Array<int> cutoff2_smoothcc;
434 Array<int> cutoff_stepcc; Array<int> cutoff2_stepcc;
435 Array<int> cutoff_curvecc; Array<int> cutoff2_curvecc;
436 int cutoff_chanaft; int cutoff2_chanaft;
437 int cutoff_polyaft; int cutoff2_polyaft;
438 float resonance; float resonance2;
439 Array<int> resonance_oncc; Array<int> resonance2_oncc;
440 Array<int> resonance_smoothcc; Array<int> resonance2_smoothcc;
441 Array<int> resonance_stepcc; Array<int> resonance2_stepcc;
442 Array<int> resonance_curvecc; Array<int> resonance2_curvecc;
443 int fil_keytrack; int fil2_keytrack;
444 int fil_keycenter; int fil2_keycenter;
445 int fil_veltrack; int fil2_veltrack;
446 int fil_random; int fil2_random;
447
448 // per voice equalizer
449 float eq1_freq; float eq2_freq; float eq3_freq;
450 Array<float> eq1_freq_oncc; Array<float> eq2_freq_oncc; Array<float> eq3_freq_oncc;
451 float eq1_vel2freq; float eq2_vel2freq; float eq3_vel2freq;
452 float eq1_bw; float eq2_bw; float eq3_bw;
453 Array<float> eq1_bw_oncc; Array<float> eq2_bw_oncc; Array<float> eq3_bw_oncc;
454 float eq1_gain; float eq2_gain; float eq3_gain;
455 Array<float> eq1_gain_oncc; Array<float> eq2_gain_oncc; Array<float> eq3_gain_oncc;
456 float eq1_vel2gain; float eq2_vel2gain; float eq3_vel2gain;
457
458 //Deprecated (from version 1)
459 float ampeg_delay, ampeg_start, ampeg_attack, ampeg_hold, ampeg_decay, ampeg_sustain, ampeg_release;
460 float ampeg_vel2delay, ampeg_vel2attack, ampeg_vel2hold, ampeg_vel2decay, ampeg_vel2sustain, ampeg_vel2release;
461 LinuxSampler::ArrayList<CC> ampeg_delaycc, ampeg_startcc, ampeg_attackcc, ampeg_holdcc;
462 LinuxSampler::ArrayList<CC> ampeg_decaycc, ampeg_sustaincc, ampeg_releasecc;
463 float fileg_delay, fileg_start, fileg_attack, fileg_hold, fileg_decay, fileg_sustain, fileg_release;
464 float fileg_vel2delay, fileg_vel2attack, fileg_vel2hold, fileg_vel2decay, fileg_vel2sustain, fileg_vel2release;
465 float pitcheg_delay, pitcheg_start, pitcheg_attack, pitcheg_hold, pitcheg_decay, pitcheg_sustain, pitcheg_release;
466 float pitcheg_vel2delay, pitcheg_vel2attack, pitcheg_vel2hold, pitcheg_vel2decay, pitcheg_vel2sustain, pitcheg_vel2release;
467 int fileg_depth, pitcheg_depth;
468 float amplfo_delay, amplfo_fade, amplfo_freq, amplfo_depth;
469 float fillfo_delay, fillfo_fade, fillfo_freq, fillfo_depth;
470 float pitchlfo_delay, pitchlfo_fade, pitchlfo_freq;
471 int pitchlfo_depth;
472 Array<int> pitchlfo_depthcc;
473
474 LinuxSampler::ArrayList<CC> pitchlfo_freqcc; // 0 to 20 Hz
475 LinuxSampler::ArrayList<CC> fillfo_freqcc; // 0 to 20 Hz
476 LinuxSampler::ArrayList<CC> amplfo_freqcc; // 0 to 20 Hz
477
478 // envelope generators
479 LinuxSampler::ArrayList<EG> eg;
480
481 // low frequency oscillators
482 LinuxSampler::ArrayList<LFO> lfos;
483
484 LinuxSampler::ArrayList<CC> volume_oncc;
485 LinuxSampler::ArrayList<CC> volume_curvecc; // used only as temporary buffer during the parsing - values are then moved to volume_oncc
486 LinuxSampler::ArrayList<CC> volume_smoothcc; // used only as temporary buffer during the parsing - values are then moved to volume_oncc
487 };
488
489 class Query {
490 public:
491 uint8_t chan; // MIDI channel
492 uint8_t key; // MIDI note
493 uint8_t vel; // MIDI velocity
494 int bend; // MIDI pitch bend
495 uint8_t bpm; // host BPM
496 uint8_t chanaft; // MIDI channel pressure
497 uint8_t polyaft; // MIDI polyphonic aftertouch
498 uint8_t prog; // MIDI program change
499 float rand; // generated random number
500 trigger_t trig; // how it was triggered
501 uint8_t* cc; // all 128 CC values
502 float timer; // time since previous region in the group was triggered
503 bool* sw; // state of region key switches, 128 possible values
504 uint8_t last_sw_key; // last key pressed in the key switch range
505 uint8_t prev_sw_key; // previous note value
506
507 void search(const Instrument* pInstrument);
508 void search(const Instrument* pInstrument, int triggercc);
509 Region* next();
510 private:
511 LinuxSampler::ArrayList<Region*>* pRegionList;
512 int regionIndex;
513 };
514
515 /////////////////////////////////////////////////////////////
516 // class Region
517
518 /// Defines Region information of an Instrument
519 class Region :
520 public Definition
521 {
522 public:
523 Region();
524 virtual ~Region();
525
526 Sample* pSample;
527 Sample* GetSample(bool create = true);
528 void DestroySampleIfNotUsed();
529
530 Region* GetParent() { return this; }; // needed by EngineBase
531 Instrument* GetInstrument() { return pInstrument; }
532 void SetInstrument(Instrument* pInstrument) { this->pInstrument = pInstrument; }
533
534 bool HasLoop();
535 uint GetLoopStart();
536 uint GetLoopEnd();
537 uint GetLoopCount();
538
539 /// Return true if region is triggered by key. Region is
540 /// assumed to come from a search in the lookup table.
541 bool OnKey(const Query& q);
542
543 /// Return an articulation for the current state
544 Articulation* GetArticulation(int bend, uint8_t bpm, uint8_t chanaft, uint8_t polyaft, uint8_t* cc);
545
546 // unique region id
547 int id;
548
549 private:
550 Instrument* pInstrument;
551 int seq_counter;
552 };
553
554 class Curve {
555 public:
556 float v[128];
557 Curve() { for (int i = 0; i < 128; i++) v[i] = 0; }
558 Curve(const Curve& curve) { Copy(curve); }
559 void operator=(const Curve& curve) { Copy(curve); }
560 void Copy(const Curve& curve) { for (int i = 0; i < 128; i++) v[i] = curve.v[i]; }
561 };
562
563 /////////////////////////////////////////////////////////////
564 // class Instrument
565
566 /// Provides all neccessary information for the synthesis of an Instrument
567 class Instrument : public SampleManager
568 {
569 public:
570 Instrument(std::string name = "Unknown", SampleManager* pSampleManager = NULL);
571 virtual ~Instrument();
572
573 std::string GetName() { return name; }
574 SampleManager* GetSampleManager() { return pSampleManager; }
575
576 bool DestroyRegion(Region* pRegion);
577 bool HasKeyBinding(uint8_t key);
578 bool HasKeySwitchBinding(uint8_t key);
579
580 /// List of Regions belonging to this Instrument
581 std::vector<Region*> regions;
582 ::LinuxSampler::ArrayList<Curve> curves;
583
584 friend class File;
585 friend class Query;
586
587 private:
588 std::string name;
589 std::vector<bool> KeyBindings;
590 std::vector<bool> KeySwitchBindings;
591 SampleManager* pSampleManager;
592 LookupTable* pLookupTable;
593 LookupTable* pLookupTableCC[128];
594 };
595
596 /////////////////////////////////////////////////////////////
597 // class Group
598
599 /// A Group act just as a template containing Region default values
600 class Group :
601 public Definition
602 {
603 public:
604 Group();
605 virtual ~Group();
606
607 /// Reset Group to default values
608 void Reset();
609
610 /// Create a new Region
611 Region* RegionFactory();
612
613 // id counter
614 int id;
615
616 };
617
618 /////////////////////////////////////////////////////////////
619 // class File
620
621 /// Parses SFZ files and provides abstract access to the data
622 class File
623 {
624 public:
625 /// Load an existing SFZ file
626 File(std::string file, SampleManager* pSampleManager = NULL);
627 virtual ~File();
628
629 /// Returns a pointer to the instrument object
630 Instrument* GetInstrument();
631
632 private:
633 void push_header(std::string token);
634 void push_opcode(std::string token);
635 int parseKey(const std::string& value);
636 EG& eg(int x);
637 EGNode& egnode(int x, int y);
638 LFO& lfo(int x);
639 void copyCurves(LinuxSampler::ArrayList<CC>& curves, LinuxSampler::ArrayList<CC>& dest);
640 void copySmoothValues(LinuxSampler::ArrayList<CC>& smooths, LinuxSampler::ArrayList<CC>& dest);
641
642 std::string currentDir;
643 /// Pointer to the Instrument belonging to this file
644 Instrument* _instrument;
645
646 // state variables
647 enum section_t { UNKNOWN, GROUP, REGION, CONTROL, CURVE };
648 section_t _current_section;
649 Region* _current_region;
650 Group* _current_group;
651 Curve* _current_curve;
652 Definition* pCurDef;
653
654 // control header directives
655 std::string default_path;
656 int octave_offset;
657 int note_offset;
658 };
659
660 } // !namespace sfz
661
662 #endif // !LIBSFZ_SFZ_H

Properties

Name Value
svn:executable *

  ViewVC Help
Powered by ViewVC