engines/gig/EngineChannel.cpp

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003,2004 by Benno Senoner and Christian Schoenebeck    *
 *   Copyright (C) 2005-2008 Christian Schoenebeck                         *
 *   Copyright (C) 2009 - 2012 Christian Schoenebeck and Grigor Iliev      *
 *   Copyright (C) 2012 - 2016 Christian Schoenebeck and Andreas Persson   *
 *                                                                         *
 *   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"
#include "Engine.h"

namespace LinuxSampler { namespace gig {
    EngineChannel::EngineChannel() {
        CurrentGigScript = NULL;
    }

    EngineChannel::~EngineChannel() {
        DisconnectAudioOutputDevice();
        // In case the channel was removed before the instrument was
        // fully loaded, try to give back instrument again (see bug #113)
        InstrumentChangeCmd< ::gig::DimensionRegion, ::gig::Instrument>& cmd = ChangeInstrument(NULL);
        if (cmd.pInstrument) {
            Engine::instruments.HandBack(cmd.pInstrument, this);
        }
        ///////
    }

    AbstractEngine::Format EngineChannel::GetEngineFormat() { return AbstractEngine::GIG; }

    /** This method is not thread safe! */
    void EngineChannel::ResetInternal(bool bResetEngine) {
        CurrentKeyDimension = 0;
        EngineChannelBase<Voice, ::gig::DimensionRegion, ::gig::Instrument>::ResetInternal(bResetEngine);
    }

    /**
     *  Will be called by the MIDIIn Thread to signal that a program
     *  change should be performed. As a program change isn't
     *  real-time safe, the actual change is performed by the disk
     *  thread.
     *
     *  @param Program     - MIDI program change number
     */
    void EngineChannel::SendProgramChange(uint8_t Program) {
        SetMidiProgram(Program);
        Engine* engine = dynamic_cast<Engine*>(pEngine);
        if(engine == NULL) return;

        if(engine->GetDiskThread()) {
            uint32_t merged = (GetMidiBankMsb() << 16) | (GetMidiBankLsb() << 8) | Program;
            engine->GetDiskThread()->OrderProgramChange(merged, this);
        } else {
            // TODO: 
        }
    }

    /**
     * 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.
     *
     * @see PrepareLoadInstrument()
     */
    void EngineChannel::LoadInstrument() {
        InstrumentResourceManager* pInstrumentManager = dynamic_cast<InstrumentResourceManager*>(pEngine->GetInstrumentManager());

        // make sure we don't trigger any new notes with an old
        // instrument
        InstrumentChangeCmd< ::gig::DimensionRegion, ::gig::Instrument>& cmd = ChangeInstrument(NULL);
        if (cmd.pInstrument) {
            // give old instrument back to instrument manager, but
            // keep the dimension regions and samples that are in use
            pInstrumentManager->HandBackInstrument(cmd.pInstrument, this, cmd.pRegionsInUse);
        }
        if (cmd.pScript) {
            // give old instrument script back to instrument resource manager
            cmd.pScript->resetAll();
            CurrentGigScript = NULL;
        }
        cmd.pRegionsInUse->clear();

        // delete all key groups
        DeleteGroupEventLists();

        // request gig instrument from instrument manager
        ::gig::Instrument* newInstrument;
        try {
            InstrumentManager::instrument_id_t instrid;
            instrid.FileName  = InstrumentFile;
            instrid.Index     = InstrumentIdx;

            newInstrument = pInstrumentManager->Borrow(instrid, this);
            if (!newInstrument) {
                throw InstrumentManagerException("resource was not created");
            }

            if (newInstrument->ScriptSlotCount() > 1) {
                std::cerr << "WARNING: Executing more than one real-time instrument script slot is not implemented yet!\n";
            }
            ::gig::Script* script = newInstrument->GetScriptOfSlot(0);
            if (script) {
                String sourceCode = script->GetScriptAsText();
                LoadInstrumentScript(sourceCode);
            }
            CurrentGigScript = script;
        }
        catch (RIFF::Exception e) {
            InstrumentStat = -2;
            StatusChanged(true);
            String msg = "gig::Engine error: Failed to load instrument, cause: " + e.Message;
            throw Exception(msg);
        }
        catch (InstrumentManagerException e) {
            InstrumentStat = -3;
            StatusChanged(true);
            String msg = "gig::Engine error: Failed to load instrument, cause: " + e.Message();
            throw Exception(msg);
        }
        catch (...) {
            InstrumentStat = -4;
            StatusChanged(true);
            throw Exception("gig::Engine error: Failed to load instrument, cause: Unknown exception while trying to parse gig file.");
        }

        RoundRobinIndex = 0;
        for (int i = 0 ; i < 128 ; i++) pMIDIKeyInfo[i].pRoundRobinIndex = NULL;

        // rebuild ActiveKeyGroups map with key groups of current
        // instrument and set the round robin pointers to use one
        // counter for each region
        int region = 0;
        for (::gig::Region* pRegion = newInstrument->GetFirstRegion(); pRegion; pRegion = newInstrument->GetNextRegion()) {
            AddGroup(pRegion->KeyGroup);

            RoundRobinIndexes[region] = 0;
            for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {
                pMIDIKeyInfo[iKey].pRoundRobinIndex = &RoundRobinIndexes[region];
            }
            region++;
        }

        InstrumentIdxName = newInstrument->pInfo->Name;
        InstrumentStat = 100;

        {
            InstrumentChangeCmd< ::gig::DimensionRegion, ::gig::Instrument>& cmd =
                ChangeInstrument(newInstrument);
            if (cmd.pScript) {
                // give old instrument script back to instrument resource manager
                cmd.pScript->resetAll();
            }
        }

        StatusChanged(true);
    }

    /**
     * Called by instrument editor API to inform this engine channel that the
     * passed @a script has been modified by the instrument editor and that
     * this engine channel should thus reload the instrument script (that is
     * that it should re-parse the scripts new source code).
     */
    void EngineChannel::reloadScript(::gig::Script* script) {
        dmsg(3,("gig::EngineChannel::realoadScript()\n"));
        // make sure this engine channel is actually using the requested
        // modified gig::Script object (because the internal script resource
        // manager will i.e. provide the same VM object for different
        // ::gig::Script objects with same source code though.
        if (!script || CurrentGigScript != script) return;

        //TODO: reloading the entire instrument is currently a very lazy (and slow) solution just for reloading the instrument script
        try {
            LoadInstrument();
        } catch (Exception e) {
            std::cerr << e.Message() << std::endl;
        } catch (...) {
            String msg = "gig::Engine error: Failed to reload instrument script, cause: Unknown exception while trying to reload gig file.";
            std::cerr << msg << std::endl;
        }
    }

    void EngineChannel::ProcessKeySwitchChange(int key) {
        // Change key dimension value if key is in keyswitching area
        {
            if (key >= pInstrument->DimensionKeyRange.low && key <= pInstrument->DimensionKeyRange.high)
                CurrentKeyDimension = float(key - pInstrument->DimensionKeyRange.low) /
                    (pInstrument->DimensionKeyRange.high - pInstrument->DimensionKeyRange.low + 1);
        }
    }
    
    String EngineChannel::InstrumentFileName() {
        return EngineChannelBase<Voice, ::gig::DimensionRegion, ::gig::Instrument>::InstrumentFileName();
    }
    
    String EngineChannel::InstrumentFileName(int index) {
        if (index == 0) return InstrumentFileName();
        if (!pInstrument || !pInstrument->GetParent()) return "";
        DLS::File* pMainFile = dynamic_cast<DLS::File*>(pInstrument->GetParent());
        if (!pMainFile) return "";
        RIFF::File* pExtensionFile = pMainFile->GetExtensionFile(index);
        return (pExtensionFile) ? pExtensionFile->GetFileName() : "";
    }

}} // namespace LinuxSampler::gig
1	/***************************************************************************
2	* *
3	* LinuxSampler - modular, streaming capable sampler *
4	* *
5	* Copyright (C) 2003,2004 by Benno Senoner and Christian Schoenebeck *
6	* Copyright (C) 2005-2008 Christian Schoenebeck *
7	* 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 *
11	* it under the terms of the GNU General Public License as published by *
12	* the Free Software Foundation; either version 2 of the License, or *
13	* (at your option) any later version. *
14	* *
15	* This program is distributed in the hope that it will be useful, *
16	* but WITHOUT ANY WARRANTY; without even the implied warranty of *
17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
18	* GNU General Public License for more details. *
19	* *
20	* You should have received a copy of the GNU General Public License *
21	* along with this program; if not, write to the Free Software *
22	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
23	* MA 02111-1307 USA *
24	***************************************************************************/
25
26	#include "EngineChannel.h"
27	#include "Engine.h"
28
29	namespace LinuxSampler { namespace gig {
30	EngineChannel::EngineChannel() {
31	CurrentGigScript = NULL;
32	}
33
34	EngineChannel::~EngineChannel() {
35	DisconnectAudioOutputDevice();
36	// In case the channel was removed before the instrument was
37	// fully loaded, try to give back instrument again (see bug #113)
38	InstrumentChangeCmd< ::gig::DimensionRegion, ::gig::Instrument>& cmd = ChangeInstrument(NULL);
39	if (cmd.pInstrument) {
40	Engine::instruments.HandBack(cmd.pInstrument, this);
41	}
42	///////
43	}
44
45	AbstractEngine::Format EngineChannel::GetEngineFormat() { return AbstractEngine::GIG; }
46
47	/** This method is not thread safe! */
48	void EngineChannel::ResetInternal(bool bResetEngine) {
49	CurrentKeyDimension = 0;
50	EngineChannelBase<Voice, ::gig::DimensionRegion, ::gig::Instrument>::ResetInternal(bResetEngine);
51	}
52
53	/**
54	* Will be called by the MIDIIn Thread to signal that a program
55	* change should be performed. As a program change isn't
56	* real-time safe, the actual change is performed by the disk
57	* thread.
58	*
59	* @param Program - MIDI program change number
60	*/
61	void EngineChannel::SendProgramChange(uint8_t Program) {
62	SetMidiProgram(Program);
63	Engine* engine = dynamic_cast<Engine*>(pEngine);
64	if(engine == NULL) return;
65
66	if(engine->GetDiskThread()) {
67	uint32_t merged = (GetMidiBankMsb() << 16) \| (GetMidiBankLsb() << 8) \| Program;
68	engine->GetDiskThread()->OrderProgramChange(merged, this);
69	} else {
70	// TODO:
71	}
72	}
73
74	/**
75	* Load an instrument from a .gig file. PrepareLoadInstrument() has to
76	* be called first to provide the information which instrument to load.
77	* This method will then actually start to load the instrument and block
78	* the calling thread until loading was completed.
79	*
80	* @see PrepareLoadInstrument()
81	*/
82	void EngineChannel::LoadInstrument() {
83	InstrumentResourceManager* pInstrumentManager = dynamic_cast<InstrumentResourceManager*>(pEngine->GetInstrumentManager());
84
85	// make sure we don't trigger any new notes with an old
86	// instrument
87	InstrumentChangeCmd< ::gig::DimensionRegion, ::gig::Instrument>& cmd = ChangeInstrument(NULL);
88	if (cmd.pInstrument) {
89	// give old instrument back to instrument manager, but
90	// keep the dimension regions and samples that are in use
91	pInstrumentManager->HandBackInstrument(cmd.pInstrument, this, cmd.pRegionsInUse);
92	}
93	if (cmd.pScript) {
94	// give old instrument script back to instrument resource manager
95	cmd.pScript->resetAll();
96	CurrentGigScript = NULL;
97	}
98	cmd.pRegionsInUse->clear();
99
100	// delete all key groups
101	DeleteGroupEventLists();
102
103	// request gig instrument from instrument manager
104	::gig::Instrument* newInstrument;
105	try {
106	InstrumentManager::instrument_id_t instrid;
107	instrid.FileName = InstrumentFile;
108	instrid.Index = InstrumentIdx;
109
110	newInstrument = pInstrumentManager->Borrow(instrid, this);
111	if (!newInstrument) {
112	throw InstrumentManagerException("resource was not created");
113	}
114
115	if (newInstrument->ScriptSlotCount() > 1) {
116	std::cerr << "WARNING: Executing more than one real-time instrument script slot is not implemented yet!\n";
117	}
118	::gig::Script* script = newInstrument->GetScriptOfSlot(0);
119	if (script) {
120	String sourceCode = script->GetScriptAsText();
121	LoadInstrumentScript(sourceCode);
122	}
123	CurrentGigScript = script;
124	}
125	catch (RIFF::Exception e) {
126	InstrumentStat = -2;
127	StatusChanged(true);
128	String msg = "gig::Engine error: Failed to load instrument, cause: " + e.Message;
129	throw Exception(msg);
130	}
131	catch (InstrumentManagerException e) {
132	InstrumentStat = -3;
133	StatusChanged(true);
134	String msg = "gig::Engine error: Failed to load instrument, cause: " + e.Message();
135	throw Exception(msg);
136	}
137	catch (...) {
138	InstrumentStat = -4;
139	StatusChanged(true);
140	throw Exception("gig::Engine error: Failed to load instrument, cause: Unknown exception while trying to parse gig file.");
141	}
142
143	RoundRobinIndex = 0;
144	for (int i = 0 ; i < 128 ; i++) pMIDIKeyInfo[i].pRoundRobinIndex = NULL;
145
146	// rebuild ActiveKeyGroups map with key groups of current
147	// instrument and set the round robin pointers to use one
148	// counter for each region
149	int region = 0;
150	for (::gig::Region* pRegion = newInstrument->GetFirstRegion(); pRegion; pRegion = newInstrument->GetNextRegion()) {
151	AddGroup(pRegion->KeyGroup);
152
153	RoundRobinIndexes[region] = 0;
154	for (int iKey = pRegion->KeyRange.low; iKey <= pRegion->KeyRange.high; iKey++) {
155	pMIDIKeyInfo[iKey].pRoundRobinIndex = &RoundRobinIndexes[region];
156	}
157	region++;
158	}
159
160	InstrumentIdxName = newInstrument->pInfo->Name;
161	InstrumentStat = 100;
162
163	{
164	InstrumentChangeCmd< ::gig::DimensionRegion, ::gig::Instrument>& cmd =
165	ChangeInstrument(newInstrument);
166	if (cmd.pScript) {
167	// give old instrument script back to instrument resource manager
168	cmd.pScript->resetAll();
169	}
170	}
171
172	StatusChanged(true);
173	}
174
175	/**
176	* Called by instrument editor API to inform this engine channel that the
177	* passed @a script has been modified by the instrument editor and that
178	* this engine channel should thus reload the instrument script (that is
179	* that it should re-parse the scripts new source code).
180	*/
181	void EngineChannel::reloadScript(::gig::Script* script) {
182	dmsg(3,("gig::EngineChannel::realoadScript()\n"));
183	// make sure this engine channel is actually using the requested
184	// modified gig::Script object (because the internal script resource
185	// manager will i.e. provide the same VM object for different
186	// ::gig::Script objects with same source code though.
187	if (!script \|\| CurrentGigScript != script) return;
188
189	//TODO: reloading the entire instrument is currently a very lazy (and slow) solution just for reloading the instrument script
190	try {
191	LoadInstrument();
192	} catch (Exception e) {
193	std::cerr << e.Message() << std::endl;
194	} catch (...) {
195	String msg = "gig::Engine error: Failed to reload instrument script, cause: Unknown exception while trying to reload gig file.";
196	std::cerr << msg << std::endl;
197	}
198	}
199
200	void EngineChannel::ProcessKeySwitchChange(int key) {
201	// Change key dimension value if key is in keyswitching area
202	{
203	if (key >= pInstrument->DimensionKeyRange.low && key <= pInstrument->DimensionKeyRange.high)
204	CurrentKeyDimension = float(key - pInstrument->DimensionKeyRange.low) /
205	(pInstrument->DimensionKeyRange.high - pInstrument->DimensionKeyRange.low + 1);
206	}
207	}
208
209	String EngineChannel::InstrumentFileName() {
210	return EngineChannelBase<Voice, ::gig::DimensionRegion, ::gig::Instrument>::InstrumentFileName();
211	}
212
213	String EngineChannel::InstrumentFileName(int index) {
214	if (index == 0) return InstrumentFileName();
215	if (!pInstrument \|\| !pInstrument->GetParent()) return "";
216	DLS::File* pMainFile = dynamic_cast<DLS::File*>(pInstrument->GetParent());
217	if (!pMainFile) return "";
218	RIFF::File* pExtensionFile = pMainFile->GetExtensionFile(index);
219	return (pExtensionFile) ? pExtensionFile->GetFileName() : "";
220	}
221
222	}} // namespace LinuxSampler::gig