/[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 2871 by schoenebeck, Sun Apr 10 18:22:23 2016 UTC revision 2948 by schoenebeck, Fri Jul 15 15:29:04 2016 UTC
# 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.
23     * event_id_t, note_id_t) being reserved for script VM implementation internal
24     * purposes.
25     *
26     * Right now there is only one bit reserved, which allows the VM (and its
27     * built-in functions) to distinguish user supplied @c Event IDs (event_id_t)
28     * from @c Note IDs (note_id_t).
29     */
30    #define INSTR_SCRIPT_EVENT_ID_RESERVED_BITS 1
31    
32    /**
33     * 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_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
65    #define EVENT_STATUS_NOTE_QUEUE 1
66    
67  namespace LinuxSampler {  namespace LinuxSampler {
68    
69      class AbstractEngineChannel;      class AbstractEngineChannel;
70      class InstrumentScript;      class InstrumentScript;
71    
72        /** @brief Convert IDs between script scope and engine internal scope.
73         *
74         * This class is used to translate unique IDs of events between script
75         * scope and sampler engine internal scope, that is:
76         * @code
77         * int (script scope) -> event_id_t (engine internal scope)
78         * int (script scope) -> note_id_t (engine internal scope)
79         * @endcode
80         * and vice versa:
81         * @code
82         * event_id_t (engine internal scope) -> int (script scope)
83         * note_id_t (engine internal scope)  -> int (script scope)
84         * @endcode
85         * This is required because engine internally i.e. notes and regular events
86         * are using their own, separate ID generating pool, and their ID number
87         * set may thus overlap and historically there were built-in script
88         * functions in KSP which allow to pass both regular MIDI event IDs, as well
89         * as Note IDs. So we must be able to distinguish between them in our
90         * built-in script function implementations.
91         *
92         * @see INSTR_SCRIPT_EVENT_ID_RESERVED_BITS
93         */
94        class ScriptID {
95        public:
96            enum type_t {
97                EVENT, ///< ID is actually an event ID
98                NOTE, ///< ID is actually a note ID
99            };
100    
101            /**
102             * Construct a ScriptID object with an ID from script scope.
103             */
104            ScriptID(uint id) : m_id(id) {}
105    
106            /**
107             * Returns a ScriptID object constructed with an event ID from engine
108             * internal scope.
109             */
110            inline static ScriptID fromEventID(event_id_t id) {
111                return ScriptID(INSTR_SCRIPT_EVENT_ID_FLAG | id);
112            }
113    
114            /**
115             * Returns a ScriptID object constructed with a note ID from engine
116             * internal scope.
117             */
118            inline static ScriptID fromNoteID(note_id_t id) {
119                return ScriptID(INSTR_SCRIPT_NOTE_ID_FLAG | id);
120            }
121    
122            /**
123             * Whether the ID reflected by this ScriptID object is actually a note
124             * ID or rather an event ID.
125             */
126            inline type_t type() const {
127                return (m_id & INSTR_SCRIPT_NOTE_ID_FLAG) ? NOTE : EVENT;
128            }
129    
130            inline bool isNoteID() const {
131                return type() == NOTE;
132            }
133    
134            inline bool isEventID() const {
135                return type() == EVENT;
136            }
137    
138            /**
139             * Returns event ID (for engine internal scope) of the ID reflected by
140             * this ScriptID object, it returns 0 (being an invalid ID) if the ID
141             * reflected by this ScriptID object is not an event ID.
142             */
143            inline event_id_t eventID() const {
144                switch (type()) {
145                    case EVENT: return m_id;
146                    default:    return 0; // not an event id, return invalid ID
147                }
148            }
149    
150            /**
151             * Returns note ID (for engine internal scope) of the ID reflected by
152             * this ScriptID object, it returns 0 (being an invalid ID) if the ID
153             * reflected by this ScriptID object is not a note ID.
154             */
155            inline note_id_t noteID() const {
156                switch (type()) {
157                    case NOTE: return ~INSTR_SCRIPT_NOTE_ID_FLAG & m_id;
158                    default:   return 0; // not a note id, return invalid ID
159                }
160            }
161    
162            /**
163             * Integer cast operator, which returns an ID number of this ScripID
164             * object intended for script scope.
165             */
166            inline operator uint() const {
167                return m_id;
168            }
169    
170        private:
171            uint m_id;
172        };
173    
174      /** @brief List of Event IDs.      /** @brief List of Event IDs.
175       *       *
176       * Used for built-in script functions:       * Used for built-in script functions:
# Line 96  namespace LinuxSampler { Line 243  namespace LinuxSampler {
243          std::map<String,VMIntRelPtr*> builtInIntVariables() OVERRIDE;          std::map<String,VMIntRelPtr*> builtInIntVariables() OVERRIDE;
244          std::map<String,VMInt8Array*> builtInIntArrayVariables() OVERRIDE;          std::map<String,VMInt8Array*> builtInIntArrayVariables() OVERRIDE;
245          std::map<String,int> builtInConstIntVariables() OVERRIDE;          std::map<String,int> builtInConstIntVariables() OVERRIDE;
246            std::map<String,VMDynVar*> builtInDynamicVariables() OVERRIDE;
247      protected:      protected:
248          ScriptEvent* m_event; ///< The event currently executed by exec().          ScriptEvent* m_event; ///< The event currently executed by exec().
249    
# Line 108  namespace LinuxSampler { Line 256  namespace LinuxSampler {
256          VMInt8Array  m_KEY_DOWN;          VMInt8Array  m_KEY_DOWN;
257          //VMIntArray m_POLY_AT; //TODO: ...          //VMIntArray m_POLY_AT; //TODO: ...
258          //int m_POLY_AT_NUM; //TODO: ...          //int m_POLY_AT_NUM; //TODO: ...
259            VMIntRelPtr  m_NI_CALLBACK_TYPE;
260            VMIntRelPtr  m_NKSP_IGNORE_WAIT;
261    
262          // buil-in script functions          // buil-in script functions
263          InstrumentScriptVMFunction_play_note m_fnPlayNote;          InstrumentScriptVMFunction_play_note m_fnPlayNote;
# Line 118  namespace LinuxSampler { Line 268  namespace LinuxSampler {
268          InstrumentScriptVMFunction_set_event_mark m_fnSetEventMark;          InstrumentScriptVMFunction_set_event_mark m_fnSetEventMark;
269          InstrumentScriptVMFunction_delete_event_mark m_fnDeleteEventMark;          InstrumentScriptVMFunction_delete_event_mark m_fnDeleteEventMark;
270          InstrumentScriptVMFunction_by_marks m_fnByMarks;          InstrumentScriptVMFunction_by_marks m_fnByMarks;
271            InstrumentScriptVMFunction_change_vol m_fnChangeVol;
272            InstrumentScriptVMFunction_change_tune m_fnChangeTune;
273            InstrumentScriptVMFunction_change_pan m_fnChangePan;
274            InstrumentScriptVMFunction_change_cutoff m_fnChangeCutoff;
275            InstrumentScriptVMFunction_change_reso m_fnChangeReso;
276            InstrumentScriptVMFunction_event_status m_fnEventStatus;
277            InstrumentScriptVMFunction_wait m_fnWait2;
278            InstrumentScriptVMFunction_stop_wait m_fnStopWait;
279            InstrumentScriptVMDynVar_ENGINE_UPTIME m_varEngineUptime;
280            InstrumentScriptVMDynVar_NI_CALLBACK_ID m_varCallbackID;
281    
282          friend class InstrumentScriptVMFunction_play_note;          friend class InstrumentScriptVMFunction_play_note;
283          friend class InstrumentScriptVMFunction_set_controller;          friend class InstrumentScriptVMFunction_set_controller;
# Line 127  namespace LinuxSampler { Line 287  namespace LinuxSampler {
287          friend class InstrumentScriptVMFunction_set_event_mark;          friend class InstrumentScriptVMFunction_set_event_mark;
288          friend class InstrumentScriptVMFunction_delete_event_mark;          friend class InstrumentScriptVMFunction_delete_event_mark;
289          friend class InstrumentScriptVMFunction_by_marks;          friend class InstrumentScriptVMFunction_by_marks;
290            friend class InstrumentScriptVMFunction_change_vol;
291            friend class InstrumentScriptVMFunction_change_tune;
292            friend class InstrumentScriptVMFunction_change_pan;
293            friend class InstrumentScriptVMFunction_change_cutoff;
294            friend class InstrumentScriptVMFunction_change_reso;
295            friend class InstrumentScriptVMFunction_event_status;
296            friend class InstrumentScriptVMFunction_wait;
297            friend class InstrumentScriptVMFunction_stop_wait;
298            friend class InstrumentScriptVMDynVar_ENGINE_UPTIME;
299            friend class InstrumentScriptVMDynVar_NI_CALLBACK_ID;
300      };      };
301    
302  } // namespace LinuxSampler  } // namespace LinuxSampler
Legend:
Removed from v.2871  
changed lines
  Added in v.2948
  ViewVC Help
Powered by ViewVC