engines/sfz/sfz.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2008 Anders Dahnielson <anders@dahnielson.com>          *
 *   Copyright (C) 2009 - 2011 Anders Dahnielson and Grigor Iliev          *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the Free Software           *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 ***************************************************************************/

#ifndef LIBSFZ_SFZ_H
#define LIBSFZ_SFZ_H

#include <fstream>
#include <iostream>
#include <vector>
#include <string>
#include <stdexcept>

#include "../common/SampleFile.h"
#include "../common/SampleManager.h"
#include "../../common/ArrayList.h"

#define TRIGGER_ATTACK  ((unsigned char) (1 << 0)) // 0x01
#define TRIGGER_RELEASE ((unsigned char) (1 << 1)) // 0x02
#define TRIGGER_FIRST   ((unsigned char) (1 << 2)) // 0x04
#define TRIGGER_LEGATO  ((unsigned char) (1 << 3)) // 0x08

namespace sfz
{
    // Forward declarations
    class Articulation;
    class Region;
    class Group;
    class Instrument;
    class File;
    class LookupTable;

    class Sample : public LinuxSampler::SampleFileBase<Region> {
        public:
            Sample(String File, bool DontClose = false, uint offset = 0): LinuxSampler::SampleFileBase<Region>(File, DontClose) {
                Offset = offset;
            }
            virtual ~Sample() { }
    };

    // Enumerations
    enum sw_vel_t    { VEL_CURRENT, VEL_PREVIOUS };
    enum off_mode_t  { OFF_FAST, OFF_NORMAL };
    enum loop_mode_t { NO_LOOP, ONE_SHOT, LOOP_CONTINUOUS, LOOP_SUSTAIN, LOOP_UNSET };
    enum curve_t     { GAIN, POWER };
    enum filter_t    { LPF_1P, HPF_1P, BPF_1P, BRF_1P, APF_1P,
                       LPF_2P, HPF_2P, BPF_2P, BRF_2P, PKF_2P,
                       LPF_4P, HPF_4P,
                       LPF_6P, HPF_6P };

    typedef unsigned char trigger_t;
    typedef unsigned char uint8_t;

    class SampleManager : public LinuxSampler::SampleManager<Sample, Region> {
    public:
        Sample* FindSample(std::string samplePath, int offset);

    protected:
        virtual void OnSampleInUse(Sample* pSample) {
            pSample->Open();
        }

        virtual void OnSampleInNotUse(Sample* pSample) {
            pSample->Close();
        }
    };
    
    class CC {
        public:
            uint8_t   Controller;  ///< MIDI controller number.
            short int Curve;
            float     Influence;   ///< Controller Value.
            float     Smooth;      ///< The speed of parameter change in milliseconds
            
            CC(uint8_t Controller = 0, float Influence = 0.0f, short int Curve = -1, float Smooth = 0) {
                this->Controller = Controller;
                this->Influence  = Influence;
                this->Curve      = Curve;
                this->Smooth     = Smooth;
            }
                    
            CC(const CC& cc) { Copy(cc); }
            void operator=(const CC& cc) { Copy(cc); }
                    
            void Copy(const CC& cc) {
                Controller = cc.Controller;
                Influence  = cc.Influence;
                Curve      = cc.Curve;
                Smooth     = cc.Smooth;
            }
    };

    /////////////////////////////////////////////////////////////
    // class Exception

    class Exception :
        public std::runtime_error
    {
        public:
        Exception(const std::string& msg) :
            runtime_error(msg)
        {
        }

        std::string Message()
        {
            return what();
        }

        void PrintMessage()
        {
            std::cerr << what() << std::endl << std::flush;
        }
    };

    /////////////////////////////////////////////////////////////
    // class optional

    //  Handy class nicked from LinuxSampler...
    //  Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck
    //  Copyright (C) 2005, 2006 Christian Schoenebeck

    class optional_base
    {
        public:
        class nothing_t { public: nothing_t() {} };
        static const nothing_t nothing;
    };

    template<class T>
    class optional :
        public optional_base
    {
        public:
        optional()
        {
            initialized = false;
        }

        optional(T data)
        {
            this->data  = data;
            initialized = true;
        }

        optional(nothing_t)
        {
            initialized = false;
        }

        template <class T_inner>
        optional(T_inner data)
        {
            this->data  = T(data);
            initialized = true;
        }

        const T& get() const throw (Exception)
        {
            if (!initialized) throw Exception("optional variable not initialized");
            return data;
        }

        T& get() throw (Exception)
        {
            if (!initialized) throw Exception("optional variable not initialized");
            return data;
        }

        void unset()
        {
            initialized = false;
        }

        optional& operator =(const optional& arg) throw (Exception)
        {
            if (!arg.initialized) {
                            initialized = false;
                        } else {
                            this->data  = arg.data;
                            initialized = true;
                        }
            return *this;
        }

        optional& operator =(const T& arg)
        {
            this->data  = arg;
            initialized = true;
            return *this;
        }

        const T& operator *() const throw (Exception) { return get(); }
        T&       operator *()       throw (Exception) { return get(); }

        const T* operator ->() const throw (Exception)
        {
            if (!initialized) throw Exception("optional variable not initialized");
            return &data;
        }

        T* operator ->() throw (Exception)
        {
            if (!initialized) throw Exception("optional variable not initialized");
            return &data;
        }

        operator bool()   const { return initialized; }
        bool operator !() const { return !initialized; }

        protected:
        T    data;
        bool initialized;
    };

    /////////////////////////////////////////////////////////////
    // class Articulation

    // Articulation containing all performance parameters for synthesis
    class Articulation
    {
    public:
        Articulation();
        virtual ~Articulation();
    };

    class EGNode
    {
    public:
        float time;
        float level;
        float shape;
        float curve;
        LinuxSampler::ArrayList<CC> time_oncc;
        LinuxSampler::ArrayList<CC> level_oncc;
        
        EGNode();
        EGNode(const EGNode& egNode) { Copy(egNode); }
        void operator=(const EGNode& egNode) { Copy(egNode); }
        void Copy(const EGNode& egNode);
    };

    class EG
    {
    public:
        LinuxSampler::ArrayList<EGNode> node;
        int sustain;
        int loop;
        int loop_count;
        float amplitude;
        float cutoff;
        EG();
        EG(const EG& eg) { Copy(eg); }
        void operator=(const EG& eg) { Copy(eg); }
        void Copy(const EG& eg);
    };

    class LFO
    {
    public:
        float delay; // 0 to 100 seconds
        float freq; // 0 to 20 Hz
        float fade; // 0 to 100 seconds
        float phase; // 0 to 360 degrees
        uint  wave; // 0 to 4294967296
        float volume; // -144 to 6 dB
        int   pitch; // -9600 to 9600 cents
        int   cutoff; // -9600 to 9600 cents
        float resonance; // 0 to 40 dB
        float pan; // -100 to 100 %
        
        LinuxSampler::ArrayList<CC> freq_oncc; // 0 to 20 Hz
        LinuxSampler::ArrayList<CC> fade_oncc; // 0 to 100 seconds
        LinuxSampler::ArrayList<CC> phase_oncc; // 0 to 360 degrees
        LinuxSampler::ArrayList<CC> pitch_oncc;
        
        LFO();
        LFO(const LFO& lfo) { Copy(lfo); }
        void operator=(const LFO& lfo) { Copy(lfo); }
        void Copy(const LFO& lfo);
    };

    // Fixed size array with copy-on-write semantics
    template<class T>
    class Array
    {
    private:
        struct Rep {
            int refcount;
            T a[128];

            Rep() : refcount(1) { }
            static void release(Rep* rep) {
                if (!--rep->refcount) delete rep;
            }
        } *ptr;
    public:
        Array() : ptr(0) { }
        ~Array() { Rep::release(ptr); }

        Array& operator=(const Array& array) {
            if (this != &array) {
                ptr = array.ptr;
                if (ptr) ptr->refcount++;
            }
            return *this;
        }

        const T& operator[](int i) const { return ptr->a[i]; }

        void set(int i, const T& v) {
            if (!ptr) {
                ptr = new Rep;
            } else if (ptr->refcount > 1 && ptr->a[i] != v) {
                Rep* newptr = new Rep(*ptr);
                newptr->refcount = 1;
                Rep::release(ptr);
                ptr = newptr;
            }
            ptr->a[i] = v;
        }
    };

    /////////////////////////////////////////////////////////////
    // class Definition

    // Base definition used by groups and regions
    class Definition
    {
    public:
        Definition();
        virtual ~Definition();

        // sample definition
        std::string sample;

        // input controls
        int   lochan;    int   hichan;
        int   lokey;     int   hikey;
        int   lovel;     int   hivel;
        Array<int> locc; Array<int> hicc;
        int   lobend;    int   hibend;
        float lobpm;     float hibpm;
        int   lochanaft; int   hichanaft;
        int   lopolyaft; int   hipolyaft;
        int   loprog;    int   hiprog;
        float lorand;    float hirand;
        float lotimer;   float hitimer;

        int seq_length;
        int seq_position;

        Array<int> start_locc; Array<int> start_hicc;
        Array<int> stop_locc;  Array<int> stop_hicc;

        int sw_lokey;    int sw_hikey;
        int sw_last;
        int sw_down;
        int sw_up;
        int sw_previous;
        sw_vel_t sw_vel;

        trigger_t trigger;

        uint group;
        uint off_by;
        off_mode_t off_mode;

        Array<int> on_locc; Array<int> on_hicc;

        // sample player
        optional<int> count;
        optional<float> delay; optional<float> delay_random; Array<optional<float> > delay_oncc;
        optional<int> delay_beats; optional<int> stop_beats;
        optional<int> delay_samples; Array<optional<int> > delay_samples_oncc;
        optional<int> end;
        optional<float> loop_crossfade;
        optional<int> offset; optional<int> offset_random; Array<optional<int> > offset_oncc;
        loop_mode_t loop_mode;
        optional<int> loop_start; optional<int> loop_end;
        optional<int> sync_beats;
        optional<int> sync_offset;

        // amplifier
        float volume;
        float pan;
        float width;
        float position;
        float amp_keytrack; int amp_keycenter; float amp_veltrack; Array<float> amp_velcurve; float amp_random;
        float rt_decay;
        Array<float> gain_oncc;
        int xfin_lokey; int xfin_hikey;
        int xfout_lokey; int xfout_hikey;
        curve_t xf_keycurve;
        int xfin_lovel; int xfin_hivel;
        int xfout_lovel; int xfout_hivel;
        curve_t xf_velcurve;
        Array<int> xfin_locc; Array<int> xfin_hicc;
        Array<int> xfout_locc; Array<int> xfout_hicc;
        curve_t xf_cccurve;

        // pitch
        int transpose;
        int tune;
        int pitch_keycenter; int pitch_keytrack; int pitch_veltrack; int pitch_random;
        int bend_up; int bend_down; int bend_step;

        // filter
        filter_t fil_type; filter_t fil2_type;
        optional<float> cutoff; optional<float> cutoff2;
        Array<int> cutoff_oncc; Array<int> cutoff2_oncc;
        int cutoff_cc; // TODO: this is just a temporary fix to avoid
                       // looping through the cutoff_oncc array
        Array<int> cutoff_smoothcc; Array<int> cutoff2_smoothcc;
        Array<int> cutoff_stepcc; Array<int> cutoff2_stepcc;
        Array<int> cutoff_curvecc; Array<int> cutoff2_curvecc;
        int cutoff_chanaft; int cutoff2_chanaft;
        int cutoff_polyaft; int cutoff2_polyaft;
        float resonance; float resonance2;
        Array<int> resonance_oncc; Array<int> resonance2_oncc;
        Array<int> resonance_smoothcc; Array<int> resonance2_smoothcc;
        Array<int> resonance_stepcc; Array<int> resonance2_stepcc;
        Array<int> resonance_curvecc; Array<int> resonance2_curvecc;
        int fil_keytrack; int fil2_keytrack;
        int fil_keycenter; int fil2_keycenter;
        int fil_veltrack; int fil2_veltrack;
        int fil_random; int fil2_random;

        // per voice equalizer
        float eq1_freq; float eq2_freq; float eq3_freq;
        Array<float> eq1_freq_oncc; Array<float> eq2_freq_oncc; Array<float> eq3_freq_oncc;
        float eq1_vel2freq; float eq2_vel2freq; float eq3_vel2freq;
        float eq1_bw; float eq2_bw; float eq3_bw;
        Array<float> eq1_bw_oncc; Array<float> eq2_bw_oncc; Array<float> eq3_bw_oncc;
        float eq1_gain; float eq2_gain; float eq3_gain;
        Array<float> eq1_gain_oncc; Array<float> eq2_gain_oncc; Array<float> eq3_gain_oncc;
        float eq1_vel2gain; float eq2_vel2gain; float eq3_vel2gain;

        //Deprecated (from version 1)
        float ampeg_delay, ampeg_start, ampeg_attack, ampeg_hold, ampeg_decay, ampeg_sustain, ampeg_release;
        float ampeg_vel2delay, ampeg_vel2attack, ampeg_vel2hold, ampeg_vel2decay, ampeg_vel2sustain, ampeg_vel2release;
        LinuxSampler::ArrayList<CC> ampeg_delaycc, ampeg_startcc, ampeg_attackcc, ampeg_holdcc;
        LinuxSampler::ArrayList<CC> ampeg_decaycc, ampeg_sustaincc, ampeg_releasecc;
        float fileg_delay, fileg_start, fileg_attack, fileg_hold, fileg_decay, fileg_sustain, fileg_release;
        float fileg_vel2delay, fileg_vel2attack, fileg_vel2hold, fileg_vel2decay, fileg_vel2sustain, fileg_vel2release;
        float pitcheg_delay, pitcheg_start, pitcheg_attack, pitcheg_hold, pitcheg_decay, pitcheg_sustain, pitcheg_release;
        float pitcheg_vel2delay, pitcheg_vel2attack, pitcheg_vel2hold, pitcheg_vel2decay, pitcheg_vel2sustain, pitcheg_vel2release;
        int   fileg_depth, pitcheg_depth;
        float amplfo_delay, amplfo_fade, amplfo_freq, amplfo_depth;
        float fillfo_delay, fillfo_fade, fillfo_freq, fillfo_depth;
        float pitchlfo_delay, pitchlfo_fade, pitchlfo_freq;
        int pitchlfo_depth;
        Array<int> pitchlfo_depthcc;
        
        LinuxSampler::ArrayList<CC> pitchlfo_freqcc; // 0 to 20 Hz
        LinuxSampler::ArrayList<CC> fillfo_freqcc; // 0 to 20 Hz
        LinuxSampler::ArrayList<CC> amplfo_freqcc; // 0 to 20 Hz

        // envelope generators
        LinuxSampler::ArrayList<EG> eg;

        // low frequency oscillators
        LinuxSampler::ArrayList<LFO> lfos;
        
        LinuxSampler::ArrayList<CC> volume_oncc;
        LinuxSampler::ArrayList<CC> volume_curvecc; // used only as temporary buffer during the parsing - values are then moved to volume_oncc
        LinuxSampler::ArrayList<CC> volume_smoothcc; // used only as temporary buffer during the parsing - values are then moved to volume_oncc
    };

    class Query {
    public:
        uint8_t chan;        // MIDI channel
        uint8_t key;         // MIDI note
        uint8_t vel;         // MIDI velocity
        int bend;            // MIDI pitch bend
        uint8_t bpm;         // host BPM
        uint8_t chanaft;     // MIDI channel pressure
        uint8_t polyaft;     // MIDI polyphonic aftertouch
        uint8_t prog;        // MIDI program change
        float rand;          // generated random number
        trigger_t trig;      // how it was triggered
        uint8_t* cc;         // all 128 CC values
        float timer;         // time since previous region in the group was triggered
        bool* sw;            // state of region key switches, 128 possible values
        uint8_t last_sw_key; // last key pressed in the key switch range
        uint8_t prev_sw_key; // previous note value

        void search(const Instrument* pInstrument);
        void search(const Instrument* pInstrument, int triggercc);
        Region* next();
    private:
        LinuxSampler::ArrayList<Region*>* pRegionList;
        int regionIndex;
    };

    /////////////////////////////////////////////////////////////
    // class Region

    /// Defines Region information of an Instrument
    class Region :
        public Definition
    {
    public:
        Region();
        virtual ~Region();

        Sample* pSample;
        Sample* GetSample(bool create = true);
        void DestroySampleIfNotUsed();

        Region*      GetParent() { return this; }; // needed by EngineBase
        Instrument*  GetInstrument() { return pInstrument; }
        void         SetInstrument(Instrument* pInstrument) { this->pInstrument = pInstrument; }

        bool HasLoop();
        uint GetLoopStart();
        uint GetLoopEnd();
        uint GetLoopCount();

        /// Return true if region is triggered by key. Region is
        /// assumed to come from a search in the lookup table.
        bool OnKey(const Query& q);

        /// Return an articulation for the current state
        Articulation* GetArticulation(int bend, uint8_t bpm, uint8_t chanaft, uint8_t polyaft, uint8_t* cc);

        // unique region id
        int id;

    private:
        Instrument* pInstrument;
        int seq_counter;
    };
    
    class Curve {
        public:
            float v[128];
            Curve() { for (int i = 0; i < 128; i++) v[i] = 0; }
            Curve(const Curve& curve) { Copy(curve); }
            void operator=(const Curve& curve) { Copy(curve); }
            void Copy(const Curve& curve) { for (int i = 0; i < 128; i++) v[i] = curve.v[i]; }
    };

    /////////////////////////////////////////////////////////////
    // class Instrument

    /// Provides all neccessary information for the synthesis of an Instrument
    class Instrument : public SampleManager
    {
    public:
        Instrument(std::string name = "Unknown", SampleManager* pSampleManager = NULL);
        virtual ~Instrument();

        std::string GetName() { return name; }
        SampleManager* GetSampleManager() { return pSampleManager; }

        bool DestroyRegion(Region* pRegion);
        bool HasKeyBinding(uint8_t key);
        bool HasKeySwitchBinding(uint8_t key);

        /// List of Regions belonging to this Instrument
        std::vector<Region*> regions;
        ::LinuxSampler::ArrayList<Curve> curves;

        friend class File;
        friend class Query;

    private:
        std::string name;
        std::vector<bool> KeyBindings;
        std::vector<bool> KeySwitchBindings;
        SampleManager* pSampleManager;
        LookupTable* pLookupTable;
        LookupTable* pLookupTableCC[128];
    };

    /////////////////////////////////////////////////////////////
    // class Group

    /// A Group act just as a template containing Region default values
    class Group :
        public Definition
    {
    public:
        Group();
        virtual ~Group();

        /// Reset Group to default values
        void Reset();

        /// Create a new Region
        Region* RegionFactory();

        // id counter
        int id;

    };

    /////////////////////////////////////////////////////////////
    // class File

    /// Parses SFZ files and provides abstract access to the data
    class File
    {
    public:
        /// Load an existing SFZ file
        File(std::string file, SampleManager* pSampleManager = NULL);
        virtual ~File();

        /// Returns a pointer to the instrument object
        Instrument* GetInstrument();

    private:
        void  push_header(std::string token);
        void  push_opcode(std::string token);
        int parseKey(const std::string& value);
        EG& eg(int x);
        EGNode& egnode(int x, int y);
        LFO& lfo(int x);
        void copyCurves(LinuxSampler::ArrayList<CC>& curves, LinuxSampler::ArrayList<CC>& dest);
        void copySmoothValues(LinuxSampler::ArrayList<CC>& smooths, LinuxSampler::ArrayList<CC>& dest);

        std::string currentDir;
        /// Pointer to the Instrument belonging to this file
        Instrument* _instrument;

        // state variables
        enum section_t { UNKNOWN, GROUP, REGION, CONTROL, CURVE };
        section_t _current_section;
        Region* _current_region;
        Group* _current_group;
        Curve* _current_curve;
        Definition* pCurDef;

        // control header directives
        std::string default_path;
        int octave_offset;
        int note_offset;
    };

} // !namespace sfz

#endif // !LIBSFZ_SFZ_H
1	iliev	2012	/***************************************************************************
2			* *
3			* LinuxSampler - modular, streaming capable sampler *
4			* *
5	persson	2055	* Copyright (C) 2008 Anders Dahnielson <anders@dahnielson.com> *
6	persson	2167	* Copyright (C) 2009 - 2011 Anders Dahnielson and Grigor Iliev *
7	iliev	2012	* *
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	persson	2055	#include "../../common/ArrayList.h"
36	iliev	2012
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	persson	2055	namespace sfz
43	iliev	2012	{
44			// Forward declarations
45			class Articulation;
46			class Region;
47			class Group;
48			class Instrument;
49			class File;
50	persson	2106	class LookupTable;
51	persson	2055
52	iliev	2021	class Sample : public LinuxSampler::SampleFileBase<Region> {
53			public:
54	iliev	2216	Sample(String File, bool DontClose = false, uint offset = 0): LinuxSampler::SampleFileBase<Region>(File, DontClose) {
55			Offset = offset;
56			}
57	iliev	2021	virtual ~Sample() { }
58			};
59	iliev	2012
60			// Enumerations
61			enum sw_vel_t { VEL_CURRENT, VEL_PREVIOUS };
62			enum off_mode_t { OFF_FAST, OFF_NORMAL };
63	persson	2167	enum loop_mode_t { NO_LOOP, ONE_SHOT, LOOP_CONTINUOUS, LOOP_SUSTAIN, LOOP_UNSET };
64	iliev	2012	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	iliev	2021	class SampleManager : public LinuxSampler::SampleManager<Sample, Region> {
74	iliev	2012	public:
75	iliev	2216	Sample* FindSample(std::string samplePath, int offset);
76	iliev	2012
77			protected:
78	iliev	2021	virtual void OnSampleInUse(Sample* pSample) {
79	iliev	2012	pSample->Open();
80			}
81
82	iliev	2021	virtual void OnSampleInNotUse(Sample* pSample) {
83	iliev	2012	pSample->Close();
84			}
85			};
86	iliev	2225
87			class CC {
88			public:
89	iliev	2230	uint8_t Controller; ///< MIDI controller number.
90			short int Curve;
91			float Influence; ///< Controller Value.
92	iliev	2232	float Smooth; ///< The speed of parameter change in milliseconds
93	iliev	2225
94	iliev	2232	CC(uint8_t Controller = 0, float Influence = 0.0f, short int Curve = -1, float Smooth = 0) {
95	iliev	2225	this->Controller = Controller;
96	iliev	2230	this->Influence = Influence;
97			this->Curve = Curve;
98	iliev	2232	this->Smooth = Smooth;
99	iliev	2225	}
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	iliev	2230	Influence = cc.Influence;
107			Curve = cc.Curve;
108	iliev	2232	Smooth = cc.Smooth;
109	iliev	2225	}
110			};
111	iliev	2012
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	persson	2055	class EGNode
247			{
248			public:
249			float time;
250			float level;
251			float shape;
252			float curve;
253	iliev	2229	LinuxSampler::ArrayList<CC> time_oncc;
254			LinuxSampler::ArrayList<CC> level_oncc;
255
256	persson	2055	EGNode();
257	iliev	2229	EGNode(const EGNode& egNode) { Copy(egNode); }
258			void operator=(const EGNode& egNode) { Copy(egNode); }
259			void Copy(const EGNode& egNode);
260	persson	2055	};
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	iliev	2229	EG(const EG& eg) { Copy(eg); }
273			void operator=(const EG& eg) { Copy(eg); }
274			void Copy(const EG& eg);
275	persson	2055	};
276
277	iliev	2218	class LFO
278			{
279			public:
280	iliev	2225	float delay; // 0 to 100 seconds
281	iliev	2218	float freq; // 0 to 20 Hz
282	iliev	2226	float fade; // 0 to 100 seconds
283	iliev	2225	float phase; // 0 to 360 degrees
284	iliev	2218	uint wave; // 0 to 4294967296
285	iliev	2221	float volume; // -144 to 6 dB
286	iliev	2218	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	iliev	2225
291	iliev	2227	LinuxSampler::ArrayList<CC> freq_oncc; // 0 to 20 Hz
292	iliev	2226	LinuxSampler::ArrayList<CC> fade_oncc; // 0 to 100 seconds
293	iliev	2225	LinuxSampler::ArrayList<CC> phase_oncc; // 0 to 360 degrees
294			LinuxSampler::ArrayList<CC> pitch_oncc;
295
296	iliev	2218	LFO();
297	iliev	2229	LFO(const LFO& lfo) { Copy(lfo); }
298			void operator=(const LFO& lfo) { Copy(lfo); }
299			void Copy(const LFO& lfo);
300	iliev	2218	};
301
302	persson	2091	// 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	iliev	2012	/////////////////////////////////////////////////////////////
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	persson	2091	Array<int> locc; Array<int> hicc;
361	iliev	2012	int lobend; int hibend;
362	persson	2106	float lobpm; float hibpm;
363	iliev	2012	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	persson	2091	Array<int> start_locc; Array<int> start_hicc;
373			Array<int> stop_locc; Array<int> stop_hicc;
374	iliev	2012
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	iliev	2027	uint group;
385	persson	2114	uint off_by;
386	iliev	2012	off_mode_t off_mode;
387
388	persson	2091	Array<int> on_locc; Array<int> on_hicc;
389	iliev	2012
390			// sample player
391			optional<int> count;
392	persson	2091	optional<float> delay; optional<float> delay_random; Array<optional<float> > delay_oncc;
393	iliev	2012	optional<int> delay_beats; optional<int> stop_beats;
394	persson	2091	optional<int> delay_samples; Array<optional<int> > delay_samples_oncc;
395	iliev	2012	optional<int> end;
396			optional<float> loop_crossfade;
397	persson	2091	optional<int> offset; optional<int> offset_random; Array<optional<int> > offset_oncc;
398	iliev	2012	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	persson	2091	float amp_keytrack; int amp_keycenter; float amp_veltrack; Array<float> amp_velcurve; float amp_random;
409	iliev	2012	float rt_decay;
410	persson	2091	Array<float> gain_oncc;
411	iliev	2012	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	persson	2091	Array<int> xfin_locc; Array<int> xfin_hicc;
418			Array<int> xfout_locc; Array<int> xfout_hicc;
419	iliev	2012	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	persson	2091	Array<int> cutoff_oncc; Array<int> cutoff2_oncc;
431	persson	2175	int cutoff_cc; // TODO: this is just a temporary fix to avoid
432			// looping through the cutoff_oncc array
433	persson	2091	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	iliev	2012	int cutoff_chanaft; int cutoff2_chanaft;
437			int cutoff_polyaft; int cutoff2_polyaft;
438			float resonance; float resonance2;
439	persson	2091	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	iliev	2012	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	persson	2091	Array<float> eq1_freq_oncc; Array<float> eq2_freq_oncc; Array<float> eq3_freq_oncc;
451	iliev	2012	float eq1_vel2freq; float eq2_vel2freq; float eq3_vel2freq;
452			float eq1_bw; float eq2_bw; float eq3_bw;
453	persson	2091	Array<float> eq1_bw_oncc; Array<float> eq2_bw_oncc; Array<float> eq3_bw_oncc;
454	iliev	2012	float eq1_gain; float eq2_gain; float eq3_gain;
455	persson	2091	Array<float> eq1_gain_oncc; Array<float> eq2_gain_oncc; Array<float> eq3_gain_oncc;
456	iliev	2012	float eq1_vel2gain; float eq2_vel2gain; float eq3_vel2gain;
457	iliev	2018
458			//Deprecated (from version 1)
459			float ampeg_delay, ampeg_start, ampeg_attack, ampeg_hold, ampeg_decay, ampeg_sustain, ampeg_release;
460	persson	2176	float ampeg_vel2delay, ampeg_vel2attack, ampeg_vel2hold, ampeg_vel2decay, ampeg_vel2sustain, ampeg_vel2release;
461	iliev	2229	LinuxSampler::ArrayList<CC> ampeg_delaycc, ampeg_startcc, ampeg_attackcc, ampeg_holdcc;
462			LinuxSampler::ArrayList<CC> ampeg_decaycc, ampeg_sustaincc, ampeg_releasecc;
463	iliev	2018	float fileg_delay, fileg_start, fileg_attack, fileg_hold, fileg_decay, fileg_sustain, fileg_release;
464	iliev	2222	float fileg_vel2delay, fileg_vel2attack, fileg_vel2hold, fileg_vel2decay, fileg_vel2sustain, fileg_vel2release;
465	iliev	2018	float pitcheg_delay, pitcheg_start, pitcheg_attack, pitcheg_hold, pitcheg_decay, pitcheg_sustain, pitcheg_release;
466	iliev	2220	float pitcheg_vel2delay, pitcheg_vel2attack, pitcheg_vel2hold, pitcheg_vel2decay, pitcheg_vel2sustain, pitcheg_vel2release;
467	iliev	2222	int fileg_depth, pitcheg_depth;
468	persson	2072	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	iliev	2224	Array<int> pitchlfo_depthcc;
473	iliev	2227
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	persson	2055
478			// envelope generators
479			LinuxSampler::ArrayList<EG> eg;
480	iliev	2218
481			// low frequency oscillators
482			LinuxSampler::ArrayList<LFO> lfos;
483	iliev	2230
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	iliev	2232	LinuxSampler::ArrayList<CC> volume_smoothcc; // used only as temporary buffer during the parsing - values are then moved to volume_oncc
487	iliev	2012	};
488
489	persson	2101	class Query {
490			public:
491			uint8_t chan; // MIDI channel
492	persson	2115	uint8_t key; // MIDI note
493	persson	2101	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	persson	2106
507			void search(const Instrument* pInstrument);
508	persson	2115	void search(const Instrument* pInstrument, int triggercc);
509	persson	2106	Region* next();
510	persson	2101	private:
511	persson	2106	LinuxSampler::ArrayList<Region> pRegionList;
512			int regionIndex;
513	persson	2101	};
514
515	iliev	2012	/////////////////////////////////////////////////////////////
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	iliev	2021	Sample* pSample;
527			Sample* GetSample(bool create = true);
528	iliev	2012	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	iliev	2021	bool HasLoop();
535			uint GetLoopStart();
536			uint GetLoopEnd();
537			uint GetLoopCount();
538
539	persson	2106	/// Return true if region is triggered by key. Region is
540			/// assumed to come from a search in the lookup table.
541	persson	2101	bool OnKey(const Query& q);
542	iliev	2012
543			/// Return an articulation for the current state
544	persson	2101	Articulation* GetArticulation(int bend, uint8_t bpm, uint8_t chanaft, uint8_t polyaft, uint8_t* cc);
545	iliev	2012
546			// unique region id
547			int id;
548
549			private:
550			Instrument* pInstrument;
551	persson	2072	int seq_counter;
552	iliev	2012	};
553	iliev	2230
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	iliev	2012
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	iliev	2230	::LinuxSampler::ArrayList<Curve> curves;
583	iliev	2012
584	persson	2106	friend class File;
585			friend class Query;
586	iliev	2012
587			private:
588			std::string name;
589			std::vector<bool> KeyBindings;
590			std::vector<bool> KeySwitchBindings;
591			SampleManager* pSampleManager;
592	persson	2106	LookupTable* pLookupTable;
593	persson	2115	LookupTable* pLookupTableCC[128];
594	iliev	2012	};
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	persson	2058	int parseKey(const std::string& value);
636	persson	2055	EG& eg(int x);
637			EGNode& egnode(int x, int y);
638	iliev	2218	LFO& lfo(int x);
639	iliev	2230	void copyCurves(LinuxSampler::ArrayList<CC>& curves, LinuxSampler::ArrayList<CC>& dest);
640	iliev	2232	void copySmoothValues(LinuxSampler::ArrayList<CC>& smooths, LinuxSampler::ArrayList<CC>& dest);
641	iliev	2012
642			std::string currentDir;
643			/// Pointer to the Instrument belonging to this file
644			Instrument* _instrument;
645
646			// state variables
647	iliev	2230	enum section_t { UNKNOWN, GROUP, REGION, CONTROL, CURVE };
648	iliev	2012	section_t _current_section;
649			Region* _current_region;
650			Group* _current_group;
651	iliev	2230	Curve* _current_curve;
652	iliev	2012	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