/[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 2611 by schoenebeck, Mon Jun 9 19:20:37 2014 UTC revision 3335 by schoenebeck, Sun Jul 30 14:33:15 2017 UTC
# Line 1  Line 1 
1  /*  /*
2   * Copyright (c) 2014 Christian Schoenebeck   * Copyright (c) 2014 - 2017 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"
16    #include "Fade.h"
17    
18  namespace LinuxSampler {  namespace LinuxSampler {
19    
20      ///////////////////////////////////////////////////////////////////////      ///////////////////////////////////////////////////////////////////////
21        // class 'EventGroup'
22    
23        void EventGroup::insert(int 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            int firstDead = -1;
35            for (int 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(int eventID) {
50            int 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            pEvents = NULL;
65            for (int i = 0; i < 128; ++i)
66                pKeyEvents[i] = NULL;
67            this->pEngineChannel = pEngineChannel;
68            for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i)
69                eventGroups[i].setScript(this);
70        }
71    
72        InstrumentScript::~InstrumentScript() {
73            resetAll();
74            if (pEvents) {
75                for (int i = 0; i < 128; ++i) delete pKeyEvents[i];
76                delete pEvents;
77            }
78        }
79    
80      /** @brief Load real-time instrument script.      /** @brief Load real-time instrument script.
81       *       *
82       * 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 32  namespace LinuxSampler { Line 92  namespace LinuxSampler {
92    
93          // hand back old script reference and VM execution contexts          // hand back old script reference and VM execution contexts
94          // (if not done already)          // (if not done already)
95          reset();          unload();
96    
97            code = text;
98    
99          AbstractInstrumentManager* pManager =          AbstractInstrumentManager* pManager =
100              dynamic_cast<AbstractInstrumentManager*>(pEngineChannel->pEngine->GetInstrumentManager());              dynamic_cast<AbstractInstrumentManager*>(pEngineChannel->pEngine->GetInstrumentManager());
# Line 61  namespace LinuxSampler { Line 123  namespace LinuxSampler {
123              handlerExecCount++;              handlerExecCount++;
124    
125          // create script event pool (if it doesn't exist already)          // create script event pool (if it doesn't exist already)
126          if (!pEvents)          if (!pEvents) {
127              pEvents = new Pool<ScriptEvent>(CONFIG_MAX_EVENTS_PER_FRAGMENT);              pEvents = new Pool<ScriptEvent>(CONFIG_MAX_EVENTS_PER_FRAGMENT);
128                for (int i = 0; i < 128; ++i)
129                    pKeyEvents[i] = new RTList<ScriptEvent>(pEvents);
130                // reset RTAVLNode's tree node member variables after nodes are allocated
131                // (since we can't use a constructor right now, we do that initialization here)
132                while (!pEvents->poolIsEmpty()) {
133                    RTList<ScriptEvent>::Iterator it = pEvents->allocAppend();
134                    it->reset();
135                }
136                pEvents->clear();
137            }
138    
139          // create new VM execution contexts for new script          // create new VM execution contexts for new script
140          while (!pEvents->poolIsEmpty()) {          while (!pEvents->poolIsEmpty()) {
# Line 84  namespace LinuxSampler { Line 156  namespace LinuxSampler {
156       * is used to share equivalent scripts among multiple sampler channels, and       * is used to share equivalent scripts among multiple sampler channels, and
157       * to deallocate the parsed script once not used on any engine channel       * to deallocate the parsed script once not used on any engine channel
158       * anymore.       * anymore.
159         *
160         * Calling this method will however not clear the @c code member variable.
161         * Thus, the script can be parsed again afterwards.
162       */       */
163      void InstrumentScript::reset() {      void InstrumentScript::unload() {
164            //dmsg(1,("InstrumentScript::unload(this=0x%llx)\n", this));
165    
166          if (parserContext)          if (parserContext)
167              dmsg(1,("Unloading current instrument script."));              dmsg(1,("Unloading current instrument script.\n"));
168    
169            resetEvents();
170    
171          // free allocated VM execution contexts          // free allocated VM execution contexts
172          if (pEvents) {          if (pEvents) {
# Line 119  namespace LinuxSampler { Line 198  namespace LinuxSampler {
198          bHasValidScript = false;          bHasValidScript = false;
199      }      }
200    
201        /**
202         * Same as unload(), but this one also empties the @c code member variable
203         * to an empty string.
204         */
205        void InstrumentScript::resetAll() {
206            unload();
207            code.clear();
208        }
209        
210        /**
211         * Clears all currently active script events. This should be called
212         * whenever the engine or engine channel was reset for some reason.
213         */
214        void InstrumentScript::resetEvents() {
215            for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i)
216                eventGroups[i].clear();
217    
218            for (int i = 0; i < 128; ++i)
219                if (pKeyEvents[i])
220                    pKeyEvents[i]->clear();
221    
222            suspendedEvents.clear();
223    
224            if (pEvents) pEvents->clear();
225        }
226    
227      ///////////////////////////////////////////////////////////////////////      ///////////////////////////////////////////////////////////////////////
228      // class 'InstrumentScriptVM'      // class 'InstrumentScriptVM'
229    
230      InstrumentScriptVM::InstrumentScriptVM() :      InstrumentScriptVM::InstrumentScriptVM() :
231          m_event(NULL), m_fnPlayNote(this), m_fnSetController(this),          m_event(NULL), m_fnPlayNote(this), m_fnSetController(this),
232          m_fnIgnoreEvent(this), m_fnIgnoreController(this)          m_fnIgnoreEvent(this), m_fnIgnoreController(this), m_fnNoteOff(this),
233            m_fnSetEventMark(this), m_fnDeleteEventMark(this), m_fnByMarks(this),
234            m_fnChangeVol(this), m_fnChangeVolTime(this),
235            m_fnChangeTune(this), m_fnChangeTuneTime(this), m_fnChangePan(this),
236            m_fnChangePanTime(this), m_fnChangePanCurve(this),
237            m_fnChangeCutoff(this), m_fnChangeReso(this),  m_fnChangeAttack(this),
238            m_fnChangeDecay(this), m_fnChangeSustain(this), m_fnChangeRelease(this),
239            m_fnChangeAmpLFODepth(this), m_fnChangeAmpLFOFreq(this),
240            m_fnChangePitchLFODepth(this), m_fnChangePitchLFOFreq(this),
241            m_fnChangeNote(this), m_fnChangeVelo(this), m_fnFork(this),
242            m_fnEventStatus(this), m_fnWait2(this), m_fnStopWait(this),
243            m_fnAbort(this), m_fnFadeIn(this), m_fnFadeOut(this),
244            m_fnChangeVolCurve(this), m_fnChangeTuneCurve(this),
245            m_fnGetEventPar(this), m_fnSetEventPar(this), m_fnChangePlayPos(this),
246            m_fnCallbackStatus(this),
247            m_varEngineUptime(this), m_varCallbackID(this), m_varAllEvents(this),
248            m_varCallbackChildID(this)
249      {      {
250          m_CC.size = _MEMBER_SIZEOF(AbstractEngineChannel, ControllerTable);          m_CC.size = _MEMBER_SIZEOF(AbstractEngineChannel, ControllerTable);
251          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);
252          m_EVENT_ID = DECLARE_VMINT(m_event, class ScriptEvent, id);          m_EVENT_ID = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, id);
253          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);
254          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);
255            m_KEY_DOWN.size = 128;
256            m_KEY_DOWN.readonly = true;
257            m_NI_CALLBACK_TYPE = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, handlerType);
258            m_NKSP_IGNORE_WAIT = DECLARE_VMINT(m_event, class ScriptEvent, ignoreAllWaitCalls);
259            m_NKSP_CALLBACK_PARENT_ID = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, parentHandlerID);
260      }      }
261    
262      VMExecStatus_t InstrumentScriptVM::exec(VMParserContext* parserCtx, ScriptEvent* event) {      VMExecStatus_t InstrumentScriptVM::exec(VMParserContext* parserCtx, ScriptEvent* event) {
# Line 140  namespace LinuxSampler { Line 266  namespace LinuxSampler {
266          // prepare built-in script variables for script execution          // prepare built-in script variables for script execution
267          m_event = event;          m_event = event;
268          m_CC.data = (int8_t*) &pEngineChannel->ControllerTable[0];          m_CC.data = (int8_t*) &pEngineChannel->ControllerTable[0];
269            m_KEY_DOWN.data = &pEngineChannel->GetMidiKeyboardManager()->KeyDown[0];
270    
271          // if script is in start condition, then do mandatory MIDI event          // if script is in start condition, then do mandatory MIDI event
272          // preprocessing tasks, which essentially means updating i.e. controller          // preprocessing tasks, which essentially means updating i.e. controller
# Line 159  namespace LinuxSampler { Line 286  namespace LinuxSampler {
286                      pEngineChannel->ControllerTable[CTRL_TABLE_IDX_PITCHBEND] =                      pEngineChannel->ControllerTable[CTRL_TABLE_IDX_PITCHBEND] =
287                          event->cause.Param.Pitch.Pitch;                          event->cause.Param.Pitch.Pitch;
288                      break;                      break;
289                    default:
290                        ; // noop
291              }              }
292          }          }
293    
# Line 169  namespace LinuxSampler { Line 298  namespace LinuxSampler {
298                  parserCtx, event->execCtx, event->handlers[event->currentHandler]                  parserCtx, event->execCtx, event->handlers[event->currentHandler]
299              );              );
300              event->executionSlices++;              event->executionSlices++;
301                if (!(res & VM_EXEC_SUSPENDED)) { // if script terminated ...
302                    // check if this script handler instance has any forked children
303                    // to be auto aborted
304                    for (int iChild = 0; iChild < MAX_FORK_PER_SCRIPT_HANDLER &&
305                         event->childHandlerID[iChild]; ++iChild)
306                    {
307                        RTList<ScriptEvent>::Iterator itChild =
308                            pEngineChannel->ScriptCallbackByID(event->childHandlerID[iChild]);
309                        if (itChild && itChild->autoAbortByParent)
310                            itChild->execCtx->signalAbort();
311                    }
312                }
313              if (res & VM_EXEC_SUSPENDED || res & VM_EXEC_ERROR) return res;              if (res & VM_EXEC_SUSPENDED || res & VM_EXEC_ERROR) return res;
314          }          }
315    
# Line 176  namespace LinuxSampler { Line 317  namespace LinuxSampler {
317      }      }
318    
319      std::map<String,VMIntRelPtr*> InstrumentScriptVM::builtInIntVariables() {      std::map<String,VMIntRelPtr*> InstrumentScriptVM::builtInIntVariables() {
320          // first get buil-in integer variables of derived VM class          // first get built-in integer variables of derived VM class
321          std::map<String,VMIntRelPtr*> m = ScriptVM::builtInIntVariables();          std::map<String,VMIntRelPtr*> m = ScriptVM::builtInIntVariables();
322    
323          // now add own built-in variables          // now add own built-in variables
# Line 185  namespace LinuxSampler { Line 326  namespace LinuxSampler {
326          m["$EVENT_NOTE"] = &m_EVENT_NOTE;          m["$EVENT_NOTE"] = &m_EVENT_NOTE;
327          m["$EVENT_VELOCITY"] = &m_EVENT_VELOCITY;          m["$EVENT_VELOCITY"] = &m_EVENT_VELOCITY;
328  //         m["$POLY_AT_NUM"] = &m_POLY_AT_NUM;  //         m["$POLY_AT_NUM"] = &m_POLY_AT_NUM;
329            m["$NI_CALLBACK_TYPE"] = &m_NI_CALLBACK_TYPE;
330            m["$NKSP_IGNORE_WAIT"] = &m_NKSP_IGNORE_WAIT;
331            m["$NKSP_CALLBACK_PARENT_ID"] = &m_NKSP_CALLBACK_PARENT_ID;
332    
333          return m;          return m;
334      }      }
335    
336      std::map<String,VMInt8Array*> InstrumentScriptVM::builtInIntArrayVariables() {      std::map<String,VMInt8Array*> InstrumentScriptVM::builtInIntArrayVariables() {
337          // first get buil-in integer array variables of derived VM class          // first get built-in integer array variables of derived VM class
338          std::map<String,VMInt8Array*> m = ScriptVM::builtInIntArrayVariables();          std::map<String,VMInt8Array*> m = ScriptVM::builtInIntArrayVariables();
339    
340          // now add own built-in variables          // now add own built-in variables
341          m["%CC"] = &m_CC;          m["%CC"] = &m_CC;
342          //m["%KEY_DOWN"] = &m_KEY_DOWN;          m["%KEY_DOWN"] = &m_KEY_DOWN;
343          //m["%POLY_AT"] = &m_POLY_AT;          //m["%POLY_AT"] = &m_POLY_AT;
344    
345          return m;          return m;
346      }      }
347    
348      std::map<String,int> InstrumentScriptVM::builtInConstIntVariables() {      std::map<String,int> InstrumentScriptVM::builtInConstIntVariables() {
349          // first get buil-in integer variables of derived VM class          // first get built-in integer variables of derived VM class
350          std::map<String,int> m = ScriptVM::builtInConstIntVariables();          std::map<String,int> m = ScriptVM::builtInConstIntVariables();
351    
352            m["$EVENT_STATUS_INACTIVE"] = EVENT_STATUS_INACTIVE;
353            m["$EVENT_STATUS_NOTE_QUEUE"] = EVENT_STATUS_NOTE_QUEUE;
354          m["$VCC_MONO_AT"] = CTRL_TABLE_IDX_AFTERTOUCH;          m["$VCC_MONO_AT"] = CTRL_TABLE_IDX_AFTERTOUCH;
355          m["$VCC_PITCH_BEND"] = CTRL_TABLE_IDX_PITCHBEND;          m["$VCC_PITCH_BEND"] = CTRL_TABLE_IDX_PITCHBEND;
356            for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i) {
357                m["$MARK_" + ToString(i+1)] = i;
358            }
359            m["$EVENT_PAR_NOTE"] = EVENT_PAR_NOTE;
360            m["$EVENT_PAR_VELOCITY"] = EVENT_PAR_VELOCITY;
361            m["$EVENT_PAR_VOLUME"] = EVENT_PAR_VOLUME;
362            m["$EVENT_PAR_TUNE"] = EVENT_PAR_TUNE;
363            m["$EVENT_PAR_0"] = EVENT_PAR_0;
364            m["$EVENT_PAR_1"] = EVENT_PAR_1;
365            m["$EVENT_PAR_2"] = EVENT_PAR_2;
366            m["$EVENT_PAR_3"] = EVENT_PAR_3;
367            m["$NKSP_LINEAR"] = FADE_CURVE_LINEAR;
368            m["$NKSP_EASE_IN_EASE_OUT"] = FADE_CURVE_EASE_IN_EASE_OUT;
369            m["$CALLBACK_STATUS_TERMINATED"] = CALLBACK_STATUS_TERMINATED;
370            m["$CALLBACK_STATUS_QUEUE"]      = CALLBACK_STATUS_QUEUE;
371            m["$CALLBACK_STATUS_RUNNING"]    = CALLBACK_STATUS_RUNNING;
372    
373            return m;
374        }
375    
376        std::map<String,VMDynVar*> InstrumentScriptVM::builtInDynamicVariables() {
377            // first get built-in dynamic variables of derived VM class
378            std::map<String,VMDynVar*> m = ScriptVM::builtInDynamicVariables();
379    
380            m["%ALL_EVENTS"] = &m_varAllEvents;
381            m["$ENGINE_UPTIME"] = &m_varEngineUptime;
382            m["$NI_CALLBACK_ID"] = &m_varCallbackID;
383            m["%NKSP_CALLBACK_CHILD_ID"] = &m_varCallbackChildID;
384    
385          return m;          return m;
386      }      }
# Line 217  namespace LinuxSampler { Line 391  namespace LinuxSampler {
391          else if (name == "set_controller") return &m_fnSetController;          else if (name == "set_controller") return &m_fnSetController;
392          else if (name == "ignore_event") return &m_fnIgnoreEvent;          else if (name == "ignore_event") return &m_fnIgnoreEvent;
393          else if (name == "ignore_controller") return &m_fnIgnoreController;          else if (name == "ignore_controller") return &m_fnIgnoreController;
394            else if (name == "note_off") return &m_fnNoteOff;
395            else if (name == "set_event_mark") return &m_fnSetEventMark;
396            else if (name == "delete_event_mark") return &m_fnDeleteEventMark;
397            else if (name == "by_marks") return &m_fnByMarks;
398            else if (name == "change_vol") return &m_fnChangeVol;
399            else if (name == "change_vol_time") return &m_fnChangeVolTime;
400            else if (name == "change_tune") return &m_fnChangeTune;
401            else if (name == "change_tune_time") return &m_fnChangeTuneTime;
402            else if (name == "change_note") return &m_fnChangeNote;
403            else if (name == "change_velo") return &m_fnChangeVelo;
404            else if (name == "change_pan") return &m_fnChangePan;
405            else if (name == "change_pan_time") return &m_fnChangePanTime;
406            else if (name == "change_pan_curve") return &m_fnChangePanCurve;
407            else if (name == "change_cutoff") return &m_fnChangeCutoff;
408            else if (name == "change_reso") return &m_fnChangeReso;
409            else if (name == "change_attack") return &m_fnChangeAttack;
410            else if (name == "change_decay") return &m_fnChangeDecay;
411            else if (name == "change_sustain") return &m_fnChangeSustain;
412            else if (name == "change_release") return &m_fnChangeRelease;
413            else if (name == "change_amp_lfo_depth") return &m_fnChangeAmpLFODepth;
414            else if (name == "change_amp_lfo_freq") return &m_fnChangeAmpLFOFreq;
415            else if (name == "change_pitch_lfo_depth") return &m_fnChangePitchLFODepth;
416            else if (name == "change_pitch_lfo_freq") return &m_fnChangePitchLFOFreq;
417            else if (name == "fade_in") return &m_fnFadeIn;
418            else if (name == "fade_out") return &m_fnFadeOut;
419            else if (name == "change_vol_curve") return &m_fnChangeVolCurve;
420            else if (name == "change_tune_curve") return &m_fnChangeTuneCurve;
421            else if (name == "change_play_pos") return &m_fnChangePlayPos;
422            else if (name == "get_event_par") return &m_fnGetEventPar;
423            else if (name == "set_event_par") return &m_fnSetEventPar;
424            else if (name == "event_status") return &m_fnEventStatus;
425            else if (name == "wait") return &m_fnWait2; // override wait() core implementation
426            else if (name == "stop_wait") return &m_fnStopWait;
427            else if (name == "abort") return &m_fnAbort;
428            else if (name == "fork") return &m_fnFork;
429            else if (name == "callback_status") return &m_fnCallbackStatus;
430    
431          // built-in script functions of derived VM class          // built-in script functions of derived VM class
432          return ScriptVM::functionByName(name);          return ScriptVM::functionByName(name);
Legend:
Removed from v.2611  
changed lines
  Added in v.3335
  ViewVC Help
Powered by ViewVC