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

Contents of /linuxsampler/trunk/src/engines/common/AbstractVoice.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2931 - (show annotations) (download) (as text)
Sat Jul 9 14:38:33 2016 UTC (3 years, 3 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 18389 byte(s)
* Implemented built-in instrument script function "change_vol()".
* Implemented built-in instrument script function "change_tune()".
* Implemented built-in instrument script function "change_pan()".
* Bumped version (2.0.0.svn11).

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 * *
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_ABSTRACTVOICE_H__
26 #define __LS_ABSTRACTVOICE_H__
27
28 #include "Voice.h"
29
30 #include "../../common/global_private.h"
31 #include "../AbstractEngineChannel.h"
32 #include "../common/LFOBase.h"
33 #include "../EngineBase.h"
34 #include "EG.h"
35 #include "../gig/EGADSR.h"
36 #include "../gig/EGDecay.h"
37 #include "../gig/SmoothVolume.h"
38 #include "../gig/Synthesizer.h"
39 #include "../gig/Profiler.h"
40 #include "SignalUnitRack.h"
41
42 // include the appropriate (unsigned) triangle LFO implementation
43 #if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
44 # include "../common/LFOTriangleIntMath.h"
45 #elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
46 # include "../common/LFOTriangleIntAbsMath.h"
47 #elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
48 # include "../common/LFOTriangleDiHarmonic.h"
49 #else
50 # error "Unknown or no (unsigned) triangle LFO implementation selected!"
51 #endif
52
53 // include the appropriate (signed) triangle LFO implementation
54 #if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
55 # include "../common/LFOTriangleIntMath.h"
56 #elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
57 # include "../common/LFOTriangleIntAbsMath.h"
58 #elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
59 # include "../common/LFOTriangleDiHarmonic.h"
60 #else
61 # error "Unknown or no (signed) triangle LFO implementation selected!"
62 #endif
63
64 namespace LinuxSampler {
65
66 #if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
67 typedef LFOTriangleIntMath<range_unsigned> LFOUnsigned;
68 #elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
69 typedef LFOTriangleIntAbsMath<range_unsigned> LFOUnsigned;
70 #elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
71 typedef LFOTriangleDiHarmonic<range_unsigned> LFOUnsigned;
72 #endif
73
74 #if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
75 typedef LFOTriangleIntMath<range_signed> LFOSigned;
76 #elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
77 typedef LFOTriangleIntAbsMath<range_signed> LFOSigned;
78 #elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
79 typedef LFOTriangleDiHarmonic<range_signed> LFOSigned;
80 #endif
81
82 class AbstractVoice : public Voice {
83 public:
84 type_t Type; ///< Voice Type (bit field, a voice may have several types)
85 NoteBase* pNote; ///< Note this voice belongs to and was caused by.
86 int MIDIPan; ///< the current MIDI pan value plus the value from RegionInfo
87
88 SignalUnitRack* const pSignalUnitRack;
89
90 AbstractVoice(SignalUnitRack* pRack);
91 virtual ~AbstractVoice();
92
93 inline bool IsActive() { return PlaybackState; }
94 inline bool IsStealable() { return !itKillEvent && PlaybackState >= playback_state_ram; }
95
96 virtual void Reset();
97
98 virtual int Trigger (
99 AbstractEngineChannel* pEngineChannel,
100 Pool<Event>::Iterator& itNoteOnEvent,
101 int PitchBend,
102 type_t VoiceType,
103 int iKeyGroup
104 );
105
106 /** Invoked when the voice is freed - gone from active to inactive. */
107 virtual void VoiceFreed() { }
108
109 virtual void Synthesize(uint Samples, sample_t* pSrc, uint Skip);
110
111 uint GetSampleRate() { return GetEngine()->SampleRate; }
112
113 uint8_t GetControllerValue(uint8_t Controller) {
114 return (Controller > 128) ? 0 : pEngineChannel->ControllerTable[Controller];
115 }
116
117 /// Keyboard key on which this voice should listen to transitional events (i.e. note-off events to release the voice).
118 inline uint8_t HostKey() const { return pNote->hostKey; }
119 /// Keyboard key which the voice should use for calculating any synthesis relevant parameters (i.e. pitch).
120 inline uint8_t MIDIKey() const { return pNote->cause.Param.Note.Key; }
121 /// MIDI note-on velocity value which the voice should use for calculating any synthesis relevant parameters (i.e. amplitude).
122 inline uint8_t MIDIVelocity() const { return pNote->cause.Param.Note.Velocity; }
123
124 void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);
125 void processPitchEvent(RTList<Event>::Iterator& itEvent);
126 void processResonanceEvent(RTList<Event>::Iterator& itEvent);
127 void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);
128 void processGroupEvents(RTList<Event>::Iterator& itEvent, uint End);
129 void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);
130 void Kill(Pool<Event>::Iterator& itKillEvent);
131 void CreateEq();
132 void onScaleTuningChanged();
133
134 bool Orphan; ///< true if this voice is playing a sample from an instrument that is unloaded. When the voice dies, the sample (and dimension region) will be handed back to the instrument resource manager.
135 playback_state_t PlaybackState; ///< When a sample will be triggered, it will be first played from RAM cache and after a couple of sample points it will switch to disk streaming and at the end of a disk stream we have to add null samples, so the interpolator can do it's work correctly
136 Stream::reference_t DiskStreamRef; ///< Reference / link to the disk stream
137
138 template<class TV, class TRR, class TR, class TD, class TIM, class TI> friend class EngineBase;
139
140 protected:
141 SampleInfo SmplInfo;
142 RegionInfo RgnInfo;
143 InstrumentInfo InstrInfo;
144 AbstractEngineChannel* pEngineChannel;
145
146 double Pos; ///< Current playback position in sample
147 PitchInfo Pitch;
148 float NotePitch; ///< Updated by calls to built-in instrument script function change_tune() (defaults to 1.0, that is neutral).
149 float CutoffBase; ///< Cutoff frequency before control change, EG and LFO are applied
150 float VolumeLeft; ///< Left channel volume. This factor is calculated when the voice is triggered and doesn't change after that.
151 float VolumeRight; ///< Right channel volume. This factor is calculated when the voice is triggered and doesn't change after that.
152 float NotePanLeft; ///< Updated by calls to built-in instrument script function change_pan() (defaults to 1.0, that is neutral).
153 float NotePanRight; ///< Updated by calls to built-in instrument script function change_pan() (defaults to 1.0, that is neutral).
154 gig::SmoothVolume CrossfadeSmoother; ///< Crossfade volume, updated by crossfade CC events
155 gig::SmoothVolume VolumeSmoother; ///< Volume, updated by CC 7 (volume) events
156 gig::SmoothVolume PanLeftSmoother; ///< Left channel volume, updated by CC 10 (pan) events and change_pan() real-time instrument script calls.
157 gig::SmoothVolume PanRightSmoother; ///< Right channel volume, updated by CC 10 (pan) events and change_pan() real-time instrument script calls.
158 gig::SmoothVolume NoteVolumeSmoother; ///< Note's global volume, updated by change_vol() real-time instrument script calls.
159 bool DiskVoice; ///< If the sample is very short it completely fits into the RAM cache and doesn't need to be streamed from disk, in that case this flag is set to false
160 bool RAMLoop; ///< If this voice has a loop defined which completely fits into the cached RAM part of the sample, in this case we handle the looping within the voice class, else if the loop is located in the disk stream part, we let the disk stream handle the looping
161 unsigned long MaxRAMPos; ///< The upper allowed limit (not actually the end) in the RAM sample cache, after that point it's not safe to chase the interpolator another time over over the current cache position, instead we switch to disk then.
162 uint Delay; ///< Number of sample points the rendering process of this voice should be delayed (jitter correction), will be set to 0 after the first audio fragment cycle
163 EG* pEG1; ///< Envelope Generator 1 (Amplification)
164 EG* pEG2; ///< Envelope Generator 2 (Filter cutoff frequency)
165 gig::EGDecay EG3; ///< Envelope Generator 3 (Pitch) TODO: use common EG instead?
166 midi_ctrl VCFCutoffCtrl;
167 midi_ctrl VCFResonanceCtrl;
168 LFOUnsigned* pLFO1; ///< Low Frequency Oscillator 1 (Amplification)
169 LFOUnsigned* pLFO2; ///< Low Frequency Oscillator 2 (Filter cutoff frequency)
170 LFOSigned* pLFO3; ///< Low Frequency Oscillator 3 (Pitch)
171 bool bLFO1Enabled; ///< Should we use the Amplitude LFO for this voice?
172 bool bLFO2Enabled; ///< Should we use the Filter Cutoff LFO for this voice?
173 bool bLFO3Enabled; ///< Should we use the Pitch LFO for this voice?
174 Pool<Event>::Iterator itTriggerEvent; ///< First event on the key's list the voice should process (only needed for the first audio fragment in which voice was triggered, after that it will be set to NULL).
175 Pool<Event>::Iterator itKillEvent; ///< Event which caused this voice to be killed
176 int SynthesisMode;
177 float fFinalCutoff;
178 float fFinalResonance;
179 gig::SynthesisParam finalSynthesisParameters;
180 gig::Loop loop;
181 RTList<Event>* pGroupEvents; ///< Events directed to an exclusive group
182
183 EqSupport* pEq; ///< Used for per voice equalization
184 bool bEqSupport;
185
186 void PrintEqInfo() {
187 if (!bEqSupport || pEq == NULL) {
188 dmsg(1,("EQ support: no\n"));
189 } else {
190 pEq->PrintInfo();
191 }
192 }
193
194 virtual AbstractEngine* GetEngine() = 0;
195 virtual SampleInfo GetSampleInfo() = 0;
196 virtual RegionInfo GetRegionInfo() = 0;
197 virtual InstrumentInfo GetInstrumentInfo() = 0;
198
199 /**
200 * Most of the important members of the voice are set when the voice
201 * is triggered (like pEngineChannel, pRegion, pSample, etc).
202 * This method is called after these members are set and before
203 * the voice is actually triggered.
204 * Override this method if you need to do some additional
205 * initialization which depends on these members before the voice
206 * is triggered.
207 */
208 virtual void AboutToTrigger() { }
209
210 virtual bool EG1Finished();
211
212 /**
213 * Gets the sample cache size in bytes.
214 */
215 virtual unsigned long GetSampleCacheSize() = 0;
216
217 /**
218 * Because in most cases we cache part of the sample in RAM, if the
219 * offset is too big (will extend beyond the RAM cache if the cache contains
220 * the beginning of the sample) we should cache in the RAM buffer not the
221 * beginning of the sample but a part that starts from the sample offset point.
222 * In that case the current sample position should start from zero (Pos).
223 * When the offset fits into RAM buffer or the whole sample is cached
224 * in RAM, Pos should contain the actual offset.
225 * We don't trim the sample because it might have a defined
226 * loop start point before the start point of the playback.
227 */
228 virtual void SetSampleStartOffset();
229
230 /**
231 * Returns the correct amplitude factor for the given \a MIDIKeyVelocity.
232 * All involved parameters (VelocityResponseCurve, VelocityResponseDepth
233 * and VelocityResponseCurveScaling) involved are taken into account to
234 * calculate the amplitude factor. Use this method when a key was
235 * triggered to get the volume with which the sample should be played
236 * back.
237 *
238 * @param MIDIKeyVelocity MIDI velocity value of the triggered key (between 0 and 127)
239 * @returns amplitude factor (between 0.0 and 1.0)
240 */
241 virtual double GetVelocityAttenuation(uint8_t MIDIKeyVelocity) = 0;
242
243 virtual double GetSampleAttenuation() = 0;
244
245 virtual double CalculateVolume(double velocityAttenuation);
246
247 virtual float GetReleaseTriggerAttenuation(float noteLength);
248
249 /**
250 * Get starting crossfade volume level
251 */
252 virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0;
253
254 virtual MidiKeyBase* GetMidiKeyInfo(int MIDIKey) = 0;
255
256 virtual int OrderNewStream() = 0;
257
258 virtual PitchInfo CalculatePitchInfo(int PitchBend);
259
260 // TODO: cleanup the interface. The following two methods
261 // are maybe not neccessary after the TriggerEG1 method
262 // was added.
263
264 /**
265 * Get current value of EG1 controller.
266 */
267 virtual double GetEG1ControllerValue(uint8_t MIDIKeyVelocity) = 0;
268
269 /**
270 * Calculate influence of EG1 controller on EG1's parameters.
271 */
272 virtual EGInfo CalculateEG1ControllerInfluence(double eg1ControllerValue) = 0;
273
274 // TODO: cleanup the interface. The velrelase and
275 // velocityAttenuation parameters are perhaps too gig
276 // specific.
277 /**
278 * Trigger the amplitude envelope generator.
279 */
280 virtual void TriggerEG1(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;
281
282 /**
283 * Get current value of EG2 controller.
284 */
285 virtual double GetEG2ControllerValue(uint8_t MIDIKeyVelocity) = 0;
286
287 /**
288 * Calculate influence of EG2 controller on EG2's parameters.
289 */
290 virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) = 0;
291
292 virtual void TriggerEG2(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;
293
294 virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) = 0;
295 virtual float CalculateFinalCutoff(float cutoffBase) = 0;
296
297 virtual void InitLFO1() = 0;
298 virtual void InitLFO2() = 0;
299 virtual void InitLFO3() = 0;
300
301 virtual uint8_t GetVCFCutoffCtrl() = 0;
302 virtual uint8_t GetVCFResonanceCtrl() = 0;
303 virtual uint8_t CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) = 0;
304
305 virtual void GetFirstEventOnKey(uint8_t MIDIKey, RTList<Event>::Iterator& itEvent) = 0;
306 virtual void ProcessCCEvent(RTList<Event>::Iterator& itEvent) = 0;
307 virtual void ProcessChannelPressureEvent(RTList<Event>::Iterator& itEvent) = 0;
308 virtual void ProcessPolyphonicKeyPressureEvent(RTList<Event>::Iterator& itEvent) = 0;
309 virtual void ProcessCutoffEvent(RTList<Event>::Iterator& itEvent) = 0;
310 virtual double GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0;
311
312 virtual unsigned long GetNoteOnTime(int MIDIKey) = 0;
313
314 virtual void ProcessGroupEvent(RTList<Event>::Iterator& itEvent) = 0;
315 void EnterReleaseStage();
316
317 virtual int CalculatePan(uint8_t pan) = 0;
318 };
319 } // namespace LinuxSampler
320
321 #endif /* __LS_ABSTRACTVOICE_H__ */

  ViewVC Help
Powered by ViewVC