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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2614 by schoenebeck, Tue Jun 10 17:22:48 2014 UTC revision 3691 by schoenebeck, Fri Jan 3 12:35:20 2020 UTC
# Line 1  Line 1 
1  /*  /*
2   * Copyright (c) 2014 Christian Schoenebeck   * Copyright (c) 2014 - 2020 Christian Schoenebeck
3   *   *
4   * http://www.linuxsampler.org   * http://www.linuxsampler.org
5   *   *
# Line 7  Line 7 
7   * See README file for details.   * See README file for details.
8   */   */
9    
10    #include "../../common/global_private.h"
11  #include "InstrumentScriptVM.h"  #include "InstrumentScriptVM.h"
12  #include "../AbstractEngineChannel.h"  #include "../AbstractEngineChannel.h"
13  #include "../../common/global_private.h"  #include "../../common/global_private.h"
14  #include "AbstractInstrumentManager.h"  #include "AbstractInstrumentManager.h"
15  #include "MidiKeyboardManager.h"  #include "MidiKeyboardManager.h"
16    #include "Fade.h"
17    
18  namespace LinuxSampler {  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'      // 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.      /** @brief Load real-time instrument script.
83       *       *
84       * Loads the real-time instrument script given by @a text on the engine       * Loads the real-time instrument script given by @a text on the engine
# Line 55  namespace LinuxSampler { Line 116  namespace LinuxSampler {
116          handlerNote = parserContext->eventHandlerByName("note");          handlerNote = parserContext->eventHandlerByName("note");
117          handlerRelease = parserContext->eventHandlerByName("release");          handlerRelease = parserContext->eventHandlerByName("release");
118          handlerController = parserContext->eventHandlerByName("controller");          handlerController = parserContext->eventHandlerByName("controller");
119            handlerRpn = parserContext->eventHandlerByName("rpn");
120            handlerNrpn = parserContext->eventHandlerByName("nrpn");
121          bHasValidScript =          bHasValidScript =
122              handlerInit || handlerNote || handlerRelease || handlerController;              handlerInit || handlerNote || handlerRelease || handlerController ||
123                handlerRpn || handlerNrpn;
124    
125          // amount of script handlers each script event has to execute          // amount of script handlers each script event has to execute
126          int handlerExecCount = 0;          int handlerExecCount = 0;
127          if (handlerNote || handlerRelease || handlerController) // only one of these are executed after "init" handler          if (handlerNote || handlerRelease || handlerController || handlerRpn ||
128                handlerNrpn) // only one of these are executed after "init" handler
129              handlerExecCount++;              handlerExecCount++;
130    
131          // create script event pool (if it doesn't exist already)          // create script event pool (if it doesn't exist already)
132          if (!pEvents)          if (!pEvents) {
133              pEvents = new Pool<ScriptEvent>(CONFIG_MAX_EVENTS_PER_FRAGMENT);              pEvents = new Pool<ScriptEvent>(CONFIG_MAX_EVENTS_PER_FRAGMENT);
134                for (int i = 0; i < 128; ++i)
135                    pKeyEvents[i] = new RTList<ScriptEvent>(pEvents);
136                // reset RTAVLNode's tree node member variables after nodes are allocated
137                // (since we can't use a constructor right now, we do that initialization here)
138                while (!pEvents->poolIsEmpty()) {
139                    RTList<ScriptEvent>::Iterator it = pEvents->allocAppend();
140                    it->reset();
141                }
142                pEvents->clear();
143            }
144    
145          // create new VM execution contexts for new script          // create new VM execution contexts for new script
146          while (!pEvents->poolIsEmpty()) {          while (!pEvents->poolIsEmpty()) {
# Line 92  namespace LinuxSampler { Line 167  namespace LinuxSampler {
167       * Thus, the script can be parsed again afterwards.       * Thus, the script can be parsed again afterwards.
168       */       */
169      void InstrumentScript::unload() {      void InstrumentScript::unload() {
170            //dmsg(1,("InstrumentScript::unload(this=0x%llx)\n", this));
171    
172          if (parserContext)          if (parserContext)
173              dmsg(1,("Unloading current instrument script.\n"));              dmsg(1,("Unloading current instrument script.\n"));
174    
175            resetEvents();
176    
177          // free allocated VM execution contexts          // free allocated VM execution contexts
178          if (pEvents) {          if (pEvents) {
179              pEvents->clear();              pEvents->clear();
# Line 121  namespace LinuxSampler { Line 200  namespace LinuxSampler {
200              handlerNote = NULL;              handlerNote = NULL;
201              handlerRelease = NULL;              handlerRelease = NULL;
202              handlerController = NULL;              handlerController = NULL;
203                handlerRpn = NULL;
204                handlerNrpn = NULL;
205          }          }
206          bHasValidScript = false;          bHasValidScript = false;
207      }      }
# Line 133  namespace LinuxSampler { Line 214  namespace LinuxSampler {
214          unload();          unload();
215          code.clear();          code.clear();
216      }      }
217        
218        /**
219         * Clears all currently active script events. This should be called
220         * whenever the engine or engine channel was reset for some reason.
221         */
222        void InstrumentScript::resetEvents() {
223            for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i)
224                eventGroups[i].clear();
225    
226            for (int i = 0; i < 128; ++i)
227                if (pKeyEvents[i])
228                    pKeyEvents[i]->clear();
229    
230            suspendedEvents.clear();
231    
232            if (pEvents) pEvents->clear();
233        }
234    
235      ///////////////////////////////////////////////////////////////////////      ///////////////////////////////////////////////////////////////////////
236      // class 'InstrumentScriptVM'      // class 'InstrumentScriptVM'
237    
238      InstrumentScriptVM::InstrumentScriptVM() :      InstrumentScriptVM::InstrumentScriptVM() :
239          m_event(NULL), m_fnPlayNote(this), m_fnSetController(this),          m_event(NULL), m_fnPlayNote(this), m_fnSetController(this),
240          m_fnIgnoreEvent(this), m_fnIgnoreController(this)          m_fnSetRpn(this), m_fnSetNrpn(this),
241            m_fnIgnoreEvent(this), m_fnIgnoreController(this), m_fnNoteOff(this),
242            m_fnSetEventMark(this), m_fnDeleteEventMark(this), m_fnByMarks(this),
243            m_fnChangeVol(this), m_fnChangeVolTime(this),
244            m_fnChangeTune(this), m_fnChangeTuneTime(this), m_fnChangePan(this),
245            m_fnChangePanTime(this), m_fnChangePanCurve(this),
246            m_fnChangeCutoff(this), m_fnChangeReso(this),  m_fnChangeAttack(this),
247            m_fnChangeDecay(this), m_fnChangeSustain(this), m_fnChangeRelease(this),
248            m_fnChangeCutoffAttack(this), m_fnChangeCutoffDecay(this),
249            m_fnChangeCutoffSustain(this), m_fnChangeCutoffRelease(this),
250            m_fnChangeAmpLFODepth(this), m_fnChangeAmpLFOFreq(this),
251            m_fnChangeCutoffLFODepth(this), m_fnChangeCutoffLFOFreq(this),
252            m_fnChangePitchLFODepth(this), m_fnChangePitchLFOFreq(this),
253            m_fnChangeNote(this), m_fnChangeVelo(this), m_fnFork(this),
254            m_fnEventStatus(this), m_fnWait2(this), m_fnStopWait(this),
255            m_fnAbort(this), m_fnFadeIn(this), m_fnFadeOut(this),
256            m_fnChangeVolCurve(this), m_fnChangeTuneCurve(this),
257            m_fnGetEventPar(this), m_fnSetEventPar(this), m_fnChangePlayPos(this),
258            m_fnCallbackStatus(this),
259            m_varEngineUptime(this), m_varCallbackID(this), m_varAllEvents(this),
260            m_varCallbackChildID(this)
261      {      {
262          m_CC.size = _MEMBER_SIZEOF(AbstractEngineChannel, ControllerTable);          m_CC.size = _MEMBER_SIZEOF(AbstractEngineChannel, ControllerTable);
263          m_CC_NUM = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.CC.Controller);          m_CC_NUM = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.CC.Controller);
264          m_EVENT_ID = DECLARE_VMINT(m_event, class ScriptEvent, id);          m_EVENT_ID = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, id);
265          m_EVENT_NOTE = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Key);          m_EVENT_NOTE = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, cause.Param.Note.Key);
266          m_EVENT_VELOCITY = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Velocity);          m_EVENT_VELOCITY = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, cause.Param.Note.Velocity);
267            m_RPN_ADDRESS = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, cause.Param.RPN.Parameter);
268            m_RPN_VALUE = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, cause.Param.RPN.Value);
269          m_KEY_DOWN.size = 128;          m_KEY_DOWN.size = 128;
270            m_KEY_DOWN.readonly = true;
271            m_NI_CALLBACK_TYPE = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, handlerType);
272            m_NKSP_IGNORE_WAIT = DECLARE_VMINT(m_event, class ScriptEvent, ignoreAllWaitCalls);
273            m_NKSP_CALLBACK_PARENT_ID = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, parentHandlerID);
274      }      }
275    
276      VMExecStatus_t InstrumentScriptVM::exec(VMParserContext* parserCtx, ScriptEvent* event) {      VMExecStatus_t InstrumentScriptVM::exec(VMParserContext* parserCtx, ScriptEvent* event) {
# Line 176  namespace LinuxSampler { Line 300  namespace LinuxSampler {
300                      pEngineChannel->ControllerTable[CTRL_TABLE_IDX_PITCHBEND] =                      pEngineChannel->ControllerTable[CTRL_TABLE_IDX_PITCHBEND] =
301                          event->cause.Param.Pitch.Pitch;                          event->cause.Param.Pitch.Pitch;
302                      break;                      break;
303                    default:
304                        ; // noop
305              }              }
306          }          }
307    
# Line 186  namespace LinuxSampler { Line 312  namespace LinuxSampler {
312                  parserCtx, event->execCtx, event->handlers[event->currentHandler]                  parserCtx, event->execCtx, event->handlers[event->currentHandler]
313              );              );
314              event->executionSlices++;              event->executionSlices++;
315                if (!(res & VM_EXEC_SUSPENDED)) { // if script terminated ...
316                    // check if this script handler instance has any forked children
317                    // to be auto aborted
318                    for (int iChild = 0; iChild < MAX_FORK_PER_SCRIPT_HANDLER &&
319                         event->childHandlerID[iChild]; ++iChild)
320                    {
321                        RTList<ScriptEvent>::Iterator itChild =
322                            pEngineChannel->ScriptCallbackByID(event->childHandlerID[iChild]);
323                        if (itChild && itChild->autoAbortByParent)
324                            itChild->execCtx->signalAbort();
325                    }
326                }
327              if (res & VM_EXEC_SUSPENDED || res & VM_EXEC_ERROR) return res;              if (res & VM_EXEC_SUSPENDED || res & VM_EXEC_ERROR) return res;
328          }          }
329    
330          return res;          return res;
331      }      }
332    
333      std::map<String,VMIntRelPtr*> InstrumentScriptVM::builtInIntVariables() {      std::map<String,VMIntPtr*> InstrumentScriptVM::builtInIntVariables() {
334          // first get buil-in integer variables of derived VM class          // first get built-in integer variables of derived VM class
335          std::map<String,VMIntRelPtr*> m = ScriptVM::builtInIntVariables();          std::map<String,VMIntPtr*> m = ScriptVM::builtInIntVariables();
336    
337          // now add own built-in variables          // now add own built-in variables
338          m["$CC_NUM"] = &m_CC_NUM;          m["$CC_NUM"] = &m_CC_NUM;
# Line 202  namespace LinuxSampler { Line 340  namespace LinuxSampler {
340          m["$EVENT_NOTE"] = &m_EVENT_NOTE;          m["$EVENT_NOTE"] = &m_EVENT_NOTE;
341          m["$EVENT_VELOCITY"] = &m_EVENT_VELOCITY;          m["$EVENT_VELOCITY"] = &m_EVENT_VELOCITY;
342  //         m["$POLY_AT_NUM"] = &m_POLY_AT_NUM;  //         m["$POLY_AT_NUM"] = &m_POLY_AT_NUM;
343            m["$RPN_ADDRESS"] = &m_RPN_ADDRESS; // used for both RPN and NRPN events
344            m["$RPN_VALUE"] = &m_RPN_VALUE;     // used for both RPN and NRPN events
345            m["$NI_CALLBACK_TYPE"] = &m_NI_CALLBACK_TYPE;
346            m["$NKSP_IGNORE_WAIT"] = &m_NKSP_IGNORE_WAIT;
347            m["$NKSP_CALLBACK_PARENT_ID"] = &m_NKSP_CALLBACK_PARENT_ID;
348    
349          return m;          return m;
350      }      }
351    
352      std::map<String,VMInt8Array*> InstrumentScriptVM::builtInIntArrayVariables() {      std::map<String,VMInt8Array*> InstrumentScriptVM::builtInIntArrayVariables() {
353          // first get buil-in integer array variables of derived VM class          // first get built-in integer array variables of derived VM class
354          std::map<String,VMInt8Array*> m = ScriptVM::builtInIntArrayVariables();          std::map<String,VMInt8Array*> m = ScriptVM::builtInIntArrayVariables();
355    
356          // now add own built-in variables          // now add own built-in variables
# Line 218  namespace LinuxSampler { Line 361  namespace LinuxSampler {
361          return m;          return m;
362      }      }
363    
364      std::map<String,int> InstrumentScriptVM::builtInConstIntVariables() {      std::map<String,vmint> InstrumentScriptVM::builtInConstIntVariables() {
365          // first get buil-in integer variables of derived VM class          // first get built-in integer variables of derived VM class
366          std::map<String,int> m = ScriptVM::builtInConstIntVariables();          std::map<String,vmint> m = ScriptVM::builtInConstIntVariables();
367    
368            m["$EVENT_STATUS_INACTIVE"] = EVENT_STATUS_INACTIVE;
369            m["$EVENT_STATUS_NOTE_QUEUE"] = EVENT_STATUS_NOTE_QUEUE;
370          m["$VCC_MONO_AT"] = CTRL_TABLE_IDX_AFTERTOUCH;          m["$VCC_MONO_AT"] = CTRL_TABLE_IDX_AFTERTOUCH;
371          m["$VCC_PITCH_BEND"] = CTRL_TABLE_IDX_PITCHBEND;          m["$VCC_PITCH_BEND"] = CTRL_TABLE_IDX_PITCHBEND;
372            for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i) {
373                m["$MARK_" + ToString(i+1)] = i;
374            }
375            m["$EVENT_PAR_NOTE"] = EVENT_PAR_NOTE;
376            m["$EVENT_PAR_VELOCITY"] = EVENT_PAR_VELOCITY;
377            m["$EVENT_PAR_VOLUME"] = EVENT_PAR_VOLUME;
378            m["$EVENT_PAR_TUNE"] = EVENT_PAR_TUNE;
379            m["$EVENT_PAR_0"] = EVENT_PAR_0;
380            m["$EVENT_PAR_1"] = EVENT_PAR_1;
381            m["$EVENT_PAR_2"] = EVENT_PAR_2;
382            m["$EVENT_PAR_3"] = EVENT_PAR_3;
383            m["$NKSP_LINEAR"] = FADE_CURVE_LINEAR;
384            m["$NKSP_EASE_IN_EASE_OUT"] = FADE_CURVE_EASE_IN_EASE_OUT;
385            m["$CALLBACK_STATUS_TERMINATED"] = CALLBACK_STATUS_TERMINATED;
386            m["$CALLBACK_STATUS_QUEUE"]      = CALLBACK_STATUS_QUEUE;
387            m["$CALLBACK_STATUS_RUNNING"]    = CALLBACK_STATUS_RUNNING;
388    
389            return m;
390        }
391    
392        std::map<String,VMDynVar*> InstrumentScriptVM::builtInDynamicVariables() {
393            // first get built-in dynamic variables of derived VM class
394            std::map<String,VMDynVar*> m = ScriptVM::builtInDynamicVariables();
395    
396            m["%ALL_EVENTS"] = &m_varAllEvents;
397            m["$ENGINE_UPTIME"] = &m_varEngineUptime;
398            m["$NI_CALLBACK_ID"] = &m_varCallbackID;
399            m["%NKSP_CALLBACK_CHILD_ID"] = &m_varCallbackChildID;
400    
401          return m;          return m;
402      }      }
# Line 232  namespace LinuxSampler { Line 405  namespace LinuxSampler {
405          // built-in script functions of this class          // built-in script functions of this class
406          if      (name == "play_note") return &m_fnPlayNote;          if      (name == "play_note") return &m_fnPlayNote;
407          else if (name == "set_controller") return &m_fnSetController;          else if (name == "set_controller") return &m_fnSetController;
408            else if (name == "set_rpn") return &m_fnSetRpn;
409            else if (name == "set_nrpn") return &m_fnSetNrpn;
410          else if (name == "ignore_event") return &m_fnIgnoreEvent;          else if (name == "ignore_event") return &m_fnIgnoreEvent;
411          else if (name == "ignore_controller") return &m_fnIgnoreController;          else if (name == "ignore_controller") return &m_fnIgnoreController;
412            else if (name == "note_off") return &m_fnNoteOff;
413            else if (name == "set_event_mark") return &m_fnSetEventMark;
414            else if (name == "delete_event_mark") return &m_fnDeleteEventMark;
415            else if (name == "by_marks") return &m_fnByMarks;
416            else if (name == "change_vol") return &m_fnChangeVol;
417            else if (name == "change_vol_time") return &m_fnChangeVolTime;
418            else if (name == "change_tune") return &m_fnChangeTune;
419            else if (name == "change_tune_time") return &m_fnChangeTuneTime;
420            else if (name == "change_note") return &m_fnChangeNote;
421            else if (name == "change_velo") return &m_fnChangeVelo;
422            else if (name == "change_pan") return &m_fnChangePan;
423            else if (name == "change_pan_time") return &m_fnChangePanTime;
424            else if (name == "change_pan_curve") return &m_fnChangePanCurve;
425            else if (name == "change_cutoff") return &m_fnChangeCutoff;
426            else if (name == "change_reso") return &m_fnChangeReso;
427            else if (name == "change_attack") return &m_fnChangeAttack;
428            else if (name == "change_decay") return &m_fnChangeDecay;
429            else if (name == "change_sustain") return &m_fnChangeSustain;
430            else if (name == "change_release") return &m_fnChangeRelease;
431            else if (name == "change_cutoff_attack") return &m_fnChangeCutoffAttack;
432            else if (name == "change_cutoff_decay") return &m_fnChangeCutoffDecay;
433            else if (name == "change_cutoff_sustain") return &m_fnChangeCutoffSustain;
434            else if (name == "change_cutoff_release") return &m_fnChangeCutoffRelease;
435            else if (name == "change_amp_lfo_depth") return &m_fnChangeAmpLFODepth;
436            else if (name == "change_amp_lfo_freq") return &m_fnChangeAmpLFOFreq;
437            else if (name == "change_cutoff_lfo_depth") return &m_fnChangeCutoffLFODepth;
438            else if (name == "change_cutoff_lfo_freq") return &m_fnChangeCutoffLFOFreq;
439            else if (name == "change_pitch_lfo_depth") return &m_fnChangePitchLFODepth;
440            else if (name == "change_pitch_lfo_freq") return &m_fnChangePitchLFOFreq;
441            else if (name == "fade_in") return &m_fnFadeIn;
442            else if (name == "fade_out") return &m_fnFadeOut;
443            else if (name == "change_vol_curve") return &m_fnChangeVolCurve;
444            else if (name == "change_tune_curve") return &m_fnChangeTuneCurve;
445            else if (name == "change_play_pos") return &m_fnChangePlayPos;
446            else if (name == "get_event_par") return &m_fnGetEventPar;
447            else if (name == "set_event_par") return &m_fnSetEventPar;
448            else if (name == "event_status") return &m_fnEventStatus;
449            else if (name == "wait") return &m_fnWait2; // override wait() core implementation
450            else if (name == "stop_wait") return &m_fnStopWait;
451            else if (name == "abort") return &m_fnAbort;
452            else if (name == "fork") return &m_fnFork;
453            else if (name == "callback_status") return &m_fnCallbackStatus;
454    
455          // built-in script functions of derived VM class          // built-in script functions of derived VM class
456          return ScriptVM::functionByName(name);          return ScriptVM::functionByName(name);
Legend:
Removed from v.2614  
changed lines
  Added in v.3691
  ViewVC Help
Powered by ViewVC