engines/gig/InstrumentResourceManager.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
 *   Copyright (C) 2005 - 2017 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                                                   *
 ***************************************************************************/

#ifndef __LS_GIG_INSTRUMENTRESOURCEMANAGER_H__
#define __LS_GIG_INSTRUMENTRESOURCEMANAGER_H__

#include "../../common/global.h"

#if AC_APPLE_UNIVERSAL_BUILD
# include <libgig/gig.h>
#else
# include <gig.h>
#endif

#include "../../common/Pool.h"
#include "../../common/ResourceManager.h"
#include "../InstrumentManagerBase.h"
#include "../../drivers/audio/AudioOutputDevice.h"
#include "../InstrumentManager.h"
#include "../../common/ArrayList.h"

//namespace libgig = gig;

namespace LinuxSampler { namespace gig {

    typedef ResourceConsumer< ::gig::Instrument> InstrumentConsumer;

}} // namespace LinuxSampler::gig

#include "../../plugins/InstrumentEditor.h"

namespace LinuxSampler { namespace gig {

    class Engine;
    class EngineChannel;

    /** @brief Gig instrument manager
     *
     * Manager to share gig instruments between multiple Gigasampler
     * engine channels. The engine channels Borrow() instruments when they
     * need them and HandBack() when they don't need them anymore. The
     * InstrumentResourceManager loads the corresponding gig file and gig
     * instrument if needed, if it's already in use by another engine
     * channel, then it just returns the same resource, if an gig
     * instrument / file is not needed anymore, then it will be freed from
     * memory.
     */
    class InstrumentResourceManager : public InstrumentManagerBase< ::gig::File, ::gig::Instrument, ::gig::DimensionRegion, ::gig::Sample>, public InstrumentEditorListener {
        public:
            InstrumentResourceManager() : Gigs(this) {}
            virtual ~InstrumentResourceManager() {}
            static void OnInstrumentLoadingProgress(::gig::progress_t* pProgress);

            // implementation of derived abstract methods from 'InstrumentManager'
            virtual String GetInstrumentName(instrument_id_t ID) OVERRIDE;
            virtual String GetInstrumentDataStructureName(instrument_id_t ID) OVERRIDE;
            virtual String GetInstrumentDataStructureVersion(instrument_id_t ID) OVERRIDE;
            virtual InstrumentEditor* LaunchInstrumentEditor(LinuxSampler::EngineChannel* pEngineChannel, instrument_id_t ID, void* pUserData = NULL) throw (InstrumentManagerException) OVERRIDE;
            virtual std::vector<instrument_id_t> GetInstrumentFileContent(String File) throw (InstrumentManagerException) OVERRIDE;
            virtual instrument_info_t GetInstrumentInfo(instrument_id_t ID) throw (InstrumentManagerException) OVERRIDE;

            // implementation of derived abstract methods from 'InstrumentEditorListener'
            virtual void OnInstrumentEditorQuit(InstrumentEditor* pSender) OVERRIDE;
            virtual void OnSamplesToBeRemoved(std::set<void*> Samples, InstrumentEditor* pSender) OVERRIDE;
            virtual void OnSamplesRemoved(InstrumentEditor* pSender) OVERRIDE;
            virtual void OnDataStructureToBeChanged(void* pStruct, String sStructType, InstrumentEditor* pSender) OVERRIDE;
            virtual void OnDataStructureChanged(void* pStruct, String sStructType, InstrumentEditor* pSender) OVERRIDE;
            virtual void OnSampleReferenceChanged(void* pOldSample, void* pNewSample, InstrumentEditor* pSender) OVERRIDE;

#if 0 // currently unused :
            void TrySendNoteOnToEditors(uint8_t Key, uint8_t Velocity, ::gig::Instrument* pInstrument);
            void TrySendNoteOffToEditors(uint8_t Key, uint8_t Velocity, ::gig::Instrument* pInstrument);
#endif // unused

        protected:
            // implementation of derived abstract methods from 'ResourceManager'
            virtual ::gig::Instrument* Create(instrument_id_t Key, InstrumentConsumer* pConsumer, void*& pArg) OVERRIDE;
            virtual void               Destroy(::gig::Instrument* pResource, void* pArg) OVERRIDE;
            virtual void               DeleteRegionIfNotUsed(::gig::DimensionRegion* pRegion, region_info_t* pRegInfo) OVERRIDE;
            virtual void               DeleteSampleIfNotUsed(::gig::Sample* pSample, region_info_t* pRegInfo) OVERRIDE;
        private:
            void                       CacheInitialSamples(::gig::Sample* pSample, AbstractEngine* pEngine);
            void                       CacheInitialSamples(::gig::Sample* pSample, EngineChannel* pEngineChannel);
            void                       CacheInitialSamples(::gig::Sample* pSample, uint maxSamplesPerCycle);

            typedef ResourceConsumer< ::gig::File> GigConsumer;

            class GigResourceManager : public ResourceManager<String, ::gig::File> {
                protected:
                    // implementation of derived abstract methods from 'ResourceManager'
                    virtual ::gig::File* Create(String Key, GigConsumer* pConsumer, void*& pArg) OVERRIDE;
                    virtual void         Destroy(::gig::File* pResource, void* pArg) OVERRIDE;
                    virtual void         OnBorrow(::gig::File* pResource, GigConsumer* pConsumer, void*& pArg) OVERRIDE {} // ignore
                public:
                    GigResourceManager(InstrumentResourceManager* parent) : parent(parent) {}
                    virtual ~GigResourceManager() {}
                private:
                    InstrumentResourceManager* parent;
            } Gigs;

            void UncacheInitialSamples(::gig::Sample* pSample);
            std::vector< ::gig::Instrument*> GetInstrumentsCurrentlyUsedOf(::gig::File* pFile, bool bLock);
            std::set<EngineChannel*> GetEngineChannelsUsingScriptSourceCode(const String& code, bool bLock);
            std::set<EngineChannel*> GetEngineChannelsUsing(::gig::Instrument* pInstrument, bool bLock);
            std::set<Engine*> GetEnginesUsing(::gig::Instrument* pInstrument, bool bLock);
            std::set<Engine*> GetEnginesUsing(::gig::File* pFile, bool bLock);
            bool SampleReferencedByInstrument(::gig::Sample* pSample, ::gig::Instrument* pInstrument);
            void SuspendEnginesUsing(::gig::Instrument* pInstrument);
            void SuspendEnginesUsing(::gig::File* pFile);
            void ResumeAllEngines();

            Mutex InstrumentEditorProxiesMutex; ///< protects the 'InstrumentEditorProxies' map
            ArrayList<InstrumentConsumer*> InstrumentEditorProxies; ///< here we store the objects that react on instrument specific notifications on behalf of the respective instrument editor
            std::set<Engine*> suspendedEngines; ///< all engines currently completely suspended
            Mutex             suspendedEnginesMutex; ///< protects 'suspendedEngines' set
            std::map< ::gig::Script*,String> pendingScriptUpdates; ///< Used to prepare updates of instrument scripts (value of the map is the original source code of the script before it is modified).
            Mutex                            pendingScriptUpdatesMutex; ///< Protectes 'pendingScriptUpdates'.
    };

}} // namespace LinuxSampler::gig

#endif // __LS_GIG_INSTRUMENTRESOURCEMANAGER_H__
1	/***************************************************************************
2	* *
3	* LinuxSampler - modular, streaming capable sampler *
4	* *
5	* Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6	* Copyright (C) 2005 - 2017 Christian Schoenebeck *
7	* *
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	#ifndef __LS_GIG_INSTRUMENTRESOURCEMANAGER_H__
25	#define __LS_GIG_INSTRUMENTRESOURCEMANAGER_H__
26
27	#include "../../common/global.h"
28
29	#if AC_APPLE_UNIVERSAL_BUILD
30	# include <libgig/gig.h>
31	#else
32	# include <gig.h>
33	#endif
34
35	#include "../../common/Pool.h"
36	#include "../../common/ResourceManager.h"
37	#include "../InstrumentManagerBase.h"
38	#include "../../drivers/audio/AudioOutputDevice.h"
39	#include "../InstrumentManager.h"
40	#include "../../common/ArrayList.h"
41
42	//namespace libgig = gig;
43
44	namespace LinuxSampler { namespace gig {
45
46	typedef ResourceConsumer< ::gig::Instrument> InstrumentConsumer;
47
48	}} // namespace LinuxSampler::gig
49
50	#include "../../plugins/InstrumentEditor.h"
51
52	namespace LinuxSampler { namespace gig {
53
54	class Engine;
55	class EngineChannel;
56
57	/** @brief Gig instrument manager
58	*
59	* Manager to share gig instruments between multiple Gigasampler
60	* engine channels. The engine channels Borrow() instruments when they
61	* need them and HandBack() when they don't need them anymore. The
62	* InstrumentResourceManager loads the corresponding gig file and gig
63	* instrument if needed, if it's already in use by another engine
64	* channel, then it just returns the same resource, if an gig
65	* instrument / file is not needed anymore, then it will be freed from
66	* memory.
67	*/
68	class InstrumentResourceManager : public InstrumentManagerBase< ::gig::File, ::gig::Instrument, ::gig::DimensionRegion, ::gig::Sample>, public InstrumentEditorListener {
69	public:
70	InstrumentResourceManager() : Gigs(this) {}
71	virtual ~InstrumentResourceManager() {}
72	static void OnInstrumentLoadingProgress(::gig::progress_t* pProgress);
73
74	// implementation of derived abstract methods from 'InstrumentManager'
75	virtual String GetInstrumentName(instrument_id_t ID) OVERRIDE;
76	virtual String GetInstrumentDataStructureName(instrument_id_t ID) OVERRIDE;
77	virtual String GetInstrumentDataStructureVersion(instrument_id_t ID) OVERRIDE;
78	virtual InstrumentEditor* LaunchInstrumentEditor(LinuxSampler::EngineChannel* pEngineChannel, instrument_id_t ID, void* pUserData = NULL) throw (InstrumentManagerException) OVERRIDE;
79	virtual std::vector<instrument_id_t> GetInstrumentFileContent(String File) throw (InstrumentManagerException) OVERRIDE;
80	virtual instrument_info_t GetInstrumentInfo(instrument_id_t ID) throw (InstrumentManagerException) OVERRIDE;
81
82	// implementation of derived abstract methods from 'InstrumentEditorListener'
83	virtual void OnInstrumentEditorQuit(InstrumentEditor* pSender) OVERRIDE;
84	virtual void OnSamplesToBeRemoved(std::set<void> Samples, InstrumentEditor pSender) OVERRIDE;
85	virtual void OnSamplesRemoved(InstrumentEditor* pSender) OVERRIDE;
86	virtual void OnDataStructureToBeChanged(void* pStruct, String sStructType, InstrumentEditor* pSender) OVERRIDE;
87	virtual void OnDataStructureChanged(void* pStruct, String sStructType, InstrumentEditor* pSender) OVERRIDE;
88	virtual void OnSampleReferenceChanged(void* pOldSample, void* pNewSample, InstrumentEditor* pSender) OVERRIDE;
89
90	#if 0 // currently unused :
91	void TrySendNoteOnToEditors(uint8_t Key, uint8_t Velocity, ::gig::Instrument* pInstrument);
92	void TrySendNoteOffToEditors(uint8_t Key, uint8_t Velocity, ::gig::Instrument* pInstrument);
93	#endif // unused
94
95	protected:
96	// implementation of derived abstract methods from 'ResourceManager'
97	virtual ::gig::Instrument* Create(instrument_id_t Key, InstrumentConsumer* pConsumer, void*& pArg) OVERRIDE;
98	virtual void Destroy(::gig::Instrument* pResource, void* pArg) OVERRIDE;
99	virtual void DeleteRegionIfNotUsed(::gig::DimensionRegion* pRegion, region_info_t* pRegInfo) OVERRIDE;
100	virtual void DeleteSampleIfNotUsed(::gig::Sample* pSample, region_info_t* pRegInfo) OVERRIDE;
101	private:
102	void CacheInitialSamples(::gig::Sample* pSample, AbstractEngine* pEngine);
103	void CacheInitialSamples(::gig::Sample* pSample, EngineChannel* pEngineChannel);
104	void CacheInitialSamples(::gig::Sample* pSample, uint maxSamplesPerCycle);
105
106	typedef ResourceConsumer< ::gig::File> GigConsumer;
107
108	class GigResourceManager : public ResourceManager<String, ::gig::File> {
109	protected:
110	// implementation of derived abstract methods from 'ResourceManager'
111	virtual ::gig::File* Create(String Key, GigConsumer* pConsumer, void*& pArg) OVERRIDE;
112	virtual void Destroy(::gig::File* pResource, void* pArg) OVERRIDE;
113	virtual void OnBorrow(::gig::File* pResource, GigConsumer* pConsumer, void*& pArg) OVERRIDE {} // ignore
114	public:
115	GigResourceManager(InstrumentResourceManager* parent) : parent(parent) {}
116	virtual ~GigResourceManager() {}
117	private:
118	InstrumentResourceManager* parent;
119	} Gigs;
120
121	void UncacheInitialSamples(::gig::Sample* pSample);
122	std::vector< ::gig::Instrument> GetInstrumentsCurrentlyUsedOf(::gig::File pFile, bool bLock);
123	std::set<EngineChannel*> GetEngineChannelsUsingScriptSourceCode(const String& code, bool bLock);
124	std::set<EngineChannel> GetEngineChannelsUsing(::gig::Instrument pInstrument, bool bLock);
125	std::set<Engine> GetEnginesUsing(::gig::Instrument pInstrument, bool bLock);
126	std::set<Engine> GetEnginesUsing(::gig::File pFile, bool bLock);
127	bool SampleReferencedByInstrument(::gig::Sample* pSample, ::gig::Instrument* pInstrument);
128	void SuspendEnginesUsing(::gig::Instrument* pInstrument);
129	void SuspendEnginesUsing(::gig::File* pFile);
130	void ResumeAllEngines();
131
132	Mutex InstrumentEditorProxiesMutex; ///< protects the 'InstrumentEditorProxies' map
133	ArrayList<InstrumentConsumer*> InstrumentEditorProxies; ///< here we store the objects that react on instrument specific notifications on behalf of the respective instrument editor
134	std::set<Engine*> suspendedEngines; ///< all engines currently completely suspended
135	Mutex suspendedEnginesMutex; ///< protects 'suspendedEngines' set
136	std::map< ::gig::Script*,String> pendingScriptUpdates; ///< Used to prepare updates of instrument scripts (value of the map is the original source code of the script before it is modified).
137	Mutex pendingScriptUpdatesMutex; ///< Protectes 'pendingScriptUpdates'.
138	};
139
140	}} // namespace LinuxSampler::gig
141
142	#endif // __LS_GIG_INSTRUMENTRESOURCEMANAGER_H__