/[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 2879 by schoenebeck, Tue Apr 19 14:07:53 2016 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              NoteBase*    pNote;        ///< Note this voice belongs to and was caused by.
86              uint         KeyGroup;              int          MIDIPan;      ///< the current MIDI pan value plus the value from RegionInfo
87    
88              AbstractVoice();              SignalUnitRack* const pSignalUnitRack;
89    
90                AbstractVoice(SignalUnitRack* pRack);
91              virtual ~AbstractVoice();              virtual ~AbstractVoice();
92    
93              inline bool IsActive() { return PlaybackState; }              inline bool IsActive() { return PlaybackState; }
# Line 99  namespace LinuxSampler { Line 103  namespace LinuxSampler {
103                  int                     iKeyGroup                  int                     iKeyGroup
104              );              );
105    
106                /** Invoked when the voice is freed - gone from active to inactive. */
107                virtual void VoiceFreed() { }
108    
109              virtual void Synthesize(uint Samples, sample_t* pSrc, uint Skip);              virtual void Synthesize(uint Samples, sample_t* pSrc, uint Skip);
110                
111                uint GetSampleRate() { return GetEngine()->SampleRate; }
112                
113                uint8_t GetControllerValue(uint8_t Controller) {
114                    return (Controller > 128) ? 0 : pEngineChannel->ControllerTable[Controller];
115                }
116    
117                /// Keyboard key on which this voice should listen to transitional events (i.e. note-off events to release the voice).
118                inline uint8_t HostKey() const { return pNote->hostKey; }
119                /// Keyboard key which the voice should use for calculating any synthesis relevant parameters (i.e. pitch).
120                inline uint8_t MIDIKey() const { return pNote->cause.Param.Note.Key; }
121                /// MIDI note-on velocity value which the voice should use for calculating any synthesis relevant parameters (i.e. amplitude).
122                inline uint8_t MIDIVelocity() const { return pNote->cause.Param.Note.Velocity; }
123    
124              void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);              void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);
125              void processPitchEvent(RTList<Event>::Iterator& itEvent);              void processPitchEvent(RTList<Event>::Iterator& itEvent);
126              void processResonanceEvent(RTList<Event>::Iterator& itEvent);              void processResonanceEvent(RTList<Event>::Iterator& itEvent);
127              void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);              void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);
128                void processGroupEvents(RTList<Event>::Iterator& itEvent, uint End);
129              void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);              void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);
130              void Kill(Pool<Event>::Iterator& itKillEvent);              void Kill(Pool<Event>::Iterator& itKillEvent);
131                void CreateEq();
132                void onScaleTuningChanged();
133    
134              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.
135              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 156  namespace LinuxSampler {
156              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
157              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.
158              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
159              gig::EGADSR                 EG1;                ///< Envelope Generator 1 (Amplification)              EG*                         pEG1;               ///< Envelope Generator 1 (Amplification)
160              gig::EGADSR                 EG2;                ///< Envelope Generator 2 (Filter cutoff frequency)              EG*                         pEG2;               ///< Envelope Generator 2 (Filter cutoff frequency)
161              gig::EGDecay                EG3;                ///< Envelope Generator 3 (Pitch)              gig::EGDecay                EG3;                ///< Envelope Generator 3 (Pitch) TODO: use common EG instead?
162              midi_ctrl                   VCFCutoffCtrl;              midi_ctrl                   VCFCutoffCtrl;
163              midi_ctrl                   VCFResonanceCtrl;              midi_ctrl                   VCFResonanceCtrl;
164              LFOUnsigned*                pLFO1;               ///< Low Frequency Oscillator 1 (Amplification)              LFOUnsigned*                pLFO1;               ///< Low Frequency Oscillator 1 (Amplification)
# Line 151  namespace LinuxSampler { Line 174  namespace LinuxSampler {
174              float                       fFinalResonance;              float                       fFinalResonance;
175              gig::SynthesisParam         finalSynthesisParameters;              gig::SynthesisParam         finalSynthesisParameters;
176              gig::Loop                   loop;              gig::Loop                   loop;
177                RTList<Event>*              pGroupEvents;        ///< Events directed to an exclusive group
178                
179                EqSupport* pEq;         ///< Used for per voice equalization
180                bool       bEqSupport;
181                
182                void PrintEqInfo() {
183                    if (!bEqSupport || pEq == NULL) {
184                        dmsg(1,("EQ support: no\n"));
185                    } else {
186                        pEq->PrintInfo();
187                    }
188                }
189    
190              virtual AbstractEngine* GetEngine() = 0;              virtual AbstractEngine* GetEngine() = 0;
191              virtual SampleInfo      GetSampleInfo() = 0;              virtual SampleInfo      GetSampleInfo() = 0;
# Line 159  namespace LinuxSampler { Line 193  namespace LinuxSampler {
193              virtual InstrumentInfo  GetInstrumentInfo() = 0;              virtual InstrumentInfo  GetInstrumentInfo() = 0;
194    
195              /**              /**
196                 * Most of the important members of the voice are set when the voice
197                 * is triggered (like pEngineChannel, pRegion, pSample, etc).
198                 * This method is called after these members are set and before
199                 * the voice is actually triggered.
200                 * Override this method if you need to do some additional
201                 * initialization which depends on these members before the voice
202                 * is triggered.
203                 */
204                virtual void AboutToTrigger() { }
205    
206                virtual bool EG1Finished();
207    
208                /**
209               * Gets the sample cache size in bytes.               * Gets the sample cache size in bytes.
210               */               */
211              virtual unsigned long GetSampleCacheSize() = 0;              virtual unsigned long GetSampleCacheSize() = 0;
212                
213                /**
214                 * Because in most cases we cache part of the sample in RAM, if the
215                 * offset is too big (will extend beyond the RAM cache if the cache contains
216                 * the beginning of the sample) we should cache in the RAM buffer not the
217                 * beginning of the sample but a part that starts from the sample offset point.
218                 * In that case the current sample position should start from zero (Pos).
219                 * When the offset fits into RAM buffer or the whole sample is cached
220                 * in RAM, Pos should contain the actual offset.
221                 * We don't trim the sample because it might have a defined
222                 * loop start point before the start point of the playback.
223                 */
224                virtual void SetSampleStartOffset();
225    
226              /**              /**
227               * 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 240  namespace LinuxSampler {
240    
241              virtual double CalculateVolume(double velocityAttenuation);              virtual double CalculateVolume(double velocityAttenuation);
242    
243                virtual float GetReleaseTriggerAttenuation(float noteLength);
244    
245              /**              /**
246               * Get starting crossfade volume level               * Get starting crossfade volume level
247               */               */
248              virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0;              virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0;
249    
250                virtual MidiKeyBase* GetMidiKeyInfo(int MIDIKey) = 0;
251    
252              virtual int   OrderNewStream() = 0;              virtual int   OrderNewStream() = 0;
253    
254              virtual PitchInfo CalculatePitchInfo(int PitchBend);              virtual PitchInfo CalculatePitchInfo(int PitchBend);
255    
256                // TODO: cleanup the interface. The following two methods
257                // are maybe not neccessary after the TriggerEG1 method
258                // was added.
259    
260              /**              /**
261               * Get current value of EG1 controller.               * Get current value of EG1 controller.
262               */               */
# Line 199  namespace LinuxSampler { Line 267  namespace LinuxSampler {
267               */               */
268              virtual EGInfo CalculateEG1ControllerInfluence(double eg1ControllerValue) = 0;              virtual EGInfo CalculateEG1ControllerInfluence(double eg1ControllerValue) = 0;
269    
270                // TODO: cleanup the interface. The velrelase and
271                // velocityAttenuation parameters are perhaps too gig
272                // specific.
273                /**
274                 * Trigger the amplitude envelope generator.
275                 */
276                virtual void TriggerEG1(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;
277    
278              /**              /**
279               * Get current value of EG2 controller.               * Get current value of EG2 controller.
280               */               */
# Line 209  namespace LinuxSampler { Line 285  namespace LinuxSampler {
285               */               */
286              virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) = 0;              virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) = 0;
287    
288                virtual void TriggerEG2(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;
289    
290              virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) = 0;              virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) = 0;
291              virtual float CalculateFinalCutoff(float cutoffBase) = 0;              virtual float CalculateFinalCutoff(float cutoffBase) = 0;
292    
# Line 222  namespace LinuxSampler { Line 300  namespace LinuxSampler {
300    
301              virtual void    GetFirstEventOnKey(uint8_t MIDIKey, RTList<Event>::Iterator& itEvent) = 0;              virtual void    GetFirstEventOnKey(uint8_t MIDIKey, RTList<Event>::Iterator& itEvent) = 0;
302              virtual void    ProcessCCEvent(RTList<Event>::Iterator& itEvent) = 0;              virtual void    ProcessCCEvent(RTList<Event>::Iterator& itEvent) = 0;
303                virtual void    ProcessChannelPressureEvent(RTList<Event>::Iterator& itEvent) = 0;
304                virtual void    ProcessPolyphonicKeyPressureEvent(RTList<Event>::Iterator& itEvent) = 0;
305              virtual void    ProcessCutoffEvent(RTList<Event>::Iterator& itEvent) = 0;              virtual void    ProcessCutoffEvent(RTList<Event>::Iterator& itEvent) = 0;
306              virtual double  GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0;              virtual double  GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0;
307    
308              virtual unsigned long GetNoteOnTime(int MIDIKey) = 0;              virtual unsigned long GetNoteOnTime(int MIDIKey) = 0;
309    
310                virtual void    ProcessGroupEvent(RTList<Event>::Iterator& itEvent) = 0;
311                void            EnterReleaseStage();
312    
313                virtual int     CalculatePan(uint8_t pan) = 0;
314      };      };
315  } // namespace LinuxSampler  } // namespace LinuxSampler
316    
317  #endif  /* __LS_ABSTRACTVOICE_H__ */  #endif  /* __LS_ABSTRACTVOICE_H__ */
Legend:
Removed from v.2015  
changed lines
  Added in v.2879
  ViewVC Help
Powered by ViewVC