/[svn]/linuxsampler/trunk/src/engines/gig/Voice.h
ViewVC logotype

Diff of /linuxsampler/trunk/src/engines/gig/Voice.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 319 by schoenebeck, Mon Dec 13 00:46:42 2004 UTC revision 1038 by persson, Sat Feb 3 15:33:00 2007 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, 2006 Christian Schoenebeck                        *
7   *                                                                         *   *                                                                         *
8   *   This program is free software; you can redistribute it and/or modify  *   *   This program is free software; you can redistribute it and/or modify  *
9   *   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 25  Line 26 
26    
27  #include "../../common/global.h"  #include "../../common/global.h"
28    
29  #if DEBUG_HEADERS  #include <gig.h>
 # warning Voice.h included  
 #endif // DEBUG_HEADERS  
30    
31  #include "../../common/RTMath.h"  #include "../../common/RTMath.h"
 #include "../../common/RingBuffer.h"  
32  #include "../../common/Pool.h"  #include "../../common/Pool.h"
33  #include "../../drivers/audio/AudioOutputDevice.h"  #include "../../drivers/audio/AudioOutputDevice.h"
 #include "../../lib/fileloader/libgig/gig.h"  
 #include "../common/BiquadFilter.h"  
34  #include "Engine.h"  #include "Engine.h"
35    #include "EngineChannel.h"
36  #include "Stream.h"  #include "Stream.h"
37  #include "DiskThread.h"  #include "DiskThread.h"
38    #include "EGADSR.h"
39  #include "EGDecay.h"  #include "EGDecay.h"
40  #include "Filter.h"  #include "Filter.h"
41  #include "../common/LFO.h"  #include "../common/LFOBase.h"
42    #include "SynthesisParam.h"
43  #define FILTER_UPDATE_PERIOD            64 ///< amount of sample points after which filter parameters (cutoff, resonance) are going to be updated (higher value means less CPU load, but also worse parameter resolution, this value will be aligned to a power of two)  #include "SmoothVolume.h"
44  #define FORCE_FILTER_USAGE              0  ///< if set to 1 then filter is always used, if set to 0 filter is used only in case the instrument file defined one  
45  #define FILTER_CUTOFF_MAX               10000.0f ///< maximum cutoff frequency (10kHz)  // include the appropriate (unsigned) triangle LFO implementation
46  #define FILTER_CUTOFF_MIN               100.0f   ///< minimum cutoff frequency (100Hz)  #if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
47    # include "../common/LFOTriangleIntMath.h"
48  // Uncomment following line to override external cutoff controller  #elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
49  //#define OVERRIDE_FILTER_CUTOFF_CTRL   1  ///< set to an arbitrary MIDI control change controller (e.g. 1 for 'modulation wheel')  # include "../common/LFOTriangleIntAbsMath.h"
50    #elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
51  // Uncomment following line to override external resonance controller  # include "../common/LFOTriangleDiHarmonic.h"
52  //#define OVERRIDE_FILTER_RES_CTRL      91  ///< set to an arbitrary MIDI control change controller (e.g. 91 for 'effect 1 depth')  #else
53    # error "Unknown or no (unsigned) triangle LFO implementation selected!"
54  // Uncomment following line to override filter type  #endif
55  //#define OVERRIDE_FILTER_TYPE          ::gig::vcf_type_lowpass  ///< either ::gig::vcf_type_lowpass, ::gig::vcf_type_bandpass or ::gig::vcf_type_highpass  
56    // include the appropriate (signed) triangle LFO implementation
57    #if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
58    # include "../common/LFOTriangleIntMath.h"
59    #elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
60    # include "../common/LFOTriangleIntAbsMath.h"
61    #elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
62    # include "../common/LFOTriangleDiHarmonic.h"
63    #else
64    # error "Unknown or no (signed) triangle LFO implementation selected!"
65    #endif
66    
67  namespace LinuxSampler { namespace gig {  namespace LinuxSampler { namespace gig {
68    
69      class Engine;      class Engine;
     class EGADSR;  
     class VCAManipulator;  
     class VCFCManipulator;  
     class VCOManipulator;  
70    
71      /// Reflects a MIDI controller      /// Reflects a MIDI controller
72      struct midi_ctrl {      struct midi_ctrl {
# Line 72  namespace LinuxSampler { namespace gig { Line 75  namespace LinuxSampler { namespace gig {
75          float   fvalue;     ///< Transformed / effective value (e.g. volume level or filter cutoff frequency)          float   fvalue;     ///< Transformed / effective value (e.g. volume level or filter cutoff frequency)
76      };      };
77    
78        #if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
79        typedef LFOTriangleIntMath<range_unsigned> LFOUnsigned;
80        #elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
81        typedef LFOTriangleIntAbsMath<range_unsigned> LFOUnsigned;
82        #elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
83        typedef LFOTriangleDiHarmonic<range_unsigned> LFOUnsigned;
84        #endif
85    
86        #if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
87        typedef LFOTriangleIntMath<range_signed> LFOSigned;
88        #elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
89        typedef LFOTriangleIntAbsMath<range_signed> LFOSigned;
90        #elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
91        typedef LFOTriangleDiHarmonic<range_signed> LFOSigned;
92        #endif
93    
94      /** Gig Voice      /** Gig Voice
95       *       *
96       * Renders a voice for the Gigasampler format.       * Renders a voice for the Gigasampler format.
# Line 90  namespace LinuxSampler { namespace gig { Line 109  namespace LinuxSampler { namespace gig {
109              int          MIDIKey;      ///< MIDI key number of the key that triggered the voice              int          MIDIKey;      ///< MIDI key number of the key that triggered the voice
110              uint         KeyGroup;              uint         KeyGroup;
111              DiskThread*  pDiskThread;  ///< Pointer to the disk thread, to be able to order a disk stream and later to delete the stream again              DiskThread*  pDiskThread;  ///< Pointer to the disk thread, to be able to order a disk stream and later to delete the stream again
             RTList<Voice>::Iterator itChildVoice; ///< Points to the next layer voice (if any). This field is currently only used by the voice stealing algorithm.  
112    
113              // Methods              // Methods
114              Voice();              Voice();
115             ~Voice();              virtual ~Voice();
116              void Kill(Pool<Event>::Iterator& itKillEvent);              void Kill(Pool<Event>::Iterator& itKillEvent);
117              void Render(uint Samples);              void Render(uint Samples);
118              void Reset();              void Reset();
119              void SetOutput(AudioOutputDevice* pAudioOutputDevice);              void SetOutput(AudioOutputDevice* pAudioOutputDevice);
120              void SetEngine(Engine* pEngine);              void SetEngine(Engine* pEngine);
121              int  Trigger(Pool<Event>::Iterator& itNoteOnEvent, int PitchBend, ::gig::Instrument* pInstrument, int iLayer, bool ReleaseTriggerVoice, bool VoiceStealing);              int  Trigger(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent, int PitchBend, ::gig::DimensionRegion* pDimRgn, type_t VoiceType, int iKeyGroup);
122              inline bool IsActive() { return PlaybackState; }              inline bool IsActive() { return PlaybackState; }
123                inline bool IsStealable() { return !itKillEvent && PlaybackState >= playback_state_ram; }
124                void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);
125    
126          //private:          //private:
127              // Types              // Types
128              enum playback_state_t {              enum playback_state_t {
129                  playback_state_end  = 0,                  playback_state_end  = 0,
130                  playback_state_ram  = 1,                  playback_state_init = 1,
131                  playback_state_disk = 2                  playback_state_ram  = 2,
132                    playback_state_disk = 3
133              };              };
134    
135              // Attributes              // Attributes
136              gig::Engine*                pEngine;            ///< Pointer to the sampler engine, to be able to access the event lists.              EngineChannel*              pEngineChannel;
137              float                       Volume;             ///< Volume level of the voice              Engine*                     pEngine;            ///< Pointer to the sampler engine, to be able to access the event lists.
138              float                       PanLeft;              float                       VolumeLeft;         ///< Left channel volume. This factor is calculated when the voice is triggered and doesn't change after that.
139              float                       PanRight;              float                       VolumeRight;        ///< Right channel volume. This factor is calculated when the voice is triggered and doesn't change after that.
140              float                       CrossfadeVolume;    ///< Current attenuation level caused by a crossfade (only if a crossfade is defined of course)              SmoothVolume                CrossfadeSmoother;  ///< Crossfade volume, updated by crossfade CC events
141                SmoothVolume                VolumeSmoother;     ///< Volume, updated by CC 7 (volume) events
142                SmoothVolume                PanLeftSmoother;    ///< Left channel volume, updated by CC 10 (pan) events
143                SmoothVolume                PanRightSmoother;   ///< Right channel volume, updated by CC 10 (pan) events
144              double                      Pos;                ///< Current playback position in sample              double                      Pos;                ///< Current playback position in sample
145              float                       PitchBase;          ///< Basic pitch depth, stays the same for the whole life time of the voice              float                       PitchBase;          ///< Basic pitch depth, stays the same for the whole life time of the voice
146              float                       PitchBend;          ///< Current pitch value of the pitchbend wheel              float                       PitchBend;          ///< Current pitch value of the pitchbend wheel
147                float                       CutoffBase;         ///< Cutoff frequency before control change, EG and LFO are applied
148              ::gig::Sample*              pSample;            ///< Pointer to the sample to be played back              ::gig::Sample*              pSample;            ///< Pointer to the sample to be played back
             ::gig::Region*              pRegion;            ///< Pointer to the articulation information of the respective keyboard region of this voice  
149              ::gig::DimensionRegion*     pDimRgn;            ///< Pointer to the articulation information of current dimension region of this voice              ::gig::DimensionRegion*     pDimRgn;            ///< Pointer to the articulation information of current dimension region of this voice
150                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.
151              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
152              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
153              Stream::reference_t         DiskStreamRef;      ///< Reference / link to the disk stream              Stream::reference_t         DiskStreamRef;      ///< Reference / link to the disk stream
154                int                         RealSampleWordsLeftToRead; ///< Number of samples left to read, not including the silence added for the interpolator
155              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.
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              uint                        LoopCyclesLeft;     ///< In case there is a RAMLoop and it's not an endless loop; reflects number of loop cycles left to be passed              //uint                        LoopCyclesLeft;     ///< In case there is a RAMLoop and it's not an endless loop; reflects number of loop cycles left to be passed
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              EGADSR*                     pEG1;               ///< Envelope Generator 1 (Amplification)              EGADSR                      EG1;                ///< Envelope Generator 1 (Amplification)
160              EGADSR*                     pEG2;               ///< Envelope Generator 2 (Filter cutoff frequency)              EGADSR                      EG2;                ///< Envelope Generator 2 (Filter cutoff frequency)
161              EGDecay*                    pEG3;               ///< Envelope Generator 3 (Pitch)              EGDecay                     EG3;                ///< Envelope Generator 3 (Pitch)
             Filter                      FilterLeft;  
             Filter                      FilterRight;  
162              midi_ctrl                   VCFCutoffCtrl;              midi_ctrl                   VCFCutoffCtrl;
163              midi_ctrl                   VCFResonanceCtrl;              midi_ctrl                   VCFResonanceCtrl;
164              int                         FilterUpdateCounter; ///< Used to update filter parameters all FILTER_UPDATE_PERIOD samples              LFOUnsigned*                pLFO1;               ///< Low Frequency Oscillator 1 (Amplification)
165              static const float          FILTER_CUTOFF_COEFF;              LFOUnsigned*                pLFO2;               ///< Low Frequency Oscillator 2 (Filter cutoff frequency)
166              static const int            FILTER_UPDATE_MASK;              LFOSigned*                  pLFO3;               ///< Low Frequency Oscillator 3 (Pitch)
167              VCAManipulator*             pVCAManipulator;              bool                        bLFO1Enabled;        ///< Should we use the Amplitude LFO for this voice?
168              VCFCManipulator*            pVCFCManipulator;              bool                        bLFO2Enabled;        ///< Should we use the Filter Cutoff LFO for this voice?
169              VCOManipulator*             pVCOManipulator;              bool                        bLFO3Enabled;        ///< Should we use the Pitch LFO for this voice?
             LFO<gig::VCAManipulator>*   pLFO1;              ///< Low Frequency Oscillator 1 (Amplification)  
             LFO<gig::VCFCManipulator>*  pLFO2;             ///< Low Frequency Oscillator 2 (Filter cutoff frequency)  
             LFO<gig::VCOManipulator>*   pLFO3;              ///< Low Frequency Oscillator 3 (Pitch)  
170              Pool<Event>::Iterator       itTriggerEvent;      ///< First event on the key's list the voice should process (only needed for the first audio fragment in which voice was triggered, after that it will be set to NULL).              Pool<Event>::Iterator       itTriggerEvent;      ///< First event on the key's list the voice should process (only needed for the first audio fragment in which voice was triggered, after that it will be set to NULL).
171          //public: // FIXME: just made public for debugging (sanity check in Engine::RenderAudio()), should be changed to private before the final release          //public: // FIXME: just made public for debugging (sanity check in Engine::RenderAudio()), should be changed to private before the final release
172              Pool<Event>::Iterator       itKillEvent;         ///< Event which caused this voice to be killed              Pool<Event>::Iterator       itKillEvent;         ///< Event which caused this voice to be killed
173          //private:          //private:
174              int                         SynthesisMode;              int                         SynthesisMode;
175              void*                       SynthesizeFragmentFnPtr; ///< Points to the respective synthesis function for the current synthesis mode.              float                       fFinalCutoff;
176                float                       fFinalResonance;
177                SynthesisParam              finalSynthesisParameters;
178                Loop                        loop;
179    
180              // Static Methods              // Static Methods
181              static float CalculateFilterCutoffCoeff();              static float CalculateFilterCutoffCoeff();
             static int   CalculateFilterUpdateMask();  
182    
183              // Methods              // Methods
184              void KillImmediately();              void KillImmediately();
185              void ProcessEvents(uint Samples);              void ProcessEvents(uint Samples);
186              void CalculateBiquadParameters(uint Samples);              void Synthesize(uint Samples, sample_t* pSrc, uint Skip);
187              void UpdateSynthesisMode();              void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);
188              void Synthesize(uint Samples, sample_t* pSrc, int Skip);              void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);
189                void processPitchEvent(RTList<Event>::Iterator& itEvent);
190              inline float CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) {              void processCrossFadeEvent(RTList<Event>::Iterator& itEvent);
191                  return (CrossfadeControllerValue <= pDimRgn->Crossfade.in_start)  ? 0.0f              void processCutoffEvent(RTList<Event>::Iterator& itEvent);
192                       : (CrossfadeControllerValue < pDimRgn->Crossfade.in_end)     ? float(CrossfadeControllerValue - pDimRgn->Crossfade.in_start) / float(pDimRgn->Crossfade.in_end - pDimRgn->Crossfade.in_start)              void processResonanceEvent(RTList<Event>::Iterator& itEvent);
193                       : (CrossfadeControllerValue <= pDimRgn->Crossfade.out_start) ? 1.0f  
194                       : (CrossfadeControllerValue < pDimRgn->Crossfade.out_end)    ? float(CrossfadeControllerValue - pDimRgn->Crossfade.out_start) / float(pDimRgn->Crossfade.out_end - pDimRgn->Crossfade.out_start)              inline uint8_t CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) {
195                       : 0.0f;                  uint8_t c = std::max(CrossfadeControllerValue, pDimRgn->AttenuationControllerThreshold);
196                    c = (!pDimRgn->Crossfade.out_end) ? c /* 0,0,0,0 means no crossfade defined */
197                              : (c < pDimRgn->Crossfade.in_end) ?
198                                    ((c <= pDimRgn->Crossfade.in_start) ? 0
199                                    : 127 * (c - pDimRgn->Crossfade.in_start) / (pDimRgn->Crossfade.in_end - pDimRgn->Crossfade.in_start))
200                              : (c <= pDimRgn->Crossfade.out_start) ? 127
201                              : (c < pDimRgn->Crossfade.out_end) ? 127 * (pDimRgn->Crossfade.out_end - c) / (pDimRgn->Crossfade.out_end - pDimRgn->Crossfade.out_start)
202                              : 0;
203                    return pDimRgn->InvertAttenuationController ? 127 - c : c;
204              }              }
205    
206              inline float Constrain(float ValueToCheck, float Min, float Max) {              inline float Constrain(float ValueToCheck, float Min, float Max) {
Legend:
Removed from v.319  
changed lines
  Added in v.1038
  ViewVC Help
Powered by ViewVC