src/engines/InstrumentManagerThread.cpp

/***************************************************************************
 *                                                                         *
 *   Copyright (C) 2005 - 2007 Christian Schoenebeck                       *
 *                                                                         *
 *   This library 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 library 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 library; if not, write to the Free Software           *
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,                 *
 *   MA  02111-1307  USA                                                   *
 ***************************************************************************/

#include "InstrumentManagerThread.h"

#include "../common/global_private.h"
#include "EngineChannelFactory.h"

namespace LinuxSampler {

    InstrumentManagerThread::InstrumentManagerThread() : Thread(true, false, 0, -4) {
        eventHandler.pThread = this;
    }

    InstrumentManagerThread::~InstrumentManagerThread() {
    }

    /**
     * @brief Order loading of a new instrument.
     *
     * The request will go into a queue waiting to be processed by the
     * class internal task thread. This method will immediately return and
     * the instrument will be loaded in the background.
     *
     * @param Filename - file name of the instrument
     * @param uiInstrumentIndex - index of the instrument within the file
     * @param pEngineChannel - engine channel on which the instrument should be loaded
     */
    void InstrumentManagerThread::StartNewLoad(String Filename, uint uiInstrumentIndex, EngineChannel* pEngineChannel) {
        dmsg(1,("Scheduling '%s' (Index=%d) to be loaded in background (if not loaded yet).\n",Filename.c_str(),uiInstrumentIndex));

        static bool listenerRegistered = false;
        if (!listenerRegistered) {
            pEngineChannel->GetSampler()->AddChannelCountListener(&eventHandler);
            listenerRegistered = true;
        }
        
        
        // already tell the engine which instrument to load
        pEngineChannel->PrepareLoadInstrument(Filename.c_str(), uiInstrumentIndex);

        command_t cmd;
        cmd.type           = command_t::DIRECT_LOAD;
        cmd.pEngineChannel = pEngineChannel;

        mutex.Lock();
        queue.push_back(cmd);
        mutex.Unlock();

        StartThread(); // ensure thread is running
        conditionJobsLeft.Set(true); // wake up thread
    }

    /**
     * @brief Order changing the life-time strategy of an instrument.
     *
     * The request will go into a queue waiting to be processed by the
     * class internal task thread. This method will immediately return and
     * in case the instrument has to be loaded due to a mode change to
     * PERSISTENT, it will be loaded in the background.
     *
     * @param pManager - InstrumentManager which manages the instrument
     * @param ID       - unique ID of the instrument
     * @param Mode     - life-time strategy to set for this instrument
     */
    void InstrumentManagerThread::StartSettingMode(InstrumentManager* pManager, const InstrumentManager::instrument_id_t& ID, InstrumentManager::mode_t Mode) {
        command_t cmd;
        cmd.type         = command_t::INSTR_MODE;
        cmd.pManager     = pManager;
        cmd.instrumentId = ID;
        cmd.mode         = Mode;

        mutex.Lock();
        queue.push_back(cmd);
        mutex.Unlock();

        StartThread(); // ensure thread is running
        conditionJobsLeft.Set(true); // wake up thread
    }

    // Entry point for the task thread.
    int InstrumentManagerThread::Main() {
        while (true) {

                        #if CONFIG_PTHREAD_TESTCANCEL
                        TestCancel();
                        #endif

            while (!queue.empty()) {
                command_t cmd;

                // grab a new command from the queue
                mutex.Lock();
                cmd = queue.front();
                queue.pop_front();
                mutex.Unlock();

                try {
                    switch (cmd.type) {
                        case command_t::DIRECT_LOAD:
                            EngineChannelFactory::SetDeleteEnabled(cmd.pEngineChannel, false);
                            cmd.pEngineChannel->LoadInstrument();
                            EngineChannelFactory::SetDeleteEnabled(cmd.pEngineChannel, true);
                            break;
                        case command_t::INSTR_MODE:
                            cmd.pManager->SetMode(cmd.instrumentId, cmd.mode);
                            break;
                        default:
                            std::cerr << "InstrumentManagerThread: unknown command - BUG!\n" << std::flush;
                    }
                } catch (Exception e) {
                    e.PrintMessage();
                    if (cmd.type == command_t::DIRECT_LOAD) {
                        EngineChannelFactory::SetDeleteEnabled(cmd.pEngineChannel, true);
                    }
                } catch (...) {
                    std::cerr << "InstrumentManagerThread: some exception occured, could not finish task\n" << std::flush;
                    if (cmd.type == command_t::DIRECT_LOAD) {
                        EngineChannelFactory::SetDeleteEnabled(cmd.pEngineChannel, true);
                    }
                }
            }

            // nothing left to do, sleep until new jobs arrive
            conditionJobsLeft.WaitIf(false);
            // reset flag
            conditionJobsLeft.Set(false);
            // unlock condition object so it can be turned again by other thread
            conditionJobsLeft.Unlock();
        }
    }
    
    void InstrumentManagerThread::EventHandler::ChannelToBeRemoved(SamplerChannel* pChannel) {
        /*
           Removing from the queue an eventual scheduled loading of an instrument
           to a sampler channel which is going to be removed.
        */
        pThread->mutex.Lock();
        std::list<command_t>::iterator it;
        for (it = pThread->queue.begin(); it != pThread->queue.end();){
            if ((*it).type != command_t::DIRECT_LOAD) { ++it; continue; }
            if ((*it).pEngineChannel == pChannel->GetEngineChannel()) {
                it = pThread->queue.erase(it);
                // we don't break here because the same engine channel could
                // occur more than once in the queue, so don't make optimizations
            } else {
                ++it;
            }
        } 
        pThread->mutex.Unlock();
    }
} // namespace LinuxSampler
1	/***************************************************************************
2	* *
3	* Copyright (C) 2005 - 2007 Christian Schoenebeck *
4	* *
5	* This library is free software; you can redistribute it and/or modify *
6	* it under the terms of the GNU General Public License as published by *
7	* the Free Software Foundation; either version 2 of the License, or *
8	* (at your option) any later version. *
9	* *
10	* This library is distributed in the hope that it will be useful, *
11	* but WITHOUT ANY WARRANTY; without even the implied warranty of *
12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13	* GNU General Public License for more details. *
14	* *
15	* You should have received a copy of the GNU General Public License *
16	* along with this library; if not, write to the Free Software *
17	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
18	* MA 02111-1307 USA *
19	***************************************************************************/
20
21	#include "InstrumentManagerThread.h"
22
23	#include "../common/global_private.h"
24	#include "EngineChannelFactory.h"
25
26	namespace LinuxSampler {
27
28	InstrumentManagerThread::InstrumentManagerThread() : Thread(true, false, 0, -4) {
29	eventHandler.pThread = this;
30	}
31
32	InstrumentManagerThread::~InstrumentManagerThread() {
33	}
34
35	/**
36	* @brief Order loading of a new instrument.
37	*
38	* The request will go into a queue waiting to be processed by the
39	* class internal task thread. This method will immediately return and
40	* the instrument will be loaded in the background.
41	*
42	* @param Filename - file name of the instrument
43	* @param uiInstrumentIndex - index of the instrument within the file
44	* @param pEngineChannel - engine channel on which the instrument should be loaded
45	*/
46	void InstrumentManagerThread::StartNewLoad(String Filename, uint uiInstrumentIndex, EngineChannel* pEngineChannel) {
47	dmsg(1,("Scheduling '%s' (Index=%d) to be loaded in background (if not loaded yet).\n",Filename.c_str(),uiInstrumentIndex));
48
49	static bool listenerRegistered = false;
50	if (!listenerRegistered) {
51	pEngineChannel->GetSampler()->AddChannelCountListener(&eventHandler);
52	listenerRegistered = true;
53	}
54
55
56	// already tell the engine which instrument to load
57	pEngineChannel->PrepareLoadInstrument(Filename.c_str(), uiInstrumentIndex);
58
59	command_t cmd;
60	cmd.type = command_t::DIRECT_LOAD;
61	cmd.pEngineChannel = pEngineChannel;
62
63	mutex.Lock();
64	queue.push_back(cmd);
65	mutex.Unlock();
66
67	StartThread(); // ensure thread is running
68	conditionJobsLeft.Set(true); // wake up thread
69	}
70
71	/**
72	* @brief Order changing the life-time strategy of an instrument.
73	*
74	* The request will go into a queue waiting to be processed by the
75	* class internal task thread. This method will immediately return and
76	* in case the instrument has to be loaded due to a mode change to
77	* PERSISTENT, it will be loaded in the background.
78	*
79	* @param pManager - InstrumentManager which manages the instrument
80	* @param ID - unique ID of the instrument
81	* @param Mode - life-time strategy to set for this instrument
82	*/
83	void InstrumentManagerThread::StartSettingMode(InstrumentManager* pManager, const InstrumentManager::instrument_id_t& ID, InstrumentManager::mode_t Mode) {
84	command_t cmd;
85	cmd.type = command_t::INSTR_MODE;
86	cmd.pManager = pManager;
87	cmd.instrumentId = ID;
88	cmd.mode = Mode;
89
90	mutex.Lock();
91	queue.push_back(cmd);
92	mutex.Unlock();
93
94	StartThread(); // ensure thread is running
95	conditionJobsLeft.Set(true); // wake up thread
96	}
97
98	// Entry point for the task thread.
99	int InstrumentManagerThread::Main() {
100	while (true) {
101
102	#if CONFIG_PTHREAD_TESTCANCEL
103	TestCancel();
104	#endif
105
106	while (!queue.empty()) {
107	command_t cmd;
108
109	// grab a new command from the queue
110	mutex.Lock();
111	cmd = queue.front();
112	queue.pop_front();
113	mutex.Unlock();
114
115	try {
116	switch (cmd.type) {
117	case command_t::DIRECT_LOAD:
118	EngineChannelFactory::SetDeleteEnabled(cmd.pEngineChannel, false);
119	cmd.pEngineChannel->LoadInstrument();
120	EngineChannelFactory::SetDeleteEnabled(cmd.pEngineChannel, true);
121	break;
122	case command_t::INSTR_MODE:
123	cmd.pManager->SetMode(cmd.instrumentId, cmd.mode);
124	break;
125	default:
126	std::cerr << "InstrumentManagerThread: unknown command - BUG!\n" << std::flush;
127	}
128	} catch (Exception e) {
129	e.PrintMessage();
130	if (cmd.type == command_t::DIRECT_LOAD) {
131	EngineChannelFactory::SetDeleteEnabled(cmd.pEngineChannel, true);
132	}
133	} catch (...) {
134	std::cerr << "InstrumentManagerThread: some exception occured, could not finish task\n" << std::flush;
135	if (cmd.type == command_t::DIRECT_LOAD) {
136	EngineChannelFactory::SetDeleteEnabled(cmd.pEngineChannel, true);
137	}
138	}
139	}
140
141	// nothing left to do, sleep until new jobs arrive
142	conditionJobsLeft.WaitIf(false);
143	// reset flag
144	conditionJobsLeft.Set(false);
145	// unlock condition object so it can be turned again by other thread
146	conditionJobsLeft.Unlock();
147	}
148	}
149
150	void InstrumentManagerThread::EventHandler::ChannelToBeRemoved(SamplerChannel* pChannel) {
151	/*
152	Removing from the queue an eventual scheduled loading of an instrument
153	to a sampler channel which is going to be removed.
154	*/
155	pThread->mutex.Lock();
156	std::list<command_t>::iterator it;
157	for (it = pThread->queue.begin(); it != pThread->queue.end();){
158	if ((*it).type != command_t::DIRECT_LOAD) { ++it; continue; }
159	if ((*it).pEngineChannel == pChannel->GetEngineChannel()) {
160	it = pThread->queue.erase(it);
161	// we don't break here because the same engine channel could
162	// occur more than once in the queue, so don't make optimizations
163	} else {
164	++it;
165	}
166	}
167	pThread->mutex.Unlock();
168	}
169	} // namespace LinuxSampler