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 '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;
        this->pEngineChannel = pEngineChannel;
        for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i)
            eventGroups[i].setScript(this);
    }

    /** @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_fnSetEventMark(this), m_fnDeleteEventMark(this), m_fnByMarks(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;
        for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i) {
            m["$MARK_" + ToString(i+1)] = i;
        }

        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;

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