/[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 729 - (show annotations) (download) (as text)
Tue Jul 26 11:18:46 2005 UTC (14 years, 7 months ago) by persson
File MIME type: text/x-c++hdr
File size: 11345 byte(s)
* improved filter cutoff calculation by adding support for the
  following gig parameters: Cutoff freq (used when no cutoff
  controller is defined), Control invert, Minimum cutoff, Velocity
  curve and Velocity range. The keyboard tracking now also scales
  cutoff frequency, not just resonance.

1 /***************************************************************************
2 * *
3 * LinuxSampler - modular, streaming capable sampler *
4 * *
5 * Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6 * Copyright (C) 2005 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 "EngineGlobals.h"
37 #include "Engine.h"
38 #include "EngineChannel.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 namespace LinuxSampler { namespace gig {
47
48 class Engine;
49 class EGADSR;
50 class EGDecay;
51 class VCAManipulator;
52 class VCFCManipulator;
53 class VCOManipulator;
54
55 /// Reflects a MIDI controller
56 struct midi_ctrl {
57 uint8_t controller; ///< MIDI control change controller number
58 uint8_t value; ///< Current MIDI controller value
59 float fvalue; ///< Transformed / effective value (e.g. volume level or filter cutoff frequency)
60 };
61
62 /** Gig Voice
63 *
64 * Renders a voice for the Gigasampler format.
65 */
66 class Voice {
67 public:
68 // Types
69 enum type_t {
70 type_normal,
71 type_release_trigger_required, ///< If the key of this voice will be released, it causes a release triggered voice to be spawned
72 type_release_trigger ///< Release triggered voice which cannot be killed by releasing its key
73 };
74
75 // Attributes
76 type_t Type; ///< Voice Type
77 int MIDIKey; ///< MIDI key number of the key that triggered the voice
78 uint KeyGroup;
79 DiskThread* pDiskThread; ///< Pointer to the disk thread, to be able to order a disk stream and later to delete the stream again
80
81 // Methods
82 Voice();
83 virtual ~Voice();
84 void Kill(Pool<Event>::Iterator& itKillEvent);
85 void Render(uint Samples);
86 void Reset();
87 void SetOutput(AudioOutputDevice* pAudioOutputDevice);
88 void SetEngine(Engine* pEngine);
89 int Trigger(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent, int PitchBend, ::gig::DimensionRegion* pDimRgn, type_t VoiceType, int iKeyGroup);
90 inline bool IsActive() { return PlaybackState; }
91 inline bool IsStealable() { return !itKillEvent && PlaybackState >= playback_state_ram; }
92 //private:
93 // Types
94 enum playback_state_t {
95 playback_state_end = 0,
96 playback_state_init = 1,
97 playback_state_ram = 2,
98 playback_state_disk = 3
99 };
100
101 // Attributes
102 EngineChannel* pEngineChannel;
103 Engine* pEngine; ///< Pointer to the sampler engine, to be able to access the event lists.
104 float Volume; ///< Volume level of the voice
105 float PanLeft;
106 float PanRight;
107 float CrossfadeVolume; ///< Current attenuation level caused by a crossfade (only if a crossfade is defined of course)
108 double Pos; ///< Current playback position in sample
109 float PitchBase; ///< Basic pitch depth, stays the same for the whole life time of the voice
110 float PitchBend; ///< Current pitch value of the pitchbend wheel
111 float CutoffBase; ///< Cutoff frequency before control change, EG and LFO are applied
112 ::gig::Sample* pSample; ///< Pointer to the sample to be played back
113 ::gig::DimensionRegion* pDimRgn; ///< Pointer to the articulation information of current dimension region of this voice
114 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
115 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
116 Stream::reference_t DiskStreamRef; ///< Reference / link to the disk stream
117 int RealSampleWordsLeftToRead; ///< Number of samples left to read, not including the silence added for the interpolator
118 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.
119 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
120 uint LoopCyclesLeft; ///< In case there is a RAMLoop and it's not an endless loop; reflects number of loop cycles left to be passed
121 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
122 EGADSR* pEG1; ///< Envelope Generator 1 (Amplification)
123 EGADSR* pEG2; ///< Envelope Generator 2 (Filter cutoff frequency)
124 EGDecay* pEG3; ///< Envelope Generator 3 (Pitch)
125 Filter FilterLeft;
126 Filter FilterRight;
127 midi_ctrl VCFCutoffCtrl;
128 midi_ctrl VCFResonanceCtrl;
129 int FilterUpdateCounter; ///< Used to update filter parameters all FILTER_UPDATE_PERIOD samples
130 static const float FILTER_CUTOFF_COEFF;
131 static const int FILTER_UPDATE_MASK;
132 VCAManipulator* pVCAManipulator;
133 VCFCManipulator* pVCFCManipulator;
134 VCOManipulator* pVCOManipulator;
135 LFO<gig::VCAManipulator>* pLFO1; ///< Low Frequency Oscillator 1 (Amplification)
136 LFO<gig::VCFCManipulator>* pLFO2; ///< Low Frequency Oscillator 2 (Filter cutoff frequency)
137 LFO<gig::VCOManipulator>* pLFO3; ///< Low Frequency Oscillator 3 (Pitch)
138 bool bLFO1Enabled; ///< Should we use the Amplitude LFO for this voice?
139 bool bLFO2Enabled; ///< Should we use the Filter Cutoff LFO for this voice?
140 bool bLFO3Enabled; ///< Should we use the Pitch LFO for this voice?
141 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).
142 //public: // FIXME: just made public for debugging (sanity check in Engine::RenderAudio()), should be changed to private before the final release
143 Pool<Event>::Iterator itKillEvent; ///< Event which caused this voice to be killed
144 //private:
145 int SynthesisMode;
146
147 // Static Methods
148 static float CalculateFilterCutoffCoeff();
149 static int CalculateFilterUpdateMask();
150
151 // Methods
152 void KillImmediately();
153 void ProcessEvents(uint Samples);
154 void CalculateBiquadParameters(uint Samples);
155 void Synthesize(uint Samples, sample_t* pSrc, uint Skip);
156
157 inline float CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) {
158 float att = (!pDimRgn->Crossfade.out_end) ? CrossfadeControllerValue / 127.0f /* 0,0,0,0 means no crossfade defined */
159 : (CrossfadeControllerValue < pDimRgn->Crossfade.in_end) ?
160 ((CrossfadeControllerValue <= pDimRgn->Crossfade.in_start) ? 0.0f
161 : float(CrossfadeControllerValue - pDimRgn->Crossfade.in_start) / float(pDimRgn->Crossfade.in_end - pDimRgn->Crossfade.in_start))
162 : (CrossfadeControllerValue <= pDimRgn->Crossfade.out_start) ? 1.0f
163 : (CrossfadeControllerValue < pDimRgn->Crossfade.out_end) ? float(pDimRgn->Crossfade.out_end - CrossfadeControllerValue) / float(pDimRgn->Crossfade.out_end - pDimRgn->Crossfade.out_start)
164 : 0.0f;
165 return pDimRgn->InvertAttenuationController ? 1 - att : att;
166 }
167
168 inline float Constrain(float ValueToCheck, float Min, float Max) {
169 if (ValueToCheck > Max) ValueToCheck = Max;
170 else if (ValueToCheck < Min) ValueToCheck = Min;
171 return ValueToCheck;
172 }
173 };
174
175 }} // namespace LinuxSampler::gig
176
177 #endif // __LS_GIG_VOICE_H__

  ViewVC Help
Powered by ViewVC