RetroArch/general.h

533 lines
12 KiB
C
Raw Normal View History

2011-01-17 19:54:58 +00:00
/* SSNES - A Super Nintendo Entertainment System (SNES) Emulator frontend for libsnes.
2012-01-08 00:08:18 +00:00
* Copyright (C) 2010-2012 - Hans-Kristian Arntzen
2010-12-24 00:33:40 +00:00
*
* Some code herein may be based on code found in BSNES.
*
* SSNES 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.
*
* SSNES 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 SSNES.
* If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __SSNES_GENERAL_H
#define __SSNES_GENERAL_H
2011-12-24 12:46:12 +00:00
#include "boolean.h"
2010-12-29 18:43:17 +00:00
#include <stdio.h>
2011-10-17 18:46:38 +00:00
#include <time.h>
2012-01-02 12:32:25 +00:00
#include <limits.h>
#include <setjmp.h>
2011-10-17 18:46:38 +00:00
#include "driver.h"
2011-01-03 19:46:50 +00:00
#include "record/ffemu.h"
#include "message.h"
2011-01-31 15:48:42 +00:00
#include "rewind.h"
2011-02-02 11:10:27 +00:00
#include "movie.h"
2011-02-10 20:16:59 +00:00
#include "autosave.h"
2011-03-07 18:12:14 +00:00
#include "dynamic.h"
2011-04-17 11:30:59 +00:00
#include "cheats.h"
2011-05-13 19:05:28 +00:00
#include "audio/ext/ssnes_dsp.h"
#include "strl.h"
2011-01-07 16:59:53 +00:00
2011-11-30 15:40:52 +00:00
#ifdef __CELLOS_LV2__
#include <sys/timer.h>
#endif
2011-12-13 22:38:05 +00:00
#ifdef XENON
#include <time/time.h>
#endif
#if defined(XENON) || defined(__CELLOS_LV2__)
2012-01-07 10:32:39 +00:00
#undef PATH_MAX
#define PATH_MAX 4096
2011-12-13 22:38:05 +00:00
#endif
2011-01-07 16:59:53 +00:00
#ifdef HAVE_CONFIG_H
#include "config.h"
2011-01-07 16:59:53 +00:00
#endif
#ifdef HAVE_NETPLAY
#include "netplay.h"
#endif
#include "audio/resampler.h"
#if defined(_WIN32) && !defined(_XBOX)
2011-10-18 12:05:30 +00:00
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
2011-12-24 23:59:46 +00:00
#include "msvc/msvc_compat.h"
#elif defined(_XBOX)
#include <xtl.h>
#include "360/msvc_compat.h"
#endif
#define MAX_PLAYERS 8
2011-02-18 22:51:51 +00:00
enum ssnes_shader_type
{
SSNES_SHADER_CG,
SSNES_SHADER_BSNES,
SSNES_SHADER_AUTO,
SSNES_SHADER_NONE
};
2011-02-18 22:51:51 +00:00
// All config related settings go here.
2010-12-29 18:00:21 +00:00
struct settings
{
struct
{
char driver[32];
2010-12-29 18:00:21 +00:00
float xscale;
float yscale;
2010-12-29 18:18:37 +00:00
bool fullscreen;
2010-12-29 18:00:21 +00:00
unsigned fullscreen_x;
unsigned fullscreen_y;
bool vsync;
bool smooth;
bool force_aspect;
2011-05-05 12:13:12 +00:00
bool crop_overscan;
2011-01-06 19:01:32 +00:00
float aspect_ratio;
2012-01-02 12:32:25 +00:00
char cg_shader_path[PATH_MAX];
char bsnes_shader_path[PATH_MAX];
char filter_path[PATH_MAX];
enum ssnes_shader_type shader_type;
float refresh_rate;
2011-01-23 02:16:14 +00:00
2011-03-06 17:19:31 +00:00
bool render_to_texture;
2012-01-12 23:29:01 +00:00
float fbo_scale_x;
float fbo_scale_y;
2012-01-02 12:32:25 +00:00
char second_pass_shader[PATH_MAX];
2011-03-06 17:19:31 +00:00
bool second_pass_smooth;
2012-01-02 12:32:25 +00:00
char shader_dir[PATH_MAX];
2011-03-06 17:19:31 +00:00
2012-01-02 12:32:25 +00:00
char font_path[PATH_MAX];
2011-01-23 01:48:06 +00:00
unsigned font_size;
2011-11-09 23:15:41 +00:00
bool font_enable;
2012-01-11 21:52:25 +00:00
bool font_scale;
2011-01-23 01:59:44 +00:00
float msg_pos_x;
float msg_pos_y;
2011-09-05 15:00:28 +00:00
float msg_color_r;
float msg_color_g;
float msg_color_b;
2011-01-23 02:16:14 +00:00
bool force_16bit;
bool disable_composition;
2011-05-11 15:52:16 +00:00
2011-08-11 03:25:31 +00:00
bool hires_record;
bool post_filter_record;
2012-01-02 12:32:25 +00:00
char external_driver[PATH_MAX];
2010-12-29 18:00:21 +00:00
} video;
struct
{
char driver[32];
2010-12-29 18:00:21 +00:00
bool enable;
unsigned out_rate;
float in_rate;
float rate_step;
2012-01-02 12:32:25 +00:00
char device[PATH_MAX];
2010-12-29 18:00:21 +00:00
unsigned latency;
bool sync;
2011-05-13 19:05:28 +00:00
2012-01-02 12:32:25 +00:00
char dsp_plugin[PATH_MAX];
char external_driver[PATH_MAX];
2012-02-14 00:16:37 +00:00
bool rate_control;
float rate_control_delta;
2010-12-29 18:00:21 +00:00
} audio;
struct
{
char driver[32];
2012-01-30 00:20:35 +00:00
struct snes_keybind binds[MAX_PLAYERS][SSNES_BIND_LIST_END];
float axis_threshold;
2012-01-30 00:20:35 +00:00
int joypad_map[MAX_PLAYERS];
2011-02-20 11:12:53 +00:00
bool netplay_client_swap_input;
2010-12-29 18:00:21 +00:00
} input;
2010-12-30 12:54:49 +00:00
2012-01-02 12:32:25 +00:00
char libsnes[PATH_MAX];
char cheat_database[PATH_MAX];
char cheat_settings_path[PATH_MAX];
2011-01-31 17:06:57 +00:00
2012-01-02 12:32:25 +00:00
char screenshot_directory[PATH_MAX];
2011-05-15 15:16:29 +00:00
2011-01-31 17:06:57 +00:00
bool rewind_enable;
size_t rewind_buffer_size;
unsigned rewind_granularity;
2011-02-05 20:45:44 +00:00
bool pause_nonactive;
2011-02-10 20:16:59 +00:00
unsigned autosave_interval;
bool block_sram_overwrite;
2011-09-27 13:31:25 +00:00
bool savestate_auto_index;
2010-12-29 18:00:21 +00:00
};
2012-01-12 21:53:14 +00:00
// Settings and/or global state that is specific to a console-style implementation.
#ifdef SSNES_CONSOLE
2012-01-12 21:53:14 +00:00
struct console_settings
{
bool autostart_game;
2012-01-12 21:53:14 +00:00
bool block_config_read;
bool default_sram_dir_enable;
bool default_savestate_dir_enable;
bool external_launcher_support;
2012-02-11 18:22:51 +00:00
bool frame_advance_enable;
bool initialize_ssnes_enable;
bool ingame_menu_enable;
bool menu_enable;
2012-02-02 17:39:09 +00:00
bool overscan_enable;
bool return_to_launcher;
bool screenshots_enable;
bool throttle_enable;
bool triple_buffering_enable;
2012-02-02 17:39:09 +00:00
float overscan_amount;
2012-01-31 13:12:00 +00:00
uint32_t aspect_ratio_index;
uint32_t emulator_initialized;
2012-01-30 14:59:15 +00:00
uint32_t screen_orientation;
2012-01-17 22:59:23 +00:00
uint32_t current_resolution_index;
uint32_t current_resolution_id;
uint32_t ingame_menu_item;
2012-01-17 22:59:23 +00:00
uint32_t initial_resolution_id;
uint32_t mode_switch;
uint32_t *supported_resolutions;
uint32_t supported_resolutions_count;
2012-02-20 21:34:11 +00:00
uint32_t control_timer_expiration_frame_count;
uint32_t timer_expiration_frame_count;
2012-02-04 12:33:19 +00:00
#ifdef _XBOX
DWORD volume_device_type;
#endif
char cgp_path[PATH_MAX];
char rom_path[PATH_MAX];
2012-01-31 13:12:00 +00:00
char aspect_ratio_name[PATH_MAX];
char default_rom_startup_dir[PATH_MAX];
char default_savestate_dir[PATH_MAX];
char default_sram_dir[PATH_MAX];
2012-01-31 17:51:45 +00:00
float menu_font_size;
2012-01-12 21:53:14 +00:00
};
#endif
enum ssnes_game_type
{
SSNES_CART_NORMAL = 0,
SSNES_CART_SGB,
SSNES_CART_BSX,
SSNES_CART_BSX_SLOTTED,
2011-12-24 12:46:12 +00:00
SSNES_CART_SUFAMI
};
2011-02-18 22:51:51 +00:00
// All run-time- / command line flag-related globals go here.
2010-12-29 18:18:37 +00:00
struct global
{
bool verbose;
bool audio_active;
bool video_active;
bool force_fullscreen;
2010-12-29 18:43:17 +00:00
2011-01-10 13:29:00 +00:00
bool has_mouse[2];
bool has_scope[2];
bool has_justifier;
bool has_justifiers;
bool has_multitap;
2011-06-19 09:11:04 +00:00
bool disconnect_device[2];
2011-01-10 06:58:11 +00:00
2010-12-29 18:43:17 +00:00
FILE *rom_file;
enum ssnes_game_type game_type;
2011-02-02 10:47:05 +00:00
uint32_t cart_crc;
2012-01-02 12:32:25 +00:00
char gb_rom_path[PATH_MAX];
char bsx_rom_path[PATH_MAX];
char sufami_rom_path[2][PATH_MAX];
bool has_set_save_path;
bool has_set_state_path;
#ifdef HAVE_CONFIGFILE
2012-01-02 12:32:25 +00:00
char config_path[PATH_MAX];
#endif
2011-01-23 01:48:06 +00:00
2012-01-02 12:32:25 +00:00
char basename[PATH_MAX];
char savefile_name_srm[PATH_MAX];
char savefile_name_rtc[PATH_MAX]; // Make sure that fill_pathname has space.
char savefile_name_psrm[PATH_MAX];
char savefile_name_asrm[PATH_MAX];
char savefile_name_bsrm[PATH_MAX];
char savestate_name[PATH_MAX];
char xml_name[PATH_MAX];
2011-08-17 22:24:57 +00:00
bool ups_pref;
bool bps_pref;
2012-01-02 12:32:25 +00:00
char ups_name[PATH_MAX];
char bps_name[PATH_MAX];
2011-01-03 19:46:50 +00:00
2011-01-23 22:09:54 +00:00
unsigned state_slot;
struct
{
struct snes_geometry geom;
unsigned pitch; // If 0, has classic libsnes semantics.
2012-01-02 12:32:25 +00:00
char fullpath[PATH_MAX];
struct snes_system_timing timing;
bool timing_set;
2011-12-02 18:12:47 +00:00
bool need_fullpath;
char *environment;
char *environment_split;
} system;
struct
{
ssnes_resampler_t *source;
float *data;
size_t data_ptr;
size_t chunk_size;
size_t nonblock_chunk_size;
size_t block_chunk_size;
2011-10-15 14:16:13 +00:00
double src_ratio;
bool use_float;
2011-11-26 14:54:58 +00:00
bool mute;
float *outsamples;
int16_t *conv_outsamples;
2011-05-13 19:05:28 +00:00
2011-10-15 12:33:41 +00:00
int16_t *rewind_buf;
size_t rewind_ptr;
size_t rewind_size;
2011-05-13 19:05:28 +00:00
dylib_t dsp_lib;
const ssnes_dsp_plugin_t *dsp_plugin;
void *dsp_handle;
2012-02-14 00:16:37 +00:00
bool rate_control;
double orig_src_ratio;
size_t driver_buffer_size;
} audio_data;
2011-03-07 18:12:14 +00:00
struct
{
bool active;
uint32_t *buffer;
uint32_t *colormap;
unsigned pitch;
dylib_t lib;
unsigned scale;
void (*psize)(unsigned *width, unsigned *height);
void (*prender)(uint32_t *colormap, uint32_t *output, unsigned outpitch,
const uint16_t *input, unsigned pitch, unsigned width, unsigned height);
} filter;
msg_queue_t *msg_queue;
2011-02-18 22:51:51 +00:00
// Rewind support.
2011-01-31 15:48:42 +00:00
state_manager_t *state_manager;
void *state_buf;
size_t state_size;
bool frame_is_reverse;
2011-01-31 15:48:42 +00:00
2011-11-20 19:19:05 +00:00
// Movie playback/recording support.
struct
{
bsv_movie_t *movie;
2012-01-02 12:32:25 +00:00
char movie_path[PATH_MAX];
2011-11-20 19:19:05 +00:00
bool movie_playback;
// Immediate playback/recording.
2012-01-02 12:32:25 +00:00
char movie_start_path[PATH_MAX];
2011-11-20 19:19:05 +00:00
bool movie_start_recording;
bool movie_start_playback;
bool movie_end;
} bsv;
bool sram_load_disable;
bool sram_save_disable;
bool use_sram;
2011-11-18 17:03:24 +00:00
2011-02-18 22:51:51 +00:00
// Pausing support
2011-02-05 19:46:58 +00:00
bool is_paused;
2011-10-17 19:30:58 +00:00
bool is_oneshot;
2011-02-05 19:46:58 +00:00
2011-02-18 22:51:51 +00:00
// Autosave support.
2011-02-11 12:44:31 +00:00
autosave_t *autosave[2];
2011-02-10 20:16:59 +00:00
2011-02-18 22:51:51 +00:00
// Netplay.
#ifdef HAVE_NETPLAY
2011-02-13 15:40:24 +00:00
netplay_t *netplay;
2012-01-02 12:32:25 +00:00
char netplay_server[PATH_MAX];
2011-02-13 15:40:24 +00:00
bool netplay_enable;
2011-02-13 16:45:14 +00:00
bool netplay_is_client;
2012-01-11 18:22:18 +00:00
bool netplay_is_spectate;
2011-02-15 14:32:26 +00:00
unsigned netplay_sync_frames;
2011-02-18 13:49:15 +00:00
uint16_t netplay_port;
2012-01-21 17:12:42 +00:00
char netplay_nick[32];
#endif
2011-02-13 15:40:24 +00:00
2011-02-18 22:51:51 +00:00
// FFmpeg record.
#ifdef HAVE_FFMPEG
2011-01-03 19:46:50 +00:00
ffemu_t *rec;
2012-01-02 12:32:25 +00:00
char record_path[PATH_MAX];
bool recording;
2011-10-06 21:43:48 +00:00
unsigned record_width;
unsigned record_height;
#endif
2011-03-17 00:25:44 +00:00
struct
{
const uint16_t *data;
unsigned width;
unsigned height;
} frame_cache;
2011-03-17 00:25:44 +00:00
char title_buf[64];
struct
{
2011-11-05 10:44:17 +00:00
char **elems;
size_t size;
size_t ptr;
} shader_dir;
2011-04-17 10:29:58 +00:00
2011-05-15 15:16:29 +00:00
char sha256[64 + 1];
2011-04-17 11:30:59 +00:00
#ifdef HAVE_XML
cheat_manager_t *cheat;
#endif
bool error_in_init;
char error_string[1024];
jmp_buf error_sjlj_context;
2010-12-29 18:18:37 +00:00
};
// Public functions
2012-01-28 14:47:02 +00:00
void config_load(void);
2012-01-12 21:53:14 +00:00
void config_set_defaults(void);
#ifdef HAVE_CONFIGFILE
2012-02-13 18:20:24 +00:00
#include "conf/config_file.h"
2012-01-28 14:47:02 +00:00
bool config_load_file(const char *path);
2012-02-13 18:20:24 +00:00
void config_read_keybinds(config_file_t *conf);
2012-02-20 19:36:21 +00:00
void config_save_keybinds(config_file_t *conf);
#endif
2010-12-29 18:00:21 +00:00
void ssnes_game_reset(void);
void ssnes_main_clear_state(void);
int ssnes_main_init(int argc, char *argv[]);
bool ssnes_main_iterate(void);
void ssnes_main_deinit(void);
void ssnes_render_cached_frame(void);
void ssnes_load_state(void);
void ssnes_save_state(void);
void ssnes_state_slot_increase(void);
void ssnes_state_slot_decrease(void);
/////////
// Public data structures
2010-12-29 18:00:21 +00:00
extern struct settings g_settings;
2010-12-29 18:18:37 +00:00
extern struct global g_extern;
#ifdef SSNES_CONSOLE
2012-01-12 21:53:14 +00:00
extern struct console_settings g_console;
#endif
/////////
2010-12-29 18:18:37 +00:00
#if defined(SSNES_CONSOLE) && defined(HAVE_LOGGER)
#include "logger_override.h"
#else
#define SSNES_LOG(...) do { \
2010-12-29 18:18:37 +00:00
if (g_extern.verbose) \
fprintf(stderr, "SSNES: " __VA_ARGS__); \
2011-01-07 16:59:53 +00:00
fflush(stderr); \
2011-10-15 10:56:48 +00:00
} while (0)
2010-12-29 18:18:37 +00:00
#define SSNES_ERR(...) do { \
fprintf(stderr, "SSNES [ERROR] :: " __VA_ARGS__); \
2011-01-07 16:59:53 +00:00
fflush(stderr); \
2011-10-15 10:56:48 +00:00
} while (0)
#define SSNES_WARN(...) do { \
fprintf(stderr, "SSNES [WARN] :: " __VA_ARGS__); \
2011-01-07 16:59:53 +00:00
fflush(stderr); \
2011-10-15 10:56:48 +00:00
} while (0)
#endif
#ifndef max
#define max(a, b) ((a) > (b) ? (a) : (b))
#endif
#ifndef min
#define min(a, b) ((a) < (b) ? (a) : (b))
#endif
#define SSNES_SCALE_BASE 256
2011-03-07 18:12:14 +00:00
static inline uint32_t next_pow2(uint32_t v)
{
v--;
v |= v >> 1;
v |= v >> 2;
v |= v >> 4;
v |= v >> 8;
v |= v >> 16;
v++;
return v;
}
2011-07-25 22:53:24 +00:00
static inline uint8_t is_little_endian(void)
{
union
{
uint16_t x;
uint8_t y[2];
} u;
u.x = 1;
return u.y[0];
}
2012-01-02 11:12:30 +00:00
#ifdef GEKKO
#include <unistd.h>
#endif
2011-11-30 15:26:23 +00:00
static inline void ssnes_sleep(unsigned msec)
2011-10-17 18:46:38 +00:00
{
2011-11-30 15:40:52 +00:00
#ifdef __CELLOS_LV2__
sys_timer_usleep(1000 * msec);
#elif defined(_WIN32)
2011-11-30 15:26:23 +00:00
Sleep(msec);
2011-12-10 16:41:16 +00:00
#elif defined(XENON)
2011-12-13 22:38:05 +00:00
udelay(1000 * msec);
2011-12-14 11:49:13 +00:00
#elif defined(GEKKO)
usleep(1000 * msec);
2011-10-17 18:46:38 +00:00
#else
2011-12-24 12:46:12 +00:00
struct timespec tv = {0};
tv.tv_sec = msec / 1000;
tv.tv_nsec = (msec % 1000) * 1000000;
2011-10-17 18:46:38 +00:00
nanosleep(&tv, NULL);
#endif
}
2011-12-25 11:13:19 +00:00
#define ssnes_assert(cond) \
2012-02-11 20:11:36 +00:00
if (!(cond)) { SSNES_ERR("Assertion failed at %s:%d.\n", __FILE__, __LINE__); exit(2); }
2011-12-25 11:13:19 +00:00
static inline void ssnes_fail(int error_code, const char *error)
{
// We cannot longjmp unless we're in ssnes_main_init().
// If not, something went very wrong, and we should just exit right away.
ssnes_assert(g_extern.error_in_init);
strlcpy(g_extern.error_string, error, sizeof(g_extern.error_string));
longjmp(g_extern.error_sjlj_context, error_code);
}
#endif
2011-03-07 18:12:14 +00:00