engines/common/Event.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
 *   Copyright (C) 2005 - 2017 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"
#include "../../scriptvm/common.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
             * current audio fragment cycle.
             */
            sched_time_t schedTimeAtCurrentFragmentStart() const {
                return uiTotalSamplesProcessed;
            }

            /**
             * 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;

    /**
     * Unique numeric ID of a script callback ID instance which can be used to
     * retrieve access to the actual @c ScriptEvent object. Once the script
     * callback instance associated with a certain ID stopped its execution
     * (that is completely stopped, not just suspended) then this numeric ID
     * becomes invalid and Pool< ScriptEvent >::fromID() will detect this
     * circumstance and will return an invalid Iterator, and thus will prevent
     * you from misusing a script callback instance which no longer "exists".
     */
    typedef pool_element_id_t script_callback_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, ///< (real) MIDI note-on event
                type_note_off, ///< (real) MIDI note-off event
                type_pitchbend, ///< MIDI pitch bend wheel change event
                type_control_change, ///< MIDI CC event
                type_sysex,           ///< MIDI system exclusive message
                type_cancel_release_key, ///< transformed either from a (real) MIDI note-on or sustain-pedal-down event
                type_release_key,     ///< transformed either from a (real) MIDI note-off or sustain-pedal-up event
                type_release_note,    ///< transformed from a type_stop_note event
                type_channel_pressure, ///< a.k.a. aftertouch
                type_note_pressure, ///< polyphonic key pressure (aftertouch)
                type_play_note, ///< caused by a call to built-in instrument script function play_note()
                type_stop_note, ///< caused by a call to built-in instrument script function note_off()
                type_kill_note, ///< caused by a call to built-in instrument script function fade_out()
                type_note_synth_param, ///< change a note's synthesis parameters (upon real-time instrument script function calls, i.e. change_vol(), change_tune(), change_pan(), etc.)
            } Type;
            enum synth_param_t {
                synth_param_volume,
                synth_param_volume_time,
                synth_param_pitch,
                synth_param_pitch_time,
                synth_param_pan,
                synth_param_cutoff,
                synth_param_resonance,
                synth_param_attack,
                synth_param_decay,
                synth_param_release,
                synth_param_amp_lfo_depth,
                synth_param_amp_lfo_freq,
                synth_param_pitch_lfo_depth,
                synth_param_pitch_lfo_freq,
            };
            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 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;
            }
            inline sched_time_t SchedTime() {
                return pEventGenerator->schedTimeAtCurrentFragmentStart() + FragmentPos();
            }
        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:
        using RTAVLNode::reset; // make reset() method 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;
        }

        /// This is actually just for code readability.
        inline RTAVLTreeBase* currentSchedulerQueue() const { return rtavlTree(); }
    };

    /**
     * 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.
        bool ignoreAllWaitCalls; ///< If true: calling any built-in wait*() script function should be ignored (this variable may be set with the 2nd argument of built-in script function stop_wait()).
        VMEventHandlerType_t handlerType; ///< Native representation of built-in script variable $NI_CALLBACK_TYPE, reflecting the script event type of this script event.
    };

    /**
     * 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 - 2017 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	#include "../../scriptvm/common.h"
33
34	namespace LinuxSampler {
35
36	// just symbol prototyping
37	class Event;
38	class SchedulerNode;
39	class ScriptEvent;
40	class ScheduledEvent;
41
42	/**
43	* Data type used to schedule events sample point accurately both within, as
44	* well as beyond the scope of the current audio fragment cycle. The timing
45	* reflected by this data type is consecutively running for a very long
46	* time. Even with a sample rate of 96 kHz a scheduler time of this data
47	* type will not wrap before 6 million years. So in practice such time
48	* stamps are unique and will not repeat (unless the EventGenerator is
49	* reset).
50	*/
51	typedef uint64_t sched_time_t;
52
53	/**
54	* Generates Event objects and is responsible for resolving the position
55	* in the current audio fragment each Event actually belongs to.
56	*/
57	class EventGenerator {
58	public:
59	EventGenerator(uint SampleRate);
60	void UpdateFragmentTime(uint SamplesToProcess);
61	Event CreateEvent();
62	Event CreateEvent(int32_t FragmentPos);
63
64	template<typename T>
65	void scheduleAheadMicroSec(RTAVLTree<T>& queue, T& node, int32_t fragmentPosBase, uint64_t microseconds);
66
67	RTList<ScheduledEvent>::Iterator popNextScheduledEvent(RTAVLTree<ScheduledEvent>& queue, Pool<ScheduledEvent>& pool, sched_time_t end);
68	RTList<ScriptEvent>::Iterator popNextScheduledScriptEvent(RTAVLTree<ScriptEvent>& queue, Pool<ScriptEvent>& pool, sched_time_t end);
69
70	/**
71	* Returns the scheduler time for the first sample point of the
72	* current audio fragment cycle.
73	*/
74	sched_time_t schedTimeAtCurrentFragmentStart() const {
75	return uiTotalSamplesProcessed;
76	}
77
78	/**
79	* Returns the scheduler time for the first sample point of the next
80	* audio fragment cycle.
81	*/
82	sched_time_t schedTimeAtCurrentFragmentEnd() const {
83	return uiTotalSamplesProcessed + uiSamplesProcessed;
84	}
85
86	protected:
87	typedef RTMath::time_stamp_t time_stamp_t;
88	inline int32_t ToFragmentPos(time_stamp_t TimeStamp) {
89	return int32_t (int32_t(TimeStamp - FragmentTime.begin) * FragmentTime.sample_ratio);
90	}
91	friend class Event;
92	private:
93	uint uiSampleRate;
94	uint uiSamplesProcessed;
95	struct __FragmentTime__ {
96	time_stamp_t begin; ///< Real time stamp of the beginning of this audio fragment cycle.
97	time_stamp_t end; ///< Real time stamp of the end of this audio fragment cycle.
98	float sample_ratio; ///< (Samples per cycle) / (Real time duration of cycle)
99	} FragmentTime;
100	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).
101	};
102
103	/**
104	* Unique numeric ID of an event which can be used to retrieve access to
105	* the actual @c Event object. Once the event associated with a certain ID
106	* was released (back to its event pool), this numeric ID becomes invalid
107	* and Pool< Event >::fromID() will detect this circumstance and will
108	* return an invalid Iterator, and thus will prevent you from misusing an
109	* event which no longer "exists".
110	*
111	* Note that an @c Event object usually just "exists" for exactly on audio
112	* fragment cycle: that is it exists right from the beginning of the audio
113	* fragment cycle where it was caused (i.e. where its MIDI data was
114	* received by the respective engine channel) and will disappear
115	* automatically at the end of that audio fragment cycle.
116	*/
117	typedef pool_element_id_t event_id_t;
118
119	/**
120	* Unique numeric ID of a note which can be used to retrieve access to the
121	* actual @c Note object. Once the note associated with a certain ID was
122	* released (back to its note pool), this numeric ID becomes invalid and
123	* Pool< Note >::fromID() will detect this circumstance and will return
124	* an invalid Iterator, and thus will prevent you from misusing a note
125	* which no longer is "alive".
126	*
127	* A @c Note object exists right when the respective MIDI note-on event
128	* was received by the respective engine channel, and remains existent
129	* until the caused note and all its voices were finally freed (which might
130	* even be long time after the respective note-off event was received,
131	* depending on the duration of the voice's release stages etc.).
132	*/
133	typedef pool_element_id_t note_id_t;
134
135	/**
136	* Unique numeric ID of a script callback ID instance which can be used to
137	* retrieve access to the actual @c ScriptEvent object. Once the script
138	* callback instance associated with a certain ID stopped its execution
139	* (that is completely stopped, not just suspended) then this numeric ID
140	* becomes invalid and Pool< ScriptEvent >::fromID() will detect this
141	* circumstance and will return an invalid Iterator, and thus will prevent
142	* you from misusing a script callback instance which no longer "exists".
143	*/
144	typedef pool_element_id_t script_callback_id_t;
145
146	/**
147	* Events are usually caused by a MIDI source or an internal modulation
148	* controller like LFO or EG. An event should only be created by an
149	* EventGenerator!
150	*
151	* @see EventGenerator, ScriptEvent
152	*/
153	class Event {
154	public:
155	Event(){}
156	enum type_t {
157	type_note_on, ///< (real) MIDI note-on event
158	type_note_off, ///< (real) MIDI note-off event
159	type_pitchbend, ///< MIDI pitch bend wheel change event
160	type_control_change, ///< MIDI CC event
161	type_sysex, ///< MIDI system exclusive message
162	type_cancel_release_key, ///< transformed either from a (real) MIDI note-on or sustain-pedal-down event
163	type_release_key, ///< transformed either from a (real) MIDI note-off or sustain-pedal-up event
164	type_release_note, ///< transformed from a type_stop_note event
165	type_channel_pressure, ///< a.k.a. aftertouch
166	type_note_pressure, ///< polyphonic key pressure (aftertouch)
167	type_play_note, ///< caused by a call to built-in instrument script function play_note()
168	type_stop_note, ///< caused by a call to built-in instrument script function note_off()
169	type_kill_note, ///< caused by a call to built-in instrument script function fade_out()
170	type_note_synth_param, ///< change a note's synthesis parameters (upon real-time instrument script function calls, i.e. change_vol(), change_tune(), change_pan(), etc.)
171	} Type;
172	enum synth_param_t {
173	synth_param_volume,
174	synth_param_volume_time,
175	synth_param_pitch,
176	synth_param_pitch_time,
177	synth_param_pan,
178	synth_param_cutoff,
179	synth_param_resonance,
180	synth_param_attack,
181	synth_param_decay,
182	synth_param_release,
183	synth_param_amp_lfo_depth,
184	synth_param_amp_lfo_freq,
185	synth_param_pitch_lfo_depth,
186	synth_param_pitch_lfo_freq,
187	};
188	union {
189	/// Note-on and note-off event specifics
190	struct _Note {
191	uint8_t Channel; ///< MIDI channel (0..15)
192	uint8_t Key; ///< MIDI key number of note-on / note-off event.
193	uint8_t Velocity; ///< Trigger or release velocity of note-on / note-off event.
194	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).
195	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).
196	note_id_t ID; ///< Unique numeric ID of the @c Note object associated with this note event.
197	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.
198	void* pRegion; ///< Engine specific pointer to instrument region
199	} Note;
200	/// Control change event specifics
201	struct _CC {
202	uint8_t Channel; ///< MIDI channel (0..15)
203	uint8_t Controller; ///< MIDI controller number of control change event.
204	uint8_t Value; ///< Controller Value of control change event.
205	} CC;
206	/// Pitchbend event specifics
207	struct _Pitch {
208	uint8_t Channel; ///< MIDI channel (0..15)
209	int16_t Pitch; ///< Pitch value of pitchbend event.
210	} Pitch;
211	/// MIDI system exclusive event specifics
212	struct _Sysex {
213	uint Size; ///< Data length (in bytes) of MIDI system exclusive message.
214	} Sysex;
215	/// Channel Pressure (aftertouch) event specifics
216	struct _ChannelPressure {
217	uint8_t Channel; ///< MIDI channel (0..15)
218	uint8_t Controller; ///< Should always be assigned to CTRL_TABLE_IDX_AFTERTOUCH.
219	uint8_t Value; ///< New aftertouch / pressure value for keys on that channel.
220	} ChannelPressure;
221	/// Polyphonic Note Pressure (aftertouch) event specifics
222	struct _NotePressure {
223	uint8_t Channel; ///< MIDI channel (0..15)
224	uint8_t Key; ///< MIDI note number where key pressure (polyphonic aftertouch) changed.
225	uint8_t Value; ///< New pressure value for note.
226	} NotePressure;
227	///< Note synthesis parameter change event's specifics (used for real-time instrument script built-in functions which may alter synthesis parameters on note level).
228	struct _NoteSynthParam {
229	note_id_t NoteID; ///< ID of Note whose voices shall be modified.
230	synth_param_t Type; ///< Synthesis parameter which is to be changed.
231	float Delta; ///< The value change that should be applied against the note's current synthesis parameter value.
232	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).
233	float AbsValue; ///< New current absolute value of synthesis parameter (that is after @c Delta being applied).
234	} NoteSynthParam;
235	} Param;
236	EngineChannel* pEngineChannel; ///< Pointer to the EngineChannel where this event occured on, NULL means Engine global event (e.g. SysEx message).
237	MidiInputPort* pMidiInputPort; ///< Pointer to the MIDI input port on which this event occured (NOTE: currently only for global events, that is SysEx messages)
238
239	inline void Init() {
240	Param.Note.ID = 0;
241	Param.Note.ParentNoteID = 0;
242	Param.NoteSynthParam.NoteID = 0;
243	}
244	inline int32_t FragmentPos() {
245	if (iFragmentPos >= 0) return iFragmentPos;
246	iFragmentPos = pEventGenerator->ToFragmentPos(TimeStamp);
247	if (iFragmentPos < 0) iFragmentPos = 0; // if event arrived shortly before the beginning of current fragment
248	return iFragmentPos;
249	}
250	inline void ResetFragmentPos() {
251	iFragmentPos = -1;
252	}
253	inline void CopyTimeFrom(const Event& other) {
254	TimeStamp = other.TimeStamp;
255	iFragmentPos = other.iFragmentPos;
256	}
257	inline sched_time_t SchedTime() {
258	return pEventGenerator->schedTimeAtCurrentFragmentStart() + FragmentPos();
259	}
260	protected:
261	typedef EventGenerator::time_stamp_t time_stamp_t;
262	Event(EventGenerator* pGenerator, EventGenerator::time_stamp_t Time);
263	Event(EventGenerator* pGenerator, int32_t FragmentPos);
264	friend class EventGenerator;
265	private:
266	EventGenerator* pEventGenerator; ///< Creator of the event.
267	time_stamp_t TimeStamp; ///< Time stamp of the event's occurence.
268	int32_t iFragmentPos; ///< Position in the current fragment this event refers to.
269	};
270
271	/**
272	* Used to sort timing relevant objects (i.e. events) into timing/scheduler
273	* queue. This class is just intended as base class and should be derived
274	* for its actual purpose (for the precise data type being scheduled).
275	*/
276	class SchedulerNode : public RTAVLNode {
277	public:
278	using RTAVLNode::reset; // make reset() method public
279
280	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.
281
282	/// Required operator implementation for RTAVLTree class.
283	inline bool operator==(const SchedulerNode& other) const {
284	return this->scheduleTime == other.scheduleTime;
285	}
286
287	/// Required operator implementation for RTAVLTree class.
288	inline bool operator<(const SchedulerNode& other) const {
289	return this->scheduleTime < other.scheduleTime;
290	}
291
292	/// This is actually just for code readability.
293	inline RTAVLTreeBase* currentSchedulerQueue() const { return rtavlTree(); }
294	};
295
296	/**
297	* Used to sort delayed MIDI events into a timing/scheduler queue. This
298	* object just contains the timing informations, the actual MIDI event is
299	* pointed by member variable @c itEvent.
300	*/
301	class ScheduledEvent : public SchedulerNode {
302	public:
303	Pool<Event>::Iterator itEvent; ///< Points to the actual Event object being scheduled.
304	};
305
306	class VMEventHandler;
307	class VMExecContext;
308
309	/** @brief Real-time instrument script event.
310	*
311	* Encapsulates one execution instance of a real-time instrument script for
312	* exactly one script event handler (script event callback).
313	*
314	* This class derives from SchedulerNode for being able to be sorted efficiently
315	* by the script scheduler if the script was either a) calling the wait()
316	* script function or b) the script was auto suspended by the ScriptVM
317	* because the script was executing for too long. In both cases the
318	* scheduler has to sort the ScriptEvents in its execution queue according
319	* to the precise time the respective script execution instance needs to be
320	* resumed.
321	*/
322	class ScriptEvent : public SchedulerNode {
323	public:
324	Event cause; ///< Copy of original external @c Event that triggered this script event (i.e. MIDI note on event, MIDI CC event, etc.).
325	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.
326	VMEventHandler** handlers; ///< The script's event handlers (callbacks) to be processed (NULL terminated list).
327	VMExecContext* execCtx; ///< Script's current execution state (polyphonic variables and execution stack).
328	int currentHandler; ///< Current index in 'handlers' list above.
329	int executionSlices; ///< Amount of times this script event has been executed by the ScriptVM runner class.
330	bool ignoreAllWaitCalls; ///< If true: calling any built-in wait*() script function should be ignored (this variable may be set with the 2nd argument of built-in script function stop_wait()).
331	VMEventHandlerType_t handlerType; ///< Native representation of built-in script variable $NI_CALLBACK_TYPE, reflecting the script event type of this script event.
332	};
333
334	/**
335	* Insert given @a node into the supplied timing @a queue with a scheduled
336	* timing position given by @a fragmentPosBase and @a microseconds, where
337	* @a microseconds reflects the amount of microseconds in future from "now"
338	* where the node shall be scheduled, and @a fragmentPos identifies the
339	* sample point within the current audio fragment cycle which shall be
340	* interpreted by this method to be "now".
341	*
342	* The meaning of @a fragmentPosBase becomes more important the larger
343	* the audio fragment size, and vice versa it bcomes less important the
344	* smaller the audio fragment size.
345	*
346	* @param queue - destination scheduler queue
347	* @param node - node (i.e. event) to be inserted into the queue
348	* @param fragmentPosBase - sample point in current audio fragment to be "now"
349	* @param microseconds - timing of node from "now" (in microseconds)
350	*/
351	template<typename T>
352	void EventGenerator::scheduleAheadMicroSec(RTAVLTree<T>& queue, T& node, int32_t fragmentPosBase, uint64_t microseconds) {
353	node.scheduleTime = uiTotalSamplesProcessed + fragmentPosBase + float(uiSampleRate) * (float(microseconds) / 1000000.f);
354	queue.insert(node);
355	}
356
357	} // namespace LinuxSampler
358
359	#endif // __LS_EVENT_H__