/[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 2061 by persson, Tue Feb 23 18:32:31 2010 UTC revision 2935 by schoenebeck, Sun Jul 10 14:24:13 2016 UTC
# Line 4  Line 4 
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-2008 Christian Schoenebeck                         *   *   Copyright (C) 2005-2008 Christian Schoenebeck                         *
7   *   Copyright (C) 2009-2010 Christian Schoenebeck and 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 37  Line 37 
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 80  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 100  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 123  namespace LinuxSampler { Line 145  namespace LinuxSampler {
145    
146              double                      Pos;                ///< Current playback position in sample              double                      Pos;                ///< Current playback position in sample
147              PitchInfo                   Pitch;              PitchInfo                   Pitch;
148                float                       NotePitch;          ///< Updated by calls to built-in instrument script function change_tune() (defaults to 1.0, that is neutral).
149              float                       CutoffBase;         ///< Cutoff frequency before control change, EG and LFO are applied              float                       CutoffBase;         ///< Cutoff frequency before control change, EG and LFO are applied
150              float                       VolumeLeft;         ///< Left channel volume. This factor is calculated when the voice is triggered and doesn't change after that.              float                       VolumeLeft;         ///< Left channel volume. This factor is calculated when the voice is triggered and doesn't change after that.
151              float                       VolumeRight;        ///< Right channel volume. This factor is calculated when the voice is triggered and doesn't change after that.              float                       VolumeRight;        ///< Right channel volume. This factor is calculated when the voice is triggered and doesn't change after that.
152                float                       NotePanLeft;        ///< Updated by calls to built-in instrument script function change_pan() (defaults to 1.0, that is neutral).
153                float                       NotePanRight;       ///< Updated by calls to built-in instrument script function change_pan() (defaults to 1.0, that is neutral).
154                float                       NoteCutoff;         ///< Updated by calls to built-in instrument script function change_cutoff() (defaults to 1.0, that is neutral).
155                float                       NoteResonance;      ///< Updated by calls to built-in instrument script function change_reso() (defaults to 1.0, that is neutral).
156              gig::SmoothVolume           CrossfadeSmoother;  ///< Crossfade volume, updated by crossfade CC events              gig::SmoothVolume           CrossfadeSmoother;  ///< Crossfade volume, updated by crossfade CC events
157              gig::SmoothVolume           VolumeSmoother;     ///< Volume, updated by CC 7 (volume) events              gig::SmoothVolume           VolumeSmoother;     ///< Volume, updated by CC 7 (volume) events
158              gig::SmoothVolume           PanLeftSmoother;    ///< Left channel volume, updated by CC 10 (pan) events              gig::SmoothVolume           PanLeftSmoother;    ///< Left channel volume, updated by CC 10 (pan) events and change_pan() real-time instrument script calls.
159              gig::SmoothVolume           PanRightSmoother;   ///< Right channel volume, updated by CC 10 (pan) events              gig::SmoothVolume           PanRightSmoother;   ///< Right channel volume, updated by CC 10 (pan) events and change_pan() real-time instrument script calls.
160                gig::SmoothVolume           NoteVolumeSmoother; ///< Note's global volume, updated by change_vol() real-time instrument script calls.
161              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              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
162              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
163              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.
164              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
165              EG*                         pEG1;               ///< Envelope Generator 1 (Amplification)              EG*                         pEG1;               ///< Envelope Generator 1 (Amplification)
166              gig::EGADSR                 EG2;                ///< Envelope Generator 2 (Filter cutoff frequency) TODO: use common EG instead of gig              EG*                         pEG2;               ///< Envelope Generator 2 (Filter cutoff frequency)
167              gig::EGDecay                EG3;                ///< Envelope Generator 3 (Pitch) TODO: use common EG instead?              gig::EGDecay                EG3;                ///< Envelope Generator 3 (Pitch) TODO: use common EG instead?
168              midi_ctrl                   VCFCutoffCtrl;              midi_ctrl                   VCFCutoffCtrl;
169              midi_ctrl                   VCFResonanceCtrl;              midi_ctrl                   VCFResonanceCtrl;
# Line 152  namespace LinuxSampler { Line 180  namespace LinuxSampler {
180              float                       fFinalResonance;              float                       fFinalResonance;
181              gig::SynthesisParam         finalSynthesisParameters;              gig::SynthesisParam         finalSynthesisParameters;
182              gig::Loop                   loop;              gig::Loop                   loop;
183                RTList<Event>*              pGroupEvents;        ///< Events directed to an exclusive group
184                
185                EqSupport* pEq;         ///< Used for per voice equalization
186                bool       bEqSupport;
187                
188                void PrintEqInfo() {
189                    if (!bEqSupport || pEq == NULL) {
190                        dmsg(1,("EQ support: no\n"));
191                    } else {
192                        pEq->PrintInfo();
193                    }
194                }
195    
196              virtual AbstractEngine* GetEngine() = 0;              virtual AbstractEngine* GetEngine() = 0;
197              virtual SampleInfo      GetSampleInfo() = 0;              virtual SampleInfo      GetSampleInfo() = 0;
# Line 160  namespace LinuxSampler { Line 199  namespace LinuxSampler {
199              virtual InstrumentInfo  GetInstrumentInfo() = 0;              virtual InstrumentInfo  GetInstrumentInfo() = 0;
200    
201              /**              /**
202                 * Most of the important members of the voice are set when the voice
203                 * is triggered (like pEngineChannel, pRegion, pSample, etc).
204                 * This method is called after these members are set and before
205                 * the voice is actually triggered.
206                 * Override this method if you need to do some additional
207                 * initialization which depends on these members before the voice
208                 * is triggered.
209                 */
210                virtual void AboutToTrigger() { }
211    
212                virtual bool EG1Finished();
213    
214                /**
215               * Gets the sample cache size in bytes.               * Gets the sample cache size in bytes.
216               */               */
217              virtual unsigned long GetSampleCacheSize() = 0;              virtual unsigned long GetSampleCacheSize() = 0;
218                
219                /**
220                 * Because in most cases we cache part of the sample in RAM, if the
221                 * offset is too big (will extend beyond the RAM cache if the cache contains
222                 * the beginning of the sample) we should cache in the RAM buffer not the
223                 * beginning of the sample but a part that starts from the sample offset point.
224                 * In that case the current sample position should start from zero (Pos).
225                 * When the offset fits into RAM buffer or the whole sample is cached
226                 * in RAM, Pos should contain the actual offset.
227                 * We don't trim the sample because it might have a defined
228                 * loop start point before the start point of the playback.
229                 */
230                virtual void SetSampleStartOffset();
231    
232              /**              /**
233               * Returns the correct amplitude factor for the given \a MIDIKeyVelocity.               * Returns the correct amplitude factor for the given \a MIDIKeyVelocity.
# Line 188  namespace LinuxSampler { Line 253  namespace LinuxSampler {
253               */               */
254              virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0;              virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0;
255    
256                virtual MidiKeyBase* GetMidiKeyInfo(int MIDIKey) = 0;
257    
258              virtual int   OrderNewStream() = 0;              virtual int   OrderNewStream() = 0;
259    
260              virtual PitchInfo CalculatePitchInfo(int PitchBend);              virtual PitchInfo CalculatePitchInfo(int PitchBend);
# Line 224  namespace LinuxSampler { Line 291  namespace LinuxSampler {
291               */               */
292              virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) = 0;              virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) = 0;
293    
294                virtual void TriggerEG2(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;
295    
296              virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) = 0;              virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) = 0;
297              virtual float CalculateFinalCutoff(float cutoffBase) = 0;              virtual float CalculateFinalCutoff(float cutoffBase) = 0;
298    
# Line 237  namespace LinuxSampler { Line 306  namespace LinuxSampler {
306    
307              virtual void    GetFirstEventOnKey(uint8_t MIDIKey, RTList<Event>::Iterator& itEvent) = 0;              virtual void    GetFirstEventOnKey(uint8_t MIDIKey, RTList<Event>::Iterator& itEvent) = 0;
308              virtual void    ProcessCCEvent(RTList<Event>::Iterator& itEvent) = 0;              virtual void    ProcessCCEvent(RTList<Event>::Iterator& itEvent) = 0;
309                virtual void    ProcessChannelPressureEvent(RTList<Event>::Iterator& itEvent) = 0;
310                virtual void    ProcessPolyphonicKeyPressureEvent(RTList<Event>::Iterator& itEvent) = 0;
311              virtual void    ProcessCutoffEvent(RTList<Event>::Iterator& itEvent) = 0;              virtual void    ProcessCutoffEvent(RTList<Event>::Iterator& itEvent) = 0;
312              virtual double  GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0;              virtual double  GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0;
313    
314              virtual unsigned long GetNoteOnTime(int MIDIKey) = 0;              virtual unsigned long GetNoteOnTime(int MIDIKey) = 0;
315    
316                virtual void    ProcessGroupEvent(RTList<Event>::Iterator& itEvent) = 0;
317                void            EnterReleaseStage();
318    
319                virtual int     CalculatePan(uint8_t pan) = 0;
320      };      };
321  } // namespace LinuxSampler  } // namespace LinuxSampler
322    
323  #endif  /* __LS_ABSTRACTVOICE_H__ */  #endif  /* __LS_ABSTRACTVOICE_H__ */
Legend:
Removed from v.2061  
changed lines
  Added in v.2935
  ViewVC Help
Powered by ViewVC