engines/gig/EngineChannel.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
 *   Copyright (C) 2005 - 2008 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_GIG_ENGINECHANNEL_H__
#define __LS_GIG_ENGINECHANNEL_H__

#include "../common/Event.h"
#include "../EngineChannel.h"
#include "../../common/RingBuffer.h"
#include "../../common/ArrayList.h"
#include "../../drivers/audio/AudioChannel.h"
#include "../../drivers/midi/VirtualMidiDevice.h"
#include "EngineGlobals.h"
#include "Engine.h"
#include "Voice.h"
#include "InstrumentResourceManager.h"

namespace LinuxSampler { namespace gig {

    // just symbol prototyping
    class midi_key_info_t;
    class Voice;

    /** @brief Engine Channel of a gig::Engine
     *
     * Encapsulates a engine channel for the Gigasampler format capable
     * sampler engine.
     */
    class EngineChannel : public LinuxSampler::EngineChannel, public InstrumentConsumer {
        public:
            EngineChannel();
            virtual ~EngineChannel();

            // implementation of abstract methods derived from interface class 'LinuxSampler::EngineChannel'
            virtual void    PrepareLoadInstrument(const char* FileName, uint Instrument);
            virtual void    LoadInstrument();
            virtual void    Reset();
            virtual void    SendNoteOn(uint8_t Key, uint8_t Velocity);
            virtual void    SendNoteOn(uint8_t Key, uint8_t Velocity, int32_t FragmentPos);
            virtual void    SendNoteOff(uint8_t Key, uint8_t Velocity);
            virtual void    SendNoteOff(uint8_t Key, uint8_t Velocity, int32_t FragmentPos);
            virtual void    SendPitchbend(int Pitch);
            virtual void    SendPitchbend(int Pitch, int32_t FragmentPos);
            virtual void    SendControlChange(uint8_t Controller, uint8_t Value);
            virtual void    SendControlChange(uint8_t Controller, uint8_t Value, int32_t FragmentPos);
            virtual bool    StatusChanged(bool bNewStatus = false);
            virtual float   Volume();
            virtual void    Volume(float f);
            virtual uint    Channels();
            virtual void    Connect(AudioOutputDevice* pAudioOut);
            virtual void    DisconnectAudioOutputDevice();
            virtual AudioOutputDevice* GetAudioOutputDevice();
            virtual void    SetOutputChannel(uint EngineAudioChannel, uint AudioDeviceChannel);
            virtual int     OutputChannel(uint EngineAudioChannel);
            virtual void    Connect(MidiInputPort* pMidiPort, midi_chan_t MidiChannel);
            virtual void    DisconnectMidiInputPort();
            virtual MidiInputPort* GetMidiInputPort();
            virtual midi_chan_t MidiChannel();
            virtual String  InstrumentFileName();
            virtual String  InstrumentName();
            virtual int     InstrumentIndex();
            virtual int     InstrumentStatus();
            virtual LinuxSampler::Engine* GetEngine();
            virtual String  EngineName();
            virtual FxSend* AddFxSend(uint8_t MidiCtrl, String Name = "") throw (Exception);
            virtual FxSend* GetFxSend(uint FxSendIndex);
            virtual uint    GetFxSendCount();
            virtual void    RemoveFxSend(FxSend* pFxSend);

            // implementation of abstract methods derived from interface class 'InstrumentConsumer'
            virtual void ResourceToBeUpdated(::gig::Instrument* pResource, void*& pUpdateArg);
            virtual void ResourceUpdated(::gig::Instrument* pOldResource, ::gig::Instrument* pNewResource, void* pUpdateArg);
            virtual void OnResourceProgress(float fProgress);

            void Connect(VirtualMidiDevice* pDevice);
            void Disconnect(VirtualMidiDevice* pDevice);

        //protected:
            Engine*                 pEngine;
            AudioChannel*           pChannelLeft;             ///< encapsulates the audio rendering buffer (left)
            AudioChannel*           pChannelRight;            ///< encapsulates the audio rendering buffer (right)
            int                     AudioDeviceChannelLeft;   ///< audio device channel number to which the left channel is connected to
            int                     AudioDeviceChannelRight;  ///< audio device channel number to which the right channel is connected to
            MidiInputPort*          pMidiInputPort;           ///< Points to the connected MIDI input port or NULL if none assigned.
            midi_chan_t             midiChannel;              ///< MIDI channel(s) on which this engine channel listens to.
            RingBuffer<Event,false>* pEventQueue;             ///< Input event queue.
            RTList<Event>*          pEvents;                  ///< All engine channel specific events for the current audio fragment.
            uint8_t                 ControllerTable[129];     ///< Reflects the current values (0-127) of all MIDI controllers for this engine / sampler channel. Number 128 is for channel pressure (mono aftertouch).
            midi_key_info_t*        pMIDIKeyInfo;             ///< Contains all active voices sorted by MIDI key number and other informations to the respective MIDI key
            Pool<uint>*             pActiveKeys;              ///< Holds all keys in it's allocation list with active voices.
            std::map<uint,uint*>    ActiveKeyGroups;          ///< Contains active keys (in case they belong to a key group) ordered by key group ID.
            ::gig::Instrument*      pInstrument;
            bool                    SustainPedal;             ///< true if sustain pedal is down
            bool                    SostenutoPedal;           ///< true if sostenuto pedal is down
            bool                    SoloMode;                 ///< in Solo Mode we only play one voice (group) at a time
            int                     SoloKey;                  ///< Currently 'active' solo key, that is the key to which the currently sounding voice belongs to (only if SoloMode is enabled)
            bool                    PortamentoMode;           ///< in Portamento Mode we slide the pitch from the last note to the current note.
            float                   PortamentoTime;           ///< How long it will take to glide from the previous note to the current (in seconds)
            float                   PortamentoPos;            ///< Current position on the keyboard, that is integer and fractional part (only used if PortamentoMode is on)
            double                  GlobalVolume;             ///< Master volume factor set through the C++ API / LSCP (a value < 1.0 means attenuation, a value > 1.0 means amplification)
            double                  MidiVolume;               ///< Volume factor altered by MIDI CC#7 (a value < 1.0 means attenuation, a value > 1.0 means amplification)
            float                   GlobalPanLeft;
            float                   GlobalPanRight;
            int                     Pitch;                    ///< Current (absolute) MIDI pitch value.
            float                   CurrentKeyDimension;      ///< Current value (0-1.0) for the keyboard dimension, altered by pressing a keyswitching key.
            String                  InstrumentFile;
            int                     InstrumentIdx;
            String                  InstrumentIdxName;
            int                     InstrumentStat;
            int                     iEngineIndexSelf;         ///< Reflects the index of this EngineChannel in the Engine's ArrayList.
            bool                    bStatusChanged;           ///< true in case an engine parameter has changed (e.g. new instrument, another volumet)
            std::vector<FxSend*>    fxSends;
            int                     GlobalTranspose;          ///< amount of semi tones all notes should be transposed

            /// Command used by the instrument loader thread to
            /// request an instrument change on a channel.
            struct instrument_change_command_t {
                bool bChangeInstrument;                             ///< Set to true by the loader when the channel should change instrument.
                ::gig::Instrument* pInstrument;                     ///< The new instrument. Also used by the loader to read the previously loaded instrument.
                RTList< ::gig::DimensionRegion*>* pDimRegionsInUse; ///< List of dimension regions in use by the currently loaded instrument. Continuously updated by the audio thread.
            };
            SynchronizedConfig<instrument_change_command_t> InstrumentChangeCommand;
            SynchronizedConfig<instrument_change_command_t>::Reader InstrumentChangeCommandReader;

            RTList< ::gig::DimensionRegion*>* pDimRegionsInUse;     ///< temporary pointer into the instrument change command, used by the audio thread

            SynchronizedConfig< ArrayList<VirtualMidiDevice*> > virtualMidiDevices;
            SynchronizedConfig< ArrayList<VirtualMidiDevice*> >::Reader virtualMidiDevicesReader_AudioThread;
            SynchronizedConfig< ArrayList<VirtualMidiDevice*> >::Reader virtualMidiDevicesReader_MidiThread;

            void ResetControllers();
            void ClearEventLists();
            void ImportEvents(uint Samples);

            friend class Engine;
            friend class Voice;
            friend class InstrumentResourceManager;

        private:
            void ResetInternal();
            void RemoveAllFxSends();
            instrument_change_command_t& ChangeInstrument(::gig::Instrument* pInstrument);
    };

}} // namespace LinuxSampler::gig

#endif // __LS_GIG_ENGINECHANNEL_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 - 2008 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_GIG_ENGINECHANNEL_H__
25	#define __LS_GIG_ENGINECHANNEL_H__
26
27	#include "../common/Event.h"
28	#include "../EngineChannel.h"
29	#include "../../common/RingBuffer.h"
30	#include "../../common/ArrayList.h"
31	#include "../../drivers/audio/AudioChannel.h"
32	#include "../../drivers/midi/VirtualMidiDevice.h"
33	#include "EngineGlobals.h"
34	#include "Engine.h"
35	#include "Voice.h"
36	#include "InstrumentResourceManager.h"
37
38	namespace LinuxSampler { namespace gig {
39
40	// just symbol prototyping
41	class midi_key_info_t;
42	class Voice;
43
44	/** @brief Engine Channel of a gig::Engine
45	*
46	* Encapsulates a engine channel for the Gigasampler format capable
47	* sampler engine.
48	*/
49	class EngineChannel : public LinuxSampler::EngineChannel, public InstrumentConsumer {
50	public:
51	EngineChannel();
52	virtual ~EngineChannel();
53
54	// implementation of abstract methods derived from interface class 'LinuxSampler::EngineChannel'
55	virtual void PrepareLoadInstrument(const char* FileName, uint Instrument);
56	virtual void LoadInstrument();
57	virtual void Reset();
58	virtual void SendNoteOn(uint8_t Key, uint8_t Velocity);
59	virtual void SendNoteOn(uint8_t Key, uint8_t Velocity, int32_t FragmentPos);
60	virtual void SendNoteOff(uint8_t Key, uint8_t Velocity);
61	virtual void SendNoteOff(uint8_t Key, uint8_t Velocity, int32_t FragmentPos);
62	virtual void SendPitchbend(int Pitch);
63	virtual void SendPitchbend(int Pitch, int32_t FragmentPos);
64	virtual void SendControlChange(uint8_t Controller, uint8_t Value);
65	virtual void SendControlChange(uint8_t Controller, uint8_t Value, int32_t FragmentPos);
66	virtual bool StatusChanged(bool bNewStatus = false);
67	virtual float Volume();
68	virtual void Volume(float f);
69	virtual uint Channels();
70	virtual void Connect(AudioOutputDevice* pAudioOut);
71	virtual void DisconnectAudioOutputDevice();
72	virtual AudioOutputDevice* GetAudioOutputDevice();
73	virtual void SetOutputChannel(uint EngineAudioChannel, uint AudioDeviceChannel);
74	virtual int OutputChannel(uint EngineAudioChannel);
75	virtual void Connect(MidiInputPort* pMidiPort, midi_chan_t MidiChannel);
76	virtual void DisconnectMidiInputPort();
77	virtual MidiInputPort* GetMidiInputPort();
78	virtual midi_chan_t MidiChannel();
79	virtual String InstrumentFileName();
80	virtual String InstrumentName();
81	virtual int InstrumentIndex();
82	virtual int InstrumentStatus();
83	virtual LinuxSampler::Engine* GetEngine();
84	virtual String EngineName();
85	virtual FxSend* AddFxSend(uint8_t MidiCtrl, String Name = "") throw (Exception);
86	virtual FxSend* GetFxSend(uint FxSendIndex);
87	virtual uint GetFxSendCount();
88	virtual void RemoveFxSend(FxSend* pFxSend);
89
90	// implementation of abstract methods derived from interface class 'InstrumentConsumer'
91	virtual void ResourceToBeUpdated(::gig::Instrument* pResource, void*& pUpdateArg);
92	virtual void ResourceUpdated(::gig::Instrument* pOldResource, ::gig::Instrument* pNewResource, void* pUpdateArg);
93	virtual void OnResourceProgress(float fProgress);
94
95	void Connect(VirtualMidiDevice* pDevice);
96	void Disconnect(VirtualMidiDevice* pDevice);
97
98	//protected:
99	Engine* pEngine;
100	AudioChannel* pChannelLeft; ///< encapsulates the audio rendering buffer (left)
101	AudioChannel* pChannelRight; ///< encapsulates the audio rendering buffer (right)
102	int AudioDeviceChannelLeft; ///< audio device channel number to which the left channel is connected to
103	int AudioDeviceChannelRight; ///< audio device channel number to which the right channel is connected to
104	MidiInputPort* pMidiInputPort; ///< Points to the connected MIDI input port or NULL if none assigned.
105	midi_chan_t midiChannel; ///< MIDI channel(s) on which this engine channel listens to.
106	RingBuffer<Event,false>* pEventQueue; ///< Input event queue.
107	RTList<Event>* pEvents; ///< All engine channel specific events for the current audio fragment.
108	uint8_t ControllerTable[129]; ///< Reflects the current values (0-127) of all MIDI controllers for this engine / sampler channel. Number 128 is for channel pressure (mono aftertouch).
109	midi_key_info_t* pMIDIKeyInfo; ///< Contains all active voices sorted by MIDI key number and other informations to the respective MIDI key
110	Pool<uint>* pActiveKeys; ///< Holds all keys in it's allocation list with active voices.
111	std::map<uint,uint*> ActiveKeyGroups; ///< Contains active keys (in case they belong to a key group) ordered by key group ID.
112	::gig::Instrument* pInstrument;
113	bool SustainPedal; ///< true if sustain pedal is down
114	bool SostenutoPedal; ///< true if sostenuto pedal is down
115	bool SoloMode; ///< in Solo Mode we only play one voice (group) at a time
116	int SoloKey; ///< Currently 'active' solo key, that is the key to which the currently sounding voice belongs to (only if SoloMode is enabled)
117	bool PortamentoMode; ///< in Portamento Mode we slide the pitch from the last note to the current note.
118	float PortamentoTime; ///< How long it will take to glide from the previous note to the current (in seconds)
119	float PortamentoPos; ///< Current position on the keyboard, that is integer and fractional part (only used if PortamentoMode is on)
120	double GlobalVolume; ///< Master volume factor set through the C++ API / LSCP (a value < 1.0 means attenuation, a value > 1.0 means amplification)
121	double MidiVolume; ///< Volume factor altered by MIDI CC#7 (a value < 1.0 means attenuation, a value > 1.0 means amplification)
122	float GlobalPanLeft;
123	float GlobalPanRight;
124	int Pitch; ///< Current (absolute) MIDI pitch value.
125	float CurrentKeyDimension; ///< Current value (0-1.0) for the keyboard dimension, altered by pressing a keyswitching key.
126	String InstrumentFile;
127	int InstrumentIdx;
128	String InstrumentIdxName;
129	int InstrumentStat;
130	int iEngineIndexSelf; ///< Reflects the index of this EngineChannel in the Engine's ArrayList.
131	bool bStatusChanged; ///< true in case an engine parameter has changed (e.g. new instrument, another volumet)
132	std::vector<FxSend*> fxSends;
133	int GlobalTranspose; ///< amount of semi tones all notes should be transposed
134
135	/// Command used by the instrument loader thread to
136	/// request an instrument change on a channel.
137	struct instrument_change_command_t {
138	bool bChangeInstrument; ///< Set to true by the loader when the channel should change instrument.
139	::gig::Instrument* pInstrument; ///< The new instrument. Also used by the loader to read the previously loaded instrument.
140	RTList< ::gig::DimensionRegion> pDimRegionsInUse; ///< List of dimension regions in use by the currently loaded instrument. Continuously updated by the audio thread.
141	};
142	SynchronizedConfig<instrument_change_command_t> InstrumentChangeCommand;
143	SynchronizedConfig<instrument_change_command_t>::Reader InstrumentChangeCommandReader;
144
145	RTList< ::gig::DimensionRegion> pDimRegionsInUse; ///< temporary pointer into the instrument change command, used by the audio thread
146
147	SynchronizedConfig< ArrayList<VirtualMidiDevice*> > virtualMidiDevices;
148	SynchronizedConfig< ArrayList<VirtualMidiDevice*> >::Reader virtualMidiDevicesReader_AudioThread;
149	SynchronizedConfig< ArrayList<VirtualMidiDevice*> >::Reader virtualMidiDevicesReader_MidiThread;
150
151	void ResetControllers();
152	void ClearEventLists();
153	void ImportEvents(uint Samples);
154
155	friend class Engine;
156	friend class Voice;
157	friend class InstrumentResourceManager;
158
159	private:
160	void ResetInternal();
161	void RemoveAllFxSends();
162	instrument_change_command_t& ChangeInstrument(::gig::Instrument* pInstrument);
163	};
164
165	}} // namespace LinuxSampler::gig
166
167	#endif // __LS_GIG_ENGINECHANNEL_H__