src/plugins/InstrumentEditor.h

/***************************************************************************
 *                                                                         *
 *   Copyright (C) 2007 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_INSTRUMENT_EDITOR_H
#define LS_INSTRUMENT_EDITOR_H

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

#include <set>

namespace LinuxSampler {

    // just symbol prototyping
    class InstrumentEditorListener;

    /** @brief Instrument Editor Interface (external plugin)
     *
     * LinuxSampler allows to spawn arbitrary instrument editor applications
     * within the sampler's own process. That way instrument editors are
     * able to modify already loaded instruments live or on-the-fly, that is
     * without having to load it again neither on sampler nor on editor side,
     * which is essential for editing large instruments.
     *
     * Instrument editors have to implement this abstract base class, embedded
     * into a DLL and placed into the respective sampler's library path. The
     * sampler will load these external DLLs as plugins on startup. Whenever
     * there's a request for editing an instrument, the sampler will try to
     * launch a matching registered editor, by calling the respective
     * plugin's @c Main() method.
     */
    class InstrumentEditor : protected Thread {
    public:

        /////////////////////////////////////////////////////////////////
        // abstract methods
        //     (these have to be implemented by the descendant)

        /**
         * Entry point for the instrument editor's thread. As the
         * instrument data structure is passed as typeless (void*)
         * pointer, this is not type safe! The implementing instrument
         * editor has to interpret the @a sTypeName and @a sTypeVersion
         * arguments to determine if it's able to cast the instrument
         * pointer to a known type and actually be able to work with it.
         *
         * @param pInstrument - pointer to the respective instrument object
         * @param sTypeName - format of the instrument data structure
         *                    (i.e. @c "libgig" )
         * @param sTypeVersion - version of the instrument data structure
         *                       (i.e. @c "3.0.1" ).
         */
        virtual int Main(void* pInstrument, String sTypeName, String sTypeVersion) = 0;

        /**
         * The instrument editor has to return @c true in case it supports
         * the given instrument data structure type and version, it has to
         * return @c false otherwise. This method will be called by the
         * sampler to determine which editor is capable to work with a
         * certain instrument.
         *
         * @param sTypeName - i.e. @c "libgig"
         * @param sTypeVersion - i.e. @c "3.0.1"
         */
        virtual bool IsTypeSupported(String sTypeName, String sTypeVersion) = 0;

        /**
         * The instrument editor's name (i.e. @c "gigedit" ).
         */
        virtual String Name() = 0;

        /**
         * The instrument editor's version (i.e. @c "0.0.1" ).
         */
        virtual String Version() = 0;

        /**
         * Arbitrary textual description of the instrument editor
         * (i.e. "Gigasampler and DLS format editor, GTK based").
         */
        virtual String Description() = 0;


        /////////////////////////////////////////////////////////////////
        // normal methods
        //     (usually not to be overriden by descendant)

        /** @brief Dispatch pending sample removal event.
         *
         * @e SHOULD be called by the instrument editor @e before deleting
         * samples, so the sampler can react by stopping usage of these
         * samples to avoid a crash.
         *
         * After calling this method, the instrument editor @e MUST call
         * @c NotifySamplesRemoved() after it actually deleted the samples, so
         * the sampler can react by i.e. resuming playback of sampler engines.
         *
         * @param Samples - list of samples that will be deleted by the
         *                  instrument editor
         */
        void NotifySamplesToBeRemoved(std::set<void*> Samples);

        /** @brief Dispatch completed sample removal event.
         *
         * Inform the sampler that the by @c NotifySamplesToBeRemoved()
         * previously announced samples have been deleted.
         */
        void NotifySamplesRemoved();

        /** @brief Dispatch pending data structure modification event.
         *
         * @e SHOULD be called by the instrument editor @e before modifying
         * data structures (except samples, which have their own dispatch
         * methods) which could otherwise lead to undesired synchronisation
         * issues and a crash. The respective data structure is passed as a
         * typeless pointer @a pStruct , so the instrument editor additionally
         * has to pass the name of the data structure (i.e. @c "gig::Region" ),
         * so the sampler can cast the pointer to an appropriate type. The
         * sampler will react by stopping usage of the respective data
         * structure.
         *
         * After calling this method, the instrument editor @e MUST call
         * @c NotifyDataStructureChanged() , so the sampler can react by
         * resuming usage of the respective data structure for playback.
         *
         * @param pStruct     - data structure going to be modified
         * @param sStructType - name of the data structure (i.e. its C++
         *                      struct or class name)
         */
        void NotifyDataStructureToBeChanged(void* pStruct, String sStructType);

        /** @brief Dispatch completed data structure modification event.
         *
         * Inform the sampler that the by @c NotifyDataStructureToBeChanged()
         * previously announced data structure has been completely modified.
         *
         * @param pStruct     - data structure that has been modified
         * @param sStructType - name of the data structure (i.e. its C++
         *                      struct or class name)
         */
        void NotifyDataStructureChanged(void* pStruct, String sStructType);

        /** @brief Dispatch sample reference changed event.
         *
         * @e SHOULD be called by the instrument editor @e after a certain data
         * structure changed its reference / pointer to a sample, so the
         * sampler can react by:
         *
         * - Caching the newly referenced sample if necessary.
         * - Un-caching the old referenced sample if necessary.
         *
         * @e Note: the instrument editor additionally @e MUST embed this call
         * into the respective @c NotifyDataStructureToBeChanged() and
         * @c NotifyDataStructureChanged() calls for announcing the data
         * structure whose sample reference is actually to be changed, so the
         * sampler can react by suspending usage. For example:
         * @code
         *  NotifyDataStructureToBeChanged(pDimReg, "gig::DimensionRegion");
         *  gig::Sample* pOldSample = pDimReg->pSample;
         *  pDimReg->pSample = pNewSample;
         *  NotifySampleReferenceChanged(pOldSample, pNewSample);
         *  NotifyDataStructureChanged(pDimReg, "gig::DimensionRegion");
         * @endcode
         * So calling this method alone is not safe!
         *
         * @param pOldSample - previous sample reference
         * @param pNewSample - current sample reference
         */
        void NotifySampleReferenceChanged(void* pOldSample, void* pNewSample);

        /**
         * Launch the instrument editor for the given instrument. The
         * editor will be spawned in its own thread and this method will
         * return as soon as the editor's thread actually started.
         */
        void Launch(void* pInstrument, String sTypeName, String sTypeVersion);

        /**
         * Registers object that wants to be notified on events.
         */
        void AddListener(InstrumentEditorListener* pListener);

        /**
         * Unregisters object that doesn't want to be notified anymore.
         */
        void RemoveListener(InstrumentEditorListener* pListener);

        /**
         * Constructor
         */
        InstrumentEditor();

    protected:
        std::set<InstrumentEditorListener*> listeners;

        // derived abstract method from base class 'Thread'
        virtual int Main();
    private:
        void*    pInstrument;
        String   sTypeName;
        String   sTypeVersion;
    };

    /** @brief Instrument Editor Notifications
     *
     * This abstract interface class has to be implemented by classes that
     * want to be notified on certain events of an instrument editor. This is
     * typically used on sampler side, but might also be used by an instrument
     * editor to get informed about modifications another instrument editor
     * makes.
     */
    class InstrumentEditorListener {
    public:
        /** @brief Called after the instrument editor stopped running.
         *
         * Automatically called after the instrument editor application stopped
         * running. This method has to be implemented by the descendant.
         *
         * @param pSender - instrument editor that died
         */
        virtual void OnInstrumentEditorQuit(InstrumentEditor* pSender) = 0;

        /** @brief Called before samples are to be deleted.
         *
         * See the dispatcher method
         * @c InstrumentEditor::NotifySamplesToBeRemoved() for details.
         * This method has to be implemented by the descendant.
         *
         * @param Samples - list of samples that will be deleted by the
         *                  instrument editor
         * @param pSender - instrument editor that is going to do this
         *                  modification
         */
        virtual void OnSamplesToBeRemoved(std::set<void*> Samples, InstrumentEditor* pSender) = 0;

        /** @brief  Called after samples have been deleted.
         *
         * See the dispatcher method
         * @c InstrumentEditor::NotifySamplesRemoved() for details.
         * This method has to be implemented by the descendant.
         *
         * @param pSender - instrument editor that did this modification
         */
        virtual void OnSamplesRemoved(InstrumentEditor* pSender) = 0;

        /** @brief Called before data structure is to be modified.
         *
         * See the dispatcher method
         * @c InstrumentEditor::NotifyDataStructureToBeChanged() for details.
         * This method has to be implemented by the descendant.
         *
         * @param pStruct     - data structure going to be modified
         * @param sStructType - name of the data structure (i.e. its C++
         *                      struct or class name)
         * @param pSender     - instrument editor that is going to do this
         *                      modification
         */
        virtual void OnDataStructureToBeChanged(void* pStruct, String sStructType, InstrumentEditor* pSender) = 0;

        /** @brief Called after data structure has been modified.
         *
         * See the dispatcher method
         * @c InstrumentEditor::NotifyDataStructureChanged() for details.
         * This method has to be implemented by the descendant.
         *
         * @param pStruct     - data structure that has been modified
         * @param sStructType - name of the data structure (i.e. its C++
         *                      struct or class name)
         * @param pSender     - instrument editor that did this modification
         */
        virtual void OnDataStructureChanged(void* pStruct, String sStructType, InstrumentEditor* pSender) = 0;

        /** @brief Called after some data structure changed its reference to a sample.
         *
         * @c InstrumentEditor::NotifySampleReferenceChanged() for details.
         * This method has to be implemented by the descendant.
         *
         * @param pOldSample - previous sample reference
         * @param pNewSample - current sample reference
         * @param pSender    - instrument editor that did this modification
         */
        virtual void OnSampleReferenceChanged(void* pOldSample, void* pNewSample, InstrumentEditor* pSender) = 0;
    };

} // namespace LinuxSampler

#endif // LS_INSTRUMENT_EDITOR_H
1	schoenebeck	1374	/***************************************************************************
2			* *
3			* Copyright (C) 2007 Christian Schoenebeck *
4			* *
5			* This program is free software; you can redistribute it and/or modify *
6			* it under the terms of the GNU General Public License as published by *
7			* the Free Software Foundation; either version 2 of the License, or *
8			* (at your option) any later version. *
9			* *
10			* This program is distributed in the hope that it will be useful, *
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of *
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13			* GNU General Public License for more details. *
14			* *
15			* You should have received a copy of the GNU General Public License *
16			* along with this program; if not, write to the Free Software *
17			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
18			* MA 02111-1307 USA *
19			***************************************************************************/
20
21			#ifndef LS_INSTRUMENT_EDITOR_H
22			#define LS_INSTRUMENT_EDITOR_H
23
24			#include "../common/global.h"
25			#include "../common/Thread.h"
26
27			#include <set>
28
29			namespace LinuxSampler {
30
31			// just symbol prototyping
32			class InstrumentEditorListener;
33
34			/** @brief Instrument Editor Interface (external plugin)
35			*
36			* LinuxSampler allows to spawn arbitrary instrument editor applications
37			* within the sampler's own process. That way instrument editors are
38			* able to modify already loaded instruments live or on-the-fly, that is
39			* without having to load it again neither on sampler nor on editor side,
40			* which is essential for editing large instruments.
41			*
42			* Instrument editors have to implement this abstract base class, embedded
43			* into a DLL and placed into the respective sampler's library path. The
44			* sampler will load these external DLLs as plugins on startup. Whenever
45			* there's a request for editing an instrument, the sampler will try to
46			* launch a matching registered editor, by calling the respective
47			* plugin's @c Main() method.
48			*/
49			class InstrumentEditor : protected Thread {
50			public:
51
52			/////////////////////////////////////////////////////////////////
53			// abstract methods
54			// (these have to be implemented by the descendant)
55
56			/**
57			* Entry point for the instrument editor's thread. As the
58			* instrument data structure is passed as typeless (void*)
59			* pointer, this is not type safe! The implementing instrument
60			* editor has to interpret the @a sTypeName and @a sTypeVersion
61			* arguments to determine if it's able to cast the instrument
62			* pointer to a known type and actually be able to work with it.
63			*
64			* @param pInstrument - pointer to the respective instrument object
65			* @param sTypeName - format of the instrument data structure
66			* (i.e. @c "libgig" )
67			* @param sTypeVersion - version of the instrument data structure
68			* (i.e. @c "3.0.1" ).
69			*/
70			virtual int Main(void* pInstrument, String sTypeName, String sTypeVersion) = 0;
71
72			/**
73			* The instrument editor has to return @c true in case it supports
74			* the given instrument data structure type and version, it has to
75			* return @c false otherwise. This method will be called by the
76			* sampler to determine which editor is capable to work with a
77			* certain instrument.
78			*
79			* @param sTypeName - i.e. @c "libgig"
80	schoenebeck	1425	* @param sTypeVersion - i.e. @c "3.0.1"
81	schoenebeck	1374	*/
82			virtual bool IsTypeSupported(String sTypeName, String sTypeVersion) = 0;
83
84			/**
85			* The instrument editor's name (i.e. @c "gigedit" ).
86			*/
87			virtual String Name() = 0;
88
89			/**
90			* The instrument editor's version (i.e. @c "0.0.1" ).
91			*/
92			virtual String Version() = 0;
93
94			/**
95			* Arbitrary textual description of the instrument editor
96			* (i.e. "Gigasampler and DLS format editor, GTK based").
97			*/
98			virtual String Description() = 0;
99
100
101
102			/////////////////////////////////////////////////////////////////
103			// normal methods
104			// (usually not to be overriden by descendant)
105
106			/** @brief Dispatch pending sample removal event.
107			*
108			* @e SHOULD be called by the instrument editor @e before deleting
109			* samples, so the sampler can react by stopping usage of these
110			* samples to avoid a crash.
111			*
112			* After calling this method, the instrument editor @e MUST call
113			* @c NotifySamplesRemoved() after it actually deleted the samples, so
114			* the sampler can react by i.e. resuming playback of sampler engines.
115			*
116			* @param Samples - list of samples that will be deleted by the
117			* instrument editor
118			*/
119			void NotifySamplesToBeRemoved(std::set<void*> Samples);
120
121			/** @brief Dispatch completed sample removal event.
122			*
123			* Inform the sampler that the by @c NotifySamplesToBeRemoved()
124			* previously announced samples have been deleted.
125			*/
126			void NotifySamplesRemoved();
127
128			/** @brief Dispatch pending data structure modification event.
129			*
130			* @e SHOULD be called by the instrument editor @e before modifying
131			* data structures (except samples, which have their own dispatch
132			* methods) which could otherwise lead to undesired synchronisation
133			* issues and a crash. The respective data structure is passed as a
134			* typeless pointer @a pStruct , so the instrument editor additionally
135			* has to pass the name of the data structure (i.e. @c "gig::Region" ),
136			* so the sampler can cast the pointer to an appropriate type. The
137			* sampler will react by stopping usage of the respective data
138			* structure.
139			*
140			* After calling this method, the instrument editor @e MUST call
141			* @c NotifyDataStructureChanged() , so the sampler can react by
142			* resuming usage of the respective data structure for playback.
143			*
144			* @param pStruct - data structure going to be modified
145			* @param sStructType - name of the data structure (i.e. its C++
146			* struct or class name)
147			*/
148			void NotifyDataStructureToBeChanged(void* pStruct, String sStructType);
149
150			/** @brief Dispatch completed data structure modification event.
151			*
152			* Inform the sampler that the by @c NotifyDataStructureToBeChanged()
153			* previously announced data structure has been completely modified.
154			*
155			* @param pStruct - data structure that has been modified
156			* @param sStructType - name of the data structure (i.e. its C++
157			* struct or class name)
158			*/
159			void NotifyDataStructureChanged(void* pStruct, String sStructType);
160
161			/** @brief Dispatch sample reference changed event.
162			*
163			* @e SHOULD be called by the instrument editor @e after a certain data
164			* structure changed its reference / pointer to a sample, so the
165			* sampler can react by:
166			*
167			* - Caching the newly referenced sample if necessary.
168			* - Un-caching the old referenced sample if necessary.
169			*
170			* @e Note: the instrument editor additionally @e MUST embed this call
171			* into the respective @c NotifyDataStructureToBeChanged() and
172			* @c NotifyDataStructureChanged() calls for announcing the data
173			* structure whose sample reference is actually to be changed, so the
174			* sampler can react by suspending usage. For example:
175			* @code
176			* NotifyDataStructureToBeChanged(pDimReg, "gig::DimensionRegion");
177			* gig::Sample* pOldSample = pDimReg->pSample;
178			* pDimReg->pSample = pNewSample;
179			* NotifySampleReferenceChanged(pOldSample, pNewSample);
180			* NotifyDataStructureChanged(pDimReg, "gig::DimensionRegion");
181			* @endcode
182			* So calling this method alone is not safe!
183			*
184			* @param pOldSample - previous sample reference
185			* @param pNewSample - current sample reference
186			*/
187			void NotifySampleReferenceChanged(void* pOldSample, void* pNewSample);
188
189			/**
190			* Launch the instrument editor for the given instrument. The
191			* editor will be spawned in its own thread and this method will
192			* return as soon as the editor's thread actually started.
193			*/
194			void Launch(void* pInstrument, String sTypeName, String sTypeVersion);
195
196			/**
197			* Registers object that wants to be notified on events.
198			*/
199			void AddListener(InstrumentEditorListener* pListener);
200
201			/**
202			* Unregisters object that doesn't want to be notified anymore.
203			*/
204			void RemoveListener(InstrumentEditorListener* pListener);
205
206			/**
207			* Constructor
208			*/
209			InstrumentEditor();
210
211			protected:
212			std::set<InstrumentEditorListener*> listeners;
213
214			// derived abstract method from base class 'Thread'
215			virtual int Main();
216			private:
217			void* pInstrument;
218			String sTypeName;
219			String sTypeVersion;
220			};
221
222			/** @brief Instrument Editor Notifications
223			*
224			* This abstract interface class has to be implemented by classes that
225			* want to be notified on certain events of an instrument editor. This is
226			* typically used on sampler side, but might also be used by an instrument
227			* editor to get informed about modifications another instrument editor
228			* makes.
229			*/
230			class InstrumentEditorListener {
231			public:
232			/** @brief Called after the instrument editor stopped running.
233			*
234			* Automatically called after the instrument editor application stopped
235			* running. This method has to be implemented by the descendant.
236			*
237			* @param pSender - instrument editor that died
238			*/
239			virtual void OnInstrumentEditorQuit(InstrumentEditor* pSender) = 0;
240
241			/** @brief Called before samples are to be deleted.
242			*
243			* See the dispatcher method
244			* @c InstrumentEditor::NotifySamplesToBeRemoved() for details.
245			* This method has to be implemented by the descendant.
246			*
247			* @param Samples - list of samples that will be deleted by the
248			* instrument editor
249			* @param pSender - instrument editor that is going to do this
250			* modification
251			*/
252			virtual void OnSamplesToBeRemoved(std::set<void> Samples, InstrumentEditor pSender) = 0;
253
254			/** @brief Called after samples have been deleted.
255			*
256			* See the dispatcher method
257			* @c InstrumentEditor::NotifySamplesRemoved() for details.
258			* This method has to be implemented by the descendant.
259			*
260			* @param pSender - instrument editor that did this modification
261			*/
262			virtual void OnSamplesRemoved(InstrumentEditor* pSender) = 0;
263
264			/** @brief Called before data structure is to be modified.
265			*
266			* See the dispatcher method
267			* @c InstrumentEditor::NotifyDataStructureToBeChanged() for details.
268			* This method has to be implemented by the descendant.
269			*
270			* @param pStruct - data structure going to be modified
271			* @param sStructType - name of the data structure (i.e. its C++
272			* struct or class name)
273			* @param pSender - instrument editor that is going to do this
274			* modification
275			*/
276			virtual void OnDataStructureToBeChanged(void* pStruct, String sStructType, InstrumentEditor* pSender) = 0;
277
278			/** @brief Called after data structure has been modified.
279			*
280			* See the dispatcher method
281			* @c InstrumentEditor::NotifyDataStructureChanged() for details.
282			* This method has to be implemented by the descendant.
283			*
284			* @param pStruct - data structure that has been modified
285			* @param sStructType - name of the data structure (i.e. its C++
286			* struct or class name)
287			* @param pSender - instrument editor that did this modification
288			*/
289			virtual void OnDataStructureChanged(void* pStruct, String sStructType, InstrumentEditor* pSender) = 0;
290
291			/** @brief Called after some data structure changed its reference to a sample.
292			*
293			* @c InstrumentEditor::NotifySampleReferenceChanged() for details.
294			* This method has to be implemented by the descendant.
295			*
296			* @param pOldSample - previous sample reference
297			* @param pNewSample - current sample reference
298			* @param pSender - instrument editor that did this modification
299			*/
300			virtual void OnSampleReferenceChanged(void* pOldSample, void* pNewSample, InstrumentEditor* pSender) = 0;
301			};
302
303			} // namespace LinuxSampler
304
305			#endif // LS_INSTRUMENT_EDITOR_H