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"

namespace LinuxSampler {

    InstrumentManagerThread::InstrumentManagerThread() : Thread(true, false, 0, -4) {
    }

    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));
        // 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();
                mutex.Unlock();

                try {
                    switch (cmd.type) {
                        case command_t::DIRECT_LOAD:
                            cmd.pEngineChannel->LoadInstrument();
                            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();
                } catch (...) {
                    std::cerr << "InstrumentManagerThread: some exception occured, could not finish task\n" << std::flush;
                }

                // remove processed command from queue
                mutex.Lock();
                queue.pop_front();
                mutex.Unlock();
            }

            // 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();
        }
    }

} // namespace LinuxSampler
1	schoenebeck	947	/***************************************************************************
2			* *
3	schoenebeck	1040	* Copyright (C) 2005 - 2007 Christian Schoenebeck *
4	schoenebeck	947	* *
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	schoenebeck	1424	#include "../common/global_private.h"
24
25	schoenebeck	947	namespace LinuxSampler {
26
27			InstrumentManagerThread::InstrumentManagerThread() : Thread(true, false, 0, -4) {
28			}
29
30			InstrumentManagerThread::~InstrumentManagerThread() {
31			}
32
33			/**
34			* @brief Order loading of a new instrument.
35			*
36			* The request will go into a queue waiting to be processed by the
37			* class internal task thread. This method will immediately return and
38			* the instrument will be loaded in the background.
39			*
40			* @param Filename - file name of the instrument
41			* @param uiInstrumentIndex - index of the instrument within the file
42			* @param pEngineChannel - engine channel on which the instrument should be loaded
43			*/
44			void InstrumentManagerThread::StartNewLoad(String Filename, uint uiInstrumentIndex, EngineChannel* pEngineChannel) {
45	persson	1038	dmsg(1,("Scheduling '%s' (Index=%d) to be loaded in background (if not loaded yet).\n",Filename.c_str(),uiInstrumentIndex));
46	schoenebeck	947	// already tell the engine which instrument to load
47			pEngineChannel->PrepareLoadInstrument(Filename.c_str(), uiInstrumentIndex);
48
49			command_t cmd;
50			cmd.type = command_t::DIRECT_LOAD;
51			cmd.pEngineChannel = pEngineChannel;
52	schoenebeck	989
53			mutex.Lock();
54			queue.push_back(cmd);
55			mutex.Unlock();
56
57	schoenebeck	947	StartThread(); // ensure thread is running
58			conditionJobsLeft.Set(true); // wake up thread
59			}
60
61			/**
62			* @brief Order changing the life-time strategy of an instrument.
63			*
64			* The request will go into a queue waiting to be processed by the
65			* class internal task thread. This method will immediately return and
66			* in case the instrument has to be loaded due to a mode change to
67			* PERSISTENT, it will be loaded in the background.
68			*
69			* @param pManager - InstrumentManager which manages the instrument
70			* @param ID - unique ID of the instrument
71			* @param Mode - life-time strategy to set for this instrument
72			*/
73			void InstrumentManagerThread::StartSettingMode(InstrumentManager* pManager, const InstrumentManager::instrument_id_t& ID, InstrumentManager::mode_t Mode) {
74			command_t cmd;
75			cmd.type = command_t::INSTR_MODE;
76			cmd.pManager = pManager;
77			cmd.instrumentId = ID;
78			cmd.mode = Mode;
79	schoenebeck	989
80			mutex.Lock();
81			queue.push_back(cmd);
82			mutex.Unlock();
83
84	schoenebeck	947	StartThread(); // ensure thread is running
85			conditionJobsLeft.Set(true); // wake up thread
86			}
87
88			// Entry point for the task thread.
89			int InstrumentManagerThread::Main() {
90			while (true) {
91	nagata	1649
92			#if CONFIG_PTHREAD_TESTCANCEL
93			TestCancel();
94			#endif
95
96	schoenebeck	989	while (!queue.empty()) {
97	schoenebeck	947	command_t cmd;
98	schoenebeck	989
99			// grab a new command from the queue
100			mutex.Lock();
101			cmd = queue.front();
102			mutex.Unlock();
103
104	schoenebeck	947	try {
105			switch (cmd.type) {
106			case command_t::DIRECT_LOAD:
107			cmd.pEngineChannel->LoadInstrument();
108			break;
109			case command_t::INSTR_MODE:
110			cmd.pManager->SetMode(cmd.instrumentId, cmd.mode);
111			break;
112			default:
113			std::cerr << "InstrumentManagerThread: unknown command - BUG!\n" << std::flush;
114			}
115	schoenebeck	1040	} catch (Exception e) {
116	schoenebeck	947	e.PrintMessage();
117	schoenebeck	1040	} catch (...) {
118			std::cerr << "InstrumentManagerThread: some exception occured, could not finish task\n" << std::flush;
119	schoenebeck	947	}
120	schoenebeck	989
121			// remove processed command from queue
122			mutex.Lock();
123			queue.pop_front();
124			mutex.Unlock();
125	schoenebeck	947	}
126
127			// nothing left to do, sleep until new jobs arrive
128			conditionJobsLeft.WaitIf(false);
129			// reset flag
130			conditionJobsLeft.Set(false);
131			// unlock condition object so it can be turned again by other thread
132			conditionJobsLeft.Unlock();
133			}
134			}
135
136			} // namespace LinuxSampler