/[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 2594 by schoenebeck, Thu Jun 5 00:16:25 2014 UTC revision 2935 by schoenebeck, Sun Jul 10 14:24:13 2016 UTC
# Line 1  Line 1 
1  /*  /*
2   * Copyright (c) 2014 Christian Schoenebeck   * Copyright (c) 2014 - 2016 Christian Schoenebeck
3   *   *
4   * http://www.linuxsampler.org   * http://www.linuxsampler.org
5   *   *
# Line 9  Line 9 
9    
10  #include "InstrumentScriptVM.h"  #include "InstrumentScriptVM.h"
11  #include "../AbstractEngineChannel.h"  #include "../AbstractEngineChannel.h"
12    #include "../../common/global_private.h"
13    #include "AbstractInstrumentManager.h"
14    #include "MidiKeyboardManager.h"
15    
16  namespace LinuxSampler {  namespace LinuxSampler {
17    
18      // circumvents a bug in GCC 4.4 which prevents the sizeof() expr to be used      ///////////////////////////////////////////////////////////////////////
19      // directly within the scrope of a class (would throw a compiler error with:      // class 'EventGroup'
20      // "object missing in reference to 'LinuxSampler::AbstractEngineChannel::ControllerTable'")  
21      static const int _AbstractEngineChannel_ControllerTable_size = sizeof(AbstractEngineChannel::ControllerTable);      void EventGroup::insert(int eventID) {
22            if (contains(eventID)) return;
23      InstrumentScriptVM::InstrumentScriptVM() : m_event(NULL) {  
24          m_CC.size = _AbstractEngineChannel_ControllerTable_size;          AbstractEngine* pEngine = m_script->pEngineChannel->pEngine;
25          m_CC_NUM = DECLARE_VMINT(m_cause, class Event, Param.CC.Controller);  
26          m_EVENT_NOTE = DECLARE_VMINT(m_cause, class Event, Param.Note.Key);          // before adding the new event ID, check if there are any dead events
27          m_EVENT_VELOCITY = DECLARE_VMINT(m_cause, class Event, Param.Note.Velocity);          // 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        // class 'InstrumentScript'
54    
55        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            for (int i = 0; i < 128; ++i)
64                pKeyEvents[i] = NULL;
65            this->pEngineChannel = pEngineChannel;
66            for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i)
67                eventGroups[i].setScript(this);
68        }
69    
70        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        /** @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            unload();
94    
95            code = text;
96    
97            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            if (!pEvents) {
125                pEvents = new Pool<ScriptEvent>(CONFIG_MAX_EVENTS_PER_FRAGMENT);
126                for (int i = 0; i < 128; ++i)
127                    pKeyEvents[i] = new RTList<ScriptEvent>(pEvents);
128            }
129    
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         *
151         * Calling this method will however not clear the @c code member variable.
152         * Thus, the script can be parsed again afterwards.
153         */
154        void InstrumentScript::unload() {
155            //dmsg(1,("InstrumentScript::unload(this=0x%llx)\n", this));
156    
157            if (parserContext)
158                dmsg(1,("Unloading current instrument script.\n"));
159    
160            resetEvents();
161    
162            // 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        /**
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        
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    
209            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        ///////////////////////////////////////////////////////////////////////
219        // class 'InstrumentScriptVM'
220    
221        InstrumentScriptVM::InstrumentScriptVM() :
222            m_event(NULL), m_fnPlayNote(this), m_fnSetController(this),
223            m_fnIgnoreEvent(this), m_fnIgnoreController(this), m_fnNoteOff(this),
224            m_fnSetEventMark(this), m_fnDeleteEventMark(this), m_fnByMarks(this),
225            m_fnChangeVol(this), m_fnChangeTune(this), m_fnChangePan(this),
226            m_fnChangeCutoff(this), m_fnChangeReso(this), m_fnEventStatus(this)
227        {
228            m_CC.size = _MEMBER_SIZEOF(AbstractEngineChannel, ControllerTable);
229            m_CC_NUM = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.CC.Controller);
230            m_EVENT_ID = DECLARE_VMINT(m_event, class ScriptEvent, id);
231            m_EVENT_NOTE = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Key);
232            m_EVENT_VELOCITY = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Velocity);
233            m_KEY_DOWN.size = 128;
234      }      }
235    
236      VMExecStatus_t InstrumentScriptVM::exec(VMParserContext* parserCtx, ScriptEvent* event) {      VMExecStatus_t InstrumentScriptVM::exec(VMParserContext* parserCtx, ScriptEvent* event) {
# Line 29  namespace LinuxSampler { Line 238  namespace LinuxSampler {
238              static_cast<AbstractEngineChannel*>(event->cause.pEngineChannel);              static_cast<AbstractEngineChannel*>(event->cause.pEngineChannel);
239    
240          // prepare built-in script variables for script execution          // prepare built-in script variables for script execution
241          m_cause = &event->cause;          m_event = event;
242          m_CC.data = (int8_t*) &pEngineChannel->ControllerTable[0];          m_CC.data = (int8_t*) &pEngineChannel->ControllerTable[0];
243            m_KEY_DOWN.data = &pEngineChannel->GetMidiKeyboardManager()->KeyDown[0];
244    
245          // if script is in start condition, then do mandatory MIDI event          // if script is in start condition, then do mandatory MIDI event
246          // preprocessing tasks, which essentially means updating i.e. controller          // preprocessing tasks, which essentially means updating i.e. controller
247          // table with new CC value in case of a controller event, because the          // table with new CC value in case of a controller event, because the
248          // script might access the new CC value          // script might access the new CC value
249          if (!event->executionSlices) {          if (!event->executionSlices) {
250              switch (m_cause->Type) {              switch (event->cause.Type) {
251                  case Event::type_control_change:                  case Event::type_control_change:
252                      pEngineChannel->ControllerTable[m_cause->Param.CC.Controller] =                      pEngineChannel->ControllerTable[event->cause.Param.CC.Controller] =
253                          m_cause->Param.CC.Value;                          event->cause.Param.CC.Value;
254                      break;                      break;
255                  case Event::type_channel_pressure:                  case Event::type_channel_pressure:
256                      pEngineChannel->ControllerTable[CTRL_TABLE_IDX_AFTERTOUCH] =                      pEngineChannel->ControllerTable[CTRL_TABLE_IDX_AFTERTOUCH] =
257                          m_cause->Param.ChannelPressure.Value;                          event->cause.Param.ChannelPressure.Value;
258                      break;                      break;
259                  case Event::type_pitchbend:                  case Event::type_pitchbend:
260                      pEngineChannel->ControllerTable[CTRL_TABLE_IDX_PITCHBEND] =                      pEngineChannel->ControllerTable[CTRL_TABLE_IDX_PITCHBEND] =
261                          m_cause->Param.Pitch.Pitch;                          event->cause.Param.Pitch.Pitch;
262                      break;                      break;
263              }              }
264          }          }
265    
266          // run the script handler(s)          // run the script handler(s)
267          VMExecStatus_t res = VM_EXEC_NOT_RUNNING;          VMExecStatus_t res = VM_EXEC_NOT_RUNNING;
268          while (event->handlers[event->currentHandler]) {          for ( ; event->handlers[event->currentHandler]; event->currentHandler++) {
269              res = ScriptVM::exec(              res = ScriptVM::exec(
270                  parserCtx, event->execCtx, event->handlers[event->currentHandler++]                  parserCtx, event->execCtx, event->handlers[event->currentHandler]
271              );              );
272              event->executionSlices++;              event->executionSlices++;
273              if (res & VM_EXEC_SUSPENDED || res & VM_EXEC_ERROR) return res;              if (res & VM_EXEC_SUSPENDED || res & VM_EXEC_ERROR) return res;
# Line 72  namespace LinuxSampler { Line 282  namespace LinuxSampler {
282    
283          // now add own built-in variables          // now add own built-in variables
284          m["$CC_NUM"] = &m_CC_NUM;          m["$CC_NUM"] = &m_CC_NUM;
285            m["$EVENT_ID"] = &m_EVENT_ID;
286          m["$EVENT_NOTE"] = &m_EVENT_NOTE;          m["$EVENT_NOTE"] = &m_EVENT_NOTE;
287          m["$EVENT_VELOCITY"] = &m_EVENT_VELOCITY;          m["$EVENT_VELOCITY"] = &m_EVENT_VELOCITY;
288  //         m["$POLY_AT_NUM"] = &m_POLY_AT_NUM;  //         m["$POLY_AT_NUM"] = &m_POLY_AT_NUM;
# Line 85  namespace LinuxSampler { Line 296  namespace LinuxSampler {
296    
297          // now add own built-in variables          // now add own built-in variables
298          m["%CC"] = &m_CC;          m["%CC"] = &m_CC;
299          //m["%KEY_DOWN"] = &m_KEY_DOWN;          m["%KEY_DOWN"] = &m_KEY_DOWN;
300          //m["%POLY_AT"] = &m_POLY_AT;          //m["%POLY_AT"] = &m_POLY_AT;
301    
302          return m;          return m;
# Line 95  namespace LinuxSampler { Line 306  namespace LinuxSampler {
306          // first get buil-in integer variables of derived VM class          // first get buil-in integer variables of derived VM class
307          std::map<String,int> m = ScriptVM::builtInConstIntVariables();          std::map<String,int> m = ScriptVM::builtInConstIntVariables();
308    
309            m["$EVENT_STATUS_INACTIVE"] = EVENT_STATUS_INACTIVE;
310            m["$EVENT_STATUS_NOTE_QUEUE"] = EVENT_STATUS_NOTE_QUEUE;
311          m["$VCC_MONO_AT"] = CTRL_TABLE_IDX_AFTERTOUCH;          m["$VCC_MONO_AT"] = CTRL_TABLE_IDX_AFTERTOUCH;
312          m["$VCC_PITCH_BEND"] = CTRL_TABLE_IDX_PITCHBEND;          m["$VCC_PITCH_BEND"] = CTRL_TABLE_IDX_PITCHBEND;
313            for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i) {
314                m["$MARK_" + ToString(i+1)] = i;
315            }
316    
317          return m;          return m;
318      }      }
319    
320        VMFunction* InstrumentScriptVM::functionByName(const String& name) {
321            // built-in script functions of this class
322            if      (name == "play_note") return &m_fnPlayNote;
323            else if (name == "set_controller") return &m_fnSetController;
324            else if (name == "ignore_event") return &m_fnIgnoreEvent;
325            else if (name == "ignore_controller") return &m_fnIgnoreController;
326            else if (name == "note_off") return &m_fnNoteOff;
327            else if (name == "set_event_mark") return &m_fnSetEventMark;
328            else if (name == "delete_event_mark") return &m_fnDeleteEventMark;
329            else if (name == "by_marks") return &m_fnByMarks;
330            else if (name == "change_vol") return &m_fnChangeVol;
331            else if (name == "change_tune") return &m_fnChangeTune;
332            else if (name == "change_pan") return &m_fnChangePan;
333            else if (name == "change_cutoff") return &m_fnChangeCutoff;
334            else if (name == "change_reso") return &m_fnChangeReso;
335            else if (name == "event_status") return &m_fnEventStatus;
336    
337            // built-in script functions of derived VM class
338            return ScriptVM::functionByName(name);
339        }
340    
341  } // namespace LinuxSampler  } // namespace LinuxSampler
Legend:
Removed from v.2594  
changed lines
  Added in v.2935
  ViewVC Help
Powered by ViewVC