engines/gig/InstrumentResourceManager.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
 *   Copyright (C) 2005 - 2009 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 std::vector<instrument_id_t> Instruments();
            virtual String GetInstrumentName(instrument_id_t ID);
            virtual String GetInstrumentDataStructureName(instrument_id_t ID);
            virtual String GetInstrumentDataStructureVersion(instrument_id_t ID);
            virtual InstrumentEditor* LaunchInstrumentEditor(instrument_id_t ID, void* pUserData = NULL) throw (InstrumentManagerException);
            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               OnBorrow(::gig::Instrument* pResource, InstrumentConsumer* pConsumer, void*& pArg);
            virtual void               CacheInitialSamples(::gig::Sample* pSample, AbstractEngine* pEngine);
            virtual void               CacheInitialSamples(::gig::Sample* pSample, EngineChannel* pEngineChannel);
            virtual void               DeleteRegionIfNotUsed(::gig::DimensionRegion* pRegion, region_info_t* pRegInfo);
            virtual void               DeleteSampleIfNotUsed(::gig::Sample* pSample, region_info_t* pRegInfo);
        private:
            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*> 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
    };

}} // namespace LinuxSampler::gig

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