src/engines/InstrumentManagerThread.h

/***************************************************************************
 *                                                                         *
 *   Copyright (C) 2005 - 2022 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                                                   *
 ***************************************************************************/

#ifndef __LS_INSTRUMENTLOADER_H__
#define __LS_INSTRUMENTLOADER_H__

#include "../common/global.h"
#include "../common/Thread.h"
#include "../common/Condition.h"
#include "../common/Mutex.h"
#include "../Sampler.h"
#include "../EventListeners.h"
#include "InstrumentManager.h"

#include <list>
#include <functional>

namespace LinuxSampler {

    /** @brief Used by InstrumentManager for background tasks.
     *
     * This class is just an encapsulation of tasks that should be done by
     * the InstrumentManager in the background, that is in a separate thread
     * without blocking the calling thread. This class is thus not exported
     * to the API.
     */
    class InstrumentManagerThread : public Thread {
        friend class EventHandler;
        
        public:
            InstrumentManagerThread();
            void StartNewLoad(String Filename, uint uiInstrumentIndex, EngineChannel* pEngineChannel);
            void StartSettingMode(InstrumentManager* pManager, const InstrumentManager::instrument_id_t& ID, InstrumentManager::mode_t Mode);
            void AddPeriodicJob(String name, std::function<void()> fn);
            void RemovePeriodicJob(String name);
            virtual ~InstrumentManagerThread();
#if (defined(__APPLE__) && !defined(__x86_64__)) || defined(WIN32)
            int StopThread();
#endif
        protected:
            struct command_t {
                enum cmd_type_t {
                    DIRECT_LOAD, ///< command was created by a StartNewLoad() call
                    INSTR_MODE   ///< command was created by a StartSettingMode() call
                } type;
                EngineChannel*                     pEngineChannel; ///< only for DIRECT_LOAD commands
                InstrumentManager*                 pManager;     ///< only for INSTR_MODE commands
                InstrumentManager::instrument_id_t instrumentId; ///< for both DIRECT_LOAD and INSTR_MODE
                InstrumentManager::mode_t          mode;         ///< only for INSTR_MODE commands
            };

            /// Custom job to be executed on behalf of external components.
            struct ext_job_t {
                String name; ///< unique name of the job
                std::function<void()> fn; ///< The actual callback for the job to be executed.
            };

            // Instance variables.
            std::list<command_t> queue; ///< queue with commands for loading new instruments.
            Mutex                mutex; ///< for making the queue thread safe 
            Condition            conditionJobsLeft; ///< synchronizer to block this thread until a new job arrives

            std::vector<ext_job_t> periodicJobs; ///< list of external tasks to be executed periodically
            Mutex                  periodicJobsMutex; ///< for making access to periodicJobs thread safe

            int Main(); ///< Implementation of virtual method from class Thread.
            void RemovePeriodicJobWithoutLock(String name);
            bool AnyPeriodicJobs();
        private:
            class EventHandler : public ChannelCountAdapter {
                public:
                    InstrumentManagerThread* pThread;
                    virtual void ChannelToBeRemoved(SamplerChannel* pChannel);
            };
            
            EventHandler eventHandler;
    };

} // namespace LinuxSampler

#endif // __LS_INSTRUMENTLOADER_H__
1	/***************************************************************************
2	* *
3	* Copyright (C) 2005 - 2022 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	#ifndef __LS_INSTRUMENTLOADER_H__
22	#define __LS_INSTRUMENTLOADER_H__
23
24	#include "../common/global.h"
25	#include "../common/Thread.h"
26	#include "../common/Condition.h"
27	#include "../common/Mutex.h"
28	#include "../Sampler.h"
29	#include "../EventListeners.h"
30	#include "InstrumentManager.h"
31
32	#include <list>
33	#include <functional>
34
35	namespace LinuxSampler {
36
37	/** @brief Used by InstrumentManager for background tasks.
38	*
39	* This class is just an encapsulation of tasks that should be done by
40	* the InstrumentManager in the background, that is in a separate thread
41	* without blocking the calling thread. This class is thus not exported
42	* to the API.
43	*/
44	class InstrumentManagerThread : public Thread {
45	friend class EventHandler;
46
47	public:
48	InstrumentManagerThread();
49	void StartNewLoad(String Filename, uint uiInstrumentIndex, EngineChannel* pEngineChannel);
50	void StartSettingMode(InstrumentManager* pManager, const InstrumentManager::instrument_id_t& ID, InstrumentManager::mode_t Mode);
51	void AddPeriodicJob(String name, std::function<void()> fn);
52	void RemovePeriodicJob(String name);
53	virtual ~InstrumentManagerThread();
54	#if (defined(__APPLE__) && !defined(__x86_64__)) \|\| defined(WIN32)
55	int StopThread();
56	#endif
57	protected:
58	struct command_t {
59	enum cmd_type_t {
60	DIRECT_LOAD, ///< command was created by a StartNewLoad() call
61	INSTR_MODE ///< command was created by a StartSettingMode() call
62	} type;
63	EngineChannel* pEngineChannel; ///< only for DIRECT_LOAD commands
64	InstrumentManager* pManager; ///< only for INSTR_MODE commands
65	InstrumentManager::instrument_id_t instrumentId; ///< for both DIRECT_LOAD and INSTR_MODE
66	InstrumentManager::mode_t mode; ///< only for INSTR_MODE commands
67	};
68
69	/// Custom job to be executed on behalf of external components.
70	struct ext_job_t {
71	String name; ///< unique name of the job
72	std::function<void()> fn; ///< The actual callback for the job to be executed.
73	};
74
75	// Instance variables.
76	std::list<command_t> queue; ///< queue with commands for loading new instruments.
77	Mutex mutex; ///< for making the queue thread safe
78	Condition conditionJobsLeft; ///< synchronizer to block this thread until a new job arrives
79
80	std::vector<ext_job_t> periodicJobs; ///< list of external tasks to be executed periodically
81	Mutex periodicJobsMutex; ///< for making access to periodicJobs thread safe
82
83	int Main(); ///< Implementation of virtual method from class Thread.
84	void RemovePeriodicJobWithoutLock(String name);
85	bool AnyPeriodicJobs();
86	private:
87	class EventHandler : public ChannelCountAdapter {
88	public:
89	InstrumentManagerThread* pThread;
90	virtual void ChannelToBeRemoved(SamplerChannel* pChannel);
91	};
92
93	EventHandler eventHandler;
94	};
95
96	} // namespace LinuxSampler
97
98	#endif // __LS_INSTRUMENTLOADER_H__