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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3802 - (show annotations) (download)
Fri Jul 31 15:07:04 2020 UTC (8 days, 17 hours ago) by schoenebeck
File size: 20681 byte(s)
* Fixed rare crash when switching between instruments that had instrument
  scripts loaded.

* Bumped version (2.1.1.svn61).

1 /*
2 * Copyright (c) 2014 - 2020 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 "../../common/global_private.h"
11 #include "InstrumentScriptVM.h"
12 #include "../AbstractEngineChannel.h"
13 #include "../../common/global_private.h"
14 #include "AbstractInstrumentManager.h"
15 #include "MidiKeyboardManager.h"
16 #include "Fade.h"
17
18 namespace LinuxSampler {
19
20 ///////////////////////////////////////////////////////////////////////
21 // class 'EventGroup'
22
23 void EventGroup::insert(vmint eventID) {
24 if (contains(eventID)) return;
25
26 AbstractEngine* pEngine = m_script->pEngineChannel->pEngine;
27
28 // before adding the new event ID, check if there are any dead events
29 // and remove them in that case, before otherwise we might run in danger
30 // to run out of free space on this group for event IDs if a lot of
31 // events die before being removed explicitly from the group by script
32 //
33 // NOTE: or should we do this "dead ones" check only once in a while?
34 ssize_t firstDead = -1;
35 for (size_t i = 0; i < size(); ++i) {
36 if (firstDead >= 0) {
37 if (pEngine->EventByID(eventID)) {
38 remove(firstDead, i - firstDead);
39 firstDead = -1;
40 }
41 } else {
42 if (!pEngine->EventByID(eventID)) firstDead = i;
43 }
44 }
45
46 append(eventID);
47 }
48
49 void EventGroup::erase(vmint eventID) {
50 size_t index = find(eventID);
51 remove(index);
52 }
53
54 ///////////////////////////////////////////////////////////////////////
55 // class 'InstrumentScript'
56
57 InstrumentScript::InstrumentScript(AbstractEngineChannel* pEngineChannel) {
58 parserContext = NULL;
59 bHasValidScript = false;
60 handlerInit = NULL;
61 handlerNote = NULL;
62 handlerRelease = NULL;
63 handlerController = NULL;
64 handlerRpn = NULL;
65 handlerNrpn = NULL;
66 pEvents = NULL;
67 for (int i = 0; i < 128; ++i)
68 pKeyEvents[i] = NULL;
69 this->pEngineChannel = pEngineChannel;
70 for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i)
71 eventGroups[i].setScript(this);
72 }
73
74 InstrumentScript::~InstrumentScript() {
75 resetAll();
76 if (pEvents) {
77 for (int i = 0; i < 128; ++i) delete pKeyEvents[i];
78 delete pEvents;
79 }
80 }
81
82 /** @brief Load real-time instrument script.
83 *
84 * Loads the real-time instrument script given by @a text on the engine
85 * channel this InstrumentScript object belongs to (defined by
86 * pEngineChannel member variable). The sampler engine's resource manager is
87 * used to allocate and share equivalent scripts on multiple engine
88 * channels.
89 *
90 * @param text - source code of script
91 * @param patchVars - 'patch' variables being overridden by instrument
92 */
93 void InstrumentScript::load(const String& text,
94 const std::map<String,String>& patchVars)
95 {
96 dmsg(1,("Loading real-time instrument script ... "));
97
98 // hand back old script reference and VM execution contexts
99 // (if not done already)
100 unload();
101
102 code = text;
103
104 AbstractInstrumentManager* pManager =
105 dynamic_cast<AbstractInstrumentManager*>(pEngineChannel->pEngine->GetInstrumentManager());
106
107 // get new script reference
108 parserContext = pManager->scripts.Borrow(
109 { .code = text, .patchVars = patchVars }, pEngineChannel
110 );
111 if (!parserContext->errors().empty()) {
112 std::vector<ParserIssue> errors = parserContext->errors();
113 std::cerr << "[ScriptVM] Could not load instrument script, there were "
114 << errors.size() << " parser errors:\n";
115 for (int i = 0; i < errors.size(); ++i)
116 errors[i].dump();
117 return; // stop here if there were any parser errors
118 }
119
120 handlerInit = parserContext->eventHandlerByName("init");
121 handlerNote = parserContext->eventHandlerByName("note");
122 handlerRelease = parserContext->eventHandlerByName("release");
123 handlerController = parserContext->eventHandlerByName("controller");
124 handlerRpn = parserContext->eventHandlerByName("rpn");
125 handlerNrpn = parserContext->eventHandlerByName("nrpn");
126 bHasValidScript =
127 handlerInit || handlerNote || handlerRelease || handlerController ||
128 handlerRpn || handlerNrpn;
129
130 // amount of script handlers each script event has to execute
131 int handlerExecCount = 0;
132 if (handlerNote || handlerRelease || handlerController || handlerRpn ||
133 handlerNrpn) // only one of these are executed after "init" handler
134 handlerExecCount++;
135
136 // create script event pool (if it doesn't exist already)
137 if (!pEvents) {
138 pEvents = new Pool<ScriptEvent>(CONFIG_MAX_EVENTS_PER_FRAGMENT);
139 for (int i = 0; i < 128; ++i)
140 pKeyEvents[i] = new RTList<ScriptEvent>(pEvents);
141 // reset RTAVLNode's tree node member variables after nodes are allocated
142 // (since we can't use a constructor right now, we do that initialization here)
143 while (!pEvents->poolIsEmpty()) {
144 RTList<ScriptEvent>::Iterator it = pEvents->allocAppend();
145 it->reset();
146 }
147 }
148 pEvents->clear(); // outside of upper block, as loop below must always start from cleared list
149
150 // create new VM execution contexts for new script
151 while (!pEvents->poolIsEmpty()) {
152 RTList<ScriptEvent>::Iterator it = pEvents->allocAppend();
153 it->execCtx = pEngineChannel->pEngine->pScriptVM->createExecContext(
154 parserContext
155 );
156 it->handlers = new VMEventHandler*[handlerExecCount+1];
157 }
158 pEvents->clear();
159
160 dmsg(1,("Done\n"));
161 }
162
163 /** @brief Unload real-time instrument script.
164 *
165 * Unloads the currently used real-time instrument script and frees all
166 * resources allocated for that script. The sampler engine's resource manager
167 * is used to share equivalent scripts among multiple sampler channels, and
168 * to deallocate the parsed script once not used on any engine channel
169 * anymore.
170 *
171 * Calling this method will however not clear the @c code member variable.
172 * Thus, the script can be parsed again afterwards.
173 */
174 void InstrumentScript::unload() {
175 //dmsg(1,("InstrumentScript::unload(this=0x%llx)\n", this));
176
177 if (parserContext)
178 dmsg(1,("Unloading current instrument script.\n"));
179
180 resetEvents();
181
182 // free allocated VM execution contexts
183 if (pEvents) {
184 pEvents->clear();
185 while (!pEvents->poolIsEmpty()) {
186 RTList<ScriptEvent>::Iterator it = pEvents->allocAppend();
187 if (!it) break;
188 if (it->execCtx) {
189 // free VM execution context object
190 delete it->execCtx;
191 it->execCtx = NULL;
192 // free C array of handler pointers
193 delete [] it->handlers;
194 it->handlers = NULL;
195 }
196 }
197 pEvents->clear();
198 }
199 // hand back VM representation of script
200 if (parserContext) {
201 AbstractInstrumentManager* pManager =
202 dynamic_cast<AbstractInstrumentManager*>(pEngineChannel->pEngine->GetInstrumentManager());
203
204 pManager->scripts.HandBack(parserContext, pEngineChannel);
205 parserContext = NULL;
206 handlerInit = NULL;
207 handlerNote = NULL;
208 handlerRelease = NULL;
209 handlerController = NULL;
210 handlerRpn = NULL;
211 handlerNrpn = NULL;
212 }
213 bHasValidScript = false;
214 }
215
216 /**
217 * Same as unload(), but this one also empties the @c code member variable
218 * to an empty string.
219 */
220 void InstrumentScript::resetAll() {
221 unload();
222 code.clear();
223 }
224
225 /**
226 * Clears all currently active script events. This should be called
227 * whenever the engine or engine channel was reset for some reason.
228 */
229 void InstrumentScript::resetEvents() {
230 for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i)
231 eventGroups[i].clear();
232
233 for (int i = 0; i < 128; ++i)
234 if (pKeyEvents[i])
235 pKeyEvents[i]->clear();
236
237 suspendedEvents.clear();
238
239 if (pEvents) pEvents->clear();
240 }
241
242 ///////////////////////////////////////////////////////////////////////
243 // class 'InstrumentScriptVM'
244
245 InstrumentScriptVM::InstrumentScriptVM() :
246 m_event(NULL), m_fnPlayNote(this), m_fnSetController(this),
247 m_fnSetRpn(this), m_fnSetNrpn(this),
248 m_fnIgnoreEvent(this), m_fnIgnoreController(this), m_fnNoteOff(this),
249 m_fnSetEventMark(this), m_fnDeleteEventMark(this), m_fnByMarks(this),
250 m_fnChangeVol(this), m_fnChangeVolTime(this),
251 m_fnChangeTune(this), m_fnChangeTuneTime(this), m_fnChangePan(this),
252 m_fnChangePanTime(this), m_fnChangePanCurve(this),
253 m_fnChangeCutoff(this), m_fnChangeReso(this), m_fnChangeAttack(this),
254 m_fnChangeDecay(this), m_fnChangeSustain(this), m_fnChangeRelease(this),
255 m_fnChangeCutoffAttack(this), m_fnChangeCutoffDecay(this),
256 m_fnChangeCutoffSustain(this), m_fnChangeCutoffRelease(this),
257 m_fnChangeAmpLFODepth(this), m_fnChangeAmpLFOFreq(this),
258 m_fnChangeCutoffLFODepth(this), m_fnChangeCutoffLFOFreq(this),
259 m_fnChangePitchLFODepth(this), m_fnChangePitchLFOFreq(this),
260 m_fnChangeNote(this), m_fnChangeVelo(this), m_fnFork(this),
261 m_fnEventStatus(this), m_fnWait2(this), m_fnStopWait(this),
262 m_fnAbort(this), m_fnFadeIn(this), m_fnFadeOut(this),
263 m_fnChangeVolCurve(this), m_fnChangeTuneCurve(this),
264 m_fnGetEventPar(this), m_fnSetEventPar(this), m_fnChangePlayPos(this),
265 m_fnCallbackStatus(this),
266 m_varEngineUptime(this), m_varCallbackID(this), m_varAllEvents(this),
267 m_varCallbackChildID(this)
268 {
269 m_CC.size = _MEMBER_SIZEOF(AbstractEngineChannel, ControllerTable);
270 m_CC_NUM = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.CC.Controller);
271 m_EVENT_ID = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, id);
272 m_EVENT_NOTE = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, cause.Param.Note.Key);
273 m_EVENT_VELOCITY = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, cause.Param.Note.Velocity);
274 m_RPN_ADDRESS = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, cause.Param.RPN.Parameter);
275 m_RPN_VALUE = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, cause.Param.RPN.Value);
276 m_KEY_DOWN.size = 128;
277 m_KEY_DOWN.readonly = true;
278 m_NI_CALLBACK_TYPE = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, handlerType);
279 m_NKSP_IGNORE_WAIT = DECLARE_VMINT(m_event, class ScriptEvent, ignoreAllWaitCalls);
280 m_NKSP_CALLBACK_PARENT_ID = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, parentHandlerID);
281 }
282
283 VMExecStatus_t InstrumentScriptVM::exec(VMParserContext* parserCtx, ScriptEvent* event) {
284 AbstractEngineChannel* pEngineChannel =
285 static_cast<AbstractEngineChannel*>(event->cause.pEngineChannel);
286
287 // prepare built-in script variables for script execution
288 m_event = event;
289 m_CC.data = (int8_t*) &pEngineChannel->ControllerTable[0];
290 m_KEY_DOWN.data = &pEngineChannel->GetMidiKeyboardManager()->KeyDown[0];
291
292 // if script is in start condition, then do mandatory MIDI event
293 // preprocessing tasks, which essentially means updating i.e. controller
294 // table with new CC value in case of a controller event, because the
295 // script might access the new CC value
296 if (!event->executionSlices) {
297 switch (event->cause.Type) {
298 case Event::type_control_change:
299 pEngineChannel->ControllerTable[event->cause.Param.CC.Controller] =
300 event->cause.Param.CC.Value;
301 break;
302 case Event::type_channel_pressure:
303 pEngineChannel->ControllerTable[CTRL_TABLE_IDX_AFTERTOUCH] =
304 event->cause.Param.ChannelPressure.Value;
305 break;
306 case Event::type_pitchbend:
307 pEngineChannel->ControllerTable[CTRL_TABLE_IDX_PITCHBEND] =
308 event->cause.Param.Pitch.Pitch;
309 break;
310 default:
311 ; // noop
312 }
313 }
314
315 // run the script handler(s)
316 VMExecStatus_t res = VM_EXEC_NOT_RUNNING;
317 for ( ; event->handlers[event->currentHandler]; event->currentHandler++) {
318 res = ScriptVM::exec(
319 parserCtx, event->execCtx, event->handlers[event->currentHandler]
320 );
321 event->executionSlices++;
322 if (!(res & VM_EXEC_SUSPENDED)) { // if script terminated ...
323 // check if this script handler instance has any forked children
324 // to be auto aborted
325 for (int iChild = 0; iChild < MAX_FORK_PER_SCRIPT_HANDLER &&
326 event->childHandlerID[iChild]; ++iChild)
327 {
328 RTList<ScriptEvent>::Iterator itChild =
329 pEngineChannel->ScriptCallbackByID(event->childHandlerID[iChild]);
330 if (itChild && itChild->autoAbortByParent)
331 itChild->execCtx->signalAbort();
332 }
333 }
334 if (res & VM_EXEC_SUSPENDED || res & VM_EXEC_ERROR) return res;
335 }
336
337 return res;
338 }
339
340 std::map<String,VMIntPtr*> InstrumentScriptVM::builtInIntVariables() {
341 // first get built-in integer variables of derived VM class
342 std::map<String,VMIntPtr*> m = ScriptVM::builtInIntVariables();
343
344 // now add own built-in variables
345 m["$CC_NUM"] = &m_CC_NUM;
346 m["$EVENT_ID"] = &m_EVENT_ID;
347 m["$EVENT_NOTE"] = &m_EVENT_NOTE;
348 m["$EVENT_VELOCITY"] = &m_EVENT_VELOCITY;
349 // m["$POLY_AT_NUM"] = &m_POLY_AT_NUM;
350 m["$RPN_ADDRESS"] = &m_RPN_ADDRESS; // used for both RPN and NRPN events
351 m["$RPN_VALUE"] = &m_RPN_VALUE; // used for both RPN and NRPN events
352 m["$NI_CALLBACK_TYPE"] = &m_NI_CALLBACK_TYPE;
353 m["$NKSP_IGNORE_WAIT"] = &m_NKSP_IGNORE_WAIT;
354 m["$NKSP_CALLBACK_PARENT_ID"] = &m_NKSP_CALLBACK_PARENT_ID;
355
356 return m;
357 }
358
359 std::map<String,VMInt8Array*> InstrumentScriptVM::builtInIntArrayVariables() {
360 // first get built-in integer array variables of derived VM class
361 std::map<String,VMInt8Array*> m = ScriptVM::builtInIntArrayVariables();
362
363 // now add own built-in variables
364 m["%CC"] = &m_CC;
365 m["%KEY_DOWN"] = &m_KEY_DOWN;
366 //m["%POLY_AT"] = &m_POLY_AT;
367
368 return m;
369 }
370
371 std::map<String,vmint> InstrumentScriptVM::builtInConstIntVariables() {
372 // first get built-in integer variables of derived VM class
373 std::map<String,vmint> m = ScriptVM::builtInConstIntVariables();
374
375 m["$EVENT_STATUS_INACTIVE"] = EVENT_STATUS_INACTIVE;
376 m["$EVENT_STATUS_NOTE_QUEUE"] = EVENT_STATUS_NOTE_QUEUE;
377 m["$VCC_MONO_AT"] = CTRL_TABLE_IDX_AFTERTOUCH;
378 m["$VCC_PITCH_BEND"] = CTRL_TABLE_IDX_PITCHBEND;
379 for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i) {
380 m["$MARK_" + ToString(i+1)] = i;
381 }
382 m["$EVENT_PAR_NOTE"] = EVENT_PAR_NOTE;
383 m["$EVENT_PAR_VELOCITY"] = EVENT_PAR_VELOCITY;
384 m["$EVENT_PAR_VOLUME"] = EVENT_PAR_VOLUME;
385 m["$EVENT_PAR_TUNE"] = EVENT_PAR_TUNE;
386 m["$EVENT_PAR_0"] = EVENT_PAR_0;
387 m["$EVENT_PAR_1"] = EVENT_PAR_1;
388 m["$EVENT_PAR_2"] = EVENT_PAR_2;
389 m["$EVENT_PAR_3"] = EVENT_PAR_3;
390 m["$NKSP_LINEAR"] = FADE_CURVE_LINEAR;
391 m["$NKSP_EASE_IN_EASE_OUT"] = FADE_CURVE_EASE_IN_EASE_OUT;
392 m["$CALLBACK_STATUS_TERMINATED"] = CALLBACK_STATUS_TERMINATED;
393 m["$CALLBACK_STATUS_QUEUE"] = CALLBACK_STATUS_QUEUE;
394 m["$CALLBACK_STATUS_RUNNING"] = CALLBACK_STATUS_RUNNING;
395
396 return m;
397 }
398
399 std::map<String,VMDynVar*> InstrumentScriptVM::builtInDynamicVariables() {
400 // first get built-in dynamic variables of derived VM class
401 std::map<String,VMDynVar*> m = ScriptVM::builtInDynamicVariables();
402
403 m["%ALL_EVENTS"] = &m_varAllEvents;
404 m["$ENGINE_UPTIME"] = &m_varEngineUptime;
405 m["$NI_CALLBACK_ID"] = &m_varCallbackID;
406 m["%NKSP_CALLBACK_CHILD_ID"] = &m_varCallbackChildID;
407
408 return m;
409 }
410
411 VMFunction* InstrumentScriptVM::functionByName(const String& name) {
412 // built-in script functions of this class
413 if (name == "play_note") return &m_fnPlayNote;
414 else if (name == "set_controller") return &m_fnSetController;
415 else if (name == "set_rpn") return &m_fnSetRpn;
416 else if (name == "set_nrpn") return &m_fnSetNrpn;
417 else if (name == "ignore_event") return &m_fnIgnoreEvent;
418 else if (name == "ignore_controller") return &m_fnIgnoreController;
419 else if (name == "note_off") return &m_fnNoteOff;
420 else if (name == "set_event_mark") return &m_fnSetEventMark;
421 else if (name == "delete_event_mark") return &m_fnDeleteEventMark;
422 else if (name == "by_marks") return &m_fnByMarks;
423 else if (name == "change_vol") return &m_fnChangeVol;
424 else if (name == "change_vol_time") return &m_fnChangeVolTime;
425 else if (name == "change_tune") return &m_fnChangeTune;
426 else if (name == "change_tune_time") return &m_fnChangeTuneTime;
427 else if (name == "change_note") return &m_fnChangeNote;
428 else if (name == "change_velo") return &m_fnChangeVelo;
429 else if (name == "change_pan") return &m_fnChangePan;
430 else if (name == "change_pan_time") return &m_fnChangePanTime;
431 else if (name == "change_pan_curve") return &m_fnChangePanCurve;
432 else if (name == "change_cutoff") return &m_fnChangeCutoff;
433 else if (name == "change_reso") return &m_fnChangeReso;
434 else if (name == "change_attack") return &m_fnChangeAttack;
435 else if (name == "change_decay") return &m_fnChangeDecay;
436 else if (name == "change_sustain") return &m_fnChangeSustain;
437 else if (name == "change_release") return &m_fnChangeRelease;
438 else if (name == "change_cutoff_attack") return &m_fnChangeCutoffAttack;
439 else if (name == "change_cutoff_decay") return &m_fnChangeCutoffDecay;
440 else if (name == "change_cutoff_sustain") return &m_fnChangeCutoffSustain;
441 else if (name == "change_cutoff_release") return &m_fnChangeCutoffRelease;
442 else if (name == "change_amp_lfo_depth") return &m_fnChangeAmpLFODepth;
443 else if (name == "change_amp_lfo_freq") return &m_fnChangeAmpLFOFreq;
444 else if (name == "change_cutoff_lfo_depth") return &m_fnChangeCutoffLFODepth;
445 else if (name == "change_cutoff_lfo_freq") return &m_fnChangeCutoffLFOFreq;
446 else if (name == "change_pitch_lfo_depth") return &m_fnChangePitchLFODepth;
447 else if (name == "change_pitch_lfo_freq") return &m_fnChangePitchLFOFreq;
448 else if (name == "fade_in") return &m_fnFadeIn;
449 else if (name == "fade_out") return &m_fnFadeOut;
450 else if (name == "change_vol_curve") return &m_fnChangeVolCurve;
451 else if (name == "change_tune_curve") return &m_fnChangeTuneCurve;
452 else if (name == "change_play_pos") return &m_fnChangePlayPos;
453 else if (name == "get_event_par") return &m_fnGetEventPar;
454 else if (name == "set_event_par") return &m_fnSetEventPar;
455 else if (name == "event_status") return &m_fnEventStatus;
456 else if (name == "wait") return &m_fnWait2; // override wait() core implementation
457 else if (name == "stop_wait") return &m_fnStopWait;
458 else if (name == "abort") return &m_fnAbort;
459 else if (name == "fork") return &m_fnFork;
460 else if (name == "callback_status") return &m_fnCallbackStatus;
461
462 // built-in script functions of derived VM class
463 return ScriptVM::functionByName(name);
464 }
465
466 } // namespace LinuxSampler

  ViewVC Help
Powered by ViewVC