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

Contents of /linuxsampler/trunk/src/engines/gig/Voice.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 832 - (show annotations) (download) (as text)
Sun Feb 5 10:24:05 2006 UTC (18 years, 2 months ago) by persson
File MIME type: text/x-c++hdr
File size: 13465 byte(s)
* added smoothing of volume changes caused by control change messages
* fine tuning of the crossfade volume curve

1 /***************************************************************************
2 * *
3 * LinuxSampler - modular, streaming capable sampler *
4 * *
5 * Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6 * Copyright (C) 2005, 2006 Christian Schoenebeck *
7 * *
8 * This program is free software; you can redistribute it and/or modify *
9 * it under the terms of the GNU General Public License as published by *
10 * the Free Software Foundation; either version 2 of the License, or *
11 * (at your option) any later version. *
12 * *
13 * This program is distributed in the hope that it will be useful, *
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16 * GNU General Public License for more details. *
17 * *
18 * You should have received a copy of the GNU General Public License *
19 * along with this program; if not, write to the Free Software *
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21 * MA 02111-1307 USA *
22 ***************************************************************************/
23
24 #ifndef __LS_GIG_VOICE_H__
25 #define __LS_GIG_VOICE_H__
26
27 #include "../../common/global.h"
28
29 #include <gig.h>
30
31 #include "../../common/RTMath.h"
32 #include "../../common/RingBuffer.h"
33 #include "../../common/Pool.h"
34 #include "../../drivers/audio/AudioOutputDevice.h"
35 #include "../common/BiquadFilter.h"
36 #include "Engine.h"
37 #include "EngineChannel.h"
38 #include "Stream.h"
39 #include "DiskThread.h"
40 #include "EGADSR.h"
41 #include "EGDecay.h"
42 #include "Filter.h"
43 #include "../common/LFOBase.h"
44 #include "SynthesisParam.h"
45 #include "SmoothVolume.h"
46
47 // include the appropriate (unsigned) triangle LFO implementation
48 #if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
49 # include "../common/LFOTriangleIntMath.h"
50 #elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
51 # include "../common/LFOTriangleIntAbsMath.h"
52 #elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
53 # include "../common/LFOTriangleDiHarmonic.h"
54 #else
55 # error "Unknown or no (unsigned) triangle LFO implementation selected!"
56 #endif
57
58 // include the appropriate (signed) triangle LFO implementation
59 #if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
60 # include "../common/LFOTriangleIntMath.h"
61 #elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
62 # include "../common/LFOTriangleIntAbsMath.h"
63 #elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
64 # include "../common/LFOTriangleDiHarmonic.h"
65 #else
66 # error "Unknown or no (signed) triangle LFO implementation selected!"
67 #endif
68
69 namespace LinuxSampler { namespace gig {
70
71 class Engine;
72
73 /// Reflects a MIDI controller
74 struct midi_ctrl {
75 uint8_t controller; ///< MIDI control change controller number
76 uint8_t value; ///< Current MIDI controller value
77 float fvalue; ///< Transformed / effective value (e.g. volume level or filter cutoff frequency)
78 };
79
80 #if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
81 typedef LFOTriangleIntMath<range_unsigned> LFOUnsigned;
82 #elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
83 typedef LFOTriangleIntAbsMath<range_unsigned> LFOUnsigned;
84 #elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
85 typedef LFOTriangleDiHarmonic<range_unsigned> LFOUnsigned;
86 #endif
87
88 #if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
89 typedef LFOTriangleIntMath<range_signed> LFOSigned;
90 #elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
91 typedef LFOTriangleIntAbsMath<range_signed> LFOSigned;
92 #elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
93 typedef LFOTriangleDiHarmonic<range_signed> LFOSigned;
94 #endif
95
96 /** Gig Voice
97 *
98 * Renders a voice for the Gigasampler format.
99 */
100 class Voice {
101 public:
102 // Types
103 enum type_t {
104 type_normal,
105 type_release_trigger_required, ///< If the key of this voice will be released, it causes a release triggered voice to be spawned
106 type_release_trigger ///< Release triggered voice which cannot be killed by releasing its key
107 };
108
109 // Attributes
110 type_t Type; ///< Voice Type
111 int MIDIKey; ///< MIDI key number of the key that triggered the voice
112 uint KeyGroup;
113 DiskThread* pDiskThread; ///< Pointer to the disk thread, to be able to order a disk stream and later to delete the stream again
114
115 // Methods
116 Voice();
117 virtual ~Voice();
118 void Kill(Pool<Event>::Iterator& itKillEvent);
119 void Render(uint Samples);
120 void Reset();
121 void SetOutput(AudioOutputDevice* pAudioOutputDevice);
122 void SetEngine(Engine* pEngine);
123 int Trigger(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent, int PitchBend, ::gig::DimensionRegion* pDimRgn, type_t VoiceType, int iKeyGroup);
124 inline bool IsActive() { return PlaybackState; }
125 inline bool IsStealable() { return !itKillEvent && PlaybackState >= playback_state_ram; }
126 void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);
127
128 //private:
129 // Types
130 enum playback_state_t {
131 playback_state_end = 0,
132 playback_state_init = 1,
133 playback_state_ram = 2,
134 playback_state_disk = 3
135 };
136
137 // Attributes
138 EngineChannel* pEngineChannel;
139 Engine* pEngine; ///< Pointer to the sampler engine, to be able to access the event lists.
140 float VolumeLeft; ///< Left channel volume. This factor is calculated when the voice is triggered and doesn't change after that.
141 float VolumeRight; ///< Right channel volume. This factor is calculated when the voice is triggered and doesn't change after that.
142 SmoothVolume CrossfadeSmoother; ///< Crossfade volume, updated by crossfade CC events
143 SmoothVolume VolumeSmoother; ///< Volume, updated by CC 7 (volume) events
144 SmoothVolume PanLeftSmoother; ///< Left channel volume, updated by CC 10 (pan) events
145 SmoothVolume PanRightSmoother; ///< Right channel volume, updated by CC 10 (pan) events
146 double Pos; ///< Current playback position in sample
147 float PitchBase; ///< Basic pitch depth, stays the same for the whole life time of the voice
148 float PitchBend; ///< Current pitch value of the pitchbend wheel
149 float CutoffBase; ///< Cutoff frequency before control change, EG and LFO are applied
150 ::gig::Sample* pSample; ///< Pointer to the sample to be played back
151 ::gig::DimensionRegion* pDimRgn; ///< Pointer to the articulation information of current dimension region of this voice
152 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
153 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
154 Stream::reference_t DiskStreamRef; ///< Reference / link to the disk stream
155 int RealSampleWordsLeftToRead; ///< Number of samples left to read, not including the silence added for the interpolator
156 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.
157 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
158 //uint LoopCyclesLeft; ///< In case there is a RAMLoop and it's not an endless loop; reflects number of loop cycles left to be passed
159 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
160 EGADSR EG1; ///< Envelope Generator 1 (Amplification)
161 EGADSR EG2; ///< Envelope Generator 2 (Filter cutoff frequency)
162 EGDecay EG3; ///< Envelope Generator 3 (Pitch)
163 midi_ctrl VCFCutoffCtrl;
164 midi_ctrl VCFResonanceCtrl;
165 static const float FILTER_CUTOFF_COEFF;
166 LFOUnsigned* pLFO1; ///< Low Frequency Oscillator 1 (Amplification)
167 LFOUnsigned* pLFO2; ///< Low Frequency Oscillator 2 (Filter cutoff frequency)
168 LFOSigned* pLFO3; ///< Low Frequency Oscillator 3 (Pitch)
169 bool bLFO1Enabled; ///< Should we use the Amplitude LFO for this voice?
170 bool bLFO2Enabled; ///< Should we use the Filter Cutoff LFO for this voice?
171 bool bLFO3Enabled; ///< Should we use the Pitch LFO for this voice?
172 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).
173 //public: // FIXME: just made public for debugging (sanity check in Engine::RenderAudio()), should be changed to private before the final release
174 Pool<Event>::Iterator itKillEvent; ///< Event which caused this voice to be killed
175 //private:
176 int SynthesisMode;
177 float fFinalCutoff;
178 float fFinalResonance;
179 SynthesisParam finalSynthesisParameters;
180 Loop loop;
181
182 // Static Methods
183 static float CalculateFilterCutoffCoeff();
184
185 // Methods
186 void KillImmediately();
187 void ProcessEvents(uint Samples);
188 void Synthesize(uint Samples, sample_t* pSrc, uint Skip);
189 void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);
190 void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);
191 void processPitchEvent(RTList<Event>::Iterator& itEvent);
192 void processCrossFadeEvent(RTList<Event>::Iterator& itEvent);
193 void processCutoffEvent(RTList<Event>::Iterator& itEvent);
194 void processResonanceEvent(RTList<Event>::Iterator& itEvent);
195
196 inline uint8_t CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) {
197 uint8_t c = std::max(CrossfadeControllerValue, pDimRgn->AttenuationControllerThreshold);
198 c = (!pDimRgn->Crossfade.out_end) ? c /* 0,0,0,0 means no crossfade defined */
199 : (c < pDimRgn->Crossfade.in_end) ?
200 ((c <= pDimRgn->Crossfade.in_start) ? 0
201 : 127 * (c - pDimRgn->Crossfade.in_start) / (pDimRgn->Crossfade.in_end - pDimRgn->Crossfade.in_start))
202 : (c <= pDimRgn->Crossfade.out_start) ? 127
203 : (c < pDimRgn->Crossfade.out_end) ? 127 * (pDimRgn->Crossfade.out_end - c) / (pDimRgn->Crossfade.out_end - pDimRgn->Crossfade.out_start)
204 : 0;
205 return pDimRgn->InvertAttenuationController ? 127 - c : c;
206 }
207
208 inline float Constrain(float ValueToCheck, float Min, float Max) {
209 if (ValueToCheck > Max) ValueToCheck = Max;
210 else if (ValueToCheck < Min) ValueToCheck = Min;
211 return ValueToCheck;
212 }
213 };
214
215 }} // namespace LinuxSampler::gig
216
217 #endif // __LS_GIG_VOICE_H__

  ViewVC Help
Powered by ViewVC