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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2427 - (show annotations) (download) (as text)
Sat Mar 2 07:03:04 2013 UTC (11 years ago) by persson
File MIME type: text/x-c++hdr
File size: 8949 byte(s)
* code refactoring: added a lock guard class for exception safe mutex
  handling and used it everywhere appropriate

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 "../drivers/audio/AudioOutputDevice.h"
35 #include "common/Event.h"
36 #include "common/SignalUnitRack.h"
37
38 namespace LinuxSampler {
39
40 class AbstractEngineChannel;
41
42 class AbstractEngine: public Engine {
43
44 public:
45 enum Format { GIG = 1, SF2, SFZ };
46 static String GetFormatString(Format f);
47 static AbstractEngine* AcquireEngine(AbstractEngineChannel* pChannel, AudioOutputDevice* pDevice);
48 static void FreeEngine(AbstractEngineChannel* pChannel, AudioOutputDevice* pDevice);
49
50 AbstractEngine();
51 virtual ~AbstractEngine();
52
53 // implementation of abstract methods derived from class 'LinuxSampler::Engine'
54 virtual void SendSysex(void* pData, uint Size, MidiInputPort* pSender);
55 virtual void Reset();
56 virtual void Enable();
57 virtual void Disable();
58 virtual uint VoiceCount();
59 virtual uint VoiceCountMax();
60 virtual String EngineName();
61
62 virtual Format GetEngineFormat() = 0;
63 virtual void Connect(AudioOutputDevice* pAudioOut) = 0;
64 virtual void DisableAndLock();
65
66 void SetVoiceCount(uint Count);
67
68 float Random() {
69 RandomSeed = RandomSeed * 1103515245 + 12345; // classic pseudo random number generator
70 return RandomSeed / 4294967296.0f;
71 }
72
73 // Simple array wrapper just to make sure memory is freed
74 // when liblinuxsampler is unloaded
75 class FloatTable {
76 private:
77 const float* array;
78 public:
79 FloatTable(const float* array) : array(array) { }
80 ~FloatTable() { delete[] array; }
81 const float& operator[](int i) const { return array[i]; }
82 };
83
84 static const FloatTable VolumeCurve; ///< Table that maps volume control change values 0..127 to amplitude. Unity gain is at 90.
85 static const FloatTable PanCurve; ///< Table that maps pan control change values 0..128 to right channel amplitude. Unity gain is at 64 (center).
86 static const FloatTable CrossfadeCurve; ///< Table that maps crossfade control change values 0..127 to amplitude. Unity gain is at 127.
87
88 AudioOutputDevice* pAudioOutputDevice;
89
90 //TODO: should be protected
91 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)
92 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)
93
94 friend class AbstractVoice;
95 friend class AbstractEngineChannel;
96 template<class V, class R, class I> friend class EngineChannelBase;
97 template<class EC, class R, class S, class D> friend class VoiceBase;
98
99 protected:
100 ArrayList<EngineChannel*> engineChannels; ///< All engine channels of a Engine instance.
101 ConditionServer EngineDisabled;
102 int8_t ScaleTuning[12]; ///< contains optional detune factors (-64..+63 cents) for all 12 semitones of an octave
103 RingBuffer<Event,false>* pEventQueue; ///< Input event queue for engine global events (e.g. SysEx messages).
104 EventGenerator* pEventGenerator;
105 RTList<Event>* pGlobalEvents; ///< All engine global events for the current audio fragment (usually only SysEx messages).
106 Pool<Event>* pEventPool; ///< Contains all Event objects that can be used.
107 RingBuffer<uint8_t,false>* pSysexBuffer; ///< Input buffer for MIDI system exclusive messages.
108 uint SampleRate; ///< Sample rate of the engines output audio signal (in Hz)
109 uint MaxSamplesPerCycle; ///< Size of each audio output buffer
110 unsigned long FrameTime; ///< Time in frames of the start of the current audio fragment
111 int ActiveVoiceCountMax; ///< the maximum voice usage since application start
112 atomic_t ActiveVoiceCount; ///< number of currently active voices
113 int VoiceSpawnsLeft; ///< We only allow CONFIG_MAX_VOICES voices to be spawned per audio fragment, we use this variable to ensure this limit.
114
115 void RouteAudio(EngineChannel* pEngineChannel, uint Samples);
116 void RouteDedicatedVoiceChannels(EngineChannel* pEngineChannel, optional<float> FxSendLevels[2], uint Samples);
117 void ClearEventLists();
118 void ImportEvents(uint Samples);
119 void ProcessSysex(Pool<Event>::Iterator& itSysexEvent);
120 void ResetScaleTuning();
121 void ProcessPitchbend(AbstractEngineChannel* pEngineChannel, Pool<Event>::Iterator& itPitchbendEvent);
122
123 void ProcessFxSendControllers (
124 AbstractEngineChannel* pEngineChannel,
125 Pool<Event>::Iterator& itControlChangeEvent
126 );
127
128 uint8_t GSCheckSum(const RingBuffer<uint8_t,false>::NonVolatileReader AddrReader, uint DataSize);
129
130 virtual void ResetInternal() = 0;
131 virtual void KillAllVoices(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itKillEvent) = 0;
132 virtual void ProcessNoteOn(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent) = 0;
133 virtual void ProcessNoteOff(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOffEvent) = 0;
134 virtual void ProcessControlChange(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itControlChangeEvent) = 0;
135 virtual int GetMinFadeOutSamples() = 0;
136
137 private:
138 static std::map<Format, std::map<AudioOutputDevice*,AbstractEngine*> > engines;
139 uint32_t RandomSeed; ///< State of the random number generator used by the random dimension.
140
141 static float* InitVolumeCurve();
142 static float* InitPanCurve();
143 static float* InitCrossfadeCurve();
144 static float* InitCurve(const float* segments, int size = 128);
145
146 void AdjustScale(int8_t ScaleTunes[12]);
147 bool RouteFxSend(FxSend* pFxSend, AudioChannel* ppSource[2], float FxSendLevel, uint Samples);
148 };
149
150 } // namespace LinuxSampler
151
152 #endif /* __LS_ABSTRACTENGINE_H__ */
153

  ViewVC Help
Powered by ViewVC