/[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 2244 by iliev, Thu Aug 18 11:32:33 2011 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-2011 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                uint8_t      MIDIPan;      ///< the current MIDI pan value
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    
# Line 133  namespace LinuxSampler { Line 148  namespace LinuxSampler {
148              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
149              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.
150              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
151              gig::EGADSR                 EG1;                ///< Envelope Generator 1 (Amplification)              EG*                         pEG1;               ///< Envelope Generator 1 (Amplification)
152              gig::EGADSR                 EG2;                ///< Envelope Generator 2 (Filter cutoff frequency)              EG*                         pEG2;               ///< Envelope Generator 2 (Filter cutoff frequency)
153              gig::EGDecay                EG3;                ///< Envelope Generator 3 (Pitch)              gig::EGDecay                EG3;                ///< Envelope Generator 3 (Pitch) TODO: use common EG instead?
154              midi_ctrl                   VCFCutoffCtrl;              midi_ctrl                   VCFCutoffCtrl;
155              midi_ctrl                   VCFResonanceCtrl;              midi_ctrl                   VCFResonanceCtrl;
156              LFOUnsigned*                pLFO1;               ///< Low Frequency Oscillator 1 (Amplification)              LFOUnsigned*                pLFO1;               ///< Low Frequency Oscillator 1 (Amplification)
# Line 151  namespace LinuxSampler { Line 166  namespace LinuxSampler {
166              float                       fFinalResonance;              float                       fFinalResonance;
167              gig::SynthesisParam         finalSynthesisParameters;              gig::SynthesisParam         finalSynthesisParameters;
168              gig::Loop                   loop;              gig::Loop                   loop;
169                RTList<Event>*              pGroupEvents;        ///< Events directed to an exclusive group
170    
171              virtual AbstractEngine* GetEngine() = 0;              virtual AbstractEngine* GetEngine() = 0;
172              virtual SampleInfo      GetSampleInfo() = 0;              virtual SampleInfo      GetSampleInfo() = 0;
# Line 159  namespace LinuxSampler { Line 174  namespace LinuxSampler {
174              virtual InstrumentInfo  GetInstrumentInfo() = 0;              virtual InstrumentInfo  GetInstrumentInfo() = 0;
175    
176              /**              /**
177                 * Most of the important members of the voice are set when the voice
178                 * is triggered (like pEngineChannel, pRegion, pSample, etc).
179                 * This method is called after these members are set and before
180                 * the voice is actually triggered.
181                 * Override this method if you need to do some additional
182                 * initialization which depends on these members before the voice
183                 * is triggered.
184                 */
185                virtual void AboutToTrigger() { }
186    
187                virtual bool EG1Finished();
188    
189                /**
190               * Gets the sample cache size in bytes.               * Gets the sample cache size in bytes.
191               */               */
192              virtual unsigned long GetSampleCacheSize() = 0;              virtual unsigned long GetSampleCacheSize() = 0;
193                
194                /**
195                 * Because in most cases we cache part of the sample in RAM, if the
196                 * offset is too big (will extend beyond the RAM cache if the cache contains
197                 * the beginning of the sample) we should cache in the RAM buffer not the
198                 * beginning of the sample but a part that starts from the sample offset point.
199                 * In that case the current sample position should start from zero (Pos).
200                 * When the offset fits into RAM buffer or the whole sample is cached
201                 * in RAM, Pos should contain the actual offset.
202                 * We don't trim the sample because it might have a defined
203                 * loop start point before the start point of the playback.
204                 */
205                virtual void SetSampleStartOffset();
206    
207              /**              /**
208               * 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 221  namespace LinuxSampler {
221    
222              virtual double CalculateVolume(double velocityAttenuation);              virtual double CalculateVolume(double velocityAttenuation);
223    
224                virtual float GetReleaseTriggerAttenuation(float noteLength);
225    
226              /**              /**
227               * Get starting crossfade volume level               * Get starting crossfade volume level
228               */               */
229              virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0;              virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0;
230    
231                virtual MidiKeyBase* GetMidiKeyInfo(int MIDIKey) = 0;
232    
233              virtual int   OrderNewStream() = 0;              virtual int   OrderNewStream() = 0;
234    
235              virtual PitchInfo CalculatePitchInfo(int PitchBend);              virtual PitchInfo CalculatePitchInfo(int PitchBend);
236    
237                // TODO: cleanup the interface. The following two methods
238                // are maybe not neccessary after the TriggerEG1 method
239                // was added.
240    
241              /**              /**
242               * Get current value of EG1 controller.               * Get current value of EG1 controller.
243               */               */
# Line 199  namespace LinuxSampler { Line 248  namespace LinuxSampler {
248               */               */
249              virtual EGInfo CalculateEG1ControllerInfluence(double eg1ControllerValue) = 0;              virtual EGInfo CalculateEG1ControllerInfluence(double eg1ControllerValue) = 0;
250    
251                // TODO: cleanup the interface. The velrelase and
252                // velocityAttenuation parameters are perhaps too gig
253                // specific.
254                /**
255                 * Trigger the amplitude envelope generator.
256                 */
257                virtual void TriggerEG1(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;
258    
259              /**              /**
260               * Get current value of EG2 controller.               * Get current value of EG2 controller.
261               */               */
# Line 209  namespace LinuxSampler { Line 266  namespace LinuxSampler {
266               */               */
267              virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) = 0;              virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) = 0;
268    
269                virtual void TriggerEG2(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;
270    
271              virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) = 0;              virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) = 0;
272              virtual float CalculateFinalCutoff(float cutoffBase) = 0;              virtual float CalculateFinalCutoff(float cutoffBase) = 0;
273    
# Line 226  namespace LinuxSampler { Line 285  namespace LinuxSampler {
285              virtual double  GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0;              virtual double  GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0;
286    
287              virtual unsigned long GetNoteOnTime(int MIDIKey) = 0;              virtual unsigned long GetNoteOnTime(int MIDIKey) = 0;
288    
289                virtual void    ProcessGroupEvent(RTList<Event>::Iterator& itEvent) = 0;
290                void            EnterReleaseStage();
291      };      };
292  } // namespace LinuxSampler  } // namespace LinuxSampler
293    
294  #endif  /* __LS_ABSTRACTVOICE_H__ */  #endif  /* __LS_ABSTRACTVOICE_H__ */
Legend:
Removed from v.2015  
changed lines
  Added in v.2244
  ViewVC Help
Powered by ViewVC