src/engines/Engine.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003,2004 by Benno Senoner and Christian Schoenebeck    *
 *   Copyright (C) 2005-2013 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_ENGINE_H__
#define __LS_ENGINE_H__

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

namespace LinuxSampler {

    // just symbol prototyping
    class MidiInputPort;

    /** @brief LinuxSampler Sampler Engine Interface
     *
     * Abstract base interface class for all LinuxSampler engines which
     * defines all mandatory methods which have to be implemented by all
     * sampler engine implementations.
     */
    class Engine {
        public:

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

            virtual int    RenderAudio(uint Samples) = 0;
            virtual void   SendSysex(void* pData, uint Size, MidiInputPort* pSender) = 0;
            virtual void   Reset() = 0;
            virtual void   Enable() = 0;
            virtual void   Disable() = 0;
            virtual uint   VoiceCount() = 0;
            virtual uint   VoiceCountMax() = 0;
            virtual int    MaxVoices() = 0;
            virtual void   SetMaxVoices(int iVoices) throw (Exception) = 0;
            virtual bool   DiskStreamSupported() = 0;
            virtual uint   DiskStreamCount() = 0;
            virtual uint   DiskStreamCountMax() = 0;
            virtual int    MaxDiskStreams() = 0;
            virtual void   SetMaxDiskStreams(int iStreams) throw (Exception) = 0;
            virtual String DiskStreamBufferFillBytes() = 0;
            virtual String DiskStreamBufferFillPercentage() = 0;
            virtual String Description() = 0;
            virtual String Version() = 0;
            virtual String EngineName() = 0;

            /**
             * Returns pointer to the Engine's InstrumentManager or NULL if
             * the Engine does not provide an InstrumentManager.
             *
             * <b>Important:</b> All engine instances of the same engine
             * type have to return the same InstrumentManager, that is all
             * instances of the same engine type have to share one and
             * the same InstrumentManager object.
             */
            virtual InstrumentManager* GetInstrumentManager() = 0;
        
            /**
             * Will be called by audio output drivers in case some
             * fundamental audio driver parameter like sample rate or
             * max. samples per cycle changed.
             */
            virtual void ReconnectAudioOutputDevice() = 0;
            
            /**
             * Modifies the scale tuning from standard well tempered chromatic
             * scaling to any other kind of scaling.
             * 
             * ScaleTunes - detune factors (-64..+63 cents) for all 12
             *              semitones of an octave
             */
            virtual void AdjustScaleTuning(const int8_t ScaleTunes[12]) = 0;
            
            /**
             * Expects a byte array with 12 elements as argument @a pScaleTunes,
             * where the currently effectve scale tuning setup is written to.
             *
             * pScaleTunes - output: detune factors (-64..+63 cents) for all 12
             *               semitones of an octave
             */
            virtual void GetScaleTuning(int8_t* pScaleTunes) = 0;
            
            /**
             * Reset to standard well tempered chromatic scaling, i.e. after
             * being altered with AdjustScaleTuning() or after having sent the
             * respective standard scale tuning SysEx MIDI message.
             */
            virtual void ResetScaleTuning() = 0;

        protected:
            virtual ~Engine() {}; // MUST only be destroyed by EngineFactory
            void Unregister();    // Remove self from EngineFactory.
            friend class EngineFactory;
    };

} // namespace LinuxSampler

#endif // __LS_ENGINE_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-2013 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_ENGINE_H__
25	#define __LS_ENGINE_H__
26
27	#include "../common/global.h"
28	#include "InstrumentManager.h"
29
30	namespace LinuxSampler {
31
32	// just symbol prototyping
33	class MidiInputPort;
34
35	/** @brief LinuxSampler Sampler Engine Interface
36	*
37	* Abstract base interface class for all LinuxSampler engines which
38	* defines all mandatory methods which have to be implemented by all
39	* sampler engine implementations.
40	*/
41	class Engine {
42	public:
43
44	/////////////////////////////////////////////////////////////////
45	// abstract methods
46	// (these have to be implemented by the descendant)
47
48	virtual int RenderAudio(uint Samples) = 0;
49	virtual void SendSysex(void* pData, uint Size, MidiInputPort* pSender) = 0;
50	virtual void Reset() = 0;
51	virtual void Enable() = 0;
52	virtual void Disable() = 0;
53	virtual uint VoiceCount() = 0;
54	virtual uint VoiceCountMax() = 0;
55	virtual int MaxVoices() = 0;
56	virtual void SetMaxVoices(int iVoices) throw (Exception) = 0;
57	virtual bool DiskStreamSupported() = 0;
58	virtual uint DiskStreamCount() = 0;
59	virtual uint DiskStreamCountMax() = 0;
60	virtual int MaxDiskStreams() = 0;
61	virtual void SetMaxDiskStreams(int iStreams) throw (Exception) = 0;
62	virtual String DiskStreamBufferFillBytes() = 0;
63	virtual String DiskStreamBufferFillPercentage() = 0;
64	virtual String Description() = 0;
65	virtual String Version() = 0;
66	virtual String EngineName() = 0;
67
68	/**
69	* Returns pointer to the Engine's InstrumentManager or NULL if
70	* the Engine does not provide an InstrumentManager.
71	*
72	* <b>Important:</b> All engine instances of the same engine
73	* type have to return the same InstrumentManager, that is all
74	* instances of the same engine type have to share one and
75	* the same InstrumentManager object.
76	*/
77	virtual InstrumentManager* GetInstrumentManager() = 0;
78
79	/**
80	* Will be called by audio output drivers in case some
81	* fundamental audio driver parameter like sample rate or
82	* max. samples per cycle changed.
83	*/
84	virtual void ReconnectAudioOutputDevice() = 0;
85
86	/**
87	* Modifies the scale tuning from standard well tempered chromatic
88	* scaling to any other kind of scaling.
89	*
90	* ScaleTunes - detune factors (-64..+63 cents) for all 12
91	* semitones of an octave
92	*/
93	virtual void AdjustScaleTuning(const int8_t ScaleTunes[12]) = 0;
94
95	/**
96	* Expects a byte array with 12 elements as argument @a pScaleTunes,
97	* where the currently effectve scale tuning setup is written to.
98	*
99	* pScaleTunes - output: detune factors (-64..+63 cents) for all 12
100	* semitones of an octave
101	*/
102	virtual void GetScaleTuning(int8_t* pScaleTunes) = 0;
103
104	/**
105	* Reset to standard well tempered chromatic scaling, i.e. after
106	* being altered with AdjustScaleTuning() or after having sent the
107	* respective standard scale tuning SysEx MIDI message.
108	*/
109	virtual void ResetScaleTuning() = 0;
110
111	protected:
112	virtual ~Engine() {}; // MUST only be destroyed by EngineFactory
113	void Unregister(); // Remove self from EngineFactory.
114	friend class EngineFactory;
115	};
116
117	} // namespace LinuxSampler
118
119	#endif // __LS_ENGINE_H__