/[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 2221 - (show annotations) (download) (as text)
Thu Jul 28 17:17:42 2011 UTC (12 years, 8 months ago) by iliev
File MIME type: text/x-c++hdr
File size: 18873 byte(s)
* sfz engine: implemented opcodes pitchlfo_delay, pitchlfo_freq,
  pitchlfo_depth, fillfo_delay, fillfo_freq, fillfo_depth,
  amplfo_delay, amplfo_freq, amplfo_depth

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

Properties

Name Value
svn:executable *

  ViewVC Help
Powered by ViewVC