/[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 239 - (show annotations) (download) (as text)
Sun Sep 12 14:48:19 2004 UTC (16 years, 1 month ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 15809 byte(s)
* implemented key groups (a.k.a exclusive groups) which is important for
  drum patches and monphonic instruments
* src/engines/gig/Engine.cpp: bugfix in ProcessNoteOn() - did not always
  stick the note on event to the respective key's own event list although
  e.g. the EGADRS expects it to find there

1 /***************************************************************************
2 * *
3 * LinuxSampler - modular, streaming capable sampler *
4 * *
5 * Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6 * *
7 * This program is free software; you can redistribute it and/or modify *
8 * it under the terms of the GNU General Public License as published by *
9 * the Free Software Foundation; either version 2 of the License, or *
10 * (at your option) any later version. *
11 * *
12 * This program is distributed in the hope that it will be useful, *
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
15 * GNU General Public License for more details. *
16 * *
17 * You should have received a copy of the GNU General Public License *
18 * along with this program; if not, write to the Free Software *
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
20 * MA 02111-1307 USA *
21 ***************************************************************************/
22
23 #ifndef __LS_GIG_VOICE_H__
24 #define __LS_GIG_VOICE_H__
25
26 #include "../../common/global.h"
27
28 #if DEBUG_HEADERS
29 # warning Voice.h included
30 #endif // DEBUG_HEADERS
31
32 #include "../../common/RTMath.h"
33 #include "../../common/RingBuffer.h"
34 #include "../../common/RTELMemoryPool.h"
35 #include "../../drivers/audio/AudioOutputDevice.h"
36 #include "../../lib/fileloader/libgig/gig.h"
37 #include "../common/BiquadFilter.h"
38 #include "Engine.h"
39 #include "Stream.h"
40 #include "DiskThread.h"
41
42 #include "EGDecay.h"
43 #include "Filter.h"
44 #include "../common/LFO.h"
45
46 #define USE_LINEAR_INTERPOLATION 0 ///< set to 0 if you prefer cubic interpolation (slower, better quality)
47 #define ENABLE_FILTER 1 ///< if set to 0 then filter (VCF) code is ignored on compile time
48 #define FILTER_UPDATE_PERIOD 64 ///< amount of sample points after which filter parameters (cutoff, resonance) are going to be updated (higher value means less CPU load, but also worse parameter resolution, this value will be aligned to a power of two)
49 #define FORCE_FILTER_USAGE 0 ///< if set to 1 then filter is always used, if set to 0 filter is used only in case the instrument file defined one
50 #define FILTER_CUTOFF_MAX 10000.0f ///< maximum cutoff frequency (10kHz)
51 #define FILTER_CUTOFF_MIN 100.0f ///< minimum cutoff frequency (100Hz)
52
53 // Uncomment following line to override external cutoff controller
54 //#define OVERRIDE_FILTER_CUTOFF_CTRL 1 ///< set to an arbitrary MIDI control change controller (e.g. 1 for 'modulation wheel')
55
56 // Uncomment following line to override external resonance controller
57 //#define OVERRIDE_FILTER_RES_CTRL 91 ///< set to an arbitrary MIDI control change controller (e.g. 91 for 'effect 1 depth')
58
59 // Uncomment following line to override filter type
60 //#define OVERRIDE_FILTER_TYPE ::gig::vcf_type_lowpass ///< either ::gig::vcf_type_lowpass, ::gig::vcf_type_bandpass or ::gig::vcf_type_highpass
61
62 namespace LinuxSampler { namespace gig {
63
64 class Engine;
65 class EGADSR;
66 class VCAManipulator;
67 class VCFCManipulator;
68 class VCOManipulator;
69
70 /// Reflects a MIDI controller
71 struct midi_ctrl {
72 uint8_t controller; ///< MIDI control change controller number
73 uint8_t value; ///< Current MIDI controller value
74 float fvalue; ///< Transformed / effective value (e.g. volume level or filter cutoff frequency)
75 };
76
77 /** Gig Voice
78 *
79 * Renders a voice for the Gigasampler format.
80 */
81 class Voice {
82 public:
83 // Attributes
84 int MIDIKey; ///< MIDI key number of the key that triggered the voice
85 uint KeyGroup;
86 DiskThread* pDiskThread; ///< Pointer to the disk thread, to be able to order a disk stream and later to delete the stream again
87
88 // Methods
89 Voice();
90 ~Voice();
91 void Kill(Event* pKillEvent);
92 void KillImmediately();
93 void Render(uint Samples);
94 void Reset();
95 void SetOutput(AudioOutputDevice* pAudioOutputDevice);
96 void SetEngine(Engine* pEngine);
97 int Trigger(Event* pNoteOnEvent, int PitchBend, ::gig::Instrument* pInstrument, int iLayer = 0);
98 inline bool IsActive() { return Active; }
99 private:
100 // Types
101 enum playback_state_t {
102 playback_state_ram,
103 playback_state_disk,
104 playback_state_end
105 };
106
107 // Attributes
108 gig::Engine* pEngine; ///< Pointer to the sampler engine, to be able to access the event lists.
109 float Volume; ///< Volume level of the voice
110 float CrossfadeVolume; ///< Current attenuation level caused by a crossfade (only if a crossfade is defined of course)
111 double Pos; ///< Current playback position in sample
112 double PitchBase; ///< Basic pitch depth, stays the same for the whole life time of the voice
113 double PitchBend; ///< Current pitch value of the pitchbend wheel
114 ::gig::Sample* pSample; ///< Pointer to the sample to be played back
115 ::gig::Region* pRegion; ///< Pointer to the articulation information of the respective keyboard region of this voice
116 ::gig::DimensionRegion* pDimRgn; ///< Pointer to the articulation information of current dimension region of this voice
117 bool Active; ///< If this voice object is currently in usage
118 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
119 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
120 Stream::reference_t DiskStreamRef; ///< Reference / link to the disk stream
121 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.
122 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
123 int LoopCyclesLeft; ///< In case there is a RAMLoop and it's not an endless loop; reflects number of loop cycles left to be passed
124 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
125 EGADSR* pEG1; ///< Envelope Generator 1 (Amplification)
126 EGADSR* pEG2; ///< Envelope Generator 2 (Filter cutoff frequency)
127 EGDecay* pEG3; ///< Envelope Generator 3 (Pitch)
128 Filter FilterLeft;
129 Filter FilterRight;
130 midi_ctrl VCFCutoffCtrl;
131 midi_ctrl VCFResonanceCtrl;
132 int FilterUpdateCounter; ///< Used to update filter parameters all FILTER_UPDATE_PERIOD samples
133 static const float FILTER_CUTOFF_COEFF;
134 static const int FILTER_UPDATE_MASK;
135 VCAManipulator* pVCAManipulator;
136 VCFCManipulator* pVCFCManipulator;
137 VCOManipulator* pVCOManipulator;
138 LFO<gig::VCAManipulator>* pLFO1; ///< Low Frequency Oscillator 1 (Amplification)
139 LFO<gig::VCFCManipulator>* pLFO2; ///< Low Frequency Oscillator 2 (Filter cutoff frequency)
140 LFO<gig::VCOManipulator>* pLFO3; ///< Low Frequency Oscillator 3 (Pitch)
141 Event* pTriggerEvent; ///< 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).
142 Event* pKillEvent; ///< Event which caused this voice to be killed
143
144 // Static Methods
145 static float CalculateFilterCutoffCoeff();
146 static int CalculateFilterUpdateMask();
147
148 // Methods
149 void ProcessEvents(uint Samples);
150 #if ENABLE_FILTER
151 void CalculateBiquadParameters(uint Samples);
152 #endif // ENABLE_FILTER
153 void Interpolate(uint Samples, sample_t* pSrc, uint Skip);
154 void InterpolateAndLoop(uint Samples, sample_t* pSrc, uint Skip);
155 inline void InterpolateOneStep_Stereo(sample_t* pSrc, int& i, float& effective_volume, float& pitch, biquad_param_t& bq_base, biquad_param_t& bq_main) {
156 int pos_int = RTMath::DoubleToInt(this->Pos); // integer position
157 float pos_fract = this->Pos - pos_int; // fractional part of position
158 pos_int <<= 1;
159
160 #if USE_LINEAR_INTERPOLATION
161 #if ENABLE_FILTER
162 // left channel
163 pEngine->pOutputLeft[i] += this->FilterLeft.Apply(&bq_base, &bq_main, effective_volume * (pSrc[pos_int] + pos_fract * (pSrc[pos_int+2] - pSrc[pos_int])));
164 // right channel
165 pEngine->pOutputRight[i++] += this->FilterRight.Apply(&bq_base, &bq_main, effective_volume * (pSrc[pos_int+1] + pos_fract * (pSrc[pos_int+3] - pSrc[pos_int+1])));
166 #else // no filter
167 // left channel
168 pEngine->pOutputLeft[i] += effective_volume * (pSrc[pos_int] + pos_fract * (pSrc[pos_int+2] - pSrc[pos_int]));
169 // right channel
170 pEngine->pOutputRight[i++] += effective_volume * (pSrc[pos_int+1] + pos_fract * (pSrc[pos_int+3] - pSrc[pos_int+1]));
171 #endif // ENABLE_FILTER
172 #else // polynomial interpolation
173 // calculate left channel
174 float xm1 = pSrc[pos_int];
175 float x0 = pSrc[pos_int+2];
176 float x1 = pSrc[pos_int+4];
177 float x2 = pSrc[pos_int+6];
178 float a = (3.0f * (x0 - x1) - xm1 + x2) * 0.5f;
179 float b = 2.0f * x1 + xm1 - (5.0f * x0 + x2) * 0.5f;
180 float c = (x1 - xm1) * 0.5f;
181 #if ENABLE_FILTER
182 pEngine->pOutputLeft[i] += this->FilterLeft.Apply(&bq_base, &bq_main, effective_volume * ((((a * pos_fract) + b) * pos_fract + c) * pos_fract + x0));
183 #else // no filter
184 pEngine->pOutputLeft[i] += effective_volume * ((((a * pos_fract) + b) * pos_fract + c) * pos_fract + x0);
185 #endif // ENABLE_FILTER
186
187 //calculate right channel
188 xm1 = pSrc[pos_int+1];
189 x0 = pSrc[pos_int+3];
190 x1 = pSrc[pos_int+5];
191 x2 = pSrc[pos_int+7];
192 a = (3.0f * (x0 - x1) - xm1 + x2) * 0.5f;
193 b = 2.0f * x1 + xm1 - (5.0f * x0 + x2) * 0.5f;
194 c = (x1 - xm1) * 0.5f;
195 #if ENABLE_FILTER
196 pEngine->pOutputRight[i++] += this->FilterRight.Apply(&bq_base, &bq_main, effective_volume * ((((a * pos_fract) + b) * pos_fract + c) * pos_fract + x0));
197 #else // no filter
198 pEngine->pOutputRight[i++] += effective_volume * ((((a * pos_fract) + b) * pos_fract + c) * pos_fract + x0);
199 #endif // ENABLE_FILTER
200 #endif // USE_LINEAR_INTERPOLATION
201
202 this->Pos += pitch;
203 }
204
205 inline void InterpolateOneStep_Mono(sample_t* pSrc, int& i, float& effective_volume, float& pitch, biquad_param_t& bq_base, biquad_param_t& bq_main) {
206 int pos_int = RTMath::DoubleToInt(this->Pos); // integer position
207 float pos_fract = this->Pos - pos_int; // fractional part of position
208
209 #if USE_LINEAR_INTERPOLATION
210 float sample_point = effective_volume * (pSrc[pos_int] + pos_fract * (pSrc[pos_int+1] - pSrc[pos_int]));
211 #else // polynomial interpolation
212 float xm1 = pSrc[pos_int];
213 float x0 = pSrc[pos_int+1];
214 float x1 = pSrc[pos_int+2];
215 float x2 = pSrc[pos_int+3];
216 float a = (3.0f * (x0 - x1) - xm1 + x2) * 0.5f;
217 float b = 2.0f * x1 + xm1 - (5.0f * x0 + x2) * 0.5f;
218 float c = (x1 - xm1) * 0.5f;
219 float sample_point = effective_volume * ((((a * pos_fract) + b) * pos_fract + c) * pos_fract + x0);
220 #endif // USE_LINEAR_INTERPOLATION
221
222 #if ENABLE_FILTER
223 sample_point = this->FilterLeft.Apply(&bq_base, &bq_main, sample_point);
224 #endif // ENABLE_FILTER
225
226 pEngine->pOutputLeft[i] += sample_point;
227 pEngine->pOutputRight[i++] += sample_point;
228
229 this->Pos += pitch;
230 }
231
232 inline float CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) {
233 return (CrossfadeControllerValue <= pDimRgn->Crossfade.in_start) ? 0.0f
234 : (CrossfadeControllerValue < pDimRgn->Crossfade.in_end) ? float(CrossfadeControllerValue - pDimRgn->Crossfade.in_start) / float(pDimRgn->Crossfade.in_end - pDimRgn->Crossfade.in_start)
235 : (CrossfadeControllerValue <= pDimRgn->Crossfade.out_start) ? 1.0f
236 : (CrossfadeControllerValue < pDimRgn->Crossfade.out_end) ? float(CrossfadeControllerValue - pDimRgn->Crossfade.out_start) / float(pDimRgn->Crossfade.out_end - pDimRgn->Crossfade.out_start)
237 : 0.0f;
238 }
239
240 inline float Constrain(float ValueToCheck, float Min, float Max) {
241 if (ValueToCheck > Max) ValueToCheck = Max;
242 else if (ValueToCheck < Min) ValueToCheck = Min;
243 return ValueToCheck;
244 }
245 };
246
247 }} // namespace LinuxSampler::gig
248
249 #endif // __LS_GIG_VOICE_H__

  ViewVC Help
Powered by ViewVC