43075248aa
This is an attempt to fix the problem Max described in his devel mail. The presence of the rom files will now be checked in detectDevice(). In case of failure there will be fallback attempts. The user will get notified of the detection failure if he has expressly selected the device that failed. Please test with your platform / engine (with or without rom files).
398 lines
13 KiB
C++
398 lines
13 KiB
C++
/* 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.
|
|
*
|
|
*/
|
|
|
|
#include "common/config-manager.h"
|
|
#include "common/error.h"
|
|
#include "common/str.h"
|
|
#include "common/system.h"
|
|
#include "common/textconsole.h"
|
|
#include "common/util.h"
|
|
#include "engines/engine.h"
|
|
#include "audio/mididrv.h"
|
|
#include "audio/musicplugin.h"
|
|
|
|
const byte MidiDriver::_mt32ToGm[128] = {
|
|
// 0 1 2 3 4 5 6 7 8 9 A B C D E F
|
|
0, 1, 0, 2, 4, 4, 5, 3, 16, 17, 18, 16, 16, 19, 20, 21, // 0x
|
|
6, 6, 6, 7, 7, 7, 8, 112, 62, 62, 63, 63, 38, 38, 39, 39, // 1x
|
|
88, 95, 52, 98, 97, 99, 14, 54, 102, 96, 53, 102, 81, 100, 14, 80, // 2x
|
|
48, 48, 49, 45, 41, 40, 42, 42, 43, 46, 45, 24, 25, 28, 27, 104, // 3x
|
|
32, 32, 34, 33, 36, 37, 35, 35, 79, 73, 72, 72, 74, 75, 64, 65, // 4x
|
|
66, 67, 71, 71, 68, 69, 70, 22, 56, 59, 57, 57, 60, 60, 58, 61, // 5x
|
|
61, 11, 11, 98, 14, 9, 14, 13, 12, 107, 107, 77, 78, 78, 76, 76, // 6x
|
|
47, 117, 127, 118, 118, 116, 115, 119, 115, 112, 55, 124, 123, 0, 14, 117 // 7x
|
|
};
|
|
|
|
const byte MidiDriver::_gmToMt32[128] = {
|
|
// 0 1 2 3 4 5 6 7 8 9 A B C D E F
|
|
5, 1, 2, 7, 3, 5, 16, 21, 22, 101, 101, 97, 104, 103, 102, 20, // 0x
|
|
8, 9, 11, 12, 14, 15, 87, 15, 59, 60, 61, 62, 67, 44, 79, 23, // 1x
|
|
64, 67, 66, 70, 68, 69, 28, 31, 52, 54, 55, 56, 49, 51, 57, 112, // 2x
|
|
48, 50, 45, 26, 34, 35, 45, 122, 89, 90, 94, 81, 92, 95, 24, 25, // 3x
|
|
80, 78, 79, 78, 84, 85, 86, 82, 74, 72, 76, 77, 110, 107, 108, 76, // 4x
|
|
47, 44, 111, 45, 44, 34, 44, 30, 32, 33, 88, 34, 35, 35, 38, 33, // 5x
|
|
41, 36, 100, 37, 40, 34, 43, 40, 63, 21, 99, 105, 103, 86, 55, 84, // 6x
|
|
101, 103, 100, 120, 117, 113, 99, 128, 128, 128, 128, 124, 123, 128, 128, 128, // 7x
|
|
};
|
|
|
|
static const uint32 GUIOMapping[] = {
|
|
MT_PCSPK, Common::GUIO_MIDIPCSPK,
|
|
MT_CMS, Common::GUIO_MIDICMS,
|
|
MT_PCJR, Common::GUIO_MIDIPCJR,
|
|
MT_ADLIB, Common::GUIO_MIDIADLIB,
|
|
MT_C64, Common::GUIO_MIDIC64,
|
|
MT_AMIGA, Common::GUIO_MIDIAMIGA,
|
|
MT_APPLEIIGS, Common::GUIO_MIDIAPPLEIIGS,
|
|
MT_TOWNS, Common::GUIO_MIDITOWNS,
|
|
MT_PC98, Common::GUIO_MIDIPC98,
|
|
MT_GM, Common::GUIO_MIDIGM,
|
|
MT_MT32, Common::GUIO_MIDIMT32,
|
|
0, 0
|
|
};
|
|
|
|
uint32 MidiDriver::musicType2GUIO(uint32 musicType) {
|
|
uint32 res = 0;
|
|
|
|
for (int i = 0; GUIOMapping[i] || GUIOMapping[i + 1]; i += 2) {
|
|
if (musicType == GUIOMapping[i] || musicType == (uint32)-1)
|
|
res |= GUIOMapping[i + 1];
|
|
}
|
|
|
|
return res;
|
|
}
|
|
|
|
bool MidiDriver::_forceTypeMT32 = false;
|
|
|
|
MusicType MidiDriver::getMusicType(MidiDriver::DeviceHandle handle) {
|
|
if (_forceTypeMT32)
|
|
return MT_MT32;
|
|
|
|
if (handle) {
|
|
const MusicPlugin::List p = MusicMan.getPlugins();
|
|
for (MusicPlugin::List::const_iterator m = p.begin(); m != p.end(); m++) {
|
|
MusicDevices i = (**m)->getDevices();
|
|
for (MusicDevices::iterator d = i.begin(); d != i.end(); d++) {
|
|
if (handle == d->getHandle())
|
|
return d->getMusicType();
|
|
}
|
|
}
|
|
}
|
|
|
|
return MT_INVALID;
|
|
}
|
|
|
|
Common::String MidiDriver::getDeviceString(DeviceHandle handle, DeviceStringType type) {
|
|
if (handle) {
|
|
const MusicPlugin::List p = MusicMan.getPlugins();
|
|
for (MusicPlugin::List::const_iterator m = p.begin(); m != p.end(); m++) {
|
|
MusicDevices i = (**m)->getDevices();
|
|
for (MusicDevices::iterator d = i.begin(); d != i.end(); d++) {
|
|
if (handle == d->getHandle()) {
|
|
if (type == kDriverName)
|
|
return d->getMusicDriverName();
|
|
else if (type == kDriverId)
|
|
return d->getMusicDriverId();
|
|
else if (type == kDeviceId)
|
|
return d->getCompleteId();
|
|
else
|
|
return Common::String("auto");
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return Common::String("auto");
|
|
}
|
|
|
|
MidiDriver::DeviceHandle MidiDriver::detectDevice(int flags) {
|
|
// Query the selected music device (defaults to MT_AUTO device).
|
|
DeviceHandle hdl = getDeviceHandle(ConfMan.get("music_driver"));
|
|
DeviceHandle reslt = MT_AUTO;
|
|
|
|
_forceTypeMT32 = false;
|
|
|
|
// Check whether the selected music driver is compatible with the
|
|
// given flags.
|
|
switch (getMusicType(hdl)) {
|
|
case MT_PCSPK:
|
|
if (flags & MDT_PCSPK)
|
|
reslt = hdl;
|
|
break;
|
|
|
|
case MT_PCJR:
|
|
if (flags & MDT_PCJR)
|
|
reslt = hdl;
|
|
break;
|
|
|
|
case MT_CMS:
|
|
if (flags & MDT_CMS)
|
|
reslt = hdl;
|
|
break;
|
|
|
|
case MT_ADLIB:
|
|
if (flags & MDT_ADLIB)
|
|
reslt = hdl;
|
|
break;
|
|
|
|
case MT_C64:
|
|
if (flags & MDT_C64)
|
|
reslt = hdl;
|
|
break;
|
|
|
|
case MT_AMIGA:
|
|
if (flags & MDT_AMIGA)
|
|
reslt = hdl;
|
|
break;
|
|
|
|
case MT_APPLEIIGS:
|
|
if (flags & MDT_APPLEIIGS)
|
|
reslt = hdl;
|
|
break;
|
|
|
|
case MT_TOWNS:
|
|
if (flags & MDT_TOWNS)
|
|
reslt = hdl;
|
|
break;
|
|
|
|
case MT_PC98:
|
|
if (flags & MDT_PC98)
|
|
reslt = hdl;
|
|
break;
|
|
|
|
case MT_GM:
|
|
case MT_GS:
|
|
case MT_MT32:
|
|
if (flags & MDT_MIDI)
|
|
reslt = hdl;
|
|
break;
|
|
|
|
case MT_NULL:
|
|
reslt = hdl;
|
|
|
|
default:
|
|
break;
|
|
}
|
|
|
|
Common::String failedDevStr;
|
|
MusicType tp = getMusicType(reslt);
|
|
if (tp != MT_INVALID && tp != MT_AUTO) {
|
|
if (checkDevice(reslt)) {
|
|
return reslt;
|
|
} else {
|
|
// If the expressly selected device is unavailable we display a warning and continue.
|
|
failedDevStr = getDeviceString(hdl, MidiDriver::kDriverName);
|
|
Common::String errorMessage = "Failed to detect the selected audio device '" + failedDevStr +"'. See log file for more information. Attempting to fall back to the next available device...";
|
|
GUIErrorMessage(errorMessage);
|
|
}
|
|
}
|
|
|
|
reslt = MT_AUTO;
|
|
|
|
// If the selected driver did not match the flags setting,
|
|
// we try to determine a suitable and "optimal" music driver.
|
|
const MusicPlugin::List p = MusicMan.getPlugins();
|
|
// If only MDT_MIDI but not MDT_PREFER_MT32 or MDT_PREFER_GM is set we prefer the other devices (which will always be
|
|
// detected since they are hard coded and cannot be disabled.
|
|
bool skipMidi = !(flags & (MDT_PREFER_GM | MDT_PREFER_MT32));
|
|
while (flags != MDT_NONE) {
|
|
if ((flags & MDT_MIDI) && !skipMidi) {
|
|
// If a preferred MT32 or GM device has been selected that device gets returned if available.
|
|
if (flags & MDT_PREFER_MT32)
|
|
hdl = getDeviceHandle(ConfMan.get("mt32_device"));
|
|
else if (flags & MDT_PREFER_GM)
|
|
hdl = getDeviceHandle(ConfMan.get("gm_device"));
|
|
else
|
|
hdl = getDeviceHandle("auto");
|
|
|
|
const MusicType type = getMusicType(hdl);
|
|
|
|
// If we have a "Don't use GM/MT-32" setting we skip this part and jump
|
|
// to AdLib, PC Speaker etc. detection right away.
|
|
if (type != MT_NULL) {
|
|
if (type != MT_AUTO && type != MT_INVALID) {
|
|
if (checkDevice(hdl)) {
|
|
if (flags & MDT_PREFER_MT32)
|
|
// If we have a preferred MT32 device we disable the gm/mt32 mapping (more about this in mididrv.h).
|
|
_forceTypeMT32 = true;
|
|
return hdl;
|
|
} else {
|
|
// If the preferred (expressly requested) device is unavailable we display a warning and continue.
|
|
// Don't warn about the missing device if we did already (this becomes relevant if the failing
|
|
// device is selected as preferred device and also as GM or MT-32 device).
|
|
if (failedDevStr != getDeviceString(hdl, MidiDriver::kDriverName)) {
|
|
Common::String errorMessage = "Failed to detect the preferred device '" + getDeviceString(hdl, MidiDriver::kDriverName) + "'. See log file for more information. Attempting to fall back to the next available device...";
|
|
GUIErrorMessage(errorMessage);
|
|
}
|
|
hdl = MT_AUTO;
|
|
}
|
|
}
|
|
|
|
// If no specific device is selected (neither in the scummvm nor in the game domain)
|
|
// and there is no preferred MT32 or GM device selected either or if the detected device is unavailable we arrive here.
|
|
// If MT32 is preferred we try for the first available device with music type 'MT_MT32' (usually the mt32 emulator).
|
|
if (flags & MDT_PREFER_MT32) {
|
|
for (MusicPlugin::List::const_iterator m = p.begin(); m != p.end(); ++m) {
|
|
MusicDevices i = (**m)->getDevices();
|
|
for (MusicDevices::iterator d = i.begin(); d != i.end(); ++d) {
|
|
if (d->getMusicType() == MT_MT32) {
|
|
hdl = d->getHandle();
|
|
if (checkDevice(hdl))
|
|
return hdl;
|
|
else
|
|
// No warning here, since the user hasn't expressly requested anything.
|
|
hdl = MT_AUTO;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Now we default to the first available device with music type 'MT_GM' if not
|
|
// MT-32 is preferred or if MT-32 is preferred but all other devices have failed.
|
|
if (!(flags & MDT_PREFER_MT32) || flags == (MDT_PREFER_MT32 | MDT_MIDI)) {
|
|
for (MusicPlugin::List::const_iterator m = p.begin(); m != p.end(); ++m) {
|
|
MusicDevices i = (**m)->getDevices();
|
|
for (MusicDevices::iterator d = i.begin(); d != i.end(); ++d) {
|
|
if (d->getMusicType() == MT_GM || d->getMusicType() == MT_GS) {
|
|
hdl = d->getHandle();
|
|
if (checkDevice(hdl))
|
|
return hdl;
|
|
else
|
|
// No warning here, since the user hasn't expressly requested anything.
|
|
hdl = MT_AUTO;
|
|
}
|
|
}
|
|
}
|
|
// Detection flags get removed after final detection attempt to avoid further attempts.
|
|
flags &= ~(MDT_MIDI | MDT_PREFER_GM | MDT_PREFER_MT32);
|
|
}
|
|
}
|
|
}
|
|
|
|
// The order in this list is important, since this is the order of preference
|
|
// (e.g. MT_ADLIB is checked before MT_PCJR and MT_PCSPK for a good reason.
|
|
// Detection flags get removed after detection attempt to avoid further attempts.
|
|
if (flags & MDT_TOWNS) {
|
|
tp = MT_TOWNS;
|
|
flags &= ~MDT_TOWNS;
|
|
} else if (flags & MDT_PC98) {
|
|
tp = MT_PC98;
|
|
flags &= ~MDT_PC98;
|
|
} else if (flags & MDT_ADLIB) {
|
|
tp = MT_ADLIB;
|
|
flags &= ~MDT_ADLIB;
|
|
} else if (flags & MDT_PCJR) {
|
|
tp = MT_PCJR;
|
|
flags &= ~MDT_PCJR;
|
|
} else if (flags & MDT_PCSPK) {
|
|
tp = MT_PCSPK;
|
|
flags &= ~MDT_PCSPK;
|
|
} else if (flags & MDT_C64) {
|
|
tp = MT_C64;
|
|
flags &= ~MDT_C64;
|
|
} else if (flags & MDT_AMIGA) {
|
|
tp = MT_AMIGA;
|
|
flags &= ~MDT_AMIGA;
|
|
} else if (flags & MDT_APPLEIIGS) {
|
|
tp = MT_APPLEIIGS;
|
|
flags &= ~MDT_APPLEIIGS;
|
|
} else if (flags & MDT_MIDI) {
|
|
// If we haven't tried to find a MIDI device yet we do this now.
|
|
skipMidi = false;
|
|
continue;
|
|
} else if (flags) {
|
|
// Invalid flags. Set them to MDT_NONE to leave detection loop.
|
|
flags = MDT_NONE;
|
|
tp = MT_AUTO;
|
|
}
|
|
|
|
for (MusicPlugin::List::const_iterator m = p.begin(); m != p.end(); ++m) {
|
|
MusicDevices i = (**m)->getDevices();
|
|
for (MusicDevices::iterator d = i.begin(); d != i.end(); ++d) {
|
|
if (d->getMusicType() == tp) {
|
|
hdl = d->getHandle();
|
|
if (checkDevice(hdl))
|
|
return hdl;
|
|
else
|
|
// No warning here, since the user hasn't expressly requested anything.
|
|
hdl = MT_AUTO;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return reslt;
|
|
}
|
|
|
|
MidiDriver *MidiDriver::createMidi(MidiDriver::DeviceHandle handle) {
|
|
MidiDriver *driver = 0;
|
|
const MusicPlugin::List p = MusicMan.getPlugins();
|
|
for (MusicPlugin::List::const_iterator m = p.begin(); m != p.end(); m++) {
|
|
if (getDeviceString(handle, MidiDriver::kDriverId).equals((**m)->getId()))
|
|
(**m)->createInstance(&driver, handle);
|
|
}
|
|
|
|
return driver;
|
|
}
|
|
|
|
bool MidiDriver::checkDevice(MidiDriver::DeviceHandle handle) {
|
|
const MusicPlugin::List p = MusicMan.getPlugins();
|
|
for (MusicPlugin::List::const_iterator m = p.begin(); m != p.end(); m++) {
|
|
if (getDeviceString(handle, MidiDriver::kDriverId).equals((**m)->getId()))
|
|
return (**m)->checkDevice(handle);
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
MidiDriver::DeviceHandle MidiDriver::getDeviceHandle(const Common::String &identifier) {
|
|
const MusicPlugin::List p = MusicMan.getPlugins();
|
|
|
|
if (p.begin() == p.end())
|
|
error("MidiDriver::getDeviceHandle: Music plugins must be loaded prior to calling this method");
|
|
|
|
for (MusicPlugin::List::const_iterator m = p.begin(); m != p.end(); m++) {
|
|
MusicDevices i = (**m)->getDevices();
|
|
for (MusicDevices::iterator d = i.begin(); d != i.end(); d++) {
|
|
// The music driver id isn't unique, but it will match
|
|
// driver's first device. This is useful when selecting
|
|
// the driver from the command line.
|
|
if (identifier.equals(d->getMusicDriverId()) || identifier.equals(d->getCompleteId()) || identifier.equals(d->getCompleteName())) {
|
|
return d->getHandle();
|
|
}
|
|
}
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
void MidiDriver::sendMT32Reset() {
|
|
static const byte resetSysEx[] = { 0x41, 0x10, 0x16, 0x12, 0x7F, 0x00, 0x00, 0x01, 0x00 };
|
|
sysEx(resetSysEx, sizeof(resetSysEx));
|
|
g_system->delayMillis(100);
|
|
}
|
|
|
|
void MidiDriver::sendGMReset() {
|
|
static const byte resetSysEx[] = { 0x7E, 0x7F, 0x09, 0x01 };
|
|
sysEx(resetSysEx, sizeof(resetSysEx));
|
|
g_system->delayMillis(100);
|
|
}
|
|
|