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

        // 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	/*
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	#include "../../common/global_private.h"
13	#include "AbstractInstrumentManager.h"
14	#include "MidiKeyboardManager.h"
15
16	namespace LinuxSampler {
17
18	///////////////////////////////////////////////////////////////////////
19	// 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	// class 'InstrumentScript'
54
55	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	for (int i = 0; i < 128; ++i)
64	pKeyEvents[i] = NULL;
65	this->pEngineChannel = pEngineChannel;
66	for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i)
67	eventGroups[i].setScript(this);
68	}
69
70	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	/** @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	unload();
94
95	code = text;
96
97	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	if (!pEvents) {
125	pEvents = new Pool<ScriptEvent>(CONFIG_MAX_EVENTS_PER_FRAGMENT);
126	for (int i = 0; i < 128; ++i)
127	pKeyEvents[i] = new RTList<ScriptEvent>(pEvents);
128	}
129
130	// create new VM execution contexts for new script
131	while (!pEvents->poolIsEmpty()) {
132	RTList<ScriptEvent>::Iterator it = pEvents->allocAppend();
133	it->execCtx = pEngineChannel->pEngine->pScriptVM->createExecContext(
134	parserContext
135	);
136	it->handlers = new VMEventHandler*[handlerExecCount+1];
137	}
138	pEvents->clear();
139
140	dmsg(1,("Done\n"));
141	}
142
143	/** @brief Unload real-time instrument script.
144	*
145	* Unloads the currently used real-time instrument script and frees all
146	* resources allocated for that script. The sampler engine's resource manager
147	* is used to share equivalent scripts among multiple sampler channels, and
148	* to deallocate the parsed script once not used on any engine channel
149	* anymore.
150	*
151	* Calling this method will however not clear the @c code member variable.
152	* Thus, the script can be parsed again afterwards.
153	*/
154	void InstrumentScript::unload() {
155	//dmsg(1,("InstrumentScript::unload(this=0x%llx)\n", this));
156
157	if (parserContext)
158	dmsg(1,("Unloading current instrument script.\n"));
159
160	// free allocated VM execution contexts
161	if (pEvents) {
162	pEvents->clear();
163	while (!pEvents->poolIsEmpty()) {
164	RTList<ScriptEvent>::Iterator it = pEvents->allocAppend();
165	if (it->execCtx) {
166	// free VM execution context object
167	delete it->execCtx;
168	it->execCtx = NULL;
169	// free C array of handler pointers
170	delete [] it->handlers;
171	}
172	}
173	pEvents->clear();
174	}
175	// hand back VM representation of script
176	if (parserContext) {
177	AbstractInstrumentManager* pManager =
178	dynamic_cast<AbstractInstrumentManager*>(pEngineChannel->pEngine->GetInstrumentManager());
179
180	pManager->scripts.HandBack(parserContext, pEngineChannel);
181	parserContext = NULL;
182	handlerInit = NULL;
183	handlerNote = NULL;
184	handlerRelease = NULL;
185	handlerController = NULL;
186	}
187	bHasValidScript = false;
188	}
189
190	/**
191	* Same as unload(), but this one also empties the @c code member variable
192	* to an empty string.
193	*/
194	void InstrumentScript::resetAll() {
195	unload();
196	code.clear();
197	}
198
199	///////////////////////////////////////////////////////////////////////
200	// class 'InstrumentScriptVM'
201
202	InstrumentScriptVM::InstrumentScriptVM() :
203	m_event(NULL), m_fnPlayNote(this), m_fnSetController(this),
204	m_fnIgnoreEvent(this), m_fnIgnoreController(this), m_fnNoteOff(this),
205	m_fnSetEventMark(this), m_fnDeleteEventMark(this), m_fnByMarks(this)
206	{
207	m_CC.size = _MEMBER_SIZEOF(AbstractEngineChannel, ControllerTable);
208	m_CC_NUM = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.CC.Controller);
209	m_EVENT_ID = DECLARE_VMINT(m_event, class ScriptEvent, id);
210	m_EVENT_NOTE = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Key);
211	m_EVENT_VELOCITY = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Velocity);
212	m_KEY_DOWN.size = 128;
213	}
214
215	VMExecStatus_t InstrumentScriptVM::exec(VMParserContext* parserCtx, ScriptEvent* event) {
216	AbstractEngineChannel* pEngineChannel =
217	static_cast<AbstractEngineChannel*>(event->cause.pEngineChannel);
218
219	// prepare built-in script variables for script execution
220	m_event = event;
221	m_CC.data = (int8_t*) &pEngineChannel->ControllerTable[0];
222	m_KEY_DOWN.data = &pEngineChannel->GetMidiKeyboardManager()->KeyDown[0];
223
224	// if script is in start condition, then do mandatory MIDI event
225	// preprocessing tasks, which essentially means updating i.e. controller
226	// table with new CC value in case of a controller event, because the
227	// script might access the new CC value
228	if (!event->executionSlices) {
229	switch (event->cause.Type) {
230	case Event::type_control_change:
231	pEngineChannel->ControllerTable[event->cause.Param.CC.Controller] =
232	event->cause.Param.CC.Value;
233	break;
234	case Event::type_channel_pressure:
235	pEngineChannel->ControllerTable[CTRL_TABLE_IDX_AFTERTOUCH] =
236	event->cause.Param.ChannelPressure.Value;
237	break;
238	case Event::type_pitchbend:
239	pEngineChannel->ControllerTable[CTRL_TABLE_IDX_PITCHBEND] =
240	event->cause.Param.Pitch.Pitch;
241	break;
242	}
243	}
244
245	// run the script handler(s)
246	VMExecStatus_t res = VM_EXEC_NOT_RUNNING;
247	for ( ; event->handlers[event->currentHandler]; event->currentHandler++) {
248	res = ScriptVM::exec(
249	parserCtx, event->execCtx, event->handlers[event->currentHandler]
250	);
251	event->executionSlices++;
252	if (res & VM_EXEC_SUSPENDED \|\| res & VM_EXEC_ERROR) return res;
253	}
254
255	return res;
256	}
257
258	std::map<String,VMIntRelPtr*> InstrumentScriptVM::builtInIntVariables() {
259	// first get buil-in integer variables of derived VM class
260	std::map<String,VMIntRelPtr*> m = ScriptVM::builtInIntVariables();
261
262	// now add own built-in variables
263	m["$CC_NUM"] = &m_CC_NUM;
264	m["$EVENT_ID"] = &m_EVENT_ID;
265	m["$EVENT_NOTE"] = &m_EVENT_NOTE;
266	m["$EVENT_VELOCITY"] = &m_EVENT_VELOCITY;
267	// m["$POLY_AT_NUM"] = &m_POLY_AT_NUM;
268
269	return m;
270	}
271
272	std::map<String,VMInt8Array*> InstrumentScriptVM::builtInIntArrayVariables() {
273	// first get buil-in integer array variables of derived VM class
274	std::map<String,VMInt8Array*> m = ScriptVM::builtInIntArrayVariables();
275
276	// now add own built-in variables
277	m["%CC"] = &m_CC;
278	m["%KEY_DOWN"] = &m_KEY_DOWN;
279	//m["%POLY_AT"] = &m_POLY_AT;
280
281	return m;
282	}
283
284	std::map<String,int> InstrumentScriptVM::builtInConstIntVariables() {
285	// first get buil-in integer variables of derived VM class
286	std::map<String,int> m = ScriptVM::builtInConstIntVariables();
287
288	m["$VCC_MONO_AT"] = CTRL_TABLE_IDX_AFTERTOUCH;
289	m["$VCC_PITCH_BEND"] = CTRL_TABLE_IDX_PITCHBEND;
290	for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i) {
291	m["$MARK_" + ToString(i+1)] = i;
292	}
293
294	return m;
295	}
296
297	VMFunction* InstrumentScriptVM::functionByName(const String& name) {
298	// built-in script functions of this class
299	if (name == "play_note") return &m_fnPlayNote;
300	else if (name == "set_controller") return &m_fnSetController;
301	else if (name == "ignore_event") return &m_fnIgnoreEvent;
302	else if (name == "ignore_controller") return &m_fnIgnoreController;
303	else if (name == "note_off") return &m_fnNoteOff;
304	else if (name == "set_event_mark") return &m_fnSetEventMark;
305	else if (name == "delete_event_mark") return &m_fnDeleteEventMark;
306	else if (name == "by_marks") return &m_fnByMarks;
307
308	// built-in script functions of derived VM class
309	return ScriptVM::functionByName(name);
310	}
311
312	} // namespace LinuxSampler