/[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 669 - (show annotations) (download)
Tue Jun 21 13:33:19 2005 UTC (15 years, 7 months ago) by schoenebeck
File size: 67476 byte(s)
* fixed minor issue with null/silence samples
  (those stole voices even though they don't need a voice at all which
  resulted in "voice stealing didn't work out" messages)

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

  ViewVC Help
Powered by ViewVC