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"

namespace LinuxSampler {

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

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

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

        // 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	2594
14			namespace LinuxSampler {
15
16	schoenebeck	2596	InstrumentScriptVM::InstrumentScriptVM() :
17	schoenebeck	2600	m_event(NULL), m_fnPlayNote(this), m_fnSetController(this),
18			m_fnIgnoreEvent(this), m_fnIgnoreController(this)
19	schoenebeck	2596	{
20	schoenebeck	2595	m_CC.size = _MEMBER_SIZEOF(AbstractEngineChannel, ControllerTable);
21	schoenebeck	2598	m_CC_NUM = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.CC.Controller);
22			m_EVENT_ID = DECLARE_VMINT(m_event, class ScriptEvent, id);
23			m_EVENT_NOTE = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Key);
24			m_EVENT_VELOCITY = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Velocity);
25	schoenebeck	2594	}
26
27			VMExecStatus_t InstrumentScriptVM::exec(VMParserContext* parserCtx, ScriptEvent* event) {
28			AbstractEngineChannel* pEngineChannel =
29			static_cast<AbstractEngineChannel*>(event->cause.pEngineChannel);
30
31			// prepare built-in script variables for script execution
32	schoenebeck	2598	m_event = event;
33	schoenebeck	2594	m_CC.data = (int8_t*) &pEngineChannel->ControllerTable[0];
34
35			// if script is in start condition, then do mandatory MIDI event
36			// preprocessing tasks, which essentially means updating i.e. controller
37			// table with new CC value in case of a controller event, because the
38			// script might access the new CC value
39			if (!event->executionSlices) {
40	schoenebeck	2598	switch (event->cause.Type) {
41	schoenebeck	2594	case Event::type_control_change:
42	schoenebeck	2598	pEngineChannel->ControllerTable[event->cause.Param.CC.Controller] =
43			event->cause.Param.CC.Value;
44	schoenebeck	2594	break;
45			case Event::type_channel_pressure:
46			pEngineChannel->ControllerTable[CTRL_TABLE_IDX_AFTERTOUCH] =
47	schoenebeck	2598	event->cause.Param.ChannelPressure.Value;
48	schoenebeck	2594	break;
49			case Event::type_pitchbend:
50			pEngineChannel->ControllerTable[CTRL_TABLE_IDX_PITCHBEND] =
51	schoenebeck	2598	event->cause.Param.Pitch.Pitch;
52	schoenebeck	2594	break;
53			}
54			}
55
56			// run the script handler(s)
57			VMExecStatus_t res = VM_EXEC_NOT_RUNNING;
58	schoenebeck	2596	for ( ; event->handlers[event->currentHandler]; event->currentHandler++) {
59	schoenebeck	2594	res = ScriptVM::exec(
60	schoenebeck	2596	parserCtx, event->execCtx, event->handlers[event->currentHandler]
61	schoenebeck	2594	);
62			event->executionSlices++;
63			if (res & VM_EXEC_SUSPENDED \|\| res & VM_EXEC_ERROR) return res;
64			}
65
66			return res;
67			}
68
69			std::map<String,VMIntRelPtr*> InstrumentScriptVM::builtInIntVariables() {
70			// first get buil-in integer variables of derived VM class
71			std::map<String,VMIntRelPtr*> m = ScriptVM::builtInIntVariables();
72
73			// now add own built-in variables
74			m["$CC_NUM"] = &m_CC_NUM;
75	schoenebeck	2598	m["$EVENT_ID"] = &m_EVENT_ID;
76	schoenebeck	2594	m["$EVENT_NOTE"] = &m_EVENT_NOTE;
77			m["$EVENT_VELOCITY"] = &m_EVENT_VELOCITY;
78			// m["$POLY_AT_NUM"] = &m_POLY_AT_NUM;
79
80			return m;
81			}
82
83			std::map<String,VMInt8Array*> InstrumentScriptVM::builtInIntArrayVariables() {
84			// first get buil-in integer array variables of derived VM class
85			std::map<String,VMInt8Array*> m = ScriptVM::builtInIntArrayVariables();
86
87			// now add own built-in variables
88			m["%CC"] = &m_CC;
89			//m["%KEY_DOWN"] = &m_KEY_DOWN;
90			//m["%POLY_AT"] = &m_POLY_AT;
91
92			return m;
93			}
94
95			std::map<String,int> InstrumentScriptVM::builtInConstIntVariables() {
96			// first get buil-in integer variables of derived VM class
97			std::map<String,int> m = ScriptVM::builtInConstIntVariables();
98
99			m["$VCC_MONO_AT"] = CTRL_TABLE_IDX_AFTERTOUCH;
100			m["$VCC_PITCH_BEND"] = CTRL_TABLE_IDX_PITCHBEND;
101
102			return m;
103			}
104
105	schoenebeck	2596	VMFunction* InstrumentScriptVM::functionByName(const String& name) {
106			// built-in script functions of this class
107	schoenebeck	2598	if (name == "play_note") return &m_fnPlayNote;
108	schoenebeck	2600	else if (name == "set_controller") return &m_fnSetController;
109	schoenebeck	2598	else if (name == "ignore_event") return &m_fnIgnoreEvent;
110			else if (name == "ignore_controller") return &m_fnIgnoreController;
111	schoenebeck	2596
112			// built-in script functions of derived VM class
113			return ScriptVM::functionByName(name);
114			}
115
116	schoenebeck	2594	} // namespace LinuxSampler