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
|
/* 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_MUSICPLUGIN_H
#define SOUND_MUSICPLUGIN_H
#include "base/plugins.h"
#include "sound/mididrv.h"
#include "common/list.h"
/**
* Music types that music drivers can implement and engines can rely on.
*/
enum MusicType {
MT_PCSPK = 1, // PC Speaker
MT_PCJR = 2, // PCjr
MT_ADLIB = 3, // AdLib
MT_TOWNS = 4, // FM-TOWNS
MT_GM = 5, // General MIDI
MT_MT32 = 6, // MT-32
MT_GS = 7 // Roland GS
};
class MusicPluginObject;
/**
* Description of a Music device. Used to list the devices a Music driver
* can manage and their capabilities.
* A device with an empty name means the default device.
*/
class MusicDevice {
public:
MusicDevice(MusicPluginObject const *musicPlugin, Common::String name, MusicType mt);
Common::String &getName() { return _name; }
Common::String &getMusicDriverName() { return _musicDriverName; }
Common::String &getMusicDriverId() { return _musicDriverId; }
MusicType getMusicType() { return _type; }
/**
* Returns a user readable string that contains the name of the current
* device name (if it isn't the default one) and the name of the driver.
*/
Common::String getCompleteName();
private:
Common::String _name;
Common::String _musicDriverName;
Common::String _musicDriverId;
MusicType _type;
};
/** List of music devices. */
typedef Common::List<MusicDevice> MusicDevices;
/**
* A MusicPluginObject is essentially a factory for MidiDriver instances with
* the added ability of listing the available devices and their capabilities.
*/
class MusicPluginObject : public PluginObject {
public:
virtual ~MusicPluginObject() {}
/**
* Returns a unique string identifier which will be used to save the
* selected MIDI driver to the config file.
*/
virtual const char *getId() const = 0;
/**
* Returns a list of the available devices.
*/
virtual MusicDevices getDevices() const = 0;
/**
* Tries to instantiate a MIDI Driver instance based on the settings of
* the currently active ConfMan target. That is, the MusicPluginObject
* should query the ConfMan singleton for the device name, port, etc.
*
* @param mixer Pointer to the global Mixer object
* @param mididriver Pointer to a pointer which the MusicPluginObject sets
* to the newly create MidiDriver, or 0 in case of an error
* @return a Common::Error describing the error which occurred, or kNoError
*/
virtual Common::Error createInstance(Audio::Mixer *mixer, MidiDriver **mididriver) const = 0;
};
// Music plugins
typedef PluginSubclass<MusicPluginObject> MusicPlugin;
/**
* Singleton class which manages all Music plugins.
*/
class MusicManager : public Common::Singleton<MusicManager> {
private:
friend class Common::Singleton<SingletonBaseType>;
public:
const MusicPlugin::List &getPlugins() const;
};
/** Convenience shortcut for accessing the Music manager. */
#define MusicMan MusicManager::instance()
#endif
|
