/[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 2448 - (hide annotations) (download) (as text)
Fri May 3 14:26:32 2013 UTC (10 years, 10 months ago) by schoenebeck
File MIME type: text/x-c++hdr
File size: 16907 byte(s)
* Immediately apply scale tuning changes to active voices.
* Exposed scale tuning to C++ API (along to the already existing standard
  SysEx way).
* Bumped version to 1.0.0.svn21

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 2382 * Copyright (C) 2009-2012 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 persson 2382 int MIDIPan; ///< the current MIDI pan value plus the value from RegionInfo
88 iliev 2217
89     SignalUnitRack* const pSignalUnitRack;
90 iliev 2015
91 iliev 2217 AbstractVoice(SignalUnitRack* pRack);
92 iliev 2015 virtual ~AbstractVoice();
93    
94     inline bool IsActive() { return PlaybackState; }
95     inline bool IsStealable() { return !itKillEvent && PlaybackState >= playback_state_ram; }
96    
97     virtual void Reset();
98    
99     virtual int Trigger (
100     AbstractEngineChannel* pEngineChannel,
101     Pool<Event>::Iterator& itNoteOnEvent,
102     int PitchBend,
103     type_t VoiceType,
104     int iKeyGroup
105     );
106    
107 iliev 2244 /** Invoked when the voice is freed - gone from active to inactive. */
108     virtual void VoiceFreed() { }
109    
110 iliev 2015 virtual void Synthesize(uint Samples, sample_t* pSrc, uint Skip);
111 iliev 2205
112     uint GetSampleRate() { return GetEngine()->SampleRate; }
113 iliev 2224
114     uint8_t GetControllerValue(uint8_t Controller) {
115     return (Controller > 128) ? 0 : pEngineChannel->ControllerTable[Controller];
116     }
117 iliev 2015
118     void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);
119     void processPitchEvent(RTList<Event>::Iterator& itEvent);
120     void processResonanceEvent(RTList<Event>::Iterator& itEvent);
121     void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);
122 persson 2114 void processGroupEvents(RTList<Event>::Iterator& itEvent, uint End);
123 iliev 2015 void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);
124     void Kill(Pool<Event>::Iterator& itKillEvent);
125 iliev 2298 void CreateEq();
126 schoenebeck 2448 void onScaleTuningChanged();
127 iliev 2015
128     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.
129     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
130     Stream::reference_t DiskStreamRef; ///< Reference / link to the disk stream
131    
132     template<class TV, class TRR, class TR, class TD, class TIM, class TI> friend class EngineBase;
133    
134     protected:
135     SampleInfo SmplInfo;
136     RegionInfo RgnInfo;
137     InstrumentInfo InstrInfo;
138     AbstractEngineChannel* pEngineChannel;
139    
140     double Pos; ///< Current playback position in sample
141     PitchInfo Pitch;
142     float CutoffBase; ///< Cutoff frequency before control change, EG and LFO are applied
143     float VolumeLeft; ///< Left channel volume. This factor is calculated when the voice is triggered and doesn't change after that.
144     float VolumeRight; ///< Right channel volume. This factor is calculated when the voice is triggered and doesn't change after that.
145     gig::SmoothVolume CrossfadeSmoother; ///< Crossfade volume, updated by crossfade CC events
146     gig::SmoothVolume VolumeSmoother; ///< Volume, updated by CC 7 (volume) events
147     gig::SmoothVolume PanLeftSmoother; ///< Left channel volume, updated by CC 10 (pan) events
148     gig::SmoothVolume PanRightSmoother; ///< Right channel volume, updated by CC 10 (pan) events
149     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
150     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
151     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.
152     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
153 persson 2055 EG* pEG1; ///< Envelope Generator 1 (Amplification)
154 persson 2175 EG* pEG2; ///< Envelope Generator 2 (Filter cutoff frequency)
155 persson 2055 gig::EGDecay EG3; ///< Envelope Generator 3 (Pitch) TODO: use common EG instead?
156 iliev 2015 midi_ctrl VCFCutoffCtrl;
157     midi_ctrl VCFResonanceCtrl;
158     LFOUnsigned* pLFO1; ///< Low Frequency Oscillator 1 (Amplification)
159     LFOUnsigned* pLFO2; ///< Low Frequency Oscillator 2 (Filter cutoff frequency)
160     LFOSigned* pLFO3; ///< Low Frequency Oscillator 3 (Pitch)
161     bool bLFO1Enabled; ///< Should we use the Amplitude LFO for this voice?
162     bool bLFO2Enabled; ///< Should we use the Filter Cutoff LFO for this voice?
163     bool bLFO3Enabled; ///< Should we use the Pitch LFO for this voice?
164     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).
165     Pool<Event>::Iterator itKillEvent; ///< Event which caused this voice to be killed
166     int SynthesisMode;
167     float fFinalCutoff;
168     float fFinalResonance;
169     gig::SynthesisParam finalSynthesisParameters;
170     gig::Loop loop;
171 persson 2114 RTList<Event>* pGroupEvents; ///< Events directed to an exclusive group
172 iliev 2298
173     EqSupport* pEq; ///< Used for per voice equalization
174     bool bEqSupport;
175    
176     void PrintEqInfo() {
177     if (!bEqSupport || pEq == NULL) {
178     dmsg(1,("EQ support: no\n"));
179     } else {
180     pEq->PrintInfo();
181     }
182     }
183 iliev 2015
184     virtual AbstractEngine* GetEngine() = 0;
185     virtual SampleInfo GetSampleInfo() = 0;
186     virtual RegionInfo GetRegionInfo() = 0;
187     virtual InstrumentInfo GetInstrumentInfo() = 0;
188    
189     /**
190 iliev 2205 * Most of the important members of the voice are set when the voice
191     * is triggered (like pEngineChannel, pRegion, pSample, etc).
192     * This method is called after these members are set and before
193     * the voice is actually triggered.
194     * Override this method if you need to do some additional
195     * initialization which depends on these members before the voice
196     * is triggered.
197     */
198     virtual void AboutToTrigger() { }
199    
200     virtual bool EG1Finished();
201    
202     /**
203 iliev 2015 * Gets the sample cache size in bytes.
204     */
205     virtual unsigned long GetSampleCacheSize() = 0;
206 iliev 2216
207     /**
208     * Because in most cases we cache part of the sample in RAM, if the
209     * offset is too big (will extend beyond the RAM cache if the cache contains
210     * the beginning of the sample) we should cache in the RAM buffer not the
211     * beginning of the sample but a part that starts from the sample offset point.
212     * In that case the current sample position should start from zero (Pos).
213     * When the offset fits into RAM buffer or the whole sample is cached
214     * in RAM, Pos should contain the actual offset.
215     * We don't trim the sample because it might have a defined
216     * loop start point before the start point of the playback.
217     */
218     virtual void SetSampleStartOffset();
219 iliev 2015
220     /**
221     * Returns the correct amplitude factor for the given \a MIDIKeyVelocity.
222     * All involved parameters (VelocityResponseCurve, VelocityResponseDepth
223     * and VelocityResponseCurveScaling) involved are taken into account to
224     * calculate the amplitude factor. Use this method when a key was
225     * triggered to get the volume with which the sample should be played
226     * back.
227     *
228     * @param MIDIKeyVelocity MIDI velocity value of the triggered key (between 0 and 127)
229     * @returns amplitude factor (between 0.0 and 1.0)
230     */
231     virtual double GetVelocityAttenuation(uint8_t MIDIKeyVelocity) = 0;
232    
233     virtual double GetSampleAttenuation() = 0;
234    
235     virtual double CalculateVolume(double velocityAttenuation);
236    
237 persson 2061 virtual float GetReleaseTriggerAttenuation(float noteLength);
238    
239 iliev 2015 /**
240     * Get starting crossfade volume level
241     */
242     virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0;
243    
244 schoenebeck 2121 virtual MidiKeyBase* GetMidiKeyInfo(int MIDIKey) = 0;
245    
246 iliev 2015 virtual int OrderNewStream() = 0;
247    
248     virtual PitchInfo CalculatePitchInfo(int PitchBend);
249    
250 persson 2055 // TODO: cleanup the interface. The following two methods
251     // are maybe not neccessary after the TriggerEG1 method
252     // was added.
253    
254 iliev 2015 /**
255     * Get current value of EG1 controller.
256     */
257     virtual double GetEG1ControllerValue(uint8_t MIDIKeyVelocity) = 0;
258    
259     /**
260     * Calculate influence of EG1 controller on EG1's parameters.
261     */
262     virtual EGInfo CalculateEG1ControllerInfluence(double eg1ControllerValue) = 0;
263    
264 persson 2055 // TODO: cleanup the interface. The velrelase and
265     // velocityAttenuation parameters are perhaps too gig
266     // specific.
267 iliev 2015 /**
268 persson 2055 * Trigger the amplitude envelope generator.
269     */
270     virtual void TriggerEG1(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;
271    
272     /**
273 iliev 2015 * Get current value of EG2 controller.
274     */
275     virtual double GetEG2ControllerValue(uint8_t MIDIKeyVelocity) = 0;
276    
277     /**
278     * Calculate influence of EG2 controller on EG2's parameters.
279     */
280     virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) = 0;
281    
282 persson 2175 virtual void TriggerEG2(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;
283    
284 iliev 2015 virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) = 0;
285     virtual float CalculateFinalCutoff(float cutoffBase) = 0;
286    
287     virtual void InitLFO1() = 0;
288     virtual void InitLFO2() = 0;
289     virtual void InitLFO3() = 0;
290    
291     virtual uint8_t GetVCFCutoffCtrl() = 0;
292     virtual uint8_t GetVCFResonanceCtrl() = 0;
293     virtual uint8_t CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) = 0;
294    
295     virtual void GetFirstEventOnKey(uint8_t MIDIKey, RTList<Event>::Iterator& itEvent) = 0;
296     virtual void ProcessCCEvent(RTList<Event>::Iterator& itEvent) = 0;
297     virtual void ProcessCutoffEvent(RTList<Event>::Iterator& itEvent) = 0;
298     virtual double GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0;
299    
300     virtual unsigned long GetNoteOnTime(int MIDIKey) = 0;
301 persson 2114
302     virtual void ProcessGroupEvent(RTList<Event>::Iterator& itEvent) = 0;
303     void EnterReleaseStage();
304 persson 2382
305     virtual int CalculatePan(uint8_t pan) = 0;
306 iliev 2015 };
307     } // namespace LinuxSampler
308    
309 persson 2114 #endif /* __LS_ABSTRACTVOICE_H__ */

  ViewVC Help
Powered by ViewVC