--- linuxsampler/trunk/src/engines/gig/EngineChannel.cpp 2005/05/19 19:25:14 554 +++ linuxsampler/trunk/src/engines/gig/EngineChannel.cpp 2007/08/17 12:55:37 1298 @@ -3,7 +3,7 @@ * LinuxSampler - modular, streaming capable sampler * * * * Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck * - * Copyright (C) 2005 Christian Schoenebeck * + * Copyright (C) 2005 - 2007 Christian Schoenebeck * * * * This program is free software; you can redistribute it and/or modify * * it under the terms of the GNU General Public License as published by * @@ -30,8 +30,7 @@ pEngine = NULL; pInstrument = NULL; pEvents = NULL; // we allocate when we retrieve the right Engine object - pCCEvents = NULL; // we allocate when we retrieve the right Engine object - pEventQueue = new RingBuffer(CONFIG_MAX_EVENTS_PER_FRAGMENT, 0); + pEventQueue = new RingBuffer(CONFIG_MAX_EVENTS_PER_FRAGMENT, 0); pActiveKeys = new Pool(128); for (uint i = 0; i < 128; i++) { pMIDIKeyInfo[i].pActiveVoices = NULL; // we allocate when we retrieve the right Engine object @@ -42,13 +41,18 @@ pMIDIKeyInfo[i].VoiceTheftsQueued = 0; pMIDIKeyInfo[i].RoundRobinIndex = 0; } - for (uint i = 0; i < Event::destination_count; i++) { - pSynthesisEvents[i] = NULL; // we allocate when we retrieve the right Engine object - } InstrumentIdx = -1; InstrumentStat = -1; + pChannelLeft = NULL; + pChannelRight = NULL; AudioDeviceChannelLeft = -1; AudioDeviceChannelRight = -1; + pMidiInputPort = NULL; + midiChannel = midi_chan_all; + ResetControllers(); + SoloMode = false; + PortamentoMode = false; + PortamentoTime = CONFIG_PORTAMENTO_TIME_DEFAULT; } EngineChannel::~EngineChannel() { @@ -57,21 +61,47 @@ if (pEventQueue) delete pEventQueue; if (pActiveKeys) delete pActiveKeys; if (pMIDIKeyInfo) delete[] pMIDIKeyInfo; + RemoveAllFxSends(); + } + + /** + * Implementation of virtual method from abstract EngineChannel interface. + * This method will periodically be polled (e.g. by the LSCP server) to + * check if some engine channel parameter has changed since the last + * StatusChanged() call. + * + * This method can also be used to mark the engine channel as changed + * from outside, e.g. by a MIDI input device. The optional argument + * \a nNewStatus can be used for this. + * + * TODO: This "poll method" is just a lazy solution and might be + * replaced in future. + * @param bNewStatus - (optional, default: false) sets the new status flag + * @returns true if engine channel status has changed since last + * StatusChanged() call + */ + bool EngineChannel::StatusChanged(bool bNewStatus) { + bool b = bStatusChanged; + bStatusChanged = bNewStatus; + return b; + } + + void EngineChannel::Reset() { + if (pEngine) pEngine->DisableAndLock(); + ResetInternal(); + ResetControllers(); + if (pEngine) { + pEngine->Enable(); + pEngine->Reset(); + } } /** * This method is not thread safe! */ void EngineChannel::ResetInternal() { - Pitch = 0; - SustainPedal = false; - GlobalVolume = 1.0; - GlobalPanLeft = 1.0f; - GlobalPanRight = 1.0f; CurrentKeyDimension = 0; - ResetControllers(); - // reset key info for (uint i = 0; i < 128; i++) { if (pMIDIKeyInfo[i].pActiveVoices) @@ -84,6 +114,8 @@ pMIDIKeyInfo[i].itSelf = Pool::Iterator(); pMIDIKeyInfo[i].VoiceTheftsQueued = 0; } + SoloKey = -1; // no solo key active yet + PortamentoPos = -1.0f; // no portamento active yet // reset all key groups std::map::iterator iter = ActiveKeyGroups.begin(); @@ -96,6 +128,9 @@ pEventQueue->init(); if (pEngine) pEngine->ResetInternal(); + + // status of engine channel has changed, so set notify flag + bStatusChanged = true; } LinuxSampler::Engine* EngineChannel::GetEngine() { @@ -124,69 +159,67 @@ * This method will then actually start to load the instrument and block * the calling thread until loading was completed. * - * @returns detailed description of the method call result * @see PrepareLoadInstrument() */ void EngineChannel::LoadInstrument() { - - if (pEngine) pEngine->DisableAndLock(); - - ResetInternal(); + ::gig::Instrument* oldInstrument = pInstrument; // free old instrument - if (pInstrument) { - // give old instrument back to instrument manager - Engine::instruments.HandBack(pInstrument, this); + if (oldInstrument) { + if (pEngine) { + // make sure we don't trigger any new notes with the + // old instrument + ::gig::DimensionRegion** dimRegionsInUse = pEngine->ChangeInstrument(this, 0); + + // give old instrument back to instrument manager, but + // keep the dimension regions and samples that are in + // use + Engine::instruments.HandBackInstrument(oldInstrument, this, dimRegionsInUse); + } else { + Engine::instruments.HandBack(oldInstrument, this); + } } // delete all key groups ActiveKeyGroups.clear(); // request gig instrument from instrument manager + ::gig::Instrument* newInstrument; try { - instrument_id_t instrid; - instrid.FileName = InstrumentFile; - instrid.iInstrument = InstrumentIdx; - pInstrument = Engine::instruments.Borrow(instrid, this); - if (!pInstrument) { - InstrumentStat = -1; - dmsg(1,("no instrument loaded!!!\n")); - exit(EXIT_FAILURE); + InstrumentManager::instrument_id_t instrid; + instrid.FileName = InstrumentFile; + instrid.Index = InstrumentIdx; + newInstrument = Engine::instruments.Borrow(instrid, this); + if (!newInstrument) { + throw InstrumentManagerException("resource was not created"); } } catch (RIFF::Exception e) { InstrumentStat = -2; String msg = "gig::Engine error: Failed to load instrument, cause: " + e.Message; - throw LinuxSamplerException(msg); + throw Exception(msg); } - catch (InstrumentResourceManagerException e) { + catch (InstrumentManagerException e) { InstrumentStat = -3; String msg = "gig::Engine error: Failed to load instrument, cause: " + e.Message(); - throw LinuxSamplerException(msg); + throw Exception(msg); } catch (...) { InstrumentStat = -4; - throw LinuxSamplerException("gig::Engine error: Failed to load instrument, cause: Unknown exception while trying to parse gig file."); + throw Exception("gig::Engine error: Failed to load instrument, cause: Unknown exception while trying to parse gig file."); } // rebuild ActiveKeyGroups map with key groups of current instrument - for (::gig::Region* pRegion = pInstrument->GetFirstRegion(); pRegion; pRegion = pInstrument->GetNextRegion()) + for (::gig::Region* pRegion = newInstrument->GetFirstRegion(); pRegion; pRegion = newInstrument->GetNextRegion()) if (pRegion->KeyGroup) ActiveKeyGroups[pRegion->KeyGroup] = NULL; - InstrumentIdxName = pInstrument->pInfo->Name; + InstrumentIdxName = newInstrument->pInfo->Name; InstrumentStat = 100; - // inform audio driver for the need of two channels - try { - if (pEngine && pEngine->pAudioOutputDevice) - pEngine->pAudioOutputDevice->AcquireChannels(2); // gig Engine only stereo - } - catch (AudioOutputException e) { - String msg = "Audio output device unable to provide 2 audio channels, cause: " + e.Message(); - throw LinuxSamplerException(msg); - } - - if (pEngine) pEngine->Enable(); + if (pEngine) pEngine->ChangeInstrument(this, newInstrument); + else pInstrument = newInstrument; + + StatusChanged(true); } /** @@ -208,6 +241,7 @@ void EngineChannel::ResourceUpdated(::gig::Instrument* pOldResource, ::gig::Instrument* pNewResource, void* pUpdateArg) { this->pInstrument = pNewResource; //TODO: there are couple of engine parameters we should update here as well if the instrument was updated (see LoadInstrument()) if (pEngine) pEngine->Enable(); + bStatusChanged = true; // status of engine has changed, so set notify flag } /** @@ -219,6 +253,7 @@ void EngineChannel::OnResourceProgress(float fProgress) { this->InstrumentStat = int(fProgress * 100.0f); dmsg(7,("gig::EngineChannel: progress %d%", InstrumentStat)); + bStatusChanged = true; // status of engine has changed, so set notify flag } void EngineChannel::Connect(AudioOutputDevice* pAudioOut) { @@ -228,19 +263,25 @@ } pEngine = Engine::AcquireEngine(this, pAudioOut); ResetInternal(); - pEvents = new RTList(pEngine->pEventPool); - pCCEvents = new RTList(pEngine->pEventPool); - for (uint i = 0; i < Event::destination_count; i++) { - pSynthesisEvents[i] = new RTList(pEngine->pEventPool); - } + pEvents = new RTList(pEngine->pEventPool); for (uint i = 0; i < 128; i++) { pMIDIKeyInfo[i].pActiveVoices = new RTList(pEngine->pVoicePool); pMIDIKeyInfo[i].pEvents = new RTList(pEngine->pEventPool); } AudioDeviceChannelLeft = 0; AudioDeviceChannelRight = 1; - pOutputLeft = pAudioOut->Channel(0)->Buffer(); - pOutputRight = pAudioOut->Channel(1)->Buffer(); + if (fxSends.empty()) { // render directly into the AudioDevice's output buffers + pChannelLeft = pAudioOut->Channel(AudioDeviceChannelLeft); + pChannelRight = pAudioOut->Channel(AudioDeviceChannelRight); + } else { // use local buffers for rendering and copy later + // ensure the local buffers have the correct size + if (pChannelLeft) delete pChannelLeft; + if (pChannelRight) delete pChannelRight; + pChannelLeft = new AudioChannel(0, pAudioOut->MaxSamplesPerCycle()); + pChannelRight = new AudioChannel(1, pAudioOut->MaxSamplesPerCycle()); + } + if (pEngine->EngineDisabled.GetUnsafe()) pEngine->Enable(); + MidiInputPort::AddSysexListener(pEngine); } void EngineChannel::DisconnectAudioOutputDevice() { @@ -250,10 +291,6 @@ delete pEvents; pEvents = NULL; } - if (pCCEvents) { - delete pCCEvents; - pCCEvents = NULL; - } for (uint i = 0; i < 128; i++) { if (pMIDIKeyInfo[i].pActiveVoices) { delete pMIDIKeyInfo[i].pActiveVoices; @@ -264,21 +301,25 @@ pMIDIKeyInfo[i].pEvents = NULL; } } - for (uint i = 0; i < Event::destination_count; i++) { - if (pSynthesisEvents[i]) { - delete pSynthesisEvents[i]; - pSynthesisEvents[i] = NULL; - } - } Engine* oldEngine = pEngine; AudioOutputDevice* oldAudioDevice = pEngine->pAudioOutputDevice; pEngine = NULL; Engine::FreeEngine(this, oldAudioDevice); AudioDeviceChannelLeft = -1; AudioDeviceChannelRight = -1; + if (!fxSends.empty()) { // free the local rendering buffers + if (pChannelLeft) delete pChannelLeft; + if (pChannelRight) delete pChannelRight; + } + pChannelLeft = NULL; + pChannelRight = NULL; } } + AudioOutputDevice* EngineChannel::GetAudioOutputDevice() { + return (pEngine) ? pEngine->pAudioOutputDevice : NULL; + } + void EngineChannel::SetOutputChannel(uint EngineAudioChannel, uint AudioDeviceChannel) { if (!pEngine || !pEngine->pAudioOutputDevice) throw AudioOutputException("No audio output device connected yet."); @@ -286,16 +327,18 @@ if (!pChannel) throw AudioOutputException("Invalid audio output device channel " + ToString(AudioDeviceChannel)); switch (EngineAudioChannel) { case 0: // left output channel - pOutputLeft = pChannel->Buffer(); + if (fxSends.empty()) pChannelLeft = pChannel; AudioDeviceChannelLeft = AudioDeviceChannel; break; case 1: // right output channel - pOutputRight = pChannel->Buffer(); + if (fxSends.empty()) pChannelRight = pChannel; AudioDeviceChannelRight = AudioDeviceChannel; break; default: throw AudioOutputException("Invalid engine audio channel " + ToString(EngineAudioChannel)); } + + bStatusChanged = true; } int EngineChannel::OutputChannel(uint EngineAudioChannel) { @@ -309,9 +352,92 @@ } } + void EngineChannel::Connect(MidiInputPort* pMidiPort, midi_chan_t MidiChannel) { + if (!pMidiPort || pMidiPort == this->pMidiInputPort) return; + DisconnectMidiInputPort(); + this->pMidiInputPort = pMidiPort; + this->midiChannel = MidiChannel; + pMidiPort->Connect(this, MidiChannel); + } + + void EngineChannel::DisconnectMidiInputPort() { + MidiInputPort* pOldPort = this->pMidiInputPort; + this->pMidiInputPort = NULL; + if (pOldPort) pOldPort->Disconnect(this); + } + + MidiInputPort* EngineChannel::GetMidiInputPort() { + return pMidiInputPort; + } + + midi_chan_t EngineChannel::MidiChannel() { + return midiChannel; + } + + FxSend* EngineChannel::AddFxSend(uint8_t MidiCtrl, String Name) throw (Exception) { + if (pEngine) pEngine->DisableAndLock(); + FxSend* pFxSend = new FxSend(this, MidiCtrl, Name); + if (fxSends.empty()) { + if (pEngine && pEngine->pAudioOutputDevice) { + AudioOutputDevice* pDevice = pEngine->pAudioOutputDevice; + // create local render buffers + pChannelLeft = new AudioChannel(0, pDevice->MaxSamplesPerCycle()); + pChannelRight = new AudioChannel(1, pDevice->MaxSamplesPerCycle()); + } else { + // postpone local render buffer creation until audio device is assigned + pChannelLeft = NULL; + pChannelRight = NULL; + } + } + fxSends.push_back(pFxSend); + if (pEngine) pEngine->Enable(); + fireFxSendCountChanged(iSamplerChannelIndex, GetFxSendCount()); + + return pFxSend; + } + + FxSend* EngineChannel::GetFxSend(uint FxSendIndex) { + return (FxSendIndex < fxSends.size()) ? fxSends[FxSendIndex] : NULL; + } + + uint EngineChannel::GetFxSendCount() { + return fxSends.size(); + } + + void EngineChannel::RemoveFxSend(FxSend* pFxSend) { + if (pEngine) pEngine->DisableAndLock(); + for ( + std::vector::iterator iter = fxSends.begin(); + iter != fxSends.end(); iter++ + ) { + if (*iter == pFxSend) { + delete pFxSend; + fxSends.erase(iter); + if (fxSends.empty()) { + // destroy local render buffers + if (pChannelLeft) delete pChannelLeft; + if (pChannelRight) delete pChannelRight; + // fallback to render directly into AudioOutputDevice's buffers + if (pEngine && pEngine->pAudioOutputDevice) { + pChannelLeft = pEngine->pAudioOutputDevice->Channel(AudioDeviceChannelLeft); + pChannelRight = pEngine->pAudioOutputDevice->Channel(AudioDeviceChannelRight); + } else { // we update the pointers later + pChannelLeft = NULL; + pChannelRight = NULL; + } + } + break; + } + } + if (pEngine) pEngine->Enable(); + fireFxSendCountChanged(iSamplerChannelIndex, GetFxSendCount()); + } + /** * Will be called by the MIDIIn Thread to let the audio thread trigger a new - * voice for the given key. + * voice for the given key. This method is meant for real time rendering, + * that is an event will immediately be created with the current system + * time as time stamp. * * @param Key - MIDI key number of the triggered key * @param Velocity - MIDI velocity value of the triggered key @@ -329,8 +455,36 @@ } /** + * Will be called by the MIDIIn Thread to let the audio thread trigger a new + * voice for the given key. This method is meant for offline rendering + * and / or for cases where the exact position of the event in the current + * audio fragment is already known. + * + * @param Key - MIDI key number of the triggered key + * @param Velocity - MIDI velocity value of the triggered key + * @param FragmentPos - sample point position in the current audio + * fragment to which this event belongs to + */ + void EngineChannel::SendNoteOn(uint8_t Key, uint8_t Velocity, int32_t FragmentPos) { + if (FragmentPos < 0) { + dmsg(1,("EngineChannel::SendNoteOn(): negative FragmentPos! Seems MIDI driver is buggy!")); + } + else if (pEngine) { + Event event = pEngine->pEventGenerator->CreateEvent(FragmentPos); + event.Type = Event::type_note_on; + event.Param.Note.Key = Key; + event.Param.Note.Velocity = Velocity; + event.pEngineChannel = this; + if (this->pEventQueue->write_space() > 0) this->pEventQueue->push(&event); + else dmsg(1,("EngineChannel: Input event queue full!")); + } + } + + /** * Will be called by the MIDIIn Thread to signal the audio thread to release - * voice(s) on the given key. + * voice(s) on the given key. This method is meant for real time rendering, + * that is an event will immediately be created with the current system + * time as time stamp. * * @param Key - MIDI key number of the released key * @param Velocity - MIDI release velocity value of the released key @@ -348,8 +502,36 @@ } /** + * Will be called by the MIDIIn Thread to signal the audio thread to release + * voice(s) on the given key. This method is meant for offline rendering + * and / or for cases where the exact position of the event in the current + * audio fragment is already known. + * + * @param Key - MIDI key number of the released key + * @param Velocity - MIDI release velocity value of the released key + * @param FragmentPos - sample point position in the current audio + * fragment to which this event belongs to + */ + void EngineChannel::SendNoteOff(uint8_t Key, uint8_t Velocity, int32_t FragmentPos) { + if (FragmentPos < 0) { + dmsg(1,("EngineChannel::SendNoteOff(): negative FragmentPos! Seems MIDI driver is buggy!")); + } + else if (pEngine) { + Event event = pEngine->pEventGenerator->CreateEvent(FragmentPos); + event.Type = Event::type_note_off; + event.Param.Note.Key = Key; + event.Param.Note.Velocity = Velocity; + event.pEngineChannel = this; + if (this->pEventQueue->write_space() > 0) this->pEventQueue->push(&event); + else dmsg(1,("EngineChannel: Input event queue full!")); + } + } + + /** * Will be called by the MIDIIn Thread to signal the audio thread to change - * the pitch value for all voices. + * the pitch value for all voices. This method is meant for real time + * rendering, that is an event will immediately be created with the + * current system time as time stamp. * * @param Pitch - MIDI pitch value (-8192 ... +8191) */ @@ -365,8 +547,34 @@ } /** + * Will be called by the MIDIIn Thread to signal the audio thread to change + * the pitch value for all voices. This method is meant for offline + * rendering and / or for cases where the exact position of the event in + * the current audio fragment is already known. + * + * @param Pitch - MIDI pitch value (-8192 ... +8191) + * @param FragmentPos - sample point position in the current audio + * fragment to which this event belongs to + */ + void EngineChannel::SendPitchbend(int Pitch, int32_t FragmentPos) { + if (FragmentPos < 0) { + dmsg(1,("EngineChannel::SendPitchBend(): negative FragmentPos! Seems MIDI driver is buggy!")); + } + else if (pEngine) { + Event event = pEngine->pEventGenerator->CreateEvent(FragmentPos); + event.Type = Event::type_pitchbend; + event.Param.Pitch.Pitch = Pitch; + event.pEngineChannel = this; + if (this->pEventQueue->write_space() > 0) this->pEventQueue->push(&event); + else dmsg(1,("EngineChannel: Input event queue full!")); + } + } + + /** * Will be called by the MIDIIn Thread to signal the audio thread that a - * continuous controller value has changed. + * continuous controller value has changed. This method is meant for real + * time rendering, that is an event will immediately be created with the + * current system time as time stamp. * * @param Controller - MIDI controller number of the occured control change * @param Value - value of the control change @@ -383,12 +591,34 @@ } } + /** + * Will be called by the MIDIIn Thread to signal the audio thread that a + * continuous controller value has changed. This method is meant for + * offline rendering and / or for cases where the exact position of the + * event in the current audio fragment is already known. + * + * @param Controller - MIDI controller number of the occured control change + * @param Value - value of the control change + * @param FragmentPos - sample point position in the current audio + * fragment to which this event belongs to + */ + void EngineChannel::SendControlChange(uint8_t Controller, uint8_t Value, int32_t FragmentPos) { + if (FragmentPos < 0) { + dmsg(1,("EngineChannel::SendControlChange(): negative FragmentPos! Seems MIDI driver is buggy!")); + } + else if (pEngine) { + Event event = pEngine->pEventGenerator->CreateEvent(FragmentPos); + event.Type = Event::type_control_change; + event.Param.CC.Controller = Controller; + event.Param.CC.Value = Value; + event.pEngineChannel = this; + if (this->pEventQueue->write_space() > 0) this->pEventQueue->push(&event); + else dmsg(1,("EngineChannel: Input event queue full!")); + } + } + void EngineChannel::ClearEventLists() { pEvents->clear(); - pCCEvents->clear(); - for (uint i = 0; i < Event::destination_count; i++) { - pSynthesisEvents[i]->clear(); - } // empty MIDI key specific event lists { RTList::Iterator iuiKey = pActiveKeys->first(); @@ -400,8 +630,23 @@ } void EngineChannel::ResetControllers() { + Pitch = 0; + SustainPedal = false; + SostenutoPedal = false; + GlobalVolume = 1.0f; + MidiVolume = 1.0; + GlobalPanLeft = 1.0f; + GlobalPanRight = 1.0f; + GlobalTranspose = 0; // set all MIDI controller values to zero - memset(ControllerTable, 0x00, 128); + memset(ControllerTable, 0x00, 129); + // reset all FX Send levels + for ( + std::vector::iterator iter = fxSends.begin(); + iter != fxSends.end(); iter++ + ) { + (*iter)->Reset(); + } } /** @@ -418,7 +663,7 @@ * current audio cycle */ void EngineChannel::ImportEvents(uint Samples) { - RingBuffer::NonVolatileReader eventQueueReader = pEventQueue->get_non_volatile_reader(); + RingBuffer::NonVolatileReader eventQueueReader = pEventQueue->get_non_volatile_reader(); Event* pEvent; while (true) { // get next event from input event queue @@ -440,12 +685,36 @@ eventQueueReader.free(); // free all copied events from input queue } + void EngineChannel::RemoveAllFxSends() { + if (pEngine) pEngine->DisableAndLock(); + if (!fxSends.empty()) { // free local render buffers + if (pChannelLeft) { + delete pChannelLeft; + if (pEngine && pEngine->pAudioOutputDevice) { + // fallback to render directly to the AudioOutputDevice's buffer + pChannelLeft = pEngine->pAudioOutputDevice->Channel(AudioDeviceChannelLeft); + } else pChannelLeft = NULL; + } + if (pChannelRight) { + delete pChannelRight; + if (pEngine && pEngine->pAudioOutputDevice) { + // fallback to render directly to the AudioOutputDevice's buffer + pChannelRight = pEngine->pAudioOutputDevice->Channel(AudioDeviceChannelRight); + } else pChannelRight = NULL; + } + } + for (int i = 0; i < fxSends.size(); i++) delete fxSends[i]; + fxSends.clear(); + if (pEngine) pEngine->Enable(); + } + float EngineChannel::Volume() { return GlobalVolume; } void EngineChannel::Volume(float f) { GlobalVolume = f; + bStatusChanged = true; // status of engine channel has changed, so set notify flag } uint EngineChannel::Channels() { @@ -471,5 +740,5 @@ String EngineChannel::EngineName() { return LS_GIG_ENGINE_NAME; } - + }} // namespace LinuxSampler::gig