engines/gig/InstrumentResourceManager.h

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

#include <gig.h>

#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);
            virtual String GetInstrumentDataStructureName(instrument_id_t ID);
            virtual String GetInstrumentDataStructureVersion(instrument_id_t ID);
            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);
            virtual instrument_info_t GetInstrumentInfo(instrument_id_t ID) throw (InstrumentManagerException);

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

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