engines/common/InstrumentScriptVM.cpp

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

#include "InstrumentScriptVM.h"
#include "../AbstractEngineChannel.h"
#include "../../common/global_private.h"
#include "AbstractInstrumentManager.h"
#include "MidiKeyboardManager.h"

namespace LinuxSampler {

    ///////////////////////////////////////////////////////////////////////
    // class 'EventGroup'

    void EventGroup::insert(int eventID) {
        if (contains(eventID)) return;

        AbstractEngine* pEngine = m_script->pEngineChannel->pEngine;

        // before adding the new event ID, check if there are any dead events
        // and remove them in that case, before otherwise we might run in danger
        // to run out of free space on this group for event IDs if a lot of
        // events die before being removed explicitly from the group by script
        //
        // NOTE: or should we do this "dead ones" check only once in a while?
        int firstDead = -1;
        for (int i = 0; i < size(); ++i) {
            if (firstDead >= 0) {
                if (pEngine->EventByID(eventID)) {
                    remove(firstDead, i - firstDead);
                    firstDead = -1;
                }
            } else {
                if (!pEngine->EventByID(eventID)) firstDead = i;
            }
        }

        append(eventID);
    }

    void EventGroup::erase(int eventID) {
        int index = find(eventID);
        remove(index);
    }

    ///////////////////////////////////////////////////////////////////////
    // class 'InstrumentScript'

    InstrumentScript::InstrumentScript(AbstractEngineChannel* pEngineChannel) {
        parserContext = NULL;
        bHasValidScript = false;
        handlerInit = NULL;
        handlerNote = NULL;
        handlerRelease = NULL;
        handlerController = NULL;
        pEvents = NULL;
        for (int i = 0; i < 128; ++i)
            pKeyEvents[i] = NULL;
        this->pEngineChannel = pEngineChannel;
        for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i)
            eventGroups[i].setScript(this);
    }

    InstrumentScript::~InstrumentScript() {
        resetAll();
        if (pEvents) {
            for (int i = 0; i < 128; ++i) delete pKeyEvents[i];
            delete pEvents;
        }
    }

    /** @brief Load real-time instrument script.
     *
     * Loads the real-time instrument script given by @a text on the engine
     * channel this InstrumentScript object belongs to (defined by
     * pEngineChannel member variable). The sampler engine's resource manager is
     * used to allocate and share equivalent scripts on multiple engine
     * channels.
     *
     * @param text - source code of script
     */
    void InstrumentScript::load(const String& text) {
        dmsg(1,("Loading real-time instrument script ... "));

        // hand back old script reference and VM execution contexts
        // (if not done already)
        unload();

        code = text;

        AbstractInstrumentManager* pManager =
            dynamic_cast<AbstractInstrumentManager*>(pEngineChannel->pEngine->GetInstrumentManager());

        // get new script reference
        parserContext = pManager->scripts.Borrow(text, pEngineChannel);
        if (!parserContext->errors().empty()) {
            std::vector<ParserIssue> errors = parserContext->errors();
            std::cerr << "[ScriptVM] Could not load instrument script, there were "
                    << errors.size() << " parser errors:\n";
            for (int i = 0; i < errors.size(); ++i)
                errors[i].dump();
            return; // stop here if there were any parser errors
        }

        handlerInit = parserContext->eventHandlerByName("init");
        handlerNote = parserContext->eventHandlerByName("note");
        handlerRelease = parserContext->eventHandlerByName("release");
        handlerController = parserContext->eventHandlerByName("controller");
        bHasValidScript =
            handlerInit || handlerNote || handlerRelease || handlerController;

        // amount of script handlers each script event has to execute
        int handlerExecCount = 0;
        if (handlerNote || handlerRelease || handlerController) // only one of these are executed after "init" handler
            handlerExecCount++;

        // create script event pool (if it doesn't exist already)
        if (!pEvents) {
            pEvents = new Pool<ScriptEvent>(CONFIG_MAX_EVENTS_PER_FRAGMENT);
            for (int i = 0; i < 128; ++i)
                pKeyEvents[i] = new RTList<ScriptEvent>(pEvents);
            // reset RTAVLNode's tree node member variables after nodes are allocated
            // (since we can't use a constructor right now, we do that initialization here)
            while (!pEvents->poolIsEmpty()) {
                RTList<ScriptEvent>::Iterator it = pEvents->allocAppend();
                it->reset();
            }
            pEvents->clear();
        }

        // create new VM execution contexts for new script
        while (!pEvents->poolIsEmpty()) {
            RTList<ScriptEvent>::Iterator it = pEvents->allocAppend();
            it->execCtx = pEngineChannel->pEngine->pScriptVM->createExecContext(
                parserContext
            );
            it->handlers = new VMEventHandler*[handlerExecCount+1];
        }
        pEvents->clear();

        dmsg(1,("Done\n"));
    }

    /** @brief Unload real-time instrument script.
     *
     * Unloads the currently used real-time instrument script and frees all
     * resources allocated for that script. The sampler engine's resource manager
     * is used to share equivalent scripts among multiple sampler channels, and
     * to deallocate the parsed script once not used on any engine channel
     * anymore.
     *
     * Calling this method will however not clear the @c code member variable.
     * Thus, the script can be parsed again afterwards.
     */
    void InstrumentScript::unload() {
        //dmsg(1,("InstrumentScript::unload(this=0x%llx)\n", this));

        if (parserContext)
            dmsg(1,("Unloading current instrument script.\n"));

        resetEvents();

        // free allocated VM execution contexts
        if (pEvents) {
            pEvents->clear();
            while (!pEvents->poolIsEmpty()) {
                RTList<ScriptEvent>::Iterator it = pEvents->allocAppend();
                if (it->execCtx) {
                    // free VM execution context object
                    delete it->execCtx;
                    it->execCtx = NULL;
                    // free C array of handler pointers
                    delete [] it->handlers;
                }
            }
            pEvents->clear();
        }
        // hand back VM representation of script
        if (parserContext) {
            AbstractInstrumentManager* pManager =
                dynamic_cast<AbstractInstrumentManager*>(pEngineChannel->pEngine->GetInstrumentManager());

            pManager->scripts.HandBack(parserContext, pEngineChannel);
            parserContext = NULL;
            handlerInit = NULL;
            handlerNote = NULL;
            handlerRelease = NULL;
            handlerController = NULL;
        }
        bHasValidScript = false;
    }

    /**
     * Same as unload(), but this one also empties the @c code member variable
     * to an empty string.
     */
    void InstrumentScript::resetAll() {
        unload();
        code.clear();
    }
    
    /**
     * Clears all currently active script events. This should be called
     * whenever the engine or engine channel was reset for some reason.
     */
    void InstrumentScript::resetEvents() {
        for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i)
            eventGroups[i].clear();

        for (int i = 0; i < 128; ++i)
            if (pKeyEvents[i])
                pKeyEvents[i]->clear();

        suspendedEvents.clear();

        if (pEvents) pEvents->clear();
    }

    ///////////////////////////////////////////////////////////////////////
    // class 'InstrumentScriptVM'

    InstrumentScriptVM::InstrumentScriptVM() :
        m_event(NULL), m_fnPlayNote(this), m_fnSetController(this),
        m_fnIgnoreEvent(this), m_fnIgnoreController(this), m_fnNoteOff(this),
        m_fnSetEventMark(this), m_fnDeleteEventMark(this), m_fnByMarks(this),
        m_fnChangeVol(this), m_fnChangeTune(this), m_fnChangePan(this),
        m_fnChangeCutoff(this), m_fnChangeReso(this), m_fnEventStatus(this),
        m_fnWait2(this), m_fnStopWait(this),
        m_varEngineUptime(this), m_varCallbackID(this)
    {
        m_CC.size = _MEMBER_SIZEOF(AbstractEngineChannel, ControllerTable);
        m_CC_NUM = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.CC.Controller);
        m_EVENT_ID = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, id);
        m_EVENT_NOTE = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Key);
        m_EVENT_VELOCITY = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Velocity);
        m_KEY_DOWN.size = 128;
        m_NI_CALLBACK_TYPE = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, handlerType);
        m_NKSP_IGNORE_WAIT = DECLARE_VMINT(m_event, class ScriptEvent, ignoreAllWaitCalls);
    }

    VMExecStatus_t InstrumentScriptVM::exec(VMParserContext* parserCtx, ScriptEvent* event) {
        AbstractEngineChannel* pEngineChannel =
            static_cast<AbstractEngineChannel*>(event->cause.pEngineChannel);

        // prepare built-in script variables for script execution
        m_event = event;
        m_CC.data = (int8_t*) &pEngineChannel->ControllerTable[0];
        m_KEY_DOWN.data = &pEngineChannel->GetMidiKeyboardManager()->KeyDown[0];

        // if script is in start condition, then do mandatory MIDI event
        // preprocessing tasks, which essentially means updating i.e. controller
        // table with new CC value in case of a controller event, because the
        // script might access the new CC value
        if (!event->executionSlices) {
            switch (event->cause.Type) {
                case Event::type_control_change:
                    pEngineChannel->ControllerTable[event->cause.Param.CC.Controller] =
                        event->cause.Param.CC.Value;
                    break;
                case Event::type_channel_pressure:
                    pEngineChannel->ControllerTable[CTRL_TABLE_IDX_AFTERTOUCH] =
                        event->cause.Param.ChannelPressure.Value;
                    break;
                case Event::type_pitchbend:
                    pEngineChannel->ControllerTable[CTRL_TABLE_IDX_PITCHBEND] =
                        event->cause.Param.Pitch.Pitch;
                    break;
            }
        }

        // run the script handler(s)
        VMExecStatus_t res = VM_EXEC_NOT_RUNNING;
        for ( ; event->handlers[event->currentHandler]; event->currentHandler++) {
            res = ScriptVM::exec(
                parserCtx, event->execCtx, event->handlers[event->currentHandler]
            );
            event->executionSlices++;
            if (res & VM_EXEC_SUSPENDED || res & VM_EXEC_ERROR) return res;
        }

        return res;
    }

    std::map<String,VMIntRelPtr*> InstrumentScriptVM::builtInIntVariables() {
        // first get built-in integer variables of derived VM class
        std::map<String,VMIntRelPtr*> m = ScriptVM::builtInIntVariables();

        // now add own built-in variables
        m["$CC_NUM"] = &m_CC_NUM;
        m["$EVENT_ID"] = &m_EVENT_ID;
        m["$EVENT_NOTE"] = &m_EVENT_NOTE;
        m["$EVENT_VELOCITY"] = &m_EVENT_VELOCITY;
//         m["$POLY_AT_NUM"] = &m_POLY_AT_NUM;
        m["$NI_CALLBACK_TYPE"] = &m_NI_CALLBACK_TYPE;
        m["$NKSP_IGNORE_WAIT"] = &m_NKSP_IGNORE_WAIT;

        return m;
    }

    std::map<String,VMInt8Array*> InstrumentScriptVM::builtInIntArrayVariables() {
        // first get built-in integer array variables of derived VM class
        std::map<String,VMInt8Array*> m = ScriptVM::builtInIntArrayVariables();

        // now add own built-in variables
        m["%CC"] = &m_CC;
        m["%KEY_DOWN"] = &m_KEY_DOWN;
        //m["%POLY_AT"] = &m_POLY_AT;

        return m;
    }

    std::map<String,int> InstrumentScriptVM::builtInConstIntVariables() {
        // first get built-in integer variables of derived VM class
        std::map<String,int> m = ScriptVM::builtInConstIntVariables();

        m["$EVENT_STATUS_INACTIVE"] = EVENT_STATUS_INACTIVE;
        m["$EVENT_STATUS_NOTE_QUEUE"] = EVENT_STATUS_NOTE_QUEUE;
        m["$VCC_MONO_AT"] = CTRL_TABLE_IDX_AFTERTOUCH;
        m["$VCC_PITCH_BEND"] = CTRL_TABLE_IDX_PITCHBEND;
        for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i) {
            m["$MARK_" + ToString(i+1)] = i;
        }

        return m;
    }

    std::map<String,VMDynVar*> InstrumentScriptVM::builtInDynamicVariables() {
        // first get built-in dynamic variables of derived VM class
        std::map<String,VMDynVar*> m = ScriptVM::builtInDynamicVariables();

        m["$ENGINE_UPTIME"] = &m_varEngineUptime;
        m["$NI_CALLBACK_ID"] = &m_varCallbackID;

        return m;
    }

    VMFunction* InstrumentScriptVM::functionByName(const String& name) {
        // built-in script functions of this class
        if      (name == "play_note") return &m_fnPlayNote;
        else if (name == "set_controller") return &m_fnSetController;
        else if (name == "ignore_event") return &m_fnIgnoreEvent;
        else if (name == "ignore_controller") return &m_fnIgnoreController;
        else if (name == "note_off") return &m_fnNoteOff;
        else if (name == "set_event_mark") return &m_fnSetEventMark;
        else if (name == "delete_event_mark") return &m_fnDeleteEventMark;
        else if (name == "by_marks") return &m_fnByMarks;
        else if (name == "change_vol") return &m_fnChangeVol;
        else if (name == "change_tune") return &m_fnChangeTune;
        else if (name == "change_pan") return &m_fnChangePan;
        else if (name == "change_cutoff") return &m_fnChangeCutoff;
        else if (name == "change_reso") return &m_fnChangeReso;
        else if (name == "event_status") return &m_fnEventStatus;
        else if (name == "wait") return &m_fnWait2; // override wait() core implementation
        else if (name == "stop_wait") return &m_fnStopWait;

        // built-in script functions of derived VM class
        return ScriptVM::functionByName(name);
    }

} // namespace LinuxSampler
1	schoenebeck	2594	/*
2	schoenebeck	2871	* Copyright (c) 2014 - 2016 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			#include "InstrumentScriptVM.h"
11			#include "../AbstractEngineChannel.h"
12	schoenebeck	2600	#include "../../common/global_private.h"
13	schoenebeck	2611	#include "AbstractInstrumentManager.h"
14	schoenebeck	2613	#include "MidiKeyboardManager.h"
15	schoenebeck	2594
16			namespace LinuxSampler {
17
18	schoenebeck	2611	///////////////////////////////////////////////////////////////////////
19	schoenebeck	2630	// class 'EventGroup'
20
21			void EventGroup::insert(int eventID) {
22			if (contains(eventID)) return;
23
24			AbstractEngine* pEngine = m_script->pEngineChannel->pEngine;
25
26			// before adding the new event ID, check if there are any dead events
27			// and remove them in that case, before otherwise we might run in danger
28			// to run out of free space on this group for event IDs if a lot of
29			// events die before being removed explicitly from the group by script
30			//
31			// NOTE: or should we do this "dead ones" check only once in a while?
32			int firstDead = -1;
33			for (int i = 0; i < size(); ++i) {
34			if (firstDead >= 0) {
35			if (pEngine->EventByID(eventID)) {
36			remove(firstDead, i - firstDead);
37			firstDead = -1;
38			}
39			} else {
40			if (!pEngine->EventByID(eventID)) firstDead = i;
41			}
42			}
43
44			append(eventID);
45			}
46
47			void EventGroup::erase(int eventID) {
48			int index = find(eventID);
49			remove(index);
50			}
51
52			///////////////////////////////////////////////////////////////////////
53	schoenebeck	2611	// class 'InstrumentScript'
54
55	schoenebeck	2630	InstrumentScript::InstrumentScript(AbstractEngineChannel* pEngineChannel) {
56			parserContext = NULL;
57			bHasValidScript = false;
58			handlerInit = NULL;
59			handlerNote = NULL;
60			handlerRelease = NULL;
61			handlerController = NULL;
62			pEvents = NULL;
63	schoenebeck	2645	for (int i = 0; i < 128; ++i)
64			pKeyEvents[i] = NULL;
65	schoenebeck	2630	this->pEngineChannel = pEngineChannel;
66			for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i)
67			eventGroups[i].setScript(this);
68			}
69
70	schoenebeck	2645	InstrumentScript::~InstrumentScript() {
71			resetAll();
72			if (pEvents) {
73			for (int i = 0; i < 128; ++i) delete pKeyEvents[i];
74			delete pEvents;
75			}
76			}
77
78	schoenebeck	2611	/** @brief Load real-time instrument script.
79			*
80			* Loads the real-time instrument script given by @a text on the engine
81			* channel this InstrumentScript object belongs to (defined by
82			* pEngineChannel member variable). The sampler engine's resource manager is
83			* used to allocate and share equivalent scripts on multiple engine
84			* channels.
85			*
86			* @param text - source code of script
87			*/
88			void InstrumentScript::load(const String& text) {
89			dmsg(1,("Loading real-time instrument script ... "));
90
91			// hand back old script reference and VM execution contexts
92			// (if not done already)
93	schoenebeck	2612	unload();
94	schoenebeck	2611
95	schoenebeck	2612	code = text;
96
97	schoenebeck	2611	AbstractInstrumentManager* pManager =
98			dynamic_cast<AbstractInstrumentManager*>(pEngineChannel->pEngine->GetInstrumentManager());
99
100			// get new script reference
101			parserContext = pManager->scripts.Borrow(text, pEngineChannel);
102			if (!parserContext->errors().empty()) {
103			std::vector<ParserIssue> errors = parserContext->errors();
104			std::cerr << "[ScriptVM] Could not load instrument script, there were "
105			<< errors.size() << " parser errors:\n";
106			for (int i = 0; i < errors.size(); ++i)
107			errors[i].dump();
108			return; // stop here if there were any parser errors
109			}
110
111			handlerInit = parserContext->eventHandlerByName("init");
112			handlerNote = parserContext->eventHandlerByName("note");
113			handlerRelease = parserContext->eventHandlerByName("release");
114			handlerController = parserContext->eventHandlerByName("controller");
115			bHasValidScript =
116			handlerInit \|\| handlerNote \|\| handlerRelease \|\| handlerController;
117
118			// amount of script handlers each script event has to execute
119			int handlerExecCount = 0;
120			if (handlerNote \|\| handlerRelease \|\| handlerController) // only one of these are executed after "init" handler
121			handlerExecCount++;
122
123			// create script event pool (if it doesn't exist already)
124	schoenebeck	2645	if (!pEvents) {
125	schoenebeck	2611	pEvents = new Pool<ScriptEvent>(CONFIG_MAX_EVENTS_PER_FRAGMENT);
126	schoenebeck	2645	for (int i = 0; i < 128; ++i)
127			pKeyEvents[i] = new RTList<ScriptEvent>(pEvents);
128	schoenebeck	2948	// reset RTAVLNode's tree node member variables after nodes are allocated
129			// (since we can't use a constructor right now, we do that initialization here)
130			while (!pEvents->poolIsEmpty()) {
131			RTList<ScriptEvent>::Iterator it = pEvents->allocAppend();
132			it->reset();
133			}
134			pEvents->clear();
135	schoenebeck	2645	}
136	schoenebeck	2611
137			// create new VM execution contexts for new script
138			while (!pEvents->poolIsEmpty()) {
139			RTList<ScriptEvent>::Iterator it = pEvents->allocAppend();
140			it->execCtx = pEngineChannel->pEngine->pScriptVM->createExecContext(
141			parserContext
142			);
143			it->handlers = new VMEventHandler*[handlerExecCount+1];
144			}
145			pEvents->clear();
146
147			dmsg(1,("Done\n"));
148			}
149
150			/** @brief Unload real-time instrument script.
151			*
152			* Unloads the currently used real-time instrument script and frees all
153			* resources allocated for that script. The sampler engine's resource manager
154			* is used to share equivalent scripts among multiple sampler channels, and
155			* to deallocate the parsed script once not used on any engine channel
156			* anymore.
157	schoenebeck	2612	*
158	schoenebeck	2614	* Calling this method will however not clear the @c code member variable.
159	schoenebeck	2612	* Thus, the script can be parsed again afterwards.
160	schoenebeck	2611	*/
161	schoenebeck	2612	void InstrumentScript::unload() {
162	schoenebeck	2618	//dmsg(1,("InstrumentScript::unload(this=0x%llx)\n", this));
163
164	schoenebeck	2611	if (parserContext)
165	schoenebeck	2612	dmsg(1,("Unloading current instrument script.\n"));
166	schoenebeck	2611
167	schoenebeck	2871	resetEvents();
168
169	schoenebeck	2611	// free allocated VM execution contexts
170			if (pEvents) {
171			pEvents->clear();
172			while (!pEvents->poolIsEmpty()) {
173			RTList<ScriptEvent>::Iterator it = pEvents->allocAppend();
174			if (it->execCtx) {
175			// free VM execution context object
176			delete it->execCtx;
177			it->execCtx = NULL;
178			// free C array of handler pointers
179			delete [] it->handlers;
180			}
181			}
182			pEvents->clear();
183			}
184			// hand back VM representation of script
185			if (parserContext) {
186			AbstractInstrumentManager* pManager =
187			dynamic_cast<AbstractInstrumentManager*>(pEngineChannel->pEngine->GetInstrumentManager());
188
189			pManager->scripts.HandBack(parserContext, pEngineChannel);
190			parserContext = NULL;
191			handlerInit = NULL;
192			handlerNote = NULL;
193			handlerRelease = NULL;
194			handlerController = NULL;
195			}
196			bHasValidScript = false;
197			}
198
199	schoenebeck	2612	/**
200			* Same as unload(), but this one also empties the @c code member variable
201			* to an empty string.
202			*/
203			void InstrumentScript::resetAll() {
204			unload();
205			code.clear();
206			}
207	schoenebeck	2871
208			/**
209			* Clears all currently active script events. This should be called
210			* whenever the engine or engine channel was reset for some reason.
211			*/
212			void InstrumentScript::resetEvents() {
213			for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i)
214			eventGroups[i].clear();
215	schoenebeck	2612
216	schoenebeck	2871	for (int i = 0; i < 128; ++i)
217			if (pKeyEvents[i])
218			pKeyEvents[i]->clear();
219
220			suspendedEvents.clear();
221
222			if (pEvents) pEvents->clear();
223			}
224
225	schoenebeck	2611	///////////////////////////////////////////////////////////////////////
226			// class 'InstrumentScriptVM'
227
228	schoenebeck	2596	InstrumentScriptVM::InstrumentScriptVM() :
229	schoenebeck	2600	m_event(NULL), m_fnPlayNote(this), m_fnSetController(this),
230	schoenebeck	2630	m_fnIgnoreEvent(this), m_fnIgnoreController(this), m_fnNoteOff(this),
231	schoenebeck	2931	m_fnSetEventMark(this), m_fnDeleteEventMark(this), m_fnByMarks(this),
232	schoenebeck	2935	m_fnChangeVol(this), m_fnChangeTune(this), m_fnChangePan(this),
233	schoenebeck	2942	m_fnChangeCutoff(this), m_fnChangeReso(this), m_fnEventStatus(this),
234	schoenebeck	2948	m_fnWait2(this), m_fnStopWait(this),
235			m_varEngineUptime(this), m_varCallbackID(this)
236	schoenebeck	2596	{
237	schoenebeck	2595	m_CC.size = _MEMBER_SIZEOF(AbstractEngineChannel, ControllerTable);
238	schoenebeck	2598	m_CC_NUM = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.CC.Controller);
239	schoenebeck	2948	m_EVENT_ID = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, id);
240	schoenebeck	2598	m_EVENT_NOTE = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Key);
241			m_EVENT_VELOCITY = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Velocity);
242	schoenebeck	2613	m_KEY_DOWN.size = 128;
243	schoenebeck	2948	m_NI_CALLBACK_TYPE = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, handlerType);
244			m_NKSP_IGNORE_WAIT = DECLARE_VMINT(m_event, class ScriptEvent, ignoreAllWaitCalls);
245	schoenebeck	2594	}
246
247			VMExecStatus_t InstrumentScriptVM::exec(VMParserContext* parserCtx, ScriptEvent* event) {
248			AbstractEngineChannel* pEngineChannel =
249			static_cast<AbstractEngineChannel*>(event->cause.pEngineChannel);
250
251			// prepare built-in script variables for script execution
252	schoenebeck	2598	m_event = event;
253	schoenebeck	2594	m_CC.data = (int8_t*) &pEngineChannel->ControllerTable[0];
254	schoenebeck	2613	m_KEY_DOWN.data = &pEngineChannel->GetMidiKeyboardManager()->KeyDown[0];
255	schoenebeck	2594
256			// if script is in start condition, then do mandatory MIDI event
257			// preprocessing tasks, which essentially means updating i.e. controller
258			// table with new CC value in case of a controller event, because the
259			// script might access the new CC value
260			if (!event->executionSlices) {
261	schoenebeck	2598	switch (event->cause.Type) {
262	schoenebeck	2594	case Event::type_control_change:
263	schoenebeck	2598	pEngineChannel->ControllerTable[event->cause.Param.CC.Controller] =
264			event->cause.Param.CC.Value;
265	schoenebeck	2594	break;
266			case Event::type_channel_pressure:
267			pEngineChannel->ControllerTable[CTRL_TABLE_IDX_AFTERTOUCH] =
268	schoenebeck	2598	event->cause.Param.ChannelPressure.Value;
269	schoenebeck	2594	break;
270			case Event::type_pitchbend:
271			pEngineChannel->ControllerTable[CTRL_TABLE_IDX_PITCHBEND] =
272	schoenebeck	2598	event->cause.Param.Pitch.Pitch;
273	schoenebeck	2594	break;
274			}
275			}
276
277			// run the script handler(s)
278			VMExecStatus_t res = VM_EXEC_NOT_RUNNING;
279	schoenebeck	2596	for ( ; event->handlers[event->currentHandler]; event->currentHandler++) {
280	schoenebeck	2594	res = ScriptVM::exec(
281	schoenebeck	2596	parserCtx, event->execCtx, event->handlers[event->currentHandler]
282	schoenebeck	2594	);
283			event->executionSlices++;
284			if (res & VM_EXEC_SUSPENDED \|\| res & VM_EXEC_ERROR) return res;
285			}
286
287			return res;
288			}
289
290			std::map<String,VMIntRelPtr*> InstrumentScriptVM::builtInIntVariables() {
291	schoenebeck	2942	// first get built-in integer variables of derived VM class
292	schoenebeck	2594	std::map<String,VMIntRelPtr*> m = ScriptVM::builtInIntVariables();
293
294			// now add own built-in variables
295			m["$CC_NUM"] = &m_CC_NUM;
296	schoenebeck	2598	m["$EVENT_ID"] = &m_EVENT_ID;
297	schoenebeck	2594	m["$EVENT_NOTE"] = &m_EVENT_NOTE;
298			m["$EVENT_VELOCITY"] = &m_EVENT_VELOCITY;
299			// m["$POLY_AT_NUM"] = &m_POLY_AT_NUM;
300	schoenebeck	2948	m["$NI_CALLBACK_TYPE"] = &m_NI_CALLBACK_TYPE;
301			m["$NKSP_IGNORE_WAIT"] = &m_NKSP_IGNORE_WAIT;
302	schoenebeck	2594
303			return m;
304			}
305
306			std::map<String,VMInt8Array*> InstrumentScriptVM::builtInIntArrayVariables() {
307	schoenebeck	2942	// first get built-in integer array variables of derived VM class
308	schoenebeck	2594	std::map<String,VMInt8Array*> m = ScriptVM::builtInIntArrayVariables();
309
310			// now add own built-in variables
311			m["%CC"] = &m_CC;
312	schoenebeck	2613	m["%KEY_DOWN"] = &m_KEY_DOWN;
313	schoenebeck	2594	//m["%POLY_AT"] = &m_POLY_AT;
314
315			return m;
316			}
317
318			std::map<String,int> InstrumentScriptVM::builtInConstIntVariables() {
319	schoenebeck	2942	// first get built-in integer variables of derived VM class
320	schoenebeck	2594	std::map<String,int> m = ScriptVM::builtInConstIntVariables();
321
322	schoenebeck	2935	m["$EVENT_STATUS_INACTIVE"] = EVENT_STATUS_INACTIVE;
323			m["$EVENT_STATUS_NOTE_QUEUE"] = EVENT_STATUS_NOTE_QUEUE;
324	schoenebeck	2594	m["$VCC_MONO_AT"] = CTRL_TABLE_IDX_AFTERTOUCH;
325			m["$VCC_PITCH_BEND"] = CTRL_TABLE_IDX_PITCHBEND;
326	schoenebeck	2630	for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i) {
327			m["$MARK_" + ToString(i+1)] = i;
328			}
329	schoenebeck	2594
330			return m;
331			}
332
333	schoenebeck	2942	std::map<String,VMDynVar*> InstrumentScriptVM::builtInDynamicVariables() {
334			// first get built-in dynamic variables of derived VM class
335			std::map<String,VMDynVar*> m = ScriptVM::builtInDynamicVariables();
336
337			m["$ENGINE_UPTIME"] = &m_varEngineUptime;
338	schoenebeck	2948	m["$NI_CALLBACK_ID"] = &m_varCallbackID;
339	schoenebeck	2942
340			return m;
341			}
342
343	schoenebeck	2596	VMFunction* InstrumentScriptVM::functionByName(const String& name) {
344			// built-in script functions of this class
345	schoenebeck	2598	if (name == "play_note") return &m_fnPlayNote;
346	schoenebeck	2600	else if (name == "set_controller") return &m_fnSetController;
347	schoenebeck	2598	else if (name == "ignore_event") return &m_fnIgnoreEvent;
348			else if (name == "ignore_controller") return &m_fnIgnoreController;
349	schoenebeck	2629	else if (name == "note_off") return &m_fnNoteOff;
350	schoenebeck	2630	else if (name == "set_event_mark") return &m_fnSetEventMark;
351			else if (name == "delete_event_mark") return &m_fnDeleteEventMark;
352			else if (name == "by_marks") return &m_fnByMarks;
353	schoenebeck	2931	else if (name == "change_vol") return &m_fnChangeVol;
354			else if (name == "change_tune") return &m_fnChangeTune;
355			else if (name == "change_pan") return &m_fnChangePan;
356	schoenebeck	2935	else if (name == "change_cutoff") return &m_fnChangeCutoff;
357			else if (name == "change_reso") return &m_fnChangeReso;
358			else if (name == "event_status") return &m_fnEventStatus;
359	schoenebeck	2948	else if (name == "wait") return &m_fnWait2; // override wait() core implementation
360			else if (name == "stop_wait") return &m_fnStopWait;
361	schoenebeck	2596
362			// built-in script functions of derived VM class
363			return ScriptVM::functionByName(name);
364			}
365
366	schoenebeck	2594	} // namespace LinuxSampler