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

Diff of /linuxsampler/trunk/src/engines/EngineChannelBase.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 2352 by persson, Sun Jun 24 16:11:31 2012 UTC revision 2927 by schoenebeck, Thu Jun 30 16:44:46 2016 UTC
# Line 5  Line 5 
5   *   Copyright (C) 2003,2004 by Benno Senoner and Christian Schoenebeck    *   *   Copyright (C) 2003,2004 by Benno Senoner and Christian Schoenebeck    *
6   *   Copyright (C) 2005-2008 Christian Schoenebeck                         *   *   Copyright (C) 2005-2008 Christian Schoenebeck                         *
7   *   Copyright (C) 2009-2012 Christian Schoenebeck and Grigor Iliev        *   *   Copyright (C) 2009-2012 Christian Schoenebeck and Grigor Iliev        *
8     *   Copyright (C) 2012-2016 Christian Schoenebeck and Andreas Persson     *
9   *                                                                         *   *                                                                         *
10   *   This program is free software; you can redistribute it and/or modify  *   *   This program is free software; you can redistribute it and/or modify  *
11   *   it under the terms of the GNU General Public License as published by  *   *   it under the terms of the GNU General Public License as published by  *
# Line 39  namespace LinuxSampler { Line 40  namespace LinuxSampler {
40              bool bChangeInstrument;       ///< Set to true by the loader when the channel should change instrument.              bool bChangeInstrument;       ///< Set to true by the loader when the channel should change instrument.
41              I* pInstrument;               ///< The new instrument. Also used by the loader to read the previously loaded instrument.              I* pInstrument;               ///< The new instrument. Also used by the loader to read the previously loaded instrument.
42              RTList<R*>* pRegionsInUse; ///< List of dimension regions in use by the currently loaded instrument. Continuously updated by the audio thread.              RTList<R*>* pRegionsInUse; ///< List of dimension regions in use by the currently loaded instrument. Continuously updated by the audio thread.
43                InstrumentScript* pScript; ///< Instrument script to be executed for this instrument. This is never NULL, it is always a valid InstrumentScript pointer. Use InstrumentScript::bHasValidScript whether it reflects a valid instrument script to be executed.
44      };      };
45    
46      template<class R>      template<class R>
# Line 48  namespace LinuxSampler { Line 50  namespace LinuxSampler {
50      };      };
51    
52      template<class V>      template<class V>
53      class VoicePool {      class NotePool {
54          public:          public:
55              virtual Pool<V>* GetVoicePool() = 0;              virtual Pool<V>* GetVoicePool() = 0;
56                virtual Pool< Note<V> >* GetNotePool() = 0;
57                virtual Pool<note_id_t>* GetNodeIDPool() = 0;
58      };      };
59    
60      template <class V /* Voice */, class R /* Region */, class I /* Instrument */>      template <class V /* Voice */, class R /* Region */, class I /* Instrument */>
61      class EngineChannelBase: public AbstractEngineChannel, public MidiKeyboardManager<V>, public ResourceConsumer<I> {      class EngineChannelBase: public AbstractEngineChannel, public MidiKeyboardManager<V>, public ResourceConsumer<I> {
62          public:          public:
63                typedef typename RTList< Note<V> >::Iterator NoteIterator;
64              typedef typename RTList<R*>::Iterator RTListRegionIterator;              typedef typename RTList<R*>::Iterator RTListRegionIterator;
65              typedef typename MidiKeyboardManager<V>::MidiKey MidiKey;              typedef typename MidiKeyboardManager<V>::MidiKey MidiKey;
66    
67                virtual MidiKeyboardManagerBase* GetMidiKeyboardManager() OVERRIDE {
68                    return this;
69                }
70    
71              virtual void HandBack(I* Instrument) {              virtual void HandBack(I* Instrument) {
72                  ResourceManager<InstrumentManager::instrument_id_t, I>* mgr =                  ResourceManager<InstrumentManager::instrument_id_t, I>* mgr =
73                      dynamic_cast<ResourceManager<InstrumentManager::instrument_id_t, I>*>(pEngine->GetInstrumentManager());                      dynamic_cast<ResourceManager<InstrumentManager::instrument_id_t, I>*>(pEngine->GetInstrumentManager());
# Line 84  namespace LinuxSampler { Line 93  namespace LinuxSampler {
93              }              }
94    
95              virtual void DeleteRegionsInUse() {              virtual void DeleteRegionsInUse() {
96                    RTList<R*>* previous = NULL; // prevent double free
97                  {                  {
98                      InstrumentChangeCmd<R, I>& cmd = InstrumentChangeCommand.GetConfigForUpdate();                      InstrumentChangeCmd<R, I>& cmd = InstrumentChangeCommand.GetConfigForUpdate();
99                      if (cmd.pRegionsInUse) {                      if (cmd.pRegionsInUse) {
100                            previous = cmd.pRegionsInUse;
101                          delete cmd.pRegionsInUse;                          delete cmd.pRegionsInUse;
102                          cmd.pRegionsInUse = NULL;                          cmd.pRegionsInUse = NULL;
103                      }                      }
# Line 95  namespace LinuxSampler { Line 106  namespace LinuxSampler {
106                  {                  {
107                      InstrumentChangeCmd<R, I>& cmd = InstrumentChangeCommand.SwitchConfig();                      InstrumentChangeCmd<R, I>& cmd = InstrumentChangeCommand.SwitchConfig();
108                      if (cmd.pRegionsInUse) {                      if (cmd.pRegionsInUse) {
109                          delete cmd.pRegionsInUse;                          if (cmd.pRegionsInUse != previous)
110                                delete cmd.pRegionsInUse;
111                          cmd.pRegionsInUse = NULL;                          cmd.pRegionsInUse = NULL;
112                      }                      }
113                      cmd.bChangeInstrument = false;                      cmd.bChangeInstrument = false;
# Line 121  namespace LinuxSampler { Line 133  namespace LinuxSampler {
133                      DisconnectAudioOutputDevice();                      DisconnectAudioOutputDevice();
134                  }                  }
135                  AbstractEngine* newEngine = AbstractEngine::AcquireEngine(this, pAudioOut);                  AbstractEngine* newEngine = AbstractEngine::AcquireEngine(this, pAudioOut);
136                  EngineMutex.Lock();                  {
137                  pEngine = newEngine;                      LockGuard lock(EngineMutex);
138                  EngineMutex.Unlock();                      pEngine = newEngine;
139                  ResetInternal();                  }
140                    ResetInternal(false/*don't reset engine*/); // 'false' is error prone here, but the danger of recursion with 'true' would be worse, there could be a better solution though
141                  pEvents = new RTList<Event>(pEngine->pEventPool);                  pEvents = new RTList<Event>(pEngine->pEventPool);
142                    delayedEvents.pList = new RTList<Event>(pEngine->pEventPool);
143    
144                  RegionPools<R>* pRegionPool = dynamic_cast<RegionPools<R>*>(pEngine);                  RegionPools<R>* pRegionPool = dynamic_cast<RegionPools<R>*>(pEngine);
145                  // reset the instrument change command struct (need to be done                  // reset the instrument change command struct (need to be done
# Line 152  namespace LinuxSampler { Line 166  namespace LinuxSampler {
166                      bStatusChanged = true;                      bStatusChanged = true;
167                  }                  }
168    
169                  VoicePool<V>* pVoicePool = dynamic_cast<VoicePool<V>*>(pEngine);                  NotePool<V>* pNotePool = dynamic_cast<NotePool<V>*>(pEngine);
170                  MidiKeyboardManager<V>::AllocateActiveVoices(pVoicePool->GetVoicePool());                  MidiKeyboardManager<V>::AllocateActiveNotesLists(
171                  MidiKeyboardManager<V>::AllocateEvents(pEngine->pEventPool);                      pNotePool->GetNotePool(),
172                        pNotePool->GetVoicePool()
173                    );
174                    MidiKeyboardManager<V>::AllocateEventsLists(pEngine->pEventPool);
175    
176                  AudioDeviceChannelLeft  = 0;                  AudioDeviceChannelLeft  = 0;
177                  AudioDeviceChannelRight = 1;                  AudioDeviceChannelRight = 1;
# Line 175  namespace LinuxSampler { Line 192  namespace LinuxSampler {
192              virtual void DisconnectAudioOutputDevice() {              virtual void DisconnectAudioOutputDevice() {
193                  if (pEngine) { // if clause to prevent disconnect loops                  if (pEngine) { // if clause to prevent disconnect loops
194    
195                      ResetInternal();                      ResetInternal(false/*don't reset engine*/); // 'false' is error prone here, but the danger of recursion with 'true' would be worse, there could be a better solution though
196    
197                      DeleteRegionsInUse();                      DeleteRegionsInUse();
198                        UnloadScriptInUse();
199    
200                      InstrumentChangeCmd<R, I>& cmd = InstrumentChangeCommand.GetConfigForUpdate();                      InstrumentChangeCmd<R, I>& cmd = InstrumentChangeCommand.GetConfigForUpdate();
201                      if (cmd.pInstrument) {                      if (cmd.pInstrument) {
# Line 189  namespace LinuxSampler { Line 207  namespace LinuxSampler {
207                          delete pEvents;                          delete pEvents;
208                          pEvents = NULL;                          pEvents = NULL;
209                      }                      }
210                        if (delayedEvents.pList) {
211                            delete delayedEvents.pList;
212                            delayedEvents.pList = NULL;
213                        }
214    
215                      MidiKeyboardManager<V>::DeleteActiveVoices();                      MidiKeyboardManager<V>::DeleteActiveNotesLists();
216                      MidiKeyboardManager<V>::DeleteEvents();                      MidiKeyboardManager<V>::DeleteEventsLists();
217                      DeleteGroupEventLists();                      DeleteGroupEventLists();
218    
219                      AudioOutputDevice* oldAudioDevice = pEngine->pAudioOutputDevice;                      AudioOutputDevice* oldAudioDevice = pEngine->pAudioOutputDevice;
220                      EngineMutex.Lock();                      {
221                      pEngine = NULL;                          LockGuard lock(EngineMutex);
222                      EngineMutex.Unlock();                          pEngine = NULL;
223                        }
224                      AbstractEngine::FreeEngine(this, oldAudioDevice);                      AbstractEngine::FreeEngine(this, oldAudioDevice);
225                      AudioDeviceChannelLeft  = -1;                      AudioDeviceChannelLeft  = -1;
226                      AudioDeviceChannelRight = -1;                      AudioDeviceChannelRight = -1;
# Line 215  namespace LinuxSampler { Line 238  namespace LinuxSampler {
238                      virtual bool Process(MidiKey* pMidiKey) { pMidiKey->pEvents->clear(); return false; }                      virtual bool Process(MidiKey* pMidiKey) { pMidiKey->pEvents->clear(); return false; }
239              };              };
240    
241              void ClearEventLists() {              /**
242                 * Free all events of the current audio fragment cycle. Calling
243                 * this method will @b NOT free events scheduled past the current
244                 * fragment's boundary! (@see AbstractEngineChannel::delayedEvents).
245                 */
246                void ClearEventListsOfCurrentFragment() {
247                  pEvents->clear();                  pEvents->clear();
248                  // empty MIDI key specific event lists                  // empty MIDI key specific event lists
249                  ClearEventListsHandler handler;                  ClearEventListsHandler handler;
# Line 235  namespace LinuxSampler { Line 263  namespace LinuxSampler {
263               * we are currently using on this EngineChannel is going to be updated,               * we are currently using on this EngineChannel is going to be updated,
264               * so we can stop playback before that happens.               * so we can stop playback before that happens.
265               */               */
266              virtual void ResourceToBeUpdated(I* pResource, void*& pUpdateArg) {              virtual void ResourceToBeUpdated(I* pResource, void*& pUpdateArg) OVERRIDE {
267                  dmsg(3,("EngineChannelBase: Received instrument update message.\n"));                  dmsg(3,("EngineChannelBase: Received instrument update message.\n"));
268                  if (pEngine) pEngine->DisableAndLock();                  if (pEngine) pEngine->DisableAndLock();
269                  ResetInternal();                  ResetInternal(false/*don't reset engine*/);
270                  this->pInstrument = NULL;                  this->pInstrument = NULL;
271              }              }
272    
# Line 246  namespace LinuxSampler { Line 274  namespace LinuxSampler {
274               * Will be called by the InstrumentResourceManager when the instrument               * Will be called by the InstrumentResourceManager when the instrument
275               * update process was completed, so we can continue with playback.               * update process was completed, so we can continue with playback.
276               */               */
277              virtual void ResourceUpdated(I* pOldResource, I* pNewResource, void* pUpdateArg) {              virtual void ResourceUpdated(I* pOldResource, I* pNewResource, void* pUpdateArg) OVERRIDE {
278                  this->pInstrument = pNewResource; //TODO: there are couple of engine parameters we should update here as well if the instrument was updated (see LoadInstrument())                  this->pInstrument = pNewResource; //TODO: there are couple of engine parameters we should update here as well if the instrument was updated (see LoadInstrument())
279                  if (pEngine) pEngine->Enable();                  if (pEngine) pEngine->Enable();
280                  bStatusChanged = true; // status of engine has changed, so set notify flag                  bStatusChanged = true; // status of engine has changed, so set notify flag
# Line 258  namespace LinuxSampler { Line 286  namespace LinuxSampler {
286               *               *
287               * @param fProgress - current progress as value between 0.0 and 1.0               * @param fProgress - current progress as value between 0.0 and 1.0
288               */               */
289              virtual void OnResourceProgress(float fProgress) {              virtual void OnResourceProgress(float fProgress) OVERRIDE {
290                  this->InstrumentStat = int(fProgress * 100.0f);                  this->InstrumentStat = int(fProgress * 100.0f);
291                  dmsg(7,("EngineChannelBase: progress %d%", InstrumentStat));                  dmsg(7,("EngineChannelBase: progress %d%%", InstrumentStat));
292                  bStatusChanged = true; // status of engine has changed, so set notify flag                  bStatusChanged = true; // status of engine has changed, so set notify flag
293              }              }
294    
295                /**
296                 * Called on sustain pedal up events to check and if required,
297                 * launch release trigger voices on the respective active key.
298                 *
299                 * @param pEngineChannel - engine channel on which this event occurred on
300                 * @param itEvent - release trigger event (contains note number)
301                 */
302                virtual void ProcessReleaseTrigger(RTList<Event>::Iterator& itEvent) OVERRIDE {
303                    if (!pEngine) return;
304                    pEngine->ProcessReleaseTrigger(this, itEvent);
305                }
306    
307              void RenderActiveVoices(uint Samples) {              void RenderActiveVoices(uint Samples) {
308                  RenderVoicesHandler handler(this, Samples);                  RenderVoicesHandler handler(this, Samples);
309                  this->ProcessActiveVoices(&handler);                  this->ProcessActiveVoices(&handler);
# Line 272  namespace LinuxSampler { Line 312  namespace LinuxSampler {
312                  SetDiskStreamCount(handler.StreamCount);                  SetDiskStreamCount(handler.StreamCount);
313              }              }
314    
315                /**
316                 * Called by real-time instrument script functions to schedule a
317                 * new note (new note-on event and a new @c Note object linked to it)
318                 * @a delay microseconds in future.
319                 *
320                 * @b IMPORTANT: for the supplied @a delay to be scheduled
321                 * correctly, the passed @a pEvent must be assigned a valid
322                 * fragment time within the current audio fragment boundaries. That
323                 * fragment time will be used by this method as basis for
324                 * interpreting what "now" acutally is, and thus it will be used as
325                 * basis for calculating the precise scheduling time for @a delay.
326                 * The easiest way to achieve this is by copying a recent event
327                 * which happened within the current audio fragment cycle: i.e. the
328                 * original event which caused calling this method here, or by using
329                 * Event::copyTimefrom() method to only copy the time, without any
330                 * other event data.
331                 *
332                 * @param pEvent - note-on event to be scheduled in future (event
333                 *                 data will be copied)
334                 * @param delay - amount of microseconds in future (from now) when
335                 *                event shall be processed
336                 * @returns unique note ID of scheduled new note, or NULL on error
337                 */
338                note_id_t ScheduleNoteMicroSec(const Event* pEvent, int delay) OVERRIDE {
339                    // add (copied) note-on event into scheduler queue
340                    const event_id_t noteOnEventID = ScheduleEventMicroSec(pEvent, delay);
341                    if (!noteOnEventID) return 0; // error
342                    // get access to (copied) event on the scheduler queue
343                    RTList<Event>::Iterator itEvent = pEvents->fromID(noteOnEventID);
344                    // stick a new note to the (copied) event on the queue
345                    const note_id_t noteID = pEngine->LaunchNewNote(this, &*itEvent);
346                    return noteID;
347                }
348    
349                /**
350                 * Called by real-time instrument script functions to ignore the note
351                 * reflected by given note ID. The note's event will be freed immediately
352                 * to its event pool and this will prevent voices to be launched for the
353                 * note.
354                 *
355                 * NOTE: preventing a note by calling this method works only if the note
356                 * was launched within the current audio fragment cycle.
357                 *
358                 * @param id - unique ID of note to be dropped
359                 */
360                void IgnoreNote(note_id_t id) OVERRIDE {
361                    Pool< Note<V> >* pNotePool =
362                        dynamic_cast<NotePool<V>*>(pEngine)->GetNotePool();
363    
364                    NoteIterator itNote = pNotePool->fromID(id);
365                    if (!itNote) return; // note probably already released
366    
367                    // if the note already got active voices, then it is too late to drop it
368                    if (!itNote->pActiveVoices->isEmpty()) return;
369    
370                    // if the original (note-on) event is not available anymore, then it is too late to drop it
371                    RTList<Event>::Iterator itEvent = pEvents->fromID(itNote->eventID);
372                    if (!itEvent) return;
373    
374                    // drop the note
375                    pNotePool->free(itNote);
376    
377                    // drop the original event
378                    pEvents->free(itEvent);
379                }
380    
381              RTList<R*>* pRegionsInUse;     ///< temporary pointer into the instrument change command, used by the audio thread              RTList<R*>* pRegionsInUse;     ///< temporary pointer into the instrument change command, used by the audio thread
382              I* pInstrument;              I* pInstrument;
383    
384              template<class TV, class TRR, class TR, class TD, class TIM, class TI> friend class EngineBase;              template<class TV, class TRR, class TR, class TD, class TIM, class TI> friend class EngineBase;
385    
386          protected:          protected:
387              EngineChannelBase() : InstrumentChangeCommandReader(InstrumentChangeCommand) {              EngineChannelBase() :
388                    MidiKeyboardManager<V>(this),
389                    InstrumentChangeCommandReader(InstrumentChangeCommand)
390                {
391                  pInstrument = NULL;                  pInstrument = NULL;
392    
393                  // reset the instrument change command struct (need to be done                  // reset the instrument change command struct (need to be done
# Line 287  namespace LinuxSampler { Line 396  namespace LinuxSampler {
396                      InstrumentChangeCmd<R, I>& cmd = InstrumentChangeCommand.GetConfigForUpdate();                      InstrumentChangeCmd<R, I>& cmd = InstrumentChangeCommand.GetConfigForUpdate();
397                      cmd.pRegionsInUse = NULL;                      cmd.pRegionsInUse = NULL;
398                      cmd.pInstrument = NULL;                      cmd.pInstrument = NULL;
399                        cmd.pScript = new InstrumentScript(this);
400                      cmd.bChangeInstrument = false;                      cmd.bChangeInstrument = false;
401                  }                  }
402                  {                  {
403                      InstrumentChangeCmd<R, I>& cmd = InstrumentChangeCommand.SwitchConfig();                      InstrumentChangeCmd<R, I>& cmd = InstrumentChangeCommand.SwitchConfig();
404                      cmd.pRegionsInUse = NULL;                      cmd.pRegionsInUse = NULL;
405                      cmd.pInstrument = NULL;                      cmd.pInstrument = NULL;
406                        cmd.pScript = new InstrumentScript(this);
407                      cmd.bChangeInstrument = false;                      cmd.bChangeInstrument = false;
408                  }                  }
409              }              }
410    
411              virtual ~EngineChannelBase() { }              virtual ~EngineChannelBase() {
412                    InstrumentScript* previous = NULL; // prevent double free
413                    {
414                        InstrumentChangeCmd<R, I>& cmd = InstrumentChangeCommand.GetConfigForUpdate();
415                        if (cmd.pScript) {
416                            previous = cmd.pScript;
417                            delete cmd.pScript;
418                            cmd.pScript = NULL;
419                        }
420                    }
421                    {
422                        InstrumentChangeCmd<R, I>& cmd = InstrumentChangeCommand.SwitchConfig();
423                        if (cmd.pScript) {
424                            if (previous != cmd.pScript)
425                                delete cmd.pScript;
426                            cmd.pScript = NULL;
427                        }
428                    }
429                }
430    
431              typedef typename RTList<V>::Iterator RTListVoiceIterator;              typedef typename RTList<V>::Iterator RTListVoiceIterator;
432    
# Line 336  namespace LinuxSampler { Line 465  namespace LinuxSampler {
465              SyncConfInstrChangeCmdReader InstrumentChangeCommandReader;              SyncConfInstrChangeCmdReader InstrumentChangeCommandReader;
466    
467              /** This method is not thread safe! */              /** This method is not thread safe! */
468              virtual void ResetInternal() {              virtual void ResetInternal(bool bResetEngine) OVERRIDE {
469                  AbstractEngineChannel::ResetInternal();                  AbstractEngineChannel::ResetInternal(bResetEngine);
470    
471                  MidiKeyboardManager<V>::Reset();                  MidiKeyboardManager<V>::Reset();
472              }              }
# Line 350  namespace LinuxSampler { Line 479  namespace LinuxSampler {
479              }              }
480    
481              /**              /**
482                 * Unload the currently used and loaded real-time instrument script.
483                 * The source code of the script is retained, so that it can still
484                 * be reloaded.
485                 */
486                void UnloadScriptInUse() {
487                    {
488                        InstrumentChangeCmd<R, I>& cmd = InstrumentChangeCommand.GetConfigForUpdate();
489                        if (cmd.pScript) cmd.pScript->unload();
490                    }
491                    {
492                        InstrumentChangeCmd<R, I>& cmd = InstrumentChangeCommand.SwitchConfig();
493                        if (cmd.pScript) cmd.pScript->unload();
494                    }
495                    InstrumentChangeCommand.SwitchConfig(); // switch back to original one
496                }
497    
498                /**
499                 * Load real-time instrument script and all its resources required
500                 * for the upcoming instrument change.
501                 *
502                 * @param text - source code of script
503                 */
504                void LoadInstrumentScript(const String& text) {
505                    InstrumentChangeCmd<R, I>& cmd = InstrumentChangeCommand.GetConfigForUpdate();
506                    // load the new script
507                    cmd.pScript->load(text);
508                }
509    
510                /**
511               * Changes the instrument for an engine channel.               * Changes the instrument for an engine channel.
512               *               *
513               * @param pInstrument - new instrument               * @param pInstrument - new instrument
Legend:
Removed from v.2352  
changed lines
  Added in v.2927
  ViewVC Help
Powered by ViewVC