/[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 3561 by schoenebeck, Fri Aug 23 11:44:00 2019 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    
30  #include "../../common/global_private.h"  #include "../../common/global_private.h"
31  #include "../AbstractEngineChannel.h"  #include "../AbstractEngineChannel.h"
32  #include "../common/LFOBase.h"  #include "LFOBase.h"
33    #include "Fade.h"
34  #include "../EngineBase.h"  #include "../EngineBase.h"
35  #include "EG.h"  #include "EG.h"
36  #include "../gig/EGADSR.h"  #include "../gig/EGADSR.h"
# Line 37  Line 38 
38  #include "../gig/SmoothVolume.h"  #include "../gig/SmoothVolume.h"
39  #include "../gig/Synthesizer.h"  #include "../gig/Synthesizer.h"
40  #include "../gig/Profiler.h"  #include "../gig/Profiler.h"
41    #include "SignalUnitRack.h"
42    
43  // include the appropriate (unsigned) triangle LFO implementation  // include the appropriate (unsigned) triangle LFO implementation
44  #if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION  #if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
45  # include "../common/LFOTriangleIntMath.h"  # include "LFOTriangleIntMath.h"
46  #elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION  #elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
47  # include "../common/LFOTriangleIntAbsMath.h"  # include "LFOTriangleIntAbsMath.h"
48  #elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION  #elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
49  # include "../common/LFOTriangleDiHarmonic.h"  # include "LFOTriangleDiHarmonic.h"
50  #else  #else
51  # error "Unknown or no (unsigned) triangle LFO implementation selected!"  # error "Unknown or no (unsigned) triangle LFO implementation selected!"
52  #endif  #endif
53    
54  // include the appropriate (signed) triangle LFO implementation  // include the appropriate (signed) triangle LFO implementation
55  #if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION  #if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
56  # include "../common/LFOTriangleIntMath.h"  # include "LFOTriangleIntMath.h"
57  #elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION  #elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
58  # include "../common/LFOTriangleIntAbsMath.h"  # include "LFOTriangleIntAbsMath.h"
59  #elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION  #elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
60  # include "../common/LFOTriangleDiHarmonic.h"  # include "LFOTriangleDiHarmonic.h"
61  #else  #else
62  # error "Unknown or no (signed) triangle LFO implementation selected!"  # error "Unknown or no (signed) triangle LFO implementation selected!"
63  #endif  #endif
# Line 80  namespace LinuxSampler { Line 82  namespace LinuxSampler {
82    
83      class AbstractVoice : public Voice {      class AbstractVoice : public Voice {
84          public:          public:
85              type_t       Type;         ///< Voice Type              type_t       Type;         ///< Voice Type (bit field, a voice may have several types)
86              int          MIDIKey;      ///< MIDI key number of the key that triggered the voice              NoteBase*    pNote;        ///< Note this voice belongs to and was caused by.
87              uint         KeyGroup;              int          MIDIPan;      ///< the current MIDI pan value plus the value from RegionInfo
88    
89              AbstractVoice();              SignalUnitRack* const pSignalUnitRack;
90    
91                AbstractVoice(SignalUnitRack* pRack);
92              virtual ~AbstractVoice();              virtual ~AbstractVoice();
93    
94              inline bool IsActive() { return PlaybackState; }              inline bool IsActive() { return PlaybackState; }
# Line 100  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                virtual release_trigger_t GetReleaseTriggerFlags() = 0;
113    
114                uint GetSampleRate() { return GetEngine()->SampleRate; }
115                
116                uint8_t GetControllerValue(uint8_t Controller) {
117                    return (Controller > 128) ? 0 : pEngineChannel->ControllerTable[Controller];
118                }
119    
120                /// Keyboard key on which this voice should listen to transitional events (i.e. note-off events to release the voice).
121                inline uint8_t HostKey() const { return pNote->hostKey; }
122                /// Keyboard key which the voice should use for calculating any synthesis relevant parameters (i.e. pitch).
123                inline uint8_t MIDIKey() const { return pNote->cause.Param.Note.Key; }
124                /// MIDI note-on velocity value which the voice should use for calculating any synthesis relevant parameters (i.e. amplitude).
125                inline uint8_t MIDIVelocity() const { return pNote->cause.Param.Note.Velocity; }
126    
127              void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);              void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);
128              void processPitchEvent(RTList<Event>::Iterator& itEvent);              void processPitchEvent(RTList<Event>::Iterator& itEvent);
129              void processResonanceEvent(RTList<Event>::Iterator& itEvent);              void processResonanceEvent(RTList<Event>::Iterator& itEvent);
130              void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);              void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);
131                void processGroupEvents(RTList<Event>::Iterator& itEvent, uint End);
132              void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);              void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);
133              void Kill(Pool<Event>::Iterator& itKillEvent);              void Kill(Pool<Event>::Iterator& itKillEvent);
134                void CreateEq();
135                void onScaleTuningChanged();
136    
137              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.
138              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 115  namespace LinuxSampler { Line 140  namespace LinuxSampler {
140    
141              template<class TV, class TRR, class TR, class TD, class TIM, class TI> friend class EngineBase;              template<class TV, class TRR, class TR, class TD, class TIM, class TI> friend class EngineBase;
142    
143            #if CONFIG_DEVMODE
144            public:
145            #else
146          protected:          protected:
147            #endif
148              SampleInfo      SmplInfo;              SampleInfo      SmplInfo;
149              RegionInfo      RgnInfo;              RegionInfo      RgnInfo;
150              InstrumentInfo  InstrInfo;              InstrumentInfo  InstrInfo;
# Line 123  namespace LinuxSampler { Line 152  namespace LinuxSampler {
152    
153              double                      Pos;                ///< Current playback position in sample              double                      Pos;                ///< Current playback position in sample
154              PitchInfo                   Pitch;              PitchInfo                   Pitch;
155                Fade                        NotePitch;          ///< Updated by calls to built-in instrument script function change_tune() (defaults to 1.0, that is neutral).
156              float                       CutoffBase;         ///< Cutoff frequency before control change, EG and LFO are applied              float                       CutoffBase;         ///< Cutoff frequency before control change, EG and LFO are applied
157              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.
158              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.
159                Fade                        NotePan[2];         ///< Updated by calls to built-in instrument script function change_pan() (defaults to 1.0, that is neutral, index 0 for left pan, index 1 for right).
160                NoteBase::Norm              NoteCutoff;         ///< Updated by calls to built-in instrument script function change_cutoff() (defaults to 1.0, that is neutral).
161                NoteBase::Norm              NoteResonance;      ///< Updated by calls to built-in instrument script function change_reso() (defaults to 1.0, that is neutral).
162              gig::SmoothVolume           CrossfadeSmoother;  ///< Crossfade volume, updated by crossfade CC events              gig::SmoothVolume           CrossfadeSmoother;  ///< Crossfade volume, updated by crossfade CC events
163              gig::SmoothVolume           VolumeSmoother;     ///< Volume, updated by CC 7 (volume) events              gig::SmoothVolume           VolumeSmoother;     ///< Volume, updated by CC 7 (volume) events
164              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.
165              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.
166                Fade                        NoteVolume;         ///< Note's global volume, updated by change_vol() real-time instrument script calls (defaults to 1.0, that is neutral).
167              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
168              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
169              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.
170              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
171              EG*                         pEG1;               ///< Envelope Generator 1 (Amplification)              EG*                         pEG1;               ///< Envelope Generator 1 (Amplification)
172              gig::EGADSR                 EG2;                ///< Envelope Generator 2 (Filter cutoff frequency) TODO: use common EG instead of gig              EG*                         pEG2;               ///< Envelope Generator 2 (Filter cutoff frequency)
173              gig::EGDecay                EG3;                ///< Envelope Generator 3 (Pitch) TODO: use common EG instead?              gig::EGDecay                EG3;                ///< Envelope Generator 3 (Pitch) TODO: use common EG instead?
174              midi_ctrl                   VCFCutoffCtrl;              midi_ctrl                   VCFCutoffCtrl;
175              midi_ctrl                   VCFResonanceCtrl;              midi_ctrl                   VCFResonanceCtrl;
# Line 152  namespace LinuxSampler { Line 186  namespace LinuxSampler {
186              float                       fFinalResonance;              float                       fFinalResonance;
187              gig::SynthesisParam         finalSynthesisParameters;              gig::SynthesisParam         finalSynthesisParameters;
188              gig::Loop                   loop;              gig::Loop                   loop;
189                RTList<Event>*              pGroupEvents;        ///< Events directed to an exclusive group
190                
191                EqSupport* pEq;         ///< Used for per voice equalization
192                bool       bEqSupport;
193                
194                void PrintEqInfo() {
195                    if (!bEqSupport || pEq == NULL) {
196                        dmsg(1,("EQ support: no\n"));
197                    } else {
198                        pEq->PrintInfo();
199                    }
200                }
201    
202              virtual AbstractEngine* GetEngine() = 0;              virtual AbstractEngine* GetEngine() = 0;
203              virtual SampleInfo      GetSampleInfo() = 0;              virtual SampleInfo      GetSampleInfo() = 0;
# Line 160  namespace LinuxSampler { Line 205  namespace LinuxSampler {
205              virtual InstrumentInfo  GetInstrumentInfo() = 0;              virtual InstrumentInfo  GetInstrumentInfo() = 0;
206    
207              /**              /**
208                 * Most of the important members of the voice are set when the voice
209                 * is triggered (like pEngineChannel, pRegion, pSample, etc).
210                 * This method is called after these members are set and before
211                 * the voice is actually triggered.
212                 * Override this method if you need to do some additional
213                 * initialization which depends on these members before the voice
214                 * is triggered.
215                 */
216                virtual void AboutToTrigger() { }
217    
218                virtual bool EG1Finished();
219    
220                /**
221               * Gets the sample cache size in bytes.               * Gets the sample cache size in bytes.
222               */               */
223              virtual unsigned long GetSampleCacheSize() = 0;              virtual unsigned long GetSampleCacheSize() = 0;
224                
225                /**
226                 * Because in most cases we cache part of the sample in RAM, if the
227                 * offset is too big (will extend beyond the RAM cache if the cache contains
228                 * the beginning of the sample) we should cache in the RAM buffer not the
229                 * beginning of the sample but a part that starts from the sample offset point.
230                 * In that case the current sample position should start from zero (Pos).
231                 * When the offset fits into RAM buffer or the whole sample is cached
232                 * in RAM, Pos should contain the actual offset.
233                 * We don't trim the sample because it might have a defined
234                 * loop start point before the start point of the playback.
235                 */
236                virtual void SetSampleStartOffset();
237    
238              /**              /**
239               * 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 259  namespace LinuxSampler {
259               */               */
260              virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0;              virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0;
261    
262                virtual MidiKeyBase* GetMidiKeyInfo(int MIDIKey) = 0;
263    
264              virtual int   OrderNewStream() = 0;              virtual int   OrderNewStream() = 0;
265    
266              virtual PitchInfo CalculatePitchInfo(int PitchBend);              virtual PitchInfo CalculatePitchInfo(int PitchBend);
# Line 224  namespace LinuxSampler { Line 297  namespace LinuxSampler {
297               */               */
298              virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) = 0;              virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) = 0;
299    
300                virtual void TriggerEG2(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;
301    
302              virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) = 0;              virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) = 0;
303              virtual float CalculateFinalCutoff(float cutoffBase) = 0;              virtual float CalculateFinalCutoff(float cutoffBase) = 0;
304    
# Line 237  namespace LinuxSampler { Line 312  namespace LinuxSampler {
312    
313              virtual void    GetFirstEventOnKey(uint8_t MIDIKey, RTList<Event>::Iterator& itEvent) = 0;              virtual void    GetFirstEventOnKey(uint8_t MIDIKey, RTList<Event>::Iterator& itEvent) = 0;
314              virtual void    ProcessCCEvent(RTList<Event>::Iterator& itEvent) = 0;              virtual void    ProcessCCEvent(RTList<Event>::Iterator& itEvent) = 0;
315                virtual void    ProcessChannelPressureEvent(RTList<Event>::Iterator& itEvent) = 0;
316                virtual void    ProcessPolyphonicKeyPressureEvent(RTList<Event>::Iterator& itEvent) = 0;
317              virtual void    ProcessCutoffEvent(RTList<Event>::Iterator& itEvent) = 0;              virtual void    ProcessCutoffEvent(RTList<Event>::Iterator& itEvent) = 0;
318              virtual double  GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0;              virtual double  GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0;
319    
320              virtual unsigned long GetNoteOnTime(int MIDIKey) = 0;              virtual unsigned long GetNoteOnTime(int MIDIKey) = 0;
321    
322                virtual void    ProcessGroupEvent(RTList<Event>::Iterator& itEvent) = 0;
323                void            EnterReleaseStage();
324    
325                virtual int     CalculatePan(uint8_t pan) = 0;
326      };      };
327  } // namespace LinuxSampler  } // namespace LinuxSampler
328    
329  #endif  /* __LS_ABSTRACTVOICE_H__ */  #endif  /* __LS_ABSTRACTVOICE_H__ */
Legend:
Removed from v.2061  
changed lines
  Added in v.3561
  ViewVC Help
Powered by ViewVC