3 |
* LinuxSampler - modular, streaming capable sampler * |
* LinuxSampler - modular, streaming capable sampler * |
4 |
* * |
* * |
5 |
* Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck * |
* Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck * |
6 |
* Copyright (C) 2005 - 2012 Christian Schoenebeck * |
* Copyright (C) 2005 - 2014 Christian Schoenebeck * |
7 |
* * |
* * |
8 |
* This program is free software; you can redistribute it and/or modify * |
* 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 * |
* it under the terms of the GNU General Public License as published by * |
64 |
* controller like LFO or EG. An event should only be created by an |
* controller like LFO or EG. An event should only be created by an |
65 |
* EventGenerator! |
* EventGenerator! |
66 |
* |
* |
67 |
* @see EventGenerator |
* @see EventGenerator, ScriptEvent |
68 |
*/ |
*/ |
69 |
class Event { |
class Event { |
70 |
public: |
public: |
76 |
type_control_change, |
type_control_change, |
77 |
type_sysex, ///< MIDI system exclusive message |
type_sysex, ///< MIDI system exclusive message |
78 |
type_cancel_release, ///< transformed either from a note-on or sustain-pedal-down event |
type_cancel_release, ///< transformed either from a note-on or sustain-pedal-down event |
79 |
type_release ///< transformed either from a note-off or sustain-pedal-up event |
type_release, ///< transformed either from a note-off or sustain-pedal-up event |
80 |
|
type_channel_pressure, ///< a.k.a. aftertouch |
81 |
|
type_note_pressure, ///< polyphonic key pressure (aftertouch) |
82 |
} Type; |
} Type; |
83 |
union { |
union { |
84 |
/// Note-on and note-off event specifics |
/// Note-on and note-off event specifics |
85 |
struct _Note { |
struct _Note { |
86 |
|
uint8_t Channel; ///< MIDI channel (0..15) |
87 |
uint8_t Key; ///< MIDI key number of note-on / note-off event. |
uint8_t Key; ///< MIDI key number of note-on / note-off event. |
88 |
uint8_t Velocity; ///< Trigger or release velocity of note-on / note-off event. |
uint8_t Velocity; ///< Trigger or release velocity of note-on / note-off event. |
|
uint8_t Channel; ///< MIDI channel (0..15) |
|
89 |
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 Layer; ///< Layer index (usually only used if a note-on event has to be postponed, e.g. due to shortage of free voices). |
90 |
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). |
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). |
91 |
void* pRegion; ///< Engine specific pointer to instrument region |
void* pRegion; ///< Engine specific pointer to instrument region |
92 |
} Note; |
} Note; |
93 |
/// Control change event specifics |
/// Control change event specifics |
94 |
struct _CC { |
struct _CC { |
95 |
|
uint8_t Channel; ///< MIDI channel (0..15) |
96 |
uint8_t Controller; ///< MIDI controller number of control change event. |
uint8_t Controller; ///< MIDI controller number of control change event. |
97 |
uint8_t Value; ///< Controller Value of control change event. |
uint8_t Value; ///< Controller Value of control change event. |
|
uint8_t Channel; ///< MIDI channel (0..15) |
|
98 |
} CC; |
} CC; |
99 |
/// Pitchbend event specifics |
/// Pitchbend event specifics |
100 |
struct _Pitch { |
struct _Pitch { |
|
int16_t Pitch; ///< Pitch value of pitchbend event. |
|
101 |
uint8_t Channel; ///< MIDI channel (0..15) |
uint8_t Channel; ///< MIDI channel (0..15) |
102 |
|
int16_t Pitch; ///< Pitch value of pitchbend event. |
103 |
} Pitch; |
} Pitch; |
104 |
/// MIDI system exclusive event specifics |
/// MIDI system exclusive event specifics |
105 |
struct _Sysex { |
struct _Sysex { |
106 |
uint Size; ///< Data length (in bytes) of MIDI system exclusive message. |
uint Size; ///< Data length (in bytes) of MIDI system exclusive message. |
107 |
} Sysex; |
} Sysex; |
108 |
|
/// Channel Pressure (aftertouch) event specifics |
109 |
|
struct _ChannelPressure { |
110 |
|
uint8_t Channel; ///< MIDI channel (0..15) |
111 |
|
uint8_t Value; ///< New aftertouch / pressure value for keys on that channel. |
112 |
|
} ChannelPressure; |
113 |
|
/// Polyphonic Note Pressure (aftertouch) event specifics |
114 |
|
struct _NotePressure { |
115 |
|
uint8_t Channel; ///< MIDI channel (0..15) |
116 |
|
uint8_t Key; ///< MIDI note number where key pressure (polyphonic aftertouch) changed. |
117 |
|
uint8_t Value; ///< New pressure value for note. |
118 |
|
} NotePressure; |
119 |
} Param; |
} Param; |
120 |
|
/// Sampler format specific informations and variables. |
121 |
|
union { |
122 |
|
/// Gigasampler/GigaStudio format specifics. |
123 |
|
struct _Gig { |
124 |
|
uint8_t DimMask; ///< May be used to override the Dimension zone to be selected for a new voice: each 1 bit means that respective bit shall be overridden by taking the respective bit from DimBits instead. |
125 |
|
uint8_t DimBits; ///< Used only in conjunction with DimMask: Dimension bits that shall be selected. |
126 |
|
} Gig; |
127 |
|
} Format; |
128 |
EngineChannel* pEngineChannel; ///< Pointer to the EngineChannel where this event occured on, NULL means Engine global event (e.g. SysEx message). |
EngineChannel* pEngineChannel; ///< Pointer to the EngineChannel where this event occured on, NULL means Engine global event (e.g. SysEx message). |
129 |
MidiInputPort* pMidiInputPort; ///< Pointer to the MIDI input port on which this event occured (NOTE: currently only for global events, that is SysEx messages) |
MidiInputPort* pMidiInputPort; ///< Pointer to the MIDI input port on which this event occured (NOTE: currently only for global events, that is SysEx messages) |
130 |
|
|
148 |
int32_t iFragmentPos; ///< Position in the current fragment this event refers to. |
int32_t iFragmentPos; ///< Position in the current fragment this event refers to. |
149 |
}; |
}; |
150 |
|
|
151 |
|
class VMEventHandler; |
152 |
|
class VMExecContext; |
153 |
|
|
154 |
|
/** @brief Real-time instrument script event. |
155 |
|
* |
156 |
|
* Encapsulates one execution instance of a real-time instrument script for |
157 |
|
* exactly one script event handler (script event callback). |
158 |
|
*/ |
159 |
|
class ScriptEvent { |
160 |
|
public: |
161 |
|
Event cause; ///< Original external event that triggered this script event (i.e. MIDI note on event, MIDI CC event, etc.). |
162 |
|
int id; ///< Unique ID of the external event that triggered this cript event. |
163 |
|
VMEventHandler** handlers; ///< The script's event handlers (callbacks) to be processed (NULL terminated list). |
164 |
|
VMExecContext* execCtx; ///< Script's current execution state (polyphonic variables and execution stack). |
165 |
|
int currentHandler; ///< Current index in 'handlers' list above. |
166 |
|
int executionSlices; ///< Amount of times this script event has been executed by the ScriptVM runner class. |
167 |
|
}; |
168 |
|
|
169 |
} // namespace LinuxSampler |
} // namespace LinuxSampler |
170 |
|
|
171 |
#endif // __LS_EVENT_H__ |
#endif // __LS_EVENT_H__ |