RetroArch/configuration.h

657 lines
18 KiB
C
Raw Normal View History

2015-01-09 15:56:21 +00:00
/* RetroArch - A frontend for libretro.
* Copyright (C) 2010-2014 - Hans-Kristian Arntzen
2016-01-10 03:06:50 +00:00
* Copyright (C) 2011-2016 - Daniel De Matteis
* Copyright (C) 2014-2016 - Jean-André Santoni
2016-10-27 15:47:10 +00:00
* Copyright (C) 2016 - Brad Parker
*
2015-01-09 15:56:21 +00:00
* RetroArch 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 Found-
* ation, either version 3 of the License, or (at your option) any later version.
*
* RetroArch 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 RetroArch.
* If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __RARCH_CONFIGURATION_H__
#define __RARCH_CONFIGURATION_H__
2015-01-09 15:56:21 +00:00
2015-03-21 06:05:08 +00:00
#include <stdint.h>
2015-12-05 06:45:36 +00:00
2015-12-06 12:12:27 +00:00
#include <boolean.h>
#include <retro_common_api.h>
2017-04-29 11:20:50 +00:00
#include <retro_miscellaneous.h>
2015-12-05 06:45:36 +00:00
#include "gfx/video_driver.h"
2016-09-05 15:29:19 +00:00
#include "input/input_defines.h"
#include "led/led_defines.h"
2015-03-21 06:05:08 +00:00
2017-09-27 22:03:50 +00:00
#define configuration_set_float(settings, var, newvar) \
2017-12-03 02:43:05 +00:00
{ \
2017-09-27 22:03:50 +00:00
settings->modified = true; \
2017-12-03 02:43:05 +00:00
var = newvar; \
}
2017-09-27 22:03:50 +00:00
#define configuration_set_bool(settings, var, newvar) \
2017-12-03 02:43:05 +00:00
{ \
2017-09-27 22:03:50 +00:00
settings->modified = true; \
2017-12-03 02:43:05 +00:00
var = newvar; \
}
2017-09-27 22:03:50 +00:00
#define configuration_set_uint(settings, var, newvar) \
2017-12-03 02:43:05 +00:00
{ \
2017-09-27 22:03:50 +00:00
settings->modified = true; \
2017-12-03 02:43:05 +00:00
var = newvar; \
}
2017-09-27 22:03:50 +00:00
#define configuration_set_int(settings, var, newvar) \
2017-12-03 02:43:05 +00:00
{ \
2017-09-27 22:03:50 +00:00
settings->modified = true; \
2017-12-03 02:43:05 +00:00
var = newvar; \
}
2017-09-27 22:03:50 +00:00
2016-08-31 13:21:12 +00:00
enum override_type
{
OVERRIDE_NONE = 0,
OVERRIDE_CORE,
OVERRIDE_GAME
};
2016-08-26 05:44:05 +00:00
RETRO_BEGIN_DECLS
2015-01-09 15:56:21 +00:00
2015-03-20 18:32:46 +00:00
typedef struct settings
{
2017-04-27 22:00:43 +00:00
struct
{
bool placeholder;
2017-04-27 22:53:06 +00:00
2017-04-28 11:43:47 +00:00
/* Video */
2017-04-27 22:53:06 +00:00
bool video_fullscreen;
bool video_windowed_fullscreen;
bool video_vsync;
bool video_hard_sync;
bool video_black_frame_insertion;
bool video_vfilter;
bool video_smooth;
bool video_force_aspect;
bool video_crop_overscan;
bool video_aspect_ratio_auto;
bool video_scale_integer;
bool video_shader_enable;
bool video_shader_watch_files;
2017-04-27 22:53:06 +00:00
bool video_threaded;
bool video_font_enable;
bool video_disable_composition;
bool video_post_filter_record;
bool video_gpu_record;
bool video_gpu_screenshot;
bool video_allow_rotate;
bool video_shared_context;
bool video_force_srgb_disable;
2017-04-28 10:26:01 +00:00
bool video_fps_show;
bool video_framecount_show;
bool video_msg_bgcolor_enable;
2017-04-27 22:53:06 +00:00
2017-04-28 11:43:47 +00:00
/* Audio */
2017-04-28 10:23:59 +00:00
bool audio_enable;
bool audio_sync;
bool audio_rate_control;
bool audio_wasapi_exclusive_mode;
bool audio_wasapi_float_format;
2017-04-28 11:43:47 +00:00
/* Input */
bool input_remap_binds_enable;
bool input_autodetect_enable;
bool input_overlay_enable;
bool input_overlay_enable_autopreferred;
bool input_overlay_hide_in_menu;
bool input_overlay_show_physical_inputs;
2017-04-28 11:43:47 +00:00
bool input_descriptor_label_show;
bool input_descriptor_hide_unbound;
bool input_all_users_control_menu;
bool input_menu_swap_ok_cancel_buttons;
bool input_backtouch_enable;
bool input_backtouch_toggle;
bool input_small_keyboard_enable;
bool input_keyboard_gamepad_enable;
/* Menu */
2017-05-31 22:25:13 +00:00
bool filter_by_current_core;
2017-04-28 11:43:47 +00:00
bool menu_show_start_screen;
bool menu_pause_libretro;
bool menu_timedate_enable;
bool menu_battery_level_enable;
bool menu_core_enable;
bool menu_dynamic_wallpaper_enable;
bool menu_throttle;
bool menu_mouse_enable;
bool menu_pointer_enable;
bool menu_navigation_wraparound_enable;
bool menu_navigation_browser_filter_supported_extensions_enable;
bool menu_dpi_override_enable;
bool menu_show_advanced_settings;
bool menu_throttle_framerate;
bool menu_linear_filter;
2017-07-14 19:11:27 +00:00
bool menu_horizontal_animation;
2017-06-19 23:42:28 +00:00
bool menu_show_online_updater;
2017-06-20 00:22:07 +00:00
bool menu_show_core_updater;
bool menu_show_load_core;
bool menu_show_load_content;
bool menu_show_information;
bool menu_show_configurations;
bool menu_show_help;
bool menu_show_quit_retroarch;
bool menu_show_reboot;
bool menu_materialui_icons_enable;
2017-04-28 11:43:47 +00:00
bool menu_xmb_shadows_enable;
bool menu_content_show_settings;
bool menu_content_show_favorites;
bool menu_content_show_images;
bool menu_content_show_music;
bool menu_content_show_video;
bool menu_content_show_netplay;
bool menu_content_show_history;
bool menu_content_show_add;
2017-04-28 11:43:47 +00:00
bool menu_unified_controls;
bool quick_menu_show_take_screenshot;
bool quick_menu_show_save_load_state;
bool quick_menu_show_undo_save_load_state;
bool quick_menu_show_add_to_favorites;
bool quick_menu_show_options;
bool quick_menu_show_controls;
bool quick_menu_show_cheats;
bool quick_menu_show_shaders;
bool quick_menu_show_save_core_overrides;
bool quick_menu_show_save_game_overrides;
bool quick_menu_show_information;
bool kiosk_mode_enable;
2017-04-28 11:43:47 +00:00
/* Netplay */
bool netplay_public_announce;
bool netplay_start_as_spectator;
bool netplay_allow_slaves;
bool netplay_require_slaves;
bool netplay_stateless_mode;
bool netplay_nat_traversal;
bool netplay_use_mitm_server;
bool netplay_request_devices[MAX_USERS];
2017-04-28 11:43:47 +00:00
/* Network */
bool network_buildbot_auto_extract_archive;
/* UI */
2017-04-27 22:53:06 +00:00
bool ui_menubar_enable;
bool ui_suspend_screensaver_enable;
bool ui_companion_start_on_boot;
bool ui_companion_enable;
2017-04-28 11:43:47 +00:00
/* Cheevos */
bool cheevos_enable;
bool cheevos_test_unofficial;
bool cheevos_hardcore_mode_enable;
2017-10-31 05:58:35 +00:00
bool cheevos_leaderboards_enable;
2017-11-23 16:55:53 +00:00
bool cheevos_badges_enable;
bool cheevos_verbose_enable;
2018-03-14 07:49:48 +00:00
bool cheevos_auto_screenshot;
2017-04-28 11:43:47 +00:00
/* Camera */
bool camera_allow;
/* WiFi */
bool wifi_allow;
/* Location */
bool location_allow;
/* Multimedia */
bool multimedia_builtin_mediaplayer_enable;
bool multimedia_builtin_imageviewer_enable;
/* Bundle */
bool bundle_finished;
bool bundle_assets_extract_enable;
/* Misc. */
bool threaded_data_runloop_enable;
bool set_supports_no_game_enable;
bool auto_screenshot_filename;
bool history_list_enable;
bool playlist_entry_remove;
bool playlist_entry_rename;
2017-04-28 11:43:47 +00:00
bool rewind_enable;
bool pause_nonactive;
bool block_sram_overwrite;
bool savestate_auto_index;
bool savestate_auto_save;
bool savestate_auto_load;
bool savestate_thumbnail_enable;
bool network_cmd_enable;
bool stdin_cmd_enable;
2017-09-10 16:57:07 +00:00
bool keymapper_enable;
2017-04-28 11:43:47 +00:00
bool network_remote_enable;
bool network_remote_enable_user[MAX_USERS];
bool load_dummy_on_core_shutdown;
bool check_firmware_before_loading;
bool game_specific_options;
bool auto_overrides_enable;
bool auto_remaps_enable;
bool auto_shaders_enable;
bool sort_savefiles_enable;
bool sort_savestates_enable;
bool config_save_on_exit;
bool show_hidden_files;
2017-08-05 17:31:58 +00:00
bool savefiles_in_content_dir;
bool savestates_in_content_dir;
bool screenshots_in_content_dir;
bool systemfiles_in_content_dir;
2017-04-28 11:43:47 +00:00
bool ssh_enable;
bool samba_enable;
bool bluetooth_enable;
bool automatically_add_content_to_playlist;
bool video_window_show_decorations;
2017-04-27 22:00:43 +00:00
} bools;
2017-04-28 12:57:55 +00:00
struct
{
float placeholder;
float video_scale;
float video_aspect_ratio;
float video_refresh_rate;
float video_font_size;
float video_msg_pos_x;
float video_msg_pos_y;
float video_msg_color_r;
float video_msg_color_g;
float video_msg_color_b;
float video_msg_bgcolor_opacity;
2017-04-28 12:57:55 +00:00
float menu_wallpaper_opacity;
float menu_framebuffer_opacity;
2017-04-28 12:57:55 +00:00
float menu_footer_opacity;
float menu_header_opacity;
float audio_max_timing_skew;
float audio_volume; /* dB scale. */
2017-06-08 20:58:43 +00:00
float audio_mixer_volume; /* dB scale. */
2017-04-28 12:57:55 +00:00
float input_overlay_opacity;
float input_overlay_scale;
float slowmotion_ratio;
float fastforward_ratio;
} floats;
2017-04-28 17:12:48 +00:00
struct
{
2017-04-28 18:08:12 +00:00
int placeholder;
2017-04-28 17:12:48 +00:00
int netplay_check_frames;
int location_update_interval_ms;
int location_update_interval_distance;
int state_slot;
2017-05-24 14:25:36 +00:00
int audio_wasapi_sh_buffer_length;
2017-04-28 17:12:48 +00:00
} ints;
2017-04-28 19:03:04 +00:00
struct
{
unsigned placeholder;
unsigned audio_out_rate;
unsigned audio_block_frames;
unsigned audio_latency;
unsigned audio_resampler_quality;
2017-04-28 19:03:04 +00:00
unsigned input_turbo_period;
unsigned input_turbo_duty_cycle;
unsigned input_bind_timeout;
unsigned input_menu_toggle_gamepad_combo;
unsigned input_keyboard_gamepad_mapping_type;
unsigned input_poll_type_behavior;
unsigned netplay_port;
unsigned netplay_input_latency_frames_min;
unsigned netplay_input_latency_frames_range;
unsigned netplay_share_digital;
unsigned netplay_share_analog;
2017-04-28 19:03:04 +00:00
unsigned bundle_assets_extract_version_current;
unsigned bundle_assets_extract_last_version;
unsigned content_history_size;
unsigned libretro_log_level;
unsigned rewind_granularity;
unsigned autosave_interval;
unsigned network_cmd_port;
unsigned network_remote_base_port;
2017-09-10 16:57:07 +00:00
unsigned keymapper_port;
2017-04-28 19:03:04 +00:00
unsigned video_window_x;
unsigned video_window_y;
unsigned video_window_opacity;
2017-04-28 19:03:04 +00:00
unsigned video_monitor_index;
unsigned video_fullscreen_x;
unsigned video_fullscreen_y;
unsigned video_max_swapchain_images;
unsigned video_swap_interval;
unsigned video_hard_sync_frames;
unsigned video_frame_delay;
unsigned video_viwidth;
unsigned video_aspect_ratio_idx;
unsigned video_rotation;
unsigned video_msg_bgcolor_red;
unsigned video_msg_bgcolor_green;
unsigned video_msg_bgcolor_blue;
2017-04-28 19:03:04 +00:00
unsigned menu_thumbnails;
unsigned menu_dpi_override_value;
unsigned menu_entry_normal_color;
unsigned menu_entry_hover_color;
unsigned menu_title_color;
unsigned menu_xmb_shader_pipeline;
unsigned menu_xmb_scale_factor;
unsigned menu_xmb_alpha_factor;
unsigned menu_xmb_theme;
unsigned menu_xmb_color_theme;
unsigned menu_materialui_color_theme;
unsigned menu_font_color_red;
unsigned menu_font_color_green;
unsigned menu_font_color_blue;
2017-04-28 19:03:04 +00:00
unsigned camera_width;
unsigned camera_height;
unsigned input_overlay_show_physical_inputs_port;
2017-09-27 22:09:59 +00:00
unsigned input_joypad_map[MAX_USERS];
unsigned input_device[MAX_USERS];
unsigned input_mouse_index[MAX_USERS];
/* Set by autoconfiguration in joypad_autoconfig_dir.
* Does not override main binds. */
unsigned input_libretro_device[MAX_USERS];
unsigned input_analog_dpad_mode[MAX_USERS];
unsigned input_keymapper_ids[RARCH_CUSTOM_BIND_LIST_END];
unsigned input_remap_ids[MAX_USERS][RARCH_CUSTOM_BIND_LIST_END];
unsigned led_map[MAX_LEDS];
2017-04-28 19:03:04 +00:00
} uints;
2017-04-28 20:59:13 +00:00
struct
{
2017-04-28 21:02:22 +00:00
char placeholder;
2017-04-28 20:59:13 +00:00
char video_driver[32];
char record_driver[32];
char camera_driver[32];
char wifi_driver[32];
char led_driver[32];
2017-04-28 20:59:13 +00:00
char location_driver[32];
char menu_driver[32];
char cheevos_username[32];
char cheevos_password[32];
char video_context_driver[32];
char audio_driver[32];
char audio_resampler[32];
char input_driver[32];
char input_joypad_driver[32];
2017-09-27 22:09:59 +00:00
2017-04-28 20:59:13 +00:00
char input_keyboard_layout[64];
2017-09-27 22:09:59 +00:00
char audio_device[255];
char camera_device[255];
char playlist_names[PATH_MAX_LENGTH];
char playlist_cores[PATH_MAX_LENGTH];
2017-04-28 20:59:13 +00:00
char bundle_assets_src[PATH_MAX_LENGTH];
char bundle_assets_dst[PATH_MAX_LENGTH];
char bundle_assets_dst_subdir[PATH_MAX_LENGTH];
char netplay_mitm_server[255];
2017-04-28 20:59:13 +00:00
} arrays;
struct
{
2017-04-28 22:39:29 +00:00
char placeholder;
2016-12-26 05:39:12 +00:00
2017-09-27 22:09:59 +00:00
char username[32];
char netplay_password[128];
char netplay_spectate_password[128];
char netplay_server[255];
char network_buildbot_url[255];
char network_buildbot_assets_url[255];
2017-04-28 22:39:29 +00:00
char browse_url[4096];
2016-04-28 17:26:02 +00:00
2017-04-28 22:39:29 +00:00
char path_menu_xmb_font[PATH_MAX_LENGTH];
char menu_content_show_settings_password[PATH_MAX_LENGTH];
char kiosk_mode_password[PATH_MAX_LENGTH];
2017-04-28 22:39:29 +00:00
char path_cheat_database[PATH_MAX_LENGTH];
char path_content_database[PATH_MAX_LENGTH];
char path_overlay[PATH_MAX_LENGTH];
char path_menu_wallpaper[PATH_MAX_LENGTH];
char path_audio_dsp_plugin[PATH_MAX_LENGTH];
char path_softfilter_plugin[PATH_MAX_LENGTH];
char path_core_options[PATH_MAX_LENGTH];
char path_content_history[PATH_MAX_LENGTH];
2017-08-12 15:10:14 +00:00
char path_content_favorites[PATH_MAX_LENGTH];
2017-04-28 22:39:29 +00:00
char path_content_music_history[PATH_MAX_LENGTH];
char path_content_image_history[PATH_MAX_LENGTH];
char path_content_video_history[PATH_MAX_LENGTH];
char path_libretro_info[PATH_MAX_LENGTH];
char path_cheat_settings[PATH_MAX_LENGTH];
char path_shader[PATH_MAX_LENGTH];
char path_font[PATH_MAX_LENGTH];
char directory_audio_filter[PATH_MAX_LENGTH];
char directory_autoconfig[PATH_MAX_LENGTH];
char directory_video_filter[PATH_MAX_LENGTH];
char directory_video_shader[PATH_MAX_LENGTH];
char directory_content_history[PATH_MAX_LENGTH];
2017-08-12 15:10:14 +00:00
char directory_content_favorites[PATH_MAX_LENGTH];
2017-04-28 22:39:29 +00:00
char directory_libretro[PATH_MAX_LENGTH];
char directory_cursor[PATH_MAX_LENGTH];
char directory_input_remapping[PATH_MAX_LENGTH];
char directory_overlay[PATH_MAX_LENGTH];
char directory_resampler[PATH_MAX_LENGTH];
char directory_screenshot[PATH_MAX_LENGTH];
char directory_system[PATH_MAX_LENGTH];
char directory_cache[PATH_MAX_LENGTH];
char directory_playlist[PATH_MAX_LENGTH];
char directory_core_assets[PATH_MAX_LENGTH];
char directory_assets[PATH_MAX_LENGTH];
char directory_dynamic_wallpapers[PATH_MAX_LENGTH];
char directory_thumbnails[PATH_MAX_LENGTH];
char directory_menu_config[PATH_MAX_LENGTH];
char directory_menu_content[PATH_MAX_LENGTH];
} paths;
bool modified;
video_viewport_t video_viewport_custom;
2017-04-28 22:39:29 +00:00
size_t rewind_buffer_size;
2015-03-20 18:32:46 +00:00
} settings_t;
2015-01-11 04:29:32 +00:00
/**
* config_get_default_camera:
*
* Gets default camera driver.
*
* Returns: Default camera driver.
**/
2015-01-09 15:56:21 +00:00
const char *config_get_default_camera(void);
/**
* config_get_default_wifi:
*
* Gets default wifi driver.
*
* Returns: Default wifi driver.
**/
const char *config_get_default_wifi(void);
2015-01-11 04:29:32 +00:00
/**
* config_get_default_location:
*
* Gets default location driver.
*
* Returns: Default location driver.
**/
2015-01-09 15:56:21 +00:00
const char *config_get_default_location(void);
2015-01-11 04:29:32 +00:00
/**
* config_get_default_video:
*
* Gets default video driver.
*
* Returns: Default video driver.
**/
2015-01-09 15:56:21 +00:00
const char *config_get_default_video(void);
2015-01-11 04:29:32 +00:00
/**
* config_get_default_audio:
*
* Gets default audio driver.
*
* Returns: Default audio driver.
**/
2015-01-09 15:56:21 +00:00
const char *config_get_default_audio(void);
2015-01-11 04:29:32 +00:00
/**
* config_get_default_audio_resampler:
*
* Gets default audio resampler driver.
*
* Returns: Default audio resampler driver.
**/
2015-01-09 15:56:21 +00:00
const char *config_get_default_audio_resampler(void);
2015-01-11 04:29:32 +00:00
/**
* config_get_default_input:
*
* Gets default input driver.
*
* Returns: Default input driver.
**/
2015-01-09 15:56:21 +00:00
const char *config_get_default_input(void);
2015-01-11 04:29:32 +00:00
/**
* config_get_default_joypad:
*
* Gets default input joypad driver.
*
* Returns: Default input joypad driver.
**/
2015-01-09 15:56:21 +00:00
const char *config_get_default_joypad(void);
2015-01-11 04:29:32 +00:00
/**
* config_get_default_menu:
*
* Gets default menu driver.
*
* Returns: Default menu driver.
**/
2015-01-09 15:56:21 +00:00
const char *config_get_default_menu(void);
2015-04-15 11:37:38 +00:00
const char *config_get_default_record(void);
2015-01-09 15:56:21 +00:00
/**
* config_load:
*
* Loads a config file and reads all the values into memory.
*
*/
void config_load(void);
/**
* config_load_override:
*
* Tries to append game-specific and core-specific configuration.
* These settings will always have precedence, thus this feature
* can be used to enforce overrides.
*
* Returns: false if there was an error or no action was performed.
*
*/
bool config_load_override(void);
/**
* config_unload_override:
*
* Unloads configuration overrides if overrides are active.
*
*
* Returns: false if there was an error.
*/
bool config_unload_override(void);
/**
* config_load_remap:
*
* Tries to append game-specific and core-specific remap files.
*
* Returns: false if there was an error or no action was performed.
*
*/
bool config_load_remap(void);
2016-07-30 18:55:50 +00:00
/**
* config_load_shader_preset:
*
* Tries to append game-specific and core-specific shader presets.
*
* Returns: false if there was an error or no action was performed.
*
*/
bool config_load_shader_preset(void);
/**
* config_save_autoconf_profile:
* @path : Path that shall be written to.
* @user : Controller number to save
* Writes a controller autoconf file to disk.
**/
bool config_save_autoconf_profile(const char *path, unsigned user);
2015-01-09 15:56:21 +00:00
/**
* config_save_file:
* @path : Path that shall be written to.
*
* Writes a config file to disk.
*
* Returns: true (1) on success, otherwise returns false (0).
2015-01-19 06:43:28 +00:00
**/
2015-01-09 15:56:21 +00:00
bool config_save_file(const char *path);
2016-08-25 06:34:51 +00:00
/**
2016-08-26 14:43:29 +00:00
* config_save_overrides:
2016-08-25 06:34:51 +00:00
* @path : Path that shall be written to.
*
* Writes a config file override to disk.
*
* Returns: true (1) on success, otherwise returns false (0).
**/
2016-08-26 14:43:29 +00:00
bool config_save_overrides(int override_type);
2016-08-25 06:34:51 +00:00
2016-05-27 14:42:20 +00:00
/* Replaces currently loaded configuration file with
* another one. Will load a dummy core to flush state
* properly. */
2017-01-24 17:08:26 +00:00
bool config_replace(bool config_save_on_exit, char *path);
2016-05-27 14:42:20 +00:00
2016-05-27 03:05:27 +00:00
bool config_init(void);
2015-03-21 00:47:06 +00:00
2016-08-01 12:14:21 +00:00
bool config_overlay_enable_default(void);
2015-03-21 00:47:06 +00:00
void config_free(void);
2015-03-20 18:32:46 +00:00
settings_t *config_get_ptr(void);
RETRO_END_DECLS
2015-01-09 15:56:21 +00:00
#endif