1 |
/*************************************************************************** |
2 |
* * |
3 |
* LinuxSampler - modular, streaming capable sampler * |
4 |
* * |
5 |
* Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck * |
6 |
* Copyright (C) 2005 - 2012 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 |
class Engine; |
50 |
class EngineChannel; |
51 |
|
52 |
/** @brief Gig instrument manager |
53 |
* |
54 |
* Manager to share gig instruments between multiple Gigasampler |
55 |
* engine channels. The engine channels Borrow() instruments when they |
56 |
* need them and HandBack() when they don't need them anymore. The |
57 |
* InstrumentResourceManager loads the corresponding gig file and gig |
58 |
* 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 |
* instrument / file is not needed anymore, then it will be freed from |
61 |
* memory. |
62 |
*/ |
63 |
class InstrumentResourceManager : public InstrumentManagerBase< ::gig::File, ::gig::Instrument, ::gig::DimensionRegion, ::gig::Sample>, public InstrumentEditorListener { |
64 |
public: |
65 |
InstrumentResourceManager() : Gigs(this) {} |
66 |
virtual ~InstrumentResourceManager() {} |
67 |
static void OnInstrumentLoadingProgress(::gig::progress_t* pProgress); |
68 |
|
69 |
// implementation of derived abstract methods from 'InstrumentManager' |
70 |
virtual String GetInstrumentName(instrument_id_t ID); |
71 |
virtual String GetInstrumentDataStructureName(instrument_id_t ID); |
72 |
virtual String GetInstrumentDataStructureVersion(instrument_id_t ID); |
73 |
virtual InstrumentEditor* LaunchInstrumentEditor(instrument_id_t ID, void* pUserData = NULL) throw (InstrumentManagerException); |
74 |
virtual std::vector<instrument_id_t> GetInstrumentFileContent(String File) throw (InstrumentManagerException); |
75 |
virtual instrument_info_t GetInstrumentInfo(instrument_id_t ID) throw (InstrumentManagerException); |
76 |
|
77 |
// implementation of derived abstract methods from 'InstrumentEditorListener' |
78 |
virtual void OnInstrumentEditorQuit(InstrumentEditor* pSender); |
79 |
virtual void OnSamplesToBeRemoved(std::set<void*> Samples, InstrumentEditor* pSender); |
80 |
virtual void OnSamplesRemoved(InstrumentEditor* pSender); |
81 |
virtual void OnDataStructureToBeChanged(void* pStruct, String sStructType, InstrumentEditor* pSender); |
82 |
virtual void OnDataStructureChanged(void* pStruct, String sStructType, InstrumentEditor* pSender); |
83 |
virtual void OnSampleReferenceChanged(void* pOldSample, void* pNewSample, InstrumentEditor* pSender); |
84 |
|
85 |
#if 0 // currently unused : |
86 |
void TrySendNoteOnToEditors(uint8_t Key, uint8_t Velocity, ::gig::Instrument* pInstrument); |
87 |
void TrySendNoteOffToEditors(uint8_t Key, uint8_t Velocity, ::gig::Instrument* pInstrument); |
88 |
#endif // unused |
89 |
|
90 |
protected: |
91 |
// implementation of derived abstract methods from 'ResourceManager' |
92 |
virtual ::gig::Instrument* Create(instrument_id_t Key, InstrumentConsumer* pConsumer, void*& pArg); |
93 |
virtual void Destroy(::gig::Instrument* pResource, void* pArg); |
94 |
virtual void DeleteRegionIfNotUsed(::gig::DimensionRegion* pRegion, region_info_t* pRegInfo); |
95 |
virtual void DeleteSampleIfNotUsed(::gig::Sample* pSample, region_info_t* pRegInfo); |
96 |
private: |
97 |
void CacheInitialSamples(::gig::Sample* pSample, AbstractEngine* pEngine); |
98 |
void CacheInitialSamples(::gig::Sample* pSample, EngineChannel* pEngineChannel); |
99 |
void CacheInitialSamples(::gig::Sample* pSample, uint maxSamplesPerCycle); |
100 |
|
101 |
typedef ResourceConsumer< ::gig::File> GigConsumer; |
102 |
|
103 |
class GigResourceManager : public ResourceManager<String, ::gig::File> { |
104 |
protected: |
105 |
// implementation of derived abstract methods from 'ResourceManager' |
106 |
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 |
public: |
110 |
GigResourceManager(InstrumentResourceManager* parent) : parent(parent) {} |
111 |
virtual ~GigResourceManager() {} |
112 |
private: |
113 |
InstrumentResourceManager* parent; |
114 |
} Gigs; |
115 |
|
116 |
void UncacheInitialSamples(::gig::Sample* pSample); |
117 |
std::vector< ::gig::Instrument*> GetInstrumentsCurrentlyUsedOf(::gig::File* pFile, bool bLock); |
118 |
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 |
bool SampleReferencedByInstrument(::gig::Sample* pSample, ::gig::Instrument* pInstrument); |
122 |
void SuspendEnginesUsing(::gig::Instrument* pInstrument); |
123 |
void SuspendEnginesUsing(::gig::File* pFile); |
124 |
void ResumeAllEngines(); |
125 |
|
126 |
Mutex InstrumentEditorProxiesMutex; ///< protects the 'InstrumentEditorProxies' map |
127 |
ArrayList<InstrumentConsumer*> InstrumentEditorProxies; ///< here we store the objects that react on instrument specific notifications on behalf of the respective instrument editor |
128 |
std::set<Engine*> suspendedEngines; ///< all engines currently completely suspended |
129 |
Mutex suspendedEnginesMutex; ///< protects 'suspendedEngines' set |
130 |
}; |
131 |
|
132 |
}} // namespace LinuxSampler::gig |
133 |
|
134 |
#endif // __LS_GIG_INSTRUMENTRESOURCEMANAGER_H__ |