engines/common/Event.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
 *   Copyright (C) 2005 - 2016 Christian Schoenebeck                       *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the Free Software           *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 ***************************************************************************/

#ifndef __LS_EVENT_H__
#define __LS_EVENT_H__

#include "../../common/global.h"
#include "../../common/RTMath.h"
#include "../../common/RTAVLTree.h"
#include "../../common/Pool.h"
#include "../EngineChannel.h"

namespace LinuxSampler {

    // just symbol prototyping
    class Event;
    class SchedulerNode;
    class ScriptEvent;
    class ScheduledEvent;

    /**
     * Data type used to schedule events sample point accurately both within, as
     * well as beyond the scope of the current audio fragment cycle. The timing
     * reflected by this data type is consecutively running for a very long
     * time. Even with a sample rate of 96 kHz a scheduler time of this data
     * type will not wrap before 6 million years. So in practice such time
     * stamps are unique and will not repeat (unless the EventGenerator is
     * reset).
     */
    typedef uint64_t sched_time_t;

    /**
     * Generates Event objects and is responsible for resolving the position
     * in the current audio fragment each Event actually belongs to.
     */
    class EventGenerator {
        public:
            EventGenerator(uint SampleRate);
            void UpdateFragmentTime(uint SamplesToProcess);
            Event CreateEvent();
            Event CreateEvent(int32_t FragmentPos);

            template<typename T>
            void scheduleAheadMicroSec(RTAVLTree<T>& queue, T& node, int32_t fragmentPosBase, uint64_t microseconds);

            RTList<ScheduledEvent>::Iterator popNextScheduledEvent(RTAVLTree<ScheduledEvent>& queue, Pool<ScheduledEvent>& pool, sched_time_t end);
            RTList<ScriptEvent>::Iterator popNextScheduledScriptEvent(RTAVLTree<ScriptEvent>& queue, Pool<ScriptEvent>& pool, sched_time_t end);

            /**
             * Returns the scheduler time for the first sample point of the next
             * audio fragment cycle.
             */
            sched_time_t schedTimeAtCurrentFragmentEnd() const {
                return uiTotalSamplesProcessed + uiSamplesProcessed;
            }

        protected:
            typedef RTMath::time_stamp_t time_stamp_t;
            inline int32_t ToFragmentPos(time_stamp_t TimeStamp) {
                return int32_t (int32_t(TimeStamp - FragmentTime.begin) * FragmentTime.sample_ratio);
            }
            friend class Event;
        private:
            uint uiSampleRate;
            uint uiSamplesProcessed;
            struct __FragmentTime__ {
                time_stamp_t begin;        ///< Real time stamp of the beginning of this audio fragment cycle.
                time_stamp_t end;          ///< Real time stamp of the end of this audio fragment cycle.
                float        sample_ratio; ///< (Samples per cycle) / (Real time duration of cycle)
            } FragmentTime;
            sched_time_t uiTotalSamplesProcessed; ///< Total amount of sample points that have been processed since this EventGenerator object has been created. This is used to schedule instrument script events long time ahead in future (that is beyond the scope of the current audio fragment).
    };

    /**
     * Unique numeric ID of an event which can be used to retrieve access to
     * the actual @c Event object. Once the event associated with a certain ID
     * was released (back to its event pool), this numeric ID becomes invalid
     * and Pool< Event >::fromID() will detect this circumstance and will
     * return an invalid Iterator, and thus will prevent you from misusing an
     * event which no longer "exists".
     *
     * Note that an @c Event object usually just "exists" for exactly on audio
     * fragment cycle: that is it exists right from the beginning of the audio
     * fragment cycle where it was caused (i.e. where its MIDI data was
     * received by the respective engine channel) and will disappear
     * automatically at the end of that audio fragment cycle.
     */
    typedef pool_element_id_t event_id_t;

    /**
     * Unique numeric ID of a note which can be used to retrieve access to the
     * actual @c Note object. Once the note associated with a certain ID was
     * released (back to its note pool), this numeric ID becomes invalid and
     * Pool< Note >::fromID() will detect this circumstance and will return
     * an invalid Iterator, and thus will prevent you from misusing a note
     * which no longer is "alive".
     *
     * A @c Note object exists right when the respective MIDI note-on event
     * was received by the respective engine channel, and remains existent
     * until the caused note and all its voices were finally freed (which might
     * even be long time after the respective note-off event was received,
     * depending on the duration of the voice's release stages etc.).
     */
    typedef pool_element_id_t note_id_t;

    /**
     * Events are usually caused by a MIDI source or an internal modulation
     * controller like LFO or EG. An event should only be created by an
     * EventGenerator!
     *
     * @see EventGenerator, ScriptEvent
     */
    class Event {
        public:
            Event(){}
            enum type_t {
                type_note_on,
                type_note_off,
                type_pitchbend,
                type_control_change,
                type_sysex,           ///< MIDI system exclusive message
                type_cancel_release,  ///< transformed either from a note-on or sustain-pedal-down event
                type_release,         ///< transformed either from a note-off or sustain-pedal-up event
                type_channel_pressure, ///< a.k.a. aftertouch
                type_note_pressure, ///< polyphonic key pressure (aftertouch)
                type_note_synth_param, ///< change a note's synthesis parameters (upon real-time instrument script function calls)
            } Type;
            enum synth_param_t {
                synth_param_volume,
                synth_param_pitch,
                synth_param_pan,
            };
            union {
                /// Note-on and note-off event specifics
                struct _Note {
                    uint8_t Channel;     ///< MIDI channel (0..15)
                    uint8_t Key;         ///< MIDI key number of note-on / note-off event.
                    uint8_t Velocity;    ///< Trigger or release velocity of note-on / note-off event.
                    int8_t  Layer;       ///< Layer index (usually only used if a note-on event has to be postponed, e.g. due to shortage of free voices).
                    int8_t  ReleaseTrigger; ///< If new voice should be a release triggered voice (actually boolean field and usually only used if a note-on event has to be postponed, e.g. due to shortage of free voices).
                    note_id_t ID;        ///< Unique numeric ID of the @c Note object associated with this note (on) event.
                    note_id_t ParentNoteID; ///< If not zero: Unique numeric ID of the parent @c Note object that shall become parent of resulting new Note object of this Event. So this is used to associate a new note with a previous note, i.e. to release the new note once the parent note was released.
                    void*   pRegion;     ///< Engine specific pointer to instrument region
                } Note;
                /// Control change event specifics
                struct _CC {
                    uint8_t Channel;     ///< MIDI channel (0..15)
                    uint8_t Controller;  ///< MIDI controller number of control change event.
                    uint8_t Value;       ///< Controller Value of control change event.
                } CC;
                /// Pitchbend event specifics
                struct _Pitch {
                    uint8_t Channel;     ///< MIDI channel (0..15)
                    int16_t Pitch;       ///< Pitch value of pitchbend event.
                } Pitch;
                /// MIDI system exclusive event specifics
                struct _Sysex {
                    uint Size;           ///< Data length (in bytes) of MIDI system exclusive message.
                } Sysex;
                /// Channel Pressure (aftertouch) event specifics
                struct _ChannelPressure {
                    uint8_t Channel; ///< MIDI channel (0..15)
                    uint8_t Controller; ///< Should always be assigned to CTRL_TABLE_IDX_AFTERTOUCH.
                    uint8_t Value;   ///< New aftertouch / pressure value for keys on that channel.
                } ChannelPressure;
                /// Polyphonic Note Pressure (aftertouch) event specifics
                struct _NotePressure {
                    uint8_t Channel; ///< MIDI channel (0..15)
                    uint8_t Key;     ///< MIDI note number where key pressure (polyphonic aftertouch) changed.
                    uint8_t Value;   ///< New pressure value for note.
                } NotePressure;
                ///< Note synthesis parameter change event's specifics (used for real-time instrument script built-in functions which may alter synthesis parameters on note level).
                struct _NoteSynthParam {
                    note_id_t     NoteID;   ///< ID of Note whose voices shall be modified.
                    synth_param_t Type;     ///< Synthesis parameter which is to be changed.
                    float         Delta;    ///< The value change that should be applied against the note's current synthesis parameter value.
                    bool          Relative; ///< Whether @c Delta should be applied relatively against the note's current synthesis parameter value (false means the paramter's current value is simply replaced by Delta).
                    float         AbsValue; ///< New current absolute value of synthesis parameter (that is after @c Delta being applied).
                } NoteSynthParam;
            } Param;
            EngineChannel* pEngineChannel; ///< Pointer to the EngineChannel where this event occured on, NULL means Engine global event (e.g. SysEx message).
            MidiInputPort* pMidiInputPort; ///< Pointer to the MIDI input port on which this event occured (NOTE: currently only for global events, that is SysEx messages)

            inline void Init() {
                Param.Note.ID = 0;
                Param.Note.ParentNoteID = 0;
                Param.NoteSynthParam.NoteID = 0;
            }
            inline int32_t FragmentPos() {
                if (iFragmentPos >= 0) return iFragmentPos;
                iFragmentPos = pEventGenerator->ToFragmentPos(TimeStamp);
                if (iFragmentPos < 0) iFragmentPos = 0; // if event arrived shortly before the beginning of current fragment
                return iFragmentPos;
            }
            inline void ResetFragmentPos() {
                iFragmentPos = -1;
            }
            inline void CopyTimeFrom(const Event& other) {
                TimeStamp = other.TimeStamp;
                iFragmentPos = other.iFragmentPos;
            }
        protected:
            typedef EventGenerator::time_stamp_t time_stamp_t;
            Event(EventGenerator* pGenerator, EventGenerator::time_stamp_t Time);
            Event(EventGenerator* pGenerator, int32_t FragmentPos);
            friend class EventGenerator;
        private:
            EventGenerator* pEventGenerator; ///< Creator of the event.
            time_stamp_t    TimeStamp;       ///< Time stamp of the event's occurence.
            int32_t         iFragmentPos;    ///< Position in the current fragment this event refers to.
    };

    /**
     * Used to sort timing relevant objects (i.e. events) into timing/scheduler
     * queue. This class is just intended as base class and should be derived
     * for its actual purpose (for the precise data type being scheduled).
     */
    class SchedulerNode : public RTAVLNode {
    public:
        sched_time_t scheduleTime; ///< Time ahead in future (in sample points) when this object shall be processed. This value is compared with EventGenerator's uiTotalSamplesProcessed member variable.

        /// Required operator implementation for RTAVLTree class.
        inline bool operator==(const SchedulerNode& other) const {
            return this->scheduleTime == other.scheduleTime;
        }

        /// Required operator implementation for RTAVLTree class.
        inline bool operator<(const SchedulerNode& other) const {
            return this->scheduleTime < other.scheduleTime;
        }
    };

    /**
     * Used to sort delayed MIDI events into a timing/scheduler queue. This
     * object just contains the timing informations, the actual MIDI event is
     * pointed by member variable @c itEvent.
     */
    class ScheduledEvent : public SchedulerNode {
    public:
        Pool<Event>::Iterator itEvent; ///< Points to the actual Event object being scheduled.
    };

    class VMEventHandler;
    class VMExecContext;

    /** @brief Real-time instrument script event.
     *
     * Encapsulates one execution instance of a real-time instrument script for
     * exactly one script event handler (script event callback).
     *
     * This class derives from SchedulerNode for being able to be sorted efficiently
     * by the script scheduler if the script was either a) calling the wait()
     * script function or b) the script was auto suspended by the ScriptVM
     * because the script was executing for too long. In both cases the
     * scheduler has to sort the ScriptEvents in its execution queue according
     * to the precise time the respective script execution instance needs to be
     * resumed.
     */
    class ScriptEvent : public SchedulerNode {
    public:
        Event cause; ///< Copy of original external @c Event that triggered this script event (i.e. MIDI note on event, MIDI CC event, etc.).
        pool_element_id_t id; ///< Native representation of built-in script variable $EVENT_ID. For scripts' "note" event handler this will reflect the unique ID of the @c Note object, for all other event handlers the unique ID of the original external @c Event object that triggered this script event.
        VMEventHandler** handlers; ///< The script's event handlers (callbacks) to be processed (NULL terminated list).
        VMExecContext* execCtx; ///< Script's current execution state (polyphonic variables and execution stack).
        int currentHandler; ///< Current index in 'handlers' list above.
        int executionSlices; ///< Amount of times this script event has been executed by the ScriptVM runner class.
    };

    /**
     * Insert given @a node into the supplied timing @a queue with a scheduled
     * timing position given by @a fragmentPosBase and @a microseconds, where
     * @a microseconds reflects the amount of microseconds in future from "now"
     * where the node shall be scheduled, and @a fragmentPos identifies the
     * sample point within the current audio fragment cycle which shall be
     * interpreted by this method to be "now".
     *
     * The meaning of @a fragmentPosBase becomes more important the larger
     * the audio fragment size, and vice versa it bcomes less important the
     * smaller the audio fragment size.
     *
     * @param queue - destination scheduler queue
     * @param node - node (i.e. event) to be inserted into the queue
     * @param fragmentPosBase - sample point in current audio fragment to be "now"
     * @param microseconds - timing of node from "now" (in microseconds)
     */
    template<typename T>
    void EventGenerator::scheduleAheadMicroSec(RTAVLTree<T>& queue, T& node, int32_t fragmentPosBase, uint64_t microseconds) {
        node.scheduleTime = uiTotalSamplesProcessed + fragmentPosBase + float(uiSampleRate) * (float(microseconds) / 1000000.f);
        queue.insert(node);
    }

} // namespace LinuxSampler

#endif // __LS_EVENT_H__
1	/***************************************************************************
2	* *
3	* LinuxSampler - modular, streaming capable sampler *
4	* *
5	* Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6	* Copyright (C) 2005 - 2016 Christian Schoenebeck *
7	* *
8	* This program is free software; you can redistribute it and/or modify *
9	* it under the terms of the GNU General Public License as published by *
10	* the Free Software Foundation; either version 2 of the License, or *
11	* (at your option) any later version. *
12	* *
13	* This program is distributed in the hope that it will be useful, *
14	* but WITHOUT ANY WARRANTY; without even the implied warranty of *
15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16	* GNU General Public License for more details. *
17	* *
18	* You should have received a copy of the GNU General Public License *
19	* along with this program; if not, write to the Free Software *
20	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21	* MA 02111-1307 USA *
22	***************************************************************************/
23
24	#ifndef __LS_EVENT_H__
25	#define __LS_EVENT_H__
26
27	#include "../../common/global.h"
28	#include "../../common/RTMath.h"
29	#include "../../common/RTAVLTree.h"
30	#include "../../common/Pool.h"
31	#include "../EngineChannel.h"
32
33	namespace LinuxSampler {
34
35	// just symbol prototyping
36	class Event;
37	class SchedulerNode;
38	class ScriptEvent;
39	class ScheduledEvent;
40
41	/**
42	* Data type used to schedule events sample point accurately both within, as
43	* well as beyond the scope of the current audio fragment cycle. The timing
44	* reflected by this data type is consecutively running for a very long
45	* time. Even with a sample rate of 96 kHz a scheduler time of this data
46	* type will not wrap before 6 million years. So in practice such time
47	* stamps are unique and will not repeat (unless the EventGenerator is
48	* reset).
49	*/
50	typedef uint64_t sched_time_t;
51
52	/**
53	* Generates Event objects and is responsible for resolving the position
54	* in the current audio fragment each Event actually belongs to.
55	*/
56	class EventGenerator {
57	public:
58	EventGenerator(uint SampleRate);
59	void UpdateFragmentTime(uint SamplesToProcess);
60	Event CreateEvent();
61	Event CreateEvent(int32_t FragmentPos);
62
63	template<typename T>
64	void scheduleAheadMicroSec(RTAVLTree<T>& queue, T& node, int32_t fragmentPosBase, uint64_t microseconds);
65
66	RTList<ScheduledEvent>::Iterator popNextScheduledEvent(RTAVLTree<ScheduledEvent>& queue, Pool<ScheduledEvent>& pool, sched_time_t end);
67	RTList<ScriptEvent>::Iterator popNextScheduledScriptEvent(RTAVLTree<ScriptEvent>& queue, Pool<ScriptEvent>& pool, sched_time_t end);
68
69	/**
70	* Returns the scheduler time for the first sample point of the next
71	* audio fragment cycle.
72	*/
73	sched_time_t schedTimeAtCurrentFragmentEnd() const {
74	return uiTotalSamplesProcessed + uiSamplesProcessed;
75	}
76
77	protected:
78	typedef RTMath::time_stamp_t time_stamp_t;
79	inline int32_t ToFragmentPos(time_stamp_t TimeStamp) {
80	return int32_t (int32_t(TimeStamp - FragmentTime.begin) * FragmentTime.sample_ratio);
81	}
82	friend class Event;
83	private:
84	uint uiSampleRate;
85	uint uiSamplesProcessed;
86	struct __FragmentTime__ {
87	time_stamp_t begin; ///< Real time stamp of the beginning of this audio fragment cycle.
88	time_stamp_t end; ///< Real time stamp of the end of this audio fragment cycle.
89	float sample_ratio; ///< (Samples per cycle) / (Real time duration of cycle)
90	} FragmentTime;
91	sched_time_t uiTotalSamplesProcessed; ///< Total amount of sample points that have been processed since this EventGenerator object has been created. This is used to schedule instrument script events long time ahead in future (that is beyond the scope of the current audio fragment).
92	};
93
94	/**
95	* Unique numeric ID of an event which can be used to retrieve access to
96	* the actual @c Event object. Once the event associated with a certain ID
97	* was released (back to its event pool), this numeric ID becomes invalid
98	* and Pool< Event >::fromID() will detect this circumstance and will
99	* return an invalid Iterator, and thus will prevent you from misusing an
100	* event which no longer "exists".
101	*
102	* Note that an @c Event object usually just "exists" for exactly on audio
103	* fragment cycle: that is it exists right from the beginning of the audio
104	* fragment cycle where it was caused (i.e. where its MIDI data was
105	* received by the respective engine channel) and will disappear
106	* automatically at the end of that audio fragment cycle.
107	*/
108	typedef pool_element_id_t event_id_t;
109
110	/**
111	* Unique numeric ID of a note which can be used to retrieve access to the
112	* actual @c Note object. Once the note associated with a certain ID was
113	* released (back to its note pool), this numeric ID becomes invalid and
114	* Pool< Note >::fromID() will detect this circumstance and will return
115	* an invalid Iterator, and thus will prevent you from misusing a note
116	* which no longer is "alive".
117	*
118	* A @c Note object exists right when the respective MIDI note-on event
119	* was received by the respective engine channel, and remains existent
120	* until the caused note and all its voices were finally freed (which might
121	* even be long time after the respective note-off event was received,
122	* depending on the duration of the voice's release stages etc.).
123	*/
124	typedef pool_element_id_t note_id_t;
125
126	/**
127	* Events are usually caused by a MIDI source or an internal modulation
128	* controller like LFO or EG. An event should only be created by an
129	* EventGenerator!
130	*
131	* @see EventGenerator, ScriptEvent
132	*/
133	class Event {
134	public:
135	Event(){}
136	enum type_t {
137	type_note_on,
138	type_note_off,
139	type_pitchbend,
140	type_control_change,
141	type_sysex, ///< MIDI system exclusive message
142	type_cancel_release, ///< transformed either from a note-on or sustain-pedal-down event
143	type_release, ///< transformed either from a note-off or sustain-pedal-up event
144	type_channel_pressure, ///< a.k.a. aftertouch
145	type_note_pressure, ///< polyphonic key pressure (aftertouch)
146	type_note_synth_param, ///< change a note's synthesis parameters (upon real-time instrument script function calls)
147	} Type;
148	enum synth_param_t {
149	synth_param_volume,
150	synth_param_pitch,
151	synth_param_pan,
152	};
153	union {
154	/// Note-on and note-off event specifics
155	struct _Note {
156	uint8_t Channel; ///< MIDI channel (0..15)
157	uint8_t Key; ///< MIDI key number of note-on / note-off event.
158	uint8_t Velocity; ///< Trigger or release velocity of note-on / note-off event.
159	int8_t Layer; ///< Layer index (usually only used if a note-on event has to be postponed, e.g. due to shortage of free voices).
160	int8_t ReleaseTrigger; ///< If new voice should be a release triggered voice (actually boolean field and usually only used if a note-on event has to be postponed, e.g. due to shortage of free voices).
161	note_id_t ID; ///< Unique numeric ID of the @c Note object associated with this note (on) event.
162	note_id_t ParentNoteID; ///< If not zero: Unique numeric ID of the parent @c Note object that shall become parent of resulting new Note object of this Event. So this is used to associate a new note with a previous note, i.e. to release the new note once the parent note was released.
163	void* pRegion; ///< Engine specific pointer to instrument region
164	} Note;
165	/// Control change event specifics
166	struct _CC {
167	uint8_t Channel; ///< MIDI channel (0..15)
168	uint8_t Controller; ///< MIDI controller number of control change event.
169	uint8_t Value; ///< Controller Value of control change event.
170	} CC;
171	/// Pitchbend event specifics
172	struct _Pitch {
173	uint8_t Channel; ///< MIDI channel (0..15)
174	int16_t Pitch; ///< Pitch value of pitchbend event.
175	} Pitch;
176	/// MIDI system exclusive event specifics
177	struct _Sysex {
178	uint Size; ///< Data length (in bytes) of MIDI system exclusive message.
179	} Sysex;
180	/// Channel Pressure (aftertouch) event specifics
181	struct _ChannelPressure {
182	uint8_t Channel; ///< MIDI channel (0..15)
183	uint8_t Controller; ///< Should always be assigned to CTRL_TABLE_IDX_AFTERTOUCH.
184	uint8_t Value; ///< New aftertouch / pressure value for keys on that channel.
185	} ChannelPressure;
186	/// Polyphonic Note Pressure (aftertouch) event specifics
187	struct _NotePressure {
188	uint8_t Channel; ///< MIDI channel (0..15)
189	uint8_t Key; ///< MIDI note number where key pressure (polyphonic aftertouch) changed.
190	uint8_t Value; ///< New pressure value for note.
191	} NotePressure;
192	///< Note synthesis parameter change event's specifics (used for real-time instrument script built-in functions which may alter synthesis parameters on note level).
193	struct _NoteSynthParam {
194	note_id_t NoteID; ///< ID of Note whose voices shall be modified.
195	synth_param_t Type; ///< Synthesis parameter which is to be changed.
196	float Delta; ///< The value change that should be applied against the note's current synthesis parameter value.
197	bool Relative; ///< Whether @c Delta should be applied relatively against the note's current synthesis parameter value (false means the paramter's current value is simply replaced by Delta).
198	float AbsValue; ///< New current absolute value of synthesis parameter (that is after @c Delta being applied).
199	} NoteSynthParam;
200	} Param;
201	EngineChannel* pEngineChannel; ///< Pointer to the EngineChannel where this event occured on, NULL means Engine global event (e.g. SysEx message).
202	MidiInputPort* pMidiInputPort; ///< Pointer to the MIDI input port on which this event occured (NOTE: currently only for global events, that is SysEx messages)
203
204	inline void Init() {
205	Param.Note.ID = 0;
206	Param.Note.ParentNoteID = 0;
207	Param.NoteSynthParam.NoteID = 0;
208	}
209	inline int32_t FragmentPos() {
210	if (iFragmentPos >= 0) return iFragmentPos;
211	iFragmentPos = pEventGenerator->ToFragmentPos(TimeStamp);
212	if (iFragmentPos < 0) iFragmentPos = 0; // if event arrived shortly before the beginning of current fragment
213	return iFragmentPos;
214	}
215	inline void ResetFragmentPos() {
216	iFragmentPos = -1;
217	}
218	inline void CopyTimeFrom(const Event& other) {
219	TimeStamp = other.TimeStamp;
220	iFragmentPos = other.iFragmentPos;
221	}
222	protected:
223	typedef EventGenerator::time_stamp_t time_stamp_t;
224	Event(EventGenerator* pGenerator, EventGenerator::time_stamp_t Time);
225	Event(EventGenerator* pGenerator, int32_t FragmentPos);
226	friend class EventGenerator;
227	private:
228	EventGenerator* pEventGenerator; ///< Creator of the event.
229	time_stamp_t TimeStamp; ///< Time stamp of the event's occurence.
230	int32_t iFragmentPos; ///< Position in the current fragment this event refers to.
231	};
232
233	/**
234	* Used to sort timing relevant objects (i.e. events) into timing/scheduler
235	* queue. This class is just intended as base class and should be derived
236	* for its actual purpose (for the precise data type being scheduled).
237	*/
238	class SchedulerNode : public RTAVLNode {
239	public:
240	sched_time_t scheduleTime; ///< Time ahead in future (in sample points) when this object shall be processed. This value is compared with EventGenerator's uiTotalSamplesProcessed member variable.
241
242	/// Required operator implementation for RTAVLTree class.
243	inline bool operator==(const SchedulerNode& other) const {
244	return this->scheduleTime == other.scheduleTime;
245	}
246
247	/// Required operator implementation for RTAVLTree class.
248	inline bool operator<(const SchedulerNode& other) const {
249	return this->scheduleTime < other.scheduleTime;
250	}
251	};
252
253	/**
254	* Used to sort delayed MIDI events into a timing/scheduler queue. This
255	* object just contains the timing informations, the actual MIDI event is
256	* pointed by member variable @c itEvent.
257	*/
258	class ScheduledEvent : public SchedulerNode {
259	public:
260	Pool<Event>::Iterator itEvent; ///< Points to the actual Event object being scheduled.
261	};
262
263	class VMEventHandler;
264	class VMExecContext;
265
266	/** @brief Real-time instrument script event.
267	*
268	* Encapsulates one execution instance of a real-time instrument script for
269	* exactly one script event handler (script event callback).
270	*
271	* This class derives from SchedulerNode for being able to be sorted efficiently
272	* by the script scheduler if the script was either a) calling the wait()
273	* script function or b) the script was auto suspended by the ScriptVM
274	* because the script was executing for too long. In both cases the
275	* scheduler has to sort the ScriptEvents in its execution queue according
276	* to the precise time the respective script execution instance needs to be
277	* resumed.
278	*/
279	class ScriptEvent : public SchedulerNode {
280	public:
281	Event cause; ///< Copy of original external @c Event that triggered this script event (i.e. MIDI note on event, MIDI CC event, etc.).
282	pool_element_id_t id; ///< Native representation of built-in script variable $EVENT_ID. For scripts' "note" event handler this will reflect the unique ID of the @c Note object, for all other event handlers the unique ID of the original external @c Event object that triggered this script event.
283	VMEventHandler** handlers; ///< The script's event handlers (callbacks) to be processed (NULL terminated list).
284	VMExecContext* execCtx; ///< Script's current execution state (polyphonic variables and execution stack).
285	int currentHandler; ///< Current index in 'handlers' list above.
286	int executionSlices; ///< Amount of times this script event has been executed by the ScriptVM runner class.
287	};
288
289	/**
290	* Insert given @a node into the supplied timing @a queue with a scheduled
291	* timing position given by @a fragmentPosBase and @a microseconds, where
292	* @a microseconds reflects the amount of microseconds in future from "now"
293	* where the node shall be scheduled, and @a fragmentPos identifies the
294	* sample point within the current audio fragment cycle which shall be
295	* interpreted by this method to be "now".
296	*
297	* The meaning of @a fragmentPosBase becomes more important the larger
298	* the audio fragment size, and vice versa it bcomes less important the
299	* smaller the audio fragment size.
300	*
301	* @param queue - destination scheduler queue
302	* @param node - node (i.e. event) to be inserted into the queue
303	* @param fragmentPosBase - sample point in current audio fragment to be "now"
304	* @param microseconds - timing of node from "now" (in microseconds)
305	*/
306	template<typename T>
307	void EventGenerator::scheduleAheadMicroSec(RTAVLTree<T>& queue, T& node, int32_t fragmentPosBase, uint64_t microseconds) {
308	node.scheduleTime = uiTotalSamplesProcessed + fragmentPosBase + float(uiSampleRate) * (float(microseconds) / 1000000.f);
309	queue.insert(node);
310	}
311
312	} // namespace LinuxSampler
313
314	#endif // __LS_EVENT_H__