/[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 3612 by schoenebeck, Mon Sep 30 18:03:43 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  // include the appropriate (unsigned) triangle LFO implementation  #include "LFOAll.h"
 #if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION  
 # include "../common/LFOTriangleIntMath.h"  
 #elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION  
 # include "../common/LFOTriangleIntAbsMath.h"  
 #elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION  
 # include "../common/LFOTriangleDiHarmonic.h"  
 #else  
 # error "Unknown or no (unsigned) triangle LFO implementation selected!"  
 #endif  
   
 // include the appropriate (signed) triangle LFO implementation  
 #if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION  
 # include "../common/LFOTriangleIntMath.h"  
 #elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION  
 # include "../common/LFOTriangleIntAbsMath.h"  
 #elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION  
 # include "../common/LFOTriangleDiHarmonic.h"  
 #else  
 # error "Unknown or no (signed) triangle LFO implementation selected!"  
 #endif  
43    
44  namespace LinuxSampler {  namespace LinuxSampler {
45    
     #if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION  
     typedef LFOTriangleIntMath<range_unsigned> LFOUnsigned;  
     #elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION  
     typedef LFOTriangleIntAbsMath<range_unsigned> LFOUnsigned;  
     #elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION  
     typedef LFOTriangleDiHarmonic<range_unsigned> LFOUnsigned;  
     #endif  
   
     #if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION  
     typedef LFOTriangleIntMath<range_signed> LFOSigned;  
     #elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION  
     typedef LFOTriangleIntAbsMath<range_signed> LFOSigned;  
     #elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION  
     typedef LFOTriangleDiHarmonic<range_signed> LFOSigned;  
     #endif  
   
46      class AbstractVoice : public Voice {      class AbstractVoice : public Voice {
47          public:          public:
48              type_t       Type;         ///< Voice Type              type_t       Type;         ///< Voice Type (bit field, a voice may have several types)
49              int          MIDIKey;      ///< MIDI key number of the key that triggered the voice              NoteBase*    pNote;        ///< Note this voice belongs to and was caused by.
50              uint         KeyGroup;              int          MIDIPan;      ///< the current MIDI pan value plus the value from RegionInfo
51    
52                SignalUnitRack* const pSignalUnitRack;
53    
54              AbstractVoice();              AbstractVoice(SignalUnitRack* pRack);
55              virtual ~AbstractVoice();              virtual ~AbstractVoice();
56    
57              inline bool IsActive() { return PlaybackState; }              inline bool IsActive() { return PlaybackState; }
# Line 100  namespace LinuxSampler { Line 67  namespace LinuxSampler {
67                  int                     iKeyGroup                  int                     iKeyGroup
68              );              );
69    
70                /** Invoked when the voice is freed - gone from active to inactive. */
71                virtual void VoiceFreed() { }
72    
73              virtual void Synthesize(uint Samples, sample_t* pSrc, uint Skip);              virtual void Synthesize(uint Samples, sample_t* pSrc, uint Skip);
74    
75                virtual release_trigger_t GetReleaseTriggerFlags() = 0;
76    
77                uint GetSampleRate() { return GetEngine()->SampleRate; }
78                
79                uint8_t GetControllerValue(uint8_t Controller) {
80                    return (Controller > 128) ? 0 : pEngineChannel->ControllerTable[Controller];
81                }
82    
83                /// Keyboard key on which this voice should listen to transitional events (i.e. note-off events to release the voice).
84                inline uint8_t HostKey() const { return pNote->hostKey; }
85                /// Keyboard key which the voice should use for calculating any synthesis relevant parameters (i.e. pitch).
86                inline uint8_t MIDIKey() const { return pNote->cause.Param.Note.Key; }
87                /// MIDI note-on velocity value which the voice should use for calculating any synthesis relevant parameters (i.e. amplitude).
88                inline uint8_t MIDIVelocity() const { return pNote->cause.Param.Note.Velocity; }
89    
90              void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);              void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);
91              void processPitchEvent(RTList<Event>::Iterator& itEvent);              void processPitchEvent(RTList<Event>::Iterator& itEvent);
92              void processResonanceEvent(RTList<Event>::Iterator& itEvent);              void processResonanceEvent(RTList<Event>::Iterator& itEvent);
93              void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);              void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);
94                void processGroupEvents(RTList<Event>::Iterator& itEvent, uint End);
95              void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);              void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);
96              void Kill(Pool<Event>::Iterator& itKillEvent);              void Kill(Pool<Event>::Iterator& itKillEvent);
97                void CreateEq();
98                void onScaleTuningChanged();
99    
100              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.
101              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 103  namespace LinuxSampler {
103    
104              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;
105    
106            #if CONFIG_DEVMODE
107            public:
108            #else
109          protected:          protected:
110            #endif
111              SampleInfo      SmplInfo;              SampleInfo      SmplInfo;
112              RegionInfo      RgnInfo;              RegionInfo      RgnInfo;
113              InstrumentInfo  InstrInfo;              InstrumentInfo  InstrInfo;
# Line 123  namespace LinuxSampler { Line 115  namespace LinuxSampler {
115    
116              double                      Pos;                ///< Current playback position in sample              double                      Pos;                ///< Current playback position in sample
117              PitchInfo                   Pitch;              PitchInfo                   Pitch;
118                Fade                        NotePitch;          ///< Updated by calls to built-in instrument script function change_tune() (defaults to 1.0, that is neutral).
119              float                       CutoffBase;         ///< Cutoff frequency before control change, EG and LFO are applied              float                       CutoffBase;         ///< Cutoff frequency before control change, EG and LFO are applied
120              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.
121              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.
122                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).
123                NoteBase::Norm              NoteCutoff;         ///< Updated by calls to built-in instrument script function change_cutoff() (defaults to 1.0, that is neutral).
124                NoteBase::Norm              NoteResonance;      ///< Updated by calls to built-in instrument script function change_reso() (defaults to 1.0, that is neutral).
125              gig::SmoothVolume           CrossfadeSmoother;  ///< Crossfade volume, updated by crossfade CC events              gig::SmoothVolume           CrossfadeSmoother;  ///< Crossfade volume, updated by crossfade CC events
126              gig::SmoothVolume           VolumeSmoother;     ///< Volume, updated by CC 7 (volume) events              gig::SmoothVolume           VolumeSmoother;     ///< Volume, updated by CC 7 (volume) events
127              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.
128              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.
129                Fade                        NoteVolume;         ///< Note's global volume, updated by change_vol() real-time instrument script calls (defaults to 1.0, that is neutral).
130              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
131              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
132              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.
133              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
134              EG*                         pEG1;               ///< Envelope Generator 1 (Amplification)              EG*                         pEG1;               ///< Envelope Generator 1 (Amplification)
135              gig::EGADSR                 EG2;                ///< Envelope Generator 2 (Filter cutoff frequency) TODO: use common EG instead of gig              EG*                         pEG2;               ///< Envelope Generator 2 (Filter cutoff frequency)
136              gig::EGDecay                EG3;                ///< Envelope Generator 3 (Pitch) TODO: use common EG instead?              gig::EGDecay                EG3;                ///< Envelope Generator 3 (Pitch) TODO: use common EG instead?
137              midi_ctrl                   VCFCutoffCtrl;              midi_ctrl                   VCFCutoffCtrl;
138              midi_ctrl                   VCFResonanceCtrl;              midi_ctrl                   VCFResonanceCtrl;
# Line 152  namespace LinuxSampler { Line 149  namespace LinuxSampler {
149              float                       fFinalResonance;              float                       fFinalResonance;
150              gig::SynthesisParam         finalSynthesisParameters;              gig::SynthesisParam         finalSynthesisParameters;
151              gig::Loop                   loop;              gig::Loop                   loop;
152                RTList<Event>*              pGroupEvents;        ///< Events directed to an exclusive group
153                
154                EqSupport* pEq;         ///< Used for per voice equalization
155                bool       bEqSupport;
156                
157                void PrintEqInfo() {
158                    if (!bEqSupport || pEq == NULL) {
159                        dmsg(1,("EQ support: no\n"));
160                    } else {
161                        pEq->PrintInfo();
162                    }
163                }
164    
165              virtual AbstractEngine* GetEngine() = 0;              virtual AbstractEngine* GetEngine() = 0;
166              virtual SampleInfo      GetSampleInfo() = 0;              virtual SampleInfo      GetSampleInfo() = 0;
# Line 160  namespace LinuxSampler { Line 168  namespace LinuxSampler {
168              virtual InstrumentInfo  GetInstrumentInfo() = 0;              virtual InstrumentInfo  GetInstrumentInfo() = 0;
169    
170              /**              /**
171                 * Most of the important members of the voice are set when the voice
172                 * is triggered (like pEngineChannel, pRegion, pSample, etc).
173                 * This method is called after these members are set and before
174                 * the voice is actually triggered.
175                 * Override this method if you need to do some additional
176                 * initialization which depends on these members before the voice
177                 * is triggered.
178                 */
179                virtual void AboutToTrigger() { }
180    
181                virtual bool EG1Finished();
182    
183                /**
184               * Gets the sample cache size in bytes.               * Gets the sample cache size in bytes.
185               */               */
186              virtual unsigned long GetSampleCacheSize() = 0;              virtual unsigned long GetSampleCacheSize() = 0;
187                
188                /**
189                 * Because in most cases we cache part of the sample in RAM, if the
190                 * offset is too big (will extend beyond the RAM cache if the cache contains
191                 * the beginning of the sample) we should cache in the RAM buffer not the
192                 * beginning of the sample but a part that starts from the sample offset point.
193                 * In that case the current sample position should start from zero (Pos).
194                 * When the offset fits into RAM buffer or the whole sample is cached
195                 * in RAM, Pos should contain the actual offset.
196                 * We don't trim the sample because it might have a defined
197                 * loop start point before the start point of the playback.
198                 */
199                virtual void SetSampleStartOffset();
200    
201              /**              /**
202               * 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 222  namespace LinuxSampler {
222               */               */
223              virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0;              virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0;
224    
225                virtual MidiKeyBase* GetMidiKeyInfo(int MIDIKey) = 0;
226    
227              virtual int   OrderNewStream() = 0;              virtual int   OrderNewStream() = 0;
228    
229              virtual PitchInfo CalculatePitchInfo(int PitchBend);              virtual PitchInfo CalculatePitchInfo(int PitchBend);
# Line 224  namespace LinuxSampler { Line 260  namespace LinuxSampler {
260               */               */
261              virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) = 0;              virtual EGInfo CalculateEG2ControllerInfluence(double eg2ControllerValue) = 0;
262    
263                virtual void TriggerEG2(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0;
264    
265              virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) = 0;              virtual float CalculateCutoffBase(uint8_t MIDIKeyVelocity) = 0;
266              virtual float CalculateFinalCutoff(float cutoffBase) = 0;              virtual float CalculateFinalCutoff(float cutoffBase) = 0;
267    
# Line 237  namespace LinuxSampler { Line 275  namespace LinuxSampler {
275    
276              virtual void    GetFirstEventOnKey(uint8_t MIDIKey, RTList<Event>::Iterator& itEvent) = 0;              virtual void    GetFirstEventOnKey(uint8_t MIDIKey, RTList<Event>::Iterator& itEvent) = 0;
277              virtual void    ProcessCCEvent(RTList<Event>::Iterator& itEvent) = 0;              virtual void    ProcessCCEvent(RTList<Event>::Iterator& itEvent) = 0;
278                virtual void    ProcessChannelPressureEvent(RTList<Event>::Iterator& itEvent) = 0;
279                virtual void    ProcessPolyphonicKeyPressureEvent(RTList<Event>::Iterator& itEvent) = 0;
280              virtual void    ProcessCutoffEvent(RTList<Event>::Iterator& itEvent) = 0;              virtual void    ProcessCutoffEvent(RTList<Event>::Iterator& itEvent) = 0;
281              virtual double  GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0;              virtual double  GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0;
282    
283              virtual unsigned long GetNoteOnTime(int MIDIKey) = 0;              virtual unsigned long GetNoteOnTime(int MIDIKey) = 0;
284    
285                virtual void    ProcessGroupEvent(RTList<Event>::Iterator& itEvent) = 0;
286                void            EnterReleaseStage();
287    
288                virtual int     CalculatePan(uint8_t pan) = 0;
289      };      };
290  } // namespace LinuxSampler  } // namespace LinuxSampler
291    
292  #endif  /* __LS_ABSTRACTVOICE_H__ */  #endif  /* __LS_ABSTRACTVOICE_H__ */
Legend:
Removed from v.2061  
changed lines
  Added in v.3612
  ViewVC Help
Powered by ViewVC