engines/common/InstrumentScriptVM.h

/*
 * Copyright (c) 2014-2017 Christian Schoenebeck
 *
 * http://www.linuxsampler.org
 *
 * This file is part of LinuxSampler and released under the same terms.
 * See README file for details.
 */

#ifndef LS_INSTRUMENT_SCRIPT_VM_H
#define LS_INSTRUMENT_SCRIPT_VM_H

#include "../../common/global.h"
#include "../../common/ConstCapacityArray.h"
#include "../../scriptvm/ScriptVM.h"
#include "Event.h"
#include "../../common/Pool.h"
#include "InstrumentScriptVMFunctions.h"
#include "InstrumentScriptVMDynVars.h"

/**
 * Amount of bits on the left hand side of all pool_element_id_t numbers (i.e.
 * event_id_t, note_id_t) being reserved for script VM implementation internal
 * purposes.
 *
 * Right now there is only one bit reserved, which allows the VM (and its
 * built-in functions) to distinguish user supplied @c Event IDs (event_id_t)
 * from @c Note IDs (note_id_t).
 */
#define INSTR_SCRIPT_EVENT_ID_RESERVED_BITS 1

/**
 * Used by InstrScriptIDType_T to initialize its constants at compile time.
 *
 * This macro is already ready to initialize additional members for
 * InstrScriptIDType_T (that is more than the currently two enum constants).
 * Just keep in mind that you also have to increase
 * INSTR_SCRIPT_EVENT_ID_RESERVED_BITS when you add more!
 *
 * @param x - sequential consecutive number (starting with zero)
 */
#define INSTR_SCRIPT_ID_TYPE_FLAG(x) \
    (x << (sizeof(pool_element_id_t) * 8 - INSTR_SCRIPT_EVENT_ID_RESERVED_BITS))

/**
 * These flags are used to distinguish the individual ID Types in script scope
 * from each other. They are added as most left bit(s) to each ID in script
 * scope.
 */
enum InstrScriptIDType_T {
    /**
     * Used to mark IDs (in script scope) to actually be a MIDI event ID.
     */
    INSTR_SCRIPT_EVENT_ID_FLAG = INSTR_SCRIPT_ID_TYPE_FLAG(0),

    /**
     * Used to mark IDs (in script scope) to actually be a note ID.
     */
    INSTR_SCRIPT_NOTE_ID_FLAG = INSTR_SCRIPT_ID_TYPE_FLAG(1),
};

#define INSTR_SCRIPT_EVENT_GROUPS 28

#define EVENT_STATUS_INACTIVE 0
#define EVENT_STATUS_NOTE_QUEUE 1

enum {
    EVENT_PAR_NOTE = 1,
    EVENT_PAR_VELOCITY,
    EVENT_PAR_VOLUME,
    EVENT_PAR_TUNE,
    EVENT_PAR_0 = 1024,
    EVENT_PAR_1,
    EVENT_PAR_2,
    EVENT_PAR_3,
};

namespace LinuxSampler {

    class AbstractEngineChannel;
    struct InstrumentScript;

    /** @brief Convert IDs between script scope and engine internal scope.
     *
     * This class is used to translate unique IDs of events between script
     * scope and sampler engine internal scope, that is:
     * @code
     * int (script scope) -> event_id_t (engine internal scope)
     * int (script scope) -> note_id_t (engine internal scope)
     * @endcode
     * and vice versa:
     * @code
     * event_id_t (engine internal scope) -> int (script scope)
     * note_id_t (engine internal scope)  -> int (script scope)
     * @endcode
     * This is required because engine internally i.e. notes and regular events
     * are using their own, separate ID generating pool, and their ID number
     * set may thus overlap and historically there were built-in script
     * functions in KSP which allow to pass both regular MIDI event IDs, as well
     * as Note IDs. So we must be able to distinguish between them in our
     * built-in script function implementations. 
     *
     * @see INSTR_SCRIPT_EVENT_ID_RESERVED_BITS
     */
    class ScriptID {
    public:
        enum type_t {
            EVENT, ///< ID is actually an event ID
            NOTE, ///< ID is actually a note ID
        };

        /**
         * Construct a ScriptID object with an ID from script scope.
         */
        ScriptID(uint id) : m_id(id) {}

        /**
         * Returns a ScriptID object constructed with an event ID from engine
         * internal scope.
         */
        inline static ScriptID fromEventID(event_id_t id) {
            return ScriptID(INSTR_SCRIPT_EVENT_ID_FLAG | id);
        }

        /**
         * Returns a ScriptID object constructed with a note ID from engine
         * internal scope.
         */
        inline static ScriptID fromNoteID(note_id_t id) {
            return ScriptID(INSTR_SCRIPT_NOTE_ID_FLAG | id);
        }

        /**
         * Whether the ID reflected by this ScriptID object is actually a note
         * ID or rather an event ID.
         */
        inline type_t type() const {
            return (m_id & INSTR_SCRIPT_NOTE_ID_FLAG) ? NOTE : EVENT;
        }

        inline bool isNoteID() const {
            return type() == NOTE;
        }

        inline bool isEventID() const {
            return type() == EVENT;
        }

        /**
         * Returns event ID (for engine internal scope) of the ID reflected by
         * this ScriptID object, it returns 0 (being an invalid ID) if the ID
         * reflected by this ScriptID object is not an event ID.
         */
        inline event_id_t eventID() const {
            switch (type()) {
                case EVENT: return m_id;
                default:    return 0; // not an event id, return invalid ID
            }
        }

        /**
         * Returns note ID (for engine internal scope) of the ID reflected by
         * this ScriptID object, it returns 0 (being an invalid ID) if the ID
         * reflected by this ScriptID object is not a note ID.
         */
        inline note_id_t noteID() const {
            switch (type()) {
                case NOTE: return ~INSTR_SCRIPT_NOTE_ID_FLAG & m_id;
                default:   return 0; // not a note id, return invalid ID
            }
        }

        /**
         * Integer cast operator, which returns an ID number of this ScripID
         * object intended for script scope.
         */
        inline operator uint() const {
            return m_id;
        }

    private:
        uint m_id;
    };

    /** @brief List of Event IDs.
     *
     * Used for built-in script functions:
     *     by_marks(), set_event_mark(), delete_event_mark()
     */
    class EventGroup : protected ConstCapacityArray<int> {
    public:
        EventGroup() : ConstCapacityArray<int>(CONFIG_MAX_EVENTS_PER_FRAGMENT), m_script(NULL) {}
        void insert(int eventID);
        void erase(int eventID);
        void setScript(InstrumentScript* pScript) { m_script = pScript; }
        inline int size() const { return ConstCapacityArray<int>::size(); }
        inline void clear() { ConstCapacityArray<int>::clear(); }
        inline int& operator[](uint index) { return ConstCapacityArray<int>::operator[](index); }
        inline const int& operator[](uint index) const { return ConstCapacityArray<int>::operator[](index); }
    protected:
        InstrumentScript* m_script;
    };

    /** @brief Real-time instrument script VM representation.
     *
     * Holds the VM representation of all event handlers of the currently loaded
     * script, ready to be executed by the sampler engine.
     *
     * Even thought scripts (or to be more specific their event handler objects)
     * are shared between sampler engine channels, the InstrumentScript struct
     * instances though are not shared. Each sampler engine channel has its own
     * instance of a InstrumentScript struct. That's important, because this
     * struct also holds engine channel local informations, for example the
     * events that occured on the respective engine channel.
     */
    struct InstrumentScript {
        VMParserContext*      parserContext; ///< VM represenation of the currently loaded script or NULL if not script was loaded. Note that it is also not NULL if parser errors occurred!
        bool                  bHasValidScript; ///< True in case there is a valid script currently loaded, false if script processing shall be skipped.
        VMEventHandler*       handlerInit; ///< VM representation of script's initilization callback or NULL if current script did not define such an init handler.
        VMEventHandler*       handlerNote; ///< VM representation of script's MIDI note on callback or NULL if current script did not define such an event handler.
        VMEventHandler*       handlerRelease; ///< VM representation of script's MIDI note off callback or NULL if current script did not define such an event handler.
        VMEventHandler*       handlerController; ///< VM representation of script's MIDI controller callback or NULL if current script did not define such an event handler.
        Pool<ScriptEvent>*    pEvents; ///< Pool of all available script execution instances. ScriptEvents available to be allocated from the Pool are currently unused / not executiong, whereas the ScriptEvents allocated on the list are currently suspended / have not finished execution yet (@see pKeyEvents).
        RTList<ScriptEvent>*  pKeyEvents[128]; ///< Stores previously finished executed "note on" script events for the respective active note/key as long as the key/note is active. This is however only done if there is a "note" script event handler and a "release" script event handler defined in the script and both handlers use (reference) polyphonic variables. If that is not the case, then this list is not used at all. So the purpose of pKeyEvents is only to implement preserving/passing polyphonic variable data from "on note .. end on" script block to the respective "on release .. end on" script block.
        RTAVLTree<ScriptEvent> suspendedEvents; ///< Contains pointers to all suspended events, sorted by time when those script events are to be resumed next.
        AbstractEngineChannel* pEngineChannel;
        String                code; ///< Source code of the instrument script. Used in case the sampler engine is changed, in that case a new ScriptVM object is created for the engine and VMParserContext object for this script needs to be recreated as well. Thus the script is then parsed again by passing the source code to recreate the parser context.
        EventGroup            eventGroups[INSTR_SCRIPT_EVENT_GROUPS]; ///< Used for built-in script functions: by_event_marks(), set_event_mark(), delete_event_mark().

        InstrumentScript(AbstractEngineChannel* pEngineChannel);
        ~InstrumentScript();

        void load(const String& text);
        void unload();
        void resetAll();
        void resetEvents();
    };

    /** @brief Real-time instrument script virtual machine.
     *
     * Extends the core ScriptVM implementation with MIDI specific built-in
     * script functions and MIDI specific built-in script variables required
     * for MIDI processing by instrument script for all sampler engine
     * implementations (sampler formats) of this sampler.
     *
     * Note that this class is currently re-entrant safe, but @b not thread
     * safe! See also comments of base class ScriptVM regarding this issue.
     */
    class InstrumentScriptVM : public ScriptVM {
    public:
        InstrumentScriptVM();
        VMExecStatus_t exec(VMParserContext* parserCtx, ScriptEvent* event);
        VMFunction* functionByName(const String& name) OVERRIDE;
        std::map<String,VMIntRelPtr*> builtInIntVariables() OVERRIDE;
        std::map<String,VMInt8Array*> builtInIntArrayVariables() OVERRIDE;
        std::map<String,int> builtInConstIntVariables() OVERRIDE;
        std::map<String,VMDynVar*> builtInDynamicVariables() OVERRIDE;
    protected:
        ScriptEvent* m_event; ///< The event currently executed by exec().

        // built-in script variables
        VMInt8Array m_CC;
        VMInt8RelPtr m_CC_NUM;
        VMIntRelPtr  m_EVENT_ID;
        VMInt8RelPtr m_EVENT_NOTE;
        VMInt8RelPtr m_EVENT_VELOCITY;
        VMInt8Array  m_KEY_DOWN;
        //VMIntArray m_POLY_AT; //TODO: ...
        //int m_POLY_AT_NUM; //TODO: ...
        VMIntRelPtr  m_NI_CALLBACK_TYPE;
        VMIntRelPtr  m_NKSP_IGNORE_WAIT;

        // built-in script functions
        InstrumentScriptVMFunction_play_note m_fnPlayNote;
        InstrumentScriptVMFunction_set_controller m_fnSetController;
        InstrumentScriptVMFunction_ignore_event m_fnIgnoreEvent;
        InstrumentScriptVMFunction_ignore_controller m_fnIgnoreController;
        InstrumentScriptVMFunction_note_off m_fnNoteOff;
        InstrumentScriptVMFunction_set_event_mark m_fnSetEventMark;
        InstrumentScriptVMFunction_delete_event_mark m_fnDeleteEventMark;
        InstrumentScriptVMFunction_by_marks m_fnByMarks;
        InstrumentScriptVMFunction_change_vol m_fnChangeVol;
        InstrumentScriptVMFunction_change_vol_time m_fnChangeVolTime;
        InstrumentScriptVMFunction_change_tune m_fnChangeTune;
        InstrumentScriptVMFunction_change_tune_time m_fnChangeTuneTime;
        InstrumentScriptVMFunction_change_pan m_fnChangePan;
        InstrumentScriptVMFunction_change_cutoff m_fnChangeCutoff;
        InstrumentScriptVMFunction_change_reso m_fnChangeReso;
        InstrumentScriptVMFunction_change_attack m_fnChangeAttack;
        InstrumentScriptVMFunction_change_decay m_fnChangeDecay;
        InstrumentScriptVMFunction_change_release m_fnChangeRelease;
        InstrumentScriptVMFunction_change_amp_lfo_depth m_fnChangeAmpLFODepth;
        InstrumentScriptVMFunction_change_amp_lfo_freq m_fnChangeAmpLFOFreq;
        InstrumentScriptVMFunction_change_pitch_lfo_depth m_fnChangePitchLFODepth;
        InstrumentScriptVMFunction_change_pitch_lfo_freq m_fnChangePitchLFOFreq;
        InstrumentScriptVMFunction_change_note m_fnChangeNote;
        InstrumentScriptVMFunction_change_velo m_fnChangeVelo;
        InstrumentScriptVMFunction_event_status m_fnEventStatus;
        InstrumentScriptVMFunction_wait m_fnWait2;
        InstrumentScriptVMFunction_stop_wait m_fnStopWait;
        InstrumentScriptVMFunction_fade_in m_fnFadeIn;
        InstrumentScriptVMFunction_fade_out m_fnFadeOut;
        InstrumentScriptVMFunction_change_vol_curve m_fnChangeVolCurve;
        InstrumentScriptVMFunction_change_tune_curve m_fnChangeTuneCurve;
        InstrumentScriptVMFunction_get_event_par m_fnGetEventPar;
        InstrumentScriptVMFunction_set_event_par m_fnSetEventPar;
        InstrumentScriptVMFunction_change_play_pos m_fnChangePlayPos;
        InstrumentScriptVMDynVar_ENGINE_UPTIME m_varEngineUptime;
        InstrumentScriptVMDynVar_NI_CALLBACK_ID m_varCallbackID;
        InstrumentScriptVMDynVar_ALL_EVENTS m_varAllEvents;

        friend class InstrumentScriptVMFunction_play_note;
        friend class InstrumentScriptVMFunction_set_controller;
        friend class InstrumentScriptVMFunction_ignore_event;
        friend class InstrumentScriptVMFunction_ignore_controller;
        friend class InstrumentScriptVMFunction_note_off;
        friend class InstrumentScriptVMFunction_set_event_mark;
        friend class InstrumentScriptVMFunction_delete_event_mark;
        friend class InstrumentScriptVMFunction_by_marks;
        friend class InstrumentScriptVMFunction_change_vol;
        friend class InstrumentScriptVMFunction_change_vol_time;
        friend class InstrumentScriptVMFunction_change_tune;
        friend class InstrumentScriptVMFunction_change_tune_time;
        friend class InstrumentScriptVMFunction_change_pan;
        friend class InstrumentScriptVMFunction_change_cutoff;
        friend class InstrumentScriptVMFunction_change_reso;
        friend class InstrumentScriptVMFunction_change_attack;
        friend class InstrumentScriptVMFunction_change_decay;
        friend class InstrumentScriptVMFunction_change_release;
        friend class VMChangeSynthParamFunction;
        friend class InstrumentScriptVMFunction_change_amp_lfo_depth;
        friend class InstrumentScriptVMFunction_change_amp_lfo_freq;
        friend class InstrumentScriptVMFunction_change_pitch_lfo_depth;
        friend class InstrumentScriptVMFunction_change_pitch_lfo_freq;
        friend class VMChangeFadeCurveFunction;
        friend class InstrumentScriptVMFunction_fade_in;
        friend class InstrumentScriptVMFunction_fade_out;
        friend class InstrumentScriptVMFunction_get_event_par;
        friend class InstrumentScriptVMFunction_set_event_par;
        friend class InstrumentScriptVMFunction_change_note;
        friend class InstrumentScriptVMFunction_change_velo;
        friend class InstrumentScriptVMFunction_change_play_pos;
        friend class InstrumentScriptVMFunction_event_status;
        friend class InstrumentScriptVMFunction_wait;
        friend class InstrumentScriptVMFunction_stop_wait;
        friend class InstrumentScriptVMDynVar_ENGINE_UPTIME;
        friend class InstrumentScriptVMDynVar_NI_CALLBACK_ID;
        friend class InstrumentScriptVMDynVar_ALL_EVENTS;
    };

} // namespace LinuxSampler

#endif // LS_INSTRUMENT_SCRIPT_VM_H
1	schoenebeck	2594	/*
2	schoenebeck	3073	* Copyright (c) 2014-2017 Christian Schoenebeck
3	schoenebeck	2594	*
4			* http://www.linuxsampler.org
5			*
6			* This file is part of LinuxSampler and released under the same terms.
7			* See README file for details.
8			*/
9
10			#ifndef LS_INSTRUMENT_SCRIPT_VM_H
11			#define LS_INSTRUMENT_SCRIPT_VM_H
12
13			#include "../../common/global.h"
14	schoenebeck	2630	#include "../../common/ConstCapacityArray.h"
15	schoenebeck	2594	#include "../../scriptvm/ScriptVM.h"
16			#include "Event.h"
17	schoenebeck	2611	#include "../../common/Pool.h"
18	schoenebeck	2596	#include "InstrumentScriptVMFunctions.h"
19	schoenebeck	2942	#include "InstrumentScriptVMDynVars.h"
20	schoenebeck	2594
21	schoenebeck	2879	/**
22			* Amount of bits on the left hand side of all pool_element_id_t numbers (i.e.
23			* event_id_t, note_id_t) being reserved for script VM implementation internal
24			* purposes.
25			*
26			* Right now there is only one bit reserved, which allows the VM (and its
27			* built-in functions) to distinguish user supplied @c Event IDs (event_id_t)
28			* from @c Note IDs (note_id_t).
29			*/
30			#define INSTR_SCRIPT_EVENT_ID_RESERVED_BITS 1
31
32			/**
33	schoenebeck	2948	* Used by InstrScriptIDType_T to initialize its constants at compile time.
34			*
35			* This macro is already ready to initialize additional members for
36			* InstrScriptIDType_T (that is more than the currently two enum constants).
37			* Just keep in mind that you also have to increase
38			* INSTR_SCRIPT_EVENT_ID_RESERVED_BITS when you add more!
39			*
40			* @param x - sequential consecutive number (starting with zero)
41	schoenebeck	2879	*/
42	schoenebeck	2948	#define INSTR_SCRIPT_ID_TYPE_FLAG(x) \
43			(x << (sizeof(pool_element_id_t) * 8 - INSTR_SCRIPT_EVENT_ID_RESERVED_BITS))
44	schoenebeck	2879
45	schoenebeck	2948	/**
46			* These flags are used to distinguish the individual ID Types in script scope
47			* from each other. They are added as most left bit(s) to each ID in script
48			* scope.
49			*/
50			enum InstrScriptIDType_T {
51			/**
52			* Used to mark IDs (in script scope) to actually be a MIDI event ID.
53			*/
54			INSTR_SCRIPT_EVENT_ID_FLAG = INSTR_SCRIPT_ID_TYPE_FLAG(0),
55
56			/**
57			* Used to mark IDs (in script scope) to actually be a note ID.
58			*/
59			INSTR_SCRIPT_NOTE_ID_FLAG = INSTR_SCRIPT_ID_TYPE_FLAG(1),
60			};
61
62	schoenebeck	2630	#define INSTR_SCRIPT_EVENT_GROUPS 28
63
64	schoenebeck	2935	#define EVENT_STATUS_INACTIVE 0
65			#define EVENT_STATUS_NOTE_QUEUE 1
66
67	schoenebeck	3193	enum {
68			EVENT_PAR_NOTE = 1,
69			EVENT_PAR_VELOCITY,
70			EVENT_PAR_VOLUME,
71			EVENT_PAR_TUNE,
72			EVENT_PAR_0 = 1024,
73			EVENT_PAR_1,
74			EVENT_PAR_2,
75			EVENT_PAR_3,
76			};
77
78	schoenebeck	2594	namespace LinuxSampler {
79
80	schoenebeck	2611	class AbstractEngineChannel;
81	schoenebeck	3034	struct InstrumentScript;
82	schoenebeck	2611
83	schoenebeck	2879	/** @brief Convert IDs between script scope and engine internal scope.
84			*
85			* This class is used to translate unique IDs of events between script
86			* scope and sampler engine internal scope, that is:
87			* @code
88			* int (script scope) -> event_id_t (engine internal scope)
89			* int (script scope) -> note_id_t (engine internal scope)
90			* @endcode
91			* and vice versa:
92			* @code
93			* event_id_t (engine internal scope) -> int (script scope)
94			* note_id_t (engine internal scope) -> int (script scope)
95			* @endcode
96	schoenebeck	2948	* This is required because engine internally i.e. notes and regular events
97			* are using their own, separate ID generating pool, and their ID number
98			* set may thus overlap and historically there were built-in script
99			* functions in KSP which allow to pass both regular MIDI event IDs, as well
100			* as Note IDs. So we must be able to distinguish between them in our
101			* built-in script function implementations.
102	schoenebeck	2879	*
103			* @see INSTR_SCRIPT_EVENT_ID_RESERVED_BITS
104			*/
105			class ScriptID {
106			public:
107			enum type_t {
108			EVENT, ///< ID is actually an event ID
109			NOTE, ///< ID is actually a note ID
110			};
111
112			/**
113			* Construct a ScriptID object with an ID from script scope.
114			*/
115			ScriptID(uint id) : m_id(id) {}
116
117			/**
118			* Returns a ScriptID object constructed with an event ID from engine
119			* internal scope.
120			*/
121			inline static ScriptID fromEventID(event_id_t id) {
122	schoenebeck	2948	return ScriptID(INSTR_SCRIPT_EVENT_ID_FLAG \| id);
123	schoenebeck	2879	}
124
125			/**
126			* Returns a ScriptID object constructed with a note ID from engine
127			* internal scope.
128			*/
129			inline static ScriptID fromNoteID(note_id_t id) {
130			return ScriptID(INSTR_SCRIPT_NOTE_ID_FLAG \| id);
131			}
132
133			/**
134			* Whether the ID reflected by this ScriptID object is actually a note
135			* ID or rather an event ID.
136			*/
137			inline type_t type() const {
138			return (m_id & INSTR_SCRIPT_NOTE_ID_FLAG) ? NOTE : EVENT;
139			}
140
141			inline bool isNoteID() const {
142			return type() == NOTE;
143			}
144
145			inline bool isEventID() const {
146			return type() == EVENT;
147			}
148
149			/**
150			* Returns event ID (for engine internal scope) of the ID reflected by
151			* this ScriptID object, it returns 0 (being an invalid ID) if the ID
152			* reflected by this ScriptID object is not an event ID.
153			*/
154			inline event_id_t eventID() const {
155			switch (type()) {
156			case EVENT: return m_id;
157			default: return 0; // not an event id, return invalid ID
158			}
159			}
160
161			/**
162			* Returns note ID (for engine internal scope) of the ID reflected by
163			* this ScriptID object, it returns 0 (being an invalid ID) if the ID
164			* reflected by this ScriptID object is not a note ID.
165			*/
166			inline note_id_t noteID() const {
167			switch (type()) {
168			case NOTE: return ~INSTR_SCRIPT_NOTE_ID_FLAG & m_id;
169			default: return 0; // not a note id, return invalid ID
170			}
171			}
172
173			/**
174			* Integer cast operator, which returns an ID number of this ScripID
175			* object intended for script scope.
176			*/
177			inline operator uint() const {
178			return m_id;
179			}
180
181			private:
182			uint m_id;
183			};
184
185	schoenebeck	2630	/** @brief List of Event IDs.
186			*
187			* Used for built-in script functions:
188			* by_marks(), set_event_mark(), delete_event_mark()
189			*/
190			class EventGroup : protected ConstCapacityArray<int> {
191			public:
192			EventGroup() : ConstCapacityArray<int>(CONFIG_MAX_EVENTS_PER_FRAGMENT), m_script(NULL) {}
193			void insert(int eventID);
194			void erase(int eventID);
195			void setScript(InstrumentScript* pScript) { m_script = pScript; }
196			inline int size() const { return ConstCapacityArray<int>::size(); }
197	schoenebeck	2871	inline void clear() { ConstCapacityArray<int>::clear(); }
198	schoenebeck	2630	inline int& operator[](uint index) { return ConstCapacityArray<int>::operator[](index); }
199			inline const int& operator[](uint index) const { return ConstCapacityArray<int>::operator[](index); }
200			protected:
201			InstrumentScript* m_script;
202			};
203
204	schoenebeck	2611	/** @brief Real-time instrument script VM representation.
205			*
206			* Holds the VM representation of all event handlers of the currently loaded
207			* script, ready to be executed by the sampler engine.
208	schoenebeck	2645	*
209			* Even thought scripts (or to be more specific their event handler objects)
210			* are shared between sampler engine channels, the InstrumentScript struct
211			* instances though are not shared. Each sampler engine channel has its own
212			* instance of a InstrumentScript struct. That's important, because this
213			* struct also holds engine channel local informations, for example the
214			* events that occured on the respective engine channel.
215	schoenebeck	2611	*/
216			struct InstrumentScript {
217			VMParserContext* parserContext; ///< VM represenation of the currently loaded script or NULL if not script was loaded. Note that it is also not NULL if parser errors occurred!
218			bool bHasValidScript; ///< True in case there is a valid script currently loaded, false if script processing shall be skipped.
219			VMEventHandler* handlerInit; ///< VM representation of script's initilization callback or NULL if current script did not define such an init handler.
220			VMEventHandler* handlerNote; ///< VM representation of script's MIDI note on callback or NULL if current script did not define such an event handler.
221			VMEventHandler* handlerRelease; ///< VM representation of script's MIDI note off callback or NULL if current script did not define such an event handler.
222			VMEventHandler* handlerController; ///< VM representation of script's MIDI controller callback or NULL if current script did not define such an event handler.
223	schoenebeck	2645	Pool<ScriptEvent>* pEvents; ///< Pool of all available script execution instances. ScriptEvents available to be allocated from the Pool are currently unused / not executiong, whereas the ScriptEvents allocated on the list are currently suspended / have not finished execution yet (@see pKeyEvents).
224			RTList<ScriptEvent>* pKeyEvents[128]; ///< Stores previously finished executed "note on" script events for the respective active note/key as long as the key/note is active. This is however only done if there is a "note" script event handler and a "release" script event handler defined in the script and both handlers use (reference) polyphonic variables. If that is not the case, then this list is not used at all. So the purpose of pKeyEvents is only to implement preserving/passing polyphonic variable data from "on note .. end on" script block to the respective "on release .. end on" script block.
225	schoenebeck	2871	RTAVLTree<ScriptEvent> suspendedEvents; ///< Contains pointers to all suspended events, sorted by time when those script events are to be resumed next.
226	schoenebeck	2611	AbstractEngineChannel* pEngineChannel;
227	schoenebeck	2612	String code; ///< Source code of the instrument script. Used in case the sampler engine is changed, in that case a new ScriptVM object is created for the engine and VMParserContext object for this script needs to be recreated as well. Thus the script is then parsed again by passing the source code to recreate the parser context.
228	schoenebeck	2630	EventGroup eventGroups[INSTR_SCRIPT_EVENT_GROUPS]; ///< Used for built-in script functions: by_event_marks(), set_event_mark(), delete_event_mark().
229	schoenebeck	2611
230	schoenebeck	2630	InstrumentScript(AbstractEngineChannel* pEngineChannel);
231	schoenebeck	2645	~InstrumentScript();
232	schoenebeck	2611
233			void load(const String& text);
234	schoenebeck	2612	void unload();
235			void resetAll();
236	schoenebeck	2871	void resetEvents();
237	schoenebeck	2611	};
238
239	schoenebeck	2594	/** @brief Real-time instrument script virtual machine.
240			*
241			* Extends the core ScriptVM implementation with MIDI specific built-in
242			* script functions and MIDI specific built-in script variables required
243			* for MIDI processing by instrument script for all sampler engine
244			* implementations (sampler formats) of this sampler.
245			*
246			* Note that this class is currently re-entrant safe, but @b not thread
247			* safe! See also comments of base class ScriptVM regarding this issue.
248			*/
249			class InstrumentScriptVM : public ScriptVM {
250			public:
251			InstrumentScriptVM();
252			VMExecStatus_t exec(VMParserContext* parserCtx, ScriptEvent* event);
253	schoenebeck	2596	VMFunction* functionByName(const String& name) OVERRIDE;
254	schoenebeck	2594	std::map<String,VMIntRelPtr*> builtInIntVariables() OVERRIDE;
255			std::map<String,VMInt8Array*> builtInIntArrayVariables() OVERRIDE;
256			std::map<String,int> builtInConstIntVariables() OVERRIDE;
257	schoenebeck	2942	std::map<String,VMDynVar*> builtInDynamicVariables() OVERRIDE;
258	schoenebeck	2594	protected:
259			ScriptEvent* m_event; ///< The event currently executed by exec().
260
261	schoenebeck	3082	// built-in script variables
262	schoenebeck	2594	VMInt8Array m_CC;
263			VMInt8RelPtr m_CC_NUM;
264	schoenebeck	2598	VMIntRelPtr m_EVENT_ID;
265	schoenebeck	2594	VMInt8RelPtr m_EVENT_NOTE;
266			VMInt8RelPtr m_EVENT_VELOCITY;
267	schoenebeck	2613	VMInt8Array m_KEY_DOWN;
268	schoenebeck	2594	//VMIntArray m_POLY_AT; //TODO: ...
269			//int m_POLY_AT_NUM; //TODO: ...
270	schoenebeck	2948	VMIntRelPtr m_NI_CALLBACK_TYPE;
271			VMIntRelPtr m_NKSP_IGNORE_WAIT;
272	schoenebeck	2596
273	schoenebeck	3082	// built-in script functions
274	schoenebeck	2596	InstrumentScriptVMFunction_play_note m_fnPlayNote;
275	schoenebeck	2600	InstrumentScriptVMFunction_set_controller m_fnSetController;
276			InstrumentScriptVMFunction_ignore_event m_fnIgnoreEvent;
277			InstrumentScriptVMFunction_ignore_controller m_fnIgnoreController;
278	schoenebeck	2629	InstrumentScriptVMFunction_note_off m_fnNoteOff;
279	schoenebeck	2630	InstrumentScriptVMFunction_set_event_mark m_fnSetEventMark;
280			InstrumentScriptVMFunction_delete_event_mark m_fnDeleteEventMark;
281			InstrumentScriptVMFunction_by_marks m_fnByMarks;
282	schoenebeck	2931	InstrumentScriptVMFunction_change_vol m_fnChangeVol;
283	schoenebeck	3188	InstrumentScriptVMFunction_change_vol_time m_fnChangeVolTime;
284	schoenebeck	2931	InstrumentScriptVMFunction_change_tune m_fnChangeTune;
285	schoenebeck	3188	InstrumentScriptVMFunction_change_tune_time m_fnChangeTuneTime;
286	schoenebeck	2931	InstrumentScriptVMFunction_change_pan m_fnChangePan;
287	schoenebeck	2935	InstrumentScriptVMFunction_change_cutoff m_fnChangeCutoff;
288			InstrumentScriptVMFunction_change_reso m_fnChangeReso;
289	schoenebeck	2953	InstrumentScriptVMFunction_change_attack m_fnChangeAttack;
290			InstrumentScriptVMFunction_change_decay m_fnChangeDecay;
291			InstrumentScriptVMFunction_change_release m_fnChangeRelease;
292	schoenebeck	3118	InstrumentScriptVMFunction_change_amp_lfo_depth m_fnChangeAmpLFODepth;
293			InstrumentScriptVMFunction_change_amp_lfo_freq m_fnChangeAmpLFOFreq;
294			InstrumentScriptVMFunction_change_pitch_lfo_depth m_fnChangePitchLFODepth;
295			InstrumentScriptVMFunction_change_pitch_lfo_freq m_fnChangePitchLFOFreq;
296	schoenebeck	3214	InstrumentScriptVMFunction_change_note m_fnChangeNote;
297			InstrumentScriptVMFunction_change_velo m_fnChangeVelo;
298	schoenebeck	2935	InstrumentScriptVMFunction_event_status m_fnEventStatus;
299	schoenebeck	2948	InstrumentScriptVMFunction_wait m_fnWait2;
300			InstrumentScriptVMFunction_stop_wait m_fnStopWait;
301	schoenebeck	3188	InstrumentScriptVMFunction_fade_in m_fnFadeIn;
302			InstrumentScriptVMFunction_fade_out m_fnFadeOut;
303	schoenebeck	3246	InstrumentScriptVMFunction_change_vol_curve m_fnChangeVolCurve;
304			InstrumentScriptVMFunction_change_tune_curve m_fnChangeTuneCurve;
305	schoenebeck	3193	InstrumentScriptVMFunction_get_event_par m_fnGetEventPar;
306			InstrumentScriptVMFunction_set_event_par m_fnSetEventPar;
307	schoenebeck	3255	InstrumentScriptVMFunction_change_play_pos m_fnChangePlayPos;
308	schoenebeck	2942	InstrumentScriptVMDynVar_ENGINE_UPTIME m_varEngineUptime;
309	schoenebeck	2948	InstrumentScriptVMDynVar_NI_CALLBACK_ID m_varCallbackID;
310	schoenebeck	3073	InstrumentScriptVMDynVar_ALL_EVENTS m_varAllEvents;
311	schoenebeck	2596
312			friend class InstrumentScriptVMFunction_play_note;
313	schoenebeck	2600	friend class InstrumentScriptVMFunction_set_controller;
314	schoenebeck	2598	friend class InstrumentScriptVMFunction_ignore_event;
315			friend class InstrumentScriptVMFunction_ignore_controller;
316	schoenebeck	2629	friend class InstrumentScriptVMFunction_note_off;
317	schoenebeck	2630	friend class InstrumentScriptVMFunction_set_event_mark;
318			friend class InstrumentScriptVMFunction_delete_event_mark;
319			friend class InstrumentScriptVMFunction_by_marks;
320	schoenebeck	2931	friend class InstrumentScriptVMFunction_change_vol;
321	schoenebeck	3188	friend class InstrumentScriptVMFunction_change_vol_time;
322	schoenebeck	2931	friend class InstrumentScriptVMFunction_change_tune;
323	schoenebeck	3188	friend class InstrumentScriptVMFunction_change_tune_time;
324	schoenebeck	2931	friend class InstrumentScriptVMFunction_change_pan;
325	schoenebeck	2935	friend class InstrumentScriptVMFunction_change_cutoff;
326			friend class InstrumentScriptVMFunction_change_reso;
327	schoenebeck	2953	friend class InstrumentScriptVMFunction_change_attack;
328			friend class InstrumentScriptVMFunction_change_decay;
329			friend class InstrumentScriptVMFunction_change_release;
330	schoenebeck	3118	friend class VMChangeSynthParamFunction;
331			friend class InstrumentScriptVMFunction_change_amp_lfo_depth;
332			friend class InstrumentScriptVMFunction_change_amp_lfo_freq;
333			friend class InstrumentScriptVMFunction_change_pitch_lfo_depth;
334			friend class InstrumentScriptVMFunction_change_pitch_lfo_freq;
335	schoenebeck	3246	friend class VMChangeFadeCurveFunction;
336	schoenebeck	3188	friend class InstrumentScriptVMFunction_fade_in;
337			friend class InstrumentScriptVMFunction_fade_out;
338	schoenebeck	3193	friend class InstrumentScriptVMFunction_get_event_par;
339			friend class InstrumentScriptVMFunction_set_event_par;
340	schoenebeck	3214	friend class InstrumentScriptVMFunction_change_note;
341			friend class InstrumentScriptVMFunction_change_velo;
342	schoenebeck	3255	friend class InstrumentScriptVMFunction_change_play_pos;
343	schoenebeck	2935	friend class InstrumentScriptVMFunction_event_status;
344	schoenebeck	2948	friend class InstrumentScriptVMFunction_wait;
345			friend class InstrumentScriptVMFunction_stop_wait;
346	schoenebeck	2942	friend class InstrumentScriptVMDynVar_ENGINE_UPTIME;
347	schoenebeck	2948	friend class InstrumentScriptVMDynVar_NI_CALLBACK_ID;
348	schoenebeck	3073	friend class InstrumentScriptVMDynVar_ALL_EVENTS;
349	schoenebeck	2594	};
350
351			} // namespace LinuxSampler
352
353			#endif // LS_INSTRUMENT_SCRIPT_VM_H