/[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 2600 - (show annotations) (download) (as text)
Sat Jun 7 00:16:03 2014 UTC (9 years, 10 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 10940 byte(s) 
* Implemented built-in instrument script function "set_controller()".
* Fixed built-in script functions "ignore_event()" and
  "ignore_controller()".
* Added extended instrument script VM for the Gigasampler/GigaStudio format
  sampler engine, which extends the general instrument script VM with Giga
  format specific variables and functions.
* Giga format instrument scripts: added built-in script int constant
  variables $GIG_DIM_CHANNEL, $GIG_DIM_LAYER, $GIG_DIM_VELOCITY,
  $GIG_DIM_AFTERTOUCH, $GIG_DIM_RELEASE, $GIG_DIM_KEYBOARD,
  $GIG_DIM_ROUNDROBIN, $GIG_DIM_RANDOM, $GIG_DIM_SMARTMIDI,
  $GIG_DIM_ROUNDROBINKEY, $GIG_DIM_MODWHEEL, $GIG_DIM_BREATH,
  $GIG_DIM_FOOT, $GIG_DIM_PORTAMENTOTIME, $GIG_DIM_EFFECT1,
  $GIG_DIM_EFFECT2, $GIG_DIM_GENPURPOSE1, $GIG_DIM_GENPURPOSE2,
  $GIG_DIM_GENPURPOSE3, $GIG_DIM_GENPURPOSE4, $GIG_DIM_SUSTAIN,
  $GIG_DIM_PORTAMENTO, $GIG_DIM_SOSTENUTO, $GIG_DIM_SOFT,
  $GIG_DIM_GENPURPOSE5, $GIG_DIM_GENPURPOSE6, $GIG_DIM_GENPURPOSE7,
  $GIG_DIM_GENPURPOSE8, $GIG_DIM_EFFECT1DEPTH, $GIG_DIM_EFFECT2DEPTH,
  $GIG_DIM_EFFECT3DEPTH, $GIG_DIM_EFFECT4DEPTH, $GIG_DIM_EFFECT5DEPTH.
* Giga format instrument scripts: Implemented built-in script function
  "gig_set_dim_zone(event_id, dimension, zone)", which allows to override
  dimension zone(s) for new voices.
* Bumped version (1.0.0.svn45).
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/SignalUnitRack.h"
39 #include "common/InstrumentScriptVM.h"
40
41 namespace LinuxSampler {
42
43 class AbstractEngineChannel;
44
45 class AbstractEngine: public Engine {
46
47 public:
48 enum Format { GIG = 1, SF2, SFZ };
49 static String GetFormatString(Format f);
50 static AbstractEngine* AcquireEngine(AbstractEngineChannel* pChannel, AudioOutputDevice* pDevice);
51 static void FreeEngine(AbstractEngineChannel* pChannel, AudioOutputDevice* pDevice);
52
53 AbstractEngine();
54 virtual ~AbstractEngine();
55
56 // implementation of abstract methods derived from class 'LinuxSampler::Engine'
57 virtual void SendSysex(void* pData, uint Size, MidiInputPort* pSender) OVERRIDE;
58 virtual void Reset() OVERRIDE;
59 virtual void Enable() OVERRIDE;
60 virtual void Disable() OVERRIDE;
61 virtual uint VoiceCount() OVERRIDE;
62 virtual uint VoiceCountMax() OVERRIDE;
63 virtual String EngineName() OVERRIDE;
64 virtual void AdjustScaleTuning(const int8_t ScaleTunes[12]) OVERRIDE;
65 virtual void GetScaleTuning(int8_t* pScaleTunes) OVERRIDE;
66 virtual void ResetScaleTuning() OVERRIDE;
67
68 virtual Format GetEngineFormat() = 0;
69 virtual void Connect(AudioOutputDevice* pAudioOut) = 0;
70 virtual void DisableAndLock();
71
72 void SetVoiceCount(uint Count);
73
74 /**
75 * Returns event with the given event ID.
76 */
77 RTList<Event>::Iterator EventByID(int id) {
78 return pEventPool->fromID(id);
79 }
80
81 float Random() {
82 RandomSeed = RandomSeed * 1103515245 + 12345; // classic pseudo random number generator
83 return RandomSeed / 4294967296.0f;
84 }
85
86 // Simple array wrapper just to make sure memory is freed
87 // when liblinuxsampler is unloaded
88 class FloatTable {
89 private:
90 const float* array;
91 public:
92 FloatTable(const float* array) : array(array) { }
93 ~FloatTable() { delete[] array; }
94 const float& operator[](int i) const { return array[i]; }
95 };
96
97 static const FloatTable VolumeCurve; ///< Table that maps volume control change values 0..127 to amplitude. Unity gain is at 90.
98 static const FloatTable PanCurve; ///< Table that maps pan control change values 0..128 to right channel amplitude. Unity gain is at 64 (center).
99 static const FloatTable CrossfadeCurve; ///< Table that maps crossfade control change values 0..127 to amplitude. Unity gain is at 127.
100
101 AudioOutputDevice* pAudioOutputDevice;
102
103 //TODO: should be protected
104 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)
105 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)
106
107 typedef ResourceConsumer<VMParserContext> ScriptConsumer;
108
109 class ScriptResourceManager : public ResourceManager<String, VMParserContext> {
110 protected:
111 // implementation of derived abstract methods from 'ResourceManager'
112 virtual VMParserContext* Create(String Key, ScriptConsumer* pConsumer, void*& pArg);
113 virtual void Destroy(VMParserContext* pResource, void* pArg);
114 virtual void OnBorrow(VMParserContext* pResource, ScriptConsumer* pConsumer, void*& pArg) {} // ignore
115 public:
116 ScriptResourceManager(AbstractEngine* parent) : parent(parent) {}
117 virtual ~ScriptResourceManager() {}
118 private:
119 AbstractEngine* parent;
120 } scripts;
121
122 friend class AbstractVoice;
123 friend class AbstractEngineChannel;
124 template<class V, class R, class I> friend class EngineChannelBase;
125 template<class EC, class R, class S, class D> friend class VoiceBase;
126
127 protected:
128 ArrayList<EngineChannel*> engineChannels; ///< All engine channels of a Engine instance.
129 ConditionServer EngineDisabled;
130 int8_t ScaleTuning[12]; ///< contains optional detune factors (-64..+63 cents) for all 12 semitones of an octave
131 ChangeFlagRelaxed ScaleTuningChanged; ///< Boolean flag indicating whenever ScaleTuning has been modified by a foreign thread (i.e. by API).
132 RingBuffer<Event,false>* pEventQueue; ///< Input event queue for engine global events (e.g. SysEx messages).
133 EventGenerator* pEventGenerator;
134 RTList<Event>* pGlobalEvents; ///< All engine global events for the current audio fragment (usually only SysEx messages).
135 Pool<Event>* pEventPool; ///< Contains all Event objects that can be used.
136 RingBuffer<uint8_t,false>* pSysexBuffer; ///< Input buffer for MIDI system exclusive messages.
137 uint SampleRate; ///< Sample rate of the engines output audio signal (in Hz)
138 uint MaxSamplesPerCycle; ///< Size of each audio output buffer
139 unsigned long FrameTime; ///< Time in frames of the start of the current audio fragment
140 int ActiveVoiceCountMax; ///< the maximum voice usage since application start
141 atomic_t ActiveVoiceCount; ///< number of currently active voices
142 int VoiceSpawnsLeft; ///< We only allow CONFIG_MAX_VOICES voices to be spawned per audio fragment, we use this variable to ensure this limit.
143 InstrumentScriptVM* pScriptVM; ///< Real-time instrument script virtual machine runner for this engine.
144
145 void RouteAudio(EngineChannel* pEngineChannel, uint Samples);
146 void RouteDedicatedVoiceChannels(EngineChannel* pEngineChannel, optional<float> FxSendLevels[2], uint Samples);
147 void ClearEventLists();
148 void ImportEvents(uint Samples);
149 void ProcessSysex(Pool<Event>::Iterator& itSysexEvent);
150 void ProcessPitchbend(AbstractEngineChannel* pEngineChannel, Pool<Event>::Iterator& itPitchbendEvent);
151
152 void ProcessFxSendControllers (
153 AbstractEngineChannel* pEngineChannel,
154 Pool<Event>::Iterator& itControlChangeEvent
155 );
156
157 uint8_t GSCheckSum(const RingBuffer<uint8_t,false>::NonVolatileReader AddrReader, uint DataSize);
158
159 virtual void ResetInternal() = 0;
160 virtual void KillAllVoices(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itKillEvent) = 0;
161 virtual void ProcessNoteOn(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent) = 0;
162 virtual void ProcessNoteOff(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOffEvent) = 0;
163 virtual void ProcessControlChange(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itControlChangeEvent) = 0;
164 virtual void ProcessChannelPressure(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itChannelPressureEvent) = 0;
165 virtual void ProcessPolyphonicKeyPressure(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNotePressureEvent) = 0;
166 virtual int GetMinFadeOutSamples() = 0;
167 virtual InstrumentScriptVM* CreateInstrumentScriptVM();
168
169 private:
170 static std::map<Format, std::map<AudioOutputDevice*,AbstractEngine*> > engines;
171 uint32_t RandomSeed; ///< State of the random number generator used by the random dimension.
172
173 static float* InitVolumeCurve();
174 static float* InitPanCurve();
175 static float* InitCrossfadeCurve();
176 static float* InitCurve(const float* segments, int size = 128);
177
178 bool RouteFxSend(FxSend* pFxSend, AudioChannel* ppSource[2], float FxSendLevel, uint Samples);
179 };
180
181 } // namespace LinuxSampler
182
183 #endif /* __LS_ABSTRACTENGINE_H__ */
184
  ViewVC Help
Powered by ViewVC