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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2015 by iliev, Sun Oct 25 22:22:52 2009 UTC revision 2559 by schoenebeck, Sun May 18 17:38:25 2014 UTC
# Line 3  Line 3 
3   *   LinuxSampler - modular, streaming capable sampler                     *   *   LinuxSampler - modular, streaming capable sampler                     *
4   *                                                                         *   *                                                                         *
5   *   Copyright (C) 2003,2004 by Benno Senoner and Christian Schoenebeck    *   *   Copyright (C) 2003,2004 by Benno Senoner and Christian Schoenebeck    *
6   *   Copyright (C) 2005-2009 Christian Schoenebeck                         *   *   Copyright (C) 2005-2008 Christian Schoenebeck                         *
7   *   Copyright (C) 2009 Grigor Iliev                                       *   *   Copyright (C) 2009-2012 Christian Schoenebeck and Grigor Iliev        *
8   *                                                                         *   *                                                                         *
9   *   This program is free software; you can redistribute it and/or modify  *   *   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  *   *   it under the terms of the GNU General Public License as published by  *
# Line 23  Line 23 
23   ***************************************************************************/   ***************************************************************************/
24    
25  #ifndef __LS_ABSTRACTVOICE_H__  #ifndef __LS_ABSTRACTVOICE_H__
26  #define __LS_ABSTRACTVOICE_H__  #define __LS_ABSTRACTVOICE_H__
27    
28  #include "Voice.h"  #include "Voice.h"
29    
# Line 31  Line 31 
31  #include "../AbstractEngineChannel.h"  #include "../AbstractEngineChannel.h"
32  #include "../common/LFOBase.h"  #include "../common/LFOBase.h"
33  #include "../EngineBase.h"  #include "../EngineBase.h"
34    #include "EG.h"
35  #include "../gig/EGADSR.h"  #include "../gig/EGADSR.h"
36  #include "../gig/EGDecay.h"  #include "../gig/EGDecay.h"
37  #include "../gig/SmoothVolume.h"  #include "../gig/SmoothVolume.h"
38  #include "../gig/Synthesizer.h"  #include "../gig/Synthesizer.h"
39  #include "../gig/Profiler.h"  #include "../gig/Profiler.h"
40    #include "SignalUnitRack.h"
41    
42  // include the appropriate (unsigned) triangle LFO implementation  // include the appropriate (unsigned) triangle LFO implementation
43  #if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION  #if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
# Line 79  namespace LinuxSampler { Line 81  namespace LinuxSampler {
81    
82      class AbstractVoice : public Voice {      class AbstractVoice : public Voice {
83          public:          public:
84              type_t       Type;         ///< Voice Type              type_t       Type;         ///< Voice Type (bit field, a voice may have several types)
85              int          MIDIKey;      ///< MIDI key number of the key that triggered the voice              int          MIDIKey;      ///< MIDI key number of the key that triggered the voice
86              uint         KeyGroup;              uint8_t      MIDIVelocity; ///< MIDI velocity of the key that triggered the voice
87                int          MIDIPan;      ///< the current MIDI pan value plus the value from RegionInfo
88                
89                SignalUnitRack* const pSignalUnitRack;
90    
91              AbstractVoice();              AbstractVoice(SignalUnitRack* pRack);
92              virtual ~AbstractVoice();              virtual ~AbstractVoice();
93    
94              inline bool IsActive() { return PlaybackState; }              inline bool IsActive() { return PlaybackState; }
# Line 99  namespace LinuxSampler { Line 104  namespace LinuxSampler {
104                  int                     iKeyGroup                  int                     iKeyGroup
105              );              );
106    
107                /** Invoked when the voice is freed - gone from active to inactive. */
108                virtual void VoiceFreed() { }
109    
110              virtual void Synthesize(uint Samples, sample_t* pSrc, uint Skip);              virtual void Synthesize(uint Samples, sample_t* pSrc, uint Skip);
111                
112                uint GetSampleRate() { return GetEngine()->SampleRate; }
113                
114                uint8_t GetControllerValue(uint8_t Controller) {
115                    return (Controller > 128) ? 0 : pEngineChannel->ControllerTable[Controller];
116                }
117    
118              void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);              void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);
119              void processPitchEvent(RTList<Event>::Iterator& itEvent);              void processPitchEvent(RTList<Event>::Iterator& itEvent);
120              void processResonanceEvent(RTList<Event>::Iterator& itEvent);              void processResonanceEvent(RTList<Event>::Iterator& itEvent);
121              void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);              void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);
122                void processGroupEvents(RTList<Event>::Iterator& itEvent, uint End);
123              void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);              void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);
124              void Kill(Pool<Event>::Iterator& itKillEvent);              void Kill(Pool<Event>::Iterator& itKillEvent);
125                void CreateEq();
126                void onScaleTuningChanged();
127    
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.              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              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
# Line 133  namespace LinuxSampler { Line 150  namespace LinuxSampler {
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              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.              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              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              gig::EGADSR                 EG1;                ///< Envelope Generator 1 (Amplification)              EG*                         pEG1;               ///< Envelope Generator 1 (Amplification)
154              gig::EGADSR                 EG2;                ///< Envelope Generator 2 (Filter cutoff frequency)              EG*                         pEG2;               ///< Envelope Generator 2 (Filter cutoff frequency)
155              gig::EGDecay                EG3;                ///< Envelope Generator 3 (Pitch)              gig::EGDecay                EG3;                ///< Envelope Generator 3 (Pitch) TODO: use common EG instead?
156              midi_ctrl                   VCFCutoffCtrl;              midi_ctrl                   VCFCutoffCtrl;
157              midi_ctrl                   VCFResonanceCtrl;              midi_ctrl                   VCFResonanceCtrl;
158              LFOUnsigned*                pLFO1;               ///< Low Frequency Oscillator 1 (Amplification)              LFOUnsigned*                pLFO1;               ///< Low Frequency Oscillator 1 (Amplification)
# Line 151  namespace LinuxSampler { Line 168  namespace LinuxSampler {
168              float                       fFinalResonance;              float                       fFinalResonance;
169              gig::SynthesisParam         finalSynthesisParameters;              gig::SynthesisParam         finalSynthesisParameters;
170              gig::Loop                   loop;              gig::Loop                   loop;
171                RTList<Event>*              pGroupEvents;        ///< Events directed to an exclusive group
172                
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    
184              virtual AbstractEngine* GetEngine() = 0;              virtual AbstractEngine* GetEngine() = 0;
185              virtual SampleInfo      GetSampleInfo() = 0;              virtual SampleInfo      GetSampleInfo() = 0;
# Line 159  namespace LinuxSampler { Line 187  namespace LinuxSampler {
187              virtual InstrumentInfo  GetInstrumentInfo() = 0;              virtual InstrumentInfo  GetInstrumentInfo() = 0;
188    
189              /**              /**
190                 * 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               * Gets the sample cache size in bytes.               * Gets the sample cache size in bytes.
204               */               */
205              virtual unsigned long GetSampleCacheSize() = 0;              virtual unsigned long GetSampleCacheSize() = 0;
206                
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    
220              /**              /**
221               * Returns the correct amplitude factor for the given \a MIDIKeyVelocity.               * Returns the correct amplitude factor for the given \a MIDIKeyVelocity.
# Line 180  namespace LinuxSampler { Line 234  namespace LinuxSampler {
234    
235              virtual double CalculateVolume(double velocityAttenuation);              virtual double CalculateVolume(double velocityAttenuation);
236    
237                virtual float GetReleaseTriggerAttenuation(float noteLength);
238    
239              /**              /**
240               * Get starting crossfade volume level               * Get starting crossfade volume level
241               */               */
242              virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0;              virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0;
243    
244                virtual MidiKeyBase* GetMidiKeyInfo(int MIDIKey) = 0;
245    
246              virtual int   OrderNewStream() = 0;              virtual int   OrderNewStream() = 0;
247    
248              virtual PitchInfo CalculatePitchInfo(int PitchBend);              virtual PitchInfo CalculatePitchInfo(int PitchBend);
249    
250                // TODO: cleanup the interface. The following two methods
251                // are maybe not neccessary after the TriggerEG1 method
252                // was added.
253    
254              /**              /**
255               * Get current value of EG1 controller.               * Get current value of EG1 controller.
256               */               */
# Line 199  namespace LinuxSampler { Line 261  namespace LinuxSampler {
261               */               */
262              virtual EGInfo CalculateEG1ControllerInfluence(double eg1ControllerValue) = 0;              virtual EGInfo CalculateEG1ControllerInfluence(double eg1ControllerValue) = 0;
263    
264                // TODO: cleanup the interface. The velrelase and
265                // velocityAttenuation parameters are perhaps too gig
266                // specific.
267                /**
268                 * 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               * Get current value of EG2 controller.               * Get current value of EG2 controller.
274               */               */
# Line 209  namespace LinuxSampler { Line 279  namespace LinuxSampler {
279               */               */
280              virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) = 0;              virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) = 0;
281    
282                virtual void TriggerEG2(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;
283    
284              virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) = 0;              virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) = 0;
285              virtual float CalculateFinalCutoff(float cutoffBase) = 0;              virtual float CalculateFinalCutoff(float cutoffBase) = 0;
286    
# Line 222  namespace LinuxSampler { Line 294  namespace LinuxSampler {
294    
295              virtual void    GetFirstEventOnKey(uint8_t MIDIKey, RTList<Event>::Iterator& itEvent) = 0;              virtual void    GetFirstEventOnKey(uint8_t MIDIKey, RTList<Event>::Iterator& itEvent) = 0;
296              virtual void    ProcessCCEvent(RTList<Event>::Iterator& itEvent) = 0;              virtual void    ProcessCCEvent(RTList<Event>::Iterator& itEvent) = 0;
297                virtual void    ProcessChannelPressureEvent(RTList<Event>::Iterator& itEvent) = 0;
298                virtual void    ProcessPolyphonicKeyPressureEvent(RTList<Event>::Iterator& itEvent) = 0;
299              virtual void    ProcessCutoffEvent(RTList<Event>::Iterator& itEvent) = 0;              virtual void    ProcessCutoffEvent(RTList<Event>::Iterator& itEvent) = 0;
300              virtual double  GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0;              virtual double  GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0;
301    
302              virtual unsigned long GetNoteOnTime(int MIDIKey) = 0;              virtual unsigned long GetNoteOnTime(int MIDIKey) = 0;
303    
304                virtual void    ProcessGroupEvent(RTList<Event>::Iterator& itEvent) = 0;
305                void            EnterReleaseStage();
306    
307                virtual int     CalculatePan(uint8_t pan) = 0;
308      };      };
309  } // namespace LinuxSampler  } // namespace LinuxSampler
310    
311  #endif  /* __LS_ABSTRACTVOICE_H__ */  #endif  /* __LS_ABSTRACTVOICE_H__ */
Legend:
Removed from v.2015  
changed lines
  Added in v.2559
  ViewVC Help
Powered by ViewVC