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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2012 - (hide annotations) (download) (as text)
Fri Oct 23 17:53:17 2009 UTC (14 years, 6 months ago) by iliev
File MIME type: text/x-c++hdr
File size: 13328 byte(s)
* Refactoring: moved the independent code from
  the Gigasampler format engine to base classes
* SFZ format engine: experimental code (not usable yet)
* SoundFont format engine: experimental code (not usable yet)
* Fixed crash which may occur when MIDI key + transpose is out of range

1 schoenebeck 53 /***************************************************************************
2     * *
3     * LinuxSampler - modular, streaming capable sampler *
4     * *
5 schoenebeck 56 * Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6 schoenebeck 1321 * Copyright (C) 2005 - 2007 Christian Schoenebeck *
7 schoenebeck 53 * *
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 schoenebeck 1424 #include "../../common/global_private.h"
28 schoenebeck 53
29 schoenebeck 505 #include <gig.h>
30    
31 schoenebeck 53 #include "../../common/RTMath.h"
32 schoenebeck 273 #include "../../common/Pool.h"
33 schoenebeck 203 #include "../../drivers/audio/AudioOutputDevice.h"
34 schoenebeck 53 #include "Stream.h"
35     #include "DiskThread.h"
36 schoenebeck 738 #include "EGADSR.h"
37 schoenebeck 53 #include "EGDecay.h"
38     #include "Filter.h"
39 schoenebeck 738 #include "../common/LFOBase.h"
40 iliev 2012 #include "../common/VoiceBase.h"
41 schoenebeck 770 #include "SynthesisParam.h"
42 persson 832 #include "SmoothVolume.h"
43 schoenebeck 53
44 schoenebeck 738 // include the appropriate (unsigned) triangle LFO implementation
45     #if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
46     # include "../common/LFOTriangleIntMath.h"
47     #elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
48     # include "../common/LFOTriangleIntAbsMath.h"
49     #elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
50     # include "../common/LFOTriangleDiHarmonic.h"
51     #else
52     # error "Unknown or no (unsigned) triangle LFO implementation selected!"
53     #endif
54    
55     // include the appropriate (signed) triangle LFO implementation
56     #if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
57     # include "../common/LFOTriangleIntMath.h"
58     #elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
59     # include "../common/LFOTriangleIntAbsMath.h"
60     #elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
61     # include "../common/LFOTriangleDiHarmonic.h"
62     #else
63     # error "Unknown or no (signed) triangle LFO implementation selected!"
64     #endif
65    
66 schoenebeck 53 namespace LinuxSampler { namespace gig {
67     class Engine;
68 iliev 2012 class EngineChannel;
69 schoenebeck 53
70     /// Reflects a MIDI controller
71     struct midi_ctrl {
72     uint8_t controller; ///< MIDI control change controller number
73     uint8_t value; ///< Current MIDI controller value
74     float fvalue; ///< Transformed / effective value (e.g. volume level or filter cutoff frequency)
75     };
76    
77 schoenebeck 738 #if CONFIG_UNSIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
78     typedef LFOTriangleIntMath<range_unsigned> LFOUnsigned;
79     #elif CONFIG_UNSIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
80     typedef LFOTriangleIntAbsMath<range_unsigned> LFOUnsigned;
81     #elif CONFIG_UNSIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
82     typedef LFOTriangleDiHarmonic<range_unsigned> LFOUnsigned;
83     #endif
84    
85     #if CONFIG_SIGNED_TRIANG_ALGO == INT_MATH_SOLUTION
86     typedef LFOTriangleIntMath<range_signed> LFOSigned;
87     #elif CONFIG_SIGNED_TRIANG_ALGO == INT_ABS_MATH_SOLUTION
88     typedef LFOTriangleIntAbsMath<range_signed> LFOSigned;
89     #elif CONFIG_SIGNED_TRIANG_ALGO == DI_HARMONIC_SOLUTION
90     typedef LFOTriangleDiHarmonic<range_signed> LFOSigned;
91     #endif
92    
93 schoenebeck 53 /** Gig Voice
94     *
95     * Renders a voice for the Gigasampler format.
96     */
97 iliev 2012 class Voice : public LinuxSampler::VoiceBase< ::gig::DimensionRegion> {
98 schoenebeck 53 public:
99     // Attributes
100 schoenebeck 242 type_t Type; ///< Voice Type
101 schoenebeck 53 int MIDIKey; ///< MIDI key number of the key that triggered the voice
102 schoenebeck 239 uint KeyGroup;
103 schoenebeck 53 DiskThread* pDiskThread; ///< Pointer to the disk thread, to be able to order a disk stream and later to delete the stream again
104    
105     // Methods
106     Voice();
107 letz 502 virtual ~Voice();
108 schoenebeck 271 void Kill(Pool<Event>::Iterator& itKillEvent);
109 schoenebeck 53 void Render(uint Samples);
110     void Reset();
111     void SetOutput(AudioOutputDevice* pAudioOutputDevice);
112 iliev 2012 void SetEngine(LinuxSampler::Engine* pEngine);
113 schoenebeck 669 int Trigger(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent, int PitchBend, ::gig::DimensionRegion* pDimRgn, type_t VoiceType, int iKeyGroup);
114 schoenebeck 285 inline bool IsActive() { return PlaybackState; }
115 schoenebeck 663 inline bool IsStealable() { return !itKillEvent && PlaybackState >= playback_state_ram; }
116 schoenebeck 829 void UpdatePortamentoPos(Pool<Event>::Iterator& itNoteOffEvent);
117    
118 iliev 2012 virtual ::gig::DimensionRegion* GetRegion() { return pDimRgn; }
119    
120 schoenebeck 319 //private:
121 schoenebeck 53 // Attributes
122 schoenebeck 411 EngineChannel* pEngineChannel;
123     Engine* pEngine; ///< Pointer to the sampler engine, to be able to access the event lists.
124 persson 832 float VolumeLeft; ///< Left channel volume. This factor is calculated when the voice is triggered and doesn't change after that.
125     float VolumeRight; ///< Right channel volume. This factor is calculated when the voice is triggered and doesn't change after that.
126     SmoothVolume CrossfadeSmoother; ///< Crossfade volume, updated by crossfade CC events
127     SmoothVolume VolumeSmoother; ///< Volume, updated by CC 7 (volume) events
128     SmoothVolume PanLeftSmoother; ///< Left channel volume, updated by CC 10 (pan) events
129     SmoothVolume PanRightSmoother; ///< Right channel volume, updated by CC 10 (pan) events
130 persson 783 double Pos; ///< Current playback position in sample
131 schoenebeck 319 float PitchBase; ///< Basic pitch depth, stays the same for the whole life time of the voice
132     float PitchBend; ///< Current pitch value of the pitchbend wheel
133 persson 1923 float PitchBendRange; ///< The pitch range of the pitchbend wheel, value is in cents / 8192
134 persson 729 float CutoffBase; ///< Cutoff frequency before control change, EG and LFO are applied
135 schoenebeck 53 ::gig::Sample* pSample; ///< Pointer to the sample to be played back
136 schoenebeck 236 ::gig::DimensionRegion* pDimRgn; ///< Pointer to the articulation information of current dimension region of this voice
137 persson 1038 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.
138 schoenebeck 53 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
139     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
140     Stream::reference_t DiskStreamRef; ///< Reference / link to the disk stream
141 schoenebeck 330 int RealSampleWordsLeftToRead; ///< Number of samples left to read, not including the silence added for the interpolator
142 schoenebeck 53 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.
143     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
144 schoenebeck 770 //uint LoopCyclesLeft; ///< In case there is a RAMLoop and it's not an endless loop; reflects number of loop cycles left to be passed
145 schoenebeck 53 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
146 schoenebeck 738 EGADSR EG1; ///< Envelope Generator 1 (Amplification)
147     EGADSR EG2; ///< Envelope Generator 2 (Filter cutoff frequency)
148     EGDecay EG3; ///< Envelope Generator 3 (Pitch)
149 schoenebeck 53 midi_ctrl VCFCutoffCtrl;
150     midi_ctrl VCFResonanceCtrl;
151 schoenebeck 738 LFOUnsigned* pLFO1; ///< Low Frequency Oscillator 1 (Amplification)
152     LFOUnsigned* pLFO2; ///< Low Frequency Oscillator 2 (Filter cutoff frequency)
153     LFOSigned* pLFO3; ///< Low Frequency Oscillator 3 (Pitch)
154 schoenebeck 687 bool bLFO1Enabled; ///< Should we use the Amplitude LFO for this voice?
155     bool bLFO2Enabled; ///< Should we use the Filter Cutoff LFO for this voice?
156     bool bLFO3Enabled; ///< Should we use the Pitch LFO for this voice?
157 schoenebeck 271 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).
158 schoenebeck 319 //public: // FIXME: just made public for debugging (sanity check in Engine::RenderAudio()), should be changed to private before the final release
159 schoenebeck 271 Pool<Event>::Iterator itKillEvent; ///< Event which caused this voice to be killed
160 schoenebeck 319 //private:
161     int SynthesisMode;
162 schoenebeck 738 float fFinalCutoff;
163     float fFinalResonance;
164 schoenebeck 770 SynthesisParam finalSynthesisParameters;
165     Loop loop;
166 schoenebeck 738
167 schoenebeck 53 // Static Methods
168     static float CalculateFilterCutoffCoeff();
169    
170     // Methods
171 schoenebeck 1321 Stream::Handle KillImmediately(bool bRequestNotification = false);
172 schoenebeck 319 void ProcessEvents(uint Samples);
173 senkov 325 void Synthesize(uint Samples, sample_t* pSrc, uint Skip);
174 schoenebeck 738 void processTransitionEvents(RTList<Event>::Iterator& itEvent, uint End);
175     void processCCEvents(RTList<Event>::Iterator& itEvent, uint End);
176     void processPitchEvent(RTList<Event>::Iterator& itEvent);
177     void processCrossFadeEvent(RTList<Event>::Iterator& itEvent);
178     void processCutoffEvent(RTList<Event>::Iterator& itEvent);
179     void processResonanceEvent(RTList<Event>::Iterator& itEvent);
180 schoenebeck 245
181 persson 832 inline uint8_t CrossfadeAttenuation(uint8_t& CrossfadeControllerValue) {
182 persson 831 uint8_t c = std::max(CrossfadeControllerValue, pDimRgn->AttenuationControllerThreshold);
183 persson 832 c = (!pDimRgn->Crossfade.out_end) ? c /* 0,0,0,0 means no crossfade defined */
184 persson 831 : (c < pDimRgn->Crossfade.in_end) ?
185 persson 832 ((c <= pDimRgn->Crossfade.in_start) ? 0
186     : 127 * (c - pDimRgn->Crossfade.in_start) / (pDimRgn->Crossfade.in_end - pDimRgn->Crossfade.in_start))
187     : (c <= pDimRgn->Crossfade.out_start) ? 127
188     : (c < pDimRgn->Crossfade.out_end) ? 127 * (pDimRgn->Crossfade.out_end - c) / (pDimRgn->Crossfade.out_end - pDimRgn->Crossfade.out_start)
189     : 0;
190     return pDimRgn->InvertAttenuationController ? 127 - c : c;
191 schoenebeck 236 }
192    
193 schoenebeck 53 inline float Constrain(float ValueToCheck, float Min, float Max) {
194     if (ValueToCheck > Max) ValueToCheck = Max;
195     else if (ValueToCheck < Min) ValueToCheck = Min;
196     return ValueToCheck;
197     }
198     };
199    
200     }} // namespace LinuxSampler::gig
201    
202     #endif // __LS_GIG_VOICE_H__

  ViewVC Help
Powered by ViewVC