engines/common/Engine.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and 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 "../../drivers/audio/AudioOutputDevice.h"

namespace LinuxSampler {

    // just symbol prototyping
    class AudioOutputDevice;

    /** LinuxSampler Sampler Engine
     *
     * Abstract base class for all LinuxSampler engines.
     */
    class Engine {
        public:

            virtual ~Engine() {};

            /////////////////////////////////////////////////////////////////
            // type definitions

            /**
             * List with all currently implemented sampler engines.
             */
            enum type_t {
                type_gig
            };


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

            virtual void   PrepareLoadInstrument(const char* FileName, uint Instrument) = 0;
            virtual void   LoadInstrument() = 0;
            virtual void   Reset() = 0;
            virtual void   Enable() = 0;
            virtual void   Disable() = 0;
            virtual void   SendNoteOn(uint8_t Key, uint8_t Velocity) = 0;
            virtual void   SendNoteOff(uint8_t Key, uint8_t Velocity) = 0;
            virtual void   SendPitchbend(int Pitch) = 0;
            virtual void   SendControlChange(uint8_t Controller, uint8_t Value) = 0;
            virtual void   SendSysex(void* pData, uint Size) = 0;
            virtual float  Volume() = 0;
            virtual void   Volume(float f) = 0;
            virtual uint   Channels() = 0;
            virtual void   Connect(AudioOutputDevice* pAudioOut) = 0;
            virtual void   DisconnectAudioOutputDevice() = 0;
            virtual void   SetOutputChannel(uint EngineAudioChannel, uint AudioDeviceChannel) = 0;
            virtual int    OutputChannel(uint EngineAudioChannel) = 0;
            virtual int    RenderAudio(uint Samples) = 0;
            virtual uint   VoiceCount() = 0;
            virtual uint   VoiceCountMax() = 0;
            virtual bool   DiskStreamSupported() = 0;
            virtual uint   DiskStreamCount() = 0;
            virtual uint   DiskStreamCountMax() = 0;
            virtual String DiskStreamBufferFillBytes() = 0;
            virtual String DiskStreamBufferFillPercentage() = 0;
            virtual String Description() = 0;
            virtual String Version() = 0;
            virtual String EngineName() = 0;
            virtual String InstrumentFileName() = 0;
            virtual String InstrumentName() = 0;
            virtual int    InstrumentIndex() = 0;
            virtual int    InstrumentStatus() = 0;
    };
}

#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	* *
7	* This program is free software; you can redistribute it and/or modify *
8	* it under the terms of the GNU General Public License as published by *
9	* the Free Software Foundation; either version 2 of the License, or *
10	* (at your option) any later version. *
11	* *
12	* This program is distributed in the hope that it will be useful, *
13	* but WITHOUT ANY WARRANTY; without even the implied warranty of *
14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
15	* GNU General Public License for more details. *
16	* *
17	* You should have received a copy of the GNU General Public License *
18	* along with this program; if not, write to the Free Software *
19	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
20	* MA 02111-1307 USA *
21	***************************************************************************/
22
23	#ifndef __LS_ENGINE_H__
24	#define __LS_ENGINE_H__
25
26	#include "../../common/global.h"
27	#include "../../drivers/audio/AudioOutputDevice.h"
28
29	namespace LinuxSampler {
30
31	// just symbol prototyping
32	class AudioOutputDevice;
33
34	/** LinuxSampler Sampler Engine
35	*
36	* Abstract base class for all LinuxSampler engines.
37	*/
38	class Engine {
39	public:
40
41	virtual ~Engine() {};
42
43	/////////////////////////////////////////////////////////////////
44	// type definitions
45
46	/**
47	* List with all currently implemented sampler engines.
48	*/
49	enum type_t {
50	type_gig
51	};
52
53
54
55	/////////////////////////////////////////////////////////////////
56	// abstract methods
57	// (these have to be implemented by the descendant)
58
59	virtual void PrepareLoadInstrument(const char* FileName, uint Instrument) = 0;
60	virtual void LoadInstrument() = 0;
61	virtual void Reset() = 0;
62	virtual void Enable() = 0;
63	virtual void Disable() = 0;
64	virtual void SendNoteOn(uint8_t Key, uint8_t Velocity) = 0;
65	virtual void SendNoteOff(uint8_t Key, uint8_t Velocity) = 0;
66	virtual void SendPitchbend(int Pitch) = 0;
67	virtual void SendControlChange(uint8_t Controller, uint8_t Value) = 0;
68	virtual void SendSysex(void* pData, uint Size) = 0;
69	virtual float Volume() = 0;
70	virtual void Volume(float f) = 0;
71	virtual uint Channels() = 0;
72	virtual void Connect(AudioOutputDevice* pAudioOut) = 0;
73	virtual void DisconnectAudioOutputDevice() = 0;
74	virtual void SetOutputChannel(uint EngineAudioChannel, uint AudioDeviceChannel) = 0;
75	virtual int OutputChannel(uint EngineAudioChannel) = 0;
76	virtual int RenderAudio(uint Samples) = 0;
77	virtual uint VoiceCount() = 0;
78	virtual uint VoiceCountMax() = 0;
79	virtual bool DiskStreamSupported() = 0;
80	virtual uint DiskStreamCount() = 0;
81	virtual uint DiskStreamCountMax() = 0;
82	virtual String DiskStreamBufferFillBytes() = 0;
83	virtual String DiskStreamBufferFillPercentage() = 0;
84	virtual String Description() = 0;
85	virtual String Version() = 0;
86	virtual String EngineName() = 0;
87	virtual String InstrumentFileName() = 0;
88	virtual String InstrumentName() = 0;
89	virtual int InstrumentIndex() = 0;
90	virtual int InstrumentStatus() = 0;
91	};
92	}
93
94	#endif // __LS_ENGINE_H__