engines/gig/EngineChannel.cpp

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
 *   Copyright (C) 2005, 2006 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  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the Free Software           *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 ***************************************************************************/

#include "EngineChannel.h"

namespace LinuxSampler { namespace gig {

    EngineChannel::EngineChannel() {
        pMIDIKeyInfo = new midi_key_info_t[128];
        pEngine      = NULL;
        pInstrument  = NULL;
        pEvents      = NULL; // we allocate when we retrieve the right Engine object
        pEventQueue  = new RingBuffer<Event>(CONFIG_MAX_EVENTS_PER_FRAGMENT, 0);
        pActiveKeys  = new Pool<uint>(128);
        for (uint i = 0; i < 128; i++) {
            pMIDIKeyInfo[i].pActiveVoices  = NULL; // we allocate when we retrieve the right Engine object
            pMIDIKeyInfo[i].KeyPressed     = false;
            pMIDIKeyInfo[i].Active         = false;
            pMIDIKeyInfo[i].ReleaseTrigger = false;
            pMIDIKeyInfo[i].pEvents        = NULL; // we allocate when we retrieve the right Engine object
            pMIDIKeyInfo[i].VoiceTheftsQueued = 0;
            pMIDIKeyInfo[i].RoundRobinIndex = 0;
        }
        InstrumentIdx  = -1;
        InstrumentStat = -1;
        AudioDeviceChannelLeft  = -1;
        AudioDeviceChannelRight = -1;
        pMidiInputPort = NULL;
        midiChannel = midi_chan_all;
        ResetControllers();
        SoloMode       = false;
        PortamentoMode = false;
        PortamentoTime = CONFIG_PORTAMENTO_TIME_DEFAULT;
    }

    EngineChannel::~EngineChannel() {
        DisconnectAudioOutputDevice();
        if (pInstrument) Engine::instruments.HandBack(pInstrument, this);
        if (pEventQueue) delete pEventQueue;
        if (pActiveKeys) delete pActiveKeys;
        if (pMIDIKeyInfo) delete[] pMIDIKeyInfo;
    }

    /**
     * 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() {
        CurrentKeyDimension = 0;

        // reset key info
        for (uint i = 0; i < 128; i++) {
            if (pMIDIKeyInfo[i].pActiveVoices)
                pMIDIKeyInfo[i].pActiveVoices->clear();
            if (pMIDIKeyInfo[i].pEvents)
                pMIDIKeyInfo[i].pEvents->clear();
            pMIDIKeyInfo[i].KeyPressed     = false;
            pMIDIKeyInfo[i].Active         = false;
            pMIDIKeyInfo[i].ReleaseTrigger = false;
            pMIDIKeyInfo[i].itSelf         = Pool<uint>::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<uint,uint*>::iterator iter = ActiveKeyGroups.begin();
        for (; iter != ActiveKeyGroups.end(); iter++) iter->second = NULL;

        // free all active keys
        pActiveKeys->clear();

        // delete all input events
        pEventQueue->init();

        if (pEngine) pEngine->ResetInternal();

        // status of engine channel has changed, so set notify flag
        bStatusChanged = true;
    }

    LinuxSampler::Engine* EngineChannel::GetEngine() {
        return pEngine;
    }

    /**
     * More or less a workaround to set the instrument name, index and load
     * status variable to zero percent immediately, that is without blocking
     * the calling thread. It might be used in future for other preparations
     * as well though.
     *
     * @param FileName   - file name of the Gigasampler instrument file
     * @param Instrument - index of the instrument in the .gig file
     * @see LoadInstrument()
     */
    void EngineChannel::PrepareLoadInstrument(const char* FileName, uint Instrument) {
        InstrumentFile = FileName;
        InstrumentIdx  = Instrument;
        InstrumentStat = 0;
    }

    /**
     * Load an instrument from a .gig file. PrepareLoadInstrument() has to
     * be called first to provide the information which instrument to load.
     * 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();

        // free old instrument
        if (pInstrument) {
            // give old instrument back to instrument manager
            Engine::instruments.HandBack(pInstrument, this);
        }

        // delete all key groups
        ActiveKeyGroups.clear();

        // request gig instrument from instrument manager
        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);
            }
        }
        catch (RIFF::Exception e) {
            InstrumentStat = -2;
            String msg = "gig::Engine error: Failed to load instrument, cause: " + e.Message;
            throw LinuxSamplerException(msg);
        }
        catch (InstrumentResourceManagerException e) {
            InstrumentStat = -3;
            String msg = "gig::Engine error: Failed to load instrument, cause: " + e.Message();
            throw LinuxSamplerException(msg);
        }
        catch (...) {
            InstrumentStat = -4;
            throw LinuxSamplerException("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())
            if (pRegion->KeyGroup) ActiveKeyGroups[pRegion->KeyGroup] = NULL;

        InstrumentIdxName = pInstrument->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();
    }

    /**
     * Will be called by the InstrumentResourceManager when the instrument
     * we are currently using on this EngineChannel is going to be updated,
     * so we can stop playback before that happens.
     */
    void EngineChannel::ResourceToBeUpdated(::gig::Instrument* pResource, void*& pUpdateArg) {
        dmsg(3,("gig::Engine: Received instrument update message.\n"));
        if (pEngine) pEngine->DisableAndLock();
        ResetInternal();
        this->pInstrument = NULL;
    }

    /**
     * Will be called by the InstrumentResourceManager when the instrument
     * update process was completed, so we can continue with playback.
     */
    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
    }

    /**
     * Will be called by the InstrumentResourceManager on progress changes
     * while loading or realoading an instrument for this EngineChannel.
     *
     * @param fProgress - current progress as value between 0.0 and 1.0
     */
    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) {
        if (pEngine) {
            if (pEngine->pAudioOutputDevice == pAudioOut) return;
            DisconnectAudioOutputDevice();
        }
        pEngine = Engine::AcquireEngine(this, pAudioOut);
        ResetInternal();
        pEvents = new RTList<Event>(pEngine->pEventPool);
        for (uint i = 0; i < 128; i++) {
            pMIDIKeyInfo[i].pActiveVoices = new RTList<Voice>(pEngine->pVoicePool);
            pMIDIKeyInfo[i].pEvents       = new RTList<Event>(pEngine->pEventPool);
        }
        AudioDeviceChannelLeft  = 0;
        AudioDeviceChannelRight = 1;
        pOutputLeft             = pAudioOut->Channel(0)->Buffer();
        pOutputRight            = pAudioOut->Channel(1)->Buffer();
        MidiInputPort::AddSysexListener(pEngine);
    }

    void EngineChannel::DisconnectAudioOutputDevice() {
        if (pEngine) { // if clause to prevent disconnect loops
            ResetInternal();
            if (pEvents) {
                delete pEvents;
                pEvents = NULL;
            }
            for (uint i = 0; i < 128; i++) {
                if (pMIDIKeyInfo[i].pActiveVoices) {
                    delete pMIDIKeyInfo[i].pActiveVoices;
                    pMIDIKeyInfo[i].pActiveVoices = NULL;
                }
                if (pMIDIKeyInfo[i].pEvents) {
                    delete pMIDIKeyInfo[i].pEvents;
                    pMIDIKeyInfo[i].pEvents = NULL;
                }
            }
            Engine* oldEngine = pEngine;
            AudioOutputDevice* oldAudioDevice = pEngine->pAudioOutputDevice;
            pEngine = NULL;
            Engine::FreeEngine(this, oldAudioDevice);
            AudioDeviceChannelLeft  = -1;
            AudioDeviceChannelRight = -1;
        }
    }

    void EngineChannel::SetOutputChannel(uint EngineAudioChannel, uint AudioDeviceChannel) {
        if (!pEngine || !pEngine->pAudioOutputDevice) throw AudioOutputException("No audio output device connected yet.");

        AudioChannel* pChannel = pEngine->pAudioOutputDevice->Channel(AudioDeviceChannel);
        if (!pChannel) throw AudioOutputException("Invalid audio output device channel " + ToString(AudioDeviceChannel));
        switch (EngineAudioChannel) {
            case 0: // left output channel
                pOutputLeft = pChannel->Buffer();
                AudioDeviceChannelLeft = AudioDeviceChannel;
                break;
            case 1: // right output channel
                pOutputRight = pChannel->Buffer();
                AudioDeviceChannelRight = AudioDeviceChannel;
                break;
            default:
                throw AudioOutputException("Invalid engine audio channel " + ToString(EngineAudioChannel));
        }
    }

    int EngineChannel::OutputChannel(uint EngineAudioChannel) {
        switch (EngineAudioChannel) {
            case 0: // left channel
                return AudioDeviceChannelLeft;
            case 1: // right channel
                return AudioDeviceChannelRight;
            default:
                throw AudioOutputException("Invalid engine audio channel " + ToString(EngineAudioChannel));
        }
    }

    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;
    }

    /**
     *  Will be called by the MIDIIn Thread to let the audio thread trigger a new
     *  voice for the given key.
     *
     *  @param Key      - MIDI key number of the triggered key
     *  @param Velocity - MIDI velocity value of the triggered key
     */
    void EngineChannel::SendNoteOn(uint8_t Key, uint8_t Velocity) {
        if (pEngine) {
            Event event               = pEngine->pEventGenerator->CreateEvent();
            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.
     *
     *  @param Key      - MIDI key number of the released key
     *  @param Velocity - MIDI release velocity value of the released key
     */
    void EngineChannel::SendNoteOff(uint8_t Key, uint8_t Velocity) {
        if (pEngine) {
            Event event               = pEngine->pEventGenerator->CreateEvent();
            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.
     *
     *  @param Pitch - MIDI pitch value (-8192 ... +8191)
     */
    void EngineChannel::SendPitchbend(int Pitch) {
        if (pEngine) {
            Event event             = pEngine->pEventGenerator->CreateEvent();
            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.
     *
     *  @param Controller - MIDI controller number of the occured control change
     *  @param Value      - value of the control change
     */
    void EngineChannel::SendControlChange(uint8_t Controller, uint8_t Value) {
        if (pEngine) {
            Event event               = pEngine->pEventGenerator->CreateEvent();
            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();
        // empty MIDI key specific event lists
        {
            RTList<uint>::Iterator iuiKey = pActiveKeys->first();
            RTList<uint>::Iterator end    = pActiveKeys->end();
            for(; iuiKey != end; ++iuiKey) {
                pMIDIKeyInfo[*iuiKey].pEvents->clear(); // free all events on the key
            }
        }
    }

    void EngineChannel::ResetControllers() {
        Pitch          = 0;
        SustainPedal   = false;
        SostenutoPedal = false;
        GlobalVolume   = CONFIG_GLOBAL_ATTENUATION;
        GlobalPanLeft  = 1.0f;
        GlobalPanRight = 1.0f;
        // set all MIDI controller values to zero
        memset(ControllerTable, 0x00, 128);
    }

    /**
     * Copy all events from the engine channel's input event queue buffer to
     * the internal event list. This will be done at the beginning of each
     * audio cycle (that is each RenderAudio() call) to distinguish all
     * events which have to be processed in the current audio cycle. Each
     * EngineChannel has it's own input event queue for the common channel
     * specific events (like NoteOn, NoteOff and ControlChange events).
     * Beside that, the engine also has a input event queue for global
     * events (usually SysEx messages).
     *
     * @param Samples - number of sample points to be processed in the
     *                  current audio cycle
     */
    void EngineChannel::ImportEvents(uint Samples) {
        RingBuffer<Event>::NonVolatileReader eventQueueReader = pEventQueue->get_non_volatile_reader();
        Event* pEvent;
        while (true) {
            // get next event from input event queue
            if (!(pEvent = eventQueueReader.pop())) break;
            // if younger event reached, ignore that and all subsequent ones for now
            if (pEvent->FragmentPos() >= Samples) {
                eventQueueReader--;
                dmsg(2,("Younger Event, pos=%d ,Samples=%d!\n",pEvent->FragmentPos(),Samples));
                pEvent->ResetFragmentPos();
                break;
            }
            // copy event to internal event list
            if (pEvents->poolIsEmpty()) {
                dmsg(1,("Event pool emtpy!\n"));
                break;
            }
            *pEvents->allocAppend() = *pEvent;
        }
        eventQueueReader.free(); // free all copied events from input queue
    }

    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() {
        return 2;
    }

    String EngineChannel::InstrumentFileName() {
        return InstrumentFile;
    }

    String EngineChannel::InstrumentName() {
        return InstrumentIdxName;
    }

    int EngineChannel::InstrumentIndex() {
        return InstrumentIdx;
    }

    int EngineChannel::InstrumentStatus() {
        return InstrumentStat;
    }

    String EngineChannel::EngineName() {
        return LS_GIG_ENGINE_NAME;
    }

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