engines/common/InstrumentScriptVM.cpp

/*
 * Copyright (c) 2014 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 'InstrumentScript'

    /** @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);

        // 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"));

        // 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();
    }

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

    InstrumentScriptVM::InstrumentScriptVM() :
        m_event(NULL), m_fnPlayNote(this), m_fnSetController(this),
        m_fnIgnoreEvent(this), m_fnIgnoreController(this), m_fnNoteOff(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(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;
    }

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

        return m;
    }

    std::map<String,VMInt8Array*> InstrumentScriptVM::builtInIntArrayVariables() {
        // first get buil-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 buil-in integer variables of derived VM class
        std::map<String,int> m = ScriptVM::builtInConstIntVariables();

        m["$VCC_MONO_AT"] = CTRL_TABLE_IDX_AFTERTOUCH;
        m["$VCC_PITCH_BEND"] = CTRL_TABLE_IDX_PITCHBEND;

        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;

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

} // namespace LinuxSampler
1	schoenebeck	2594	/*
2			* Copyright (c) 2014 Christian Schoenebeck
3			*
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			// class 'InstrumentScript'
20
21			/** @brief Load real-time instrument script.
22			*
23			* Loads the real-time instrument script given by @a text on the engine
24			* channel this InstrumentScript object belongs to (defined by
25			* pEngineChannel member variable). The sampler engine's resource manager is
26			* used to allocate and share equivalent scripts on multiple engine
27			* channels.
28			*
29			* @param text - source code of script
30			*/
31			void InstrumentScript::load(const String& text) {
32			dmsg(1,("Loading real-time instrument script ... "));
33
34			// hand back old script reference and VM execution contexts
35			// (if not done already)
36	schoenebeck	2612	unload();
37	schoenebeck	2611
38	schoenebeck	2612	code = text;
39
40	schoenebeck	2611	AbstractInstrumentManager* pManager =
41			dynamic_cast<AbstractInstrumentManager*>(pEngineChannel->pEngine->GetInstrumentManager());
42
43			// get new script reference
44			parserContext = pManager->scripts.Borrow(text, pEngineChannel);
45			if (!parserContext->errors().empty()) {
46			std::vector<ParserIssue> errors = parserContext->errors();
47			std::cerr << "[ScriptVM] Could not load instrument script, there were "
48			<< errors.size() << " parser errors:\n";
49			for (int i = 0; i < errors.size(); ++i)
50			errors[i].dump();
51			return; // stop here if there were any parser errors
52			}
53
54			handlerInit = parserContext->eventHandlerByName("init");
55			handlerNote = parserContext->eventHandlerByName("note");
56			handlerRelease = parserContext->eventHandlerByName("release");
57			handlerController = parserContext->eventHandlerByName("controller");
58			bHasValidScript =
59			handlerInit \|\| handlerNote \|\| handlerRelease \|\| handlerController;
60
61			// amount of script handlers each script event has to execute
62			int handlerExecCount = 0;
63			if (handlerNote \|\| handlerRelease \|\| handlerController) // only one of these are executed after "init" handler
64			handlerExecCount++;
65
66			// create script event pool (if it doesn't exist already)
67			if (!pEvents)
68			pEvents = new Pool<ScriptEvent>(CONFIG_MAX_EVENTS_PER_FRAGMENT);
69
70			// create new VM execution contexts for new script
71			while (!pEvents->poolIsEmpty()) {
72			RTList<ScriptEvent>::Iterator it = pEvents->allocAppend();
73			it->execCtx = pEngineChannel->pEngine->pScriptVM->createExecContext(
74			parserContext
75			);
76			it->handlers = new VMEventHandler*[handlerExecCount+1];
77			}
78			pEvents->clear();
79
80			dmsg(1,("Done\n"));
81			}
82
83			/** @brief Unload real-time instrument script.
84			*
85			* Unloads the currently used real-time instrument script and frees all
86			* resources allocated for that script. The sampler engine's resource manager
87			* is used to share equivalent scripts among multiple sampler channels, and
88			* to deallocate the parsed script once not used on any engine channel
89			* anymore.
90	schoenebeck	2612	*
91	schoenebeck	2614	* Calling this method will however not clear the @c code member variable.
92	schoenebeck	2612	* Thus, the script can be parsed again afterwards.
93	schoenebeck	2611	*/
94	schoenebeck	2612	void InstrumentScript::unload() {
95	schoenebeck	2618	//dmsg(1,("InstrumentScript::unload(this=0x%llx)\n", this));
96
97	schoenebeck	2611	if (parserContext)
98	schoenebeck	2612	dmsg(1,("Unloading current instrument script.\n"));
99	schoenebeck	2611
100			// free allocated VM execution contexts
101			if (pEvents) {
102			pEvents->clear();
103			while (!pEvents->poolIsEmpty()) {
104			RTList<ScriptEvent>::Iterator it = pEvents->allocAppend();
105			if (it->execCtx) {
106			// free VM execution context object
107			delete it->execCtx;
108			it->execCtx = NULL;
109			// free C array of handler pointers
110			delete [] it->handlers;
111			}
112			}
113			pEvents->clear();
114			}
115			// hand back VM representation of script
116			if (parserContext) {
117			AbstractInstrumentManager* pManager =
118			dynamic_cast<AbstractInstrumentManager*>(pEngineChannel->pEngine->GetInstrumentManager());
119
120			pManager->scripts.HandBack(parserContext, pEngineChannel);
121			parserContext = NULL;
122			handlerInit = NULL;
123			handlerNote = NULL;
124			handlerRelease = NULL;
125			handlerController = NULL;
126			}
127			bHasValidScript = false;
128			}
129
130	schoenebeck	2612	/**
131			* Same as unload(), but this one also empties the @c code member variable
132			* to an empty string.
133			*/
134			void InstrumentScript::resetAll() {
135			unload();
136			code.clear();
137			}
138
139	schoenebeck	2611	///////////////////////////////////////////////////////////////////////
140			// class 'InstrumentScriptVM'
141
142	schoenebeck	2596	InstrumentScriptVM::InstrumentScriptVM() :
143	schoenebeck	2600	m_event(NULL), m_fnPlayNote(this), m_fnSetController(this),
144	schoenebeck	2629	m_fnIgnoreEvent(this), m_fnIgnoreController(this), m_fnNoteOff(this)
145	schoenebeck	2596	{
146	schoenebeck	2595	m_CC.size = _MEMBER_SIZEOF(AbstractEngineChannel, ControllerTable);
147	schoenebeck	2598	m_CC_NUM = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.CC.Controller);
148			m_EVENT_ID = DECLARE_VMINT(m_event, class ScriptEvent, id);
149			m_EVENT_NOTE = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Key);
150			m_EVENT_VELOCITY = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Velocity);
151	schoenebeck	2613	m_KEY_DOWN.size = 128;
152	schoenebeck	2594	}
153
154			VMExecStatus_t InstrumentScriptVM::exec(VMParserContext* parserCtx, ScriptEvent* event) {
155			AbstractEngineChannel* pEngineChannel =
156			static_cast<AbstractEngineChannel*>(event->cause.pEngineChannel);
157
158			// prepare built-in script variables for script execution
159	schoenebeck	2598	m_event = event;
160	schoenebeck	2594	m_CC.data = (int8_t*) &pEngineChannel->ControllerTable[0];
161	schoenebeck	2613	m_KEY_DOWN.data = &pEngineChannel->GetMidiKeyboardManager()->KeyDown[0];
162	schoenebeck	2594
163			// if script is in start condition, then do mandatory MIDI event
164			// preprocessing tasks, which essentially means updating i.e. controller
165			// table with new CC value in case of a controller event, because the
166			// script might access the new CC value
167			if (!event->executionSlices) {
168	schoenebeck	2598	switch (event->cause.Type) {
169	schoenebeck	2594	case Event::type_control_change:
170	schoenebeck	2598	pEngineChannel->ControllerTable[event->cause.Param.CC.Controller] =
171			event->cause.Param.CC.Value;
172	schoenebeck	2594	break;
173			case Event::type_channel_pressure:
174			pEngineChannel->ControllerTable[CTRL_TABLE_IDX_AFTERTOUCH] =
175	schoenebeck	2598	event->cause.Param.ChannelPressure.Value;
176	schoenebeck	2594	break;
177			case Event::type_pitchbend:
178			pEngineChannel->ControllerTable[CTRL_TABLE_IDX_PITCHBEND] =
179	schoenebeck	2598	event->cause.Param.Pitch.Pitch;
180	schoenebeck	2594	break;
181			}
182			}
183
184			// run the script handler(s)
185			VMExecStatus_t res = VM_EXEC_NOT_RUNNING;
186	schoenebeck	2596	for ( ; event->handlers[event->currentHandler]; event->currentHandler++) {
187	schoenebeck	2594	res = ScriptVM::exec(
188	schoenebeck	2596	parserCtx, event->execCtx, event->handlers[event->currentHandler]
189	schoenebeck	2594	);
190			event->executionSlices++;
191			if (res & VM_EXEC_SUSPENDED \|\| res & VM_EXEC_ERROR) return res;
192			}
193
194			return res;
195			}
196
197			std::map<String,VMIntRelPtr*> InstrumentScriptVM::builtInIntVariables() {
198			// first get buil-in integer variables of derived VM class
199			std::map<String,VMIntRelPtr*> m = ScriptVM::builtInIntVariables();
200
201			// now add own built-in variables
202			m["$CC_NUM"] = &m_CC_NUM;
203	schoenebeck	2598	m["$EVENT_ID"] = &m_EVENT_ID;
204	schoenebeck	2594	m["$EVENT_NOTE"] = &m_EVENT_NOTE;
205			m["$EVENT_VELOCITY"] = &m_EVENT_VELOCITY;
206			// m["$POLY_AT_NUM"] = &m_POLY_AT_NUM;
207
208			return m;
209			}
210
211			std::map<String,VMInt8Array*> InstrumentScriptVM::builtInIntArrayVariables() {
212			// first get buil-in integer array variables of derived VM class
213			std::map<String,VMInt8Array*> m = ScriptVM::builtInIntArrayVariables();
214
215			// now add own built-in variables
216			m["%CC"] = &m_CC;
217	schoenebeck	2613	m["%KEY_DOWN"] = &m_KEY_DOWN;
218	schoenebeck	2594	//m["%POLY_AT"] = &m_POLY_AT;
219
220			return m;
221			}
222
223			std::map<String,int> InstrumentScriptVM::builtInConstIntVariables() {
224			// first get buil-in integer variables of derived VM class
225			std::map<String,int> m = ScriptVM::builtInConstIntVariables();
226
227			m["$VCC_MONO_AT"] = CTRL_TABLE_IDX_AFTERTOUCH;
228			m["$VCC_PITCH_BEND"] = CTRL_TABLE_IDX_PITCHBEND;
229
230			return m;
231			}
232
233	schoenebeck	2596	VMFunction* InstrumentScriptVM::functionByName(const String& name) {
234			// built-in script functions of this class
235	schoenebeck	2598	if (name == "play_note") return &m_fnPlayNote;
236	schoenebeck	2600	else if (name == "set_controller") return &m_fnSetController;
237	schoenebeck	2598	else if (name == "ignore_event") return &m_fnIgnoreEvent;
238			else if (name == "ignore_controller") return &m_fnIgnoreController;
239	schoenebeck	2629	else if (name == "note_off") return &m_fnNoteOff;
240	schoenebeck	2596
241			// built-in script functions of derived VM class
242			return ScriptVM::functionByName(name);
243			}
244
245	schoenebeck	2594	} // namespace LinuxSampler