/[svn]/linuxsampler/trunk/src/engines/common/InstrumentScriptVM.h
ViewVC logotype

Diff of /linuxsampler/trunk/src/engines/common/InstrumentScriptVM.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2935 by schoenebeck, Sun Jul 10 14:24:13 2016 UTC revision 3296 by schoenebeck, Wed Jun 28 09:45:56 2017 UTC
# Line 1  Line 1 
1  /*  /*
2   * Copyright (c) 2014-2016 Christian Schoenebeck   * Copyright (c) 2014-2017 Christian Schoenebeck
3   *   *
4   * http://www.linuxsampler.org   * http://www.linuxsampler.org
5   *   *
# Line 16  Line 16 
16  #include "Event.h"  #include "Event.h"
17  #include "../../common/Pool.h"  #include "../../common/Pool.h"
18  #include "InstrumentScriptVMFunctions.h"  #include "InstrumentScriptVMFunctions.h"
19    #include "InstrumentScriptVMDynVars.h"
20    
21  /**  /**
22   * Amount of bits on the left hand side of all pool_element_id_t numbers (i.e.   * Amount of bits on the left hand side of all pool_element_id_t numbers (i.e.
# Line 29  Line 30 
30  #define INSTR_SCRIPT_EVENT_ID_RESERVED_BITS 1  #define INSTR_SCRIPT_EVENT_ID_RESERVED_BITS 1
31    
32  /**  /**
33   * Used to mark IDs (in script scope) to actually be a note ID.   * Used by InstrScriptIDType_T to initialize its constants at compile time.
34     *
35     * This macro is already ready to initialize additional members for
36     * InstrScriptIDType_T (that is more than the currently two enum constants).
37     * Just keep in mind that you also have to increase
38     * INSTR_SCRIPT_EVENT_ID_RESERVED_BITS when you add more!
39     *
40     * @param x - sequential consecutive number (starting with zero)
41   */   */
42  #define INSTR_SCRIPT_NOTE_ID_FLAG   (1 << (sizeof(pool_element_id_t) * 8 - 1))  #define INSTR_SCRIPT_ID_TYPE_FLAG(x) \
43        (x << (sizeof(pool_element_id_t) * 8 - INSTR_SCRIPT_EVENT_ID_RESERVED_BITS))
44    
45    /**
46     * These flags are used to distinguish the individual ID Types in script scope
47     * from each other. They are added as most left bit(s) to each ID in script
48     * scope.
49     */
50    enum InstrScriptIDType_T {
51        /**
52         * Used to mark IDs (in script scope) to actually be a MIDI event ID.
53         */
54        INSTR_SCRIPT_EVENT_ID_FLAG = INSTR_SCRIPT_ID_TYPE_FLAG(0),
55    
56        /**
57         * Used to mark IDs (in script scope) to actually be a note ID.
58         */
59        INSTR_SCRIPT_NOTE_ID_FLAG = INSTR_SCRIPT_ID_TYPE_FLAG(1),
60    };
61    
62  #define INSTR_SCRIPT_EVENT_GROUPS 28  #define INSTR_SCRIPT_EVENT_GROUPS 28
63    
64  #define EVENT_STATUS_INACTIVE 0  #define EVENT_STATUS_INACTIVE 0
65  #define EVENT_STATUS_NOTE_QUEUE 1  #define EVENT_STATUS_NOTE_QUEUE 1
66    
67    enum {
68        EVENT_PAR_NOTE = 1,
69        EVENT_PAR_VELOCITY,
70        EVENT_PAR_VOLUME,
71        EVENT_PAR_TUNE,
72        EVENT_PAR_0 = 1024,
73        EVENT_PAR_1,
74        EVENT_PAR_2,
75        EVENT_PAR_3,
76    };
77    
78    enum {
79        CALLBACK_STATUS_TERMINATED = 0,
80        CALLBACK_STATUS_QUEUE = 1,
81        CALLBACK_STATUS_RUNNING = (1 << 1)
82    };
83    
84  namespace LinuxSampler {  namespace LinuxSampler {
85    
86      class AbstractEngineChannel;      class AbstractEngineChannel;
87      class InstrumentScript;      struct InstrumentScript;
88    
89      /** @brief Convert IDs between script scope and engine internal scope.      /** @brief Convert IDs between script scope and engine internal scope.
90       *       *
# Line 56  namespace LinuxSampler { Line 99  namespace LinuxSampler {
99       * event_id_t (engine internal scope) -> int (script scope)       * event_id_t (engine internal scope) -> int (script scope)
100       * note_id_t (engine internal scope)  -> int (script scope)       * note_id_t (engine internal scope)  -> int (script scope)
101       * @endcode       * @endcode
102       * This is required because engine internally notes and regular events are       * This is required because engine internally i.e. notes and regular events
103       * using their own, separate ID generating pool, and their ID number set       * are using their own, separate ID generating pool, and their ID number
104       * may thus overlap.       * set may thus overlap and historically there were built-in script
105         * functions in KSP which allow to pass both regular MIDI event IDs, as well
106         * as Note IDs. So we must be able to distinguish between them in our
107         * built-in script function implementations.
108       *       *
109       * @see INSTR_SCRIPT_EVENT_ID_RESERVED_BITS       * @see INSTR_SCRIPT_EVENT_ID_RESERVED_BITS
110       */       */
# Line 79  namespace LinuxSampler { Line 125  namespace LinuxSampler {
125           * internal scope.           * internal scope.
126           */           */
127          inline static ScriptID fromEventID(event_id_t id) {          inline static ScriptID fromEventID(event_id_t id) {
128              return ScriptID(id);              return ScriptID(INSTR_SCRIPT_EVENT_ID_FLAG | id);
129          }          }
130    
131          /**          /**
# Line 214  namespace LinuxSampler { Line 260  namespace LinuxSampler {
260          std::map<String,VMIntRelPtr*> builtInIntVariables() OVERRIDE;          std::map<String,VMIntRelPtr*> builtInIntVariables() OVERRIDE;
261          std::map<String,VMInt8Array*> builtInIntArrayVariables() OVERRIDE;          std::map<String,VMInt8Array*> builtInIntArrayVariables() OVERRIDE;
262          std::map<String,int> builtInConstIntVariables() OVERRIDE;          std::map<String,int> builtInConstIntVariables() OVERRIDE;
263            std::map<String,VMDynVar*> builtInDynamicVariables() OVERRIDE;
264      protected:      protected:
265          ScriptEvent* m_event; ///< The event currently executed by exec().          ScriptEvent* m_event; ///< The event currently executed by exec().
266    
267          // buil-in script variables          // built-in script variables
268          VMInt8Array m_CC;          VMInt8Array m_CC;
269          VMInt8RelPtr m_CC_NUM;          VMInt8RelPtr m_CC_NUM;
270          VMIntRelPtr  m_EVENT_ID;          VMIntRelPtr  m_EVENT_ID;
# Line 226  namespace LinuxSampler { Line 273  namespace LinuxSampler {
273          VMInt8Array  m_KEY_DOWN;          VMInt8Array  m_KEY_DOWN;
274          //VMIntArray m_POLY_AT; //TODO: ...          //VMIntArray m_POLY_AT; //TODO: ...
275          //int m_POLY_AT_NUM; //TODO: ...          //int m_POLY_AT_NUM; //TODO: ...
276            VMIntRelPtr  m_NI_CALLBACK_TYPE;
277            VMIntRelPtr  m_NKSP_IGNORE_WAIT;
278            VMIntRelPtr  m_NKSP_CALLBACK_PARENT_ID;
279    
280          // buil-in script functions          // built-in script functions
281          InstrumentScriptVMFunction_play_note m_fnPlayNote;          InstrumentScriptVMFunction_play_note m_fnPlayNote;
282          InstrumentScriptVMFunction_set_controller m_fnSetController;          InstrumentScriptVMFunction_set_controller m_fnSetController;
283          InstrumentScriptVMFunction_ignore_event m_fnIgnoreEvent;          InstrumentScriptVMFunction_ignore_event m_fnIgnoreEvent;
# Line 237  namespace LinuxSampler { Line 287  namespace LinuxSampler {
287          InstrumentScriptVMFunction_delete_event_mark m_fnDeleteEventMark;          InstrumentScriptVMFunction_delete_event_mark m_fnDeleteEventMark;
288          InstrumentScriptVMFunction_by_marks m_fnByMarks;          InstrumentScriptVMFunction_by_marks m_fnByMarks;
289          InstrumentScriptVMFunction_change_vol m_fnChangeVol;          InstrumentScriptVMFunction_change_vol m_fnChangeVol;
290            InstrumentScriptVMFunction_change_vol_time m_fnChangeVolTime;
291          InstrumentScriptVMFunction_change_tune m_fnChangeTune;          InstrumentScriptVMFunction_change_tune m_fnChangeTune;
292            InstrumentScriptVMFunction_change_tune_time m_fnChangeTuneTime;
293          InstrumentScriptVMFunction_change_pan m_fnChangePan;          InstrumentScriptVMFunction_change_pan m_fnChangePan;
294          InstrumentScriptVMFunction_change_cutoff m_fnChangeCutoff;          InstrumentScriptVMFunction_change_cutoff m_fnChangeCutoff;
295          InstrumentScriptVMFunction_change_reso m_fnChangeReso;          InstrumentScriptVMFunction_change_reso m_fnChangeReso;
296            InstrumentScriptVMFunction_change_attack m_fnChangeAttack;
297            InstrumentScriptVMFunction_change_decay m_fnChangeDecay;
298            InstrumentScriptVMFunction_change_release m_fnChangeRelease;
299            InstrumentScriptVMFunction_change_amp_lfo_depth m_fnChangeAmpLFODepth;
300            InstrumentScriptVMFunction_change_amp_lfo_freq m_fnChangeAmpLFOFreq;
301            InstrumentScriptVMFunction_change_pitch_lfo_depth m_fnChangePitchLFODepth;
302            InstrumentScriptVMFunction_change_pitch_lfo_freq m_fnChangePitchLFOFreq;
303            InstrumentScriptVMFunction_change_note m_fnChangeNote;
304            InstrumentScriptVMFunction_change_velo m_fnChangeVelo;
305            InstrumentScriptVMFunction_fork m_fnFork;
306          InstrumentScriptVMFunction_event_status m_fnEventStatus;          InstrumentScriptVMFunction_event_status m_fnEventStatus;
307            InstrumentScriptVMFunction_wait m_fnWait2;
308            InstrumentScriptVMFunction_stop_wait m_fnStopWait;
309            InstrumentScriptVMFunction_abort m_fnAbort;
310            InstrumentScriptVMFunction_fade_in m_fnFadeIn;
311            InstrumentScriptVMFunction_fade_out m_fnFadeOut;
312            InstrumentScriptVMFunction_change_vol_curve m_fnChangeVolCurve;
313            InstrumentScriptVMFunction_change_tune_curve m_fnChangeTuneCurve;
314            InstrumentScriptVMFunction_get_event_par m_fnGetEventPar;
315            InstrumentScriptVMFunction_set_event_par m_fnSetEventPar;
316            InstrumentScriptVMFunction_change_play_pos m_fnChangePlayPos;
317            InstrumentScriptVMFunction_callback_status m_fnCallbackStatus;
318            InstrumentScriptVMDynVar_ENGINE_UPTIME m_varEngineUptime;
319            InstrumentScriptVMDynVar_NI_CALLBACK_ID m_varCallbackID;
320            InstrumentScriptVMDynVar_ALL_EVENTS m_varAllEvents;
321            InstrumentScriptVMDynVar_NKSP_CALLBACK_CHILD_ID m_varCallbackChildID;
322    
323          friend class InstrumentScriptVMFunction_play_note;          friend class InstrumentScriptVMFunction_play_note;
324          friend class InstrumentScriptVMFunction_set_controller;          friend class InstrumentScriptVMFunction_set_controller;
# Line 252  namespace LinuxSampler { Line 329  namespace LinuxSampler {
329          friend class InstrumentScriptVMFunction_delete_event_mark;          friend class InstrumentScriptVMFunction_delete_event_mark;
330          friend class InstrumentScriptVMFunction_by_marks;          friend class InstrumentScriptVMFunction_by_marks;
331          friend class InstrumentScriptVMFunction_change_vol;          friend class InstrumentScriptVMFunction_change_vol;
332            friend class InstrumentScriptVMFunction_change_vol_time;
333          friend class InstrumentScriptVMFunction_change_tune;          friend class InstrumentScriptVMFunction_change_tune;
334            friend class InstrumentScriptVMFunction_change_tune_time;
335          friend class InstrumentScriptVMFunction_change_pan;          friend class InstrumentScriptVMFunction_change_pan;
336          friend class InstrumentScriptVMFunction_change_cutoff;          friend class InstrumentScriptVMFunction_change_cutoff;
337          friend class InstrumentScriptVMFunction_change_reso;          friend class InstrumentScriptVMFunction_change_reso;
338            friend class InstrumentScriptVMFunction_change_attack;
339            friend class InstrumentScriptVMFunction_change_decay;
340            friend class InstrumentScriptVMFunction_change_release;
341            friend class VMChangeSynthParamFunction;
342            friend class InstrumentScriptVMFunction_change_amp_lfo_depth;
343            friend class InstrumentScriptVMFunction_change_amp_lfo_freq;
344            friend class InstrumentScriptVMFunction_change_pitch_lfo_depth;
345            friend class InstrumentScriptVMFunction_change_pitch_lfo_freq;
346            friend class VMChangeFadeCurveFunction;
347            friend class InstrumentScriptVMFunction_fade_in;
348            friend class InstrumentScriptVMFunction_fade_out;
349            friend class InstrumentScriptVMFunction_get_event_par;
350            friend class InstrumentScriptVMFunction_set_event_par;
351            friend class InstrumentScriptVMFunction_change_note;
352            friend class InstrumentScriptVMFunction_change_velo;
353            friend class InstrumentScriptVMFunction_change_play_pos;
354          friend class InstrumentScriptVMFunction_event_status;          friend class InstrumentScriptVMFunction_event_status;
355            friend class InstrumentScriptVMFunction_wait;
356            friend class InstrumentScriptVMFunction_stop_wait;
357            friend class InstrumentScriptVMFunction_abort;
358            friend class InstrumentScriptVMFunction_fork;
359            friend class InstrumentScriptVMFunction_callback_status;
360            friend class InstrumentScriptVMDynVar_ENGINE_UPTIME;
361            friend class InstrumentScriptVMDynVar_NI_CALLBACK_ID;
362            friend class InstrumentScriptVMDynVar_ALL_EVENTS;
363            friend class InstrumentScriptVMDynVar_NKSP_CALLBACK_CHILD_ID;
364      };      };
365    
366  } // namespace LinuxSampler  } // namespace LinuxSampler
Legend:
Removed from v.2935  
changed lines
  Added in v.3296
  ViewVC Help
Powered by ViewVC