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
|
/* 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_FMOPL_H
#define SOUND_FMOPL_H
#include "common/scummsys.h"
#include "common/str.h"
namespace OPL {
class OPL;
class Config {
public:
enum OplFlags {
kFlagOpl2 = (1 << 0),
kFlagDualOpl2 = (1 << 1),
kFlagOpl3 = (1 << 2)
};
/**
* OPL type to emulate.
*/
enum OplType {
kOpl2,
kDualOpl2,
kOpl3
};
typedef int8 DriverId;
struct EmulatorDescription {
const char *name;
const char *description;
DriverId id; // A unique ID for each driver
uint32 flags; // Capabilities of this driver
};
/**
* Get a list of all available OPL emulators.
* @return list of all available OPL emulators, terminated by a zero entry
*/
static const EmulatorDescription *getAvailable() { return _drivers; }
/**
* Returns the driver id of a given name.
*/
static DriverId parse(const Common::String &name);
/**
* Detects a driver for the specific type.
*
* @return Returns a valid driver id on success, -1 otherwise.
*/
static DriverId detect(OplType type);
/**
* Creates the specific driver with a specific type setup.
*/
static OPL *create(DriverId driver, OplType type);
/**
* Wrapper to easily init an OPL chip, without specifing an emulator.
* By default it will try to initialize an OPL2 emulator, thus an AdLib card.
*/
static OPL *create(OplType type = kOpl2);
private:
static const EmulatorDescription _drivers[];
};
class OPL {
private:
// TODO: This is part of a temporary HACK to allow only 1 instance
static bool _hasInstance;
public:
OPL() { assert(!_hasInstance); _hasInstance = true; }
virtual ~OPL() { _hasInstance = false; }
/**
* Initializes the OPL emulator.
*
* @param rate output sample rate
* @return true on success, false on failure
*/
virtual bool init(int rate) = 0;
/**
* Reinitializes the OPL emulator
*/
virtual void reset() = 0;
/**
* Writes a byte to the given I/O port.
*
* @param a port address
* @param v value, which will be written
*/
virtual void write(int a, int v) = 0;
/**
* Reads a byte from the given I/O port.
*
* @param a port address
* @return value read
*/
virtual byte read(int a) = 0;
/**
* Function to directly write to a specific OPL register.
* This writes to *both* chips for a Dual OPL2.
*
* @param r hardware register number to write to
* @param v value, which will be written
*/
virtual void writeReg(int r, int v) = 0;
/**
* Read up to 'length' samples.
*
* Data will be in native endianess, 16 bit per sample, signed.
* For stereo OPL, buffer will be filled with interleaved
* left and right channel samples, starting with a left sample.
* Furthermore, the samples in the left and right are summed up.
* So if you request 4 samples from a stereo OPL, you will get
* a total of two left channel and two right channel samples.
*/
virtual void readBuffer(int16 *buffer, int length) = 0;
/**
* Returns whether the setup OPL mode is stereo or not
*/
virtual bool isStereo() const = 0;
};
} // End of namespace OPL
// Legacy API
// !You should not write any new code using the legacy API!
typedef OPL::OPL FM_OPL;
void OPLDestroy(FM_OPL *OPL);
void OPLResetChip(FM_OPL *OPL);
void OPLWrite(FM_OPL *OPL, int a, int v);
unsigned char OPLRead(FM_OPL *OPL, int a);
void OPLWriteReg(FM_OPL *OPL, int r, int v);
void YM3812UpdateOne(FM_OPL *OPL, int16 *buffer, int length);
/**
* Legacy factory to create an AdLib (OPL2) chip.
*
* !You should not write any new code using the legacy API!
*/
FM_OPL *makeAdLibOPL(int rate);
#endif
|
