1 |
/*************************************************************************** |
2 |
* * |
3 |
* LinuxSampler - modular, streaming capable sampler * |
4 |
* * |
5 |
* 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 * |
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 |
#include "EngineChannel.h" |
25 |
|
26 |
namespace LinuxSampler { namespace gig { |
27 |
|
28 |
EngineChannel::EngineChannel() { |
29 |
pMIDIKeyInfo = new midi_key_info_t[128]; |
30 |
pEngine = NULL; |
31 |
pInstrument = NULL; |
32 |
pEvents = NULL; // we allocate when we retrieve the right Engine object |
33 |
pEventQueue = new RingBuffer<Event>(CONFIG_MAX_EVENTS_PER_FRAGMENT, 0); |
34 |
pActiveKeys = new Pool<uint>(128); |
35 |
for (uint i = 0; i < 128; i++) { |
36 |
pMIDIKeyInfo[i].pActiveVoices = NULL; // we allocate when we retrieve the right Engine object |
37 |
pMIDIKeyInfo[i].KeyPressed = false; |
38 |
pMIDIKeyInfo[i].Active = false; |
39 |
pMIDIKeyInfo[i].ReleaseTrigger = false; |
40 |
pMIDIKeyInfo[i].pEvents = NULL; // we allocate when we retrieve the right Engine object |
41 |
pMIDIKeyInfo[i].VoiceTheftsQueued = 0; |
42 |
pMIDIKeyInfo[i].RoundRobinIndex = 0; |
43 |
} |
44 |
InstrumentIdx = -1; |
45 |
InstrumentStat = -1; |
46 |
AudioDeviceChannelLeft = -1; |
47 |
AudioDeviceChannelRight = -1; |
48 |
pMidiInputPort = NULL; |
49 |
midiChannel = midi_chan_all; |
50 |
ResetControllers(); |
51 |
SoloMode = false; |
52 |
PortamentoMode = false; |
53 |
PortamentoTime = CONFIG_PORTAMENTO_TIME_DEFAULT; |
54 |
} |
55 |
|
56 |
EngineChannel::~EngineChannel() { |
57 |
DisconnectAudioOutputDevice(); |
58 |
if (pInstrument) Engine::instruments.HandBack(pInstrument, this); |
59 |
if (pEventQueue) delete pEventQueue; |
60 |
if (pActiveKeys) delete pActiveKeys; |
61 |
if (pMIDIKeyInfo) delete[] pMIDIKeyInfo; |
62 |
} |
63 |
|
64 |
/** |
65 |
* Implementation of virtual method from abstract EngineChannel interface. |
66 |
* This method will periodically be polled (e.g. by the LSCP server) to |
67 |
* check if some engine channel parameter has changed since the last |
68 |
* StatusChanged() call. |
69 |
* |
70 |
* This method can also be used to mark the engine channel as changed |
71 |
* from outside, e.g. by a MIDI input device. The optional argument |
72 |
* \a nNewStatus can be used for this. |
73 |
* |
74 |
* TODO: This "poll method" is just a lazy solution and might be |
75 |
* replaced in future. |
76 |
* @param bNewStatus - (optional, default: false) sets the new status flag |
77 |
* @returns true if engine channel status has changed since last |
78 |
* StatusChanged() call |
79 |
*/ |
80 |
bool EngineChannel::StatusChanged(bool bNewStatus) { |
81 |
bool b = bStatusChanged; |
82 |
bStatusChanged = bNewStatus; |
83 |
return b; |
84 |
} |
85 |
|
86 |
void EngineChannel::Reset() { |
87 |
if (pEngine) pEngine->DisableAndLock(); |
88 |
ResetInternal(); |
89 |
ResetControllers(); |
90 |
if (pEngine) { |
91 |
pEngine->Enable(); |
92 |
pEngine->Reset(); |
93 |
} |
94 |
} |
95 |
|
96 |
/** |
97 |
* This method is not thread safe! |
98 |
*/ |
99 |
void EngineChannel::ResetInternal() { |
100 |
CurrentKeyDimension = 0; |
101 |
|
102 |
// reset key info |
103 |
for (uint i = 0; i < 128; i++) { |
104 |
if (pMIDIKeyInfo[i].pActiveVoices) |
105 |
pMIDIKeyInfo[i].pActiveVoices->clear(); |
106 |
if (pMIDIKeyInfo[i].pEvents) |
107 |
pMIDIKeyInfo[i].pEvents->clear(); |
108 |
pMIDIKeyInfo[i].KeyPressed = false; |
109 |
pMIDIKeyInfo[i].Active = false; |
110 |
pMIDIKeyInfo[i].ReleaseTrigger = false; |
111 |
pMIDIKeyInfo[i].itSelf = Pool<uint>::Iterator(); |
112 |
pMIDIKeyInfo[i].VoiceTheftsQueued = 0; |
113 |
} |
114 |
SoloKey = -1; // no solo key active yet |
115 |
PortamentoPos = -1.0f; // no portamento active yet |
116 |
|
117 |
// reset all key groups |
118 |
std::map<uint,uint*>::iterator iter = ActiveKeyGroups.begin(); |
119 |
for (; iter != ActiveKeyGroups.end(); iter++) iter->second = NULL; |
120 |
|
121 |
// free all active keys |
122 |
pActiveKeys->clear(); |
123 |
|
124 |
// delete all input events |
125 |
pEventQueue->init(); |
126 |
|
127 |
if (pEngine) pEngine->ResetInternal(); |
128 |
|
129 |
// status of engine channel has changed, so set notify flag |
130 |
bStatusChanged = true; |
131 |
} |
132 |
|
133 |
LinuxSampler::Engine* EngineChannel::GetEngine() { |
134 |
return pEngine; |
135 |
} |
136 |
|
137 |
/** |
138 |
* More or less a workaround to set the instrument name, index and load |
139 |
* status variable to zero percent immediately, that is without blocking |
140 |
* the calling thread. It might be used in future for other preparations |
141 |
* as well though. |
142 |
* |
143 |
* @param FileName - file name of the Gigasampler instrument file |
144 |
* @param Instrument - index of the instrument in the .gig file |
145 |
* @see LoadInstrument() |
146 |
*/ |
147 |
void EngineChannel::PrepareLoadInstrument(const char* FileName, uint Instrument) { |
148 |
InstrumentFile = FileName; |
149 |
InstrumentIdx = Instrument; |
150 |
InstrumentStat = 0; |
151 |
} |
152 |
|
153 |
/** |
154 |
* Load an instrument from a .gig file. PrepareLoadInstrument() has to |
155 |
* be called first to provide the information which instrument to load. |
156 |
* This method will then actually start to load the instrument and block |
157 |
* the calling thread until loading was completed. |
158 |
* |
159 |
* @returns detailed description of the method call result |
160 |
* @see PrepareLoadInstrument() |
161 |
*/ |
162 |
void EngineChannel::LoadInstrument() { |
163 |
|
164 |
if (pEngine) pEngine->DisableAndLock(); |
165 |
|
166 |
ResetInternal(); |
167 |
|
168 |
// free old instrument |
169 |
if (pInstrument) { |
170 |
// give old instrument back to instrument manager |
171 |
Engine::instruments.HandBack(pInstrument, this); |
172 |
} |
173 |
|
174 |
// delete all key groups |
175 |
ActiveKeyGroups.clear(); |
176 |
|
177 |
// request gig instrument from instrument manager |
178 |
try { |
179 |
instrument_id_t instrid; |
180 |
instrid.FileName = InstrumentFile; |
181 |
instrid.iInstrument = InstrumentIdx; |
182 |
pInstrument = Engine::instruments.Borrow(instrid, this); |
183 |
if (!pInstrument) { |
184 |
InstrumentStat = -1; |
185 |
dmsg(1,("no instrument loaded!!!\n")); |
186 |
exit(EXIT_FAILURE); |
187 |
} |
188 |
} |
189 |
catch (RIFF::Exception e) { |
190 |
InstrumentStat = -2; |
191 |
String msg = "gig::Engine error: Failed to load instrument, cause: " + e.Message; |
192 |
throw LinuxSamplerException(msg); |
193 |
} |
194 |
catch (InstrumentResourceManagerException e) { |
195 |
InstrumentStat = -3; |
196 |
String msg = "gig::Engine error: Failed to load instrument, cause: " + e.Message(); |
197 |
throw LinuxSamplerException(msg); |
198 |
} |
199 |
catch (...) { |
200 |
InstrumentStat = -4; |
201 |
throw LinuxSamplerException("gig::Engine error: Failed to load instrument, cause: Unknown exception while trying to parse gig file."); |
202 |
} |
203 |
|
204 |
// rebuild ActiveKeyGroups map with key groups of current instrument |
205 |
for (::gig::Region* pRegion = pInstrument->GetFirstRegion(); pRegion; pRegion = pInstrument->GetNextRegion()) |
206 |
if (pRegion->KeyGroup) ActiveKeyGroups[pRegion->KeyGroup] = NULL; |
207 |
|
208 |
InstrumentIdxName = pInstrument->pInfo->Name; |
209 |
InstrumentStat = 100; |
210 |
|
211 |
// inform audio driver for the need of two channels |
212 |
try { |
213 |
if (pEngine && pEngine->pAudioOutputDevice) |
214 |
pEngine->pAudioOutputDevice->AcquireChannels(2); // gig Engine only stereo |
215 |
} |
216 |
catch (AudioOutputException e) { |
217 |
String msg = "Audio output device unable to provide 2 audio channels, cause: " + e.Message(); |
218 |
throw LinuxSamplerException(msg); |
219 |
} |
220 |
|
221 |
if (pEngine) pEngine->Enable(); |
222 |
} |
223 |
|
224 |
/** |
225 |
* Will be called by the InstrumentResourceManager when the instrument |
226 |
* we are currently using on this EngineChannel is going to be updated, |
227 |
* so we can stop playback before that happens. |
228 |
*/ |
229 |
void EngineChannel::ResourceToBeUpdated(::gig::Instrument* pResource, void*& pUpdateArg) { |
230 |
dmsg(3,("gig::Engine: Received instrument update message.\n")); |
231 |
if (pEngine) pEngine->DisableAndLock(); |
232 |
ResetInternal(); |
233 |
this->pInstrument = NULL; |
234 |
} |
235 |
|
236 |
/** |
237 |
* Will be called by the InstrumentResourceManager when the instrument |
238 |
* update process was completed, so we can continue with playback. |
239 |
*/ |
240 |
void EngineChannel::ResourceUpdated(::gig::Instrument* pOldResource, ::gig::Instrument* pNewResource, void* pUpdateArg) { |
241 |
this->pInstrument = pNewResource; //TODO: there are couple of engine parameters we should update here as well if the instrument was updated (see LoadInstrument()) |
242 |
if (pEngine) pEngine->Enable(); |
243 |
bStatusChanged = true; // status of engine has changed, so set notify flag |
244 |
} |
245 |
|
246 |
/** |
247 |
* Will be called by the InstrumentResourceManager on progress changes |
248 |
* while loading or realoading an instrument for this EngineChannel. |
249 |
* |
250 |
* @param fProgress - current progress as value between 0.0 and 1.0 |
251 |
*/ |
252 |
void EngineChannel::OnResourceProgress(float fProgress) { |
253 |
this->InstrumentStat = int(fProgress * 100.0f); |
254 |
dmsg(7,("gig::EngineChannel: progress %d%", InstrumentStat)); |
255 |
bStatusChanged = true; // status of engine has changed, so set notify flag |
256 |
} |
257 |
|
258 |
void EngineChannel::Connect(AudioOutputDevice* pAudioOut) { |
259 |
if (pEngine) { |
260 |
if (pEngine->pAudioOutputDevice == pAudioOut) return; |
261 |
DisconnectAudioOutputDevice(); |
262 |
} |
263 |
pEngine = Engine::AcquireEngine(this, pAudioOut); |
264 |
ResetInternal(); |
265 |
pEvents = new RTList<Event>(pEngine->pEventPool); |
266 |
for (uint i = 0; i < 128; i++) { |
267 |
pMIDIKeyInfo[i].pActiveVoices = new RTList<Voice>(pEngine->pVoicePool); |
268 |
pMIDIKeyInfo[i].pEvents = new RTList<Event>(pEngine->pEventPool); |
269 |
} |
270 |
AudioDeviceChannelLeft = 0; |
271 |
AudioDeviceChannelRight = 1; |
272 |
pOutputLeft = pAudioOut->Channel(0)->Buffer(); |
273 |
pOutputRight = pAudioOut->Channel(1)->Buffer(); |
274 |
} |
275 |
|
276 |
void EngineChannel::DisconnectAudioOutputDevice() { |
277 |
if (pEngine) { // if clause to prevent disconnect loops |
278 |
ResetInternal(); |
279 |
if (pEvents) { |
280 |
delete pEvents; |
281 |
pEvents = NULL; |
282 |
} |
283 |
for (uint i = 0; i < 128; i++) { |
284 |
if (pMIDIKeyInfo[i].pActiveVoices) { |
285 |
delete pMIDIKeyInfo[i].pActiveVoices; |
286 |
pMIDIKeyInfo[i].pActiveVoices = NULL; |
287 |
} |
288 |
if (pMIDIKeyInfo[i].pEvents) { |
289 |
delete pMIDIKeyInfo[i].pEvents; |
290 |
pMIDIKeyInfo[i].pEvents = NULL; |
291 |
} |
292 |
} |
293 |
Engine* oldEngine = pEngine; |
294 |
AudioOutputDevice* oldAudioDevice = pEngine->pAudioOutputDevice; |
295 |
pEngine = NULL; |
296 |
Engine::FreeEngine(this, oldAudioDevice); |
297 |
AudioDeviceChannelLeft = -1; |
298 |
AudioDeviceChannelRight = -1; |
299 |
} |
300 |
} |
301 |
|
302 |
void EngineChannel::SetOutputChannel(uint EngineAudioChannel, uint AudioDeviceChannel) { |
303 |
if (!pEngine || !pEngine->pAudioOutputDevice) throw AudioOutputException("No audio output device connected yet."); |
304 |
|
305 |
AudioChannel* pChannel = pEngine->pAudioOutputDevice->Channel(AudioDeviceChannel); |
306 |
if (!pChannel) throw AudioOutputException("Invalid audio output device channel " + ToString(AudioDeviceChannel)); |
307 |
switch (EngineAudioChannel) { |
308 |
case 0: // left output channel |
309 |
pOutputLeft = pChannel->Buffer(); |
310 |
AudioDeviceChannelLeft = AudioDeviceChannel; |
311 |
break; |
312 |
case 1: // right output channel |
313 |
pOutputRight = pChannel->Buffer(); |
314 |
AudioDeviceChannelRight = AudioDeviceChannel; |
315 |
break; |
316 |
default: |
317 |
throw AudioOutputException("Invalid engine audio channel " + ToString(EngineAudioChannel)); |
318 |
} |
319 |
} |
320 |
|
321 |
int EngineChannel::OutputChannel(uint EngineAudioChannel) { |
322 |
switch (EngineAudioChannel) { |
323 |
case 0: // left channel |
324 |
return AudioDeviceChannelLeft; |
325 |
case 1: // right channel |
326 |
return AudioDeviceChannelRight; |
327 |
default: |
328 |
throw AudioOutputException("Invalid engine audio channel " + ToString(EngineAudioChannel)); |
329 |
} |
330 |
} |
331 |
|
332 |
void EngineChannel::Connect(MidiInputPort* pMidiPort, midi_chan_t MidiChannel) { |
333 |
if (!pMidiPort || pMidiPort == this->pMidiInputPort) return; |
334 |
DisconnectMidiInputPort(); |
335 |
this->pMidiInputPort = pMidiPort; |
336 |
this->midiChannel = MidiChannel; |
337 |
pMidiPort->Connect(this, MidiChannel); |
338 |
} |
339 |
|
340 |
void EngineChannel::DisconnectMidiInputPort() { |
341 |
MidiInputPort* pOldPort = this->pMidiInputPort; |
342 |
this->pMidiInputPort = NULL; |
343 |
if (pOldPort) pOldPort->Disconnect(this); |
344 |
} |
345 |
|
346 |
MidiInputPort* EngineChannel::GetMidiInputPort() { |
347 |
return pMidiInputPort; |
348 |
} |
349 |
|
350 |
midi_chan_t EngineChannel::MidiChannel() { |
351 |
return midiChannel; |
352 |
} |
353 |
|
354 |
/** |
355 |
* Will be called by the MIDIIn Thread to let the audio thread trigger a new |
356 |
* voice for the given key. |
357 |
* |
358 |
* @param Key - MIDI key number of the triggered key |
359 |
* @param Velocity - MIDI velocity value of the triggered key |
360 |
*/ |
361 |
void EngineChannel::SendNoteOn(uint8_t Key, uint8_t Velocity) { |
362 |
if (pEngine) { |
363 |
Event event = pEngine->pEventGenerator->CreateEvent(); |
364 |
event.Type = Event::type_note_on; |
365 |
event.Param.Note.Key = Key; |
366 |
event.Param.Note.Velocity = Velocity; |
367 |
event.pEngineChannel = this; |
368 |
if (this->pEventQueue->write_space() > 0) this->pEventQueue->push(&event); |
369 |
else dmsg(1,("EngineChannel: Input event queue full!")); |
370 |
} |
371 |
} |
372 |
|
373 |
/** |
374 |
* Will be called by the MIDIIn Thread to signal the audio thread to release |
375 |
* voice(s) on the given key. |
376 |
* |
377 |
* @param Key - MIDI key number of the released key |
378 |
* @param Velocity - MIDI release velocity value of the released key |
379 |
*/ |
380 |
void EngineChannel::SendNoteOff(uint8_t Key, uint8_t Velocity) { |
381 |
if (pEngine) { |
382 |
Event event = pEngine->pEventGenerator->CreateEvent(); |
383 |
event.Type = Event::type_note_off; |
384 |
event.Param.Note.Key = Key; |
385 |
event.Param.Note.Velocity = Velocity; |
386 |
event.pEngineChannel = this; |
387 |
if (this->pEventQueue->write_space() > 0) this->pEventQueue->push(&event); |
388 |
else dmsg(1,("EngineChannel: Input event queue full!")); |
389 |
} |
390 |
} |
391 |
|
392 |
/** |
393 |
* Will be called by the MIDIIn Thread to signal the audio thread to change |
394 |
* the pitch value for all voices. |
395 |
* |
396 |
* @param Pitch - MIDI pitch value (-8192 ... +8191) |
397 |
*/ |
398 |
void EngineChannel::SendPitchbend(int Pitch) { |
399 |
if (pEngine) { |
400 |
Event event = pEngine->pEventGenerator->CreateEvent(); |
401 |
event.Type = Event::type_pitchbend; |
402 |
event.Param.Pitch.Pitch = Pitch; |
403 |
event.pEngineChannel = this; |
404 |
if (this->pEventQueue->write_space() > 0) this->pEventQueue->push(&event); |
405 |
else dmsg(1,("EngineChannel: Input event queue full!")); |
406 |
} |
407 |
} |
408 |
|
409 |
/** |
410 |
* Will be called by the MIDIIn Thread to signal the audio thread that a |
411 |
* continuous controller value has changed. |
412 |
* |
413 |
* @param Controller - MIDI controller number of the occured control change |
414 |
* @param Value - value of the control change |
415 |
*/ |
416 |
void EngineChannel::SendControlChange(uint8_t Controller, uint8_t Value) { |
417 |
if (pEngine) { |
418 |
Event event = pEngine->pEventGenerator->CreateEvent(); |
419 |
event.Type = Event::type_control_change; |
420 |
event.Param.CC.Controller = Controller; |
421 |
event.Param.CC.Value = Value; |
422 |
event.pEngineChannel = this; |
423 |
if (this->pEventQueue->write_space() > 0) this->pEventQueue->push(&event); |
424 |
else dmsg(1,("EngineChannel: Input event queue full!")); |
425 |
} |
426 |
} |
427 |
|
428 |
void EngineChannel::ClearEventLists() { |
429 |
pEvents->clear(); |
430 |
// empty MIDI key specific event lists |
431 |
{ |
432 |
RTList<uint>::Iterator iuiKey = pActiveKeys->first(); |
433 |
RTList<uint>::Iterator end = pActiveKeys->end(); |
434 |
for(; iuiKey != end; ++iuiKey) { |
435 |
pMIDIKeyInfo[*iuiKey].pEvents->clear(); // free all events on the key |
436 |
} |
437 |
} |
438 |
} |
439 |
|
440 |
void EngineChannel::ResetControllers() { |
441 |
Pitch = 0; |
442 |
SustainPedal = false; |
443 |
SostenutoPedal = false; |
444 |
GlobalVolume = CONFIG_GLOBAL_ATTENUATION; |
445 |
GlobalPanLeft = 1.0f; |
446 |
GlobalPanRight = 1.0f; |
447 |
// set all MIDI controller values to zero |
448 |
memset(ControllerTable, 0x00, 128); |
449 |
} |
450 |
|
451 |
/** |
452 |
* Copy all events from the engine channel's input event queue buffer to |
453 |
* the internal event list. This will be done at the beginning of each |
454 |
* audio cycle (that is each RenderAudio() call) to distinguish all |
455 |
* events which have to be processed in the current audio cycle. Each |
456 |
* EngineChannel has it's own input event queue for the common channel |
457 |
* specific events (like NoteOn, NoteOff and ControlChange events). |
458 |
* Beside that, the engine also has a input event queue for global |
459 |
* events (usually SysEx messages). |
460 |
* |
461 |
* @param Samples - number of sample points to be processed in the |
462 |
* current audio cycle |
463 |
*/ |
464 |
void EngineChannel::ImportEvents(uint Samples) { |
465 |
RingBuffer<Event>::NonVolatileReader eventQueueReader = pEventQueue->get_non_volatile_reader(); |
466 |
Event* pEvent; |
467 |
while (true) { |
468 |
// get next event from input event queue |
469 |
if (!(pEvent = eventQueueReader.pop())) break; |
470 |
// if younger event reached, ignore that and all subsequent ones for now |
471 |
if (pEvent->FragmentPos() >= Samples) { |
472 |
eventQueueReader--; |
473 |
dmsg(2,("Younger Event, pos=%d ,Samples=%d!\n",pEvent->FragmentPos(),Samples)); |
474 |
pEvent->ResetFragmentPos(); |
475 |
break; |
476 |
} |
477 |
// copy event to internal event list |
478 |
if (pEvents->poolIsEmpty()) { |
479 |
dmsg(1,("Event pool emtpy!\n")); |
480 |
break; |
481 |
} |
482 |
*pEvents->allocAppend() = *pEvent; |
483 |
} |
484 |
eventQueueReader.free(); // free all copied events from input queue |
485 |
} |
486 |
|
487 |
float EngineChannel::Volume() { |
488 |
return GlobalVolume; |
489 |
} |
490 |
|
491 |
void EngineChannel::Volume(float f) { |
492 |
GlobalVolume = f; |
493 |
bStatusChanged = true; // status of engine channel has changed, so set notify flag |
494 |
} |
495 |
|
496 |
uint EngineChannel::Channels() { |
497 |
return 2; |
498 |
} |
499 |
|
500 |
String EngineChannel::InstrumentFileName() { |
501 |
return InstrumentFile; |
502 |
} |
503 |
|
504 |
String EngineChannel::InstrumentName() { |
505 |
return InstrumentIdxName; |
506 |
} |
507 |
|
508 |
int EngineChannel::InstrumentIndex() { |
509 |
return InstrumentIdx; |
510 |
} |
511 |
|
512 |
int EngineChannel::InstrumentStatus() { |
513 |
return InstrumentStat; |
514 |
} |
515 |
|
516 |
String EngineChannel::EngineName() { |
517 |
return LS_GIG_ENGINE_NAME; |
518 |
} |
519 |
|
520 |
}} // namespace LinuxSampler::gig |