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 SampleManager;

    class Sample : public LinuxSampler::SampleFileBase<Region> {
        private:
            int  End;
            long TotalFrames;
            
        public:
            Sample(String File, bool DontClose = false, uint offset = 0, int end = -2 /* -2 means unspecified */)
                  : LinuxSampler::SampleFileBase<Region>(File, DontClose)
            {
                Offset = offset;
                End = end;
                
                long tfc = LinuxSampler::SampleFileBase<Region>::GetTotalFrameCount();
                if (Offset >= tfc) {
                    std::cerr << "Offset for file '" << this->GetFile() << "' too long (" << Offset << ")" << std::endl;
                    Offset = 0;
                }
                
                if (End == -2 || End > tfc) TotalFrames = tfc;
                else if (End == -1 || End < Offset) TotalFrames = 0;
                else TotalFrames = End;
            }
            virtual ~Sample() { }
            
            virtual long GetTotalFrameCount() { return TotalFrames; }
            
            friend class SampleManager;
    };

    // 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, uint offset, int end);

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