| 1 |
/*************************************************************************** |
| 2 |
* * |
| 3 |
* LinuxSampler - modular, streaming capable sampler * |
| 4 |
* * |
| 5 |
* 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 * |
| 9 |
* it under the terms of the GNU General Public License as published by * |
| 10 |
* the Free Software Foundation; either version 2 of the License, or * |
| 11 |
* (at your option) any later version. * |
| 12 |
* * |
| 13 |
* This program is distributed in the hope that it will be useful, * |
| 14 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of * |
| 15 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * |
| 16 |
* GNU General Public License for more details. * |
| 17 |
* * |
| 18 |
* You should have received a copy of the GNU General Public License * |
| 19 |
* along with this program; if not, write to the Free Software * |
| 20 |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, * |
| 21 |
* MA 02111-1307 USA * |
| 22 |
***************************************************************************/ |
| 23 |
|
| 24 |
#ifndef __LS_GIG_VOICE_H__ |
| 25 |
#define __LS_GIG_VOICE_H__ |
| 26 |
|
| 27 |
#include "../../common/global.h" |
| 28 |
|
| 29 |
#if DEBUG_HEADERS |
| 30 |
# warning Voice.h included |
| 31 |
#endif // DEBUG_HEADERS |
| 32 |
|
| 33 |
#include "../../common/RTMath.h" |
| 34 |
#include "../../common/RingBuffer.h" |
| 35 |
#include "../../common/Pool.h" |
| 36 |
#include "../../drivers/audio/AudioOutputDevice.h" |
| 37 |
#include "../../lib/fileloader/libgig/gig.h" |
| 38 |
#include "../common/BiquadFilter.h" |
| 39 |
//#include "EngineGlobals.h" |
| 40 |
#include "Engine.h" |
| 41 |
#include "EngineChannel.h" |
| 42 |
#include "Stream.h" |
| 43 |
#include "DiskThread.h" |
| 44 |
|
| 45 |
#include "EGDecay.h" |
| 46 |
#include "Filter.h" |
| 47 |
#include "../common/LFO.h" |
| 48 |
|
| 49 |
namespace LinuxSampler { namespace gig { |
| 50 |
|
| 51 |
class Engine; |
| 52 |
class EGADSR; |
| 53 |
class EGDecay; |
| 54 |
class VCAManipulator; |
| 55 |
class VCFCManipulator; |
| 56 |
class VCOManipulator; |
| 57 |
|
| 58 |
/// Reflects a MIDI controller |
| 59 |
struct midi_ctrl { |
| 60 |
uint8_t controller; ///< MIDI control change controller number |
| 61 |
uint8_t value; ///< Current MIDI controller value |
| 62 |
float fvalue; ///< Transformed / effective value (e.g. volume level or filter cutoff frequency) |
| 63 |
}; |
| 64 |
|
| 65 |
/** Gig Voice |
| 66 |
* |
| 67 |
* Renders a voice for the Gigasampler format. |
| 68 |
*/ |
| 69 |
class Voice { |
| 70 |
public: |
| 71 |
// Types |
| 72 |
enum type_t { |
| 73 |
type_normal, |
| 74 |
type_release_trigger_required, ///< If the key of this voice will be released, it causes a release triggered voice to be spawned |
| 75 |
type_release_trigger ///< Release triggered voice which cannot be killed by releasing its key |
| 76 |
}; |
| 77 |
|
| 78 |
// Attributes |
| 79 |
type_t Type; ///< Voice Type |
| 80 |
int MIDIKey; ///< MIDI key number of the key that triggered the voice |
| 81 |
uint KeyGroup; |
| 82 |
DiskThread* pDiskThread; ///< Pointer to the disk thread, to be able to order a disk stream and later to delete the stream again |
| 83 |
|
| 84 |
// Methods |
| 85 |
Voice(); |
| 86 |
~Voice(); |
| 87 |
void Kill(Pool<Event>::Iterator& itKillEvent); |
| 88 |
void Render(uint Samples); |
| 89 |
void Reset(); |
| 90 |
void SetOutput(AudioOutputDevice* pAudioOutputDevice); |
| 91 |
void SetEngine(Engine* pEngine); |
| 92 |
int Trigger(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent, int PitchBend, ::gig::Instrument* pInstrument, int iLayer, bool ReleaseTriggerVoice, bool VoiceStealingAllowed); |
| 93 |
inline bool IsActive() { return PlaybackState; } |
| 94 |
//private: |
| 95 |
// Types |
| 96 |
enum playback_state_t { |
| 97 |
playback_state_end = 0, |
| 98 |
playback_state_ram = 1, |
| 99 |
playback_state_disk = 2 |
| 100 |
}; |
| 101 |
|
| 102 |
// Attributes |
| 103 |
EngineChannel* pEngineChannel; |
| 104 |
Engine* pEngine; ///< Pointer to the sampler engine, to be able to access the event lists. |
| 105 |
float Volume; ///< Volume level of the voice |
| 106 |
float PanLeft; |
| 107 |
float PanRight; |
| 108 |
float CrossfadeVolume; ///< Current attenuation level caused by a crossfade (only if a crossfade is defined of course) |
| 109 |
double Pos; ///< Current playback position in sample |
| 110 |
float PitchBase; ///< Basic pitch depth, stays the same for the whole life time of the voice |
| 111 |
float PitchBend; ///< Current pitch value of the pitchbend wheel |
| 112 |
::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 |
| 114 |
::gig::DimensionRegion* pDimRgn; ///< Pointer to the articulation information of current dimension region of this voice |
| 115 |
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 |
| 116 |
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 |
| 117 |
Stream::reference_t DiskStreamRef; ///< Reference / link to the disk stream |
| 118 |
int RealSampleWordsLeftToRead; ///< Number of samples left to read, not including the silence added for the interpolator |
| 119 |
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. |
| 120 |
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 |
| 121 |
uint LoopCyclesLeft; ///< In case there is a RAMLoop and it's not an endless loop; reflects number of loop cycles left to be passed |
| 122 |
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 |
| 123 |
EGADSR* pEG1; ///< Envelope Generator 1 (Amplification) |
| 124 |
EGADSR* pEG2; ///< Envelope Generator 2 (Filter cutoff frequency) |
| 125 |
EGDecay* pEG3; ///< Envelope Generator 3 (Pitch) |
| 126 |
Filter FilterLeft; |
| 127 |
Filter FilterRight; |
| 128 |
midi_ctrl VCFCutoffCtrl; |
| 129 |
midi_ctrl VCFResonanceCtrl; |
| 130 |
int FilterUpdateCounter; ///< Used to update filter parameters all FILTER_UPDATE_PERIOD samples |
| 131 |
static const float FILTER_CUTOFF_COEFF; |
| 132 |
static const int FILTER_UPDATE_MASK; |
| 133 |
VCAManipulator* pVCAManipulator; |
| 134 |
VCFCManipulator* pVCFCManipulator; |
| 135 |
VCOManipulator* pVCOManipulator; |
| 136 |
LFO<gig::VCAManipulator>* pLFO1; ///< Low Frequency Oscillator 1 (Amplification) |
| 137 |
LFO<gig::VCFCManipulator>* pLFO2; ///< Low Frequency Oscillator 2 (Filter cutoff frequency) |
| 138 |
LFO<gig::VCOManipulator>* pLFO3; ///< Low Frequency Oscillator 3 (Pitch) |
| 139 |
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). |
| 140 |
//public: // FIXME: just made public for debugging (sanity check in Engine::RenderAudio()), should be changed to private before the final release |
| 141 |
Pool<Event>::Iterator itKillEvent; ///< Event which caused this voice to be killed |
| 142 |
//private: |
| 143 |
int SynthesisMode; |
| 144 |
|
| 145 |
// Static Methods |
| 146 |
static float CalculateFilterCutoffCoeff(); |
| 147 |
static int CalculateFilterUpdateMask(); |
| 148 |
|
| 149 |
// Methods |
| 150 |
void KillImmediately(); |
| 151 |
void ProcessEvents(uint Samples); |
| 152 |
void CalculateBiquadParameters(uint Samples); |
| 153 |
void Synthesize(uint Samples, sample_t* pSrc, uint Skip); |
| 154 |
|
| 155 |
inline float CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) { |
| 156 |
float att = (!pDimRgn->Crossfade.out_end) ? CrossfadeControllerValue / 127.0f /* 0,0,0,0 means no crossfade defined */ |
| 157 |
: (CrossfadeControllerValue < pDimRgn->Crossfade.in_end) ? |
| 158 |
((CrossfadeControllerValue <= pDimRgn->Crossfade.in_start) ? 0.0f |
| 159 |
: float(CrossfadeControllerValue - pDimRgn->Crossfade.in_start) / float(pDimRgn->Crossfade.in_end - pDimRgn->Crossfade.in_start)) |
| 160 |
: (CrossfadeControllerValue <= pDimRgn->Crossfade.out_start) ? 1.0f |
| 161 |
: (CrossfadeControllerValue < pDimRgn->Crossfade.out_end) ? float(pDimRgn->Crossfade.out_end - CrossfadeControllerValue) / float(pDimRgn->Crossfade.out_end - pDimRgn->Crossfade.out_start) |
| 162 |
: 0.0f; |
| 163 |
return pDimRgn->InvertAttenuationController ? 1 - att : att; |
| 164 |
} |
| 165 |
|
| 166 |
inline float Constrain(float ValueToCheck, float Min, float Max) { |
| 167 |
if (ValueToCheck > Max) ValueToCheck = Max; |
| 168 |
else if (ValueToCheck < Min) ValueToCheck = Min; |
| 169 |
return ValueToCheck; |
| 170 |
} |
| 171 |
}; |
| 172 |
|
| 173 |
}} // namespace LinuxSampler::gig |
| 174 |
|
| 175 |
#endif // __LS_GIG_VOICE_H__ |
Parent Directory
| 
Revision Log