scummvm/sound/mididrv.h
James Brown 9809c86373 Add boilerplate license to some files, to satisfy Debian types :)
fmopl.c/fmopl.h are infringing on the GPL at the moment. We either need to
replace these, or get permission to relicense them, before 0.2.0

svn-id: r4036
2002-04-21 17:46:42 +00:00

122 lines
3.0 KiB
C++

/* ScummVM - Scumm Interpreter
* Copyright (C) 2001 Ludvig Strigeus
* Copyright (C) 2001/2002 The ScummVM project
*
* 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.
*
* $Header$
*
*/
struct MidiEvent {
uint32 delta;
uint32 event;
};
/* Lowlevel Abstract Midi Driver Class */
class MidiDriver {
public:
/* called whenever the midi driver is in streaming mode,
* and more midi commands need to be generated
* return 0 to tell the mididriver that the end of stream was reached
*/
typedef int StreamCallback(void *param, MidiEvent *ev, int num);
/* open modes, pass one of those to open() */
enum {
MO_SIMPLE = 1,
MO_STREAMING = 2,
};
/* Special events that can be inserted in a MidiEvent.
* event = (ME_xxx<<24) | <24-bit data associated with event>
*/
enum {
ME_NONE = 0,
ME_TEMPO = 1,
};
/* error codes returned by open.
* can be converted to a string with get_error_name()
*/
enum {
MERR_CANNOT_CONNECT = 1,
MERR_STREAMING_NOT_AVAILABLE = 2,
MERR_DEVICE_NOT_AVAILABLE = 3,
MERR_ALREADY_OPEN = 4,
};
enum {
PROP_TIMEDIV = 1,
};
/* destroy the midi object */
virtual void destroy() = 0;
/* open the midi driver.
* returns 0 if successful.
* otherwise an error code. */
virtual int open(int mode) = 0;
/* close the midi driver */
virtual void close() = 0;
/* output a packed midi command to the midi stream
* valid only if mode is MO_SIMPLE
*/
virtual void send(uint32 b) = 0;
/* set callback when more streams need to be generated.
* valid only when mode==MO_STREAMING
*/
virtual void set_stream_callback(void *param, StreamCallback *sc) = 0;
/* Pause or resume streaming MIDI */
virtual void pause(bool pause) = 0;
/* Get or set a property */
virtual uint32 property(int prop, uint32 param) = 0;
/* retrieve a string representation of an error code */
static const char *get_error_name(int error_code);
};
/* driver types */
enum {
MD_AUTO = 0,
MD_NULL = 1,
MD_WINDOWS = 2,
MD_TIMIDITY = 3,
MD_SEQ = 4,
MD_QTMUSIC = 5,
MD_AMIDI = 6,
};
/* Factory functions => no need to include the specific classes
* in this header => faster compile */
MidiDriver *MidiDriver_NULL_create();
MidiDriver *MidiDriver_WIN_create();
MidiDriver *MidiDriver_TIMIDITY_create();
MidiDriver *MidiDriver_SEQ_create();
MidiDriver *MidiDriver_QT_create();
MidiDriver *MidiDriver_AMIDI_create();