/[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 2630 - (show annotations) (download)
Fri Jun 13 15:01:06 2014 UTC (9 years, 9 months ago) by schoenebeck
File size: 11746 byte(s)
* Implemented built-in instrument script function "set_event_mark()".
* Implemented built-in instrument script function "delete_event_mark()".
* Implemented built-in instrument script function "by_marks()".
* Added built-in instrument script int const variables $MARK_1 to $MARK_28.
* Built-in instrument script functions "ignore_event()", "note_off()" and
  "gig_set_dim_zone()" now also accept an array of event IDs as argument
  (i.e. return value of new script function "by_marks()").
* Bumped version (1.0.0.svn53).

1 /*
2 * Copyright (c) 2014 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 "InstrumentScriptVM.h"
11 #include "../AbstractEngineChannel.h"
12 #include "../../common/global_private.h"
13 #include "AbstractInstrumentManager.h"
14 #include "MidiKeyboardManager.h"
15
16 namespace LinuxSampler {
17
18 ///////////////////////////////////////////////////////////////////////
19 // 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 // 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 this->pEngineChannel = pEngineChannel;
64 for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i)
65 eventGroups[i].setScript(this);
66 }
67
68 /** @brief Load real-time instrument script.
69 *
70 * Loads the real-time instrument script given by @a text on the engine
71 * channel this InstrumentScript object belongs to (defined by
72 * pEngineChannel member variable). The sampler engine's resource manager is
73 * used to allocate and share equivalent scripts on multiple engine
74 * channels.
75 *
76 * @param text - source code of script
77 */
78 void InstrumentScript::load(const String& text) {
79 dmsg(1,("Loading real-time instrument script ... "));
80
81 // hand back old script reference and VM execution contexts
82 // (if not done already)
83 unload();
84
85 code = text;
86
87 AbstractInstrumentManager* pManager =
88 dynamic_cast<AbstractInstrumentManager*>(pEngineChannel->pEngine->GetInstrumentManager());
89
90 // get new script reference
91 parserContext = pManager->scripts.Borrow(text, pEngineChannel);
92 if (!parserContext->errors().empty()) {
93 std::vector<ParserIssue> errors = parserContext->errors();
94 std::cerr << "[ScriptVM] Could not load instrument script, there were "
95 << errors.size() << " parser errors:\n";
96 for (int i = 0; i < errors.size(); ++i)
97 errors[i].dump();
98 return; // stop here if there were any parser errors
99 }
100
101 handlerInit = parserContext->eventHandlerByName("init");
102 handlerNote = parserContext->eventHandlerByName("note");
103 handlerRelease = parserContext->eventHandlerByName("release");
104 handlerController = parserContext->eventHandlerByName("controller");
105 bHasValidScript =
106 handlerInit || handlerNote || handlerRelease || handlerController;
107
108 // amount of script handlers each script event has to execute
109 int handlerExecCount = 0;
110 if (handlerNote || handlerRelease || handlerController) // only one of these are executed after "init" handler
111 handlerExecCount++;
112
113 // create script event pool (if it doesn't exist already)
114 if (!pEvents)
115 pEvents = new Pool<ScriptEvent>(CONFIG_MAX_EVENTS_PER_FRAGMENT);
116
117 // create new VM execution contexts for new script
118 while (!pEvents->poolIsEmpty()) {
119 RTList<ScriptEvent>::Iterator it = pEvents->allocAppend();
120 it->execCtx = pEngineChannel->pEngine->pScriptVM->createExecContext(
121 parserContext
122 );
123 it->handlers = new VMEventHandler*[handlerExecCount+1];
124 }
125 pEvents->clear();
126
127 dmsg(1,("Done\n"));
128 }
129
130 /** @brief Unload real-time instrument script.
131 *
132 * Unloads the currently used real-time instrument script and frees all
133 * resources allocated for that script. The sampler engine's resource manager
134 * is used to share equivalent scripts among multiple sampler channels, and
135 * to deallocate the parsed script once not used on any engine channel
136 * anymore.
137 *
138 * Calling this method will however not clear the @c code member variable.
139 * Thus, the script can be parsed again afterwards.
140 */
141 void InstrumentScript::unload() {
142 //dmsg(1,("InstrumentScript::unload(this=0x%llx)\n", this));
143
144 if (parserContext)
145 dmsg(1,("Unloading current instrument script.\n"));
146
147 // free allocated VM execution contexts
148 if (pEvents) {
149 pEvents->clear();
150 while (!pEvents->poolIsEmpty()) {
151 RTList<ScriptEvent>::Iterator it = pEvents->allocAppend();
152 if (it->execCtx) {
153 // free VM execution context object
154 delete it->execCtx;
155 it->execCtx = NULL;
156 // free C array of handler pointers
157 delete [] it->handlers;
158 }
159 }
160 pEvents->clear();
161 }
162 // hand back VM representation of script
163 if (parserContext) {
164 AbstractInstrumentManager* pManager =
165 dynamic_cast<AbstractInstrumentManager*>(pEngineChannel->pEngine->GetInstrumentManager());
166
167 pManager->scripts.HandBack(parserContext, pEngineChannel);
168 parserContext = NULL;
169 handlerInit = NULL;
170 handlerNote = NULL;
171 handlerRelease = NULL;
172 handlerController = NULL;
173 }
174 bHasValidScript = false;
175 }
176
177 /**
178 * Same as unload(), but this one also empties the @c code member variable
179 * to an empty string.
180 */
181 void InstrumentScript::resetAll() {
182 unload();
183 code.clear();
184 }
185
186 ///////////////////////////////////////////////////////////////////////
187 // class 'InstrumentScriptVM'
188
189 InstrumentScriptVM::InstrumentScriptVM() :
190 m_event(NULL), m_fnPlayNote(this), m_fnSetController(this),
191 m_fnIgnoreEvent(this), m_fnIgnoreController(this), m_fnNoteOff(this),
192 m_fnSetEventMark(this), m_fnDeleteEventMark(this), m_fnByMarks(this)
193 {
194 m_CC.size = _MEMBER_SIZEOF(AbstractEngineChannel, ControllerTable);
195 m_CC_NUM = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.CC.Controller);
196 m_EVENT_ID = DECLARE_VMINT(m_event, class ScriptEvent, id);
197 m_EVENT_NOTE = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Key);
198 m_EVENT_VELOCITY = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Velocity);
199 m_KEY_DOWN.size = 128;
200 }
201
202 VMExecStatus_t InstrumentScriptVM::exec(VMParserContext* parserCtx, ScriptEvent* event) {
203 AbstractEngineChannel* pEngineChannel =
204 static_cast<AbstractEngineChannel*>(event->cause.pEngineChannel);
205
206 // prepare built-in script variables for script execution
207 m_event = event;
208 m_CC.data = (int8_t*) &pEngineChannel->ControllerTable[0];
209 m_KEY_DOWN.data = &pEngineChannel->GetMidiKeyboardManager()->KeyDown[0];
210
211 // if script is in start condition, then do mandatory MIDI event
212 // preprocessing tasks, which essentially means updating i.e. controller
213 // table with new CC value in case of a controller event, because the
214 // script might access the new CC value
215 if (!event->executionSlices) {
216 switch (event->cause.Type) {
217 case Event::type_control_change:
218 pEngineChannel->ControllerTable[event->cause.Param.CC.Controller] =
219 event->cause.Param.CC.Value;
220 break;
221 case Event::type_channel_pressure:
222 pEngineChannel->ControllerTable[CTRL_TABLE_IDX_AFTERTOUCH] =
223 event->cause.Param.ChannelPressure.Value;
224 break;
225 case Event::type_pitchbend:
226 pEngineChannel->ControllerTable[CTRL_TABLE_IDX_PITCHBEND] =
227 event->cause.Param.Pitch.Pitch;
228 break;
229 }
230 }
231
232 // run the script handler(s)
233 VMExecStatus_t res = VM_EXEC_NOT_RUNNING;
234 for ( ; event->handlers[event->currentHandler]; event->currentHandler++) {
235 res = ScriptVM::exec(
236 parserCtx, event->execCtx, event->handlers[event->currentHandler]
237 );
238 event->executionSlices++;
239 if (res & VM_EXEC_SUSPENDED || res & VM_EXEC_ERROR) return res;
240 }
241
242 return res;
243 }
244
245 std::map<String,VMIntRelPtr*> InstrumentScriptVM::builtInIntVariables() {
246 // first get buil-in integer variables of derived VM class
247 std::map<String,VMIntRelPtr*> m = ScriptVM::builtInIntVariables();
248
249 // now add own built-in variables
250 m["$CC_NUM"] = &m_CC_NUM;
251 m["$EVENT_ID"] = &m_EVENT_ID;
252 m["$EVENT_NOTE"] = &m_EVENT_NOTE;
253 m["$EVENT_VELOCITY"] = &m_EVENT_VELOCITY;
254 // m["$POLY_AT_NUM"] = &m_POLY_AT_NUM;
255
256 return m;
257 }
258
259 std::map<String,VMInt8Array*> InstrumentScriptVM::builtInIntArrayVariables() {
260 // first get buil-in integer array variables of derived VM class
261 std::map<String,VMInt8Array*> m = ScriptVM::builtInIntArrayVariables();
262
263 // now add own built-in variables
264 m["%CC"] = &m_CC;
265 m["%KEY_DOWN"] = &m_KEY_DOWN;
266 //m["%POLY_AT"] = &m_POLY_AT;
267
268 return m;
269 }
270
271 std::map<String,int> InstrumentScriptVM::builtInConstIntVariables() {
272 // first get buil-in integer variables of derived VM class
273 std::map<String,int> m = ScriptVM::builtInConstIntVariables();
274
275 m["$VCC_MONO_AT"] = CTRL_TABLE_IDX_AFTERTOUCH;
276 m["$VCC_PITCH_BEND"] = CTRL_TABLE_IDX_PITCHBEND;
277 for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i) {
278 m["$MARK_" + ToString(i+1)] = i;
279 }
280
281 return m;
282 }
283
284 VMFunction* InstrumentScriptVM::functionByName(const String& name) {
285 // built-in script functions of this class
286 if (name == "play_note") return &m_fnPlayNote;
287 else if (name == "set_controller") return &m_fnSetController;
288 else if (name == "ignore_event") return &m_fnIgnoreEvent;
289 else if (name == "ignore_controller") return &m_fnIgnoreController;
290 else if (name == "note_off") return &m_fnNoteOff;
291 else if (name == "set_event_mark") return &m_fnSetEventMark;
292 else if (name == "delete_event_mark") return &m_fnDeleteEventMark;
293 else if (name == "by_marks") return &m_fnByMarks;
294
295 // built-in script functions of derived VM class
296 return ScriptVM::functionByName(name);
297 }
298
299 } // namespace LinuxSampler

  ViewVC Help
Powered by ViewVC