/[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 2218 - (show annotations) (download) (as text)
Thu Jul 28 08:05:57 2011 UTC (12 years, 8 months ago) by iliev
File MIME type: text/x-c++hdr
File size: 18674 byte(s)
* sfz engine: use the newly introduced signal units model

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 int pitch; // -9600 to 9600 cents
250 int cutoff; // -9600 to 9600 cents
251 float resonance; // 0 to 40 dB
252 float pan; // -100 to 100 %
253 LFO();
254 };
255
256 // Fixed size array with copy-on-write semantics
257 template<class T>
258 class Array
259 {
260 private:
261 struct Rep {
262 int refcount;
263 T a[128];
264
265 Rep() : refcount(1) { }
266 static void release(Rep* rep) {
267 if (!--rep->refcount) delete rep;
268 }
269 } *ptr;
270 public:
271 Array() : ptr(0) { }
272 ~Array() { Rep::release(ptr); }
273
274 Array& operator=(const Array& array) {
275 if (this != &array) {
276 ptr = array.ptr;
277 if (ptr) ptr->refcount++;
278 }
279 return *this;
280 }
281
282 const T& operator[](int i) const { return ptr->a[i]; }
283
284 void set(int i, const T& v) {
285 if (!ptr) {
286 ptr = new Rep;
287 } else if (ptr->refcount > 1 && ptr->a[i] != v) {
288 Rep* newptr = new Rep(*ptr);
289 newptr->refcount = 1;
290 Rep::release(ptr);
291 ptr = newptr;
292 }
293 ptr->a[i] = v;
294 }
295 };
296
297 /////////////////////////////////////////////////////////////
298 // class Definition
299
300 // Base definition used by groups and regions
301 class Definition
302 {
303 public:
304 Definition();
305 virtual ~Definition();
306
307 // sample definition
308 std::string sample;
309
310 // input controls
311 int lochan; int hichan;
312 int lokey; int hikey;
313 int lovel; int hivel;
314 Array<int> locc; Array<int> hicc;
315 int lobend; int hibend;
316 float lobpm; float hibpm;
317 int lochanaft; int hichanaft;
318 int lopolyaft; int hipolyaft;
319 int loprog; int hiprog;
320 float lorand; float hirand;
321 float lotimer; float hitimer;
322
323 int seq_length;
324 int seq_position;
325
326 Array<int> start_locc; Array<int> start_hicc;
327 Array<int> stop_locc; Array<int> stop_hicc;
328
329 int sw_lokey; int sw_hikey;
330 int sw_last;
331 int sw_down;
332 int sw_up;
333 int sw_previous;
334 sw_vel_t sw_vel;
335
336 trigger_t trigger;
337
338 uint group;
339 uint off_by;
340 off_mode_t off_mode;
341
342 Array<int> on_locc; Array<int> on_hicc;
343
344 // sample player
345 optional<int> count;
346 optional<float> delay; optional<float> delay_random; Array<optional<float> > delay_oncc;
347 optional<int> delay_beats; optional<int> stop_beats;
348 optional<int> delay_samples; Array<optional<int> > delay_samples_oncc;
349 optional<int> end;
350 optional<float> loop_crossfade;
351 optional<int> offset; optional<int> offset_random; Array<optional<int> > offset_oncc;
352 loop_mode_t loop_mode;
353 optional<int> loop_start; optional<int> loop_end;
354 optional<int> sync_beats;
355 optional<int> sync_offset;
356
357 // amplifier
358 float volume;
359 float pan;
360 float width;
361 float position;
362 float amp_keytrack; int amp_keycenter; float amp_veltrack; Array<float> amp_velcurve; float amp_random;
363 float rt_decay;
364 Array<float> gain_oncc;
365 int xfin_lokey; int xfin_hikey;
366 int xfout_lokey; int xfout_hikey;
367 curve_t xf_keycurve;
368 int xfin_lovel; int xfin_hivel;
369 int xfout_lovel; int xfout_hivel;
370 curve_t xf_velcurve;
371 Array<int> xfin_locc; Array<int> xfin_hicc;
372 Array<int> xfout_locc; Array<int> xfout_hicc;
373 curve_t xf_cccurve;
374
375 // pitch
376 int transpose;
377 int tune;
378 int pitch_keycenter; int pitch_keytrack; int pitch_veltrack; int pitch_random;
379 int bend_up; int bend_down; int bend_step;
380
381 // filter
382 filter_t fil_type; filter_t fil2_type;
383 optional<float> cutoff; optional<float> cutoff2;
384 Array<int> cutoff_oncc; Array<int> cutoff2_oncc;
385 int cutoff_cc; // TODO: this is just a temporary fix to avoid
386 // looping through the cutoff_oncc array
387 Array<int> cutoff_smoothcc; Array<int> cutoff2_smoothcc;
388 Array<int> cutoff_stepcc; Array<int> cutoff2_stepcc;
389 Array<int> cutoff_curvecc; Array<int> cutoff2_curvecc;
390 int cutoff_chanaft; int cutoff2_chanaft;
391 int cutoff_polyaft; int cutoff2_polyaft;
392 float resonance; float resonance2;
393 Array<int> resonance_oncc; Array<int> resonance2_oncc;
394 Array<int> resonance_smoothcc; Array<int> resonance2_smoothcc;
395 Array<int> resonance_stepcc; Array<int> resonance2_stepcc;
396 Array<int> resonance_curvecc; Array<int> resonance2_curvecc;
397 int fil_keytrack; int fil2_keytrack;
398 int fil_keycenter; int fil2_keycenter;
399 int fil_veltrack; int fil2_veltrack;
400 int fil_random; int fil2_random;
401
402 // per voice equalizer
403 float eq1_freq; float eq2_freq; float eq3_freq;
404 Array<float> eq1_freq_oncc; Array<float> eq2_freq_oncc; Array<float> eq3_freq_oncc;
405 float eq1_vel2freq; float eq2_vel2freq; float eq3_vel2freq;
406 float eq1_bw; float eq2_bw; float eq3_bw;
407 Array<float> eq1_bw_oncc; Array<float> eq2_bw_oncc; Array<float> eq3_bw_oncc;
408 float eq1_gain; float eq2_gain; float eq3_gain;
409 Array<float> eq1_gain_oncc; Array<float> eq2_gain_oncc; Array<float> eq3_gain_oncc;
410 float eq1_vel2gain; float eq2_vel2gain; float eq3_vel2gain;
411
412 //Deprecated (from version 1)
413 float ampeg_delay, ampeg_start, ampeg_attack, ampeg_hold, ampeg_decay, ampeg_sustain, ampeg_release;
414 float ampeg_vel2delay, ampeg_vel2attack, ampeg_vel2hold, ampeg_vel2decay, ampeg_vel2sustain, ampeg_vel2release;
415 float fileg_delay, fileg_start, fileg_attack, fileg_hold, fileg_decay, fileg_sustain, fileg_release;
416 float pitcheg_delay, pitcheg_start, pitcheg_attack, pitcheg_hold, pitcheg_decay, pitcheg_sustain, pitcheg_release;
417 float amplfo_delay, amplfo_fade, amplfo_freq, amplfo_depth;
418 float fillfo_delay, fillfo_fade, fillfo_freq, fillfo_depth;
419 float pitchlfo_delay, pitchlfo_fade, pitchlfo_freq;
420 int pitchlfo_depth;
421
422 // envelope generators
423 LinuxSampler::ArrayList<EG> eg;
424
425 // low frequency oscillators
426 LinuxSampler::ArrayList<LFO> lfos;
427 };
428
429 class Query {
430 public:
431 uint8_t chan; // MIDI channel
432 uint8_t key; // MIDI note
433 uint8_t vel; // MIDI velocity
434 int bend; // MIDI pitch bend
435 uint8_t bpm; // host BPM
436 uint8_t chanaft; // MIDI channel pressure
437 uint8_t polyaft; // MIDI polyphonic aftertouch
438 uint8_t prog; // MIDI program change
439 float rand; // generated random number
440 trigger_t trig; // how it was triggered
441 uint8_t* cc; // all 128 CC values
442 float timer; // time since previous region in the group was triggered
443 bool* sw; // state of region key switches, 128 possible values
444 uint8_t last_sw_key; // last key pressed in the key switch range
445 uint8_t prev_sw_key; // previous note value
446
447 void search(const Instrument* pInstrument);
448 void search(const Instrument* pInstrument, int triggercc);
449 Region* next();
450 private:
451 LinuxSampler::ArrayList<Region*>* pRegionList;
452 int regionIndex;
453 };
454
455 /////////////////////////////////////////////////////////////
456 // class Region
457
458 /// Defines Region information of an Instrument
459 class Region :
460 public Definition
461 {
462 public:
463 Region();
464 virtual ~Region();
465
466 Sample* pSample;
467 Sample* GetSample(bool create = true);
468 void DestroySampleIfNotUsed();
469
470 Region* GetParent() { return this; }; // needed by EngineBase
471 Instrument* GetInstrument() { return pInstrument; }
472 void SetInstrument(Instrument* pInstrument) { this->pInstrument = pInstrument; }
473
474 bool HasLoop();
475 uint GetLoopStart();
476 uint GetLoopEnd();
477 uint GetLoopCount();
478
479 /// Return true if region is triggered by key. Region is
480 /// assumed to come from a search in the lookup table.
481 bool OnKey(const Query& q);
482
483 /// Return an articulation for the current state
484 Articulation* GetArticulation(int bend, uint8_t bpm, uint8_t chanaft, uint8_t polyaft, uint8_t* cc);
485
486 // unique region id
487 int id;
488
489 private:
490 Instrument* pInstrument;
491 int seq_counter;
492 };
493
494 /////////////////////////////////////////////////////////////
495 // class Instrument
496
497 /// Provides all neccessary information for the synthesis of an Instrument
498 class Instrument : public SampleManager
499 {
500 public:
501 Instrument(std::string name = "Unknown", SampleManager* pSampleManager = NULL);
502 virtual ~Instrument();
503
504 std::string GetName() { return name; }
505 SampleManager* GetSampleManager() { return pSampleManager; }
506
507 bool DestroyRegion(Region* pRegion);
508 bool HasKeyBinding(uint8_t key);
509 bool HasKeySwitchBinding(uint8_t key);
510
511 /// List of Regions belonging to this Instrument
512 std::vector<Region*> regions;
513
514 friend class File;
515 friend class Query;
516
517 private:
518 std::string name;
519 std::vector<bool> KeyBindings;
520 std::vector<bool> KeySwitchBindings;
521 SampleManager* pSampleManager;
522 LookupTable* pLookupTable;
523 LookupTable* pLookupTableCC[128];
524 };
525
526 /////////////////////////////////////////////////////////////
527 // class Group
528
529 /// A Group act just as a template containing Region default values
530 class Group :
531 public Definition
532 {
533 public:
534 Group();
535 virtual ~Group();
536
537 /// Reset Group to default values
538 void Reset();
539
540 /// Create a new Region
541 Region* RegionFactory();
542
543 // id counter
544 int id;
545
546 };
547
548 /////////////////////////////////////////////////////////////
549 // class File
550
551 /// Parses SFZ files and provides abstract access to the data
552 class File
553 {
554 public:
555 /// Load an existing SFZ file
556 File(std::string file, SampleManager* pSampleManager = NULL);
557 virtual ~File();
558
559 /// Returns a pointer to the instrument object
560 Instrument* GetInstrument();
561
562 private:
563 void push_header(std::string token);
564 void push_opcode(std::string token);
565 int parseKey(const std::string& value);
566 EG& eg(int x);
567 EGNode& egnode(int x, int y);
568 LFO& lfo(int x);
569
570 std::string currentDir;
571 /// Pointer to the Instrument belonging to this file
572 Instrument* _instrument;
573
574 // state variables
575 enum section_t { UNKNOWN, GROUP, REGION, CONTROL };
576 section_t _current_section;
577 Region* _current_region;
578 Group* _current_group;
579 Definition* pCurDef;
580
581 // control header directives
582 std::string default_path;
583 int octave_offset;
584 int note_offset;
585 };
586
587 } // !namespace sfz
588
589 #endif // !LIBSFZ_SFZ_H

Properties

Name Value
svn:executable *

  ViewVC Help
Powered by ViewVC