/[svn]/linuxsampler/trunk/src/engines/common/AbstractVoice.h
ViewVC logotype

Annotation of /linuxsampler/trunk/src/engines/common/AbstractVoice.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2218 - (hide annotations) (download) (as text)
Thu Jul 28 08:05:57 2011 UTC (12 years, 8 months ago) by iliev
File MIME type: text/x-c++hdr
File size: 16006 byte(s)
* sfz engine: use the newly introduced signal units model

1 iliev 2015 /***************************************************************************
2     * *
3     * LinuxSampler - modular, streaming capable sampler *
4     * *
5     * Copyright (C) 2003,2004 by Benno Senoner and Christian Schoenebeck *
6 persson 2055 * Copyright (C) 2005-2008 Christian Schoenebeck *
7 persson 2175 * Copyright (C) 2009-2011 Christian Schoenebeck and Grigor Iliev *
8 iliev 2015 * *
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 persson 2114 #define __LS_ABSTRACTVOICE_H__
27 iliev 2015
28     #include "Voice.h"
29    
30     #include "../../common/global_private.h"
31     #include "../AbstractEngineChannel.h"
32     #include "../common/LFOBase.h"
33     #include "../EngineBase.h"
34 persson 2055 #include "EG.h"
35 iliev 2015 #include "../gig/EGADSR.h"
36     #include "../gig/EGDecay.h"
37     #include "../gig/SmoothVolume.h"
38     #include "../gig/Synthesizer.h"
39     #include "../gig/Profiler.h"
40 iliev 2205 #include "SignalUnitRack.h"
41 iliev 2015
42     // include the appropriate (unsigned) triangle LFO implementation
43     #if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
44     # include "../common/LFOTriangleIntMath.h"
45     #elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
46     # include "../common/LFOTriangleIntAbsMath.h"
47     #elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
48     # include "../common/LFOTriangleDiHarmonic.h"
49     #else
50     # error "Unknown or no (unsigned) triangle LFO implementation selected!"
51     #endif
52    
53     // include the appropriate (signed) triangle LFO implementation
54     #if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
55     # include "../common/LFOTriangleIntMath.h"
56     #elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
57     # include "../common/LFOTriangleIntAbsMath.h"
58     #elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
59     # include "../common/LFOTriangleDiHarmonic.h"
60     #else
61     # error "Unknown or no (signed) triangle LFO implementation selected!"
62     #endif
63    
64     namespace LinuxSampler {
65    
66     #if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
67     typedef LFOTriangleIntMath<range_unsigned> LFOUnsigned;
68     #elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
69     typedef LFOTriangleIntAbsMath<range_unsigned> LFOUnsigned;
70     #elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
71     typedef LFOTriangleDiHarmonic<range_unsigned> LFOUnsigned;
72     #endif
73    
74     #if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
75     typedef LFOTriangleIntMath<range_signed> LFOSigned;
76     #elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
77     typedef LFOTriangleIntAbsMath<range_signed> LFOSigned;
78     #elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
79     typedef LFOTriangleDiHarmonic<range_signed> LFOSigned;
80     #endif
81    
82     class AbstractVoice : public Voice {
83     public:
84 persson 2115 type_t Type; ///< Voice Type (bit field, a voice may have several types)
85 iliev 2015 int MIDIKey; ///< MIDI key number of the key that triggered the voice
86 iliev 2218 uint8_t MIDIVelocity; ///< MIDI velocity of the key that triggered the voice
87 iliev 2217
88     SignalUnitRack* const pSignalUnitRack;
89 iliev 2015
90 iliev 2217 AbstractVoice(SignalUnitRack* pRack);
91 iliev 2015 virtual ~AbstractVoice();
92    
93     inline bool IsActive() { return PlaybackState; }
94     inline bool IsStealable() { return !itKillEvent && PlaybackState >= playback_state_ram; }
95    
96     virtual void Reset();
97    
98     virtual int Trigger (
99     AbstractEngineChannel* pEngineChannel,
100     Pool<Event>::Iterator& itNoteOnEvent,
101     int PitchBend,
102     type_t VoiceType,
103     int iKeyGroup
104     );
105    
106     virtual void Synthesize(uint Samples, sample_t* pSrc, uint Skip);
107 iliev 2205
108     uint GetSampleRate() { return GetEngine()->SampleRate; }
109 iliev 2015
110     void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);
111     void processPitchEvent(RTList<Event>::Iterator& itEvent);
112     void processResonanceEvent(RTList<Event>::Iterator& itEvent);
113     void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);
114 persson 2114 void processGroupEvents(RTList<Event>::Iterator& itEvent, uint End);
115 iliev 2015 void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);
116     void Kill(Pool<Event>::Iterator& itKillEvent);
117    
118     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.
119     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
120     Stream::reference_t DiskStreamRef; ///< Reference / link to the disk stream
121    
122     template<class TV, class TRR, class TR, class TD, class TIM, class TI> friend class EngineBase;
123    
124     protected:
125     SampleInfo SmplInfo;
126     RegionInfo RgnInfo;
127     InstrumentInfo InstrInfo;
128     AbstractEngineChannel* pEngineChannel;
129    
130     double Pos; ///< Current playback position in sample
131     PitchInfo Pitch;
132     float CutoffBase; ///< Cutoff frequency before control change, EG and LFO are applied
133     float VolumeLeft; ///< Left channel volume. This factor is calculated when the voice is triggered and doesn't change after that.
134     float VolumeRight; ///< Right channel volume. This factor is calculated when the voice is triggered and doesn't change after that.
135     gig::SmoothVolume CrossfadeSmoother; ///< Crossfade volume, updated by crossfade CC events
136     gig::SmoothVolume VolumeSmoother; ///< Volume, updated by CC 7 (volume) events
137     gig::SmoothVolume PanLeftSmoother; ///< Left channel volume, updated by CC 10 (pan) events
138     gig::SmoothVolume PanRightSmoother; ///< Right channel volume, updated by CC 10 (pan) events
139     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
140     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
141     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.
142     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
143 persson 2055 EG* pEG1; ///< Envelope Generator 1 (Amplification)
144 persson 2175 EG* pEG2; ///< Envelope Generator 2 (Filter cutoff frequency)
145 persson 2055 gig::EGDecay EG3; ///< Envelope Generator 3 (Pitch) TODO: use common EG instead?
146 iliev 2015 midi_ctrl VCFCutoffCtrl;
147     midi_ctrl VCFResonanceCtrl;
148     LFOUnsigned* pLFO1; ///< Low Frequency Oscillator 1 (Amplification)
149     LFOUnsigned* pLFO2; ///< Low Frequency Oscillator 2 (Filter cutoff frequency)
150     LFOSigned* pLFO3; ///< Low Frequency Oscillator 3 (Pitch)
151     bool bLFO1Enabled; ///< Should we use the Amplitude LFO for this voice?
152     bool bLFO2Enabled; ///< Should we use the Filter Cutoff LFO for this voice?
153     bool bLFO3Enabled; ///< Should we use the Pitch LFO for this voice?
154     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).
155     Pool<Event>::Iterator itKillEvent; ///< Event which caused this voice to be killed
156     int SynthesisMode;
157     float fFinalCutoff;
158     float fFinalResonance;
159     gig::SynthesisParam finalSynthesisParameters;
160     gig::Loop loop;
161 persson 2114 RTList<Event>* pGroupEvents; ///< Events directed to an exclusive group
162 iliev 2015
163     virtual AbstractEngine* GetEngine() = 0;
164     virtual SampleInfo GetSampleInfo() = 0;
165     virtual RegionInfo GetRegionInfo() = 0;
166     virtual InstrumentInfo GetInstrumentInfo() = 0;
167    
168     /**
169 iliev 2205 * Most of the important members of the voice are set when the voice
170     * is triggered (like pEngineChannel, pRegion, pSample, etc).
171     * This method is called after these members are set and before
172     * the voice is actually triggered.
173     * Override this method if you need to do some additional
174     * initialization which depends on these members before the voice
175     * is triggered.
176     */
177     virtual void AboutToTrigger() { }
178    
179     virtual bool EG1Finished();
180    
181     /**
182 iliev 2015 * Gets the sample cache size in bytes.
183     */
184     virtual unsigned long GetSampleCacheSize() = 0;
185 iliev 2216
186     /**
187     * Because in most cases we cache part of the sample in RAM, if the
188     * offset is too big (will extend beyond the RAM cache if the cache contains
189     * the beginning of the sample) we should cache in the RAM buffer not the
190     * beginning of the sample but a part that starts from the sample offset point.
191     * In that case the current sample position should start from zero (Pos).
192     * When the offset fits into RAM buffer or the whole sample is cached
193     * in RAM, Pos should contain the actual offset.
194     * We don't trim the sample because it might have a defined
195     * loop start point before the start point of the playback.
196     */
197     virtual void SetSampleStartOffset();
198 iliev 2015
199     /**
200     * Returns the correct amplitude factor for the given \a MIDIKeyVelocity.
201     * All involved parameters (VelocityResponseCurve, VelocityResponseDepth
202     * and VelocityResponseCurveScaling) involved are taken into account to
203     * calculate the amplitude factor. Use this method when a key was
204     * triggered to get the volume with which the sample should be played
205     * back.
206     *
207     * @param MIDIKeyVelocity MIDI velocity value of the triggered key (between 0 and 127)
208     * @returns amplitude factor (between 0.0 and 1.0)
209     */
210     virtual double GetVelocityAttenuation(uint8_t MIDIKeyVelocity) = 0;
211    
212     virtual double GetSampleAttenuation() = 0;
213    
214     virtual double CalculateVolume(double velocityAttenuation);
215    
216 persson 2061 virtual float GetReleaseTriggerAttenuation(float noteLength);
217    
218 iliev 2015 /**
219     * Get starting crossfade volume level
220     */
221     virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0;
222    
223 schoenebeck 2121 virtual MidiKeyBase* GetMidiKeyInfo(int MIDIKey) = 0;
224    
225 iliev 2015 virtual int OrderNewStream() = 0;
226    
227     virtual PitchInfo CalculatePitchInfo(int PitchBend);
228    
229 persson 2055 // TODO: cleanup the interface. The following two methods
230     // are maybe not neccessary after the TriggerEG1 method
231     // was added.
232    
233 iliev 2015 /**
234     * Get current value of EG1 controller.
235     */
236     virtual double GetEG1ControllerValue(uint8_t MIDIKeyVelocity) = 0;
237    
238     /**
239     * Calculate influence of EG1 controller on EG1's parameters.
240     */
241     virtual EGInfo CalculateEG1ControllerInfluence(double eg1ControllerValue) = 0;
242    
243 persson 2055 // TODO: cleanup the interface. The velrelase and
244     // velocityAttenuation parameters are perhaps too gig
245     // specific.
246 iliev 2015 /**
247 persson 2055 * Trigger the amplitude envelope generator.
248     */
249     virtual void TriggerEG1(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;
250    
251     /**
252 iliev 2015 * Get current value of EG2 controller.
253     */
254     virtual double GetEG2ControllerValue(uint8_t MIDIKeyVelocity) = 0;
255    
256     /**
257     * Calculate influence of EG2 controller on EG2's parameters.
258     */
259     virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) = 0;
260    
261 persson 2175 virtual void TriggerEG2(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;
262    
263 iliev 2015 virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) = 0;
264     virtual float CalculateFinalCutoff(float cutoffBase) = 0;
265    
266     virtual void InitLFO1() = 0;
267     virtual void InitLFO2() = 0;
268     virtual void InitLFO3() = 0;
269    
270     virtual uint8_t GetVCFCutoffCtrl() = 0;
271     virtual uint8_t GetVCFResonanceCtrl() = 0;
272     virtual uint8_t CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) = 0;
273    
274     virtual void GetFirstEventOnKey(uint8_t MIDIKey, RTList<Event>::Iterator& itEvent) = 0;
275     virtual void ProcessCCEvent(RTList<Event>::Iterator& itEvent) = 0;
276     virtual void ProcessCutoffEvent(RTList<Event>::Iterator& itEvent) = 0;
277     virtual double GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0;
278    
279     virtual unsigned long GetNoteOnTime(int MIDIKey) = 0;
280 persson 2114
281     virtual void ProcessGroupEvent(RTList<Event>::Iterator& itEvent) = 0;
282     void EnterReleaseStage();
283 iliev 2015 };
284     } // namespace LinuxSampler
285    
286 persson 2114 #endif /* __LS_ABSTRACTVOICE_H__ */

  ViewVC Help
Powered by ViewVC