1 |
/* |
/* |
2 |
* Copyright (c) 2014 Christian Schoenebeck |
* Copyright (c) 2014 - 2017 Christian Schoenebeck |
3 |
* |
* |
4 |
* http://www.linuxsampler.org |
* http://www.linuxsampler.org |
5 |
* |
* |
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 |
|
|
17 |
namespace LinuxSampler { |
namespace LinuxSampler { |
18 |
|
|
19 |
/////////////////////////////////////////////////////////////////////// |
/////////////////////////////////////////////////////////////////////// |
20 |
|
// class 'EventGroup' |
21 |
|
|
22 |
|
void EventGroup::insert(int eventID) { |
23 |
|
if (contains(eventID)) return; |
24 |
|
|
25 |
|
AbstractEngine* pEngine = m_script->pEngineChannel->pEngine; |
26 |
|
|
27 |
|
// before adding the new event ID, check if there are any dead events |
28 |
|
// and remove them in that case, before otherwise we might run in danger |
29 |
|
// to run out of free space on this group for event IDs if a lot of |
30 |
|
// events die before being removed explicitly from the group by script |
31 |
|
// |
32 |
|
// NOTE: or should we do this "dead ones" check only once in a while? |
33 |
|
int firstDead = -1; |
34 |
|
for (int i = 0; i < size(); ++i) { |
35 |
|
if (firstDead >= 0) { |
36 |
|
if (pEngine->EventByID(eventID)) { |
37 |
|
remove(firstDead, i - firstDead); |
38 |
|
firstDead = -1; |
39 |
|
} |
40 |
|
} else { |
41 |
|
if (!pEngine->EventByID(eventID)) firstDead = i; |
42 |
|
} |
43 |
|
} |
44 |
|
|
45 |
|
append(eventID); |
46 |
|
} |
47 |
|
|
48 |
|
void EventGroup::erase(int eventID) { |
49 |
|
int index = find(eventID); |
50 |
|
remove(index); |
51 |
|
} |
52 |
|
|
53 |
|
/////////////////////////////////////////////////////////////////////// |
54 |
// class 'InstrumentScript' |
// class 'InstrumentScript' |
55 |
|
|
56 |
|
InstrumentScript::InstrumentScript(AbstractEngineChannel* pEngineChannel) { |
57 |
|
parserContext = NULL; |
58 |
|
bHasValidScript = false; |
59 |
|
handlerInit = NULL; |
60 |
|
handlerNote = NULL; |
61 |
|
handlerRelease = NULL; |
62 |
|
handlerController = NULL; |
63 |
|
pEvents = NULL; |
64 |
|
for (int i = 0; i < 128; ++i) |
65 |
|
pKeyEvents[i] = NULL; |
66 |
|
this->pEngineChannel = pEngineChannel; |
67 |
|
for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i) |
68 |
|
eventGroups[i].setScript(this); |
69 |
|
} |
70 |
|
|
71 |
|
InstrumentScript::~InstrumentScript() { |
72 |
|
resetAll(); |
73 |
|
if (pEvents) { |
74 |
|
for (int i = 0; i < 128; ++i) delete pKeyEvents[i]; |
75 |
|
delete pEvents; |
76 |
|
} |
77 |
|
} |
78 |
|
|
79 |
/** @brief Load real-time instrument script. |
/** @brief Load real-time instrument script. |
80 |
* |
* |
81 |
* 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 |
91 |
|
|
92 |
// hand back old script reference and VM execution contexts |
// hand back old script reference and VM execution contexts |
93 |
// (if not done already) |
// (if not done already) |
94 |
reset(); |
unload(); |
95 |
|
|
96 |
|
code = text; |
97 |
|
|
98 |
AbstractInstrumentManager* pManager = |
AbstractInstrumentManager* pManager = |
99 |
dynamic_cast<AbstractInstrumentManager*>(pEngineChannel->pEngine->GetInstrumentManager()); |
dynamic_cast<AbstractInstrumentManager*>(pEngineChannel->pEngine->GetInstrumentManager()); |
122 |
handlerExecCount++; |
handlerExecCount++; |
123 |
|
|
124 |
// create script event pool (if it doesn't exist already) |
// create script event pool (if it doesn't exist already) |
125 |
if (!pEvents) |
if (!pEvents) { |
126 |
pEvents = new Pool<ScriptEvent>(CONFIG_MAX_EVENTS_PER_FRAGMENT); |
pEvents = new Pool<ScriptEvent>(CONFIG_MAX_EVENTS_PER_FRAGMENT); |
127 |
|
for (int i = 0; i < 128; ++i) |
128 |
|
pKeyEvents[i] = new RTList<ScriptEvent>(pEvents); |
129 |
|
// reset RTAVLNode's tree node member variables after nodes are allocated |
130 |
|
// (since we can't use a constructor right now, we do that initialization here) |
131 |
|
while (!pEvents->poolIsEmpty()) { |
132 |
|
RTList<ScriptEvent>::Iterator it = pEvents->allocAppend(); |
133 |
|
it->reset(); |
134 |
|
} |
135 |
|
pEvents->clear(); |
136 |
|
} |
137 |
|
|
138 |
// create new VM execution contexts for new script |
// create new VM execution contexts for new script |
139 |
while (!pEvents->poolIsEmpty()) { |
while (!pEvents->poolIsEmpty()) { |
155 |
* is used to share equivalent scripts among multiple sampler channels, and |
* is used to share equivalent scripts among multiple sampler channels, and |
156 |
* to deallocate the parsed script once not used on any engine channel |
* to deallocate the parsed script once not used on any engine channel |
157 |
* anymore. |
* anymore. |
158 |
|
* |
159 |
|
* Calling this method will however not clear the @c code member variable. |
160 |
|
* Thus, the script can be parsed again afterwards. |
161 |
*/ |
*/ |
162 |
void InstrumentScript::reset() { |
void InstrumentScript::unload() { |
163 |
|
//dmsg(1,("InstrumentScript::unload(this=0x%llx)\n", this)); |
164 |
|
|
165 |
if (parserContext) |
if (parserContext) |
166 |
dmsg(1,("Unloading current instrument script.")); |
dmsg(1,("Unloading current instrument script.\n")); |
167 |
|
|
168 |
|
resetEvents(); |
169 |
|
|
170 |
// free allocated VM execution contexts |
// free allocated VM execution contexts |
171 |
if (pEvents) { |
if (pEvents) { |
197 |
bHasValidScript = false; |
bHasValidScript = false; |
198 |
} |
} |
199 |
|
|
200 |
|
/** |
201 |
|
* Same as unload(), but this one also empties the @c code member variable |
202 |
|
* to an empty string. |
203 |
|
*/ |
204 |
|
void InstrumentScript::resetAll() { |
205 |
|
unload(); |
206 |
|
code.clear(); |
207 |
|
} |
208 |
|
|
209 |
|
/** |
210 |
|
* Clears all currently active script events. This should be called |
211 |
|
* whenever the engine or engine channel was reset for some reason. |
212 |
|
*/ |
213 |
|
void InstrumentScript::resetEvents() { |
214 |
|
for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i) |
215 |
|
eventGroups[i].clear(); |
216 |
|
|
217 |
|
for (int i = 0; i < 128; ++i) |
218 |
|
if (pKeyEvents[i]) |
219 |
|
pKeyEvents[i]->clear(); |
220 |
|
|
221 |
|
suspendedEvents.clear(); |
222 |
|
|
223 |
|
if (pEvents) pEvents->clear(); |
224 |
|
} |
225 |
|
|
226 |
/////////////////////////////////////////////////////////////////////// |
/////////////////////////////////////////////////////////////////////// |
227 |
// class 'InstrumentScriptVM' |
// class 'InstrumentScriptVM' |
228 |
|
|
229 |
InstrumentScriptVM::InstrumentScriptVM() : |
InstrumentScriptVM::InstrumentScriptVM() : |
230 |
m_event(NULL), m_fnPlayNote(this), m_fnSetController(this), |
m_event(NULL), m_fnPlayNote(this), m_fnSetController(this), |
231 |
m_fnIgnoreEvent(this), m_fnIgnoreController(this) |
m_fnIgnoreEvent(this), m_fnIgnoreController(this), m_fnNoteOff(this), |
232 |
|
m_fnSetEventMark(this), m_fnDeleteEventMark(this), m_fnByMarks(this), |
233 |
|
m_fnChangeVol(this), m_fnChangeVolTime(this), |
234 |
|
m_fnChangeTune(this), m_fnChangeTuneTime(this), m_fnChangePan(this), |
235 |
|
m_fnChangeCutoff(this), m_fnChangeReso(this), m_fnChangeAttack(this), |
236 |
|
m_fnChangeDecay(this), m_fnChangeRelease(this), |
237 |
|
m_fnChangeAmpLFODepth(this), m_fnChangeAmpLFOFreq(this), |
238 |
|
m_fnChangePitchLFODepth(this), m_fnChangePitchLFOFreq(this), |
239 |
|
m_fnChangeNote(this), m_fnChangeVelo(this), |
240 |
|
m_fnEventStatus(this), m_fnWait2(this), m_fnStopWait(this), |
241 |
|
m_fnFadeIn(this), m_fnFadeOut(this), |
242 |
|
m_fnGetEventPar(this), m_fnSetEventPar(this), |
243 |
|
m_varEngineUptime(this), m_varCallbackID(this), m_varAllEvents(this) |
244 |
{ |
{ |
245 |
m_CC.size = _MEMBER_SIZEOF(AbstractEngineChannel, ControllerTable); |
m_CC.size = _MEMBER_SIZEOF(AbstractEngineChannel, ControllerTable); |
246 |
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); |
247 |
m_EVENT_ID = DECLARE_VMINT(m_event, class ScriptEvent, id); |
m_EVENT_ID = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, id); |
248 |
m_EVENT_NOTE = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Key); |
m_EVENT_NOTE = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Key); |
249 |
m_EVENT_VELOCITY = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Velocity); |
m_EVENT_VELOCITY = DECLARE_VMINT(m_event, class ScriptEvent, cause.Param.Note.Velocity); |
250 |
|
m_KEY_DOWN.size = 128; |
251 |
|
m_NI_CALLBACK_TYPE = DECLARE_VMINT_READONLY(m_event, class ScriptEvent, handlerType); |
252 |
|
m_NKSP_IGNORE_WAIT = DECLARE_VMINT(m_event, class ScriptEvent, ignoreAllWaitCalls); |
253 |
} |
} |
254 |
|
|
255 |
VMExecStatus_t InstrumentScriptVM::exec(VMParserContext* parserCtx, ScriptEvent* event) { |
VMExecStatus_t InstrumentScriptVM::exec(VMParserContext* parserCtx, ScriptEvent* event) { |
259 |
// prepare built-in script variables for script execution |
// prepare built-in script variables for script execution |
260 |
m_event = event; |
m_event = event; |
261 |
m_CC.data = (int8_t*) &pEngineChannel->ControllerTable[0]; |
m_CC.data = (int8_t*) &pEngineChannel->ControllerTable[0]; |
262 |
|
m_KEY_DOWN.data = &pEngineChannel->GetMidiKeyboardManager()->KeyDown[0]; |
263 |
|
|
264 |
// if script is in start condition, then do mandatory MIDI event |
// if script is in start condition, then do mandatory MIDI event |
265 |
// preprocessing tasks, which essentially means updating i.e. controller |
// preprocessing tasks, which essentially means updating i.e. controller |
279 |
pEngineChannel->ControllerTable[CTRL_TABLE_IDX_PITCHBEND] = |
pEngineChannel->ControllerTable[CTRL_TABLE_IDX_PITCHBEND] = |
280 |
event->cause.Param.Pitch.Pitch; |
event->cause.Param.Pitch.Pitch; |
281 |
break; |
break; |
282 |
|
default: |
283 |
|
; // noop |
284 |
} |
} |
285 |
} |
} |
286 |
|
|
298 |
} |
} |
299 |
|
|
300 |
std::map<String,VMIntRelPtr*> InstrumentScriptVM::builtInIntVariables() { |
std::map<String,VMIntRelPtr*> InstrumentScriptVM::builtInIntVariables() { |
301 |
// first get buil-in integer variables of derived VM class |
// first get built-in integer variables of derived VM class |
302 |
std::map<String,VMIntRelPtr*> m = ScriptVM::builtInIntVariables(); |
std::map<String,VMIntRelPtr*> m = ScriptVM::builtInIntVariables(); |
303 |
|
|
304 |
// now add own built-in variables |
// now add own built-in variables |
307 |
m["$EVENT_NOTE"] = &m_EVENT_NOTE; |
m["$EVENT_NOTE"] = &m_EVENT_NOTE; |
308 |
m["$EVENT_VELOCITY"] = &m_EVENT_VELOCITY; |
m["$EVENT_VELOCITY"] = &m_EVENT_VELOCITY; |
309 |
// m["$POLY_AT_NUM"] = &m_POLY_AT_NUM; |
// m["$POLY_AT_NUM"] = &m_POLY_AT_NUM; |
310 |
|
m["$NI_CALLBACK_TYPE"] = &m_NI_CALLBACK_TYPE; |
311 |
|
m["$NKSP_IGNORE_WAIT"] = &m_NKSP_IGNORE_WAIT; |
312 |
|
|
313 |
return m; |
return m; |
314 |
} |
} |
315 |
|
|
316 |
std::map<String,VMInt8Array*> InstrumentScriptVM::builtInIntArrayVariables() { |
std::map<String,VMInt8Array*> InstrumentScriptVM::builtInIntArrayVariables() { |
317 |
// first get buil-in integer array variables of derived VM class |
// first get built-in integer array variables of derived VM class |
318 |
std::map<String,VMInt8Array*> m = ScriptVM::builtInIntArrayVariables(); |
std::map<String,VMInt8Array*> m = ScriptVM::builtInIntArrayVariables(); |
319 |
|
|
320 |
// now add own built-in variables |
// now add own built-in variables |
321 |
m["%CC"] = &m_CC; |
m["%CC"] = &m_CC; |
322 |
//m["%KEY_DOWN"] = &m_KEY_DOWN; |
m["%KEY_DOWN"] = &m_KEY_DOWN; |
323 |
//m["%POLY_AT"] = &m_POLY_AT; |
//m["%POLY_AT"] = &m_POLY_AT; |
324 |
|
|
325 |
return m; |
return m; |
326 |
} |
} |
327 |
|
|
328 |
std::map<String,int> InstrumentScriptVM::builtInConstIntVariables() { |
std::map<String,int> InstrumentScriptVM::builtInConstIntVariables() { |
329 |
// first get buil-in integer variables of derived VM class |
// first get built-in integer variables of derived VM class |
330 |
std::map<String,int> m = ScriptVM::builtInConstIntVariables(); |
std::map<String,int> m = ScriptVM::builtInConstIntVariables(); |
331 |
|
|
332 |
|
m["$EVENT_STATUS_INACTIVE"] = EVENT_STATUS_INACTIVE; |
333 |
|
m["$EVENT_STATUS_NOTE_QUEUE"] = EVENT_STATUS_NOTE_QUEUE; |
334 |
m["$VCC_MONO_AT"] = CTRL_TABLE_IDX_AFTERTOUCH; |
m["$VCC_MONO_AT"] = CTRL_TABLE_IDX_AFTERTOUCH; |
335 |
m["$VCC_PITCH_BEND"] = CTRL_TABLE_IDX_PITCHBEND; |
m["$VCC_PITCH_BEND"] = CTRL_TABLE_IDX_PITCHBEND; |
336 |
|
for (int i = 0; i < INSTR_SCRIPT_EVENT_GROUPS; ++i) { |
337 |
|
m["$MARK_" + ToString(i+1)] = i; |
338 |
|
} |
339 |
|
m["$EVENT_PAR_NOTE"] = EVENT_PAR_NOTE; |
340 |
|
m["$EVENT_PAR_VELOCITY"] = EVENT_PAR_VELOCITY; |
341 |
|
m["$EVENT_PAR_VOLUME"] = EVENT_PAR_VOLUME; |
342 |
|
m["$EVENT_PAR_TUNE"] = EVENT_PAR_TUNE; |
343 |
|
m["$EVENT_PAR_0"] = EVENT_PAR_0; |
344 |
|
m["$EVENT_PAR_1"] = EVENT_PAR_1; |
345 |
|
m["$EVENT_PAR_2"] = EVENT_PAR_2; |
346 |
|
m["$EVENT_PAR_3"] = EVENT_PAR_3; |
347 |
|
|
348 |
|
return m; |
349 |
|
} |
350 |
|
|
351 |
|
std::map<String,VMDynVar*> InstrumentScriptVM::builtInDynamicVariables() { |
352 |
|
// first get built-in dynamic variables of derived VM class |
353 |
|
std::map<String,VMDynVar*> m = ScriptVM::builtInDynamicVariables(); |
354 |
|
|
355 |
|
m["%ALL_EVENTS"] = &m_varAllEvents; |
356 |
|
m["$ENGINE_UPTIME"] = &m_varEngineUptime; |
357 |
|
m["$NI_CALLBACK_ID"] = &m_varCallbackID; |
358 |
|
|
359 |
return m; |
return m; |
360 |
} |
} |
365 |
else if (name == "set_controller") return &m_fnSetController; |
else if (name == "set_controller") return &m_fnSetController; |
366 |
else if (name == "ignore_event") return &m_fnIgnoreEvent; |
else if (name == "ignore_event") return &m_fnIgnoreEvent; |
367 |
else if (name == "ignore_controller") return &m_fnIgnoreController; |
else if (name == "ignore_controller") return &m_fnIgnoreController; |
368 |
|
else if (name == "note_off") return &m_fnNoteOff; |
369 |
|
else if (name == "set_event_mark") return &m_fnSetEventMark; |
370 |
|
else if (name == "delete_event_mark") return &m_fnDeleteEventMark; |
371 |
|
else if (name == "by_marks") return &m_fnByMarks; |
372 |
|
else if (name == "change_vol") return &m_fnChangeVol; |
373 |
|
else if (name == "change_vol_time") return &m_fnChangeVolTime; |
374 |
|
else if (name == "change_tune") return &m_fnChangeTune; |
375 |
|
else if (name == "change_tune_time") return &m_fnChangeTuneTime; |
376 |
|
else if (name == "change_note") return &m_fnChangeNote; |
377 |
|
else if (name == "change_velo") return &m_fnChangeVelo; |
378 |
|
else if (name == "change_pan") return &m_fnChangePan; |
379 |
|
else if (name == "change_cutoff") return &m_fnChangeCutoff; |
380 |
|
else if (name == "change_reso") return &m_fnChangeReso; |
381 |
|
else if (name == "change_attack") return &m_fnChangeAttack; |
382 |
|
else if (name == "change_decay") return &m_fnChangeDecay; |
383 |
|
else if (name == "change_release") return &m_fnChangeRelease; |
384 |
|
else if (name == "change_amp_lfo_depth") return &m_fnChangeAmpLFODepth; |
385 |
|
else if (name == "change_amp_lfo_freq") return &m_fnChangeAmpLFOFreq; |
386 |
|
else if (name == "change_pitch_lfo_depth") return &m_fnChangePitchLFODepth; |
387 |
|
else if (name == "change_pitch_lfo_freq") return &m_fnChangePitchLFOFreq; |
388 |
|
else if (name == "fade_in") return &m_fnFadeIn; |
389 |
|
else if (name == "fade_out") return &m_fnFadeOut; |
390 |
|
else if (name == "get_event_par") return &m_fnGetEventPar; |
391 |
|
else if (name == "set_event_par") return &m_fnSetEventPar; |
392 |
|
else if (name == "event_status") return &m_fnEventStatus; |
393 |
|
else if (name == "wait") return &m_fnWait2; // override wait() core implementation |
394 |
|
else if (name == "stop_wait") return &m_fnStopWait; |
395 |
|
|
396 |
// built-in script functions of derived VM class |
// built-in script functions of derived VM class |
397 |
return ScriptVM::functionByName(name); |
return ScriptVM::functionByName(name); |