/[svn]/linuxsampler/trunk/src/engines/gig/Engine.cpp
ViewVC logotype

Contents of /linuxsampler/trunk/src/engines/gig/Engine.cpp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 716 - (show annotations) (download)
Sun Jul 24 06:57:30 2005 UTC (14 years, 2 months ago) by iliev
File size: 68921 byte(s)
* Added configure option --enable-process-muted-channels
which can be used to enable the processing of muted channels

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 #include <sstream>
25 #include "DiskThread.h"
26 #include "Voice.h"
27 #include "EGADSR.h"
28 #include "../EngineFactory.h"
29
30 #include "Engine.h"
31
32 #if defined(__APPLE__)
33 # include <stdlib.h>
34 #else
35 # include <malloc.h>
36 #endif
37
38 namespace LinuxSampler { namespace gig {
39
40 InstrumentResourceManager Engine::instruments;
41
42 std::map<AudioOutputDevice*,Engine*> Engine::engines;
43
44 /**
45 * Get a gig::Engine object for the given gig::EngineChannel and the
46 * given AudioOutputDevice. All engine channels which are connected to
47 * the same audio output device will use the same engine instance. This
48 * method will be called by a gig::EngineChannel whenever it's
49 * connecting to a audio output device.
50 *
51 * @param pChannel - engine channel which acquires an engine object
52 * @param pDevice - the audio output device \a pChannel is connected to
53 */
54 Engine* Engine::AcquireEngine(LinuxSampler::gig::EngineChannel* pChannel, AudioOutputDevice* pDevice) {
55 Engine* pEngine = NULL;
56 // check if there's already an engine for the given audio output device
57 if (engines.count(pDevice)) {
58 dmsg(4,("Using existing gig::Engine.\n"));
59 pEngine = engines[pDevice];
60 } else { // create a new engine (and disk thread) instance for the given audio output device
61 dmsg(4,("Creating new gig::Engine.\n"));
62 pEngine = (Engine*) EngineFactory::Create("gig");
63 pEngine->Connect(pDevice);
64 engines[pDevice] = pEngine;
65 }
66 // register engine channel to the engine instance
67 pEngine->engineChannels.add(pChannel);
68 // remember index in the ArrayList
69 pChannel->iEngineIndexSelf = pEngine->engineChannels.size() - 1;
70 dmsg(4,("This gig::Engine has now %d EngineChannels.\n",pEngine->engineChannels.size()));
71 return pEngine;
72 }
73
74 /**
75 * Once an engine channel is disconnected from an audio output device,
76 * it wil immediately call this method to unregister itself from the
77 * engine instance and if that engine instance is not used by any other
78 * engine channel anymore, then that engine instance will be destroyed.
79 *
80 * @param pChannel - engine channel which wants to disconnect from it's
81 * engine instance
82 * @param pDevice - audio output device \a pChannel was connected to
83 */
84 void Engine::FreeEngine(LinuxSampler::gig::EngineChannel* pChannel, AudioOutputDevice* pDevice) {
85 dmsg(4,("Disconnecting EngineChannel from gig::Engine.\n"));
86 Engine* pEngine = engines[pDevice];
87 // unregister EngineChannel from the Engine instance
88 pEngine->engineChannels.remove(pChannel);
89 // if the used Engine instance is not used anymore, then destroy it
90 if (pEngine->engineChannels.empty()) {
91 pDevice->Disconnect(pEngine);
92 engines.erase(pDevice);
93 delete pEngine;
94 dmsg(4,("Destroying gig::Engine.\n"));
95 }
96 else dmsg(4,("This gig::Engine has now %d EngineChannels.\n",pEngine->engineChannels.size()));
97 }
98
99 /**
100 * Constructor
101 */
102 Engine::Engine() {
103 pAudioOutputDevice = NULL;
104 pDiskThread = NULL;
105 pEventGenerator = NULL;
106 pSysexBuffer = new RingBuffer<uint8_t>(CONFIG_SYSEX_BUFFER_SIZE, 0);
107 pEventQueue = new RingBuffer<Event>(CONFIG_MAX_EVENTS_PER_FRAGMENT, 0);
108 pEventPool = new Pool<Event>(CONFIG_MAX_EVENTS_PER_FRAGMENT);
109 pVoicePool = new Pool<Voice>(CONFIG_MAX_VOICES);
110 pVoiceStealingQueue = new RTList<Event>(pEventPool);
111 pGlobalEvents = new RTList<Event>(pEventPool);
112 for (RTList<Voice>::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) {
113 iterVoice->SetEngine(this);
114 }
115 pVoicePool->clear();
116
117 pSynthesisParameters[0] = NULL; // we allocate when an audio device is connected
118 pBasicFilterParameters = NULL;
119 pMainFilterParameters = NULL;
120
121 ResetInternal();
122 ResetScaleTuning();
123 }
124
125 /**
126 * Destructor
127 */
128 Engine::~Engine() {
129 if (pDiskThread) {
130 dmsg(1,("Stopping disk thread..."));
131 pDiskThread->StopThread();
132 delete pDiskThread;
133 dmsg(1,("OK\n"));
134 }
135 if (pEventQueue) delete pEventQueue;
136 if (pEventPool) delete pEventPool;
137 if (pVoicePool) {
138 pVoicePool->clear();
139 delete pVoicePool;
140 }
141 if (pEventGenerator) delete pEventGenerator;
142 if (pMainFilterParameters) delete[] pMainFilterParameters;
143 if (pBasicFilterParameters) delete[] pBasicFilterParameters;
144 if (pSynthesisParameters[0]) free(pSynthesisParameters[0]);
145 if (pVoiceStealingQueue) delete pVoiceStealingQueue;
146 if (pSysexBuffer) delete pSysexBuffer;
147 EngineFactory::Destroy(this);
148 }
149
150 void Engine::Enable() {
151 dmsg(3,("gig::Engine: enabling\n"));
152 EngineDisabled.PushAndUnlock(false, 2); // set condition object 'EngineDisabled' to false (wait max. 2s)
153 dmsg(3,("gig::Engine: enabled (val=%d)\n", EngineDisabled.GetUnsafe()));
154 }
155
156 void Engine::Disable() {
157 dmsg(3,("gig::Engine: disabling\n"));
158 bool* pWasDisabled = EngineDisabled.PushAndUnlock(true, 2); // wait max. 2s
159 if (!pWasDisabled) dmsg(3,("gig::Engine warning: Timeout waiting to disable engine.\n"));
160 }
161
162 void Engine::DisableAndLock() {
163 dmsg(3,("gig::Engine: disabling\n"));
164 bool* pWasDisabled = EngineDisabled.Push(true, 2); // wait max. 2s
165 if (!pWasDisabled) dmsg(3,("gig::Engine warning: Timeout waiting to disable engine.\n"));
166 }
167
168 /**
169 * Reset all voices and disk thread and clear input event queue and all
170 * control and status variables.
171 */
172 void Engine::Reset() {
173 DisableAndLock();
174 ResetInternal();
175 ResetScaleTuning();
176 Enable();
177 }
178
179 /**
180 * Reset all voices and disk thread and clear input event queue and all
181 * control and status variables. This method is not thread safe!
182 */
183 void Engine::ResetInternal() {
184 ActiveVoiceCount = 0;
185 ActiveVoiceCountMax = 0;
186
187 // reset voice stealing parameters
188 pVoiceStealingQueue->clear();
189 itLastStolenVoice = RTList<Voice>::Iterator();
190 itLastStolenVoiceGlobally = RTList<Voice>::Iterator();
191 iuiLastStolenKey = RTList<uint>::Iterator();
192 iuiLastStolenKeyGlobally = RTList<uint>::Iterator();
193 pLastStolenChannel = NULL;
194
195 // reset all voices
196 for (RTList<Voice>::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) {
197 iterVoice->Reset();
198 }
199 pVoicePool->clear();
200
201 // reset disk thread
202 if (pDiskThread) pDiskThread->Reset();
203
204 // delete all input events
205 pEventQueue->init();
206 }
207
208 /**
209 * Reset to normal, chromatic scale (means equal tempered).
210 */
211 void Engine::ResetScaleTuning() {
212 memset(&ScaleTuning[0], 0x00, 12);
213 }
214
215 /**
216 * Connect this engine instance with the given audio output device.
217 * This method will be called when an Engine instance is created.
218 * All of the engine's data structures which are dependant to the used
219 * audio output device / driver will be (re)allocated and / or
220 * adjusted appropriately.
221 *
222 * @param pAudioOut - audio output device to connect to
223 */
224 void Engine::Connect(AudioOutputDevice* pAudioOut) {
225 pAudioOutputDevice = pAudioOut;
226
227 ResetInternal();
228
229 // inform audio driver for the need of two channels
230 try {
231 pAudioOutputDevice->AcquireChannels(2); // gig engine only stereo
232 }
233 catch (AudioOutputException e) {
234 String msg = "Audio output device unable to provide 2 audio channels, cause: " + e.Message();
235 throw LinuxSamplerException(msg);
236 }
237
238 this->MaxSamplesPerCycle = pAudioOutputDevice->MaxSamplesPerCycle();
239 this->SampleRate = pAudioOutputDevice->SampleRate();
240
241 // FIXME: audio drivers with varying fragment sizes might be a problem here
242 MaxFadeOutPos = MaxSamplesPerCycle - int(double(SampleRate) * CONFIG_EG_MIN_RELEASE_TIME) - 1;
243 if (MaxFadeOutPos < 0) {
244 std::cerr << "gig::Engine: WARNING, CONFIG_EG_MIN_RELEASE_TIME "
245 << "too big for current audio fragment size & sampling rate! "
246 << "May lead to click sounds if voice stealing chimes in!\n" << std::flush;
247 // force volume ramp downs at the beginning of each fragment
248 MaxFadeOutPos = 0;
249 // lower minimum release time
250 const float minReleaseTime = (float) MaxSamplesPerCycle / (float) SampleRate;
251 for (RTList<Voice>::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) {
252 iterVoice->pEG1->CalculateFadeOutCoeff(minReleaseTime, SampleRate);
253 }
254 pVoicePool->clear();
255 }
256
257 // (re)create disk thread
258 if (this->pDiskThread) {
259 dmsg(1,("Stopping disk thread..."));
260 this->pDiskThread->StopThread();
261 delete this->pDiskThread;
262 dmsg(1,("OK\n"));
263 }
264 this->pDiskThread = new DiskThread(((pAudioOut->MaxSamplesPerCycle() << CONFIG_MAX_PITCH) << 1) + 6); //FIXME: assuming stereo
265 if (!pDiskThread) {
266 dmsg(0,("gig::Engine new diskthread = NULL\n"));
267 exit(EXIT_FAILURE);
268 }
269
270 for (RTList<Voice>::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) {
271 iterVoice->pDiskThread = this->pDiskThread;
272 dmsg(3,("d"));
273 }
274 pVoicePool->clear();
275
276 // (re)create event generator
277 if (pEventGenerator) delete pEventGenerator;
278 pEventGenerator = new EventGenerator(pAudioOut->SampleRate());
279
280 // (re)allocate synthesis parameter matrix
281 if (pSynthesisParameters[0]) free(pSynthesisParameters[0]);
282
283 #if defined(__APPLE__)
284 pSynthesisParameters[0] = (float *) malloc(Event::destination_count * sizeof(float) * pAudioOut->MaxSamplesPerCycle());
285 #else
286 pSynthesisParameters[0] = (float *) memalign(16,(Event::destination_count * sizeof(float) * pAudioOut->MaxSamplesPerCycle()));
287 #endif
288 for (int dst = 1; dst < Event::destination_count; dst++)
289 pSynthesisParameters[dst] = pSynthesisParameters[dst - 1] + pAudioOut->MaxSamplesPerCycle();
290
291 // (re)allocate biquad filter parameter sequence
292 if (pBasicFilterParameters) delete[] pBasicFilterParameters;
293 if (pMainFilterParameters) delete[] pMainFilterParameters;
294 pBasicFilterParameters = new biquad_param_t[pAudioOut->MaxSamplesPerCycle()];
295 pMainFilterParameters = new biquad_param_t[pAudioOut->MaxSamplesPerCycle()];
296
297 dmsg(1,("Starting disk thread..."));
298 pDiskThread->StartThread();
299 dmsg(1,("OK\n"));
300
301 for (RTList<Voice>::Iterator iterVoice = pVoicePool->allocAppend(); iterVoice == pVoicePool->last(); iterVoice = pVoicePool->allocAppend()) {
302 if (!iterVoice->pDiskThread) {
303 dmsg(0,("Engine -> voice::trigger: !pDiskThread\n"));
304 exit(EXIT_FAILURE);
305 }
306 }
307 }
308
309 /**
310 * Clear all engine global event lists.
311 */
312 void Engine::ClearEventLists() {
313 pGlobalEvents->clear();
314 }
315
316 /**
317 * Copy all events from the engine's global input queue buffer to the
318 * engine's internal event list. This will be done at the beginning of
319 * each audio cycle (that is each RenderAudio() call) to distinguish
320 * all global events which have to be processed in the current audio
321 * cycle. These events are usually just SysEx messages. Every
322 * EngineChannel has it's own input event queue buffer and event list
323 * to handle common events like NoteOn, NoteOff and ControlChange
324 * events.
325 *
326 * @param Samples - number of sample points to be processed in the
327 * current audio cycle
328 */
329 void Engine::ImportEvents(uint Samples) {
330 RingBuffer<Event>::NonVolatileReader eventQueueReader = pEventQueue->get_non_volatile_reader();
331 Event* pEvent;
332 while (true) {
333 // get next event from input event queue
334 if (!(pEvent = eventQueueReader.pop())) break;
335 // if younger event reached, ignore that and all subsequent ones for now
336 if (pEvent->FragmentPos() >= Samples) {
337 eventQueueReader--;
338 dmsg(2,("Younger Event, pos=%d ,Samples=%d!\n",pEvent->FragmentPos(),Samples));
339 pEvent->ResetFragmentPos();
340 break;
341 }
342 // copy event to internal event list
343 if (pGlobalEvents->poolIsEmpty()) {
344 dmsg(1,("Event pool emtpy!\n"));
345 break;
346 }
347 *pGlobalEvents->allocAppend() = *pEvent;
348 }
349 eventQueueReader.free(); // free all copied events from input queue
350 }
351
352 /**
353 * Let this engine proceed to render the given amount of sample points. The
354 * calculated audio data of all voices of this engine will be placed into
355 * the engine's audio sum buffer which has to be copied and eventually be
356 * converted to the appropriate value range by the audio output class (e.g.
357 * AlsaIO or JackIO) right after.
358 *
359 * @param Samples - number of sample points to be rendered
360 * @returns 0 on success
361 */
362 int Engine::RenderAudio(uint Samples) {
363 dmsg(5,("RenderAudio(Samples=%d)\n", Samples));
364
365 // return if engine disabled
366 if (EngineDisabled.Pop()) {
367 dmsg(5,("gig::Engine: engine disabled (val=%d)\n",EngineDisabled.GetUnsafe()));
368 return 0;
369 }
370
371 // update time of start and end of this audio fragment (as events' time stamps relate to this)
372 pEventGenerator->UpdateFragmentTime(Samples);
373
374 // We only allow a maximum of CONFIG_MAX_VOICES voices to be spawned
375 // in each audio fragment. All subsequent request for spawning new
376 // voices in the same audio fragment will be ignored.
377 VoiceSpawnsLeft = CONFIG_MAX_VOICES;
378
379 // get all events from the engine's global input event queue which belong to the current fragment
380 // (these are usually just SysEx messages)
381 ImportEvents(Samples);
382
383 // process engine global events (these are currently only MIDI System Exclusive messages)
384 {
385 RTList<Event>::Iterator itEvent = pGlobalEvents->first();
386 RTList<Event>::Iterator end = pGlobalEvents->end();
387 for (; itEvent != end; ++itEvent) {
388 switch (itEvent->Type) {
389 case Event::type_sysex:
390 dmsg(5,("Engine: Sysex received\n"));
391 ProcessSysex(itEvent);
392 break;
393 }
394 }
395 }
396
397 // reset internal voice counter (just for statistic of active voices)
398 ActiveVoiceCountTemp = 0;
399
400 // handle events on all engine channels
401 for (int i = 0; i < engineChannels.size(); i++) {
402 if (!engineChannels[i]->pInstrument) continue; // ignore if no instrument loaded
403 ProcessEvents(engineChannels[i], Samples);
404 }
405
406 // render all 'normal', active voices on all engine channels
407 for (int i = 0; i < engineChannels.size(); i++) {
408 if (!engineChannels[i]->pInstrument) continue; // ignore if no instrument loaded
409 RenderActiveVoices(engineChannels[i], Samples);
410 }
411
412 // now that all ordinary voices on ALL engine channels are rendered, render new stolen voices
413 RenderStolenVoices(Samples);
414
415 // handle cleanup on all engine channels for the next audio fragment
416 for (int i = 0; i < engineChannels.size(); i++) {
417 if (!engineChannels[i]->pInstrument) continue; // ignore if no instrument loaded
418 PostProcess(engineChannels[i]);
419 }
420
421
422 // empty the engine's event list for the next audio fragment
423 ClearEventLists();
424
425 // reset voice stealing for the next audio fragment
426 pVoiceStealingQueue->clear();
427
428 // just some statistics about this engine instance
429 ActiveVoiceCount = ActiveVoiceCountTemp;
430 if (ActiveVoiceCount > ActiveVoiceCountMax) ActiveVoiceCountMax = ActiveVoiceCount;
431
432 FrameTime += Samples;
433
434 return 0;
435 }
436
437 /**
438 * Dispatch and handle all events in this audio fragment for the given
439 * engine channel.
440 *
441 * @param pEngineChannel - engine channel on which events should be
442 * processed
443 * @param Samples - amount of sample points to be processed in
444 * this audio fragment cycle
445 */
446 void Engine::ProcessEvents(EngineChannel* pEngineChannel, uint Samples) {
447 // get all events from the engine channels's input event queue which belong to the current fragment
448 // (these are the common events like NoteOn, NoteOff, ControlChange, etc.)
449 pEngineChannel->ImportEvents(Samples);
450
451 // process events
452 {
453 RTList<Event>::Iterator itEvent = pEngineChannel->pEvents->first();
454 RTList<Event>::Iterator end = pEngineChannel->pEvents->end();
455 for (; itEvent != end; ++itEvent) {
456 switch (itEvent->Type) {
457 case Event::type_note_on:
458 dmsg(5,("Engine: Note on received\n"));
459 ProcessNoteOn((EngineChannel*)itEvent->pEngineChannel, itEvent);
460 break;
461 case Event::type_note_off:
462 dmsg(5,("Engine: Note off received\n"));
463 ProcessNoteOff((EngineChannel*)itEvent->pEngineChannel, itEvent);
464 break;
465 case Event::type_control_change:
466 dmsg(5,("Engine: MIDI CC received\n"));
467 ProcessControlChange((EngineChannel*)itEvent->pEngineChannel, itEvent);
468 break;
469 case Event::type_pitchbend:
470 dmsg(5,("Engine: Pitchbend received\n"));
471 ProcessPitchbend((EngineChannel*)itEvent->pEngineChannel, itEvent);
472 break;
473 }
474 }
475 }
476
477 // reset voice stealing for the next engine channel (or next audio fragment)
478 itLastStolenVoice = RTList<Voice>::Iterator();
479 itLastStolenVoiceGlobally = RTList<Voice>::Iterator();
480 iuiLastStolenKey = RTList<uint>::Iterator();
481 iuiLastStolenKeyGlobally = RTList<uint>::Iterator();
482 pLastStolenChannel = NULL;
483 }
484
485 /**
486 * Render all 'normal' voices (that is voices which were not stolen in
487 * this fragment) on the given engine channel.
488 *
489 * @param pEngineChannel - engine channel on which audio should be
490 * rendered
491 * @param Samples - amount of sample points to be rendered in
492 * this audio fragment cycle
493 */
494 void Engine::RenderActiveVoices(EngineChannel* pEngineChannel, uint Samples) {
495 #if !CONFIG_PROCESS_MUTED_CHANNELS
496 if (pEngineChannel->GetMute()) return; // skip if sampler channel is muted
497 #endif
498
499 RTList<uint>::Iterator iuiKey = pEngineChannel->pActiveKeys->first();
500 RTList<uint>::Iterator end = pEngineChannel->pActiveKeys->end();
501 while (iuiKey != end) { // iterate through all active keys
502 midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey];
503 ++iuiKey;
504
505 RTList<Voice>::Iterator itVoice = pKey->pActiveVoices->first();
506 RTList<Voice>::Iterator itVoicesEnd = pKey->pActiveVoices->end();
507 for (; itVoice != itVoicesEnd; ++itVoice) { // iterate through all voices on this key
508 // now render current voice
509 itVoice->Render(Samples);
510 if (itVoice->IsActive()) ActiveVoiceCountTemp++; // still active
511 else { // voice reached end, is now inactive
512 FreeVoice(pEngineChannel, itVoice); // remove voice from the list of active voices
513 }
514 }
515 }
516 }
517
518 /**
519 * Render all stolen voices (only voices which were stolen in this
520 * fragment) on the given engine channel. Stolen voices are rendered
521 * after all normal voices have been rendered; this is needed to render
522 * audio of those voices which were selected for voice stealing until
523 * the point were the stealing (that is the take over of the voice)
524 * actually happened.
525 *
526 * @param pEngineChannel - engine channel on which audio should be
527 * rendered
528 * @param Samples - amount of sample points to be rendered in
529 * this audio fragment cycle
530 */
531 void Engine::RenderStolenVoices(uint Samples) {
532 RTList<Event>::Iterator itVoiceStealEvent = pVoiceStealingQueue->first();
533 RTList<Event>::Iterator end = pVoiceStealingQueue->end();
534 for (; itVoiceStealEvent != end; ++itVoiceStealEvent) {
535 EngineChannel* pEngineChannel = (EngineChannel*) itVoiceStealEvent->pEngineChannel;
536 Pool<Voice>::Iterator itNewVoice =
537 LaunchVoice(pEngineChannel, itVoiceStealEvent, itVoiceStealEvent->Param.Note.Layer, itVoiceStealEvent->Param.Note.ReleaseTrigger, false, false);
538 if (itNewVoice) {
539 itNewVoice->Render(Samples);
540 if (itNewVoice->IsActive()) ActiveVoiceCountTemp++; // still active
541 else { // voice reached end, is now inactive
542 FreeVoice(pEngineChannel, itNewVoice); // remove voice from the list of active voices
543 }
544 }
545 else dmsg(1,("gig::Engine: ERROR, voice stealing didn't work out!\n"));
546
547 // we need to clear the key's event list explicitly here in case key was never active
548 midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[itVoiceStealEvent->Param.Note.Key];
549 pKey->VoiceTheftsQueued--;
550 if (!pKey->Active && !pKey->VoiceTheftsQueued) pKey->pEvents->clear();
551 }
552 }
553
554 /**
555 * Free all keys which have turned inactive in this audio fragment, from
556 * the list of active keys and clear all event lists on that engine
557 * channel.
558 *
559 * @param pEngineChannel - engine channel to cleanup
560 */
561 void Engine::PostProcess(EngineChannel* pEngineChannel) {
562 // free all keys which have no active voices left
563 {
564 RTList<uint>::Iterator iuiKey = pEngineChannel->pActiveKeys->first();
565 RTList<uint>::Iterator end = pEngineChannel->pActiveKeys->end();
566 while (iuiKey != end) { // iterate through all active keys
567 midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey];
568 ++iuiKey;
569 if (pKey->pActiveVoices->isEmpty()) FreeKey(pEngineChannel, pKey);
570 #if CONFIG_DEVMODE
571 else { // just a sanity check for debugging
572 RTList<Voice>::Iterator itVoice = pKey->pActiveVoices->first();
573 RTList<Voice>::Iterator itVoicesEnd = pKey->pActiveVoices->end();
574 for (; itVoice != itVoicesEnd; ++itVoice) { // iterate through all voices on this key
575 if (itVoice->itKillEvent) {
576 dmsg(1,("gig::Engine: ERROR, killed voice survived !!!\n"));
577 }
578 }
579 }
580 #endif // CONFIG_DEVMODE
581 }
582 }
583
584 // empty the engine channel's own event lists
585 pEngineChannel->ClearEventLists();
586 }
587
588 /**
589 * Will be called by the MIDI input device whenever a MIDI system
590 * exclusive message has arrived.
591 *
592 * @param pData - pointer to sysex data
593 * @param Size - lenght of sysex data (in bytes)
594 */
595 void Engine::SendSysex(void* pData, uint Size) {
596 Event event = pEventGenerator->CreateEvent();
597 event.Type = Event::type_sysex;
598 event.Param.Sysex.Size = Size;
599 event.pEngineChannel = NULL; // as Engine global event
600 if (pEventQueue->write_space() > 0) {
601 if (pSysexBuffer->write_space() >= Size) {
602 // copy sysex data to input buffer
603 uint toWrite = Size;
604 uint8_t* pPos = (uint8_t*) pData;
605 while (toWrite) {
606 const uint writeNow = RTMath::Min(toWrite, pSysexBuffer->write_space_to_end());
607 pSysexBuffer->write(pPos, writeNow);
608 toWrite -= writeNow;
609 pPos += writeNow;
610
611 }
612 // finally place sysex event into input event queue
613 pEventQueue->push(&event);
614 }
615 else dmsg(1,("Engine: Sysex message too large (%d byte) for input buffer (%d byte)!",Size,CONFIG_SYSEX_BUFFER_SIZE));
616 }
617 else dmsg(1,("Engine: Input event queue full!"));
618 }
619
620 /**
621 * Assigns and triggers a new voice for the respective MIDI key.
622 *
623 * @param pEngineChannel - engine channel on which this event occured on
624 * @param itNoteOnEvent - key, velocity and time stamp of the event
625 */
626 void Engine::ProcessNoteOn(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent) {
627 #if !CONFIG_PROCESS_MUTED_CHANNELS
628 if (pEngineChannel->GetMute()) return; // skip if sampler channel is muted
629 #endif
630
631 const int key = itNoteOnEvent->Param.Note.Key;
632
633 // Change key dimension value if key is in keyswitching area
634 {
635 const ::gig::Instrument* pInstrument = pEngineChannel->pInstrument;
636 if (key >= pInstrument->DimensionKeyRange.low && key <= pInstrument->DimensionKeyRange.high)
637 pEngineChannel->CurrentKeyDimension = ((key - pInstrument->DimensionKeyRange.low) * 128) /
638 (pInstrument->DimensionKeyRange.high - pInstrument->DimensionKeyRange.low + 1);
639 }
640
641 midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[key];
642
643 pKey->KeyPressed = true; // the MIDI key was now pressed down
644 pKey->Velocity = itNoteOnEvent->Param.Note.Velocity;
645 pKey->NoteOnTime = FrameTime + itNoteOnEvent->FragmentPos(); // will be used to calculate note length
646
647 // cancel release process of voices on this key if needed
648 if (pKey->Active && !pEngineChannel->SustainPedal) {
649 RTList<Event>::Iterator itCancelReleaseEvent = pKey->pEvents->allocAppend();
650 if (itCancelReleaseEvent) {
651 *itCancelReleaseEvent = *itNoteOnEvent; // copy event
652 itCancelReleaseEvent->Type = Event::type_cancel_release; // transform event type
653 }
654 else dmsg(1,("Event pool emtpy!\n"));
655 }
656
657 // move note on event to the key's own event list
658 RTList<Event>::Iterator itNoteOnEventOnKeyList = itNoteOnEvent.moveToEndOf(pKey->pEvents);
659
660 // allocate and trigger new voice(s) for the key
661 {
662 // first, get total amount of required voices (dependant on amount of layers)
663 ::gig::Region* pRegion = pEngineChannel->pInstrument->GetRegion(itNoteOnEventOnKeyList->Param.Note.Key);
664 if (pRegion) {
665 int voicesRequired = pRegion->Layers;
666 // now launch the required amount of voices
667 for (int i = 0; i < voicesRequired; i++)
668 LaunchVoice(pEngineChannel, itNoteOnEventOnKeyList, i, false, true, true);
669 }
670 }
671
672 // if neither a voice was spawned or postponed then remove note on event from key again
673 if (!pKey->Active && !pKey->VoiceTheftsQueued)
674 pKey->pEvents->free(itNoteOnEventOnKeyList);
675
676 pKey->RoundRobinIndex++;
677 }
678
679 /**
680 * Releases the voices on the given key if sustain pedal is not pressed.
681 * If sustain is pressed, the release of the note will be postponed until
682 * sustain pedal will be released or voice turned inactive by itself (e.g.
683 * due to completion of sample playback).
684 *
685 * @param pEngineChannel - engine channel on which this event occured on
686 * @param itNoteOffEvent - key, velocity and time stamp of the event
687 */
688 void Engine::ProcessNoteOff(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOffEvent) {
689 #if !CONFIG_PROCESS_MUTED_CHANNELS
690 if (pEngineChannel->GetMute()) return; // skip if sampler channel is muted
691 #endif
692
693 midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[itNoteOffEvent->Param.Note.Key];
694 pKey->KeyPressed = false; // the MIDI key was now released
695
696 // release voices on this key if needed
697 if (pKey->Active && !pEngineChannel->SustainPedal) {
698 itNoteOffEvent->Type = Event::type_release; // transform event type
699
700 // move event to the key's own event list
701 RTList<Event>::Iterator itNoteOffEventOnKeyList = itNoteOffEvent.moveToEndOf(pKey->pEvents);
702
703 // spawn release triggered voice(s) if needed
704 if (pKey->ReleaseTrigger) {
705 // first, get total amount of required voices (dependant on amount of layers)
706 ::gig::Region* pRegion = pEngineChannel->pInstrument->GetRegion(itNoteOffEventOnKeyList->Param.Note.Key);
707 if (pRegion) {
708 int voicesRequired = pRegion->Layers;
709
710 // MIDI note-on velocity is used instead of note-off velocity
711 itNoteOffEventOnKeyList->Param.Note.Velocity = pKey->Velocity;
712
713 // now launch the required amount of voices
714 for (int i = 0; i < voicesRequired; i++)
715 LaunchVoice(pEngineChannel, itNoteOffEventOnKeyList, i, true, false, false); //FIXME: for the moment we don't perform voice stealing for release triggered samples
716 }
717 pKey->ReleaseTrigger = false;
718 }
719
720 // if neither a voice was spawned or postponed then remove note off event from key again
721 if (!pKey->Active && !pKey->VoiceTheftsQueued)
722 pKey->pEvents->free(itNoteOffEventOnKeyList);
723 }
724 }
725
726 /**
727 * Moves pitchbend event from the general (input) event list to the pitch
728 * event list.
729 *
730 * @param pEngineChannel - engine channel on which this event occured on
731 * @param itPitchbendEvent - absolute pitch value and time stamp of the event
732 */
733 void Engine::ProcessPitchbend(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itPitchbendEvent) {
734 pEngineChannel->Pitch = itPitchbendEvent->Param.Pitch.Pitch; // store current pitch value
735 itPitchbendEvent.moveToEndOf(pEngineChannel->pSynthesisEvents[Event::destination_vco]);
736 }
737
738 /**
739 * Allocates and triggers a new voice. This method will usually be
740 * called by the ProcessNoteOn() method and by the voices itself
741 * (e.g. to spawn further voices on the same key for layered sounds).
742 *
743 * @param pEngineChannel - engine channel on which this event occured on
744 * @param itNoteOnEvent - key, velocity and time stamp of the event
745 * @param iLayer - layer index for the new voice (optional - only
746 * in case of layered sounds of course)
747 * @param ReleaseTriggerVoice - if new voice is a release triggered voice
748 * (optional, default = false)
749 * @param VoiceStealing - if voice stealing should be performed
750 * when there is no free voice
751 * (optional, default = true)
752 * @param HandleKeyGroupConflicts - if voices should be killed due to a
753 * key group conflict
754 * @returns pointer to new voice or NULL if there was no free voice or
755 * if the voice wasn't triggered (for example when no region is
756 * defined for the given key).
757 */
758 Pool<Voice>::Iterator Engine::LaunchVoice(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent, int iLayer, bool ReleaseTriggerVoice, bool VoiceStealing, bool HandleKeyGroupConflicts) {
759 int MIDIKey = itNoteOnEvent->Param.Note.Key;
760 midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[MIDIKey];
761 ::gig::Region* pRegion = pEngineChannel->pInstrument->GetRegion(MIDIKey);
762
763 // if nothing defined for this key
764 if (!pRegion) return Pool<Voice>::Iterator(); // nothing to do
765
766 // only mark the first voice of a layered voice (group) to be in a
767 // key group, so the layered voices won't kill each other
768 int iKeyGroup = (iLayer == 0 && !ReleaseTriggerVoice) ? pRegion->KeyGroup : 0;
769
770 // handle key group (a.k.a. exclusive group) conflicts
771 if (HandleKeyGroupConflicts) {
772 if (iKeyGroup) { // if this voice / key belongs to a key group
773 uint** ppKeyGroup = &pEngineChannel->ActiveKeyGroups[iKeyGroup];
774 if (*ppKeyGroup) { // if there's already an active key in that key group
775 midi_key_info_t* pOtherKey = &pEngineChannel->pMIDIKeyInfo[**ppKeyGroup];
776 // kill all voices on the (other) key
777 RTList<Voice>::Iterator itVoiceToBeKilled = pOtherKey->pActiveVoices->first();
778 RTList<Voice>::Iterator end = pOtherKey->pActiveVoices->end();
779 for (; itVoiceToBeKilled != end; ++itVoiceToBeKilled) {
780 if (itVoiceToBeKilled->Type != Voice::type_release_trigger) {
781 itVoiceToBeKilled->Kill(itNoteOnEvent);
782 --VoiceSpawnsLeft; //FIXME: just a hack, we should better check in StealVoice() if the voice was killed due to key conflict
783 }
784 }
785 }
786 }
787 }
788
789 Voice::type_t VoiceType = Voice::type_normal;
790
791 // get current dimension values to select the right dimension region
792 //TODO: for stolen voices this dimension region selection block is processed twice, this should be changed
793 //FIXME: controller values for selecting the dimension region here are currently not sample accurate
794 uint DimValues[8] = { 0 };
795 for (int i = pRegion->Dimensions - 1; i >= 0; i--) {
796 switch (pRegion->pDimensionDefinitions[i].dimension) {
797 case ::gig::dimension_samplechannel:
798 DimValues[i] = 0; //TODO: we currently ignore this dimension
799 break;
800 case ::gig::dimension_layer:
801 DimValues[i] = iLayer;
802 break;
803 case ::gig::dimension_velocity:
804 DimValues[i] = itNoteOnEvent->Param.Note.Velocity;
805 break;
806 case ::gig::dimension_channelaftertouch:
807 DimValues[i] = 0; //TODO: we currently ignore this dimension
808 break;
809 case ::gig::dimension_releasetrigger:
810 VoiceType = (ReleaseTriggerVoice) ? Voice::type_release_trigger : (!iLayer) ? Voice::type_release_trigger_required : Voice::type_normal;
811 DimValues[i] = (uint) ReleaseTriggerVoice;
812 break;
813 case ::gig::dimension_keyboard:
814 DimValues[i] = (uint) pEngineChannel->CurrentKeyDimension;
815 break;
816 case ::gig::dimension_roundrobin:
817 DimValues[i] = (uint) pEngineChannel->pMIDIKeyInfo[MIDIKey].RoundRobinIndex; // incremented for each note on
818 break;
819 case ::gig::dimension_random:
820 RandomSeed = RandomSeed * 1103515245 + 12345; // classic pseudo random number generator
821 DimValues[i] = (uint) RandomSeed >> (32 - pRegion->pDimensionDefinitions[i].bits); // highest bits are most random
822 break;
823 case ::gig::dimension_modwheel:
824 DimValues[i] = pEngineChannel->ControllerTable[1];
825 break;
826 case ::gig::dimension_breath:
827 DimValues[i] = pEngineChannel->ControllerTable[2];
828 break;
829 case ::gig::dimension_foot:
830 DimValues[i] = pEngineChannel->ControllerTable[4];
831 break;
832 case ::gig::dimension_portamentotime:
833 DimValues[i] = pEngineChannel->ControllerTable[5];
834 break;
835 case ::gig::dimension_effect1:
836 DimValues[i] = pEngineChannel->ControllerTable[12];
837 break;
838 case ::gig::dimension_effect2:
839 DimValues[i] = pEngineChannel->ControllerTable[13];
840 break;
841 case ::gig::dimension_genpurpose1:
842 DimValues[i] = pEngineChannel->ControllerTable[16];
843 break;
844 case ::gig::dimension_genpurpose2:
845 DimValues[i] = pEngineChannel->ControllerTable[17];
846 break;
847 case ::gig::dimension_genpurpose3:
848 DimValues[i] = pEngineChannel->ControllerTable[18];
849 break;
850 case ::gig::dimension_genpurpose4:
851 DimValues[i] = pEngineChannel->ControllerTable[19];
852 break;
853 case ::gig::dimension_sustainpedal:
854 DimValues[i] = pEngineChannel->ControllerTable[64];
855 break;
856 case ::gig::dimension_portamento:
857 DimValues[i] = pEngineChannel->ControllerTable[65];
858 break;
859 case ::gig::dimension_sostenutopedal:
860 DimValues[i] = pEngineChannel->ControllerTable[66];
861 break;
862 case ::gig::dimension_softpedal:
863 DimValues[i] = pEngineChannel->ControllerTable[67];
864 break;
865 case ::gig::dimension_genpurpose5:
866 DimValues[i] = pEngineChannel->ControllerTable[80];
867 break;
868 case ::gig::dimension_genpurpose6:
869 DimValues[i] = pEngineChannel->ControllerTable[81];
870 break;
871 case ::gig::dimension_genpurpose7:
872 DimValues[i] = pEngineChannel->ControllerTable[82];
873 break;
874 case ::gig::dimension_genpurpose8:
875 DimValues[i] = pEngineChannel->ControllerTable[83];
876 break;
877 case ::gig::dimension_effect1depth:
878 DimValues[i] = pEngineChannel->ControllerTable[91];
879 break;
880 case ::gig::dimension_effect2depth:
881 DimValues[i] = pEngineChannel->ControllerTable[92];
882 break;
883 case ::gig::dimension_effect3depth:
884 DimValues[i] = pEngineChannel->ControllerTable[93];
885 break;
886 case ::gig::dimension_effect4depth:
887 DimValues[i] = pEngineChannel->ControllerTable[94];
888 break;
889 case ::gig::dimension_effect5depth:
890 DimValues[i] = pEngineChannel->ControllerTable[95];
891 break;
892 case ::gig::dimension_none:
893 std::cerr << "gig::Engine::LaunchVoice() Error: dimension=none\n" << std::flush;
894 break;
895 default:
896 std::cerr << "gig::Engine::LaunchVoice() Error: Unknown dimension\n" << std::flush;
897 }
898 }
899 ::gig::DimensionRegion* pDimRgn = pRegion->GetDimensionRegionByValue(DimValues);
900
901 // no need to continue if sample is silent
902 if (!pDimRgn->pSample || !pDimRgn->pSample->SamplesTotal) return Pool<Voice>::Iterator();
903
904 // allocate a new voice for the key
905 Pool<Voice>::Iterator itNewVoice = pKey->pActiveVoices->allocAppend();
906 if (itNewVoice) {
907 // launch the new voice
908 if (itNewVoice->Trigger(pEngineChannel, itNoteOnEvent, pEngineChannel->Pitch, pDimRgn, VoiceType, iKeyGroup) < 0) {
909 dmsg(4,("Voice not triggered\n"));
910 pKey->pActiveVoices->free(itNewVoice);
911 }
912 else { // on success
913 --VoiceSpawnsLeft;
914 if (!pKey->Active) { // mark as active key
915 pKey->Active = true;
916 pKey->itSelf = pEngineChannel->pActiveKeys->allocAppend();
917 *pKey->itSelf = itNoteOnEvent->Param.Note.Key;
918 }
919 if (itNewVoice->KeyGroup) {
920 uint** ppKeyGroup = &pEngineChannel->ActiveKeyGroups[itNewVoice->KeyGroup];
921 *ppKeyGroup = &*pKey->itSelf; // put key as the (new) active key to its key group
922 }
923 if (itNewVoice->Type == Voice::type_release_trigger_required) pKey->ReleaseTrigger = true; // mark key for the need of release triggered voice(s)
924 return itNewVoice; // success
925 }
926 }
927 else if (VoiceStealing) {
928 // try to steal one voice
929 int result = StealVoice(pEngineChannel, itNoteOnEvent);
930 if (!result) { // voice stolen successfully
931 // put note-on event into voice-stealing queue, so it will be reprocessed after killed voice died
932 RTList<Event>::Iterator itStealEvent = pVoiceStealingQueue->allocAppend();
933 if (itStealEvent) {
934 *itStealEvent = *itNoteOnEvent; // copy event
935 itStealEvent->Param.Note.Layer = iLayer;
936 itStealEvent->Param.Note.ReleaseTrigger = ReleaseTriggerVoice;
937 pKey->VoiceTheftsQueued++;
938 }
939 else dmsg(1,("Voice stealing queue full!\n"));
940 }
941 }
942
943 return Pool<Voice>::Iterator(); // no free voice or error
944 }
945
946 /**
947 * Will be called by LaunchVoice() method in case there are no free
948 * voices left. This method will select and kill one old voice for
949 * voice stealing and postpone the note-on event until the selected
950 * voice actually died.
951 *
952 * @param pEngineChannel - engine channel on which this event occured on
953 * @param itNoteOnEvent - key, velocity and time stamp of the event
954 * @returns 0 on success, a value < 0 if no active voice could be picked for voice stealing
955 */
956 int Engine::StealVoice(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itNoteOnEvent) {
957 if (VoiceSpawnsLeft <= 0) {
958 dmsg(1,("Max. voice thefts per audio fragment reached (you may raise CONFIG_MAX_VOICES).\n"));
959 return -1;
960 }
961 if (!pEventPool->poolIsEmpty()) {
962
963 RTList<Voice>::Iterator itSelectedVoice;
964
965 // Select one voice for voice stealing
966 switch (CONFIG_VOICE_STEAL_ALGO) {
967
968 // try to pick the oldest voice on the key where the new
969 // voice should be spawned, if there is no voice on that
970 // key, or no voice left to kill, then procceed with
971 // 'oldestkey' algorithm
972 case voice_steal_algo_oldestvoiceonkey: {
973 midi_key_info_t* pSelectedKey = &pEngineChannel->pMIDIKeyInfo[itNoteOnEvent->Param.Note.Key];
974 itSelectedVoice = pSelectedKey->pActiveVoices->first();
975 // proceed iterating if voice was created in this fragment cycle
976 while (itSelectedVoice && !itSelectedVoice->IsStealable()) ++itSelectedVoice;
977 // if we haven't found a voice then proceed with algorithm 'oldestkey'
978 if (itSelectedVoice && itSelectedVoice->IsStealable()) break;
979 } // no break - intentional !
980
981 // try to pick the oldest voice on the oldest active key
982 // from the same engine channel
983 // (caution: must stay after 'oldestvoiceonkey' algorithm !)
984 case voice_steal_algo_oldestkey: {
985 // if we already stole in this fragment, try to proceed on same key
986 if (this->itLastStolenVoice) {
987 itSelectedVoice = this->itLastStolenVoice;
988 do {
989 ++itSelectedVoice;
990 } while (itSelectedVoice && !itSelectedVoice->IsStealable()); // proceed iterating if voice was created in this fragment cycle
991 // found a "stealable" voice ?
992 if (itSelectedVoice && itSelectedVoice->IsStealable()) {
993 // remember which voice we stole, so we can simply proceed on next voice stealing
994 this->itLastStolenVoice = itSelectedVoice;
995 break; // selection succeeded
996 }
997 }
998 // get (next) oldest key
999 RTList<uint>::Iterator iuiSelectedKey = (this->iuiLastStolenKey) ? ++this->iuiLastStolenKey : pEngineChannel->pActiveKeys->first();
1000 while (iuiSelectedKey) {
1001 midi_key_info_t* pSelectedKey = &pEngineChannel->pMIDIKeyInfo[*iuiSelectedKey];
1002 itSelectedVoice = pSelectedKey->pActiveVoices->first();
1003 // proceed iterating if voice was created in this fragment cycle
1004 while (itSelectedVoice && !itSelectedVoice->IsStealable()) ++itSelectedVoice;
1005 // found a "stealable" voice ?
1006 if (itSelectedVoice && itSelectedVoice->IsStealable()) {
1007 // remember which voice on which key we stole, so we can simply proceed on next voice stealing
1008 this->iuiLastStolenKey = iuiSelectedKey;
1009 this->itLastStolenVoice = itSelectedVoice;
1010 break; // selection succeeded
1011 }
1012 ++iuiSelectedKey; // get next oldest key
1013 }
1014 break;
1015 }
1016
1017 // don't steal anything
1018 case voice_steal_algo_none:
1019 default: {
1020 dmsg(1,("No free voice (voice stealing disabled)!\n"));
1021 return -1;
1022 }
1023 }
1024
1025 // if we couldn't steal a voice from the same engine channel then
1026 // steal oldest voice on the oldest key from any other engine channel
1027 // (the smaller engine channel number, the higher priority)
1028 if (!itSelectedVoice || !itSelectedVoice->IsStealable()) {
1029 EngineChannel* pSelectedChannel;
1030 int iChannelIndex;
1031 // select engine channel
1032 if (pLastStolenChannel) {
1033 pSelectedChannel = pLastStolenChannel;
1034 iChannelIndex = pSelectedChannel->iEngineIndexSelf;
1035 } else { // pick the engine channel followed by this engine channel
1036 iChannelIndex = (pEngineChannel->iEngineIndexSelf + 1) % engineChannels.size();
1037 pSelectedChannel = engineChannels[iChannelIndex];
1038 }
1039
1040 // if we already stole in this fragment, try to proceed on same key
1041 if (this->itLastStolenVoiceGlobally) {
1042 itSelectedVoice = this->itLastStolenVoiceGlobally;
1043 do {
1044 ++itSelectedVoice;
1045 } while (itSelectedVoice && !itSelectedVoice->IsStealable()); // proceed iterating if voice was created in this fragment cycle
1046 }
1047
1048 #if CONFIG_DEVMODE
1049 EngineChannel* pBegin = pSelectedChannel; // to detect endless loop
1050 #endif // CONFIG_DEVMODE
1051
1052 // did we find a 'stealable' voice?
1053 if (itSelectedVoice && itSelectedVoice->IsStealable()) {
1054 // remember which voice we stole, so we can simply proceed on next voice stealing
1055 this->itLastStolenVoiceGlobally = itSelectedVoice;
1056 } else while (true) { // iterate through engine channels
1057 // get (next) oldest key
1058 RTList<uint>::Iterator iuiSelectedKey = (this->iuiLastStolenKeyGlobally) ? ++this->iuiLastStolenKeyGlobally : pSelectedChannel->pActiveKeys->first();
1059 this->iuiLastStolenKeyGlobally = RTList<uint>::Iterator(); // to prevent endless loop (see line above)
1060 while (iuiSelectedKey) {
1061 midi_key_info_t* pSelectedKey = &pSelectedChannel->pMIDIKeyInfo[*iuiSelectedKey];
1062 itSelectedVoice = pSelectedKey->pActiveVoices->first();
1063 // proceed iterating if voice was created in this fragment cycle
1064 while (itSelectedVoice && !itSelectedVoice->IsStealable()) ++itSelectedVoice;
1065 // found a "stealable" voice ?
1066 if (itSelectedVoice && itSelectedVoice->IsStealable()) {
1067 // remember which voice on which key on which engine channel we stole, so we can simply proceed on next voice stealing
1068 this->iuiLastStolenKeyGlobally = iuiSelectedKey;
1069 this->itLastStolenVoiceGlobally = itSelectedVoice;
1070 this->pLastStolenChannel = pSelectedChannel;
1071 goto stealable_voice_found; // selection succeeded
1072 }
1073 ++iuiSelectedKey; // get next key on current engine channel
1074 }
1075 // get next engine channel
1076 iChannelIndex = (iChannelIndex + 1) % engineChannels.size();
1077 pSelectedChannel = engineChannels[iChannelIndex];
1078
1079 #if CONFIG_DEVMODE
1080 if (pSelectedChannel == pBegin) {
1081 dmsg(1,("FATAL ERROR: voice stealing endless loop!\n"));
1082 dmsg(1,("VoiceSpawnsLeft=%d.\n", VoiceSpawnsLeft));
1083 dmsg(1,("Exiting.\n"));
1084 exit(-1);
1085 }
1086 #endif // CONFIG_DEVMODE
1087 }
1088 }
1089
1090 // jump point if a 'stealable' voice was found
1091 stealable_voice_found:
1092
1093 #if CONFIG_DEVMODE
1094 if (!itSelectedVoice->IsActive()) {
1095 dmsg(1,("gig::Engine: ERROR, tried to steal a voice which was not active !!!\n"));
1096 return -1;
1097 }
1098 #endif // CONFIG_DEVMODE
1099
1100 // now kill the selected voice
1101 itSelectedVoice->Kill(itNoteOnEvent);
1102
1103 --VoiceSpawnsLeft;
1104
1105 return 0; // success
1106 }
1107 else {
1108 dmsg(1,("Event pool emtpy!\n"));
1109 return -1;
1110 }
1111 }
1112
1113 /**
1114 * Removes the given voice from the MIDI key's list of active voices.
1115 * This method will be called when a voice went inactive, e.g. because
1116 * it finished to playback its sample, finished its release stage or
1117 * just was killed.
1118 *
1119 * @param pEngineChannel - engine channel on which this event occured on
1120 * @param itVoice - points to the voice to be freed
1121 */
1122 void Engine::FreeVoice(EngineChannel* pEngineChannel, Pool<Voice>::Iterator& itVoice) {
1123 if (itVoice) {
1124 midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[itVoice->MIDIKey];
1125
1126 uint keygroup = itVoice->KeyGroup;
1127
1128 // free the voice object
1129 pVoicePool->free(itVoice);
1130
1131 // if no other voices left and member of a key group, remove from key group
1132 if (pKey->pActiveVoices->isEmpty() && keygroup) {
1133 uint** ppKeyGroup = &pEngineChannel->ActiveKeyGroups[keygroup];
1134 if (*ppKeyGroup == &*pKey->itSelf) *ppKeyGroup = NULL; // remove key from key group
1135 }
1136 }
1137 else std::cerr << "Couldn't release voice! (!itVoice)\n" << std::flush;
1138 }
1139
1140 /**
1141 * Called when there's no more voice left on a key, this call will
1142 * update the key info respectively.
1143 *
1144 * @param pEngineChannel - engine channel on which this event occured on
1145 * @param pKey - key which is now inactive
1146 */
1147 void Engine::FreeKey(EngineChannel* pEngineChannel, midi_key_info_t* pKey) {
1148 if (pKey->pActiveVoices->isEmpty()) {
1149 pKey->Active = false;
1150 pEngineChannel->pActiveKeys->free(pKey->itSelf); // remove key from list of active keys
1151 pKey->itSelf = RTList<uint>::Iterator();
1152 pKey->ReleaseTrigger = false;
1153 pKey->pEvents->clear();
1154 dmsg(3,("Key has no more voices now\n"));
1155 }
1156 else dmsg(1,("gig::Engine: Oops, tried to free a key which contains voices.\n"));
1157 }
1158
1159 /**
1160 * Reacts on supported control change commands (e.g. pitch bend wheel,
1161 * modulation wheel, aftertouch).
1162 *
1163 * @param pEngineChannel - engine channel on which this event occured on
1164 * @param itControlChangeEvent - controller, value and time stamp of the event
1165 */
1166 void Engine::ProcessControlChange(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itControlChangeEvent) {
1167 dmsg(4,("Engine::ContinuousController cc=%d v=%d\n", itControlChangeEvent->Param.CC.Controller, itControlChangeEvent->Param.CC.Value));
1168
1169 // update controller value in the engine channel's controller table
1170 pEngineChannel->ControllerTable[itControlChangeEvent->Param.CC.Controller] = itControlChangeEvent->Param.CC.Value;
1171
1172 // move event from the unsorted event list to the control change event list
1173 Pool<Event>::Iterator itControlChangeEventOnCCList = itControlChangeEvent.moveToEndOf(pEngineChannel->pCCEvents);
1174
1175 switch (itControlChangeEventOnCCList->Param.CC.Controller) {
1176 case 7: { // volume
1177 //TODO: not sample accurate yet
1178 pEngineChannel->GlobalVolume = (float) itControlChangeEventOnCCList->Param.CC.Value / 127.0f;
1179 pEngineChannel->bStatusChanged = true; // engine channel status has changed, so set notify flag
1180 break;
1181 }
1182 case 10: { // panpot
1183 //TODO: not sample accurate yet
1184 const int pan = (int) itControlChangeEventOnCCList->Param.CC.Value - 64;
1185 pEngineChannel->GlobalPanLeft = 1.0f - float(RTMath::Max(pan, 0)) / 63.0f;
1186 pEngineChannel->GlobalPanRight = 1.0f - float(RTMath::Min(pan, 0)) / -64.0f;
1187 break;
1188 }
1189 case 64: { // sustain
1190 if (itControlChangeEventOnCCList->Param.CC.Value >= 64 && !pEngineChannel->SustainPedal) {
1191 dmsg(4,("PEDAL DOWN\n"));
1192 pEngineChannel->SustainPedal = true;
1193
1194 #if !CONFIG_PROCESS_MUTED_CHANNELS
1195 if (pEngineChannel->GetMute()) return; // skip if sampler channel is muted
1196 #endif
1197
1198 // cancel release process of voices if necessary
1199 RTList<uint>::Iterator iuiKey = pEngineChannel->pActiveKeys->first();
1200 for (; iuiKey; ++iuiKey) {
1201 midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey];
1202 if (!pKey->KeyPressed) {
1203 RTList<Event>::Iterator itNewEvent = pKey->pEvents->allocAppend();
1204 if (itNewEvent) {
1205 *itNewEvent = *itControlChangeEventOnCCList; // copy event to the key's own event list
1206 itNewEvent->Type = Event::type_cancel_release; // transform event type
1207 }
1208 else dmsg(1,("Event pool emtpy!\n"));
1209 }
1210 }
1211 }
1212 if (itControlChangeEventOnCCList->Param.CC.Value < 64 && pEngineChannel->SustainPedal) {
1213 dmsg(4,("PEDAL UP\n"));
1214 pEngineChannel->SustainPedal = false;
1215
1216 #if !CONFIG_PROCESS_MUTED_CHANNELS
1217 if (pEngineChannel->GetMute()) return; // skip if sampler channel is muted
1218 #endif
1219
1220 // release voices if their respective key is not pressed
1221 RTList<uint>::Iterator iuiKey = pEngineChannel->pActiveKeys->first();
1222 for (; iuiKey; ++iuiKey) {
1223 midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey];
1224 if (!pKey->KeyPressed) {
1225 RTList<Event>::Iterator itNewEvent = pKey->pEvents->allocAppend();
1226 if (itNewEvent) {
1227 *itNewEvent = *itControlChangeEventOnCCList; // copy event to the key's own event list
1228 itNewEvent->Type = Event::type_release; // transform event type
1229 }
1230 else dmsg(1,("Event pool emtpy!\n"));
1231 }
1232 }
1233 }
1234 break;
1235 }
1236
1237
1238 // Channel Mode Messages
1239
1240 case 120: { // all sound off
1241 KillAllVoices(pEngineChannel, itControlChangeEventOnCCList);
1242 break;
1243 }
1244 case 121: { // reset all controllers
1245 pEngineChannel->ResetControllers();
1246 break;
1247 }
1248 case 123: { // all notes off
1249 ReleaseAllVoices(pEngineChannel, itControlChangeEventOnCCList);
1250 break;
1251 }
1252 }
1253 }
1254
1255 /**
1256 * Reacts on MIDI system exclusive messages.
1257 *
1258 * @param itSysexEvent - sysex data size and time stamp of the sysex event
1259 */
1260 void Engine::ProcessSysex(Pool<Event>::Iterator& itSysexEvent) {
1261 RingBuffer<uint8_t>::NonVolatileReader reader = pSysexBuffer->get_non_volatile_reader();
1262
1263 uint8_t exclusive_status, id;
1264 if (!reader.pop(&exclusive_status)) goto free_sysex_data;
1265 if (!reader.pop(&id)) goto free_sysex_data;
1266 if (exclusive_status != 0xF0) goto free_sysex_data;
1267
1268 switch (id) {
1269 case 0x41: { // Roland
1270 dmsg(3,("Roland Sysex\n"));
1271 uint8_t device_id, model_id, cmd_id;
1272 if (!reader.pop(&device_id)) goto free_sysex_data;
1273 if (!reader.pop(&model_id)) goto free_sysex_data;
1274 if (!reader.pop(&cmd_id)) goto free_sysex_data;
1275 if (model_id != 0x42 /*GS*/) goto free_sysex_data;
1276 if (cmd_id != 0x12 /*DT1*/) goto free_sysex_data;
1277
1278 // command address
1279 uint8_t addr[3]; // 2 byte addr MSB, followed by 1 byte addr LSB)
1280 const RingBuffer<uint8_t>::NonVolatileReader checksum_reader = reader; // so we can calculate the check sum later
1281 if (reader.read(&addr[0], 3) != 3) goto free_sysex_data;
1282 if (addr[0] == 0x40 && addr[1] == 0x00) { // System Parameters
1283 dmsg(3,("\tSystem Parameter\n"));
1284 }
1285 else if (addr[0] == 0x40 && addr[1] == 0x01) { // Common Parameters
1286 dmsg(3,("\tCommon Parameter\n"));
1287 }
1288 else if (addr[0] == 0x40 && (addr[1] & 0xf0) == 0x10) { // Part Parameters (1)
1289 dmsg(3,("\tPart Parameter\n"));
1290 switch (addr[2]) {
1291 case 0x40: { // scale tuning
1292 dmsg(3,("\t\tScale Tuning\n"));
1293 uint8_t scale_tunes[12]; // detuning of all 12 semitones of an octave
1294 if (reader.read(&scale_tunes[0], 12) != 12) goto free_sysex_data;
1295 uint8_t checksum;
1296 if (!reader.pop(&checksum)) goto free_sysex_data;
1297 #if CONFIG_ASSERT_GS_SYSEX_CHECKSUM
1298 if (GSCheckSum(checksum_reader, 12)) goto free_sysex_data;
1299 #endif // CONFIG_ASSERT_GS_SYSEX_CHECKSUM
1300 for (int i = 0; i < 12; i++) scale_tunes[i] -= 64;
1301 AdjustScale((int8_t*) scale_tunes);
1302 dmsg(3,("\t\t\tNew scale applied.\n"));
1303 break;
1304 }
1305 }
1306 }
1307 else if (addr[0] == 0x40 && (addr[1] & 0xf0) == 0x20) { // Part Parameters (2)
1308 }
1309 else if (addr[0] == 0x41) { // Drum Setup Parameters
1310 }
1311 break;
1312 }
1313 }
1314
1315 free_sysex_data: // finally free sysex data
1316 pSysexBuffer->increment_read_ptr(itSysexEvent->Param.Sysex.Size);
1317 }
1318
1319 /**
1320 * Calculates the Roland GS sysex check sum.
1321 *
1322 * @param AddrReader - reader which currently points to the first GS
1323 * command address byte of the GS sysex message in
1324 * question
1325 * @param DataSize - size of the GS message data (in bytes)
1326 */
1327 uint8_t Engine::GSCheckSum(const RingBuffer<uint8_t>::NonVolatileReader AddrReader, uint DataSize) {
1328 RingBuffer<uint8_t>::NonVolatileReader reader = AddrReader;
1329 uint bytes = 3 /*addr*/ + DataSize;
1330 uint8_t addr_and_data[bytes];
1331 reader.read(&addr_and_data[0], bytes);
1332 uint8_t sum = 0;
1333 for (uint i = 0; i < bytes; i++) sum += addr_and_data[i];
1334 return 128 - sum % 128;
1335 }
1336
1337 /**
1338 * Allows to tune each of the twelve semitones of an octave.
1339 *
1340 * @param ScaleTunes - detuning of all twelve semitones (in cents)
1341 */
1342 void Engine::AdjustScale(int8_t ScaleTunes[12]) {
1343 memcpy(&this->ScaleTuning[0], &ScaleTunes[0], 12); //TODO: currently not sample accurate
1344 }
1345
1346 /**
1347 * Releases all voices on an engine channel. All voices will go into
1348 * the release stage and thus it might take some time (e.g. dependant to
1349 * their envelope release time) until they actually die.
1350 *
1351 * @param pEngineChannel - engine channel on which all voices should be released
1352 * @param itReleaseEvent - event which caused this releasing of all voices
1353 */
1354 void Engine::ReleaseAllVoices(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itReleaseEvent) {
1355 RTList<uint>::Iterator iuiKey = pEngineChannel->pActiveKeys->first();
1356 while (iuiKey) {
1357 midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey];
1358 ++iuiKey;
1359 // append a 'release' event to the key's own event list
1360 RTList<Event>::Iterator itNewEvent = pKey->pEvents->allocAppend();
1361 if (itNewEvent) {
1362 *itNewEvent = *itReleaseEvent; // copy original event (to the key's event list)
1363 itNewEvent->Type = Event::type_release; // transform event type
1364 }
1365 else dmsg(1,("Event pool emtpy!\n"));
1366 }
1367 }
1368
1369 /**
1370 * Kills all voices on an engine channel as soon as possible. Voices
1371 * won't get into release state, their volume level will be ramped down
1372 * as fast as possible.
1373 *
1374 * @param pEngineChannel - engine channel on which all voices should be killed
1375 * @param itKillEvent - event which caused this killing of all voices
1376 */
1377 void Engine::KillAllVoices(EngineChannel* pEngineChannel, Pool<Event>::Iterator& itKillEvent) {
1378 RTList<uint>::Iterator iuiKey = pEngineChannel->pActiveKeys->first();
1379 RTList<uint>::Iterator end = pEngineChannel->pActiveKeys->end();
1380 while (iuiKey != end) { // iterate through all active keys
1381 midi_key_info_t* pKey = &pEngineChannel->pMIDIKeyInfo[*iuiKey];
1382 ++iuiKey;
1383 RTList<Voice>::Iterator itVoice = pKey->pActiveVoices->first();
1384 RTList<Voice>::Iterator itVoicesEnd = pKey->pActiveVoices->end();
1385 for (; itVoice != itVoicesEnd; ++itVoice) { // iterate through all voices on this key
1386 itVoice->Kill(itKillEvent);
1387 --VoiceSpawnsLeft; //FIXME: just a temporary workaround, we should check the cause in StealVoice() instead
1388 }
1389 }
1390 }
1391
1392 /**
1393 * Initialize the parameter sequence for the modulation destination given by
1394 * by 'dst' with the constant value given by val.
1395 */
1396 void Engine::ResetSynthesisParameters(Event::destination_t dst, float val) {
1397 int maxsamples = pAudioOutputDevice->MaxSamplesPerCycle();
1398 float* m = &pSynthesisParameters[dst][0];
1399 for (int i = 0; i < maxsamples; i += 4) {
1400 m[i] = val;
1401 m[i+1] = val;
1402 m[i+2] = val;
1403 m[i+3] = val;
1404 }
1405 }
1406
1407 uint Engine::VoiceCount() {
1408 return ActiveVoiceCount;
1409 }
1410
1411 uint Engine::VoiceCountMax() {
1412 return ActiveVoiceCountMax;
1413 }
1414
1415 bool Engine::DiskStreamSupported() {
1416 return true;
1417 }
1418
1419 uint Engine::DiskStreamCount() {
1420 return (pDiskThread) ? pDiskThread->ActiveStreamCount : 0;
1421 }
1422
1423 uint Engine::DiskStreamCountMax() {
1424 return (pDiskThread) ? pDiskThread->ActiveStreamCountMax : 0;
1425 }
1426
1427 String Engine::DiskStreamBufferFillBytes() {
1428 return pDiskThread->GetBufferFillBytes();
1429 }
1430
1431 String Engine::DiskStreamBufferFillPercentage() {
1432 return pDiskThread->GetBufferFillPercentage();
1433 }
1434
1435 String Engine::EngineName() {
1436 return LS_GIG_ENGINE_NAME;
1437 }
1438
1439 String Engine::Description() {
1440 return "Gigasampler Engine";
1441 }
1442
1443 String Engine::Version() {
1444 String s = "$Revision: 1.51 $";
1445 return s.substr(11, s.size() - 13); // cut dollar signs, spaces and CVS macro keyword
1446 }
1447
1448 }} // namespace LinuxSampler::gig

  ViewVC Help
Powered by ViewVC