src/engines/EngineChannelFactory.h

/***************************************************************************
 *                                                                         *
 *   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_ENGINECHANNELFACTORY_H__
#define __LS_ENGINECHANNELFACTORY_H__

#include <set>

#include "EngineChannel.h"

namespace LinuxSampler {

    /** @brief Manages EngineChannel instances.
     *
     * This class is used to create and destroy EngineChannel instances of the
     * various engine types supported by this sampler. It's basically used to
     * avoid dependencies to palpable sampler engine types /
     * implementations.
     */
    class EngineChannelFactory {
        public:
            /**
             * Create EngineChannel instance of given engine type.
             *
             * @see EngineFactory::AvailableEngineTypes()
             */
            static EngineChannel* Create(String EngineType) throw (Exception);

            /**
             * Destroy given EngineChannel instance.
             */
            static void Destroy(EngineChannel* pEngineChannel);

            /**
             * Returns all EngineChannel instances.
             */
            static const std::set<EngineChannel*>& EngineChannelInstances();

            /**
             * Specifies whether the deallocation of the specified EngineChannel
             * object should be postponed. When the object deletion is diabled
             * it is not freed from memory (when destroyed) until it is enabled.
             * Used to prevent orphaned pointers.
             */
            static void SetDeleteEnabled(const EngineChannel* pEngineChannel, bool enable);

        private:
            static Mutex LockedChannelsMutex;
    };

} // namespace LinuxSampler

#endif // __LS_ENGINECHANNELFACTORY_H__
1	/***************************************************************************
2	* *
3	* Copyright (C) 2005, 2006 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_ENGINECHANNELFACTORY_H__
22	#define __LS_ENGINECHANNELFACTORY_H__
23
24	#include <set>
25
26	#include "EngineChannel.h"
27
28	namespace LinuxSampler {
29
30	/** @brief Manages EngineChannel instances.
31	*
32	* This class is used to create and destroy EngineChannel instances of the
33	* various engine types supported by this sampler. It's basically used to
34	* avoid dependencies to palpable sampler engine types /
35	* implementations.
36	*/
37	class EngineChannelFactory {
38	public:
39	/**
40	* Create EngineChannel instance of given engine type.
41	*
42	* @see EngineFactory::AvailableEngineTypes()
43	*/
44	static EngineChannel* Create(String EngineType) throw (Exception);
45
46	/**
47	* Destroy given EngineChannel instance.
48	*/
49	static void Destroy(EngineChannel* pEngineChannel);
50
51	/**
52	* Returns all EngineChannel instances.
53	*/
54	static const std::set<EngineChannel*>& EngineChannelInstances();
55
56	/**
57	* Specifies whether the deallocation of the specified EngineChannel
58	* object should be postponed. When the object deletion is diabled
59	* it is not freed from memory (when destroyed) until it is enabled.
60	* Used to prevent orphaned pointers.
61	*/
62	static void SetDeleteEnabled(const EngineChannel* pEngineChannel, bool enable);
63
64	private:
65	static Mutex LockedChannelsMutex;
66	};
67
68	} // namespace LinuxSampler
69
70	#endif // __LS_ENGINECHANNELFACTORY_H__