/[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 2600 by schoenebeck, Sat Jun 7 00:16:03 2014 UTC revision 2871 by schoenebeck, Sun Apr 10 18:22:23 2016 UTC
# Line 1  Line 1 
1  /*  /*
2   * Copyright (c) 2014 Christian Schoenebeck   * Copyright (c) 2014-2016 Christian Schoenebeck
3   *   *
4   * http://www.linuxsampler.org   * http://www.linuxsampler.org
5   *   *
# Line 11  Line 11 
11  #define LS_INSTRUMENT_SCRIPT_VM_H  #define LS_INSTRUMENT_SCRIPT_VM_H
12    
13  #include "../../common/global.h"  #include "../../common/global.h"
14    #include "../../common/ConstCapacityArray.h"
15  #include "../../scriptvm/ScriptVM.h"  #include "../../scriptvm/ScriptVM.h"
16  #include "Event.h"  #include "Event.h"
17    #include "../../common/Pool.h"
18  #include "InstrumentScriptVMFunctions.h"  #include "InstrumentScriptVMFunctions.h"
19    
20    #define INSTR_SCRIPT_EVENT_GROUPS 28
21    
22  namespace LinuxSampler {  namespace LinuxSampler {
23    
24        class AbstractEngineChannel;
25        class InstrumentScript;
26    
27        /** @brief List of Event IDs.
28         *
29         * Used for built-in script functions:
30         *     by_marks(), set_event_mark(), delete_event_mark()
31         */
32        class EventGroup : protected ConstCapacityArray<int> {
33        public:
34            EventGroup() : ConstCapacityArray<int>(CONFIG_MAX_EVENTS_PER_FRAGMENT), m_script(NULL) {}
35            void insert(int eventID);
36            void erase(int eventID);
37            void setScript(InstrumentScript* pScript) { m_script = pScript; }
38            inline int size() const { return ConstCapacityArray<int>::size(); }
39            inline void clear() { ConstCapacityArray<int>::clear(); }
40            inline int& operator[](uint index) { return ConstCapacityArray<int>::operator[](index); }
41            inline const int& operator[](uint index) const { return ConstCapacityArray<int>::operator[](index); }
42        protected:
43            InstrumentScript* m_script;
44        };
45    
46        /** @brief Real-time instrument script VM representation.
47         *
48         * Holds the VM representation of all event handlers of the currently loaded
49         * script, ready to be executed by the sampler engine.
50         *
51         * Even thought scripts (or to be more specific their event handler objects)
52         * are shared between sampler engine channels, the InstrumentScript struct
53         * instances though are not shared. Each sampler engine channel has its own
54         * instance of a InstrumentScript struct. That's important, because this
55         * struct also holds engine channel local informations, for example the
56         * events that occured on the respective engine channel.
57         */
58        struct InstrumentScript {
59            VMParserContext*      parserContext; ///< VM represenation of the currently loaded script or NULL if not script was loaded. Note that it is also not NULL if parser errors occurred!
60            bool                  bHasValidScript; ///< True in case there is a valid script currently loaded, false if script processing shall be skipped.
61            VMEventHandler*       handlerInit; ///< VM representation of script's initilization callback or NULL if current script did not define such an init handler.
62            VMEventHandler*       handlerNote; ///< VM representation of script's MIDI note on callback or NULL if current script did not define such an event handler.
63            VMEventHandler*       handlerRelease; ///< VM representation of script's MIDI note off callback or NULL if current script did not define such an event handler.
64            VMEventHandler*       handlerController; ///< VM representation of script's MIDI controller callback or NULL if current script did not define such an event handler.
65            Pool<ScriptEvent>*    pEvents; ///< Pool of all available script execution instances. ScriptEvents available to be allocated from the Pool are currently unused / not executiong, whereas the ScriptEvents allocated on the list are currently suspended / have not finished execution yet (@see pKeyEvents).
66            RTList<ScriptEvent>*  pKeyEvents[128]; ///< Stores previously finished executed "note on" script events for the respective active note/key as long as the key/note is active. This is however only done if there is a "note" script event handler and a "release" script event handler defined in the script and both handlers use (reference) polyphonic variables. If that is not the case, then this list is not used at all. So the purpose of pKeyEvents is only to implement preserving/passing polyphonic variable data from "on note .. end on" script block to the respective "on release .. end on" script block.
67            RTAVLTree<ScriptEvent> suspendedEvents; ///< Contains pointers to all suspended events, sorted by time when those script events are to be resumed next.
68            AbstractEngineChannel* pEngineChannel;
69            String                code; ///< Source code of the instrument script. Used in case the sampler engine is changed, in that case a new ScriptVM object is created for the engine and VMParserContext object for this script needs to be recreated as well. Thus the script is then parsed again by passing the source code to recreate the parser context.
70            EventGroup            eventGroups[INSTR_SCRIPT_EVENT_GROUPS]; ///< Used for built-in script functions: by_event_marks(), set_event_mark(), delete_event_mark().
71    
72            InstrumentScript(AbstractEngineChannel* pEngineChannel);
73            ~InstrumentScript();
74    
75            void load(const String& text);
76            void unload();
77            void resetAll();
78            void resetEvents();
79        };
80    
81      /** @brief Real-time instrument script virtual machine.      /** @brief Real-time instrument script virtual machine.
82       *       *
83       * Extends the core ScriptVM implementation with MIDI specific built-in       * Extends the core ScriptVM implementation with MIDI specific built-in
# Line 44  namespace LinuxSampler { Line 105  namespace LinuxSampler {
105          VMIntRelPtr  m_EVENT_ID;          VMIntRelPtr  m_EVENT_ID;
106          VMInt8RelPtr m_EVENT_NOTE;          VMInt8RelPtr m_EVENT_NOTE;
107          VMInt8RelPtr m_EVENT_VELOCITY;          VMInt8RelPtr m_EVENT_VELOCITY;
108          //VMIntArray m_KEY_DOWN; //TODO: ...          VMInt8Array  m_KEY_DOWN;
109          //VMIntArray m_POLY_AT; //TODO: ...          //VMIntArray m_POLY_AT; //TODO: ...
110          //int m_POLY_AT_NUM; //TODO: ...          //int m_POLY_AT_NUM; //TODO: ...
111    
# Line 53  namespace LinuxSampler { Line 114  namespace LinuxSampler {
114          InstrumentScriptVMFunction_set_controller m_fnSetController;          InstrumentScriptVMFunction_set_controller m_fnSetController;
115          InstrumentScriptVMFunction_ignore_event m_fnIgnoreEvent;          InstrumentScriptVMFunction_ignore_event m_fnIgnoreEvent;
116          InstrumentScriptVMFunction_ignore_controller m_fnIgnoreController;          InstrumentScriptVMFunction_ignore_controller m_fnIgnoreController;
117            InstrumentScriptVMFunction_note_off m_fnNoteOff;
118            InstrumentScriptVMFunction_set_event_mark m_fnSetEventMark;
119            InstrumentScriptVMFunction_delete_event_mark m_fnDeleteEventMark;
120            InstrumentScriptVMFunction_by_marks m_fnByMarks;
121    
122          friend class InstrumentScriptVMFunction_play_note;          friend class InstrumentScriptVMFunction_play_note;
123          friend class InstrumentScriptVMFunction_set_controller;          friend class InstrumentScriptVMFunction_set_controller;
124          friend class InstrumentScriptVMFunction_ignore_event;          friend class InstrumentScriptVMFunction_ignore_event;
125          friend class InstrumentScriptVMFunction_ignore_controller;          friend class InstrumentScriptVMFunction_ignore_controller;
126            friend class InstrumentScriptVMFunction_note_off;
127            friend class InstrumentScriptVMFunction_set_event_mark;
128            friend class InstrumentScriptVMFunction_delete_event_mark;
129            friend class InstrumentScriptVMFunction_by_marks;
130      };      };
131    
132  } // namespace LinuxSampler  } // namespace LinuxSampler
Legend:
Removed from v.2600  
changed lines
  Added in v.2871
  ViewVC Help
Powered by ViewVC