ES-DE/es-core/src/Settings.cpp

//
//  Settings.cpp
//
//  Functions to read from and write to the configuration file es_settings.cfg.
//  The default values for the application settings are defined here as well.
//

#include "Settings.h"

#include "utils/FileSystemUtil.h"
#include "utils/StringUtil.h"
#include "Log.h"
#include "Scripting.h"
#include "Platform.h"

#include <pugixml.hpp>
#include <algorithm>
#include <vector>

Settings* Settings::sInstance = nullptr;

// These values are NOT saved to es_settings.cfg since they're not set via
// the in-program settings menu. Most can be set using command-line arguments,
// but some are debug flags that are either hardcoded or set by internal debug
// functions.
std::vector<const char*> settings_dont_save {
    // These options can be set using command-line arguments:
    "Debug",                // --debug
    "ForceKid",             // --force-kid
    "ForceKiosk",           // --force-kiosk
    "IgnoreGamelist",       // --ignore-gamelist
    "ShowExit",             // --no-exit
    "SplashScreen",         // --no-splash
    "VSync",                // --vsync [1/on or 0/off]
    #ifndef _WIN64
    "Windowed",             // --windowed
    #endif
    "WindowWidth",          // Set via --resolution [width] [height]
    "WindowHeight",         // set via --resolution [width] [height]

    // These options are not shown in the --help text and are intended
    // for debugging and testing purposes:
    "ScreenWidth",          // Set via --screensize [width] [height]
    "ScreenHeight",         // set via --screensize [width] [height]
    "ScreenOffsetX",        // Set via --screenoffset [X] [Y]
    "ScreenOffsetY",        // Set via --screenoffset [X] [Y]
    "ScreenRotate",         // --screenrotate [0-3]

    // These options are not configurable from the command-line:
    "DebugGrid",
    "DebugText",
    "DebugImage",
    "SplashScreenProgress"
};

Settings::Settings()
{
    mWasChanged = false;
    setDefaults();
    loadFile();
}

Settings* Settings::getInstance()
{
    if (sInstance == nullptr)
        sInstance = new Settings();

    return sInstance;
}

void Settings::setDefaults()
{
    mBoolMap.clear();
    mIntMap.clear();

    //
    // Settings configured via the in-program settings menu.
    //

    // UI settings.
    mStringMap["StartupSystem"] = "";
    mStringMap["GamelistViewStyle"] = "automatic";
    mStringMap["TransitionStyle"] = "instant";
    mStringMap["ThemeSet"] = "";
    mStringMap["UIMode"] = "Full";
    mStringMap["DefaultSortOrder"] = "filename, ascending";
    mBoolMap["FavoritesFirst"] = true;
    mBoolMap["ForceDisableFilters"] = false;
    mBoolMap["QuickSystemSelect"] = true;
    mBoolMap["MoveCarousel"] = true;
    mBoolMap["ShowHelpPrompts"] = true;
    mBoolMap["ShowKidStartMenu"] = false;

    // UI settings -> scrensaver settings.
    mIntMap["ScreenSaverTime"] = 5*60*1000; // 5 minutes
    mBoolMap["ScreenSaverControls"] = true;
    mStringMap["ScreenSaverBehavior"] = "dim";

    // UI settings -> screensaver settings -> video screensaver settings.
    mIntMap["ScreenSaverSwapVideoTimeout"] = 30000;
    mBoolMap["StretchVideoOnScreenSaver"] = false;
    mStringMap["ScreenSaverGameInfo"] = "never";
    mBoolMap["ScreenSaverVideoMute"] = false;			// Raspberry Pi only
    mBoolMap["CaptionsCompatibility"] = true;

    // UI settings -> screensaver settings -> slideshow screensaver settings.
    mIntMap["ScreenSaverSwapImageTimeout"] = 10000;
    mBoolMap["SlideshowScreenSaverStretch"] = false;
    mStringMap["SlideshowScreenSaverBackgroundAudioFile"] = Utils::FileSystem::getHomePath() +
            "/.emulationstation/slideshow/audio/slideshow_bg.wav";
    mBoolMap["SlideshowScreenSaverCustomImageSource"] = false;
    mStringMap["SlideshowScreenSaverImageDir"] = Utils::FileSystem::getHomePath() +
            "/.emulationstation/slideshow/image";
    mBoolMap["SlideshowScreenSaverRecurse"] = false;
    mStringMap["SlideshowScreenSaverImageFilter"] = ".png,.jpg";

    // Sound settings.
    // The ALSA Audio Card and Audio Device selection code is disabled at the moment.
    // As PulseAudio controls the sound devices for the desktop environment, it doesn't
    // make much sense to be able to select ALSA devices directly. Normally (always?)
    // the selection doesn't make any difference at all. But maybe some PulseAudio
    // settings could be added later on, if needed.
    // The code is still active for Raspberry Pi though as I'm not sure if this is
    // useful for that device.
    #ifdef _RPI_
    mStringMap["AudioCard"] = "default";
    // Audio out device for volume control.
    //#endif
    //#ifdef _RPI_
    mStringMap["AudioDevice"] = "PCM";
    // Audio out device for Video playback using OMX player.
    mStringMap["OMXAudioDev"] = "both";
    //#else
    //    mStringMap["AudioDevice"] = "Master";
    #endif
    mBoolMap["VideoAudio"] = true;
    mBoolMap["NavigationSounds"] = true;

    // Game collection settings.
    mStringMap["CollectionSystemsAuto"] = "";
    mStringMap["CollectionSystemsCustom"] = "";
    mBoolMap["UseCustomCollectionsSystem"] = true;
    mBoolMap["FavFirstCustom"] = true;
    mBoolMap["CollectionShowSystemInfo"] = true;

    // Scraper.
    mStringMap["Scraper"] = "ScreenScraper";
    mStringMap["ScraperRegion"] = "eu";
    mStringMap["ScraperLanguage"] = "en";
//	mBoolMap["ScraperGenerateMiximages"] = false;
//	mBoolMap["ScraperGenerateThumbnails"] = false;
    mBoolMap["ScraperInteractive"] = true;
    mBoolMap["ScraperSemiautomatic"] = true;
    mBoolMap["ScraperOverwriteData"] = true;
    mBoolMap["ScrapeMetadata"] = true;
    mBoolMap["ScrapeGameNames"] = true;
    mBoolMap["ScrapeRatings"] = true;
    mBoolMap["Scrape3DBoxes"] = true;
    mBoolMap["ScrapeCovers"] = true;
    mBoolMap["ScrapeMarquees"] = true;
    mBoolMap["ScrapeScreenshots"] = true;

    // Other settings.
    #ifdef _RPI_
        mIntMap["MaxVRAM"] = 80;
    #else
        mIntMap["MaxVRAM"] = 100;
    #endif
    #ifdef __unix__
    mStringMap["FullscreenMode"] = "normal";
    #endif
    mStringMap["PowerSaverMode"] = "disabled";
    // This setting only applies to raspberry pi but set it for all platforms so
    // we don't get a warning if we encounter it on a different platform.
    mBoolMap["VideoOmxPlayer"] = false;
    #ifdef _RPI_
    // We're defaulting to OMX Player for full screen video on the Pi.
    mBoolMap["ScreenSaverOmxPlayer"] = true;
    // Use OMX Player defaults.
    mStringMap["SubtitleFont"] = "/usr/share/fonts/truetype/freefont/FreeSans.ttf";
    mStringMap["SubtitleItalicFont"] = "/usr/share/fonts/truetype/freefont/FreeSansOblique.ttf";
    mIntMap["SubtitleSize"] = 55;
    mStringMap["SubtitleAlignment"] = "left";
    #else
    mBoolMap["ScreenSaverOmxPlayer"] = false;
    #endif
    mStringMap["SaveGamelistsMode"] = "always";
    #ifdef _WIN64
    mBoolMap["HideTaskbar"] = false;
    #endif
    mStringMap["MediaDirectory"] = "";
    mBoolMap["LaunchCommandOverride"] = true;
    mBoolMap["CustomEventScripts"] = false;
    mBoolMap["ParseGamelistOnly"] = false;
    mBoolMap["LocalArt"] = false;
    mBoolMap["ShowHiddenFiles"] = false;
    mBoolMap["DrawFramerate"] = false;
    mBoolMap["ShowRebootSystem"] = true;
    mBoolMap["ShowPoweroffSystem"] = true;

    //
    // Settings configured via command-line arguments.
    //

    // Options listed using --help
    mBoolMap["Debug"] = false;
    mBoolMap["ForceKid"] = false;
    mBoolMap["ForceKiosk"] = false;
    mBoolMap["IgnoreGamelist"] = false;
    mBoolMap["ShowExit"] = true;
    mBoolMap["SplashScreen"] = true;
    mBoolMap["VSync"] = true;
    #ifndef _WIN64
    mBoolMap["Windowed"] = false;
    #endif
    mIntMap["WindowWidth"]   = 0;
    mIntMap["WindowHeight"]  = 0;
    mIntMap["ScreenWidth"]   = 0;

    // Undocumented options.
    mIntMap["ScreenHeight"]  = 0;
    mIntMap["ScreenOffsetX"] = 0;
    mIntMap["ScreenOffsetY"] = 0;
    mIntMap["ScreenRotate"]  = 0;

    //
    // Settings that can be changed in es_settings.cfg
    // but that are not configurable via the GUI.
    //

    mBoolMap["ShowDefaultKeyboardWarning"] = true;
    mStringMap["ROMDirectory"] = "";
    mIntMap["ScraperResizeMaxWidth"] = 600;
    mIntMap["ScraperResizeMaxHeight"] = 0;

    //
    // Hardcoded or program-internal settings.
    //

    mBoolMap["BackgroundJoystickInput"] = false;
    mBoolMap["DebugGrid"] = false;
    mBoolMap["DebugText"] = false;
    mBoolMap["DebugImage"] = false;
    mBoolMap["SplashScreenProgress"] = true;
    mStringMap["UIMode_passkey"] = "uuddlrlrba";
}

template <typename K, typename V>
void saveMap(pugi::xml_document& doc, std::map<K, V>& map, const char* type)
{
    for (auto iter = map.cbegin(); iter != map.cend(); iter++) {
        // Key is on the "don't save" list, so don't save it.
        if (std::find(settings_dont_save.cbegin(), settings_dont_save.cend(),
                iter->first) != settings_dont_save.cend())
            continue;

        pugi::xml_node node = doc.append_child(type);
        node.append_attribute("name").set_value(iter->first.c_str());
        node.append_attribute("value").set_value(iter->second);
    }
}

void Settings::saveFile()
{
    LOG(LogDebug) << "Settings::saveFile(): Saving Settings to file.";
    const std::string path = Utils::FileSystem::getHomePath() +
            "/.emulationstation/es_settings.cfg";

    pugi::xml_document doc;

    saveMap<std::string, bool>(doc, mBoolMap, "bool");
    saveMap<std::string, int>(doc, mIntMap, "int");
    saveMap<std::string, float>(doc, mFloatMap, "float");

    //saveMap<std::string, std::string>(doc, mStringMap, "string");
    for (auto iter = mStringMap.cbegin(); iter != mStringMap.cend(); iter++) {
        pugi::xml_node node = doc.append_child("string");
        node.append_attribute("name").set_value(iter->first.c_str());
        node.append_attribute("value").set_value(iter->second.c_str());
    }

    #ifdef _WIN64
    doc.save_file(Utils::String::stringToWideString(path).c_str());
    #else
    doc.save_file(path.c_str());
    #endif

    Scripting::fireEvent("config-changed");
    Scripting::fireEvent("settings-changed");
}

void Settings::loadFile()
{
    const std::string path = Utils::FileSystem::getHomePath() +
            "/.emulationstation/es_settings.cfg";

    if (!Utils::FileSystem::exists(path))
        return;

    pugi::xml_document doc;
    #ifdef _WIN64
    pugi::xml_parse_result result = doc.load_file(Utils::String::stringToWideString(path).c_str());
    #else
    pugi::xml_parse_result result = doc.load_file(path.c_str());
    #endif
    if (!result) {
        LOG(LogError) << "Error - Could not parse Settings file!\n   " << result.description();
        return;
    }

    for (pugi::xml_node node = doc.child("bool"); node; node = node.next_sibling("bool"))
        setBool(node.attribute("name").as_string(), node.attribute("value").as_bool());
    for (pugi::xml_node node = doc.child("int"); node; node = node.next_sibling("int"))
        setInt(node.attribute("name").as_string(), node.attribute("value").as_int());
    for (pugi::xml_node node = doc.child("float"); node; node = node.next_sibling("float"))
        setFloat(node.attribute("name").as_string(), node.attribute("value").as_float());
    for (pugi::xml_node node = doc.child("string"); node; node = node.next_sibling("string"))
        setString(node.attribute("name").as_string(), node.attribute("value").as_string());
}

// Print a warning message if the setting we're trying to get doesn't already exist in
// the map. Then return the value in the map.
#define SETTINGS_GETSET(type, mapName, getMethodName, setMethodName) \
        type Settings::getMethodName(const std::string& name) \
{ \
    if (mapName.find(name) == mapName.cend()) { \
        LOG(LogError) << "Error - Tried to use unset setting " << name << "!"; \
    } \
    return mapName[name]; \
} \
bool Settings::setMethodName(const std::string& name, type value) \
{ \
    if (mapName.count(name) == 0 || mapName[name] != value) { \
        mapName[name] = value; \
\
        if (std::find(settings_dont_save.cbegin(), settings_dont_save.cend(), name) \
                 == settings_dont_save.cend()) \
            mWasChanged = true; \
\
        return true; \
    } \
    return false; \
}

SETTINGS_GETSET(bool, mBoolMap, getBool, setBool);
SETTINGS_GETSET(int, mIntMap, getInt, setInt);
SETTINGS_GETSET(float, mFloatMap, getFloat, setFloat);
SETTINGS_GETSET(const std::string&, mStringMap, getString, setString);