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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 287 - (hide annotations) (download) (as text)
Sat Oct 16 17:38:03 2004 UTC (19 years, 6 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 17838 byte(s)
* fixed segfault which occured whenever a voice stole a voice and was in
  turn killed in the same audio fragment, to fix that the MIDI key
  informations are now updated only after all voices were processed

1 schoenebeck 53 /***************************************************************************
2     * *
3     * LinuxSampler - modular, streaming capable sampler *
4     * *
5 schoenebeck 56 * Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6 schoenebeck 53 * *
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 schoenebeck 273 #include "../../common/Pool.h"
35 schoenebeck 203 #include "../../drivers/audio/AudioOutputDevice.h"
36 schoenebeck 53 #include "../../lib/fileloader/libgig/gig.h"
37 schoenebeck 80 #include "../common/BiquadFilter.h"
38 schoenebeck 53 #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 schoenebeck 80 #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 schoenebeck 53 #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 schoenebeck 242 // Types
84     enum type_t {
85     type_normal,
86     type_release_trigger_required, ///< If the key of this voice will be released, it causes a release triggered voice to be spawned
87     type_release_trigger ///< Release triggered voice which cannot be killed by releasing its key
88     };
89    
90 schoenebeck 53 // Attributes
91 schoenebeck 242 type_t Type; ///< Voice Type
92 schoenebeck 53 int MIDIKey; ///< MIDI key number of the key that triggered the voice
93 schoenebeck 239 uint KeyGroup;
94 schoenebeck 53 DiskThread* pDiskThread; ///< Pointer to the disk thread, to be able to order a disk stream and later to delete the stream again
95 schoenebeck 285 RTList<Voice>::Iterator itChildVoice; ///< Points to the next layer voice (if any). This field is currently only used by the voice stealing algorithm.
96 schoenebeck 53
97     // Methods
98     Voice();
99     ~Voice();
100 schoenebeck 271 void Kill(Pool<Event>::Iterator& itKillEvent);
101 schoenebeck 53 void Render(uint Samples);
102     void Reset();
103     void SetOutput(AudioOutputDevice* pAudioOutputDevice);
104     void SetEngine(Engine* pEngine);
105 schoenebeck 287 int Trigger(Pool<Event>::Iterator& itNoteOnEvent, int PitchBend, ::gig::Instrument* pInstrument, int iLayer, bool ReleaseTriggerVoice, bool VoiceStealing);
106 schoenebeck 285 inline bool IsActive() { return PlaybackState; }
107 schoenebeck 53 private:
108     // Types
109     enum playback_state_t {
110 schoenebeck 285 playback_state_end = 0,
111     playback_state_ram = 1,
112     playback_state_disk = 2
113 schoenebeck 53 };
114    
115     // Attributes
116     gig::Engine* pEngine; ///< Pointer to the sampler engine, to be able to access the event lists.
117     float Volume; ///< Volume level of the voice
118 schoenebeck 245 float PanLeft;
119     float PanRight;
120 schoenebeck 236 float CrossfadeVolume; ///< Current attenuation level caused by a crossfade (only if a crossfade is defined of course)
121 schoenebeck 53 double Pos; ///< Current playback position in sample
122     double PitchBase; ///< Basic pitch depth, stays the same for the whole life time of the voice
123     double PitchBend; ///< Current pitch value of the pitchbend wheel
124     ::gig::Sample* pSample; ///< Pointer to the sample to be played back
125     ::gig::Region* pRegion; ///< Pointer to the articulation information of the respective keyboard region of this voice
126 schoenebeck 236 ::gig::DimensionRegion* pDimRgn; ///< Pointer to the articulation information of current dimension region of this voice
127 schoenebeck 53 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
128     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
129     Stream::reference_t DiskStreamRef; ///< Reference / link to the disk stream
130     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.
131     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
132     int LoopCyclesLeft; ///< In case there is a RAMLoop and it's not an endless loop; reflects number of loop cycles left to be passed
133     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
134     EGADSR* pEG1; ///< Envelope Generator 1 (Amplification)
135     EGADSR* pEG2; ///< Envelope Generator 2 (Filter cutoff frequency)
136     EGDecay* pEG3; ///< Envelope Generator 3 (Pitch)
137     Filter FilterLeft;
138     Filter FilterRight;
139     midi_ctrl VCFCutoffCtrl;
140     midi_ctrl VCFResonanceCtrl;
141     int FilterUpdateCounter; ///< Used to update filter parameters all FILTER_UPDATE_PERIOD samples
142     static const float FILTER_CUTOFF_COEFF;
143 schoenebeck 80 static const int FILTER_UPDATE_MASK;
144 schoenebeck 53 VCAManipulator* pVCAManipulator;
145     VCFCManipulator* pVCFCManipulator;
146     VCOManipulator* pVCOManipulator;
147     LFO<gig::VCAManipulator>* pLFO1; ///< Low Frequency Oscillator 1 (Amplification)
148     LFO<gig::VCFCManipulator>* pLFO2; ///< Low Frequency Oscillator 2 (Filter cutoff frequency)
149     LFO<gig::VCOManipulator>* pLFO3; ///< Low Frequency Oscillator 3 (Pitch)
150 schoenebeck 271 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).
151 schoenebeck 287 public: // FIXME: just made public for debugging (sanity check in Engine::RenderAudio()), should be changed to private before the final release
152 schoenebeck 271 Pool<Event>::Iterator itKillEvent; ///< Event which caused this voice to be killed
153 schoenebeck 287 private:
154 schoenebeck 53
155 schoenebeck 287
156 schoenebeck 53 // Static Methods
157     static float CalculateFilterCutoffCoeff();
158 schoenebeck 80 static int CalculateFilterUpdateMask();
159 schoenebeck 53
160     // Methods
161 schoenebeck 285 void KillImmediately();
162 schoenebeck 53 void ProcessEvents(uint Samples);
163 schoenebeck 80 #if ENABLE_FILTER
164     void CalculateBiquadParameters(uint Samples);
165     #endif // ENABLE_FILTER
166 schoenebeck 245 void InterpolateNoLoop(uint Samples, sample_t* pSrc, uint Skip);
167 schoenebeck 53 void InterpolateAndLoop(uint Samples, sample_t* pSrc, uint Skip);
168 schoenebeck 245
169     inline void InterpolateMono(sample_t* pSrc, int& i) {
170     InterpolateOneStep_Mono(pSrc, i,
171     pEngine->pSynthesisParameters[Event::destination_vca][i] * PanLeft,
172     pEngine->pSynthesisParameters[Event::destination_vca][i] * PanRight,
173     pEngine->pSynthesisParameters[Event::destination_vco][i],
174     pEngine->pBasicFilterParameters[i],
175     pEngine->pMainFilterParameters[i]);
176     }
177    
178     inline void InterpolateStereo(sample_t* pSrc, int& i) {
179     InterpolateOneStep_Stereo(pSrc, i,
180     pEngine->pSynthesisParameters[Event::destination_vca][i] * PanLeft,
181     pEngine->pSynthesisParameters[Event::destination_vca][i] * PanRight,
182     pEngine->pSynthesisParameters[Event::destination_vco][i],
183     pEngine->pBasicFilterParameters[i],
184     pEngine->pMainFilterParameters[i]);
185     }
186    
187     inline void InterpolateOneStep_Stereo(sample_t* pSrc, int& i, float volume_left, float volume_right, float& pitch, biquad_param_t& bq_base, biquad_param_t& bq_main) {
188 schoenebeck 53 int pos_int = RTMath::DoubleToInt(this->Pos); // integer position
189     float pos_fract = this->Pos - pos_int; // fractional part of position
190     pos_int <<= 1;
191    
192     #if USE_LINEAR_INTERPOLATION
193     #if ENABLE_FILTER
194     // left channel
195 schoenebeck 245 pEngine->pOutputLeft[i] += this->FilterLeft.Apply(&bq_base, &bq_main, volume_left * (pSrc[pos_int] + pos_fract * (pSrc[pos_int+2] - pSrc[pos_int])));
196 schoenebeck 53 // right channel
197 schoenebeck 245 pEngine->pOutputRight[i++] += this->FilterRight.Apply(&bq_base, &bq_main, volume_right * (pSrc[pos_int+1] + pos_fract * (pSrc[pos_int+3] - pSrc[pos_int+1])));
198 schoenebeck 53 #else // no filter
199     // left channel
200 schoenebeck 245 pEngine->pOutputLeft[i] += volume_left * (pSrc[pos_int] + pos_fract * (pSrc[pos_int+2] - pSrc[pos_int]));
201 schoenebeck 53 // right channel
202 schoenebeck 245 pEngine->pOutputRight[i++] += volume_right * (pSrc[pos_int+1] + pos_fract * (pSrc[pos_int+3] - pSrc[pos_int+1]));
203 schoenebeck 53 #endif // ENABLE_FILTER
204     #else // polynomial interpolation
205     // calculate left channel
206     float xm1 = pSrc[pos_int];
207     float x0 = pSrc[pos_int+2];
208     float x1 = pSrc[pos_int+4];
209     float x2 = pSrc[pos_int+6];
210 letz 99 float a = (3.0f * (x0 - x1) - xm1 + x2) * 0.5f;
211     float b = 2.0f * x1 + xm1 - (5.0f * x0 + x2) * 0.5f;
212     float c = (x1 - xm1) * 0.5f;
213 schoenebeck 53 #if ENABLE_FILTER
214 schoenebeck 245 pEngine->pOutputLeft[i] += this->FilterLeft.Apply(&bq_base, &bq_main, volume_left * ((((a * pos_fract) + b) * pos_fract + c) * pos_fract + x0));
215 schoenebeck 53 #else // no filter
216 schoenebeck 245 pEngine->pOutputLeft[i] += volume_left * ((((a * pos_fract) + b) * pos_fract + c) * pos_fract + x0);
217 schoenebeck 53 #endif // ENABLE_FILTER
218    
219     //calculate right channel
220     xm1 = pSrc[pos_int+1];
221     x0 = pSrc[pos_int+3];
222     x1 = pSrc[pos_int+5];
223     x2 = pSrc[pos_int+7];
224 letz 99 a = (3.0f * (x0 - x1) - xm1 + x2) * 0.5f;
225     b = 2.0f * x1 + xm1 - (5.0f * x0 + x2) * 0.5f;
226     c = (x1 - xm1) * 0.5f;
227 schoenebeck 53 #if ENABLE_FILTER
228 schoenebeck 245 pEngine->pOutputRight[i++] += this->FilterRight.Apply(&bq_base, &bq_main, volume_right * ((((a * pos_fract) + b) * pos_fract + c) * pos_fract + x0));
229 schoenebeck 53 #else // no filter
230 schoenebeck 245 pEngine->pOutputRight[i++] += volume_right * ((((a * pos_fract) + b) * pos_fract + c) * pos_fract + x0);
231 schoenebeck 53 #endif // ENABLE_FILTER
232     #endif // USE_LINEAR_INTERPOLATION
233    
234     this->Pos += pitch;
235     }
236 schoenebeck 97
237 schoenebeck 245 inline void InterpolateOneStep_Mono(sample_t* pSrc, int& i, float volume_left, float volume_right, float& pitch, biquad_param_t& bq_base, biquad_param_t& bq_main) {
238 schoenebeck 53 int pos_int = RTMath::DoubleToInt(this->Pos); // integer position
239     float pos_fract = this->Pos - pos_int; // fractional part of position
240    
241     #if USE_LINEAR_INTERPOLATION
242 schoenebeck 245 float sample_point = pSrc[pos_int] + pos_fract * (pSrc[pos_int+1] - pSrc[pos_int]);
243 schoenebeck 53 #else // polynomial interpolation
244     float xm1 = pSrc[pos_int];
245     float x0 = pSrc[pos_int+1];
246     float x1 = pSrc[pos_int+2];
247     float x2 = pSrc[pos_int+3];
248 letz 99 float a = (3.0f * (x0 - x1) - xm1 + x2) * 0.5f;
249     float b = 2.0f * x1 + xm1 - (5.0f * x0 + x2) * 0.5f;
250     float c = (x1 - xm1) * 0.5f;
251 schoenebeck 245 float sample_point = (((a * pos_fract) + b) * pos_fract + c) * pos_fract + x0;
252 schoenebeck 53 #endif // USE_LINEAR_INTERPOLATION
253    
254     #if ENABLE_FILTER
255 schoenebeck 80 sample_point = this->FilterLeft.Apply(&bq_base, &bq_main, sample_point);
256 schoenebeck 53 #endif // ENABLE_FILTER
257    
258 schoenebeck 245 pEngine->pOutputLeft[i] += sample_point * volume_left;
259     pEngine->pOutputRight[i++] += sample_point * volume_right;
260 schoenebeck 53
261     this->Pos += pitch;
262     }
263 schoenebeck 97
264 schoenebeck 236 inline float CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) {
265     return (CrossfadeControllerValue <= pDimRgn->Crossfade.in_start) ? 0.0f
266     : (CrossfadeControllerValue < pDimRgn->Crossfade.in_end) ? float(CrossfadeControllerValue - pDimRgn->Crossfade.in_start) / float(pDimRgn->Crossfade.in_end - pDimRgn->Crossfade.in_start)
267     : (CrossfadeControllerValue <= pDimRgn->Crossfade.out_start) ? 1.0f
268     : (CrossfadeControllerValue < pDimRgn->Crossfade.out_end) ? float(CrossfadeControllerValue - pDimRgn->Crossfade.out_start) / float(pDimRgn->Crossfade.out_end - pDimRgn->Crossfade.out_start)
269     : 0.0f;
270     }
271    
272 schoenebeck 53 inline float Constrain(float ValueToCheck, float Min, float Max) {
273     if (ValueToCheck > Max) ValueToCheck = Max;
274     else if (ValueToCheck < Min) ValueToCheck = Min;
275     return ValueToCheck;
276     }
277     };
278    
279     }} // namespace LinuxSampler::gig
280    
281     #endif // __LS_GIG_VOICE_H__

  ViewVC Help
Powered by ViewVC