engines/common/InstrumentScriptVM.cpp

/*
 * 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.
 */

#include "../../common/global_private.h"
#include "InstrumentScriptVM.h"
#include "../AbstractEngineChannel.h"
#include "../../common/global_private.h"
#include "AbstractInstrumentManager.h"
#include "MidiKeyboardManager.h"
#include "Fade.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_fnChangeVolTime(this),
        m_fnChangeTune(this), m_fnChangeTuneTime(this), m_fnChangePan(this),
        m_fnChangePanTime(this), m_fnChangePanCurve(this),
        m_fnChangeCutoff(this), m_fnChangeReso(this),  m_fnChangeAttack(this),
        m_fnChangeDecay(this), m_fnChangeSustain(this), m_fnChangeRelease(this),
        m_fnChangeAmpLFODepth(this), m_fnChangeAmpLFOFreq(this),
        m_fnChangePitchLFODepth(this), m_fnChangePitchLFOFreq(this),
        m_fnChangeNote(this), m_fnChangeVelo(this), m_fnFork(this),
        m_fnEventStatus(this), m_fnWait2(this), m_fnStopWait(this),
        m_fnAbort(this), m_fnFadeIn(this), m_fnFadeOut(this),
        m_fnChangeVolCurve(this), m_fnChangeTuneCurve(this),
        m_fnGetEventPar(this), m_fnSetEventPar(this), m_fnChangePlayPos(this),
        m_fnCallbackStatus(this),
        m_varEngineUptime(this), m_varCallbackID(this), m_varAllEvents(this),
        m_varCallbackChildID(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_READONLY(m_event, class ScriptEvent, cause.Param.Note.Key);
        m_EVENT_VELOCITY = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, cause.Param.Note.Velocity);
        m_KEY_DOWN.size = 128;
        m_KEY_DOWN.readonly = true;
        m_NI_CALLBACK_TYPE = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, handlerType);
        m_NKSP_IGNORE_WAIT = DECLARE_VMINT(m_event, class ScriptEvent, ignoreAllWaitCalls);
        m_NKSP_CALLBACK_PARENT_ID = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, parentHandlerID);
    }

    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;
                default:
                    ; // noop
            }
        }

        // 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)) { // if script terminated ...
                // check if this script handler instance has any forked children
                // to be auto aborted
                for (int iChild = 0; iChild < MAX_FORK_PER_SCRIPT_HANDLER &&
                     event->childHandlerID[iChild]; ++iChild)
                {
                    RTList<ScriptEvent>::Iterator itChild =
                        pEngineChannel->ScriptCallbackByID(event->childHandlerID[iChild]);
                    if (itChild && itChild->autoAbortByParent)
                        itChild->execCtx->signalAbort();
                }
            }
            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;
        m["$NKSP_CALLBACK_PARENT_ID"] = &m_NKSP_CALLBACK_PARENT_ID;

        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;
        }
        m["$EVENT_PAR_NOTE"] = EVENT_PAR_NOTE;
        m["$EVENT_PAR_VELOCITY"] = EVENT_PAR_VELOCITY;
        m["$EVENT_PAR_VOLUME"] = EVENT_PAR_VOLUME;
        m["$EVENT_PAR_TUNE"] = EVENT_PAR_TUNE;
        m["$EVENT_PAR_0"] = EVENT_PAR_0;
        m["$EVENT_PAR_1"] = EVENT_PAR_1;
        m["$EVENT_PAR_2"] = EVENT_PAR_2;
        m["$EVENT_PAR_3"] = EVENT_PAR_3;
        m["$NKSP_LINEAR"] = FADE_CURVE_LINEAR;
        m["$NKSP_EASE_IN_EASE_OUT"] = FADE_CURVE_EASE_IN_EASE_OUT;
        m["$CALLBACK_STATUS_TERMINATED"] = CALLBACK_STATUS_TERMINATED;
        m["$CALLBACK_STATUS_QUEUE"]      = CALLBACK_STATUS_QUEUE;
        m["$CALLBACK_STATUS_RUNNING"]    = CALLBACK_STATUS_RUNNING;

        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["%ALL_EVENTS"] = &m_varAllEvents;
        m["$ENGINE_UPTIME"] = &m_varEngineUptime;
        m["$NI_CALLBACK_ID"] = &m_varCallbackID;
        m["%NKSP_CALLBACK_CHILD_ID"] = &m_varCallbackChildID;

        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_vol_time") return &m_fnChangeVolTime;
        else if (name == "change_tune") return &m_fnChangeTune;
        else if (name == "change_tune_time") return &m_fnChangeTuneTime;
        else if (name == "change_note") return &m_fnChangeNote;
        else if (name == "change_velo") return &m_fnChangeVelo;
        else if (name == "change_pan") return &m_fnChangePan;
        else if (name == "change_pan_time") return &m_fnChangePanTime;
        else if (name == "change_pan_curve") return &m_fnChangePanCurve;
        else if (name == "change_cutoff") return &m_fnChangeCutoff;
        else if (name == "change_reso") return &m_fnChangeReso;
        else if (name == "change_attack") return &m_fnChangeAttack;
        else if (name == "change_decay") return &m_fnChangeDecay;
        else if (name == "change_sustain") return &m_fnChangeSustain;
        else if (name == "change_release") return &m_fnChangeRelease;
        else if (name == "change_amp_lfo_depth") return &m_fnChangeAmpLFODepth;
        else if (name == "change_amp_lfo_freq") return &m_fnChangeAmpLFOFreq;
        else if (name == "change_pitch_lfo_depth") return &m_fnChangePitchLFODepth;
        else if (name == "change_pitch_lfo_freq") return &m_fnChangePitchLFOFreq;
        else if (name == "fade_in") return &m_fnFadeIn;
        else if (name == "fade_out") return &m_fnFadeOut;
        else if (name == "change_vol_curve") return &m_fnChangeVolCurve;
        else if (name == "change_tune_curve") return &m_fnChangeTuneCurve;
        else if (name == "change_play_pos") return &m_fnChangePlayPos;
        else if (name == "get_event_par") return &m_fnGetEventPar;
        else if (name == "set_event_par") return &m_fnSetEventPar;
        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;
        else if (name == "abort") return &m_fnAbort;
        else if (name == "fork") return &m_fnFork;
        else if (name == "callback_status") return &m_fnCallbackStatus;

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

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