/[svn]/linuxsampler/trunk/src/engines/AbstractEngineChannel.h
ViewVC logotype

Contents of /linuxsampler/trunk/src/engines/AbstractEngineChannel.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2948 - (show annotations) (download) (as text)
Fri Jul 15 15:29:04 2016 UTC (7 years, 9 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 15428 byte(s)
* NKSP: Implemented built-in script function "stop_wait()".
* NKSP: Implemented built-in script variable "$NI_CALLBACK_ID".
* NKSP: Implemented built-in script variable "$NI_CALLBACK_TYPE".
* NKSP: Implemented built-in script variable "$NKSP_IGNORE_WAIT".
* NKSP: Added support for read-only built-in variables
  (respectively handled by the script parser).
* NKSP: Added built-in script constant "$NI_CB_TYPE_INIT".
* NKSP: Added built-in script constant "$NI_CB_TYPE_NOTE".
* NKSP: Added built-in script constant "$NI_CB_TYPE_RELEASE".
* NKSP: Added built-in script constant "$NI_CB_TYPE_CONTROLLER".
* Bumped version (2.0.0.svn17).

1 /***************************************************************************
2 * *
3 * LinuxSampler - modular, streaming capable sampler *
4 * *
5 * Copyright (C) 2003,2004 by Benno Senoner and Christian Schoenebeck *
6 * Copyright (C) 2005-2008 Christian Schoenebeck *
7 * Copyright (C) 2009-2012 Christian Schoenebeck and Grigor Iliev *
8 * Copyright (C) 2012-2016 Christian Schoenebeck and Andreas Persson *
9 * *
10 * This program is free software; you can redistribute it and/or modify *
11 * it under the terms of the GNU General Public License as published by *
12 * the Free Software Foundation; either version 2 of the License, or *
13 * (at your option) any later version. *
14 * *
15 * This program is distributed in the hope that it will be useful, *
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
18 * GNU General Public License for more details. *
19 * *
20 * You should have received a copy of the GNU General Public License *
21 * along with this program; if not, write to the Free Software *
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
23 * MA 02111-1307 USA *
24 ***************************************************************************/
25
26 #ifndef __LS_ABSTRACTENGINECHANNEL_H__
27 #define __LS_ABSTRACTENGINECHANNEL_H__
28
29 #include "EngineChannel.h"
30 #include "AbstractEngine.h"
31
32 #include "../common/Pool.h"
33 #include "../common/RingBuffer.h"
34 #include "../common/ResourceManager.h"
35 #include "common/AbstractInstrumentManager.h"
36 #include "common/InstrumentScriptVM.h"
37
38 #define CTRL_TABLE_IDX_AFTERTOUCH 128
39 #define CTRL_TABLE_IDX_PITCHBEND 129
40
41 namespace LinuxSampler {
42
43 class MidiKeyboardManagerBase;
44
45 class AbstractEngineChannel: public EngineChannel, public InstrumentScriptConsumer {
46 public:
47 // implementation of abstract methods derived from interface class 'LinuxSampler::EngineChannel'
48 virtual void PrepareLoadInstrument(const char* FileName, uint Instrument) OVERRIDE;
49 virtual void Reset() OVERRIDE;
50 virtual void SendNoteOn(uint8_t Key, uint8_t Velocity, uint8_t MidiChannel) OVERRIDE;
51 virtual void SendNoteOn(uint8_t Key, uint8_t Velocity, uint8_t MidiChannel, int32_t FragmentPos) OVERRIDE;
52 virtual void SendNoteOff(uint8_t Key, uint8_t Velocity, uint8_t MidiChannel) OVERRIDE;
53 virtual void SendNoteOff(uint8_t Key, uint8_t Velocity, uint8_t MidiChannel, int32_t FragmentPos) OVERRIDE;
54 virtual void SendPitchbend(int Pitch, uint8_t MidiChannel) OVERRIDE;
55 virtual void SendPitchbend(int Pitch, uint8_t MidiChannel, int32_t FragmentPos) OVERRIDE;
56 virtual void SendControlChange(uint8_t Controller, uint8_t Value, uint8_t MidiChannel) OVERRIDE;
57 virtual void SendControlChange(uint8_t Controller, uint8_t Value, uint8_t MidiChannel, int32_t FragmentPos) OVERRIDE;
58 virtual void SendChannelPressure(uint8_t Value, uint8_t MidiChannel) OVERRIDE;
59 virtual void SendChannelPressure(uint8_t Value, uint8_t MidiChannel, int32_t FragmentPos) OVERRIDE;
60 virtual void SendPolyphonicKeyPressure(uint8_t Key, uint8_t Value, uint8_t MidiChannel) OVERRIDE;
61 virtual void SendPolyphonicKeyPressure(uint8_t Key, uint8_t Value, uint8_t MidiChannel, int32_t FragmentPos) OVERRIDE;
62 virtual bool StatusChanged(bool bNewStatus = false) OVERRIDE;
63 virtual float Volume() OVERRIDE;
64 virtual void Volume(float f) OVERRIDE;
65 virtual float Pan() OVERRIDE;
66 virtual void Pan(float f) OVERRIDE;
67 virtual uint Channels() OVERRIDE;
68 virtual AudioOutputDevice* GetAudioOutputDevice() OVERRIDE;
69 virtual void SetOutputChannel(uint EngineAudioChannel, uint AudioDeviceChannel) OVERRIDE;
70 virtual int OutputChannel(uint EngineAudioChannel) OVERRIDE;
71 virtual void Connect(MidiInputPort* pMidiPort) OVERRIDE;
72 virtual void Disconnect(MidiInputPort* pMidiPort) OVERRIDE;
73 virtual void DisconnectAllMidiInputPorts() OVERRIDE;
74 virtual uint GetMidiInputPortCount() OVERRIDE;
75 virtual MidiInputPort* GetMidiInputPort(uint index) OVERRIDE;
76 virtual midi_chan_t MidiChannel() OVERRIDE;
77 virtual void SetMidiChannel(midi_chan_t MidiChannel) OVERRIDE;
78 virtual void Connect(MidiInputPort* pMidiPort, midi_chan_t MidiChannel) OVERRIDE; // deprecated, may be removed
79 virtual void DisconnectMidiInputPort() OVERRIDE; // deprecated, may be removed
80 virtual MidiInputPort* GetMidiInputPort() OVERRIDE; // deprecated, may be removed
81 virtual String InstrumentFileName() OVERRIDE;
82 virtual String InstrumentName() OVERRIDE;
83 virtual int InstrumentIndex() OVERRIDE;
84 virtual int InstrumentStatus() OVERRIDE;
85 virtual Engine* GetEngine() OVERRIDE;
86 virtual String EngineName() OVERRIDE;
87 virtual FxSend* AddFxSend(uint8_t MidiCtrl, String Name = "") throw (Exception) OVERRIDE;
88 virtual FxSend* GetFxSend(uint FxSendIndex) OVERRIDE;
89 virtual uint GetFxSendCount() OVERRIDE;
90 virtual void RemoveFxSend(FxSend* pFxSend) OVERRIDE;
91 virtual void Connect(VirtualMidiDevice* pDevice) OVERRIDE;
92 virtual void Disconnect(VirtualMidiDevice* pDevice) OVERRIDE;
93
94 // implementation of abstract methods derived from AbstractEngine::ScriptConsumer
95 virtual void ResourceToBeUpdated(VMParserContext* pResource, void*& pUpdateArg) OVERRIDE {}
96 virtual void ResourceUpdated(VMParserContext* pOldResource, VMParserContext* pNewResource, void* pUpdateArg) OVERRIDE {}
97 virtual void OnResourceProgress(float fProgress) OVERRIDE {}
98
99 virtual AbstractEngine::Format GetEngineFormat() = 0;
100 virtual MidiKeyboardManagerBase* GetMidiKeyboardManager() = 0;
101
102 AudioOutputDevice* GetAudioOutputDeviceSafe();
103
104 script_callback_id_t GetScriptCallbackID(const ScriptEvent* e) const {
105 return pScript->pEvents->getID(e);
106 }
107
108 RTList<ScriptEvent>::Iterator ScriptCallbackByID(script_callback_id_t id) const {
109 return pScript->pEvents->fromID(id);
110 }
111
112 void ScheduleResumeOfScriptCallback(RTList<ScriptEvent>::Iterator& itCallback, sched_time_t now, bool forever);
113
114 friend class AbstractVoice;
115 friend class AbstractEngine;
116 template<class TV, class TRR, class TR, class TD, class TIM, class TI> friend class EngineBase;
117 template<class EC, class R, class S, class D> friend class VoiceBase;
118
119 //protected:
120 AbstractEngineChannel();
121 virtual ~AbstractEngineChannel();
122
123 AbstractEngine* pEngine;
124 Mutex EngineMutex; ///< protects the Engine from access by the instrument loader thread when lscp is disconnecting
125 Mutex MidiInputMutex; ///< Introduced when support for multiple MIDI inputs per engine channel was added: protects the MIDI event input ringbuffer on this engine channel to be accessed concurrently by multiple midi input threads. As alternative one might also move the ringbuffer from this engine channel to the individual MIDI ports/devices and let the sampler engine read the events from there instead of receiving them here.
126
127 //protected:
128 AudioChannel* pChannelLeft; ///< encapsulates the audio rendering buffer (left)
129 AudioChannel* pChannelRight; ///< encapsulates the audio rendering buffer (right)
130 int AudioDeviceChannelLeft; ///< audio device channel number to which the left channel is connected to
131 int AudioDeviceChannelRight; ///< audio device channel number to which the right channel is connected to
132 DoubleBuffer< ArrayList<MidiInputPort*> > midiInputs; ///< MIDI input ports on which this sampler engine channel shall listen to.
133 midi_chan_t midiChannel; ///< MIDI channel(s) on which this engine channel listens to (on all MIDI input ports).
134 RingBuffer<Event,false>* pEventQueue; ///< Input event queue.
135 RTList<Event>* pEvents; ///< All engine channel specific events for the current audio fragment.
136 struct _DelayedEvents {
137 RTList<Event>* pList; ///< Unsorted list where all delayed events are moved to and remain here until they're finally processed.
138 Pool<ScheduledEvent> schedulerNodes; ///< Nodes used to sort the delayed events (stored on pList) with time sorted queue.
139 RTAVLTree<ScheduledEvent> queue; ///< Used to access the delayed events (from pList) in time sorted manner.
140
141 _DelayedEvents() : pList(NULL), schedulerNodes(CONFIG_MAX_EVENTS_PER_FRAGMENT) {}
142
143 inline void clear() {
144 if (pList) pList->clear();
145 schedulerNodes.clear();
146 queue.clear();
147 }
148 } delayedEvents;
149 uint8_t ControllerTable[130]; ///< Reflects the current values (0-127) of all MIDI controllers for this engine / sampler channel. Number 128 is for channel pressure (mono aftertouch), 129 for pitch bend.
150 String InstrumentFile;
151 int InstrumentIdx;
152 String InstrumentIdxName;
153 int InstrumentStat;
154 double GlobalVolume; ///< Master volume factor set through the C++ API / LSCP (a value < 1.0 means attenuation, a value > 1.0 means amplification)
155 double MidiVolume; ///< Volume factor altered by MIDI CC#7 (a value < 1.0 means attenuation, a value > 1.0 means amplification)
156 int Pitch; ///< Current (absolute) MIDI pitch value.
157 float CurrentKeyDimension; ///< Current value (0-1.0) for the keyboard dimension, altered by pressing a keyswitching key.
158 bool PortamentoMode; ///< in Portamento Mode we slide the pitch from the last note to the current note.
159 float PortamentoTime; ///< How long it will take to glide from the previous note to the current (in seconds)
160 float PortamentoPos; ///< Current position on the keyboard, that is integer and fractional part (only used if PortamentoMode is on)
161 std::vector<FxSend*> fxSends;
162 int GlobalTranspose; ///< amount of semi tones all notes should be transposed
163 int iLastPanRequest; ///< just for the return value of Pan(), so we don't have to make an injective function
164 int iEngineIndexSelf; ///< Reflects the index of this EngineChannel in the Engine's ArrayList.
165 bool bStatusChanged; ///< true in case an engine parameter has changed (e.g. new instrument, another volumet)
166 uint32_t RoundRobinIndex; ///< counter for round robin sample selection, incremented for each note on
167 InstrumentScript* pScript; ///< Points to the real-time instrument script(s) to be executed, NULL if current instrument does not have an instrument script. Even though the underlying VM representation of the script is shared among multiple sampler channels, the InstrumentScript object here is not shared though, it exists for each sampler channel separately.
168
169 SynchronizedConfig< ArrayList<VirtualMidiDevice*> > virtualMidiDevices;
170 SynchronizedConfig< ArrayList<VirtualMidiDevice*> >::Reader virtualMidiDevicesReader_AudioThread;
171 SynchronizedConfig< ArrayList<VirtualMidiDevice*> >::Reader virtualMidiDevicesReader_MidiThread;
172
173 // specialization of RTList that doesn't require the pool
174 // to be provided at construction time
175 template<typename T>
176 class LazyList : public RTList<T> {
177 public:
178 using RTList<T>::allocAppend;
179 using RTList<T>::pPool;
180
181 LazyList() : RTList<T>(0) { }
182 typename RTList<T>::Iterator allocAppend(Pool<T>* pool) {
183 pPool = pool;
184 return allocAppend();
185 }
186 };
187
188 typedef std::map<uint, LazyList<Event>*> ActiveKeyGroupMap;
189 ActiveKeyGroupMap ActiveKeyGroups; ///< Contains event queues for key groups, ordered by key group ID.
190
191 virtual void ResetControllers();
192 virtual void ResetInternal(bool bResetEngine);
193 virtual void RemoveAllFxSends();
194
195 void ImportEvents(uint Samples);
196 virtual note_id_t ScheduleNoteMicroSec(const Event* pEvent, int delay) = 0;
197 event_id_t ScheduleEventMicroSec(const Event* pEvent, int delay);
198 void IgnoreEvent(event_id_t id);
199 virtual void IgnoreNote(note_id_t id) = 0;
200 void IgnoreEventByScriptID(const ScriptID& id);
201
202 void AddGroup(uint group);
203 void HandleKeyGroupConflicts(uint KeyGroup, Pool<Event>::Iterator& itNoteOnEvent);
204 void ClearGroupEventLists();
205 void DeleteGroupEventLists();
206
207 private:
208 /**
209 * Returns @c true if there are 2 ore more MidiInputPorts connected
210 * to this engine channel.
211 *
212 * This method is currently only used to prevent unnecessary
213 * MidiInputMutex.Lock() if there is not more than 1 MIDI input on
214 * this engine channel.
215 */
216 inline bool hasMultipleMIDIInputs() const {
217 //FIXME: leaves tiny time frames open (shortly after 1->2 devices connected or 2->1 disconnected) which could lead to concurrency issue for the purpose described above, however in practice it "should" be acceptable
218 return midiInputs.unsafeBack().size() > 1;
219 }
220
221 inline bool applyTranspose(Event* event);
222 };
223
224 } // namespace LinuxSampler
225
226 #endif /* __LS_ABSTRACTENGINECHANNEL_H__ */
227

  ViewVC Help
Powered by ViewVC