1 |
/* |
2 |
* Copyright (c) 2014 - 2016 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 |
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 |
// reset RTAVLNode's tree node member variables after nodes are allocated |
129 |
// (since we can't use a constructor right now, we do that initialization here) |
130 |
while (!pEvents->poolIsEmpty()) { |
131 |
RTList<ScriptEvent>::Iterator it = pEvents->allocAppend(); |
132 |
it->reset(); |
133 |
} |
134 |
pEvents->clear(); |
135 |
} |
136 |
|
137 |
// create new VM execution contexts for new script |
138 |
while (!pEvents->poolIsEmpty()) { |
139 |
RTList<ScriptEvent>::Iterator it = pEvents->allocAppend(); |
140 |
it->execCtx = pEngineChannel->pEngine->pScriptVM->createExecContext( |
141 |
parserContext |
142 |
); |
143 |
it->handlers = new VMEventHandler*[handlerExecCount+1]; |
144 |
} |
145 |
pEvents->clear(); |
146 |
|
147 |
dmsg(1,("Done\n")); |
148 |
} |
149 |
|
150 |
/** @brief Unload real-time instrument script. |
151 |
* |
152 |
* Unloads the currently used real-time instrument script and frees all |
153 |
* resources allocated for that script. The sampler engine's resource manager |
154 |
* is used to share equivalent scripts among multiple sampler channels, and |
155 |
* to deallocate the parsed script once not used on any engine channel |
156 |
* anymore. |
157 |
* |
158 |
* Calling this method will however not clear the @c code member variable. |
159 |
* Thus, the script can be parsed again afterwards. |
160 |
*/ |
161 |
void InstrumentScript::unload() { |
162 |
//dmsg(1,("InstrumentScript::unload(this=0x%llx)\n", this)); |
163 |
|
164 |
if (parserContext) |
165 |
dmsg(1,("Unloading current instrument script.\n")); |
166 |
|
167 |
resetEvents(); |
168 |
|
169 |
// free allocated VM execution contexts |
170 |
if (pEvents) { |
171 |
pEvents->clear(); |
172 |
while (!pEvents->poolIsEmpty()) { |
173 |
RTList<ScriptEvent>::Iterator it = pEvents->allocAppend(); |
174 |
if (it->execCtx) { |
175 |
// free VM execution context object |
176 |
delete it->execCtx; |
177 |
it->execCtx = NULL; |
178 |
// free C array of handler pointers |
179 |
delete [] it->handlers; |
180 |
} |
181 |
} |
182 |
pEvents->clear(); |
183 |
} |
184 |
// hand back VM representation of script |
185 |
if (parserContext) { |
186 |
AbstractInstrumentManager* pManager = |
187 |
dynamic_cast<AbstractInstrumentManager*>(pEngineChannel->pEngine->GetInstrumentManager()); |
188 |
|
189 |
pManager->scripts.HandBack(parserContext, pEngineChannel); |
190 |
parserContext = NULL; |
191 |
handlerInit = NULL; |
192 |
handlerNote = NULL; |
193 |
handlerRelease = NULL; |
194 |
handlerController = NULL; |
195 |
} |
196 |
bHasValidScript = false; |
197 |
} |
198 |
|
199 |
/** |
200 |
* Same as unload(), but this one also empties the @c code member variable |
201 |
* to an empty string. |
202 |
*/ |
203 |
void InstrumentScript::resetAll() { |
204 |
unload(); |
205 |
code.clear(); |
206 |
} |
207 |
|
208 |
/** |
209 |
* Clears all currently active script events. This should be called |
210 |
* whenever the engine or engine channel was reset for some reason. |
211 |
*/ |
212 |
void InstrumentScript::resetEvents() { |
213 |
for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i) |
214 |
eventGroups[i].clear(); |
215 |
|
216 |
for (int i = 0; i < 128; ++i) |
217 |
if (pKeyEvents[i]) |
218 |
pKeyEvents[i]->clear(); |
219 |
|
220 |
suspendedEvents.clear(); |
221 |
|
222 |
if (pEvents) pEvents->clear(); |
223 |
} |
224 |
|
225 |
/////////////////////////////////////////////////////////////////////// |
226 |
// class 'InstrumentScriptVM' |
227 |
|
228 |
InstrumentScriptVM::InstrumentScriptVM() : |
229 |
m_event(NULL), m_fnPlayNote(this), m_fnSetController(this), |
230 |
m_fnIgnoreEvent(this), m_fnIgnoreController(this), m_fnNoteOff(this), |
231 |
m_fnSetEventMark(this), m_fnDeleteEventMark(this), m_fnByMarks(this), |
232 |
m_fnChangeVol(this), m_fnChangeTune(this), m_fnChangePan(this), |
233 |
m_fnChangeCutoff(this), m_fnChangeReso(this), m_fnEventStatus(this), |
234 |
m_fnWait2(this), m_fnStopWait(this), |
235 |
m_varEngineUptime(this), m_varCallbackID(this) |
236 |
{ |
237 |
m_CC.size = _MEMBER_SIZEOF(AbstractEngineChannel, ControllerTable); |
238 |
m_CC_NUM = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.CC.Controller); |
239 |
m_EVENT_ID = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, id); |
240 |
m_EVENT_NOTE = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Key); |
241 |
m_EVENT_VELOCITY = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Velocity); |
242 |
m_KEY_DOWN.size = 128; |
243 |
m_NI_CALLBACK_TYPE = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, handlerType); |
244 |
m_NKSP_IGNORE_WAIT = DECLARE_VMINT(m_event, class ScriptEvent, ignoreAllWaitCalls); |
245 |
} |
246 |
|
247 |
VMExecStatus_t InstrumentScriptVM::exec(VMParserContext* parserCtx, ScriptEvent* event) { |
248 |
AbstractEngineChannel* pEngineChannel = |
249 |
static_cast<AbstractEngineChannel*>(event->cause.pEngineChannel); |
250 |
|
251 |
// prepare built-in script variables for script execution |
252 |
m_event = event; |
253 |
m_CC.data = (int8_t*) &pEngineChannel->ControllerTable[0]; |
254 |
m_KEY_DOWN.data = &pEngineChannel->GetMidiKeyboardManager()->KeyDown[0]; |
255 |
|
256 |
// if script is in start condition, then do mandatory MIDI event |
257 |
// preprocessing tasks, which essentially means updating i.e. controller |
258 |
// table with new CC value in case of a controller event, because the |
259 |
// script might access the new CC value |
260 |
if (!event->executionSlices) { |
261 |
switch (event->cause.Type) { |
262 |
case Event::type_control_change: |
263 |
pEngineChannel->ControllerTable[event->cause.Param.CC.Controller] = |
264 |
event->cause.Param.CC.Value; |
265 |
break; |
266 |
case Event::type_channel_pressure: |
267 |
pEngineChannel->ControllerTable[CTRL_TABLE_IDX_AFTERTOUCH] = |
268 |
event->cause.Param.ChannelPressure.Value; |
269 |
break; |
270 |
case Event::type_pitchbend: |
271 |
pEngineChannel->ControllerTable[CTRL_TABLE_IDX_PITCHBEND] = |
272 |
event->cause.Param.Pitch.Pitch; |
273 |
break; |
274 |
} |
275 |
} |
276 |
|
277 |
// run the script handler(s) |
278 |
VMExecStatus_t res = VM_EXEC_NOT_RUNNING; |
279 |
for ( ; event->handlers[event->currentHandler]; event->currentHandler++) { |
280 |
res = ScriptVM::exec( |
281 |
parserCtx, event->execCtx, event->handlers[event->currentHandler] |
282 |
); |
283 |
event->executionSlices++; |
284 |
if (res & VM_EXEC_SUSPENDED || res & VM_EXEC_ERROR) return res; |
285 |
} |
286 |
|
287 |
return res; |
288 |
} |
289 |
|
290 |
std::map<String,VMIntRelPtr*> InstrumentScriptVM::builtInIntVariables() { |
291 |
// first get built-in integer variables of derived VM class |
292 |
std::map<String,VMIntRelPtr*> m = ScriptVM::builtInIntVariables(); |
293 |
|
294 |
// now add own built-in variables |
295 |
m["$CC_NUM"] = &m_CC_NUM; |
296 |
m["$EVENT_ID"] = &m_EVENT_ID; |
297 |
m["$EVENT_NOTE"] = &m_EVENT_NOTE; |
298 |
m["$EVENT_VELOCITY"] = &m_EVENT_VELOCITY; |
299 |
// m["$POLY_AT_NUM"] = &m_POLY_AT_NUM; |
300 |
m["$NI_CALLBACK_TYPE"] = &m_NI_CALLBACK_TYPE; |
301 |
m["$NKSP_IGNORE_WAIT"] = &m_NKSP_IGNORE_WAIT; |
302 |
|
303 |
return m; |
304 |
} |
305 |
|
306 |
std::map<String,VMInt8Array*> InstrumentScriptVM::builtInIntArrayVariables() { |
307 |
// first get built-in integer array variables of derived VM class |
308 |
std::map<String,VMInt8Array*> m = ScriptVM::builtInIntArrayVariables(); |
309 |
|
310 |
// now add own built-in variables |
311 |
m["%CC"] = &m_CC; |
312 |
m["%KEY_DOWN"] = &m_KEY_DOWN; |
313 |
//m["%POLY_AT"] = &m_POLY_AT; |
314 |
|
315 |
return m; |
316 |
} |
317 |
|
318 |
std::map<String,int> InstrumentScriptVM::builtInConstIntVariables() { |
319 |
// first get built-in integer variables of derived VM class |
320 |
std::map<String,int> m = ScriptVM::builtInConstIntVariables(); |
321 |
|
322 |
m["$EVENT_STATUS_INACTIVE"] = EVENT_STATUS_INACTIVE; |
323 |
m["$EVENT_STATUS_NOTE_QUEUE"] = EVENT_STATUS_NOTE_QUEUE; |
324 |
m["$VCC_MONO_AT"] = CTRL_TABLE_IDX_AFTERTOUCH; |
325 |
m["$VCC_PITCH_BEND"] = CTRL_TABLE_IDX_PITCHBEND; |
326 |
for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i) { |
327 |
m["$MARK_" + ToString(i+1)] = i; |
328 |
} |
329 |
|
330 |
return m; |
331 |
} |
332 |
|
333 |
std::map<String,VMDynVar*> InstrumentScriptVM::builtInDynamicVariables() { |
334 |
// first get built-in dynamic variables of derived VM class |
335 |
std::map<String,VMDynVar*> m = ScriptVM::builtInDynamicVariables(); |
336 |
|
337 |
m["$ENGINE_UPTIME"] = &m_varEngineUptime; |
338 |
m["$NI_CALLBACK_ID"] = &m_varCallbackID; |
339 |
|
340 |
return m; |
341 |
} |
342 |
|
343 |
VMFunction* InstrumentScriptVM::functionByName(const String& name) { |
344 |
// built-in script functions of this class |
345 |
if (name == "play_note") return &m_fnPlayNote; |
346 |
else if (name == "set_controller") return &m_fnSetController; |
347 |
else if (name == "ignore_event") return &m_fnIgnoreEvent; |
348 |
else if (name == "ignore_controller") return &m_fnIgnoreController; |
349 |
else if (name == "note_off") return &m_fnNoteOff; |
350 |
else if (name == "set_event_mark") return &m_fnSetEventMark; |
351 |
else if (name == "delete_event_mark") return &m_fnDeleteEventMark; |
352 |
else if (name == "by_marks") return &m_fnByMarks; |
353 |
else if (name == "change_vol") return &m_fnChangeVol; |
354 |
else if (name == "change_tune") return &m_fnChangeTune; |
355 |
else if (name == "change_pan") return &m_fnChangePan; |
356 |
else if (name == "change_cutoff") return &m_fnChangeCutoff; |
357 |
else if (name == "change_reso") return &m_fnChangeReso; |
358 |
else if (name == "event_status") return &m_fnEventStatus; |
359 |
else if (name == "wait") return &m_fnWait2; // override wait() core implementation |
360 |
else if (name == "stop_wait") return &m_fnStopWait; |
361 |
|
362 |
// built-in script functions of derived VM class |
363 |
return ScriptVM::functionByName(name); |
364 |
} |
365 |
|
366 |
} // namespace LinuxSampler |