1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* $URL$
* $Id$
*
*/
#ifndef SOUND_MIDIDRV_H
#define SOUND_MIDIDRV_H
#include "common/scummsys.h"
#include "common/timer.h"
class MidiChannel;
class MusicDevice;
namespace Audio {
class Mixer;
}
namespace Common { class String; }
/**
* Music Driver Types, used to uniquely identify each music driver.
*
* The pseudo drivers are listed first, then all native drivers,
* then all other MIDI drivers, and finally the non-MIDI drivers.
*
* @todo Rename MidiDriverType to MusicDriverType
*/
/**
* Music types that music drivers can implement and engines can rely on.
*/
enum MusicType {
MT_AUTO = 0, // Auto
MT_NULL, // Null
MT_PCSPK, // PC Speaker
MT_PCJR, // PCjr
MT_CMS, // CMS
MT_ADLIB, // AdLib
MT_TOWNS, // FM-TOWNS
MT_PC98, // PC98
MT_GM, // General MIDI
MT_MT32, // MT-32
MT_GS // Roland GS
};
/**
* A set of flags to be passed to detectDevice() which can be used to
* specify what kind of music driver is preferred / accepted.
*
* The flags (except for MDT_PREFER_MT32 and MDT_PREFER_GM) indicate whether a given driver
* type is acceptable. E.g. the TOWNS music driver could be returned by
* detectDevice if and only if MDT_TOWNS is specified.
*
* @todo Rename MidiDriverFlags to MusicDriverFlags
*/
enum MidiDriverFlags {
MDT_NONE = 0,
MDT_PCSPK = 1 << 0, // PC Speaker: Maps to MD_PCSPK and MD_PCJR
MDT_CMS = 1 << 1, // Creative Music System / Gameblaster: Maps to MD_CMS
MDT_PCJR = 1 << 2, // Tandy/PC Junior driver
MDT_ADLIB = 1 << 3, // AdLib: Maps to MT_ADLIB
MDT_TOWNS = 1 << 4, // FM-TOWNS: Maps to MT_TOWNS
MDT_PC98 = 1 << 5, // FM-TOWNS: Maps to MT_PC98
MDT_MIDI = 1 << 6, // Real MIDI
MDT_PREFER_MT32 = 1 << 7, // MT-32 output is preferred
MDT_PREFER_GM = 1 << 8 // GM output is preferred
};
/**
* Abstract description of a MIDI driver. Used by the config file and command
* line parsing code, and also to be able to give the user a list of available
* drivers.
*
* @todo Rename MidiDriverType to MusicDriverType
*/
/**
* Abstract MIDI Driver Class
*
* @todo Rename MidiDriver to MusicDriver
*/
class MidiDriver {
public:
typedef uint32 DeviceHandle;
enum DeviceStringType {
kDriverName,
kDriverId,
kDeviceId
};
static uint32 musicType2GUIO(uint32 musicType);
/** Create music driver matching the given device handle, or MT_AUTO if there is no match. */
static MidiDriver *createMidi(DeviceHandle handle);
/** Returnd device handle based on the present devices and the flags parameter.
/ * Returns NULl if the matching device is the null or auto device. */
static DeviceHandle detectDevice(int flags);
/**
* Find the music driver matching the given driver name/description.
*/
static DeviceHandle getDeviceHandle(const Common::String &identifier);
/** Get the music type matching the given device handle, or MT_AUTO if there is no match. */
static MusicType getMusicType(DeviceHandle handle);
/** Get the device string matching the given device handle and the given type. */
static Common::String getDeviceString(DeviceHandle handle, DeviceStringType type);
private:
// If detectDevice() detects MT32 and we have a preferred MT32 device
// we use this to force getMusicType() to return MT_MT32 so that we don't
// have to rely on the 'True Roland MT-32' config manager setting (since nobody
// would possibly think about activating 'True Roland MT-32' when he has set
// 'Music Driver' to '>default>')
static bool _forceTypeMT32;
public:
virtual ~MidiDriver() { }
static const byte _mt32ToGm[128];
static const byte _gmToMt32[128];
/**
* Error codes returned by open.
* Can be converted to a string with getErrorName().
*/
enum {
MERR_CANNOT_CONNECT = 1,
// MERR_STREAMING_NOT_AVAILABLE = 2,
MERR_DEVICE_NOT_AVAILABLE = 3,
MERR_ALREADY_OPEN = 4
};
enum {
// PROP_TIMEDIV = 1,
PROP_OLD_ADLIB = 2,
PROP_CHANNEL_MASK = 3
};
/**
* Open the midi driver.
* @return 0 if successful, otherwise an error code.
*/
virtual int open() = 0;
/** Close the midi driver. */
virtual void close() = 0;
/**
* Output a packed midi command to the midi stream.
* The 'lowest' byte (i.e. b & 0xFF) is the status
* code, then come (if used) the first and second
* opcode.
*/
virtual void send(uint32 b) = 0;
/**
* Output a midi command to the midi stream. Convenience wrapper
* around the usual 'packed' send method.
*
* Do NOT use this for sysEx transmission; instead, use the sysEx()
* method below.
*/
void send(byte status, byte firstOp, byte secondOp) {
send(status | ((uint32)firstOp << 8) | ((uint32)secondOp << 16));
}
/** Get or set a property. */
virtual uint32 property(int prop, uint32 param) { return 0; }
/** Retrieve a string representation of an error code. */
static const char *getErrorName(int error_code);
// HIGH-LEVEL SEMANTIC METHODS
virtual void setPitchBendRange(byte channel, uint range) {
send(0xB0 | channel, 101, 0);
send(0xB0 | channel, 100, 0);
send(0xB0 | channel, 6, range);
send(0xB0 | channel, 38, 0);
send(0xB0 | channel, 101, 127);
send(0xB0 | channel, 100, 127);
}
/**
* Transmit a sysEx to the midi device.
*
* The given msg MUST NOT contain the usual SysEx frame, i.e.
* do NOT include the leading 0xF0 and the trailing 0xF7.
*
* Furthermore, the maximal supported length of a SysEx
* is 264 bytes. Passing longer buffers can lead to
* undefined behavior (most likely, a crash).
*/
virtual void sysEx(const byte *msg, uint16 length) { }
virtual void sysEx_customInstrument(byte channel, uint32 type, const byte *instr) { }
virtual void metaEvent(byte type, byte *data, uint16 length) { }
// Timing functions - MidiDriver now operates timers
virtual void setTimerCallback(void *timer_param, Common::TimerManager::TimerProc timer_proc) = 0;
/** The time in microseconds between invocations of the timer callback. */
virtual uint32 getBaseTempo() = 0;
// Channel allocation functions
virtual MidiChannel *allocateChannel() = 0;
virtual MidiChannel *getPercussionChannel() = 0;
};
class MidiChannel {
public:
virtual ~MidiChannel() {}
virtual MidiDriver *device() = 0;
virtual byte getNumber() = 0;
virtual void release() = 0;
virtual void send(uint32 b) = 0; // 4-bit channel portion is ignored
// Regular messages
virtual void noteOff(byte note) = 0;
virtual void noteOn(byte note, byte velocity) = 0;
virtual void programChange(byte program) = 0;
virtual void pitchBend(int16 bend) = 0; // -0x2000 to +0x1FFF
// Control Change messages
virtual void controlChange(byte control, byte value) = 0;
virtual void modulationWheel(byte value) { controlChange(1, value); }
virtual void volume(byte value) { controlChange(7, value); }
virtual void panPosition(byte value) { controlChange(10, value); }
virtual void pitchBendFactor(byte value) = 0;
virtual void detune(byte value) { controlChange(17, value); }
virtual void priority(byte value) { }
virtual void sustain(bool value) { controlChange(64, value ? 1 : 0); }
virtual void effectLevel(byte value) { controlChange(91, value); }
virtual void chorusLevel(byte value) { controlChange(93, value); }
virtual void allNotesOff() { controlChange(123, 0); }
// SysEx messages
virtual void sysEx_customInstrument(uint32 type, const byte *instr) = 0;
};
#endif
|