engines/gig/InstrumentResourceManager.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
 *   Copyright (C) 2005, 2006 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/global.h"
#include "../../common/Exception.h"
#include "../../common/ResourceManager.h"
#include "../../drivers/audio/AudioOutputDevice.h"
#include "../InstrumentManager.h"

//namespace libgig = gig;

namespace LinuxSampler { namespace gig {

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

}} // namespace LinuxSampler::gig

#include "EngineChannel.h"
#include "Engine.h"

namespace LinuxSampler { namespace gig {

    // just symbol prototyping
    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 InstrumentManager, public ResourceManager<InstrumentManager::instrument_id_t, ::gig::Instrument> {
        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 InstrumentManager::mode_t GetMode(const instrument_id_t& ID);
            virtual void SetMode(const instrument_id_t& ID, InstrumentManager::mode_t Mode);
            virtual String GetInstrumentName(instrument_id_t ID);

            void HandBackInstrument(::gig::Instrument* pResource, InstrumentConsumer* pConsumer,
                                    ::gig::DimensionRegion** dimRegionsInUse);
            void HandBackDimReg(::gig::DimensionRegion* pDimReg);

        protected:
            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);
        private:
            typedef ResourceConsumer< ::gig::File> GigConsumer;

            class GigResourceManager : public ResourceManager<String, ::gig::File> {
                protected:
                    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 CacheInitialSamples(::gig::Sample* pSample, gig::EngineChannel* pEngineChannel);

            struct dimreg_info_t {
                int           refCount;
                ::gig::File*  file;
                ::RIFF::File* riff;
            };
            Mutex DimRegInfoMutex; ///< protects the DimRegInfo and SampleRefCount maps from concurrent access by the instrument loader and disk threads
            std::map< ::gig::DimensionRegion*, dimreg_info_t> DimRegInfo; ///< contains dimension regions that are still in use but belong to released instrument
            std::map< ::gig::Sample*, int> SampleRefCount; ///< contains samples that are still in use but belong to a released instrument
    };

    /**
     * Will be thrown by the InstrumentResourceManager on errors.
     */
    class InstrumentResourceManagerException : public Exception {
        public:
            InstrumentResourceManagerException(String msg) : Exception(msg) {}
    };

}} // 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, 2006 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/global.h"
32	#include "../../common/Exception.h"
33	#include "../../common/ResourceManager.h"
34	#include "../../drivers/audio/AudioOutputDevice.h"
35	#include "../InstrumentManager.h"
36
37	//namespace libgig = gig;
38
39	namespace LinuxSampler { namespace gig {
40
41	typedef ResourceConsumer< ::gig::Instrument> InstrumentConsumer;
42
43	}} // namespace LinuxSampler::gig
44
45	#include "EngineChannel.h"
46	#include "Engine.h"
47
48	namespace LinuxSampler { namespace gig {
49
50	// just symbol prototyping
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 InstrumentManager, public ResourceManager<InstrumentManager::instrument_id_t, ::gig::Instrument> {
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 std::vector<instrument_id_t> Instruments();
72	virtual InstrumentManager::mode_t GetMode(const instrument_id_t& ID);
73	virtual void SetMode(const instrument_id_t& ID, InstrumentManager::mode_t Mode);
74	virtual String GetInstrumentName(instrument_id_t ID);
75
76	void HandBackInstrument(::gig::Instrument* pResource, InstrumentConsumer* pConsumer,
77	::gig::DimensionRegion** dimRegionsInUse);
78	void HandBackDimReg(::gig::DimensionRegion* pDimReg);
79
80	protected:
81	virtual ::gig::Instrument* Create(instrument_id_t Key, InstrumentConsumer* pConsumer, void*& pArg);
82	virtual void Destroy(::gig::Instrument* pResource, void* pArg);
83	virtual void OnBorrow(::gig::Instrument* pResource, InstrumentConsumer* pConsumer, void*& pArg);
84	private:
85	typedef ResourceConsumer< ::gig::File> GigConsumer;
86
87	class GigResourceManager : public ResourceManager<String, ::gig::File> {
88	protected:
89	virtual ::gig::File* Create(String Key, GigConsumer* pConsumer, void*& pArg);
90	virtual void Destroy(::gig::File* pResource, void* pArg);
91	virtual void OnBorrow(::gig::File* pResource, GigConsumer* pConsumer, void*& pArg) {} // ignore
92	public:
93	GigResourceManager(InstrumentResourceManager* parent) : parent(parent) {}
94	virtual ~GigResourceManager() {}
95	private:
96	InstrumentResourceManager* parent;
97	} Gigs;
98
99	void CacheInitialSamples(::gig::Sample* pSample, gig::EngineChannel* pEngineChannel);
100
101	struct dimreg_info_t {
102	int refCount;
103	::gig::File* file;
104	::RIFF::File* riff;
105	};
106	Mutex DimRegInfoMutex; ///< protects the DimRegInfo and SampleRefCount maps from concurrent access by the instrument loader and disk threads
107	std::map< ::gig::DimensionRegion*, dimreg_info_t> DimRegInfo; ///< contains dimension regions that are still in use but belong to released instrument
108	std::map< ::gig::Sample*, int> SampleRefCount; ///< contains samples that are still in use but belong to a released instrument
109	};
110
111	/**
112	* Will be thrown by the InstrumentResourceManager on errors.
113	*/
114	class InstrumentResourceManagerException : public Exception {
115	public:
116	InstrumentResourceManagerException(String msg) : Exception(msg) {}
117	};
118
119	}} // namespace LinuxSampler::gig
120
121	#endif // __LS_GIG_INSTRUMENTRESOURCEMANAGER_H__