| 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) 2013-2014 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 |
|
| 35 |
#define CTRL_TABLE_IDX_AFTERTOUCH 128 |
| 36 |
#define CTRL_TABLE_IDX_PITCHBEND 129 |
| 37 |
|
| 38 |
namespace LinuxSampler { |
| 39 |
|
| 40 |
class AbstractEngineChannel: public EngineChannel, public AbstractEngine::ScriptConsumer { |
| 41 |
public: |
| 42 |
// implementation of abstract methods derived from interface class 'LinuxSampler::EngineChannel' |
| 43 |
virtual void PrepareLoadInstrument(const char* FileName, uint Instrument) OVERRIDE; |
| 44 |
virtual void Reset() OVERRIDE; |
| 45 |
virtual void SendNoteOn(uint8_t Key, uint8_t Velocity, uint8_t MidiChannel) OVERRIDE; |
| 46 |
virtual void SendNoteOn(uint8_t Key, uint8_t Velocity, uint8_t MidiChannel, int32_t FragmentPos) OVERRIDE; |
| 47 |
virtual void SendNoteOff(uint8_t Key, uint8_t Velocity, uint8_t MidiChannel) OVERRIDE; |
| 48 |
virtual void SendNoteOff(uint8_t Key, uint8_t Velocity, uint8_t MidiChannel, int32_t FragmentPos) OVERRIDE; |
| 49 |
virtual void SendPitchbend(int Pitch, uint8_t MidiChannel) OVERRIDE; |
| 50 |
virtual void SendPitchbend(int Pitch, uint8_t MidiChannel, int32_t FragmentPos) OVERRIDE; |
| 51 |
virtual void SendControlChange(uint8_t Controller, uint8_t Value, uint8_t MidiChannel) OVERRIDE; |
| 52 |
virtual void SendControlChange(uint8_t Controller, uint8_t Value, uint8_t MidiChannel, int32_t FragmentPos) OVERRIDE; |
| 53 |
virtual void SendChannelPressure(uint8_t Value, uint8_t MidiChannel) OVERRIDE; |
| 54 |
virtual void SendChannelPressure(uint8_t Value, uint8_t MidiChannel, int32_t FragmentPos) OVERRIDE; |
| 55 |
virtual void SendPolyphonicKeyPressure(uint8_t Key, uint8_t Value, uint8_t MidiChannel) OVERRIDE; |
| 56 |
virtual void SendPolyphonicKeyPressure(uint8_t Key, uint8_t Value, uint8_t MidiChannel, int32_t FragmentPos) OVERRIDE; |
| 57 |
virtual bool StatusChanged(bool bNewStatus = false) OVERRIDE; |
| 58 |
virtual float Volume() OVERRIDE; |
| 59 |
virtual void Volume(float f) OVERRIDE; |
| 60 |
virtual float Pan() OVERRIDE; |
| 61 |
virtual void Pan(float f) OVERRIDE; |
| 62 |
virtual uint Channels() OVERRIDE; |
| 63 |
virtual AudioOutputDevice* GetAudioOutputDevice() OVERRIDE; |
| 64 |
virtual void SetOutputChannel(uint EngineAudioChannel, uint AudioDeviceChannel) OVERRIDE; |
| 65 |
virtual int OutputChannel(uint EngineAudioChannel) OVERRIDE; |
| 66 |
virtual void Connect(MidiInputPort* pMidiPort) OVERRIDE; |
| 67 |
virtual void Disconnect(MidiInputPort* pMidiPort) OVERRIDE; |
| 68 |
virtual void DisconnectAllMidiInputPorts() OVERRIDE; |
| 69 |
virtual uint GetMidiInputPortCount() OVERRIDE; |
| 70 |
virtual MidiInputPort* GetMidiInputPort(uint index) OVERRIDE; |
| 71 |
virtual midi_chan_t MidiChannel() OVERRIDE; |
| 72 |
virtual void SetMidiChannel(midi_chan_t MidiChannel) OVERRIDE; |
| 73 |
virtual void Connect(MidiInputPort* pMidiPort, midi_chan_t MidiChannel) OVERRIDE; // deprecated, may be removed |
| 74 |
virtual void DisconnectMidiInputPort() OVERRIDE; // deprecated, may be removed |
| 75 |
virtual MidiInputPort* GetMidiInputPort() OVERRIDE; // deprecated, may be removed |
| 76 |
virtual String InstrumentFileName() OVERRIDE; |
| 77 |
virtual String InstrumentName() OVERRIDE; |
| 78 |
virtual int InstrumentIndex() OVERRIDE; |
| 79 |
virtual int InstrumentStatus() OVERRIDE; |
| 80 |
virtual Engine* GetEngine() OVERRIDE; |
| 81 |
virtual String EngineName() OVERRIDE; |
| 82 |
virtual FxSend* AddFxSend(uint8_t MidiCtrl, String Name = "") throw (Exception) OVERRIDE; |
| 83 |
virtual FxSend* GetFxSend(uint FxSendIndex) OVERRIDE; |
| 84 |
virtual uint GetFxSendCount() OVERRIDE; |
| 85 |
virtual void RemoveFxSend(FxSend* pFxSend) OVERRIDE; |
| 86 |
virtual void Connect(VirtualMidiDevice* pDevice) OVERRIDE; |
| 87 |
virtual void Disconnect(VirtualMidiDevice* pDevice) OVERRIDE; |
| 88 |
|
| 89 |
// implementation of abstract methods derived from AbstractEngine::ScriptConsumer |
| 90 |
virtual void ResourceToBeUpdated(VMParserContext* pResource, void*& pUpdateArg) OVERRIDE {} |
| 91 |
virtual void ResourceUpdated(VMParserContext* pOldResource, VMParserContext* pNewResource, void* pUpdateArg) OVERRIDE {} |
| 92 |
virtual void OnResourceProgress(float fProgress) OVERRIDE {} |
| 93 |
|
| 94 |
virtual AbstractEngine::Format GetEngineFormat() = 0; |
| 95 |
|
| 96 |
AudioOutputDevice* GetAudioOutputDeviceSafe(); |
| 97 |
void loadInstrumentScript(const String& text); |
| 98 |
void unloadCurrentInstrumentScript(); |
| 99 |
|
| 100 |
friend class AbstractVoice; |
| 101 |
friend class AbstractEngine; |
| 102 |
template<class TV, class TRR, class TR, class TD, class TIM, class TI> friend class EngineBase; |
| 103 |
template<class EC, class R, class S, class D> friend class VoiceBase; |
| 104 |
|
| 105 |
//protected: |
| 106 |
AbstractEngineChannel(); |
| 107 |
virtual ~AbstractEngineChannel(); |
| 108 |
|
| 109 |
AbstractEngine* pEngine; |
| 110 |
Mutex EngineMutex; ///< protects the Engine from access by the instrument loader thread when lscp is disconnecting |
| 111 |
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. |
| 112 |
|
| 113 |
//protected: |
| 114 |
AudioChannel* pChannelLeft; ///< encapsulates the audio rendering buffer (left) |
| 115 |
AudioChannel* pChannelRight; ///< encapsulates the audio rendering buffer (right) |
| 116 |
int AudioDeviceChannelLeft; ///< audio device channel number to which the left channel is connected to |
| 117 |
int AudioDeviceChannelRight; ///< audio device channel number to which the right channel is connected to |
| 118 |
DoubleBuffer< ArrayList<MidiInputPort*> > midiInputs; ///< MIDI input ports on which this sampler engine channel shall listen to. |
| 119 |
midi_chan_t midiChannel; ///< MIDI channel(s) on which this engine channel listens to (on all MIDI input ports). |
| 120 |
RingBuffer<Event,false>* pEventQueue; ///< Input event queue. |
| 121 |
RTList<Event>* pEvents; ///< All engine channel specific events for the current audio fragment. |
| 122 |
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. |
| 123 |
String InstrumentFile; |
| 124 |
int InstrumentIdx; |
| 125 |
String InstrumentIdxName; |
| 126 |
int InstrumentStat; |
| 127 |
double GlobalVolume; ///< Master volume factor set through the C++ API / LSCP (a value < 1.0 means attenuation, a value > 1.0 means amplification) |
| 128 |
double MidiVolume; ///< Volume factor altered by MIDI CC#7 (a value < 1.0 means attenuation, a value > 1.0 means amplification) |
| 129 |
int Pitch; ///< Current (absolute) MIDI pitch value. |
| 130 |
float CurrentKeyDimension; ///< Current value (0-1.0) for the keyboard dimension, altered by pressing a keyswitching key. |
| 131 |
bool PortamentoMode; ///< in Portamento Mode we slide the pitch from the last note to the current note. |
| 132 |
float PortamentoTime; ///< How long it will take to glide from the previous note to the current (in seconds) |
| 133 |
float PortamentoPos; ///< Current position on the keyboard, that is integer and fractional part (only used if PortamentoMode is on) |
| 134 |
std::vector<FxSend*> fxSends; |
| 135 |
int GlobalTranspose; ///< amount of semi tones all notes should be transposed |
| 136 |
int iLastPanRequest; ///< just for the return value of Pan(), so we don't have to make an injective function |
| 137 |
int iEngineIndexSelf; ///< Reflects the index of this EngineChannel in the Engine's ArrayList. |
| 138 |
bool bStatusChanged; ///< true in case an engine parameter has changed (e.g. new instrument, another volumet) |
| 139 |
uint32_t RoundRobinIndex; ///< counter for round robin sample selection, incremented for each note on |
| 140 |
Pool<ScriptEvent>* pScriptEvents; ///< 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. |
| 141 |
struct _Script { |
| 142 |
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! |
| 143 |
bool bHasValidScript; ///< True in case there is a valid script currently loaded, false if script processing shall be skipped. |
| 144 |
VMEventHandler* handlerInit; ///< VM representation of script's initilization callback or NULL if current script did not define such an init handler. |
| 145 |
VMEventHandler* handlerNote; ///< VM representation of script's MIDI note callback or NULL if current script did not define such an event handler. |
| 146 |
VMEventHandler* handlerController; ///< VM representation of script's MIDI controller callback or NULL if current script did not define such an event handler. |
| 147 |
_Script() { |
| 148 |
parserContext = NULL; |
| 149 |
bHasValidScript = false; |
| 150 |
handlerNote = handlerController = NULL; |
| 151 |
} |
| 152 |
} script; |
| 153 |
|
| 154 |
SynchronizedConfig< ArrayList<VirtualMidiDevice*> > virtualMidiDevices; |
| 155 |
SynchronizedConfig< ArrayList<VirtualMidiDevice*> >::Reader virtualMidiDevicesReader_AudioThread; |
| 156 |
SynchronizedConfig< ArrayList<VirtualMidiDevice*> >::Reader virtualMidiDevicesReader_MidiThread; |
| 157 |
|
| 158 |
// specialization of RTList that doesn't require the pool |
| 159 |
// to be provided at construction time |
| 160 |
template<typename T> |
| 161 |
class LazyList : public RTList<T> { |
| 162 |
public: |
| 163 |
using RTList<T>::allocAppend; |
| 164 |
using RTList<T>::pPool; |
| 165 |
|
| 166 |
LazyList() : RTList<T>(0) { } |
| 167 |
typename RTList<T>::Iterator allocAppend(Pool<T>* pool) { |
| 168 |
pPool = pool; |
| 169 |
return allocAppend(); |
| 170 |
} |
| 171 |
}; |
| 172 |
|
| 173 |
typedef std::map<uint, LazyList<Event>*> ActiveKeyGroupMap; |
| 174 |
ActiveKeyGroupMap ActiveKeyGroups; ///< Contains event queues for key groups, ordered by key group ID. |
| 175 |
|
| 176 |
virtual void ResetControllers(); |
| 177 |
virtual void ResetInternal(); |
| 178 |
virtual void RemoveAllFxSends(); |
| 179 |
|
| 180 |
void ImportEvents(uint Samples); |
| 181 |
|
| 182 |
void AddGroup(uint group); |
| 183 |
void HandleKeyGroupConflicts(uint KeyGroup, Pool<Event>::Iterator& itNoteOnEvent); |
| 184 |
void ClearGroupEventLists(); |
| 185 |
void DeleteGroupEventLists(); |
| 186 |
|
| 187 |
private: |
| 188 |
/** |
| 189 |
* Returns @c true if there are 2 ore more MidiInputPorts connected |
| 190 |
* to this engine channel. |
| 191 |
* |
| 192 |
* This method is currently only used to prevent unnecessary |
| 193 |
* MidiInputMutex.Lock() if there is not more than 1 MIDI input on |
| 194 |
* this engine channel. |
| 195 |
*/ |
| 196 |
inline bool hasMultipleMIDIInputs() const { |
| 197 |
//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 |
| 198 |
return midiInputs.unsafeBack().size() > 1; |
| 199 |
} |
| 200 |
}; |
| 201 |
|
| 202 |
} // namespace LinuxSampler |
| 203 |
|
| 204 |
#endif /* __LS_ABSTRACTENGINECHANNEL_H__ */ |
| 205 |
|
Parent Directory
| 
Revision Log