/[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 203 by schoenebeck, Tue Jul 13 22:44:13 2004 UTC revision 729 by persson, Tue Jul 26 11:18:46 2005 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 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"
32  #include "../../common/RingBuffer.h"  #include "../../common/RingBuffer.h"
33  #include "../../common/RTELMemoryPool.h"  #include "../../common/Pool.h"
34  #include "../../drivers/audio/AudioOutputDevice.h"  #include "../../drivers/audio/AudioOutputDevice.h"
 #include "../../lib/fileloader/libgig/gig.h"  
35  #include "../common/BiquadFilter.h"  #include "../common/BiquadFilter.h"
36    //#include "EngineGlobals.h"
37  #include "Engine.h"  #include "Engine.h"
38    #include "EngineChannel.h"
39  #include "Stream.h"  #include "Stream.h"
40  #include "DiskThread.h"  #include "DiskThread.h"
41    
# Line 43  Line 43 
43  #include "Filter.h"  #include "Filter.h"
44  #include "../common/LFO.h"  #include "../common/LFO.h"
45    
 #define USE_LINEAR_INTERPOLATION        0  ///< set to 0 if you prefer cubic interpolation (slower, better quality)  
 #define ENABLE_FILTER                   1  ///< if set to 0 then filter (VCF) code is ignored on compile time  
 #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)  
 #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  
 #define FILTER_CUTOFF_MAX               10000.0f ///< maximum cutoff frequency (10kHz)  
 #define FILTER_CUTOFF_MIN               100.0f   ///< minimum cutoff frequency (100Hz)  
   
 // Uncomment following line to override external cutoff controller  
 //#define OVERRIDE_FILTER_CUTOFF_CTRL   1  ///< set to an arbitrary MIDI control change controller (e.g. 1 for 'modulation wheel')  
   
 // Uncomment following line to override external resonance controller  
 //#define OVERRIDE_FILTER_RES_CTRL      91  ///< set to an arbitrary MIDI control change controller (e.g. 91 for 'effect 1 depth')  
   
 // Uncomment following line to override filter type  
 //#define OVERRIDE_FILTER_TYPE          ::gig::vcf_type_lowpass  ///< either ::gig::vcf_type_lowpass, ::gig::vcf_type_bandpass or ::gig::vcf_type_highpass  
   
46  namespace LinuxSampler { namespace gig {  namespace LinuxSampler { namespace gig {
47    
48      class Engine;      class Engine;
49      class EGADSR;      class EGADSR;
50        class EGDecay;
51      class VCAManipulator;      class VCAManipulator;
52      class VCFCManipulator;      class VCFCManipulator;
53      class VCOManipulator;      class VCOManipulator;
# Line 80  namespace LinuxSampler { namespace gig { Line 65  namespace LinuxSampler { namespace gig {
65       */       */
66      class Voice {      class Voice {
67          public:          public:
68                // Types
69                enum type_t {
70                    type_normal,
71                    type_release_trigger_required,  ///< If the key of this voice will be released, it causes a release triggered voice to be spawned
72                    type_release_trigger            ///< Release triggered voice which cannot be killed by releasing its key
73                };
74    
75              // Attributes              // Attributes
76                type_t       Type;         ///< Voice Type
77              int          MIDIKey;      ///< MIDI key number of the key that triggered the voice              int          MIDIKey;      ///< MIDI key number of the key that triggered the voice
78                uint         KeyGroup;
79              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
80    
81              // Methods              // Methods
82              Voice();              Voice();
83             ~Voice();              virtual ~Voice();
84              void Kill();              void Kill(Pool<Event>::Iterator& itKillEvent);
85              void Render(uint Samples);              void Render(uint Samples);
86              void Reset();              void Reset();
87              void SetOutput(AudioOutputDevice* pAudioOutputDevice);              void SetOutput(AudioOutputDevice* pAudioOutputDevice);
88              void SetEngine(Engine* pEngine);              void SetEngine(Engine* pEngine);
89              int  Trigger(Event* pNoteOnEvent, int PitchBend, ::gig::Instrument* pInstrument);              int  Trigger(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent, int PitchBend, ::gig::DimensionRegion* pDimRgn, type_t VoiceType, int iKeyGroup);
90              inline bool IsActive() { return Active; }              inline bool IsActive() { return PlaybackState; }
91          private:              inline bool IsStealable() { return !itKillEvent && PlaybackState >= playback_state_ram; }
92            //private:
93              // Types              // Types
94              enum playback_state_t {              enum playback_state_t {
95                  playback_state_ram,                  playback_state_end  = 0,
96                  playback_state_disk,                  playback_state_init = 1,
97                  playback_state_end                  playback_state_ram  = 2,
98                    playback_state_disk = 3
99              };              };
100    
101              // Attributes              // Attributes
102              gig::Engine*                pEngine;            ///< Pointer to the sampler engine, to be able to access the event lists.              EngineChannel*              pEngineChannel;
103                Engine*                     pEngine;            ///< Pointer to the sampler engine, to be able to access the event lists.
104              float                       Volume;             ///< Volume level of the voice              float                       Volume;             ///< Volume level of the voice
105              float*                      pOutputLeft;        ///< Audio output channel buffer (left)              float                       PanLeft;
106              float*                      pOutputRight;       ///< Audio output channel buffer (right)              float                       PanRight;
107              uint                        SampleRate;         ///< Sample rate of the engines output audio signal (in Hz)              float                       CrossfadeVolume;    ///< Current attenuation level caused by a crossfade (only if a crossfade is defined of course)
             uint                        MaxSamplesPerCycle; ///< Size of each audio output buffer  
108              double                      Pos;                ///< Current playback position in sample              double                      Pos;                ///< Current playback position in sample
109              double                      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
110              double                      PitchBend;          ///< Current pitch value of the pitchbend wheel              float                       PitchBend;          ///< Current pitch value of the pitchbend wheel
111                float                       CutoffBase;         ///< Cutoff frequency before control change, EG and LFO are applied
112              ::gig::Sample*              pSample;            ///< Pointer to the sample to be played back              ::gig::Sample*              pSample;            ///< Pointer to the sample to be played back
113              ::gig::Region*              pRegion;            ///< Pointer to the articulation information of the respective keyboard region of this voice              ::gig::DimensionRegion*     pDimRgn;            ///< Pointer to the articulation information of current dimension region of this voice
             bool                        Active;             ///< If this voice object is currently in usage  
114              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
115              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
116              Stream::reference_t         DiskStreamRef;      ///< Reference / link to the disk stream              Stream::reference_t         DiskStreamRef;      ///< Reference / link to the disk stream
117                int                         RealSampleWordsLeftToRead; ///< Number of samples left to read, not including the silence added for the interpolator
118              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.
119              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
120              int                         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
121              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
122              EGADSR*                     pEG1;               ///< Envelope Generator 1 (Amplification)              EGADSR*                     pEG1;               ///< Envelope Generator 1 (Amplification)
123              EGADSR*                     pEG2;               ///< Envelope Generator 2 (Filter cutoff frequency)              EGADSR*                     pEG2;               ///< Envelope Generator 2 (Filter cutoff frequency)
# Line 138  namespace LinuxSampler { namespace gig { Line 135  namespace LinuxSampler { namespace gig {
135              LFO<gig::VCAManipulator>*   pLFO1;              ///< Low Frequency Oscillator 1 (Amplification)              LFO<gig::VCAManipulator>*   pLFO1;              ///< Low Frequency Oscillator 1 (Amplification)
136              LFO<gig::VCFCManipulator>*  pLFO2;             ///< Low Frequency Oscillator 2 (Filter cutoff frequency)              LFO<gig::VCFCManipulator>*  pLFO2;             ///< Low Frequency Oscillator 2 (Filter cutoff frequency)
137              LFO<gig::VCOManipulator>*   pLFO3;              ///< Low Frequency Oscillator 3 (Pitch)              LFO<gig::VCOManipulator>*   pLFO3;              ///< Low Frequency Oscillator 3 (Pitch)
138              Event*                      pTriggerEvent;      ///< 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).              bool                        bLFO1Enabled;        ///< Should we use the Amplitude LFO for this voice?
139                bool                        bLFO2Enabled;        ///< Should we use the Filter Cutoff LFO for this voice?
140                bool                        bLFO3Enabled;        ///< Should we use the Pitch LFO for this voice?
141                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).
142            //public: // FIXME: just made public for debugging (sanity check in Engine::RenderAudio()), should be changed to private before the final release
143                Pool<Event>::Iterator       itKillEvent;         ///< Event which caused this voice to be killed
144            //private:
145                int                         SynthesisMode;
146    
147              // Static Methods              // Static Methods
148              static float CalculateFilterCutoffCoeff();              static float CalculateFilterCutoffCoeff();
149              static int   CalculateFilterUpdateMask();              static int   CalculateFilterUpdateMask();
150    
151              // Methods              // Methods
152              void        ProcessEvents(uint Samples);              void KillImmediately();
153              #if ENABLE_FILTER              void ProcessEvents(uint Samples);
154              void        CalculateBiquadParameters(uint Samples);              void CalculateBiquadParameters(uint Samples);
155              #endif // ENABLE_FILTER              void Synthesize(uint Samples, sample_t* pSrc, uint Skip);
156              void        Interpolate(uint Samples, sample_t* pSrc, uint Skip);  
157              void        InterpolateAndLoop(uint Samples, sample_t* pSrc, uint Skip);              inline float CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) {
158              inline void InterpolateOneStep_Stereo(sample_t* pSrc, int& i, float& effective_volume, float& pitch, biquad_param_t& bq_base, biquad_param_t& bq_main) {                  float att = (!pDimRgn->Crossfade.out_end) ? CrossfadeControllerValue / 127.0f /* 0,0,0,0 means no crossfade defined */
159                  int   pos_int   = RTMath::DoubleToInt(this->Pos);  // integer position                            : (CrossfadeControllerValue < pDimRgn->Crossfade.in_end) ?
160                  float pos_fract = this->Pos - pos_int;             // fractional part of position                                  ((CrossfadeControllerValue <= pDimRgn->Crossfade.in_start) ? 0.0f
161                  pos_int <<= 1;                                  : float(CrossfadeControllerValue - pDimRgn->Crossfade.in_start) / float(pDimRgn->Crossfade.in_end - pDimRgn->Crossfade.in_start))
162                              : (CrossfadeControllerValue <= pDimRgn->Crossfade.out_start) ? 1.0f
163                  #if USE_LINEAR_INTERPOLATION                            : (CrossfadeControllerValue < pDimRgn->Crossfade.out_end) ? float(pDimRgn->Crossfade.out_end - CrossfadeControllerValue) / float(pDimRgn->Crossfade.out_end - pDimRgn->Crossfade.out_start)
164                      #if ENABLE_FILTER                            : 0.0f;
165                          // left channel                  return pDimRgn->InvertAttenuationController ? 1 - att : att;
                         pOutputLeft[i]    += this->FilterLeft.Apply(&bq_base, &bq_main, effective_volume * (pSrc[pos_int]   + pos_fract * (pSrc[pos_int+2] - pSrc[pos_int])));  
                         // right channel  
                         pOutputRight[i++] += this->FilterRight.Apply(&bq_base, &bq_main, effective_volume * (pSrc[pos_int+1] + pos_fract * (pSrc[pos_int+3] - pSrc[pos_int+1])));  
                     #else // no filter  
                         // left channel  
                         pOutputLeft[i]    += effective_volume * (pSrc[pos_int]   + pos_fract * (pSrc[pos_int+2] - pSrc[pos_int]));  
                         // right channel  
                         pOutputRight[i++] += effective_volume * (pSrc[pos_int+1] + pos_fract * (pSrc[pos_int+3] - pSrc[pos_int+1]));  
                     #endif // ENABLE_FILTER  
                 #else // polynomial interpolation  
                     // calculate left channel  
                     float xm1 = pSrc[pos_int];  
                     float x0  = pSrc[pos_int+2];  
                     float x1  = pSrc[pos_int+4];  
                     float x2  = pSrc[pos_int+6];  
                     float a   = (3.0f * (x0 - x1) - xm1 + x2) * 0.5f;  
                     float b   = 2.0f * x1 + xm1 - (5.0f * x0 + x2) * 0.5f;  
                     float c   = (x1 - xm1) * 0.5f;  
                     #if ENABLE_FILTER  
                         pOutputLeft[i] += this->FilterLeft.Apply(&bq_base, &bq_main, effective_volume * ((((a * pos_fract) + b) * pos_fract + c) * pos_fract + x0));  
                     #else // no filter  
                         pOutputLeft[i] += effective_volume * ((((a * pos_fract) + b) * pos_fract + c) * pos_fract + x0);  
                     #endif // ENABLE_FILTER  
   
                     //calculate right channel  
                     xm1 = pSrc[pos_int+1];  
                     x0  = pSrc[pos_int+3];  
                     x1  = pSrc[pos_int+5];  
                     x2  = pSrc[pos_int+7];  
                     a   = (3.0f * (x0 - x1) - xm1 + x2) * 0.5f;  
                     b   = 2.0f * x1 + xm1 - (5.0f * x0 + x2) * 0.5f;  
                     c   = (x1 - xm1) * 0.5f;  
                     #if ENABLE_FILTER  
                         pOutputRight[i++] += this->FilterRight.Apply(&bq_base, &bq_main, effective_volume * ((((a * pos_fract) + b) * pos_fract + c) * pos_fract + x0));  
                     #else // no filter  
                         pOutputRight[i++] += effective_volume * ((((a * pos_fract) + b) * pos_fract + c) * pos_fract + x0);  
                     #endif // ENABLE_FILTER  
                 #endif // USE_LINEAR_INTERPOLATION  
   
                 this->Pos += pitch;  
             }  
   
             inline void InterpolateOneStep_Mono(sample_t* pSrc, int& i, float& effective_volume, float& pitch,  biquad_param_t& bq_base, biquad_param_t& bq_main) {  
                 int   pos_int   = RTMath::DoubleToInt(this->Pos);  // integer position  
                 float pos_fract = this->Pos - pos_int;             // fractional part of position  
   
                 #if USE_LINEAR_INTERPOLATION  
                     float sample_point  = effective_volume * (pSrc[pos_int] + pos_fract * (pSrc[pos_int+1] - pSrc[pos_int]));  
                 #else // polynomial interpolation  
                     float xm1 = pSrc[pos_int];  
                     float x0  = pSrc[pos_int+1];  
                     float x1  = pSrc[pos_int+2];  
                     float x2  = pSrc[pos_int+3];  
                     float a   = (3.0f * (x0 - x1) - xm1 + x2) * 0.5f;  
                     float b   = 2.0f * x1 + xm1 - (5.0f * x0 + x2) * 0.5f;  
                     float c   = (x1 - xm1) * 0.5f;  
                     float sample_point = effective_volume * ((((a * pos_fract) + b) * pos_fract + c) * pos_fract + x0);  
                 #endif // USE_LINEAR_INTERPOLATION  
   
                 #if ENABLE_FILTER  
                     sample_point = this->FilterLeft.Apply(&bq_base, &bq_main, sample_point);  
                 #endif // ENABLE_FILTER  
   
                 pOutputLeft[i]    += sample_point;  
                 pOutputRight[i++] += sample_point;  
   
                 this->Pos += pitch;  
166              }              }
167    
168              inline float Constrain(float ValueToCheck, float Min, float Max) {              inline float Constrain(float ValueToCheck, float Min, float Max) {
Legend:
Removed from v.203  
changed lines
  Added in v.729
  ViewVC Help
Powered by ViewVC