ppsspp/Core/Config.h

602 lines
16 KiB
C
Raw Normal View History

2012-11-01 15:19:01 +00:00
// Copyright (c) 2012- PPSSPP Project.
// 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, version 2.0 or later versions.
2012-11-01 15:19:01 +00:00
// 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 2.0 for more details.
// A copy of the GPL 2.0 should have been included with the program.
// If not, see http://www.gnu.org/licenses/
// Official git repository and contact information can be found at
// https://github.com/hrydgard/ppsspp and http://www.ppsspp.org/.
#pragma once
#include <string>
#include <map>
#include <vector>
2019-06-06 21:16:27 +00:00
#include "ppsspp_config.h"
2017-02-24 23:52:42 +00:00
#include "Common/CommonTypes.h"
#include "Common/File/Path.h"
#include "Core/ConfigValues.h"
2012-11-01 15:19:01 +00:00
extern const char *PPSSPP_GIT_VERSION;
2012-11-01 15:19:01 +00:00
enum ChatPositions {
BOTTOM_LEFT = 0,
BOTTOM_CENTER = 1,
BOTOM_RIGHT = 2,
TOP_LEFT = 3,
TOP_CENTER = 4,
TOP_RIGHT = 5,
CENTER_LEFT = 6,
CENTER_RIGHT = 7,
};
namespace http {
class Download;
class Downloader;
}
struct UrlEncoder;
struct ConfigPrivate;
struct ConfigTouchPos {
float x;
float y;
float scale;
// Note: Show is not used for all settings.
bool show;
};
struct ConfigCustomButton {
uint64_t key;
int image;
int shape;
bool toggle;
2022-06-19 13:18:05 +00:00
bool repeat;
};
struct Config {
2012-11-01 15:19:01 +00:00
public:
Config();
~Config();
2012-11-01 15:19:01 +00:00
// Whether to save the config on close.
2012-11-01 15:19:01 +00:00
bool bSaveSettings;
bool bFirstRun;
bool bGameSpecific = false;
bool bUpdatedInstanceCounter = false;
int iRunCount; // To be used to for example check for updates every 10 runs and things like that.
bool bAutoRun; // start immediately
bool bBrowse; // when opening the emulator, immediately show a file browser
2013-05-01 12:08:01 +00:00
// General
bool bScreenshotsAsPNG;
2016-08-27 18:38:05 +00:00
bool bUseFFV1;
bool bDumpFrames;
bool bDumpVideoOutput;
2016-09-03 14:06:40 +00:00
bool bDumpAudio;
bool bSaveLoadResetsAVdumping;
bool bEnableLogging;
bool bDumpDecryptedEboot;
2015-10-14 15:45:21 +00:00
bool bFullscreenOnDoubleclick;
// These four are Win UI only
bool bPauseOnLostFocus;
bool bTopMost;
bool bIgnoreWindowsKey;
bool bRestartRequired;
std::string sFont;
bool bPauseWhenMinimized;
// Not used on mobile devices.
bool bPauseExitsEmulator;
2018-04-02 14:31:26 +00:00
bool bPauseMenuExitsEmulator;
// Core
2012-11-01 15:19:01 +00:00
bool bIgnoreBadMemAccess;
bool bFastMemory;
2016-05-06 21:45:37 +00:00
int iCpuCore;
2013-12-12 14:58:46 +00:00
bool bCheckForNewVersion;
bool bForceLagSync;
bool bFuncReplacements;
bool bHideSlowWarnings;
bool bHideStateWarnings;
bool bPreloadFunctions;
uint32_t uJitDisableFlags;
2013-12-12 14:58:46 +00:00
2015-11-15 19:03:16 +00:00
bool bSeparateSASThread;
int iIOTimingMethod;
2013-06-12 21:15:45 +00:00
int iLockedCPUSpeed;
bool bAutoSaveSymbolMap;
bool bCacheFullIsoInRam;
int iRemoteISOPort;
2017-02-14 02:18:14 +00:00
std::string sLastRemoteISOServer;
int iLastRemoteISOPort;
2017-02-22 01:45:58 +00:00
bool bRemoteISOManual;
bool bRemoteShareOnStartup;
2017-02-22 01:45:58 +00:00
std::string sRemoteISOSubdir;
bool bRemoteDebuggerOnStartup;
bool bMemStickInserted;
int iMemStickSizeGB;
bool bLoadPlugins;
int iScreenRotation; // The rotation angle of the PPSSPP UI. Only supported on Android and possibly other mobile platforms.
int iInternalScreenRotation; // The internal screen rotation angle. Useful for vertical SHMUPs and similar.
std::string sReportHost;
std::vector<std::string> vPinnedPaths;
std::string sLanguageIni;
std::string sIgnoreCompatSettings;
2018-08-12 22:08:56 +00:00
bool bDiscordPresence; // Enables setting the Discord presence to the current game (or menu)
// GFX
2014-08-17 14:07:14 +00:00
int iGPUBackend;
std::string sFailedGPUBackends;
std::string sDisabledGPUBackends;
// We have separate device parameters for each backend so it doesn't get erased if you switch backends.
// If not set, will use the "best" device.
std::string sVulkanDevice;
std::string sD3D11Device; // Windows only
2020-01-09 13:57:09 +00:00
std::string sCameraDevice;
std::string sMicDevice;
bool bSoftwareRendering;
bool bSoftwareRenderingJit;
bool bHardwareTransform; // only used in the GLES backend
bool bSoftwareSkinning;
bool bVendorBugChecksEnabled;
bool bUseGeometryShader;
// Speedhacks (more will be moved here):
bool bSkipBufferEffects;
int iTexFiltering; // 1 = auto , 2 = nearest , 3 = linear , 4 = auto max quality
2014-08-08 18:51:15 +00:00
int iBufFilter; // 1 = linear, 2 = nearest
bool bDisplayStretch; // Automatically matches the aspect ratio of the window.
float fDisplayOffsetX;
float fDisplayOffsetY;
float fDisplayScale; // Relative to the most constraining axis (x or y).
float fDisplayAspectRatio; // Stored relative to the PSP's native ratio, so 1.0 is the normal pixel aspect ratio.
bool bImmersiveMode; // Mode on Android Kitkat 4.4 and later that hides the back button etc.
bool bSustainedPerformanceMode; // Android: Slows clocks down to avoid overheating/speed fluctuations.
bool bIgnoreScreenInsets; // Android: Center screen disregarding insets if this is enabled.
2013-07-20 14:03:52 +00:00
bool bVSync;
2013-05-02 19:36:36 +00:00
int iFrameSkip;
int iFrameSkipType;
int iFastForwardMode; // See FastForwardMode in ConfigValues.h.
bool bAutoFrameSkip;
bool bEnableCardboardVR; // Cardboard Master Switch
int iCardboardScreenSize; // Screen Size (in %)
int iCardboardXShift; // X-Shift of Screen (in %)
int iCardboardYShift; // Y-Shift of Screen (in %)
2013-03-30 16:49:02 +00:00
int iWindowX;
int iWindowY;
int iWindowWidth; // Windows and other windowed environments
int iWindowHeight;
bool bShowMenuBar; // Windows-only
float fUITint;
float fUISaturation;
bool bVertexCache;
bool bTextureBackoffCache;
bool bVertexDecoderJit;
bool bFullScreen;
bool bFullScreenMulti;
int iForceFullScreen = -1; // -1 = nope, 0 = force off, 1 = force on (not saved.)
int iInternalResolution; // 0 = Auto (native), 1 = 1x (480x272), 2 = 2x, 3 = 3x, 4 = 4x and so on.
int iAnisotropyLevel; // 0 - 5, powers of 2: 0 = 1x = no aniso
2022-11-27 10:39:44 +00:00
int iMultiSampleLevel;
int bHighQualityDepth;
bool bReplaceTextures;
bool bSaveNewTextures;
bool bIgnoreTextureFilenames;
int iTexScalingLevel; // 0 = auto, 1 = off, 2 = 2x, ..., 5 = 5x
int iTexScalingType; // 0 = xBRZ, 1 = Hybrid
2013-05-03 14:21:46 +00:00
bool bTexDeposterize;
bool bTexHardwareScaling;
int iFpsLimit1;
int iFpsLimit2;
int iAnalogFpsLimit;
int iMaxRecent;
2013-07-21 11:31:46 +00:00
int iCurrentStateSlot;
int iRewindSnapshotInterval;
bool bUISound;
bool bEnableStateUndo;
2021-08-03 08:04:49 +00:00
std::string sStateLoadUndoGame;
2021-08-07 11:28:43 +00:00
std::string sStateUndoLastSaveGame;
int iStateUndoLastSaveSlot;
int iAutoLoadSaveState; // 0 = off, 1 = oldest, 2 = newest, >2 = slot number + 3
2013-05-23 11:10:39 +00:00
bool bEnableCheats;
bool bReloadCheats;
2015-01-26 23:50:50 +00:00
int iCwCheatRefreshRate;
2020-03-26 09:59:08 +00:00
float fCwCheatScrollPosition;
2020-11-23 09:06:48 +00:00
float fGameListScrollPosition;
2015-01-23 01:08:20 +00:00
int iBloomHack; //0 = off, 1 = safe, 2 = balanced, 3 = aggressive
bool bSkipGPUReadbacks;
2014-04-25 12:44:02 +00:00
int iSplineBezierQuality; // 0 = low , 1 = Intermediate , 2 = High
bool bHardwareTessellation;
bool bShaderCache; // Hidden ini-only setting, useful for debugging shader compile times.
2020-05-18 09:17:45 +00:00
std::vector<std::string> vPostShaderNames; // Off for chain end (only Off for no shader)
2020-05-15 22:52:38 +00:00
std::map<std::string, float> mPostShaderSetting;
// Note that this is separate from VR stereo, though it'll share some code paths.
bool bStereoRendering;
// There can only be one, unlike regular post shaders.
std::string sStereoToMonoShader;
2020-09-15 05:45:57 +00:00
bool bShaderChainRequires60FPS;
2020-05-18 09:17:45 +00:00
std::string sTextureShaderName;
bool bGfxDebugOutput;
int iInflightFrames;
bool bRenderDuplicateFrames;
// Sound
bool bEnableSound;
int iAudioBackend;
int iGlobalVolume;
int iReverbVolume;
int iAltSpeedVolume;
bool bExtraAudioBuffering; // For bluetooth
2019-09-15 19:54:55 +00:00
std::string sAudioDevice;
bool bAutoAudioDevice;
// UI
bool bShowDebuggerOnLoad;
2023-01-28 23:25:00 +00:00
int iShowStatusFlags;
2020-02-23 07:33:44 +00:00
bool bShowRegionOnGameIcon;
bool bShowIDOnGameIcon;
2020-03-01 14:34:35 +00:00
float fGameGridScale;
bool bShowOnScreenMessages;
int iBackgroundAnimation; // enum BackgroundAnimation
bool bTransparentBackground;
2022-02-11 11:32:23 +00:00
std::string sThemeName;
// These aren't saved, just for instant debugging.
bool bLogFrameDrops;
bool bShowDebugStats;
bool bShowAudioDebug;
bool bShowControlDebug;
bool bShowGpuProfile;
// Analog stick tilting
2023-02-16 10:07:57 +00:00
// This is the held base angle (from the horizon), that we compute the tilt relative from.
float fTiltBaseAngleY;
2023-02-16 10:07:57 +00:00
// Inverts the direction of the x axes and y axes for the purposes of tilt input.
bool bInvertTiltX;
bool bInvertTiltY;
// The sensitivity of the tilt in the X and Y directions, separately.
int iTiltSensitivityX;
int iTiltSensitivityY;
2023-02-16 10:07:57 +00:00
// The deadzone radius of the tilt. Only used in the analog mapping.
float fTiltAnalogDeadzoneRadius;
2023-02-16 10:07:57 +00:00
// Type of tilt input currently selected: Defined in TiltEventProcessor.h
// 0 - no tilt, 1 - analog stick, 2 - D-Pad, 3 - Action Buttons (Tri, Cross, Square, Circle)
int iTiltInputType;
// The three tabs.
bool bGridView1;
bool bGridView2;
bool bGridView3;
2019-11-13 17:55:18 +00:00
// Right analog binding
int iRightAnalogUp;
int iRightAnalogDown;
int iRightAnalogLeft;
int iRightAnalogRight;
int iRightAnalogPress;
bool bRightAnalogCustom;
2021-08-07 10:47:50 +00:00
bool bRightAnalogDisableDiagonal;
2019-11-13 17:55:18 +00:00
2021-08-17 07:17:37 +00:00
// Motion gesture controller
bool bGestureControlEnabled;
int iSwipeUp;
int iSwipeDown;
int iSwipeLeft;
int iSwipeRight;
float fSwipeSensitivity;
float fSwipeSmoothing;
int iDoubleTapGesture;
// Disable diagonals
bool bDisableDpadDiagonals;
bool bGamepadOnlyFocused;
// Control Style
int iTouchButtonStyle;
int iTouchButtonOpacity;
int iTouchButtonHideSeconds;
2020-03-22 23:45:22 +00:00
// Auto rotation speed
float fAnalogAutoRotSpeed;
2019-12-18 23:41:32 +00:00
// Snap touch control position
bool bTouchSnapToGrid;
int iTouchSnapGridSize;
// Floating analog stick (recenters on thumb on press).
bool bAutoCenterTouchAnalog;
//space between PSP buttons
//the PSP button's center (triangle, circle, square, cross)
ConfigTouchPos touchActionButtonCenter;
float fActionButtonSpacing;
//radius of the D-pad (PSP cross)
// int iDpadRadius;
//the D-pad (PSP cross) position
ConfigTouchPos touchDpad;
float fDpadSpacing;
ConfigTouchPos touchStartKey;
ConfigTouchPos touchSelectKey;
ConfigTouchPos touchFastForwardKey;
ConfigTouchPos touchLKey;
ConfigTouchPos touchRKey;
ConfigTouchPos touchAnalogStick;
2019-07-18 01:16:46 +00:00
ConfigTouchPos touchRightAnalogStick;
ConfigTouchPos touchCustom0;
ConfigTouchPos touchCustom1;
ConfigTouchPos touchCustom2;
ConfigTouchPos touchCustom3;
ConfigTouchPos touchCustom4;
ConfigTouchPos touchCustom5;
ConfigTouchPos touchCustom6;
ConfigTouchPos touchCustom7;
ConfigTouchPos touchCustom8;
ConfigTouchPos touchCustom9;
2021-07-11 15:51:10 +00:00
float fLeftStickHeadScale;
float fRightStickHeadScale;
bool bHideStickBackground;
// Controls Visibility
bool bShowTouchControls;
bool bShowTouchCircle;
bool bShowTouchCross;
bool bShowTouchTriangle;
bool bShowTouchSquare;
2023-03-26 09:21:34 +00:00
ConfigCustomButton CustomButton0;
ConfigCustomButton CustomButton1;
ConfigCustomButton CustomButton2;
ConfigCustomButton CustomButton3;
ConfigCustomButton CustomButton4;
ConfigCustomButton CustomButton5;
ConfigCustomButton CustomButton6;
ConfigCustomButton CustomButton7;
ConfigCustomButton CustomButton8;
ConfigCustomButton CustomButton9;
2020-02-12 14:48:49 +00:00
// Ignored on iOS and other platforms that lack pause.
bool bShowTouchPause;
bool bHapticFeedback;
// We also use the XInput settings as analog settings on other platforms like Android.
float fAnalogDeadzone;
float fAnalogInverseDeadzone;
float fAnalogSensitivity;
// convert analog stick circle to square
bool bAnalogIsCircular;
float fAnalogLimiterDeadzone;
2017-04-26 14:48:55 +00:00
bool bMouseControl;
bool bMapMouse; // Workaround for mapping screen:|
bool bMouseConfine; // Trap inside the window.
2017-04-26 14:48:55 +00:00
float fMouseSensitivity;
float fMouseSmoothing;
bool bSystemControls;
// Risky JIT optimizations
bool bDiscardRegsOnJRRA;
// SystemParam
std::string sNickName;
std::string sMACAddress;
int iLanguage;
int iTimeFormat;
int iDateFormat;
int iTimeZone;
bool bDayLightSavings;
int iButtonPreference;
2013-04-20 16:01:03 +00:00
int iLockParentalLevel;
bool bEncryptSave;
bool bSavedataUpgrade;
// Networking
std::string proAdhocServer;
bool bEnableWlan;
2014-08-23 12:35:05 +00:00
bool bEnableAdhocServer;
2020-01-17 19:32:09 +00:00
bool bEnableUPnP;
bool bUPnPUseOriginalPort;
bool bForcedFirstConnect;
int iPortOffset;
int iMinTimeout;
int iWlanAdhocChannel;
bool bWlanPowerSave;
2016-10-21 12:40:11 +00:00
bool bEnableNetworkChat;
//for chat position , moveable buttons is better than this
int iChatButtonPosition;
int iChatScreenPosition;
2017-07-06 13:43:39 +00:00
bool bEnableQuickChat;
std::string sQuickChat0;
std::string sQuickChat1;
std::string sQuickChat2;
std::string sQuickChat3;
std::string sQuickChat4;
int iPSPModel;
int iFirmwareVersion;
bool bBypassOSKWithKeyboard;
// Virtual reality
bool bEnableVR;
bool bEnable6DoF;
bool bEnableStereo;
bool bEnableMotions;
bool bForce72Hz;
bool bManualForceVR;
float fCameraDistance;
2022-10-29 17:19:25 +00:00
float fCameraHeight;
2022-10-29 17:31:57 +00:00
float fCameraSide;
float fCanvasDistance;
float fFieldOfViewPercentage;
2022-11-25 14:58:51 +00:00
float fHeadUpDisplayScale;
float fMotionLength;
float fHeadRotationScale;
bool bHeadRotationEnabled;
bool bHeadRotationSmoothing;
int iCameraPitch;
// Debugger
int iDisasmWindowX;
int iDisasmWindowY;
int iDisasmWindowW;
int iDisasmWindowH;
2013-09-28 14:04:56 +00:00
int iGEWindowX;
int iGEWindowY;
int iGEWindowW;
int iGEWindowH;
2022-08-14 18:42:04 +00:00
uint32_t uGETabsLeft;
uint32_t uGETabsRight;
uint32_t uGETabsTopRight;
int iConsoleWindowX;
int iConsoleWindowY;
int iFontWidth;
int iFontHeight;
2013-07-30 15:06:37 +00:00
bool bDisplayStatusBar;
2013-09-30 19:42:05 +00:00
bool bShowBottomTabTitles;
bool bShowDeveloperMenu;
bool bShowAllocatorDebug;
// Double edged sword: much easier debugging, but not accurate.
bool bSkipDeadbeefFilling;
bool bFuncHashMap;
bool bDebugMemInfoDetailed;
2020-02-11 07:19:30 +00:00
bool bDrawFrameGraph;
// Volatile development settings
bool bShowFrameProfiler;
bool bGpuLogProfiler; // Controls the Vulkan logging profiler (profiles textures uploads etc).
// Various directories. Autoconfigured, not read from ini.
Path currentDirectory; // The directory selected in the game browsing window.
Path defaultCurrentDirectory; // Platform dependent, initialized at startup.
Path memStickDirectory;
Path flash0Directory;
Path internalDataDirectory;
Path appCacheDirectory;
2012-11-01 15:19:01 +00:00
// Data for upgrade prompt
std::string upgradeMessage; // The actual message from the server is currently not used, need a translation mechanism. So this just acts as a flag.
std::string upgradeVersion;
std::string dismissedVersion;
void Load(const char *iniFileName = nullptr, const char *controllerIniFilename = nullptr);
2021-07-25 13:33:11 +00:00
bool Save(const char *saveReason);
void Reload();
void RestoreDefaults(RestoreSettingsBits whatToRestore);
2016-08-27 18:38:05 +00:00
//per game config managment, should maybe be in it's own class
void changeGameSpecific(const std::string &gameId = "", const std::string &title = "");
bool createGameConfig(const std::string &game_id);
bool deleteGameConfig(const std::string& pGameId);
bool loadGameConfig(const std::string &game_id, const std::string &title);
bool saveGameConfig(const std::string &pGameId, const std::string &title);
void unloadGameConfig();
Path getGameConfigFile(const std::string &gameId);
bool hasGameConfig(const std::string &game_id);
void SetSearchPath(const Path &path);
const Path FindConfigFile(const std::string &baseFilename);
void UpdateIniLocation(const char *iniFileName = nullptr, const char *controllerIniFilename = nullptr);
// Utility functions for "recent" management
void AddRecent(const std::string &file);
void RemoveRecent(const std::string &file);
void CleanRecent();
static void DownloadCompletedCallback(http::Download &download);
void DismissUpgrade();
void ResetControlLayout();
void GetReportingInfo(UrlEncoder &data);
bool IsPortrait() const;
int NextValidBackend();
bool IsBackendEnabled(GPUBackend backend, bool validate = true);
bool UseFullScreen() const {
if (iForceFullScreen != -1)
return iForceFullScreen == 1;
return bFullScreen;
}
2022-07-12 05:01:06 +00:00
std::vector<std::string> RecentIsos() const;
bool HasRecentIsos() const;
void ClearRecentIsos();
const std::map<std::string, std::pair<std::string, int>> &GetLangValuesMapping();
2022-10-09 13:04:19 +00:00
bool LoadAppendedConfig();
void SetAppendedConfigIni(const Path &path);
2023-02-14 16:11:32 +00:00
void UpdateAfterSettingAutoFrameSkip();
void NotifyUpdatedCpuCore();
protected:
void LoadStandardControllerIni();
void LoadLangValuesMapping();
2016-08-27 18:38:05 +00:00
void PostLoadCleanup(bool gameSpecific);
void PreSaveCleanup(bool gameSpecific);
void PostSaveCleanup(bool gameSpecific);
2012-11-01 15:19:01 +00:00
private:
bool reload_ = false;
2014-12-30 18:05:36 +00:00
std::string gameId_;
std::string gameIdTitle_;
std::vector<std::string> recentIsos;
std::map<std::string, std::pair<std::string, int>> langValuesMapping_;
Path iniFilename_;
Path controllerIniFilename_;
Path searchPath_;
2022-10-09 13:04:19 +00:00
Path appendedConfigFileName_;
// A set make more sense, but won't have many entry, and I dont want to include the whole std::set header here
std::vector<std::string> appendedConfigUpdatedGames_;
ConfigPrivate *private_ = nullptr;
2012-11-01 15:19:01 +00:00
};
std::string CreateRandMAC();
// TODO: Find a better place for this.
extern http::Downloader g_DownloadManager;
extern Config g_Config;