/[svn]/linuxsampler/trunk/src/engines/common/InstrumentScriptVM.cpp
ViewVC logotype

Annotation of /linuxsampler/trunk/src/engines/common/InstrumentScriptVM.cpp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2931 - (hide annotations) (download)
Sat Jul 9 14:38:33 2016 UTC (7 years, 8 months ago) by schoenebeck
File size: 12919 byte(s)
* Implemented built-in instrument script function "change_vol()".
* Implemented built-in instrument script function "change_tune()".
* Implemented built-in instrument script function "change_pan()".
* Bumped version (2.0.0.svn11).

1 schoenebeck 2594 /*
2 schoenebeck 2871 * Copyright (c) 2014 - 2016 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     #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 schoenebeck 2645 for (int i = 0; i < 128; ++i)
64     pKeyEvents[i] = NULL;
65 schoenebeck 2630 this->pEngineChannel = pEngineChannel;
66     for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i)
67     eventGroups[i].setScript(this);
68     }
69    
70 schoenebeck 2645 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 schoenebeck 2611 /** @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 schoenebeck 2612 unload();
94 schoenebeck 2611
95 schoenebeck 2612 code = text;
96    
97 schoenebeck 2611 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 schoenebeck 2645 if (!pEvents) {
125 schoenebeck 2611 pEvents = new Pool<ScriptEvent>(CONFIG_MAX_EVENTS_PER_FRAGMENT);
126 schoenebeck 2645 for (int i = 0; i < 128; ++i)
127     pKeyEvents[i] = new RTList<ScriptEvent>(pEvents);
128     }
129 schoenebeck 2611
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 schoenebeck 2612 *
151 schoenebeck 2614 * Calling this method will however not clear the @c code member variable.
152 schoenebeck 2612 * Thus, the script can be parsed again afterwards.
153 schoenebeck 2611 */
154 schoenebeck 2612 void InstrumentScript::unload() {
155 schoenebeck 2618 //dmsg(1,("InstrumentScript::unload(this=0x%llx)\n", this));
156    
157 schoenebeck 2611 if (parserContext)
158 schoenebeck 2612 dmsg(1,("Unloading current instrument script.\n"));
159 schoenebeck 2611
160 schoenebeck 2871 resetEvents();
161    
162 schoenebeck 2611 // free allocated VM execution contexts
163     if (pEvents) {
164     pEvents->clear();
165     while (!pEvents->poolIsEmpty()) {
166     RTList<ScriptEvent>::Iterator it = pEvents->allocAppend();
167     if (it->execCtx) {
168     // free VM execution context object
169     delete it->execCtx;
170     it->execCtx = NULL;
171     // free C array of handler pointers
172     delete [] it->handlers;
173     }
174     }
175     pEvents->clear();
176     }
177     // hand back VM representation of script
178     if (parserContext) {
179     AbstractInstrumentManager* pManager =
180     dynamic_cast<AbstractInstrumentManager*>(pEngineChannel->pEngine->GetInstrumentManager());
181    
182     pManager->scripts.HandBack(parserContext, pEngineChannel);
183     parserContext = NULL;
184     handlerInit = NULL;
185     handlerNote = NULL;
186     handlerRelease = NULL;
187     handlerController = NULL;
188     }
189     bHasValidScript = false;
190     }
191    
192 schoenebeck 2612 /**
193     * Same as unload(), but this one also empties the @c code member variable
194     * to an empty string.
195     */
196     void InstrumentScript::resetAll() {
197     unload();
198     code.clear();
199     }
200 schoenebeck 2871
201     /**
202     * Clears all currently active script events. This should be called
203     * whenever the engine or engine channel was reset for some reason.
204     */
205     void InstrumentScript::resetEvents() {
206     for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i)
207     eventGroups[i].clear();
208 schoenebeck 2612
209 schoenebeck 2871 for (int i = 0; i < 128; ++i)
210     if (pKeyEvents[i])
211     pKeyEvents[i]->clear();
212    
213     suspendedEvents.clear();
214    
215     if (pEvents) pEvents->clear();
216     }
217    
218 schoenebeck 2611 ///////////////////////////////////////////////////////////////////////
219     // class 'InstrumentScriptVM'
220    
221 schoenebeck 2596 InstrumentScriptVM::InstrumentScriptVM() :
222 schoenebeck 2600 m_event(NULL), m_fnPlayNote(this), m_fnSetController(this),
223 schoenebeck 2630 m_fnIgnoreEvent(this), m_fnIgnoreController(this), m_fnNoteOff(this),
224 schoenebeck 2931 m_fnSetEventMark(this), m_fnDeleteEventMark(this), m_fnByMarks(this),
225     m_fnChangeVol(this), m_fnChangeTune(this), m_fnChangePan(this)
226 schoenebeck 2596 {
227 schoenebeck 2595 m_CC.size = _MEMBER_SIZEOF(AbstractEngineChannel, ControllerTable);
228 schoenebeck 2598 m_CC_NUM = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.CC.Controller);
229     m_EVENT_ID = DECLARE_VMINT(m_event, class ScriptEvent, id);
230     m_EVENT_NOTE = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Key);
231     m_EVENT_VELOCITY = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Velocity);
232 schoenebeck 2613 m_KEY_DOWN.size = 128;
233 schoenebeck 2594 }
234    
235     VMExecStatus_t InstrumentScriptVM::exec(VMParserContext* parserCtx, ScriptEvent* event) {
236     AbstractEngineChannel* pEngineChannel =
237     static_cast<AbstractEngineChannel*>(event->cause.pEngineChannel);
238    
239     // prepare built-in script variables for script execution
240 schoenebeck 2598 m_event = event;
241 schoenebeck 2594 m_CC.data = (int8_t*) &pEngineChannel->ControllerTable[0];
242 schoenebeck 2613 m_KEY_DOWN.data = &pEngineChannel->GetMidiKeyboardManager()->KeyDown[0];
243 schoenebeck 2594
244     // if script is in start condition, then do mandatory MIDI event
245     // preprocessing tasks, which essentially means updating i.e. controller
246     // table with new CC value in case of a controller event, because the
247     // script might access the new CC value
248     if (!event->executionSlices) {
249 schoenebeck 2598 switch (event->cause.Type) {
250 schoenebeck 2594 case Event::type_control_change:
251 schoenebeck 2598 pEngineChannel->ControllerTable[event->cause.Param.CC.Controller] =
252     event->cause.Param.CC.Value;
253 schoenebeck 2594 break;
254     case Event::type_channel_pressure:
255     pEngineChannel->ControllerTable[CTRL_TABLE_IDX_AFTERTOUCH] =
256 schoenebeck 2598 event->cause.Param.ChannelPressure.Value;
257 schoenebeck 2594 break;
258     case Event::type_pitchbend:
259     pEngineChannel->ControllerTable[CTRL_TABLE_IDX_PITCHBEND] =
260 schoenebeck 2598 event->cause.Param.Pitch.Pitch;
261 schoenebeck 2594 break;
262     }
263     }
264    
265     // run the script handler(s)
266     VMExecStatus_t res = VM_EXEC_NOT_RUNNING;
267 schoenebeck 2596 for ( ; event->handlers[event->currentHandler]; event->currentHandler++) {
268 schoenebeck 2594 res = ScriptVM::exec(
269 schoenebeck 2596 parserCtx, event->execCtx, event->handlers[event->currentHandler]
270 schoenebeck 2594 );
271     event->executionSlices++;
272     if (res & VM_EXEC_SUSPENDED || res & VM_EXEC_ERROR) return res;
273     }
274    
275     return res;
276     }
277    
278     std::map<String,VMIntRelPtr*> InstrumentScriptVM::builtInIntVariables() {
279     // first get buil-in integer variables of derived VM class
280     std::map<String,VMIntRelPtr*> m = ScriptVM::builtInIntVariables();
281    
282     // now add own built-in variables
283     m["$CC_NUM"] = &m_CC_NUM;
284 schoenebeck 2598 m["$EVENT_ID"] = &m_EVENT_ID;
285 schoenebeck 2594 m["$EVENT_NOTE"] = &m_EVENT_NOTE;
286     m["$EVENT_VELOCITY"] = &m_EVENT_VELOCITY;
287     // m["$POLY_AT_NUM"] = &m_POLY_AT_NUM;
288    
289     return m;
290     }
291    
292     std::map<String,VMInt8Array*> InstrumentScriptVM::builtInIntArrayVariables() {
293     // first get buil-in integer array variables of derived VM class
294     std::map<String,VMInt8Array*> m = ScriptVM::builtInIntArrayVariables();
295    
296     // now add own built-in variables
297     m["%CC"] = &m_CC;
298 schoenebeck 2613 m["%KEY_DOWN"] = &m_KEY_DOWN;
299 schoenebeck 2594 //m["%POLY_AT"] = &m_POLY_AT;
300    
301     return m;
302     }
303    
304     std::map<String,int> InstrumentScriptVM::builtInConstIntVariables() {
305     // first get buil-in integer variables of derived VM class
306     std::map<String,int> m = ScriptVM::builtInConstIntVariables();
307    
308     m["$VCC_MONO_AT"] = CTRL_TABLE_IDX_AFTERTOUCH;
309     m["$VCC_PITCH_BEND"] = CTRL_TABLE_IDX_PITCHBEND;
310 schoenebeck 2630 for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i) {
311     m["$MARK_" + ToString(i+1)] = i;
312     }
313 schoenebeck 2594
314     return m;
315     }
316    
317 schoenebeck 2596 VMFunction* InstrumentScriptVM::functionByName(const String& name) {
318     // built-in script functions of this class
319 schoenebeck 2598 if (name == "play_note") return &m_fnPlayNote;
320 schoenebeck 2600 else if (name == "set_controller") return &m_fnSetController;
321 schoenebeck 2598 else if (name == "ignore_event") return &m_fnIgnoreEvent;
322     else if (name == "ignore_controller") return &m_fnIgnoreController;
323 schoenebeck 2629 else if (name == "note_off") return &m_fnNoteOff;
324 schoenebeck 2630 else if (name == "set_event_mark") return &m_fnSetEventMark;
325     else if (name == "delete_event_mark") return &m_fnDeleteEventMark;
326     else if (name == "by_marks") return &m_fnByMarks;
327 schoenebeck 2931 else if (name == "change_vol") return &m_fnChangeVol;
328     else if (name == "change_tune") return &m_fnChangeTune;
329     else if (name == "change_pan") return &m_fnChangePan;
330 schoenebeck 2596
331     // built-in script functions of derived VM class
332     return ScriptVM::functionByName(name);
333     }
334    
335 schoenebeck 2594 } // namespace LinuxSampler

  ViewVC Help
Powered by ViewVC