sukibaby
0aa41b305d
Currently we are storing the default driver lists as a macro, and splitting them into RString vectors every time they are needed. This commit changes the macros in `arch_default.h` into vectors of RStrings, so that they do not need to be split each time. I have updated all references where the default driver lists are being called so that the vector is used directly. A new function is added to RageUtil to make a compatible vector of RStrings from user input which may be separated with a comma. RageSoundDriver was refactored to check user input in Preferences.ini against the default driver list, and in case of incorrect spelling or failure, provides a detailed error message (including a list of valid options) in logs so the user can resolve the problem. `fix_bogus_sound_driver_pref` is no longer needed, since we are now telling the user what their valid options are if the user provides an incorrect entry for the `SoundDrivers` preference, instead of silently attempting to guess what the user wanted. Since I think it's rare that someone wants to specify a driver to begin with, we should let them know their exact options if they put something wrong here, instead of silently failing or using an unwanted driver. I tested this on Windows by specifying `DirectSound-sw` in Preferences.ini, and it worked as expected. I also tried putting an unusable value in, and got the error in logs letting me know what my valid driver options were. Of course, input and movies all work as expected too.
125 lines
3.7 KiB
C++
125 lines
3.7 KiB
C++
#include "global.h"
|
|
#include "RageSoundDriver.h"
|
|
#include "RageSoundManager.h"
|
|
#include "RageLog.h"
|
|
#include "RageUtil.h"
|
|
|
|
#include "arch/arch_default.h"
|
|
|
|
#include <cstddef>
|
|
#include <vector>
|
|
|
|
namespace
|
|
{
|
|
void WarnUserAboutBadSoundDriverEntry()
|
|
{
|
|
#if defined(_WIN32)
|
|
LOG->Trace(" - Valid sound drivers for your OS are: WaveOut, DirectSound-sw, WDMKS, Null");
|
|
#elif defined(MACOSX)
|
|
LOG->Trace(" - Valid sound drivers for your OS are: AudioUnit, Null");
|
|
#else // assume linux/unix if we reach this point
|
|
LOG->Trace(" - Valid sound drivers for your OS are: ALSA-sw, OSS, JACK, Pulse, Null");
|
|
#endif
|
|
LOG->Trace(" - Make sure the driver entry is spelled correctly, and is supported on your OS.");
|
|
}
|
|
} // namespace
|
|
|
|
DriverList RageSoundDriver::m_pDriverList;
|
|
|
|
RageSoundDriver *RageSoundDriver::Create( const RString& drivers )
|
|
{
|
|
std::vector<RString> driversToTry;
|
|
if(drivers.empty())
|
|
{
|
|
driversToTry = GetDefaultSoundDriverList();
|
|
}
|
|
else
|
|
{
|
|
std::size_t start = 0;
|
|
std::size_t end = drivers.find(',');
|
|
|
|
while (end != RString::npos)
|
|
{
|
|
driversToTry.emplace_back(drivers.substr(start, end - start));
|
|
start = end + 1;
|
|
end = drivers.find(',', start);
|
|
}
|
|
|
|
driversToTry.emplace_back(drivers.substr(start));
|
|
|
|
std::size_t to_try = 0;
|
|
|
|
while (to_try < driversToTry.size())
|
|
{
|
|
if (std::find(GetDefaultSoundDriverList().begin(), GetDefaultSoundDriverList().end(), driversToTry[to_try]) == GetDefaultSoundDriverList().end())
|
|
{
|
|
LOG->Warn("Removed unusable sound driver %s", driversToTry[to_try].c_str());
|
|
WarnUserAboutBadSoundDriverEntry();
|
|
driversToTry.erase(driversToTry.begin() + to_try);
|
|
}
|
|
else
|
|
{
|
|
++to_try;
|
|
}
|
|
}
|
|
if(driversToTry.empty())
|
|
{
|
|
driversToTry = GetDefaultSoundDriverList();
|
|
}
|
|
}
|
|
|
|
for (RString const &Driver : driversToTry)
|
|
{
|
|
RageDriver *pDriver = m_pDriverList.Create( Driver );
|
|
char const *driverString = Driver.c_str();
|
|
if( pDriver == nullptr )
|
|
{
|
|
LOG->Trace( "Unknown sound driver: %s", driverString );
|
|
continue;
|
|
}
|
|
|
|
RageSoundDriver *pRet = dynamic_cast<RageSoundDriver *>( pDriver );
|
|
ASSERT( pRet != nullptr );
|
|
|
|
const RString sError = pRet->Init();
|
|
if( sError.empty() )
|
|
{
|
|
LOG->Info( "Sound driver: %s", driverString );
|
|
return pRet;
|
|
}
|
|
LOG->Info( "Couldn't load driver %s: %s", driverString, sError.c_str() );
|
|
SAFE_DELETE( pRet );
|
|
}
|
|
return nullptr;
|
|
}
|
|
|
|
std::vector<RString> RageSoundDriver::GetSoundDriverList()
|
|
{
|
|
return GetDefaultSoundDriverList();
|
|
}
|
|
|
|
/*
|
|
* (c) 2002-2006 Glenn Maynard, Steve Checkoway
|
|
* All rights reserved.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a
|
|
* copy of this software and associated documentation files (the
|
|
* "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
* distribute, and/or sell copies of the Software, and to permit persons to
|
|
* whom the Software is furnished to do so, provided that the above
|
|
* copyright notice(s) and this permission notice appear in all copies of
|
|
* the Software and that both the above copyright notice(s) and this
|
|
* permission notice appear in supporting documentation.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
|
|
* THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS
|
|
* INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT
|
|
* OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
|
|
* OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
|
* OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
* PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|