1 /*************************************************************************** 2 * * 3 * LinuxSampler - modular, streaming capable sampler * 4 * * 5 * Copyright (C) 2003,2004 by Benno Senoner and Christian Schoenebeck * 6 * Copyright (C) 2005-2008 Christian Schoenebeck * 7 * Copyright (C) 2009-2012 Christian Schoenebeck and Grigor Iliev * 8 * * 9 * 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 * 11 * the Free Software Foundation; either version 2 of the License, or * 12 * (at your option) any later version. * 13 * * 14 * This program is distributed in the hope that it will be useful, * 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of * 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * 17 * GNU General Public License for more details. * 18 * * 19 * You should have received a copy of the GNU General Public License * 20 * along with this program; if not, write to the Free Software * 21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, * 22 * MA 02111-1307 USA * 23 ***************************************************************************/ 24 25 #ifndef __LS_ABSTRACTVOICE_H__ 26 #define __LS_ABSTRACTVOICE_H__ 27 28 #include "Voice.h" 29 30 #include "../../common/global_private.h" 31 #include "../AbstractEngineChannel.h" 32 #include "LFOBase.h" 33 #include "Fade.h" 34 #include "../EngineBase.h" 35 #include "EG.h" 36 #include "../gig/EGADSR.h" 37 #include "../gig/EGDecay.h" 38 #include "../gig/SmoothVolume.h" 39 #include "../gig/Synthesizer.h" 40 #include "../gig/Profiler.h" 41 #include "SignalUnitRack.h" 42 #include "LFOCluster.h" 43 44 namespace LinuxSampler { 45 46 class AbstractVoice : public Voice { 47 public: 48 type_t Type; ///< Voice Type (bit field, a voice may have several types) 49 NoteBase* pNote; ///< Note this voice belongs to and was caused by. 50 int MIDIPan; ///< the current MIDI pan value plus the value from RegionInfo 51 52 SignalUnitRack* const pSignalUnitRack; 53 54 AbstractVoice(SignalUnitRack* pRack); 55 virtual ~AbstractVoice(); 56 IsActive()57 inline bool IsActive() { return PlaybackState; } IsStealable()58 inline bool IsStealable() { return !itKillEvent && PlaybackState >= playback_state_ram; } 59 60 virtual void Reset(); 61 62 virtual int Trigger ( 63 AbstractEngineChannel* pEngineChannel, 64 Pool<Event>::Iterator& itNoteOnEvent, 65 int PitchBend, 66 type_t VoiceType, 67 int iKeyGroup 68 ); 69 70 /** Invoked when the voice is freed - gone from active to inactive. */ VoiceFreed()71 virtual void VoiceFreed() { } 72 73 virtual void Synthesize(uint Samples, sample_t* pSrc, uint Skip); 74 75 virtual release_trigger_t GetReleaseTriggerFlags() = 0; 76 GetSampleRate()77 uint GetSampleRate() { return GetEngine()->SampleRate; } 78 GetControllerValue(uint8_t Controller)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). HostKey()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). MIDIKey()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). MIDIVelocity()88 inline uint8_t MIDIVelocity() const { return pNote->cause.Param.Note.Velocity; } 89 90 void processCCEvents(RTList<Event>::Iterator& itEvent, uint End); 91 void processPitchEvent(RTList<Event>::Iterator& itEvent); 92 void processResonanceEvent(RTList<Event>::Iterator& itEvent); 93 void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End); 94 void processGroupEvents(RTList<Event>::Iterator& itEvent, uint End); 95 void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent); 96 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. 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 102 Stream::reference_t DiskStreamRef; ///< Reference / link to the disk stream 103 104 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: 110 #endif 111 SampleInfo SmplInfo; 112 RegionInfo RgnInfo; 113 InstrumentInfo InstrInfo; 114 AbstractEngineChannel* pEngineChannel; 115 116 double Pos; ///< Current playback position in sample 117 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 120 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. 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 126 gig::SmoothVolume VolumeSmoother; ///< Volume, updated by CC 7 (volume) events 127 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 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 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 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. 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 134 EG* pEG1; ///< Envelope Generator 1 (Amplification) 135 EG* pEG2; ///< Envelope Generator 2 (Filter cutoff frequency) 136 gig::EGDecay EG3; ///< Envelope Generator 3 (Pitch) TODO: use common EG instead? 137 midi_ctrl VCFCutoffCtrl; 138 midi_ctrl VCFResonanceCtrl; 139 LFOClusterUnsigned* pLFO1; ///< Low Frequency Oscillator 1 (Amplification) 140 LFOClusterUnsigned* pLFO2; ///< Low Frequency Oscillator 2 (Filter cutoff frequency) 141 LFOClusterSigned* pLFO3; ///< Low Frequency Oscillator 3 (Pitch) 142 bool bLFO1Enabled; ///< Should we use the Amplitude LFO for this voice? 143 bool bLFO2Enabled; ///< Should we use the Filter Cutoff LFO for this voice? 144 bool bLFO3Enabled; ///< Should we use the Pitch LFO for this voice? 145 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). 146 Pool<Event>::Iterator itKillEvent; ///< Event which caused this voice to be killed 147 int SynthesisMode; 148 float fFinalCutoff; 149 float fFinalResonance; 150 gig::SynthesisParam finalSynthesisParameters; 151 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 PrintEqInfo()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; 166 virtual SampleInfo GetSampleInfo() = 0; 167 virtual RegionInfo GetRegionInfo() = 0; 168 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 */ AboutToTrigger()179 virtual void AboutToTrigger() { } 180 181 virtual bool EG1Finished(); 182 183 /** 184 * Gets the sample cache size in bytes. 185 */ 186 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. 203 * All involved parameters (VelocityResponseCurve, VelocityResponseDepth 204 * and VelocityResponseCurveScaling) involved are taken into account to 205 * calculate the amplitude factor. Use this method when a key was 206 * triggered to get the volume with which the sample should be played 207 * back. 208 * 209 * @param MIDIKeyVelocity MIDI velocity value of the triggered key (between 0 and 127) 210 * @returns amplitude factor (between 0.0 and 1.0) 211 */ 212 virtual double GetVelocityAttenuation(uint8_t MIDIKeyVelocity) = 0; 213 214 virtual double GetSampleAttenuation() = 0; 215 216 virtual double CalculateVolume(double velocityAttenuation); 217 218 virtual float GetReleaseTriggerAttenuation(float noteLength); 219 220 /** 221 * Get starting crossfade volume level 222 */ 223 virtual double CalculateCrossfadeVolume(uint8_t MIDIKeyVelocity) = 0; 224 225 virtual MidiKeyBase* GetMidiKeyInfo(int MIDIKey) = 0; 226 227 virtual int OrderNewStream() = 0; 228 229 virtual PitchInfo CalculatePitchInfo(int PitchBend); 230 231 // TODO: cleanup the interface. The following two methods 232 // are maybe not neccessary after the TriggerEG1 method 233 // was added. 234 235 /** 236 * Get current value of EG1 controller. 237 */ 238 virtual double GetEG1ControllerValue(uint8_t MIDIKeyVelocity) = 0; 239 240 /** 241 * Calculate influence of EG1 controller on EG1's parameters. 242 */ 243 virtual EGInfo CalculateEG1ControllerInfluence(double eg1ControllerValue) = 0; 244 245 // TODO: cleanup the interface. The velrelase and 246 // velocityAttenuation parameters are perhaps too gig 247 // specific. 248 /** 249 * Trigger the amplitude envelope generator. 250 */ 251 virtual void TriggerEG1(const EGInfo& egInfo, double velrelease, double velocityAttenuation, uint sampleRate, uint8_t velocity) = 0; 252 253 /** 254 * Get current value of EG2 controller. 255 */ 256 virtual double GetEG2ControllerValue(uint8_t MIDIKeyVelocity) = 0; 257 258 /** 259 * Calculate influence of EG2 controller on EG2's parameters. 260 */ 261 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; 266 virtual float CalculateFinalCutoff(float cutoffBase) = 0; 267 268 virtual void InitLFO1() = 0; 269 virtual void InitLFO2() = 0; 270 virtual void InitLFO3() = 0; 271 272 virtual uint8_t GetVCFCutoffCtrl() = 0; 273 virtual uint8_t GetVCFResonanceCtrl() = 0; 274 virtual uint8_t CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) = 0; 275 276 virtual void GetFirstEventOnKey(uint8_t MIDIKey, RTList<Event>::Iterator& itEvent) = 0; 277 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; 281 virtual double GetVelocityRelease(uint8_t MIDIKeyVelocity) = 0; 282 283 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 291 292 #endif /* __LS_ABSTRACTVOICE_H__ */ 293