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

  ViewVC Help
Powered by ViewVC