/[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 2217 by iliev, Tue Jul 26 15:51:30 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;              
87                SignalUnitRack* const pSignalUnitRack;
88    
89              AbstractVoice();              AbstractVoice(SignalUnitRack* pRack);
90              virtual ~AbstractVoice();              virtual ~AbstractVoice();
91    
92              inline bool IsActive() { return PlaybackState; }              inline bool IsActive() { return PlaybackState; }
# Line 100  namespace LinuxSampler { Line 103  namespace LinuxSampler {
103              );              );
104    
105              virtual void Synthesize(uint Samples, sample_t* pSrc, uint Skip);              virtual void Synthesize(uint Samples, sample_t* pSrc, uint Skip);
106                
107                uint GetSampleRate() { return GetEngine()->SampleRate; }
108    
109              void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);              void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);
110              void processPitchEvent(RTList<Event>::Iterator& itEvent);              void processPitchEvent(RTList<Event>::Iterator& itEvent);
111              void processResonanceEvent(RTList<Event>::Iterator& itEvent);              void processResonanceEvent(RTList<Event>::Iterator& itEvent);
112              void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);              void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);
113                void processGroupEvents(RTList<Event>::Iterator& itEvent, uint End);
114              void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);              void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);
115              void Kill(Pool<Event>::Iterator& itKillEvent);              void Kill(Pool<Event>::Iterator& itKillEvent);
116    
# Line 133  namespace LinuxSampler { Line 139  namespace LinuxSampler {
139              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
140              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.
141              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
142              gig::EGADSR                 EG1;                ///< Envelope Generator 1 (Amplification)              EG*                         pEG1;               ///< Envelope Generator 1 (Amplification)
143              gig::EGADSR                 EG2;                ///< Envelope Generator 2 (Filter cutoff frequency)              EG*                         pEG2;               ///< Envelope Generator 2 (Filter cutoff frequency)
144              gig::EGDecay                EG3;                ///< Envelope Generator 3 (Pitch)              gig::EGDecay                EG3;                ///< Envelope Generator 3 (Pitch) TODO: use common EG instead?
145              midi_ctrl                   VCFCutoffCtrl;              midi_ctrl                   VCFCutoffCtrl;
146              midi_ctrl                   VCFResonanceCtrl;              midi_ctrl                   VCFResonanceCtrl;
147              LFOUnsigned*                pLFO1;               ///< Low Frequency Oscillator 1 (Amplification)              LFOUnsigned*                pLFO1;               ///< Low Frequency Oscillator 1 (Amplification)
# Line 151  namespace LinuxSampler { Line 157  namespace LinuxSampler {
157              float                       fFinalResonance;              float                       fFinalResonance;
158              gig::SynthesisParam         finalSynthesisParameters;              gig::SynthesisParam         finalSynthesisParameters;
159              gig::Loop                   loop;              gig::Loop                   loop;
160                RTList<Event>*              pGroupEvents;        ///< Events directed to an exclusive group
161    
162              virtual AbstractEngine* GetEngine() = 0;              virtual AbstractEngine* GetEngine() = 0;
163              virtual SampleInfo      GetSampleInfo() = 0;              virtual SampleInfo      GetSampleInfo() = 0;
# Line 159  namespace LinuxSampler { Line 165  namespace LinuxSampler {
165              virtual InstrumentInfo  GetInstrumentInfo() = 0;              virtual InstrumentInfo  GetInstrumentInfo() = 0;
166    
167              /**              /**
168                 * Most of the important members of the voice are set when the voice
169                 * is triggered (like pEngineChannel, pRegion, pSample, etc).
170                 * This method is called after these members are set and before
171                 * the voice is actually triggered.
172                 * Override this method if you need to do some additional
173                 * initialization which depends on these members before the voice
174                 * is triggered.
175                 */
176                virtual void AboutToTrigger() { }
177    
178                virtual bool EG1Finished();
179    
180                /**
181               * Gets the sample cache size in bytes.               * Gets the sample cache size in bytes.
182               */               */
183              virtual unsigned long GetSampleCacheSize() = 0;              virtual unsigned long GetSampleCacheSize() = 0;
184                
185                /**
186                 * Because in most cases we cache part of the sample in RAM, if the
187                 * offset is too big (will extend beyond the RAM cache if the cache contains
188                 * the beginning of the sample) we should cache in the RAM buffer not the
189                 * beginning of the sample but a part that starts from the sample offset point.
190                 * In that case the current sample position should start from zero (Pos).
191                 * When the offset fits into RAM buffer or the whole sample is cached
192                 * in RAM, Pos should contain the actual offset.
193                 * We don't trim the sample because it might have a defined
194                 * loop start point before the start point of the playback.
195                 */
196                virtual void SetSampleStartOffset();
197    
198              /**              /**
199               * 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 212  namespace LinuxSampler {
212    
213              virtual double CalculateVolume(double velocityAttenuation);              virtual double CalculateVolume(double velocityAttenuation);
214    
215                virtual float GetReleaseTriggerAttenuation(float noteLength);
216    
217              /**              /**
218               * Get starting crossfade volume level               * Get starting crossfade volume level
219               */               */
220              virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0;              virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0;
221    
222                virtual MidiKeyBase* GetMidiKeyInfo(int MIDIKey) = 0;
223    
224              virtual int   OrderNewStream() = 0;              virtual int   OrderNewStream() = 0;
225    
226              virtual PitchInfo CalculatePitchInfo(int PitchBend);              virtual PitchInfo CalculatePitchInfo(int PitchBend);
227    
228                // TODO: cleanup the interface. The following two methods
229                // are maybe not neccessary after the TriggerEG1 method
230                // was added.
231    
232              /**              /**
233               * Get current value of EG1 controller.               * Get current value of EG1 controller.
234               */               */
# Line 199  namespace LinuxSampler { Line 239  namespace LinuxSampler {
239               */               */
240              virtual EGInfo CalculateEG1ControllerInfluence(double eg1ControllerValue) = 0;              virtual EGInfo CalculateEG1ControllerInfluence(double eg1ControllerValue) = 0;
241    
242                // TODO: cleanup the interface. The velrelase and
243                // velocityAttenuation parameters are perhaps too gig
244                // specific.
245                /**
246                 * Trigger the amplitude envelope generator.
247                 */
248                virtual void TriggerEG1(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;
249    
250              /**              /**
251               * Get current value of EG2 controller.               * Get current value of EG2 controller.
252               */               */
# Line 209  namespace LinuxSampler { Line 257  namespace LinuxSampler {
257               */               */
258              virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) = 0;              virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) = 0;
259    
260                virtual void TriggerEG2(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;
261    
262              virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) = 0;              virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) = 0;
263              virtual float CalculateFinalCutoff(float cutoffBase) = 0;              virtual float CalculateFinalCutoff(float cutoffBase) = 0;
264    
# Line 226  namespace LinuxSampler { Line 276  namespace LinuxSampler {
276              virtual double  GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0;              virtual double  GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0;
277    
278              virtual unsigned long GetNoteOnTime(int MIDIKey) = 0;              virtual unsigned long GetNoteOnTime(int MIDIKey) = 0;
279    
280                virtual void    ProcessGroupEvent(RTList<Event>::Iterator& itEvent) = 0;
281                void            EnterReleaseStage();
282      };      };
283  } // namespace LinuxSampler  } // namespace LinuxSampler
284    
285  #endif  /* __LS_ABSTRACTVOICE_H__ */  #endif  /* __LS_ABSTRACTVOICE_H__ */
Legend:
Removed from v.2015  
changed lines
  Added in v.2217
  ViewVC Help
Powered by ViewVC