src/engines/AbstractEngine.h

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

#include "Engine.h"
#include "../common/ArrayList.h"
#include "../common/atomic.h"
#include "../common/ConditionServer.h"
#include "../common/Pool.h"
#include "../common/RingBuffer.h"
#include "../common/ChangeFlagRelaxed.h"
#include "../common/ResourceManager.h"
#include "../drivers/audio/AudioOutputDevice.h"
#include "common/Event.h"
#include "common/Note.h"
#include "common/SignalUnitRack.h"
#include "common/InstrumentScriptVM.h"

namespace LinuxSampler {

    class AbstractEngineChannel;

    class AbstractEngine: public Engine {

        public:
            enum Format { GIG = 1, SF2, SFZ };
            static String GetFormatString(Format f);
            static AbstractEngine* AcquireEngine(AbstractEngineChannel* pChannel, AudioOutputDevice* pDevice);
            static void FreeEngine(AbstractEngineChannel* pChannel, AudioOutputDevice* pDevice);

            AbstractEngine();
            virtual ~AbstractEngine();

            // implementation of abstract methods derived from class 'LinuxSampler::Engine'
            virtual void   SendSysex(void* pData, uint Size, MidiInputPort* pSender) OVERRIDE;
            virtual void   Reset() OVERRIDE;
            virtual void   Enable() OVERRIDE;
            virtual void   Disable() OVERRIDE;
            virtual uint   VoiceCount() OVERRIDE;
            virtual uint   VoiceCountMax() OVERRIDE;
            virtual String EngineName() OVERRIDE;
            virtual void   AdjustScaleTuning(const int8_t ScaleTunes[12]) OVERRIDE;
            virtual void   GetScaleTuning(int8_t* pScaleTunes) OVERRIDE;
            virtual void   ResetScaleTuning() OVERRIDE;

            virtual Format GetEngineFormat() = 0;
            virtual void   Connect(AudioOutputDevice* pAudioOut) = 0;
            virtual void   DisableAndLock();

            void SetVoiceCount(uint Count);

            /**
             * Returns event with the given event ID.
             */
            RTList<Event>::Iterator EventByID(event_id_t id) {
                return pEventPool->fromID(id);
            }

            virtual NoteBase* NoteByID(note_id_t id) = 0;

            float Random() {
                RandomSeed = RandomSeed * 1103515245 + 12345; // classic pseudo random number generator
                return RandomSeed / 4294967296.0f;
            }

            // Simple array wrapper just to make sure memory is freed
            // when liblinuxsampler is unloaded
            class FloatTable {
            private:
                const float* array;
            public:
                FloatTable(const float* array) : array(array) { }
                ~FloatTable() { delete[] array; }
                const float& operator[](int i) const { return array[i]; }
            };

            static const FloatTable VolumeCurve;    ///< Table that maps volume control change values 0..127 to amplitude. Unity gain is at 90.
            static const FloatTable PanCurve;       ///< Table that maps pan control change values 0..128 to right channel amplitude. Unity gain is at 64 (center).
            static const FloatTable CrossfadeCurve; ///< Table that maps crossfade control change values 0..127 to amplitude. Unity gain is at 127.

            static float PanCurveValueNorm(float pan, int channel);

            AudioOutputDevice* pAudioOutputDevice;
            
            //TODO: should be protected
            AudioChannel* pDedicatedVoiceChannelLeft;  ///< encapsulates a special audio rendering buffer (left) for rendering and routing audio on a per voice basis (this is a very special case and only used for voices which lie on a note which was set with individual, dedicated FX send level)
            AudioChannel* pDedicatedVoiceChannelRight; ///< encapsulates a special audio rendering buffer (right) for rendering and routing audio on a per voice basis (this is a very special case and only used for voices which lie on a note which was set with individual, dedicated FX send level)

            friend class AbstractVoice;
            friend class AbstractEngineChannel;
            template<class V, class R, class I> friend class EngineChannelBase;
            template<class EC, class R, class S, class D> friend class VoiceBase;

        //protected:
            ArrayList<EngineChannel*>  engineChannels; ///< All engine channels of a Engine instance.
            ConditionServer            EngineDisabled;
            int8_t                     ScaleTuning[12];    ///< contains optional detune factors (-64..+63 cents) for all 12 semitones of an octave
            ChangeFlagRelaxed          ScaleTuningChanged; ///< Boolean flag indicating whenever ScaleTuning has been modified by a foreign thread (i.e. by API).
            RingBuffer<Event,false>*   pEventQueue;        ///< Input event queue for engine global events (e.g. SysEx messages).
            EventGenerator*            pEventGenerator;
            RTList<Event>*             pGlobalEvents;         ///< All engine global events for the current audio fragment (usually only SysEx messages).
            Pool<Event>*               pEventPool;            ///< Contains all Event objects that can be used.
            RingBuffer<uint8_t,false>* pSysexBuffer;          ///< Input buffer for MIDI system exclusive messages.
            uint                       SampleRate;            ///< Sample rate of the engines output audio signal (in Hz)
            uint                       MaxSamplesPerCycle;    ///< Size of each audio output buffer
            sched_time_t               FrameTime;             ///< Scheduler time of the 1st sample point of the current audio fragment cycle. This is a consecutive sample point counter for the engine which proceeds (beyond fragment boundaries) until the engine is explicitly reset for some reason.
            int                        ActiveVoiceCountMax;   ///< the maximum voice usage since application start
            atomic_t                   ActiveVoiceCount;      ///< number of currently active voices
            int                        VoiceSpawnsLeft;       ///< We only allow CONFIG_MAX_VOICES voices to be spawned per audio fragment, we use this variable to ensure this limit.
            InstrumentScriptVM*        pScriptVM; ///< Real-time instrument script virtual machine runner for this engine.

            void RouteAudio(EngineChannel* pEngineChannel, uint Samples);
            void RouteDedicatedVoiceChannels(EngineChannel* pEngineChannel, optional<float> FxSendLevels[2], uint Samples);
            void ClearEventLists();
            void ImportEvents(uint Samples);
            void ProcessSysex(Pool<Event>::Iterator& itSysexEvent);
            void ProcessPitchbend(AbstractEngineChannel* pEngineChannel, Pool<Event>::Iterator& itPitchbendEvent);

            void ProcessFxSendControllers (
                AbstractEngineChannel*  pEngineChannel,
                Pool<Event>::Iterator&  itControlChangeEvent
            );

            uint8_t GSCheckSum(const RingBuffer<uint8_t,false>::NonVolatileReader AddrReader, uint DataSize);

            virtual void ResetInternal() = 0;
            virtual void KillAllVoices(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itKillEvent) = 0;
            virtual void ProcessNoteOn(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent) = 0;
            virtual void ProcessNoteOff(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOffEvent) = 0;
            virtual void ProcessControlChange(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itControlChangeEvent) = 0;
            virtual void ProcessChannelPressure(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itChannelPressureEvent) = 0;
            virtual void ProcessPolyphonicKeyPressure(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNotePressureEvent) = 0;
            virtual void ProcessReleaseTrigger(EngineChannel* pEngineChannel, RTList<Event>::Iterator& itEvent) = 0;
            virtual int  GetMinFadeOutSamples() = 0;
            virtual note_id_t LaunchNewNote(LinuxSampler::EngineChannel* pEngineChannel, Event* pNoteOnEvent) = 0;
            virtual void CreateInstrumentScriptVM();

        private:
            static std::map<Format, std::map<AudioOutputDevice*,AbstractEngine*> > engines;
            uint32_t RandomSeed; ///< State of the random number generator used by the random dimension.

            static float* InitVolumeCurve();
            static float* InitPanCurve();
            static float* InitCrossfadeCurve();
            static float* InitCurve(const float* segments, int size = 128);

            bool RouteFxSend(FxSend* pFxSend, AudioChannel* ppSource[2], float FxSendLevel, uint Samples);
    };

} // namespace LinuxSampler

#endif  /* __LS_ABSTRACTENGINE_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	* Copyright (C) 2009-2013 Christian Schoenebeck and Grigor Iliev *
8	* *
9	* This program is free software; you can redistribute it and/or modify *
10	* it under the terms of the GNU General Public License as published by *
11	* the Free Software Foundation; either version 2 of the License, or *
12	* (at your option) any later version. *
13	* *
14	* This program is distributed in the hope that it will be useful, *
15	* but WITHOUT ANY WARRANTY; without even the implied warranty of *
16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
17	* GNU General Public License for more details. *
18	* *
19	* You should have received a copy of the GNU General Public License *
20	* along with this program; if not, write to the Free Software *
21	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
22	* MA 02111-1307 USA *
23	***************************************************************************/
24
25	#ifndef __LS_ABSTRACTENGINE_H__
26	#define __LS_ABSTRACTENGINE_H__
27
28	#include "Engine.h"
29	#include "../common/ArrayList.h"
30	#include "../common/atomic.h"
31	#include "../common/ConditionServer.h"
32	#include "../common/Pool.h"
33	#include "../common/RingBuffer.h"
34	#include "../common/ChangeFlagRelaxed.h"
35	#include "../common/ResourceManager.h"
36	#include "../drivers/audio/AudioOutputDevice.h"
37	#include "common/Event.h"
38	#include "common/Note.h"
39	#include "common/SignalUnitRack.h"
40	#include "common/InstrumentScriptVM.h"
41
42	namespace LinuxSampler {
43
44	class AbstractEngineChannel;
45
46	class AbstractEngine: public Engine {
47
48	public:
49	enum Format { GIG = 1, SF2, SFZ };
50	static String GetFormatString(Format f);
51	static AbstractEngine* AcquireEngine(AbstractEngineChannel* pChannel, AudioOutputDevice* pDevice);
52	static void FreeEngine(AbstractEngineChannel* pChannel, AudioOutputDevice* pDevice);
53
54	AbstractEngine();
55	virtual ~AbstractEngine();
56
57	// implementation of abstract methods derived from class 'LinuxSampler::Engine'
58	virtual void SendSysex(void* pData, uint Size, MidiInputPort* pSender) OVERRIDE;
59	virtual void Reset() OVERRIDE;
60	virtual void Enable() OVERRIDE;
61	virtual void Disable() OVERRIDE;
62	virtual uint VoiceCount() OVERRIDE;
63	virtual uint VoiceCountMax() OVERRIDE;
64	virtual String EngineName() OVERRIDE;
65	virtual void AdjustScaleTuning(const int8_t ScaleTunes[12]) OVERRIDE;
66	virtual void GetScaleTuning(int8_t* pScaleTunes) OVERRIDE;
67	virtual void ResetScaleTuning() OVERRIDE;
68
69	virtual Format GetEngineFormat() = 0;
70	virtual void Connect(AudioOutputDevice* pAudioOut) = 0;
71	virtual void DisableAndLock();
72
73	void SetVoiceCount(uint Count);
74
75	/**
76	* Returns event with the given event ID.
77	*/
78	RTList<Event>::Iterator EventByID(event_id_t id) {
79	return pEventPool->fromID(id);
80	}
81
82	virtual NoteBase* NoteByID(note_id_t id) = 0;
83
84	float Random() {
85	RandomSeed = RandomSeed * 1103515245 + 12345; // classic pseudo random number generator
86	return RandomSeed / 4294967296.0f;
87	}
88
89	// Simple array wrapper just to make sure memory is freed
90	// when liblinuxsampler is unloaded
91	class FloatTable {
92	private:
93	const float* array;
94	public:
95	FloatTable(const float* array) : array(array) { }
96	~FloatTable() { delete[] array; }
97	const float& operator[](int i) const { return array[i]; }
98	};
99
100	static const FloatTable VolumeCurve; ///< Table that maps volume control change values 0..127 to amplitude. Unity gain is at 90.
101	static const FloatTable PanCurve; ///< Table that maps pan control change values 0..128 to right channel amplitude. Unity gain is at 64 (center).
102	static const FloatTable CrossfadeCurve; ///< Table that maps crossfade control change values 0..127 to amplitude. Unity gain is at 127.
103
104	static float PanCurveValueNorm(float pan, int channel);
105
106	AudioOutputDevice* pAudioOutputDevice;
107
108	//TODO: should be protected
109	AudioChannel* pDedicatedVoiceChannelLeft; ///< encapsulates a special audio rendering buffer (left) for rendering and routing audio on a per voice basis (this is a very special case and only used for voices which lie on a note which was set with individual, dedicated FX send level)
110	AudioChannel* pDedicatedVoiceChannelRight; ///< encapsulates a special audio rendering buffer (right) for rendering and routing audio on a per voice basis (this is a very special case and only used for voices which lie on a note which was set with individual, dedicated FX send level)
111
112	friend class AbstractVoice;
113	friend class AbstractEngineChannel;
114	template<class V, class R, class I> friend class EngineChannelBase;
115	template<class EC, class R, class S, class D> friend class VoiceBase;
116
117	//protected:
118	ArrayList<EngineChannel*> engineChannels; ///< All engine channels of a Engine instance.
119	ConditionServer EngineDisabled;
120	int8_t ScaleTuning[12]; ///< contains optional detune factors (-64..+63 cents) for all 12 semitones of an octave
121	ChangeFlagRelaxed ScaleTuningChanged; ///< Boolean flag indicating whenever ScaleTuning has been modified by a foreign thread (i.e. by API).
122	RingBuffer<Event,false>* pEventQueue; ///< Input event queue for engine global events (e.g. SysEx messages).
123	EventGenerator* pEventGenerator;
124	RTList<Event>* pGlobalEvents; ///< All engine global events for the current audio fragment (usually only SysEx messages).
125	Pool<Event>* pEventPool; ///< Contains all Event objects that can be used.
126	RingBuffer<uint8_t,false>* pSysexBuffer; ///< Input buffer for MIDI system exclusive messages.
127	uint SampleRate; ///< Sample rate of the engines output audio signal (in Hz)
128	uint MaxSamplesPerCycle; ///< Size of each audio output buffer
129	sched_time_t FrameTime; ///< Scheduler time of the 1st sample point of the current audio fragment cycle. This is a consecutive sample point counter for the engine which proceeds (beyond fragment boundaries) until the engine is explicitly reset for some reason.
130	int ActiveVoiceCountMax; ///< the maximum voice usage since application start
131	atomic_t ActiveVoiceCount; ///< number of currently active voices
132	int VoiceSpawnsLeft; ///< We only allow CONFIG_MAX_VOICES voices to be spawned per audio fragment, we use this variable to ensure this limit.
133	InstrumentScriptVM* pScriptVM; ///< Real-time instrument script virtual machine runner for this engine.
134
135	void RouteAudio(EngineChannel* pEngineChannel, uint Samples);
136	void RouteDedicatedVoiceChannels(EngineChannel* pEngineChannel, optional<float> FxSendLevels[2], uint Samples);
137	void ClearEventLists();
138	void ImportEvents(uint Samples);
139	void ProcessSysex(Pool<Event>::Iterator& itSysexEvent);
140	void ProcessPitchbend(AbstractEngineChannel* pEngineChannel, Pool<Event>::Iterator& itPitchbendEvent);
141
142	void ProcessFxSendControllers (
143	AbstractEngineChannel* pEngineChannel,
144	Pool<Event>::Iterator& itControlChangeEvent
145	);
146
147	uint8_t GSCheckSum(const RingBuffer<uint8_t,false>::NonVolatileReader AddrReader, uint DataSize);
148
149	virtual void ResetInternal() = 0;
150	virtual void KillAllVoices(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itKillEvent) = 0;
151	virtual void ProcessNoteOn(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent) = 0;
152	virtual void ProcessNoteOff(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOffEvent) = 0;
153	virtual void ProcessControlChange(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itControlChangeEvent) = 0;
154	virtual void ProcessChannelPressure(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itChannelPressureEvent) = 0;
155	virtual void ProcessPolyphonicKeyPressure(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNotePressureEvent) = 0;
156	virtual void ProcessReleaseTrigger(EngineChannel* pEngineChannel, RTList<Event>::Iterator& itEvent) = 0;
157	virtual int GetMinFadeOutSamples() = 0;
158	virtual note_id_t LaunchNewNote(LinuxSampler::EngineChannel* pEngineChannel, Event* pNoteOnEvent) = 0;
159	virtual void CreateInstrumentScriptVM();
160
161	private:
162	static std::map<Format, std::map<AudioOutputDevice,AbstractEngine> > engines;
163	uint32_t RandomSeed; ///< State of the random number generator used by the random dimension.
164
165	static float* InitVolumeCurve();
166	static float* InitPanCurve();
167	static float* InitCrossfadeCurve();
168	static float* InitCurve(const float* segments, int size = 128);
169
170	bool RouteFxSend(FxSend* pFxSend, AudioChannel* ppSource[2], float FxSendLevel, uint Samples);
171	};
172
173	} // namespace LinuxSampler
174
175	#endif /* __LS_ABSTRACTENGINE_H__ */
176