diff options
| author | neonloop | 2021-08-04 15:09:12 +0000 |
|---|---|---|
| committer | neonloop | 2021-08-04 15:09:12 +0000 |
| commit | 99632f66e74fc57c463072be312d634aeb67bc61 (patch) | |
| tree | e4ccaf52b93d04c69865d82556e2ce4cd3a6c599 | |
| download | picoarch-99632f66e74fc57c463072be312d634aeb67bc61.tar.gz picoarch-99632f66e74fc57c463072be312d634aeb67bc61.tar.bz2 picoarch-99632f66e74fc57c463072be312d634aeb67bc61.zip | |
Initial commit
36 files changed, 9153 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0c4c792 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +*.o +*.so +/pkg +/profile +picoarch + +/gpsp +/snes9x2002 +/snes9x2005
\ No newline at end of file diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..4adc002 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "libpicofe"] + path = libpicofe + url = https://github.com/notaz/libpicofe @@ -0,0 +1,49 @@ +This project uses code from libpicofe as a submodule. To accommodate various needs, it is +triple-licensed with these licenses: + - GNU GPL, version 2 or later. + - GNU LGPL, version 2.1 or later. + - MAME license. +When used as part of another project, host project's license usually applies +to combined source code as a whole. + +The library also contains filters by Roman Pauer (M-HT), that are licensed +under MIT license, which is compatible with the above licenses. + +-------- + +libretro cores are built separately, and patched with patches located +in patches/. They retain their individual licenses, and the patches +are licensed under the same terms. + +-------- + +The remainder of the code is licensed under the BSD 3-clause license: + +Copyright 2021 neonloop + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + +1. Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright +notice, this list of conditions and the following disclaimer in the +documentation and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its +contributors may be used to endorse or promote products derived from +this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..488e17b --- /dev/null +++ b/Makefile @@ -0,0 +1,181 @@ +# Global definitions +platform ?= unix + +CC = $(CROSS_COMPILE)gcc +SYSROOT = $(shell $(CC) --print-sysroot) + +OBJS = libpicofe/input.o libpicofe/in_sdl.o libpicofe/linux/in_evdev.o libpicofe/linux/plat.o libpicofe/fonts.o libpicofe/readpng.o libpicofe/config_file.o config.o core.o menu.o main.o options.o scale.o unzip.o + +BIN = picoarch + +CFLAGS += -Wall +CFLAGS += -fdata-sections -ffunction-sections -DPICO_HOME_DIR='"/.picoarch/"' -flto -fno-PIC +CFLAGS += -I./ $(shell $(SYSROOT)/usr/bin/sdl-config --cflags) + +LDFLAGS = -lc -ldl -lgcc -lSDL -lasound -lpng -lz -Wl,--gc-sections -flto -fno-PIC + +CORES = gpsp snes9x2002 snes9x2005 + +ifeq ($(platform), trimui) + OBJS += plat_trimui.o + CFLAGS += -mcpu=arm926ej-s -mtune=arm926ej-s + +else ifeq ($(platform), unix) + OBJS += plat_linux.o + LDFLAGS += -fPIE +endif + +ifeq ($(DEBUG), 1) + CFLAGS += -Og -g +else + CFLAGS += -Ofast -DNDEBUG + +ifneq ($(PROFILE), 1) + LDFLAGS += -s +endif + +endif + +ifeq ($(PROFILE), 1) + CFLAGS += -fno-omit-frame-pointer -pg -g + LDFLAGS += -pg -g +else ifeq ($(PROFILE), GENERATE) + CFLAGS += -fprofile-generate=./profile/picoarch + LDFLAGS += -lgcov +else ifeq ($(PROFILE), APPLY) + CFLAGS += -fprofile-use -fprofile-dir=./profile/picoarch -fbranch-probabilities +endif + +ifeq ($(MINUI), 1) + MMENU = 1 + CFLAGS += -DMINUI +endif + +ifeq ($(MMENU), 1) + CFLAGS += -DMMENU + LDFLAGS += -lSDL_image -lSDL_ttf -ldl +endif + +SOFILES = $(foreach core,$(CORES),$(core)_libretro.so) + +all: $(BIN) cores + +plat_trimui.o: plat_sdl.c +plat_linux.o: plat_sdl.c + +$(BIN): $(OBJS) + $(CC) $(OBJS) $(LDFLAGS) -o $(BIN) + +define CORE_template = + +$1_REPO ?= https://github.com/libretro/$(1)/ + +$(1): + git clone $(if $($1_REVISION),,--depth 1) $$($(1)_REPO) $(1) + $(if $1_REVISION,cd $(1) && git checkout $($1_REVISION),) + (test ! -d patches/$(1)) || (cd $(1) && $(foreach patch, $(sort $(wildcard patches/$(1)/*.patch)), patch -p1 < ../$(patch) &&) true) + +$(1)_libretro.so: $(1) + cd $(1) && make platform=$(platform) $(if $(DEBUG),DEBUG=$(DEBUG),) $(if $(PROFILE),PROFILE=$(PROFILE),) $($(1)_FLAGS) + cp $(1)/$(1)_libretro.so . + +clean-$(1): + test ! -d $(1) || cd $(1) && make platform=$(platform) clean + rm -f $(1)_libretro.so +endef + +$(foreach core,$(CORES),$(eval $(call CORE_template,$(core)))) + +cores: $(SOFILES) + +clean: + rm -f $(OBJS) $(BIN) $(SOFILES) + rm -rf pkg + +clean-all: $(foreach core,$(CORES),clean-$(core)) clean + +force-clean: clean + rm -rf $(CORES) + +ifeq ($(platform), trimui) + +gpsp_ROM_DIR = GBA +gpsp_TYPES = gba,bin,zip +gpsp_PAK_NAME = Game Boy Advance +define gpsp_PAK_EXTRA + +needs-swap + +endef + +snes9x2002_ROM_DIR = SFC +snes9x2002_TYPES = smc,fig,sfc,gd3,gd7,dx2,bsx,swc +snes9x2002_PAK_NAME = Super Nintendo + +snes9x2005_ROM_DIR = SFC +snes9x2005_TYPES = smc,fig,sfc,gd3,gd7,dx2,bsx,swc +snes9x2005_PAK_NAME = Super Nintendo (2005) + +# -- gmenunx + +dist-gmenu-section: + mkdir -p pkg/gmenunx/Apps/picoarch + mkdir -p pkg/gmenunx/Apps/gmenunx/sections/libretro + touch pkg/gmenunx/Apps/gmenunx/sections/libretro/.section + +define CORE_gmenushortcut = + +define $1_SHORTCUT +title=$1 +exec=/mnt/SDCARD/Apps/picoarch/picoarch +params=/mnt/SDCARD/Apps/picoarch/$1_libretro.so +selectordir=/mnt/SDCARD/Roms/$($1_ROM_DIR) +selectorfilter=$($1_TYPES) +endef + +dist-gmenu-$(1): $(BIN) $(1)_libretro.so dist-gmenu-section + cp $(BIN) $1_libretro.so pkg/gmenunx/Apps/picoarch + $$(file >pkg/gmenunx/Apps/gmenunx/sections/libretro/$(1),$$($(1)_SHORTCUT)) + +endef + +$(foreach core, $(CORES),$(eval $(call CORE_gmenushortcut,$(core)))) + +dist-gmenu: $(foreach core, $(CORES), dist-gmenu-$(core)) + +# -- MinUI + +ifeq ($(MINUI), 1) +define CORE_pak_template = + +define $1_LAUNCH_SH +#!/bin/sh +# $($1_PAK_NAME).pak/launch.sh + +EMU_EXE=picoarch +EMU_DIR=$$$$(dirname "$$$$0") +ROM_DIR=$$$${EMU_DIR/.pak/} +ROM_DIR=$$$${ROM_DIR/Emus/Roms} +EMU_NAME=$$$${ROM_DIR/\/mnt\/SDCARD\/Roms\//} +ROM=$$$${1} +$($1_PAK_EXTRA) +HOME="$$$$ROM_DIR" +cd "$$$$EMU_DIR" +"$$$$EMU_DIR/$$$$EMU_EXE" ./$1_libretro.so "$$$$ROM" &> "/mnt/SDCARD/.minui/logs/$$$$EMU_NAME.txt" +endef + +dist-minui-$(1): $(BIN) $(1)_libretro.so + mkdir -p "pkg/MinUI/Emus/$($1_PAK_NAME).pak" + $$(file >$1_launch.sh,$$($1_LAUNCH_SH)) + mv $1_launch.sh "pkg/MinUI/Emus/$($1_PAK_NAME).pak/launch.sh" + cp $(BIN) $1_libretro.so "pkg/MinUI/Emus/$($1_PAK_NAME).pak" + +endef + +$(foreach core, $(CORES),$(eval $(call CORE_pak_template,$(core)))) + +dist-minui: $(foreach core, $(CORES), dist-minui-$(core)) + +endif # MINUI=1 + +endif # platform=trimui diff --git a/README.md b/README.md new file mode 100644 index 0000000..8e5f24e --- /dev/null +++ b/README.md @@ -0,0 +1,110 @@ +# picoarch - a libretro frontend designed for small screens and low power + +picoarch uses libpicofe and SDL to create a small frontend to libretro cores. It's designed for small (320x240 2.0-2.4") screen, low-powered devices like the Trimui Model S (PowKiddy A66). + +## Building + +The frontend can currently be built for the TrimUI Model S and Linux (useful for testing and debugging). + +First, fetch the repo with submodules: + +``` +git clone --recurse-submodules https://git.crowdedwood.com/picoarch +``` + +### Linux instructions + +To build picoarch itself, you need libSDL 1.2, libpng, and libasound. Different cores may need additional dependencies. + +After that, `make` bulids picoarch and all supported cores into this directory. + +### TrimUI instructions + +To build for TrimUI, you need to set up the [toolchain](https://git.crowdedwood.com/trimui-toolchain/about/) first. + +To build generic binaries: + +``` +make platform=trimui +``` + +If you want to build for MinUI, you need to install [libmmenu](https://github.com/shauninman/libmmenu) into the toolchain. Then: + +``` +make platform=trimui MINUI=1 +``` + +`MINUI=1` will change save/config/system paths to match MinUI standards. If you just want to include mmenu, you can run: + +``` +make platform=trimui MMENU=1 +``` + +### Other build options + +To debug: + +``` +make DEBUG=1 +``` + +To build a specific supported core: + +``` +make gpsp_libretro.so +``` + +To clean a core so it will be built again: + +``` +make clean-gpsp +``` + +To completely clean the repo (will delete, pull, and patch all core repos from scratch) + +``` +make force-clean +``` + +Distribution builds can also be made for gmenunx and MinUI: + +``` +make platform=trimui dist-gmenu +make platform=trimui MINUI=1 dist-minui +``` + +These will output a directory structure that can be moved onto the SD card into `pkg/gmenunx` or `pkg/MinUI`. + +To build profiles for profile-guided optimization: + +``` +make PROFILE=GENERATE +``` + +To apply the generated profiles: + +``` +make PROFILE=APPLY +``` + +PGO can lead to major speed improvements with some emulators. + +## Notes on cores + +In order to make development and testing easier, the Makefile will pull and build supported cores. + +A few common changes will need to be made when you add cores, since TrimUI is not a supported libretro platform. picoarch has a `patches/` directory containing needed changes to make cores work well in picoarch. Patches are applied in order after checking out the repository. + +Common changes include: + +- Adding a `platform=trimui` target to the core Makefile +- Modifying `libretro_core_options.h` to shorten text, add manual line breaks, and change defaults for small screen / low power devices +- Hiding unnecessary core options and forcing different defaults + +picoarch also keeps the running core name in a global variable. This can be used for: + +- Renaming buttons to match the core's system +- Adding frameskip to make fast-forward faster +- Displaying extra options or hiding unnecessary options + +Some features and fixes are also included in `patches` -- it would be best for them to be upstreamed eventually. diff --git a/config.c b/config.c new file mode 100644 index 0000000..ba6041c --- /dev/null +++ b/config.c @@ -0,0 +1,120 @@ +#include <stdlib.h> +#include <string.h> +#include "config.h" +#include "main.h" +#include "options.h" +#include "scale.h" + +typedef enum { + CE_TYPE_STR = 0, + CE_TYPE_NUM = 4, +} config_entry_type; + +#define CE_STR(val) \ + { #val, CE_TYPE_STRING, val } + +#define CE_NUM(val) \ + { #val, CE_TYPE_NUM, &val } + +static const struct { + const char *name; + config_entry_type type; + void *val; +} config_data[] = { + CE_NUM(show_fps), + CE_NUM(limit_frames), + CE_NUM(audio_buffer_size), + CE_NUM(scale_size), + CE_NUM(scale_filter), +}; + +void config_write(FILE *f) +{ + for (int i = 0; i < array_size(config_data); i++) { + switch (config_data[i].type) + { + case CE_TYPE_STR: + fprintf(f, "%s = %s\n", config_data[i].name, (char *)config_data[i].val); + break; + case CE_TYPE_NUM: + fprintf(f, "%s = %u\n", config_data[i].name, *(uint32_t *)config_data[i].val); + break; + default: + PA_WARN("unhandled type %d for %s\n", config_data[i].type, (char *)config_data[i].val); + break; + } + } + + for (int i = 0; i < core_options.len; i++) { + const char* k = options_get_key(i); + if (!options_is_blocked(k)) + fprintf(f, "%s = %s\n", k, options_get_value(k)); + } +} + +static void parse_str_val(char *cval, const char *src) +{ + char *tmp; + strncpy(cval, src, 256); + cval[256 - 1] = 0; + tmp = strchr(cval, '\n'); + if (tmp == NULL) + tmp = strchr(cval, '\r'); + if (tmp != NULL) + *tmp = 0; +} + +static void parse_num_val(uint32_t *cval, const char *src) +{ + char *tmp = NULL; + uint32_t val; + val = strtoul(src, &tmp, 10); + if (tmp == NULL || src == tmp) + return; // parse failed + + *cval = val; +} + +static char *config_find_value(const char* cfg, const char *key) { + char *tmp; + + tmp = strstr(cfg, key); + if (tmp == NULL) + return NULL; + tmp += strlen(key); + if (strncmp(tmp, " = ", 3) != 0) + return NULL; + tmp += 3; + + return tmp; +} + +void config_read(const char* cfg) +{ + for (int i = 0; i < array_size(config_data); i++) { + char *tmp = config_find_value(cfg, config_data[i].name); + if (!tmp) + continue; + + if (config_data[i].type == CE_TYPE_STR) { + parse_str_val(config_data[i].val, tmp); + continue; + } + + parse_num_val(config_data[i].val, tmp); + } + + for (int i = 0; i < core_options.len; i++) { + char value[256] = {0}; + const char *key = options_get_key(i); + if (options_is_blocked(key)) + continue; + + char *tmp = config_find_value(cfg, key); + if (!tmp) + continue; + + parse_str_val(value, tmp); + options_set_value(key, value); + } +} diff --git a/config.h b/config.h new file mode 100644 index 0000000..f5a7e45 --- /dev/null +++ b/config.h @@ -0,0 +1,9 @@ +#ifndef CONFIG_H +#define CONFIG_H + +#include <stdio.h> + +void config_write(FILE *f); +void config_read(const char *cfg); + +#endif @@ -0,0 +1,593 @@ +#include <dlfcn.h> +#include <errno.h> +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <sys/stat.h> +#include <sys/types.h> +#include <unistd.h> +#include "core.h" +#include "libpicofe/input.h" +#include "main.h" +#include "options.h" +#include "plat.h" +#include "unzip.h" + +#define PATH_SEPARATOR_CHAR '/' + +struct core_cbs current_core; + +double sample_rate; +double frame_rate; +double aspect_ratio; +int audio_buffer_size_override; +int state_slot; + +static char config_dir[MAX_PATH]; +static char save_dir[MAX_PATH]; +static char system_dir[MAX_PATH]; +static char temp_rom[MAX_PATH]; +static struct retro_game_info game_info; + +static uint32_t buttons = 0; + +static void gamepak_related_name(char *buf, size_t len, const char *new_extension) +{ + char filename[MAX_PATH]; + char *dot; + + strncpy(filename, basename(content_path), sizeof(filename)); + filename[sizeof(filename) - 1] = 0; + + dot = strrchr(filename, '.'); + if (dot) + *dot = 0; + + snprintf(buf, len, "%s%s%s", save_dir, filename, new_extension); +} + +void config_file_name(char *buf, size_t len, int is_game) +{ + if (is_game && content_path) { + gamepak_related_name(buf, len, ".cfg"); + } else { + snprintf(buf, len, "%s%s", config_dir, "picoarch.cfg"); + } +} + +void sram_write(void) { + char filename[MAX_PATH]; + FILE *sram_file = NULL; + void *sram; + + size_t sram_size = current_core.retro_get_memory_size(RETRO_MEMORY_SAVE_RAM); + if (!sram_size) { + return; + } + + gamepak_related_name(filename, MAX_PATH, ".sav"); + + sram_file = fopen(filename, "w"); + if (!sram_file) { + PA_ERROR("Error opening SRAM file: %s\n", strerror(errno)); + return; + } + + sram = current_core.retro_get_memory_data(RETRO_MEMORY_SAVE_RAM); + + if (!sram || sram_size != fwrite(sram, 1, sram_size, sram_file)) { + PA_ERROR("Error writing SRAM data to file\n"); + } + + fclose(sram_file); + + sync(); +} + +void sram_read(void) { + char filename[MAX_PATH]; + FILE *sram_file = NULL; + void *sram; + + size_t sram_size = current_core.retro_get_memory_size(RETRO_MEMORY_SAVE_RAM); + if (!sram_size) { + return; + } + + gamepak_related_name(filename, MAX_PATH, ".sav"); + + sram_file = fopen(filename, "r"); + if (!sram_file) { + return; + } + + sram = current_core.retro_get_memory_data(RETRO_MEMORY_SAVE_RAM); + + if (!sram || !fread(sram, 1, sram_size, sram_file)) { + PA_ERROR("Error reading SRAM data\n"); + } + + fclose(sram_file); +} + +void state_file_name(char *name, size_t size, int slot) { + char extension[5] = {0}; + + snprintf(extension, 5, ".st%d", slot); + gamepak_related_name(name, MAX_PATH, extension); +} + +int state_read(void) { + char filename[MAX_PATH]; + FILE *state_file = NULL; + void *state = NULL; + int ret = -1; + + size_t state_size = current_core.retro_serialize_size(); + if (!state_size) { + return 0; + } + + state = calloc(1, state_size); + if (!state) { + PA_ERROR("Couldn't allocate memory for state\n"); + goto error; + } + + state_file_name(filename, MAX_PATH, state_slot); + + state_file = fopen(filename, "r"); + if (!state_file) { + PA_ERROR("Error opening state file: %s\n", strerror(errno)); + goto error; + } + + if (state_size != fread(state, 1, state_size, state_file)) { + PA_ERROR("Error reading state data from file\n"); + goto error; + } + + if (!current_core.retro_unserialize(state, state_size)) { + PA_ERROR("Error restoring save state\n", strerror(errno)); + goto error; + } + + ret = 0; +error: + if (state) + free(state); + if (state_file) + fclose(state_file); + return ret; +} + +int state_write(void) { + char filename[MAX_PATH]; + FILE *state_file = NULL; + void *state = NULL; + int ret = -1; + + size_t state_size = current_core.retro_serialize_size(); + if (!state_size) { + return false; + } + + state = calloc(1, state_size); + if (!state) { + PA_ERROR("Couldn't allocate memory for state\n"); + goto error; + } + + state_file_name(filename, MAX_PATH, state_slot); + + state_file = fopen(filename, "w"); + if (!state_file) { + PA_ERROR("Error opening state file: %s\n", strerror(errno)); + goto error; + } + + if (!current_core.retro_serialize(state, state_size)) { + PA_ERROR("Error creating save state\n", strerror(errno)); + goto error; + } + + if (state_size != fwrite(state, 1, state_size, state_file)) { + PA_ERROR("Error writing state data to file\n"); + goto error; + } + ret = 0; +error: + if (state) + free(state); + if (state_file) + fclose(state_file); + + sync(); + return ret; +} + +static void set_directories(void) { + const char *home = getenv("HOME"); + char *dst = save_dir; + int len = MAX_PATH; + + if (home != NULL) { + snprintf(dst, len, "%s/.picoarch-%s/", home, core_name); + mkdir(dst, 0755); + } + + strncpy(config_dir, save_dir, MAX_PATH-1); + +#ifdef MINUI + strncpy(system_dir, save_dir, MAX_PATH-1); +#else + if (!getcwd(system_dir, MAX_PATH)) { + PA_FATAL("Can't find system directory"); + } +#endif +} + +static bool pa_environment(unsigned cmd, void *data) { + switch(cmd) { + case RETRO_ENVIRONMENT_GET_OVERSCAN: { /* 2 */ + bool *out = (bool *)data; + if (out) + *out = true; + break; + } + case RETRO_ENVIRONMENT_GET_CAN_DUPE: { /* 3 */ + bool *out = (bool *)data; + if (out) + *out = true; + break; + } + case RETRO_ENVIRONMENT_SET_MESSAGE: { /* 6 */ + /* Just warn for now. TODO: Display on the screen */ + const struct retro_message *message = (const struct retro_message*)data; + PA_WARN(message->msg); + break; + } + case RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY: { /* 9 */ + const char **out = (const char **)data; + if (out) + *out = system_dir; + break; + } + case RETRO_ENVIRONMENT_SET_PIXEL_FORMAT: { /* 10 */ + const enum retro_pixel_format *format = (enum retro_pixel_format *)data; + + if (*format != RETRO_PIXEL_FORMAT_RGB565) { + /* 565 is only supported format */ + return false; + } + break; + } + case RETRO_ENVIRONMENT_GET_VARIABLE: { /* 15 */ + struct retro_variable *var = (struct retro_variable *)data; + if (var && var->key) { + var->value = options_get_value(var->key); + } + break; + } + case RETRO_ENVIRONMENT_SET_VARIABLES: { /* 16 */ + const struct retro_variable *vars = (const struct retro_variable *)data; + options_free(); + if (vars) { + options_init_variables(vars); + load_config(); + } + break; + } + case RETRO_ENVIRONMENT_GET_VARIABLE_UPDATE: { /* 17 */ + bool *out = (bool *)data; + if (out) + *out = options_changed(); + break; + } + case RETRO_ENVIRONMENT_GET_LOG_INTERFACE: { /* 27 */ + struct retro_log_callback *log_cb = (struct retro_log_callback *)data; + if (log_cb) + log_cb->log = pa_log; + break; + } + case RETRO_ENVIRONMENT_GET_SAVE_DIRECTORY: { /* 31 */ + const char **out = (const char **)data; + if (out) + *out = save_dir; + break; + } + case RETRO_ENVIRONMENT_GET_INPUT_BITMASKS: { /* 52 */ + bool *out = (bool *)data; + if (out) + *out = true; + break; + } + case RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION: { /* 52 */ + unsigned *out = (unsigned *)data; + if (out) + *out = 1; + break; + } + case RETRO_ENVIRONMENT_SET_CORE_OPTIONS: { /* 53 */ + options_free(); + if (data) { + options_init(*(const struct retro_core_option_definition **)data); + load_config(); + } + break; + } + case RETRO_ENVIRONMENT_SET_CORE_OPTIONS_INTL: { /* 54 */ + const struct retro_core_options_intl *options = (const struct retro_core_options_intl *)data; + if (options && options->us) { + options_free(); + options_init(options->us); + load_config(); + } + break; + } + case RETRO_ENVIRONMENT_SET_AUDIO_BUFFER_STATUS_CALLBACK: { /* 62 */ + const struct retro_audio_buffer_status_callback *cb = + (const struct retro_audio_buffer_status_callback *)data; + if (cb) { + current_core.retro_audio_buffer_status = cb->callback; + } else { + current_core.retro_audio_buffer_status = NULL; + } + break; + } + case RETRO_ENVIRONMENT_SET_MINIMUM_AUDIO_LATENCY: { /* 63 */ + const unsigned *latency_ms = (const unsigned *)data; + if (latency_ms) { + unsigned frames = *latency_ms * frame_rate / 1000; + if (frames > audio_buffer_size && frames < 30) + audio_buffer_size_override = frames; + else + PA_WARN("Audio buffer change out of range (%d), ignored\n", frames); + } + break; + } + default: + PA_DEBUG("Unsupported environment cmd: %u\n", cmd); + return false; + } + + return true; +} + +static void pa_video_refresh(const void *data, unsigned width, unsigned height, size_t pitch) { + if (data && !should_quit) { + pa_track_render(); + plat_video_process(data, width, height, pitch); + } +} + +static void pa_audio_sample(int16_t left, int16_t right) { + const struct audio_frame frame = { .left = left, .right = right }; + if (!should_quit && enable_audio) + plat_sound_write(&frame, 1); +} + +static size_t pa_audio_sample_batch(const int16_t *data, size_t frames) { + if (!should_quit && enable_audio) + plat_sound_write((const struct audio_frame *)data, frames); + return frames; +} + +static void pa_input_poll(void) { + int actions[IN_BINDTYPE_COUNT] = { 0, }; + unsigned int emu_act; + int which = EACTION_NONE; + + in_update(actions); + emu_act = actions[IN_BINDTYPE_EMU]; + if (emu_act) { + for (; !(emu_act & 1); emu_act >>= 1, which++) + ; + emu_act = which; + } + handle_emu_action(which); + + buttons = actions[IN_BINDTYPE_PLAYER12]; +} + +static int16_t pa_input_state(unsigned port, unsigned device, unsigned index, unsigned id) { + if (port == 0 && device == RETRO_DEVICE_JOYPAD && index == 0) { + if (id == RETRO_DEVICE_ID_JOYPAD_MASK) + return buttons; + + return (buttons >> id) & 1; + } + + return 0; +} + +int core_load(const char *corefile) { + void (*set_environment)(retro_environment_t) = NULL; + void (*set_video_refresh)(retro_video_refresh_t) = NULL; + void (*set_audio_sample)(retro_audio_sample_t) = NULL; + void (*set_audio_sample_batch)(retro_audio_sample_batch_t) = NULL; + void (*set_input_poll)(retro_input_poll_t) = NULL; + void (*set_input_state)(retro_input_state_t) = NULL; + + PA_INFO("Loading core %s\n", corefile); + + memset(¤t_core, 0, sizeof(current_core)); + current_core.handle = dlopen(corefile, RTLD_LAZY); + + if (!current_core.handle) { + PA_ERROR("Couldn't load core: %s\n", dlerror()); + return -1; + } + + set_directories(); + + current_core.retro_init = dlsym(current_core.handle, "retro_init"); + current_core.retro_deinit = dlsym(current_core.handle, "retro_deinit"); + current_core.retro_get_system_info = dlsym(current_core.handle, "retro_get_system_info"); + current_core.retro_get_system_av_info = dlsym(current_core.handle, "retro_get_system_av_info"); + current_core.retro_set_controller_port_device = dlsym(current_core.handle, "retro_set_controller_port_device"); + current_core.retro_reset = dlsym(current_core.handle, "retro_reset"); + current_core.retro_run = dlsym(current_core.handle, "retro_run"); + current_core.retro_serialize_size = dlsym(current_core.handle, "retro_serialize_size"); + current_core.retro_serialize = dlsym(current_core.handle, "retro_serialize"); + current_core.retro_unserialize = dlsym(current_core.handle, "retro_unserialize"); + current_core.retro_cheat_reset = dlsym(current_core.handle, "retro_cheat_reset"); + current_core.retro_cheat_set = dlsym(current_core.handle, "retro_cheat_set"); + current_core.retro_load_game = dlsym(current_core.handle, "retro_load_game"); + current_core.retro_load_game_special = dlsym(current_core.handle, "retro_load_game_special"); + current_core.retro_unload_game = dlsym(current_core.handle, "retro_unload_game"); + current_core.retro_get_region = dlsym(current_core.handle, "retro_get_region"); + current_core.retro_get_memory_data = dlsym(current_core.handle, "retro_get_memory_data"); + current_core.retro_get_memory_size = dlsym(current_core.handle, "retro_get_memory_size"); + + set_environment = dlsym(current_core.handle, "retro_set_environment"); + set_video_refresh = dlsym(current_core.handle, "retro_set_video_refresh"); + set_audio_sample = dlsym(current_core.handle, "retro_set_audio_sample"); + set_audio_sample_batch = dlsym(current_core.handle, "retro_set_audio_sample_batch"); + set_input_poll = dlsym(current_core.handle, "retro_set_input_poll"); + set_input_state = dlsym(current_core.handle, "retro_set_input_state"); + + set_environment(pa_environment); + set_video_refresh(pa_video_refresh); + set_audio_sample(pa_audio_sample); + set_audio_sample_batch(pa_audio_sample_batch); + set_input_poll(pa_input_poll); + set_input_state(pa_input_state); + + current_core.retro_init(); + current_core.initialized = true; + PA_INFO("Finished loading core\n"); + return 0; +} + +#define MAX_EXTENSIONS 24 + +static void core_handle_zip(const char *path, struct retro_system_info *info, struct retro_game_info *game_info, FILE** file) { + const char *extensions[MAX_EXTENSIONS] = {0}; + char *extensionstr = strdup(info->valid_extensions); + char *ext = NULL; + char *saveptr = NULL; + int index = 0; + bool haszip = false; + FILE *dest = NULL; + + if (info->valid_extensions && has_suffix_i(path, ".zip")) { + while((ext = strtok_r(index == 0 ? extensionstr : NULL, "|", &saveptr))) { + if (!strcmp(ext, "zip")) { + haszip = true; + break; + } + extensions[index++] = ext; + if (index > MAX_EXTENSIONS - 1) break; + } + + if (!haszip) { + if (!unzip_tmp(*file, extensions, temp_rom, MAX_PATH)) { + game_info->path = temp_rom; + dest = fopen(temp_rom, "r"); + if (dest) { + fclose(*file); + *file = dest; + } + } + } + } + free(extensionstr); +} + +int core_load_content(const char *path) { + struct retro_system_info info = {0}; + struct retro_system_av_info av_info = {0}; + FILE *file = fopen(path, "rb"); + int ret = -1; + + if (!file) { + PA_ERROR("Couldn't load content: %s\n", strerror(errno)); + goto finish; + } + + memset(&game_info, 0, sizeof(struct retro_game_info)); + + PA_INFO("Loading %s\n", path); + game_info.path = path; + + current_core.retro_get_system_info(&info); + + core_handle_zip(path, &info, &game_info, &file); + + fseek(file, 0, SEEK_END); + game_info.size = ftell(file); + rewind(file); + + if (!info.need_fullpath) { + void *game_data = malloc(game_info.size); + + if (!game_data) { + PA_ERROR("Couldn't allocate memory for content\n"); + goto finish; + } + + if (fread(game_data, 1, game_info.size, file) != game_info.size) { + PA_ERROR("Couldn't read file: %s\n", strerror(errno)); + goto finish; + } + + game_info.data = game_data; + } + + if (!current_core.retro_load_game(&game_info)) { + PA_ERROR("Couldn't load content\n"); + goto finish; + } + + sram_read(); + + current_core.retro_get_system_av_info(&av_info); + + PA_INFO("Screen: %dx%d\n", av_info.geometry.base_width, av_info.geometry.base_height); + PA_INFO("Audio sample rate: %f\n", av_info.timing.sample_rate); + PA_INFO("Frame rate: %f\n", av_info.timing.fps); + + sample_rate = av_info.timing.sample_rate; + frame_rate = av_info.timing.fps; + aspect_ratio = av_info.geometry.aspect_ratio; + + if (!aspect_ratio) + aspect_ratio = (float)av_info.geometry.base_width / (float)av_info.geometry.base_height; + +#ifdef MMENU + gamepak_related_name(save_template_path, MAX_PATH, ".st%i"); +#endif + + ret = 0; +finish: + if (file) + fclose(file); + + return ret; +} + +void core_unload(void) { + PA_INFO("Unloading core...\n"); + + if (current_core.initialized) { + current_core.retro_deinit(); + current_core.initialized = false; + } + + if (game_info.data) { + free((void *)game_info.data); + game_info.data = NULL; + } + + if (current_core.handle) { + dlclose(current_core.handle); + current_core.handle = NULL; + } + + if (temp_rom[0]) { + remove(temp_rom); + temp_rom[0] = '\0'; + } + options_free(); +} @@ -0,0 +1,52 @@ +#ifndef _CORE_H__ +#define _CORE_H__ + +#include "libretro.h" + +struct core_cbs { + bool initialized; + void *handle; + void (*retro_init)(void); + void (*retro_deinit)(void); + void (*retro_api_version)(void); + void (*retro_get_system_info)(struct retro_system_info *info); + void (*retro_get_system_av_info)(struct retro_system_av_info *info); + void (*retro_set_controller_port_device)(unsigned port, unsigned device); + void (*retro_reset)(void); + void (*retro_run)(void); + size_t (*retro_serialize_size)(void); + bool (*retro_serialize)(void *data, size_t size); + bool (*retro_unserialize)(const void *data, size_t size); + void (*retro_cheat_reset)(void); + void (*retro_cheat_set)(unsigned index, bool enabled, const char *code); + bool (*retro_load_game)(const struct retro_game_info *game); + bool (*retro_load_game_special)(unsigned game_type, const struct retro_game_info *info, size_t num_info); + void (*retro_unload_game)(void); + unsigned (*retro_get_region)(void); + void *(*retro_get_memory_data)(unsigned id); + size_t (*retro_get_memory_size)(unsigned id); + retro_audio_buffer_status_callback_t retro_audio_buffer_status; +}; + +extern struct core_cbs current_core; + +extern double sample_rate; +extern double frame_rate; +extern double aspect_ratio; +extern int audio_buffer_size_override; +extern int state_slot; + +void config_file_name(char *buf, size_t len, int is_game); + +void sram_read(void); +void sram_write(void); + +void state_file_name(char *name, size_t size, int slot); +int state_read(void); +int state_write(void); + +int core_load(const char *corefile); +int core_load_content(const char *path); +void core_unload(void); + +#endif diff --git a/libpicofe b/libpicofe new file mode 160000 +Subproject 76e45c3489a0c32d91744413c198f685b553f6c diff --git a/libretro.h b/libretro.h new file mode 100644 index 0000000..32aa15f --- /dev/null +++ b/libretro.h @@ -0,0 +1,3456 @@ +/* Copyright (C) 2010-2020 The RetroArch team + * + * --------------------------------------------------------------------------------------- + * The following license statement only applies to this libretro API header (libretro.h). + * --------------------------------------------------------------------------------------- + * + * 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, sublicense, and/or sell copies of the Software, + * and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + * + * 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. + * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ + +#ifndef LIBRETRO_H__ +#define LIBRETRO_H__ + +#include <stdint.h> +#include <stddef.h> +#include <limits.h> + +#ifdef __cplusplus +extern "C" { +#endif + +#ifndef __cplusplus +#if defined(_MSC_VER) && _MSC_VER < 1800 && !defined(SN_TARGET_PS3) +/* Hack applied for MSVC when compiling in C89 mode + * as it isn't C99-compliant. */ +#define bool unsigned char +#define true 1 +#define false 0 +#else +#include <stdbool.h> +#endif +#endif + +#ifndef RETRO_CALLCONV +# if defined(__GNUC__) && defined(__i386__) && !defined(__x86_64__) +# define RETRO_CALLCONV __attribute__((cdecl)) +# elif defined(_MSC_VER) && defined(_M_X86) && !defined(_M_X64) +# define RETRO_CALLCONV __cdecl +# else +# define RETRO_CALLCONV /* all other platforms only have one calling convention each */ +# endif +#endif + +#ifndef RETRO_API +# if defined(_WIN32) || defined(__CYGWIN__) || defined(__MINGW32__) +# ifdef RETRO_IMPORT_SYMBOLS +# ifdef __GNUC__ +# define RETRO_API RETRO_CALLCONV __attribute__((__dllimport__)) +# else +# define RETRO_API RETRO_CALLCONV __declspec(dllimport) +# endif +# else +# ifdef __GNUC__ +# define RETRO_API RETRO_CALLCONV __attribute__((__dllexport__)) +# else +# define RETRO_API RETRO_CALLCONV __declspec(dllexport) +# endif +# endif +# else +# if defined(__GNUC__) && __GNUC__ >= 4 +# define RETRO_API RETRO_CALLCONV __attribute__((__visibility__("default"))) +# else +# define RETRO_API RETRO_CALLCONV +# endif +# endif +#endif + +/* Used for checking API/ABI mismatches that can break libretro + * implementations. + * It is not incremented for compatible changes to the API. + */ +#define RETRO_API_VERSION 1 + +/* + * Libretro's fundamental device abstractions. + * + * Libretro's input system consists of some standardized device types, + * such as a joypad (with/without analog), mouse, keyboard, lightgun + * and a pointer. + * + * The functionality of these devices are fixed, and individual cores + * map their own concept of a controller to libretro's abstractions. + * This makes it possible for frontends to map the abstract types to a + * real input device, and not having to worry about binding input + * correctly to arbitrary controller layouts. + */ + +#define RETRO_DEVICE_TYPE_SHIFT 8 +#define RETRO_DEVICE_MASK ((1 << RETRO_DEVICE_TYPE_SHIFT) - 1) +#define RETRO_DEVICE_SUBCLASS(base, id) (((id + 1) << RETRO_DEVICE_TYPE_SHIFT) | base) + +/* Input disabled. */ +#define RETRO_DEVICE_NONE 0 + +/* The JOYPAD is called RetroPad. It is essentially a Super Nintendo + * controller, but with additional L2/R2/L3/R3 buttons, similar to a + * PS1 DualShock. */ +#define RETRO_DEVICE_JOYPAD 1 + +/* The mouse is a simple mouse, similar to Super Nintendo's mouse. + * X and Y coordinates are reported relatively to last poll (poll callback). + * It is up to the libretro implementation to keep track of where the mouse + * pointer is supposed to be on the screen. + * The frontend must make sure not to interfere with its own hardware + * mouse pointer. + */ +#define RETRO_DEVICE_MOUSE 2 + +/* KEYBOARD device lets one poll for raw key pressed. + * It is poll based, so input callback will return with the current + * pressed state. + * For event/text based keyboard input, see + * RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK. + */ +#define RETRO_DEVICE_KEYBOARD 3 + +/* LIGHTGUN device is similar to Guncon-2 for PlayStation 2. + * It reports X/Y coordinates in screen space (similar to the pointer) + * in the range [-0x8000, 0x7fff] in both axes, with zero being center and + * -0x8000 being out of bounds. + * As well as reporting on/off screen state. It features a trigger, + * start/select buttons, auxiliary action buttons and a + * directional pad. A forced off-screen shot can be requested for + * auto-reloading function in some games. + */ +#define RETRO_DEVICE_LIGHTGUN 4 + +/* The ANALOG device is an extension to JOYPAD (RetroPad). + * Similar to DualShock2 it adds two analog sticks and all buttons can + * be analog. This is treated as a separate device type as it returns + * axis values in the full analog range of [-0x7fff, 0x7fff], + * although some devices may return -0x8000. + * Positive X axis is right. Positive Y axis is down. + * Buttons are returned in the range [0, 0x7fff]. + * Only use ANALOG type when polling for analog values. + */ +#define RETRO_DEVICE_ANALOG 5 + +/* Abstracts the concept of a pointing mechanism, e.g. touch. + * This allows libretro to query in absolute coordinates where on the + * screen a mouse (or something similar) is being placed. + * For a touch centric device, coordinates reported are the coordinates + * of the press. + * + * Coordinates in X and Y are reported as: + * [-0x7fff, 0x7fff]: -0x7fff corresponds to the far left/top of the screen, + * and 0x7fff corresponds to the far right/bottom of the screen. + * The "screen" is here defined as area that is passed to the frontend and + * later displayed on the monitor. + * + * The frontend is free to scale/resize this screen as it sees fit, however, + * (X, Y) = (-0x7fff, -0x7fff) will correspond to the top-left pixel of the + * game image, etc. + * + * To check if the pointer coordinates are valid (e.g. a touch display + * actually being touched), PRESSED returns 1 or 0. + * + * If using a mouse on a desktop, PRESSED will usually correspond to the + * left mouse button, but this is a frontend decision. + * PRESSED will only return 1 if the pointer is inside the game screen. + * + * For multi-touch, the index variable can be used to successively query + * more presses. + * If index = 0 returns true for _PRESSED, coordinates can be extracted + * with _X, _Y for index = 0. One can then query _PRESSED, _X, _Y with + * index = 1, and so on. + * Eventually _PRESSED will return false for an index. No further presses + * are registered at this point. */ +#define RETRO_DEVICE_POINTER 6 + +/* Buttons for the RetroPad (JOYPAD). + * The placement of these is equivalent to placements on the + * Super Nintendo controller. + * L2/R2/L3/R3 buttons correspond to the PS1 DualShock. + * Also used as id values for RETRO_DEVICE_INDEX_ANALOG_BUTTON */ +#define RETRO_DEVICE_ID_JOYPAD_B 0 +#define RETRO_DEVICE_ID_JOYPAD_Y 1 +#define RETRO_DEVICE_ID_JOYPAD_SELECT 2 +#define RETRO_DEVICE_ID_JOYPAD_START 3 +#define RETRO_DEVICE_ID_JOYPAD_UP 4 +#define RETRO_DEVICE_ID_JOYPAD_DOWN 5 +#define RETRO_DEVICE_ID_JOYPAD_LEFT 6 +#define RETRO_DEVICE_ID_JOYPAD_RIGHT 7 +#define RETRO_DEVICE_ID_JOYPAD_A 8 +#define RETRO_DEVICE_ID_JOYPAD_X 9 +#define RETRO_DEVICE_ID_JOYPAD_L 10 +#define RETRO_DEVICE_ID_JOYPAD_R 11 +#define RETRO_DEVICE_ID_JOYPAD_L2 12 +#define RETRO_DEVICE_ID_JOYPAD_R2 13 +#define RETRO_DEVICE_ID_JOYPAD_L3 14 +#define RETRO_DEVICE_ID_JOYPAD_R3 15 + +#define RETRO_DEVICE_ID_JOYPAD_MASK 256 + +/* Index / Id values for ANALOG device. */ +#define RETRO_DEVICE_INDEX_ANALOG_LEFT 0 +#define RETRO_DEVICE_INDEX_ANALOG_RIGHT 1 +#define RETRO_DEVICE_INDEX_ANALOG_BUTTON 2 +#define RETRO_DEVICE_ID_ANALOG_X 0 +#define RETRO_DEVICE_ID_ANALOG_Y 1 + +/* Id values for MOUSE. */ +#define RETRO_DEVICE_ID_MOUSE_X 0 +#define RETRO_DEVICE_ID_MOUSE_Y 1 +#define RETRO_DEVICE_ID_MOUSE_LEFT 2 +#define RETRO_DEVICE_ID_MOUSE_RIGHT 3 +#define RETRO_DEVICE_ID_MOUSE_WHEELUP 4 +#define RETRO_DEVICE_ID_MOUSE_WHEELDOWN 5 +#define RETRO_DEVICE_ID_MOUSE_MIDDLE 6 +#define RETRO_DEVICE_ID_MOUSE_HORIZ_WHEELUP 7 +#define RETRO_DEVICE_ID_MOUSE_HORIZ_WHEELDOWN 8 +#define RETRO_DEVICE_ID_MOUSE_BUTTON_4 9 +#define RETRO_DEVICE_ID_MOUSE_BUTTON_5 10 + +/* Id values for LIGHTGUN. */ +#define RETRO_DEVICE_ID_LIGHTGUN_SCREEN_X 13 /*Absolute Position*/ +#define RETRO_DEVICE_ID_LIGHTGUN_SCREEN_Y 14 /*Absolute*/ +#define RETRO_DEVICE_ID_LIGHTGUN_IS_OFFSCREEN 15 /*Status Check*/ +#define RETRO_DEVICE_ID_LIGHTGUN_TRIGGER 2 +#define RETRO_DEVICE_ID_LIGHTGUN_RELOAD 16 /*Forced off-screen shot*/ +#define RETRO_DEVICE_ID_LIGHTGUN_AUX_A 3 +#define RETRO_DEVICE_ID_LIGHTGUN_AUX_B 4 +#define RETRO_DEVICE_ID_LIGHTGUN_START 6 +#define RETRO_DEVICE_ID_LIGHTGUN_SELECT 7 +#define RETRO_DEVICE_ID_LIGHTGUN_AUX_C 8 +#define RETRO_DEVICE_ID_LIGHTGUN_DPAD_UP 9 +#define RETRO_DEVICE_ID_LIGHTGUN_DPAD_DOWN 10 +#define RETRO_DEVICE_ID_LIGHTGUN_DPAD_LEFT 11 +#define RETRO_DEVICE_ID_LIGHTGUN_DPAD_RIGHT 12 +/* deprecated */ +#define RETRO_DEVICE_ID_LIGHTGUN_X 0 /*Relative Position*/ +#define RETRO_DEVICE_ID_LIGHTGUN_Y 1 /*Relative*/ +#define RETRO_DEVICE_ID_LIGHTGUN_CURSOR 3 /*Use Aux:A*/ +#define RETRO_DEVICE_ID_LIGHTGUN_TURBO 4 /*Use Aux:B*/ +#define RETRO_DEVICE_ID_LIGHTGUN_PAUSE 5 /*Use Start*/ + +/* Id values for POINTER. */ +#define RETRO_DEVICE_ID_POINTER_X 0 +#define RETRO_DEVICE_ID_POINTER_Y 1 +#define RETRO_DEVICE_ID_POINTER_PRESSED 2 +#define RETRO_DEVICE_ID_POINTER_COUNT 3 + +/* Returned from retro_get_region(). */ +#define RETRO_REGION_NTSC 0 +#define RETRO_REGION_PAL 1 + +/* Id values for LANGUAGE */ +enum retro_language +{ + RETRO_LANGUAGE_ENGLISH = 0, + RETRO_LANGUAGE_JAPANESE = 1, + RETRO_LANGUAGE_FRENCH = 2, + RETRO_LANGUAGE_SPANISH = 3, + RETRO_LANGUAGE_GERMAN = 4, + RETRO_LANGUAGE_ITALIAN = 5, + RETRO_LANGUAGE_DUTCH = 6, + RETRO_LANGUAGE_PORTUGUESE_BRAZIL = 7, + RETRO_LANGUAGE_PORTUGUESE_PORTUGAL = 8, + RETRO_LANGUAGE_RUSSIAN = 9, + RETRO_LANGUAGE_KOREAN = 10, + RETRO_LANGUAGE_CHINESE_TRADITIONAL = 11, + RETRO_LANGUAGE_CHINESE_SIMPLIFIED = 12, + RETRO_LANGUAGE_ESPERANTO = 13, + RETRO_LANGUAGE_POLISH = 14, + RETRO_LANGUAGE_VIETNAMESE = 15, + RETRO_LANGUAGE_ARABIC = 16, + RETRO_LANGUAGE_GREEK = 17, + RETRO_LANGUAGE_TURKISH = 18, + RETRO_LANGUAGE_SLOVAK = 19, + RETRO_LANGUAGE_PERSIAN = 20, + RETRO_LANGUAGE_HEBREW = 21, + RETRO_LANGUAGE_ASTURIAN = 22, + RETRO_LANGUAGE_FINNISH = 23, + RETRO_LANGUAGE_LAST, + + /* Ensure sizeof(enum) == sizeof(int) */ + RETRO_LANGUAGE_DUMMY = INT_MAX +}; + +/* Passed to retro_get_memory_data/size(). + * If the memory type doesn't apply to the + * implementation NULL/0 can be returned. + */ +#define RETRO_MEMORY_MASK 0xff + +/* Regular save RAM. This RAM is usually found on a game cartridge, + * backed up by a battery. + * If save game data is too complex for a single memory buffer, + * the SAVE_DIRECTORY (preferably) or SYSTEM_DIRECTORY environment + * callback can be used. */ +#define RETRO_MEMORY_SAVE_RAM 0 + +/* Some games have a built-in clock to keep track of time. + * This memory is usually just a couple of bytes to keep track of time. + */ +#define RETRO_MEMORY_RTC 1 + +/* System ram lets a frontend peek into a game systems main RAM. */ +#define RETRO_MEMORY_SYSTEM_RAM 2 + +/* Video ram lets a frontend peek into a game systems video RAM (VRAM). */ +#define RETRO_MEMORY_VIDEO_RAM 3 + +/* Keysyms used for ID in input state callback when polling RETRO_KEYBOARD. */ +enum retro_key +{ + RETROK_UNKNOWN = 0, + RETROK_FIRST = 0, + RETROK_BACKSPACE = 8, + RETROK_TAB = 9, + RETROK_CLEAR = 12, + RETROK_RETURN = 13, + RETROK_PAUSE = 19, + RETROK_ESCAPE = 27, + RETROK_SPACE = 32, + RETROK_EXCLAIM = 33, + RETROK_QUOTEDBL = 34, + RETROK_HASH = 35, + RETROK_DOLLAR = 36, + RETROK_AMPERSAND = 38, + RETROK_QUOTE = 39, + RETROK_LEFTPAREN = 40, + RETROK_RIGHTPAREN = 41, + RETROK_ASTERISK = 42, + RETROK_PLUS = 43, + RETROK_COMMA = 44, + RETROK_MINUS = 45, + RETROK_PERIOD = 46, + RETROK_SLASH = 47, + RETROK_0 = 48, + RETROK_1 = 49, + RETROK_2 = 50, + RETROK_3 = 51, + RETROK_4 = 52, + RETROK_5 = 53, + RETROK_6 = 54, + RETROK_7 = 55, + RETROK_8 = 56, + RETROK_9 = 57, + RETROK_COLON = 58, + RETROK_SEMICOLON = 59, + RETROK_LESS = 60, + RETROK_EQUALS = 61, + RETROK_GREATER = 62, + RETROK_QUESTION = 63, + RETROK_AT = 64, + RETROK_LEFTBRACKET = 91, + RETROK_BACKSLASH = 92, + RETROK_RIGHTBRACKET = 93, + RETROK_CARET = 94, + RETROK_UNDERSCORE = 95, + RETROK_BACKQUOTE = 96, + RETROK_a = 97, + RETROK_b = 98, + RETROK_c = 99, + RETROK_d = 100, + RETROK_e = 101, + RETROK_f = 102, + RETROK_g = 103, + RETROK_h = 104, + RETROK_i = 105, + RETROK_j = 106, + RETROK_k = 107, + RETROK_l = 108, + RETROK_m = 109, + RETROK_n = 110, + RETROK_o = 111, + RETROK_p = 112, + RETROK_q = 113, + RETROK_r = 114, + RETROK_s = 115, + RETROK_t = 116, + RETROK_u = 117, + RETROK_v = 118, + RETROK_w = 119, + RETROK_x = 120, + RETROK_y = 121, + RETROK_z = 122, + RETROK_LEFTBRACE = 123, + RETROK_BAR = 124, + RETROK_RIGHTBRACE = 125, + RETROK_TILDE = 126, + RETROK_DELETE = 127, + + RETROK_KP0 = 256, + RETROK_KP1 = 257, + RETROK_KP2 = 258, + RETROK_KP3 = 259, + RETROK_KP4 = 260, + RETROK_KP5 = 261, + RETROK_KP6 = 262, + RETROK_KP7 = 263, + RETROK_KP8 = 264, + RETROK_KP9 = 265, + RETROK_KP_PERIOD = 266, + RETROK_KP_DIVIDE = 267, + RETROK_KP_MULTIPLY = 268, + RETROK_KP_MINUS = 269, + RETROK_KP_PLUS = 270, + RETROK_KP_ENTER = 271, + RETROK_KP_EQUALS = 272, + + RETROK_UP = 273, + RETROK_DOWN = 274, + RETROK_RIGHT = 275, + RETROK_LEFT = 276, + RETROK_INSERT = 277, + RETROK_HOME = 278, + RETROK_END = 279, + RETROK_PAGEUP = 280, + RETROK_PAGEDOWN = 281, + + RETROK_F1 = 282, + RETROK_F2 = 283, + RETROK_F3 = 284, + RETROK_F4 = 285, + RETROK_F5 = 286, + RETROK_F6 = 287, + RETROK_F7 = 288, + RETROK_F8 = 289, + RETROK_F9 = 290, + RETROK_F10 = 291, + RETROK_F11 = 292, + RETROK_F12 = 293, + RETROK_F13 = 294, + RETROK_F14 = 295, + RETROK_F15 = 296, + + RETROK_NUMLOCK = 300, + RETROK_CAPSLOCK = 301, + RETROK_SCROLLOCK = 302, + RETROK_RSHIFT = 303, + RETROK_LSHIFT = 304, + RETROK_RCTRL = 305, + RETROK_LCTRL = 306, + RETROK_RALT = 307, + RETROK_LALT = 308, + RETROK_RMETA = 309, + RETROK_LMETA = 310, + RETROK_LSUPER = 311, + RETROK_RSUPER = 312, + RETROK_MODE = 313, + RETROK_COMPOSE = 314, + + RETROK_HELP = 315, + RETROK_PRINT = 316, + RETROK_SYSREQ = 317, + RETROK_BREAK = 318, + RETROK_MENU = 319, + RETROK_POWER = 320, + RETROK_EURO = 321, + RETROK_UNDO = 322, + RETROK_OEM_102 = 323, + + RETROK_LAST, + + RETROK_DUMMY = INT_MAX /* Ensure sizeof(enum) == sizeof(int) */ +}; + +enum retro_mod +{ + RETROKMOD_NONE = 0x0000, + + RETROKMOD_SHIFT = 0x01, + RETROKMOD_CTRL = 0x02, + RETROKMOD_ALT = 0x04, + RETROKMOD_META = 0x08, + + RETROKMOD_NUMLOCK = 0x10, + RETROKMOD_CAPSLOCK = 0x20, + RETROKMOD_SCROLLOCK = 0x40, + + RETROKMOD_DUMMY = INT_MAX /* Ensure sizeof(enum) == sizeof(int) */ +}; + +/* If set, this call is not part of the public libretro API yet. It can + * change or be removed at any time. */ +#define RETRO_ENVIRONMENT_EXPERIMENTAL 0x10000 +/* Environment callback to be used internally in frontend. */ +#define RETRO_ENVIRONMENT_PRIVATE 0x20000 + +/* Environment commands. */ +#define RETRO_ENVIRONMENT_SET_ROTATION 1 /* const unsigned * -- + * Sets screen rotation of graphics. + * Valid values are 0, 1, 2, 3, which rotates screen by 0, 90, 180, + * 270 degrees counter-clockwise respectively. + */ +#define RETRO_ENVIRONMENT_GET_OVERSCAN 2 /* bool * -- + * NOTE: As of 2019 this callback is considered deprecated in favor of + * using core options to manage overscan in a more nuanced, core-specific way. + * + * Boolean value whether or not the implementation should use overscan, + * or crop away overscan. + */ +#define RETRO_ENVIRONMENT_GET_CAN_DUPE 3 /* bool * -- + * Boolean value whether or not frontend supports frame duping, + * passing NULL to video frame callback. + */ + + /* Environ 4, 5 are no longer supported (GET_VARIABLE / SET_VARIABLES), + * and reserved to avoid possible ABI clash. + */ + +#define RETRO_ENVIRONMENT_SET_MESSAGE 6 /* const struct retro_message * -- + * Sets a message to be displayed in implementation-specific manner + * for a certain amount of 'frames'. + * Should not be used for trivial messages, which should simply be + * logged via RETRO_ENVIRONMENT_GET_LOG_INTERFACE (or as a + * fallback, stderr). + */ +#define RETRO_ENVIRONMENT_SHUTDOWN 7 /* N/A (NULL) -- + * Requests the frontend to shutdown. + * Should only be used if game has a specific + * way to shutdown the game from a menu item or similar. + */ +#define RETRO_ENVIRONMENT_SET_PERFORMANCE_LEVEL 8 + /* const unsigned * -- + * Gives a hint to the frontend how demanding this implementation + * is on a system. E.g. reporting a level of 2 means + * this implementation should run decently on all frontends + * of level 2 and up. + * + * It can be used by the frontend to potentially warn + * about too demanding implementations. + * + * The levels are "floating". + * + * This function can be called on a per-game basis, + * as certain games an implementation can play might be + * particularly demanding. + * If called, it should be called in retro_load_game(). + */ +#define RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY 9 + /* const char ** -- + * Returns the "system" directory of the frontend. + * This directory can be used to store system specific + * content such as BIOSes, configuration data, etc. + * The returned value can be NULL. + * If so, no such directory is defined, + * and it's up to the implementation to find a suitable directory. + * + * NOTE: Some cores used this folder also for "save" data such as + * memory cards, etc, for lack of a better place to put it. + * This is now discouraged, and if possible, cores should try to + * use the new GET_SAVE_DIRECTORY. + */ +#define RETRO_ENVIRONMENT_SET_PIXEL_FORMAT 10 + /* const enum retro_pixel_format * -- + * Sets the internal pixel format used by the implementation. + * The default pixel format is RETRO_PIXEL_FORMAT_0RGB1555. + * This pixel format however, is deprecated (see enum retro_pixel_format). + * If the call returns false, the frontend does not support this pixel + * format. + * + * This function should be called inside retro_load_game() or + * retro_get_system_av_info(). + */ +#define RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS 11 + /* const struct retro_input_descriptor * -- + * Sets an array of retro_input_descriptors. + * It is up to the frontend to present this in a usable way. + * The array is terminated by retro_input_descriptor::description + * being set to NULL. + * This function can be called at any time, but it is recommended + * to call it as early as possible. + */ +#define RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK 12 + /* const struct retro_keyboard_callback * -- + * Sets a callback function used to notify core about keyboard events. + */ +#define RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE 13 + /* const struct retro_disk_control_callback * -- + * Sets an interface which frontend can use to eject and insert + * disk images. + * This is used for games which consist of multiple images and + * must be manually swapped out by the user (e.g. PSX). + */ +#define RETRO_ENVIRONMENT_SET_HW_RENDER 14 + /* struct retro_hw_render_callback * -- + * Sets an interface to let a libretro core render with + * hardware acceleration. + * Should be called in retro_load_game(). + * If successful, libretro cores will be able to render to a + * frontend-provided framebuffer. + * The size of this framebuffer will be at least as large as + * max_width/max_height provided in get_av_info(). + * If HW rendering is used, pass only RETRO_HW_FRAME_BUFFER_VALID or + * NULL to retro_video_refresh_t. + */ +#define RETRO_ENVIRONMENT_GET_VARIABLE 15 + /* struct retro_variable * -- + * Interface to acquire user-defined information from environment + * that cannot feasibly be supported in a multi-system way. + * 'key' should be set to a key which has already been set by + * SET_VARIABLES. + * 'data' will be set to a value or NULL. + */ +#define RETRO_ENVIRONMENT_SET_VARIABLES 16 + /* const struct retro_variable * -- + * Allows an implementation to signal the environment + * which variables it might want to check for later using + * GET_VARIABLE. + * This allows the frontend to present these variables to + * a user dynamically. + * This should be called the first time as early as + * possible (ideally in retro_set_environment). + * Afterward it may be called again for the core to communicate + * updated options to the frontend, but the number of core + * options must not change from the number in the initial call. + * + * 'data' points to an array of retro_variable structs + * terminated by a { NULL, NULL } element. + * retro_variable::key should be namespaced to not collide + * with other implementations' keys. E.g. A core called + * 'foo' should use keys named as 'foo_option'. + * retro_variable::value should contain a human readable + * description of the key as well as a '|' delimited list + * of expected values. + * + * The number of possible options should be very limited, + * i.e. it should be feasible to cycle through options + * without a keyboard. + * + * First entry should be treated as a default. + * + * Example entry: + * { "foo_option", "Speed hack coprocessor X; false|true" } + * + * Text before first ';' is description. This ';' must be + * followed by a space, and followed by a list of possible + * values split up with '|'. + * + * Only strings are operated on. The possible values will + * generally be displayed and stored as-is by the frontend. + */ +#define RETRO_ENVIRONMENT_GET_VARIABLE_UPDATE 17 + /* bool * -- + * Result is set to true if some variables are updated by + * frontend since last call to RETRO_ENVIRONMENT_GET_VARIABLE. + * Variables should be queried with GET_VARIABLE. + */ +#define RETRO_ENVIRONMENT_SET_SUPPORT_NO_GAME 18 + /* const bool * -- + * If true, the libretro implementation supports calls to + * retro_load_game() with NULL as argument. + * Used by cores which can run without particular game data. + * This should be called within retro_set_environment() only. + */ +#define RETRO_ENVIRONMENT_GET_LIBRETRO_PATH 19 + /* const char ** -- + * Retrieves the absolute path from where this libretro + * implementation was loaded. + * NULL is returned if the libretro was loaded statically + * (i.e. linked statically to frontend), or if the path cannot be + * determined. + * Mostly useful in cooperation with SET_SUPPORT_NO_GAME as assets can + * be loaded without ugly hacks. + */ + + /* Environment 20 was an obsolete version of SET_AUDIO_CALLBACK. + * It was not used by any known core at the time, + * and was removed from the API. */ +#define RETRO_ENVIRONMENT_SET_FRAME_TIME_CALLBACK 21 + /* const struct retro_frame_time_callback * -- + * Lets the core know how much time has passed since last + * invocation of retro_run(). + * The frontend can tamper with the timing to fake fast-forward, + * slow-motion, frame stepping, etc. + * In this case the delta time will use the reference value + * in frame_time_callback.. + */ +#define RETRO_ENVIRONMENT_SET_AUDIO_CALLBACK 22 + /* const struct retro_audio_callback * -- + * Sets an interface which is used to notify a libretro core about audio + * being available for writing. + * The callback can be called from any thread, so a core using this must + * have a thread safe audio implementation. + * It is intended for games where audio and video are completely + * asynchronous and audio can be generated on the fly. + * This interface is not recommended for use with emulators which have + * highly synchronous audio. + * + * The callback only notifies about writability; the libretro core still + * has to call the normal audio callbacks + * to write audio. The audio callbacks must be called from within the + * notification callback. + * The amount of audio data to write is up to the implementation. + * Generally, the audio callback will be called continously in a loop. + * + * Due to thread safety guarantees and lack of sync between audio and + * video, a frontend can selectively disallow this interface based on + * internal configuration. A core using this interface must also + * implement the "normal" audio interface. + * + * A libretro core using SET_AUDIO_CALLBACK should also make use of + * SET_FRAME_TIME_CALLBACK. + */ +#define RETRO_ENVIRONMENT_GET_RUMBLE_INTERFACE 23 + /* struct retro_rumble_interface * -- + * Gets an interface which is used by a libretro core to set + * state of rumble motors in controllers. + * A strong and weak motor is supported, and they can be + * controlled indepedently. + * Should be called from either retro_init() or retro_load_game(). + * Should not be called from retro_set_environment(). + * Returns false if rumble functionality is unavailable. + */ +#define RETRO_ENVIRONMENT_GET_INPUT_DEVICE_CAPABILITIES 24 + /* uint64_t * -- + * Gets a bitmask telling which device type are expected to be + * handled properly in a call to retro_input_state_t. + * Devices which are not handled or recognized always return + * 0 in retro_input_state_t. + * Example bitmask: caps = (1 << RETRO_DEVICE_JOYPAD) | (1 << RETRO_DEVICE_ANALOG). + * Should only be called in retro_run(). + */ +#define RETRO_ENVIRONMENT_GET_SENSOR_INTERFACE (25 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* struct retro_sensor_interface * -- + * Gets access to the sensor interface. + * The purpose of this interface is to allow + * setting state related to sensors such as polling rate, + * enabling/disable it entirely, etc. + * Reading sensor state is done via the normal + * input_state_callback API. + */ +#define RETRO_ENVIRONMENT_GET_CAMERA_INTERFACE (26 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* struct retro_camera_callback * -- + * Gets an interface to a video camera driver. + * A libretro core can use this interface to get access to a + * video camera. + * New video frames are delivered in a callback in same + * thread as retro_run(). + * + * GET_CAMERA_INTERFACE should be called in retro_load_game(). + * + * Depending on the camera implementation used, camera frames + * will be delivered as a raw framebuffer, + * or as an OpenGL texture directly. + * + * The core has to tell the frontend here which types of + * buffers can be handled properly. + * An OpenGL texture can only be handled when using a + * libretro GL core (SET_HW_RENDER). + * It is recommended to use a libretro GL core when + * using camera interface. + * + * The camera is not started automatically. The retrieved start/stop + * functions must be used to explicitly + * start and stop the camera driver. + */ +#define RETRO_ENVIRONMENT_GET_LOG_INTERFACE 27 + /* struct retro_log_callback * -- + * Gets an interface for logging. This is useful for + * logging in a cross-platform way + * as certain platforms cannot use stderr for logging. + * It also allows the frontend to + * show logging information in a more suitable way. + * If this interface is not used, libretro cores should + * log to stderr as desired. + */ +#define RETRO_ENVIRONMENT_GET_PERF_INTERFACE 28 + /* struct retro_perf_callback * -- + * Gets an interface for performance counters. This is useful + * for performance logging in a cross-platform way and for detecting + * architecture-specific features, such as SIMD support. + */ +#define RETRO_ENVIRONMENT_GET_LOCATION_INTERFACE 29 + /* struct retro_location_callback * -- + * Gets access to the location interface. + * The purpose of this interface is to be able to retrieve + * location-based information from the host device, + * such as current latitude / longitude. + */ +#define RETRO_ENVIRONMENT_GET_CONTENT_DIRECTORY 30 /* Old name, kept for compatibility. */ +#define RETRO_ENVIRONMENT_GET_CORE_ASSETS_DIRECTORY 30 + /* const char ** -- + * Returns the "core assets" directory of the frontend. + * This directory can be used to store specific assets that the + * core relies upon, such as art assets, + * input data, etc etc. + * The returned value can be NULL. + * If so, no such directory is defined, + * and it's up to the implementation to find a suitable directory. + */ +#define RETRO_ENVIRONMENT_GET_SAVE_DIRECTORY 31 + /* const char ** -- + * Returns the "save" directory of the frontend, unless there is no + * save directory available. The save directory should be used to + * store SRAM, memory cards, high scores, etc, if the libretro core + * cannot use the regular memory interface (retro_get_memory_data()). + * + * If the frontend cannot designate a save directory, it will return + * NULL to indicate that the core should attempt to operate without a + * save directory set. + * + * NOTE: early libretro cores used the system directory for save + * files. Cores that need to be backwards-compatible can still check + * GET_SYSTEM_DIRECTORY. + */ +#define RETRO_ENVIRONMENT_SET_SYSTEM_AV_INFO 32 + /* const struct retro_system_av_info * -- + * Sets a new av_info structure. This can only be called from + * within retro_run(). + * This should *only* be used if the core is completely altering the + * internal resolutions, aspect ratios, timings, sampling rate, etc. + * Calling this can require a full reinitialization of video/audio + * drivers in the frontend, + * + * so it is important to call it very sparingly, and usually only with + * the users explicit consent. + * An eventual driver reinitialize will happen so that video and + * audio callbacks + * happening after this call within the same retro_run() call will + * target the newly initialized driver. + * + * This callback makes it possible to support configurable resolutions + * in games, which can be useful to + * avoid setting the "worst case" in max_width/max_height. + * + * ***HIGHLY RECOMMENDED*** Do not call this callback every time + * resolution changes in an emulator core if it's + * expected to be a temporary change, for the reasons of possible + * driver reinitialization. + * This call is not a free pass for not trying to provide + * correct values in retro_get_system_av_info(). If you need to change + * things like aspect ratio or nominal width/height, + * use RETRO_ENVIRONMENT_SET_GEOMETRY, which is a softer variant + * of SET_SYSTEM_AV_INFO. + * + * If this returns false, the frontend does not acknowledge a + * changed av_info struct. + */ +#define RETRO_ENVIRONMENT_SET_PROC_ADDRESS_CALLBACK 33 + /* const struct retro_get_proc_address_interface * -- + * Allows a libretro core to announce support for the + * get_proc_address() interface. + * This interface allows for a standard way to extend libretro where + * use of environment calls are too indirect, + * e.g. for cases where the frontend wants to call directly into the core. + * + * If a core wants to expose this interface, SET_PROC_ADDRESS_CALLBACK + * **MUST** be called from within retro_set_environment(). + */ +#define RETRO_ENVIRONMENT_SET_SUBSYSTEM_INFO 34 + /* const struct retro_subsystem_info * -- + * This environment call introduces the concept of libretro "subsystems". + * A subsystem is a variant of a libretro core which supports + * different kinds of games. + * The purpose of this is to support e.g. emulators which might + * have special needs, e.g. Super Nintendo's Super GameBoy, Sufami Turbo. + * It can also be used to pick among subsystems in an explicit way + * if the libretro implementation is a multi-system emulator itself. + * + * Loading a game via a subsystem is done with retro_load_game_special(), + * and this environment call allows a libretro core to expose which + * subsystems are supported for use with retro_load_game_special(). + * A core passes an array of retro_game_special_info which is terminated + * with a zeroed out retro_game_special_info struct. + * + * If a core wants to use this functionality, SET_SUBSYSTEM_INFO + * **MUST** be called from within retro_set_environment(). + */ +#define RETRO_ENVIRONMENT_SET_CONTROLLER_INFO 35 + /* const struct retro_controller_info * -- + * This environment call lets a libretro core tell the frontend + * which controller subclasses are recognized in calls to + * retro_set_controller_port_device(). + * + * Some emulators such as Super Nintendo support multiple lightgun + * types which must be specifically selected from. It is therefore + * sometimes necessary for a frontend to be able to tell the core + * about a special kind of input device which is not specifcally + * provided by the Libretro API. + * + * In order for a frontend to understand the workings of those devices, + * they must be defined as a specialized subclass of the generic device + * types already defined in the libretro API. + * + * The core must pass an array of const struct retro_controller_info which + * is terminated with a blanked out struct. Each element of the + * retro_controller_info struct corresponds to the ascending port index + * that is passed to retro_set_controller_port_device() when that function + * is called to indicate to the core that the frontend has changed the + * active device subclass. SEE ALSO: retro_set_controller_port_device() + * + * The ascending input port indexes provided by the core in the struct + * are generally presented by frontends as ascending User # or Player #, + * such as Player 1, Player 2, Player 3, etc. Which device subclasses are + * supported can vary per input port. + * + * The first inner element of each entry in the retro_controller_info array + * is a retro_controller_description struct that specifies the names and + * codes of all device subclasses that are available for the corresponding + * User or Player, beginning with the generic Libretro device that the + * subclasses are derived from. The second inner element of each entry is the + * total number of subclasses that are listed in the retro_controller_description. + * + * NOTE: Even if special device types are set in the libretro core, + * libretro should only poll input based on the base input device types. + */ +#define RETRO_ENVIRONMENT_SET_MEMORY_MAPS (36 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* const struct retro_memory_map * -- + * This environment call lets a libretro core tell the frontend + * about the memory maps this core emulates. + * This can be used to implement, for example, cheats in a core-agnostic way. + * + * Should only be used by emulators; it doesn't make much sense for + * anything else. + * It is recommended to expose all relevant pointers through + * retro_get_memory_* as well. + * + * Can be called from retro_init and retro_load_game. + */ +#define RETRO_ENVIRONMENT_SET_GEOMETRY 37 + /* const struct retro_game_geometry * -- + * This environment call is similar to SET_SYSTEM_AV_INFO for changing + * video parameters, but provides a guarantee that drivers will not be + * reinitialized. + * This can only be called from within retro_run(). + * + * The purpose of this call is to allow a core to alter nominal + * width/heights as well as aspect ratios on-the-fly, which can be + * useful for some emulators to change in run-time. + * + * max_width/max_height arguments are ignored and cannot be changed + * with this call as this could potentially require a reinitialization or a + * non-constant time operation. + * If max_width/max_height are to be changed, SET_SYSTEM_AV_INFO is required. + * + * A frontend must guarantee that this environment call completes in + * constant time. + */ +#define RETRO_ENVIRONMENT_GET_USERNAME 38 + /* const char ** + * Returns the specified username of the frontend, if specified by the user. + * This username can be used as a nickname for a core that has online facilities + * or any other mode where personalization of the user is desirable. + * The returned value can be NULL. + * If this environ callback is used by a core that requires a valid username, + * a default username should be specified by the core. + */ +#define RETRO_ENVIRONMENT_GET_LANGUAGE 39 + /* unsigned * -- + * Returns the specified language of the frontend, if specified by the user. + * It can be used by the core for localization purposes. + */ +#define RETRO_ENVIRONMENT_GET_CURRENT_SOFTWARE_FRAMEBUFFER (40 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* struct retro_framebuffer * -- + * Returns a preallocated framebuffer which the core can use for rendering + * the frame into when not using SET_HW_RENDER. + * The framebuffer returned from this call must not be used + * after the current call to retro_run() returns. + * + * The goal of this call is to allow zero-copy behavior where a core + * can render directly into video memory, avoiding extra bandwidth cost by copying + * memory from core to video memory. + * + * If this call succeeds and the core renders into it, + * the framebuffer pointer and pitch can be passed to retro_video_refresh_t. + * If the buffer from GET_CURRENT_SOFTWARE_FRAMEBUFFER is to be used, + * the core must pass the exact + * same pointer as returned by GET_CURRENT_SOFTWARE_FRAMEBUFFER; + * i.e. passing a pointer which is offset from the + * buffer is undefined. The width, height and pitch parameters + * must also match exactly to the values obtained from GET_CURRENT_SOFTWARE_FRAMEBUFFER. + * + * It is possible for a frontend to return a different pixel format + * than the one used in SET_PIXEL_FORMAT. This can happen if the frontend + * needs to perform conversion. + * + * It is still valid for a core to render to a different buffer + * even if GET_CURRENT_SOFTWARE_FRAMEBUFFER succeeds. + * + * A frontend must make sure that the pointer obtained from this function is + * writeable (and readable). + */ +#define RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE (41 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* const struct retro_hw_render_interface ** -- + * Returns an API specific rendering interface for accessing API specific data. + * Not all HW rendering APIs support or need this. + * The contents of the returned pointer is specific to the rendering API + * being used. See the various headers like libretro_vulkan.h, etc. + * + * GET_HW_RENDER_INTERFACE cannot be called before context_reset has been called. + * Similarly, after context_destroyed callback returns, + * the contents of the HW_RENDER_INTERFACE are invalidated. + */ +#define RETRO_ENVIRONMENT_SET_SUPPORT_ACHIEVEMENTS (42 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* const bool * -- + * If true, the libretro implementation supports achievements + * either via memory descriptors set with RETRO_ENVIRONMENT_SET_MEMORY_MAPS + * or via retro_get_memory_data/retro_get_memory_size. + * + * This must be called before the first call to retro_run. + */ +#define RETRO_ENVIRONMENT_SET_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE (43 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* const struct retro_hw_render_context_negotiation_interface * -- + * Sets an interface which lets the libretro core negotiate with frontend how a context is created. + * The semantics of this interface depends on which API is used in SET_HW_RENDER earlier. + * This interface will be used when the frontend is trying to create a HW rendering context, + * so it will be used after SET_HW_RENDER, but before the context_reset callback. + */ +#define RETRO_ENVIRONMENT_SET_SERIALIZATION_QUIRKS 44 + /* uint64_t * -- + * Sets quirk flags associated with serialization. The frontend will zero any flags it doesn't + * recognize or support. Should be set in either retro_init or retro_load_game, but not both. + */ +#define RETRO_ENVIRONMENT_SET_HW_SHARED_CONTEXT (44 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* N/A (null) * -- + * The frontend will try to use a 'shared' hardware context (mostly applicable + * to OpenGL) when a hardware context is being set up. + * + * Returns true if the frontend supports shared hardware contexts and false + * if the frontend does not support shared hardware contexts. + * + * This will do nothing on its own until SET_HW_RENDER env callbacks are + * being used. + */ +#define RETRO_ENVIRONMENT_GET_VFS_INTERFACE (45 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* struct retro_vfs_interface_info * -- + * Gets access to the VFS interface. + * VFS presence needs to be queried prior to load_game or any + * get_system/save/other_directory being called to let front end know + * core supports VFS before it starts handing out paths. + * It is recomended to do so in retro_set_environment + */ +#define RETRO_ENVIRONMENT_GET_LED_INTERFACE (46 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* struct retro_led_interface * -- + * Gets an interface which is used by a libretro core to set + * state of LEDs. + */ +#define RETRO_ENVIRONMENT_GET_AUDIO_VIDEO_ENABLE (47 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* int * -- + * Tells the core if the frontend wants audio or video. + * If disabled, the frontend will discard the audio or video, + * so the core may decide to skip generating a frame or generating audio. + * This is mainly used for increasing performance. + * Bit 0 (value 1): Enable Video + * Bit 1 (value 2): Enable Audio + * Bit 2 (value 4): Use Fast Savestates. + * Bit 3 (value 8): Hard Disable Audio + * Other bits are reserved for future use and will default to zero. + * If video is disabled: + * * The frontend wants the core to not generate any video, + * including presenting frames via hardware acceleration. + * * The frontend's video frame callback will do nothing. + * * After running the frame, the video output of the next frame should be + * no different than if video was enabled, and saving and loading state + * should have no issues. + * If audio is disabled: + * * The frontend wants the core to not generate any audio. + * * The frontend's audio callbacks will do nothing. + * * After running the frame, the audio output of the next frame should be + * no different than if audio was enabled, and saving and loading state + * should have no issues. + * Fast Savestates: + * * Guaranteed to be created by the same binary that will load them. + * * Will not be written to or read from the disk. + * * Suggest that the core assumes loading state will succeed. + * * Suggest that the core updates its memory buffers in-place if possible. + * * Suggest that the core skips clearing memory. + * * Suggest that the core skips resetting the system. + * * Suggest that the core may skip validation steps. + * Hard Disable Audio: + * * Used for a secondary core when running ahead. + * * Indicates that the frontend will never need audio from the core. + * * Suggests that the core may stop synthesizing audio, but this should not + * compromise emulation accuracy. + * * Audio output for the next frame does not matter, and the frontend will + * never need an accurate audio state in the future. + * * State will never be saved when using Hard Disable Audio. + */ +#define RETRO_ENVIRONMENT_GET_MIDI_INTERFACE (48 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* struct retro_midi_interface ** -- + * Returns a MIDI interface that can be used for raw data I/O. + */ + +#define RETRO_ENVIRONMENT_GET_FASTFORWARDING (49 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* bool * -- + * Boolean value that indicates whether or not the frontend is in + * fastforwarding mode. + */ + +#define RETRO_ENVIRONMENT_GET_TARGET_REFRESH_RATE (50 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* float * -- + * Float value that lets us know what target refresh rate + * is curently in use by the frontend. + * + * The core can use the returned value to set an ideal + * refresh rate/framerate. + */ + +#define RETRO_ENVIRONMENT_GET_INPUT_BITMASKS (51 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* bool * -- + * Boolean value that indicates whether or not the frontend supports + * input bitmasks being returned by retro_input_state_t. The advantage + * of this is that retro_input_state_t has to be only called once to + * grab all button states instead of multiple times. + * + * If it returns true, you can pass RETRO_DEVICE_ID_JOYPAD_MASK as 'id' + * to retro_input_state_t (make sure 'device' is set to RETRO_DEVICE_JOYPAD). + * It will return a bitmask of all the digital buttons. + */ + +#define RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION 52 + /* unsigned * -- + * Unsigned value is the API version number of the core options + * interface supported by the frontend. If callback return false, + * API version is assumed to be 0. + * + * In legacy code, core options are set by passing an array of + * retro_variable structs to RETRO_ENVIRONMENT_SET_VARIABLES. + * This may be still be done regardless of the core options + * interface version. + * + * If version is >= 1 however, core options may instead be set by + * passing an array of retro_core_option_definition structs to + * RETRO_ENVIRONMENT_SET_CORE_OPTIONS, or a 2D array of + * retro_core_option_definition structs to RETRO_ENVIRONMENT_SET_CORE_OPTIONS_INTL. + * This allows the core to additionally set option sublabel information + * and/or provide localisation support. + */ + +#define RETRO_ENVIRONMENT_SET_CORE_OPTIONS 53 + /* const struct retro_core_option_definition ** -- + * Allows an implementation to signal the environment + * which variables it might want to check for later using + * GET_VARIABLE. + * This allows the frontend to present these variables to + * a user dynamically. + * This should only be called if RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION + * returns an API version of >= 1. + * This should be called instead of RETRO_ENVIRONMENT_SET_VARIABLES. + * This should be called the first time as early as + * possible (ideally in retro_set_environment). + * Afterwards it may be called again for the core to communicate + * updated options to the frontend, but the number of core + * options must not change from the number in the initial call. + * + * 'data' points to an array of retro_core_option_definition structs + * terminated by a { NULL, NULL, NULL, {{0}}, NULL } element. + * retro_core_option_definition::key should be namespaced to not collide + * with other implementations' keys. e.g. A core called + * 'foo' should use keys named as 'foo_option'. + * retro_core_option_definition::desc should contain a human readable + * description of the key. + * retro_core_option_definition::info should contain any additional human + * readable information text that a typical user may need to + * understand the functionality of the option. + * retro_core_option_definition::values is an array of retro_core_option_value + * structs terminated by a { NULL, NULL } element. + * > retro_core_option_definition::values[index].value is an expected option + * value. + * > retro_core_option_definition::values[index].label is a human readable + * label used when displaying the value on screen. If NULL, + * the value itself is used. + * retro_core_option_definition::default_value is the default core option + * setting. It must match one of the expected option values in the + * retro_core_option_definition::values array. If it does not, or the + * default value is NULL, the first entry in the + * retro_core_option_definition::values array is treated as the default. + * + * The number of possible options should be very limited, + * and must be less than RETRO_NUM_CORE_OPTION_VALUES_MAX. + * i.e. it should be feasible to cycle through options + * without a keyboard. + * + * Example entry: + * { + * "foo_option", + * "Speed hack coprocessor X", + * "Provides increased performance at the expense of reduced accuracy", + * { + * { "false", NULL }, + * { "true", NULL }, + * { "unstable", "Turbo (Unstable)" }, + * { NULL, NULL }, + * }, + * "false" + * } + * + * Only strings are operated on. The possible values will + * generally be displayed and stored as-is by the frontend. + */ + +#define RETRO_ENVIRONMENT_SET_CORE_OPTIONS_INTL 54 + /* const struct retro_core_options_intl * -- + * Allows an implementation to signal the environment + * which variables it might want to check for later using + * GET_VARIABLE. + * This allows the frontend to present these variables to + * a user dynamically. + * This should only be called if RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION + * returns an API version of >= 1. + * This should be called instead of RETRO_ENVIRONMENT_SET_VARIABLES. + * This should be called the first time as early as + * possible (ideally in retro_set_environment). + * Afterwards it may be called again for the core to communicate + * updated options to the frontend, but the number of core + * options must not change from the number in the initial call. + * + * This is fundamentally the same as RETRO_ENVIRONMENT_SET_CORE_OPTIONS, + * with the addition of localisation support. The description of the + * RETRO_ENVIRONMENT_SET_CORE_OPTIONS callback should be consulted + * for further details. + * + * 'data' points to a retro_core_options_intl struct. + * + * retro_core_options_intl::us is a pointer to an array of + * retro_core_option_definition structs defining the US English + * core options implementation. It must point to a valid array. + * + * retro_core_options_intl::local is a pointer to an array of + * retro_core_option_definition structs defining core options for + * the current frontend language. It may be NULL (in which case + * retro_core_options_intl::us is used by the frontend). Any items + * missing from this array will be read from retro_core_options_intl::us + * instead. + * + * NOTE: Default core option values are always taken from the + * retro_core_options_intl::us array. Any default values in + * retro_core_options_intl::local array will be ignored. + */ + +#define RETRO_ENVIRONMENT_SET_CORE_OPTIONS_DISPLAY 55 + /* struct retro_core_option_display * -- + * + * Allows an implementation to signal the environment to show + * or hide a variable when displaying core options. This is + * considered a *suggestion*. The frontend is free to ignore + * this callback, and its implementation not considered mandatory. + * + * 'data' points to a retro_core_option_display struct + * + * retro_core_option_display::key is a variable identifier + * which has already been set by SET_VARIABLES/SET_CORE_OPTIONS. + * + * retro_core_option_display::visible is a boolean, specifying + * whether variable should be displayed + * + * Note that all core option variables will be set visible by + * default when calling SET_VARIABLES/SET_CORE_OPTIONS. + */ + +#define RETRO_ENVIRONMENT_GET_PREFERRED_HW_RENDER 56 + /* unsigned * -- + * + * Allows an implementation to ask frontend preferred hardware + * context to use. Core should use this information to deal + * with what specific context to request with SET_HW_RENDER. + * + * 'data' points to an unsigned variable + */ + +#define RETRO_ENVIRONMENT_GET_DISK_CONTROL_INTERFACE_VERSION 57 + /* unsigned * -- + * Unsigned value is the API version number of the disk control + * interface supported by the frontend. If callback return false, + * API version is assumed to be 0. + * + * In legacy code, the disk control interface is defined by passing + * a struct of type retro_disk_control_callback to + * RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE. + * This may be still be done regardless of the disk control + * interface version. + * + * If version is >= 1 however, the disk control interface may + * instead be defined by passing a struct of type + * retro_disk_control_ext_callback to + * RETRO_ENVIRONMENT_SET_DISK_CONTROL_EXT_INTERFACE. + * This allows the core to provide additional information about + * disk images to the frontend and/or enables extra + * disk control functionality by the frontend. + */ + +#define RETRO_ENVIRONMENT_SET_DISK_CONTROL_EXT_INTERFACE 58 + /* const struct retro_disk_control_ext_callback * -- + * Sets an interface which frontend can use to eject and insert + * disk images, and also obtain information about individual + * disk image files registered by the core. + * This is used for games which consist of multiple images and + * must be manually swapped out by the user (e.g. PSX, floppy disk + * based systems). + */ + +#define RETRO_ENVIRONMENT_GET_MESSAGE_INTERFACE_VERSION 59 + /* unsigned * -- + * Unsigned value is the API version number of the message + * interface supported by the frontend. If callback returns + * false, API version is assumed to be 0. + * + * In legacy code, messages may be displayed in an + * implementation-specific manner by passing a struct + * of type retro_message to RETRO_ENVIRONMENT_SET_MESSAGE. + * This may be still be done regardless of the message + * interface version. + * + * If version is >= 1 however, messages may instead be + * displayed by passing a struct of type retro_message_ext + * to RETRO_ENVIRONMENT_SET_MESSAGE_EXT. This allows the + * core to specify message logging level, priority and + * destination (OSD, logging interface or both). + */ + +#define RETRO_ENVIRONMENT_SET_MESSAGE_EXT 60 + /* const struct retro_message_ext * -- + * Sets a message to be displayed in an implementation-specific + * manner for a certain amount of 'frames'. Additionally allows + * the core to specify message logging level, priority and + * destination (OSD, logging interface or both). + * Should not be used for trivial messages, which should simply be + * logged via RETRO_ENVIRONMENT_GET_LOG_INTERFACE (or as a + * fallback, stderr). + */ + +#define RETRO_ENVIRONMENT_GET_INPUT_MAX_USERS 61 + /* unsigned * -- + * Unsigned value is the number of active input devices + * provided by the frontend. This may change between + * frames, but will remain constant for the duration + * of each frame. + * If callback returns true, a core need not poll any + * input device with an index greater than or equal to + * the number of active devices. + * If callback returns false, the number of active input + * devices is unknown. In this case, all input devices + * should be considered active. + */ + +#define RETRO_ENVIRONMENT_SET_AUDIO_BUFFER_STATUS_CALLBACK 62 + /* const struct retro_audio_buffer_status_callback * -- + * Lets the core know the occupancy level of the frontend + * audio buffer. Can be used by a core to attempt frame + * skipping in order to avoid buffer under-runs. + * A core may pass NULL to disable buffer status reporting + * in the frontend. + */ + +#define RETRO_ENVIRONMENT_SET_MINIMUM_AUDIO_LATENCY 63 + /* const unsigned * -- + * Sets minimum frontend audio latency in milliseconds. + * Resultant audio latency may be larger than set value, + * or smaller if a hardware limit is encountered. A frontend + * is expected to honour requests up to 512 ms. + * + * - If value is less than current frontend + * audio latency, callback has no effect + * - If value is zero, default frontend audio + * latency is set + * + * May be used by a core to increase audio latency and + * therefore decrease the probability of buffer under-runs + * (crackling) when performing 'intensive' operations. + * A core utilising RETRO_ENVIRONMENT_SET_AUDIO_BUFFER_STATUS_CALLBACK + * to implement audio-buffer-based frame skipping may achieve + * optimal results by setting the audio latency to a 'high' + * (typically 6x or 8x) integer multiple of the expected + * frame time. + * + * WARNING: This can only be called from within retro_run(). + * Calling this can require a full reinitialization of audio + * drivers in the frontend, so it is important to call it very + * sparingly, and usually only with the users explicit consent. + * An eventual driver reinitialize will happen so that audio + * callbacks happening after this call within the same retro_run() + * call will target the newly initialized driver. + */ + +#define RETRO_ENVIRONMENT_SET_FASTFORWARDING_OVERRIDE 64 + /* const struct retro_fastforwarding_override * -- + * Used by a libretro core to override the current + * fastforwarding mode of the frontend. + * If NULL is passed to this function, the frontend + * will return true if fastforwarding override + * functionality is supported (no change in + * fastforwarding state will occur in this case). + */ + +#define RETRO_ENVIRONMENT_SET_CONTENT_INFO_OVERRIDE 65 + /* const struct retro_system_content_info_override * -- + * Allows an implementation to override 'global' content + * info parameters reported by retro_get_system_info(). + * Overrides also affect subsystem content info parameters + * set via RETRO_ENVIRONMENT_SET_SUBSYSTEM_INFO. + * This function must be called inside retro_set_environment(). + * If callback returns false, content info overrides + * are unsupported by the frontend, and will be ignored. + * If callback returns true, extended game info may be + * retrieved by calling RETRO_ENVIRONMENT_GET_GAME_INFO_EXT + * in retro_load_game() or retro_load_game_special(). + * + * 'data' points to an array of retro_system_content_info_override + * structs terminated by a { NULL, false, false } element. + * If 'data' is NULL, no changes will be made to the frontend; + * a core may therefore pass NULL in order to test whether + * the RETRO_ENVIRONMENT_SET_CONTENT_INFO_OVERRIDE and + * RETRO_ENVIRONMENT_GET_GAME_INFO_EXT callbacks are supported + * by the frontend. + * + * For struct member descriptions, see the definition of + * struct retro_system_content_info_override. + * + * Example: + * + * - struct retro_system_info: + * { + * "My Core", // library_name + * "v1.0", // library_version + * "m3u|md|cue|iso|chd|sms|gg|sg", // valid_extensions + * true, // need_fullpath + * false // block_extract + * } + * + * - Array of struct retro_system_content_info_override: + * { + * { + * "md|sms|gg", // extensions + * false, // need_fullpath + * true // persistent_data + * }, + * { + * "sg", // extensions + * false, // need_fullpath + * false // persistent_data + * }, + * { NULL, false, false } + * } + * + * Result: + * - Files of type m3u, cue, iso, chd will not be + * loaded by the frontend. Frontend will pass a + * valid path to the core, and core will handle + * loading internally + * - Files of type md, sms, gg will be loaded by + * the frontend. A valid memory buffer will be + * passed to the core. This memory buffer will + * remain valid until retro_deinit() returns + * - Files of type sg will be loaded by the frontend. + * A valid memory buffer will be passed to the core. + * This memory buffer will remain valid until + * retro_load_game() (or retro_load_game_special()) + * returns + * + * NOTE: If an extension is listed multiple times in + * an array of retro_system_content_info_override + * structs, only the first instance will be registered + */ + +#define RETRO_ENVIRONMENT_GET_GAME_INFO_EXT 66 + /* const struct retro_game_info_ext ** -- + * Allows an implementation to fetch extended game + * information, providing additional content path + * and memory buffer status details. + * This function may only be called inside + * retro_load_game() or retro_load_game_special(). + * If callback returns false, extended game information + * is unsupported by the frontend. In this case, only + * regular retro_game_info will be available. + * RETRO_ENVIRONMENT_GET_GAME_INFO_EXT is guaranteed + * to return true if RETRO_ENVIRONMENT_SET_CONTENT_INFO_OVERRIDE + * returns true. + * + * 'data' points to an array of retro_game_info_ext structs. + * + * For struct member descriptions, see the definition of + * struct retro_game_info_ext. + * + * - If function is called inside retro_load_game(), + * the retro_game_info_ext array is guaranteed to + * have a size of 1 - i.e. the returned pointer may + * be used to access directly the members of the + * first retro_game_info_ext struct, for example: + * + * struct retro_game_info_ext *game_info_ext; + * if (environ_cb(RETRO_ENVIRONMENT_GET_GAME_INFO_EXT, &game_info_ext)) + * printf("Content Directory: %s\n", game_info_ext->dir); + * + * - If the function is called inside retro_load_game_special(), + * the retro_game_info_ext array is guaranteed to have a + * size equal to the num_info argument passed to + * retro_load_game_special() + */ + +/* VFS functionality */ + +/* File paths: + * File paths passed as parameters when using this API shall be well formed UNIX-style, + * using "/" (unquoted forward slash) as directory separator regardless of the platform's native separator. + * Paths shall also include at least one forward slash ("game.bin" is an invalid path, use "./game.bin" instead). + * Other than the directory separator, cores shall not make assumptions about path format: + * "C:/path/game.bin", "http://example.com/game.bin", "#game/game.bin", "./game.bin" (without quotes) are all valid paths. + * Cores may replace the basename or remove path components from the end, and/or add new components; + * however, cores shall not append "./", "../" or multiple consecutive forward slashes ("//") to paths they request to front end. + * The frontend is encouraged to make such paths work as well as it can, but is allowed to give up if the core alters paths too much. + * Frontends are encouraged, but not required, to support native file system paths (modulo replacing the directory separator, if applicable). + * Cores are allowed to try using them, but must remain functional if the front rejects such requests. + * Cores are encouraged to use the libretro-common filestream functions for file I/O, + * as they seamlessly integrate with VFS, deal with directory separator replacement as appropriate + * and provide platform-specific fallbacks in cases where front ends do not support VFS. */ + +/* Opaque file handle + * Introduced in VFS API v1 */ +struct retro_vfs_file_handle; + +/* Opaque directory handle + * Introduced in VFS API v3 */ +struct retro_vfs_dir_handle; + +/* File open flags + * Introduced in VFS API v1 */ +#define RETRO_VFS_FILE_ACCESS_READ (1 << 0) /* Read only mode */ +#define RETRO_VFS_FILE_ACCESS_WRITE (1 << 1) /* Write only mode, discard contents and overwrites existing file unless RETRO_VFS_FILE_ACCESS_UPDATE is also specified */ +#define RETRO_VFS_FILE_ACCESS_READ_WRITE (RETRO_VFS_FILE_ACCESS_READ | RETRO_VFS_FILE_ACCESS_WRITE) /* Read-write mode, discard contents and overwrites existing file unless RETRO_VFS_FILE_ACCESS_UPDATE is also specified*/ +#define RETRO_VFS_FILE_ACCESS_UPDATE_EXISTING (1 << 2) /* Prevents discarding content of existing files opened for writing */ + +/* These are only hints. The frontend may choose to ignore them. Other than RAM/CPU/etc use, + and how they react to unlikely external interference (for example someone else writing to that file, + or the file's server going down), behavior will not change. */ +#define RETRO_VFS_FILE_ACCESS_HINT_NONE (0) +/* Indicate that the file will be accessed many times. The frontend should aggressively cache everything. */ +#define RETRO_VFS_FILE_ACCESS_HINT_FREQUENT_ACCESS (1 << 0) + +/* Seek positions */ +#define RETRO_VFS_SEEK_POSITION_START 0 +#define RETRO_VFS_SEEK_POSITION_CURRENT 1 +#define RETRO_VFS_SEEK_POSITION_END 2 + +/* stat() result flags + * Introduced in VFS API v3 */ +#define RETRO_VFS_STAT_IS_VALID (1 << 0) +#define RETRO_VFS_STAT_IS_DIRECTORY (1 << 1) +#define RETRO_VFS_STAT_IS_CHARACTER_SPECIAL (1 << 2) + +/* Get path from opaque handle. Returns the exact same path passed to file_open when getting the handle + * Introduced in VFS API v1 */ +typedef const char *(RETRO_CALLCONV *retro_vfs_get_path_t)(struct retro_vfs_file_handle *stream); + +/* Open a file for reading or writing. If path points to a directory, this will + * fail. Returns the opaque file handle, or NULL for error. + * Introduced in VFS API v1 */ +typedef struct retro_vfs_file_handle *(RETRO_CALLCONV *retro_vfs_open_t)(const char *path, unsigned mode, unsigned hints); + +/* Close the file and release its resources. Must be called if open_file returns non-NULL. Returns 0 on success, -1 on failure. + * Whether the call succeeds ot not, the handle passed as parameter becomes invalid and should no longer be used. + * Introduced in VFS API v1 */ +typedef int (RETRO_CALLCONV *retro_vfs_close_t)(struct retro_vfs_file_handle *stream); + +/* Return the size of the file in bytes, or -1 for error. + * Introduced in VFS API v1 */ +typedef int64_t (RETRO_CALLCONV *retro_vfs_size_t)(struct retro_vfs_file_handle *stream); + +/* Truncate file to specified size. Returns 0 on success or -1 on error + * Introduced in VFS API v2 */ +typedef int64_t (RETRO_CALLCONV *retro_vfs_truncate_t)(struct retro_vfs_file_handle *stream, int64_t length); + +/* Get the current read / write position for the file. Returns -1 for error. + * Introduced in VFS API v1 */ +typedef int64_t (RETRO_CALLCONV *retro_vfs_tell_t)(struct retro_vfs_file_handle *stream); + +/* Set the current read/write position for the file. Returns the new position, -1 for error. + * Introduced in VFS API v1 */ +typedef int64_t (RETRO_CALLCONV *retro_vfs_seek_t)(struct retro_vfs_file_handle *stream, int64_t offset, int seek_position); + +/* Read data from a file. Returns the number of bytes read, or -1 for error. + * Introduced in VFS API v1 */ +typedef int64_t (RETRO_CALLCONV *retro_vfs_read_t)(struct retro_vfs_file_handle *stream, void *s, uint64_t len); + +/* Write data to a file. Returns the number of bytes written, or -1 for error. + * Introduced in VFS API v1 */ +typedef int64_t (RETRO_CALLCONV *retro_vfs_write_t)(struct retro_vfs_file_handle *stream, const void *s, uint64_t len); + +/* Flush pending writes to file, if using buffered IO. Returns 0 on sucess, or -1 on failure. + * Introduced in VFS API v1 */ +typedef int (RETRO_CALLCONV *retro_vfs_flush_t)(struct retro_vfs_file_handle *stream); + +/* Delete the specified file. Returns 0 on success, -1 on failure + * Introduced in VFS API v1 */ +typedef int (RETRO_CALLCONV *retro_vfs_remove_t)(const char *path); + +/* Rename the specified file. Returns 0 on success, -1 on failure + * Introduced in VFS API v1 */ +typedef int (RETRO_CALLCONV *retro_vfs_rename_t)(const char *old_path, const char *new_path); + +/* Stat the specified file. Retruns a bitmask of RETRO_VFS_STAT_* flags, none are set if path was not valid. + * Additionally stores file size in given variable, unless NULL is given. + * Introduced in VFS API v3 */ +typedef int (RETRO_CALLCONV *retro_vfs_stat_t)(const char *path, int32_t *size); + +/* Create the specified directory. Returns 0 on success, -1 on unknown failure, -2 if already exists. + * Introduced in VFS API v3 */ +typedef int (RETRO_CALLCONV *retro_vfs_mkdir_t)(const char *dir); + +/* Open the specified directory for listing. Returns the opaque dir handle, or NULL for error. + * Support for the include_hidden argument may vary depending on the platform. + * Introduced in VFS API v3 */ +typedef struct retro_vfs_dir_handle *(RETRO_CALLCONV *retro_vfs_opendir_t)(const char *dir, bool include_hidden); + +/* Read the directory entry at the current position, and move the read pointer to the next position. + * Returns true on success, false if already on the last entry. + * Introduced in VFS API v3 */ +typedef bool (RETRO_CALLCONV *retro_vfs_readdir_t)(struct retro_vfs_dir_handle *dirstream); + +/* Get the name of the last entry read. Returns a string on success, or NULL for error. + * The returned string pointer is valid until the next call to readdir or closedir. + * Introduced in VFS API v3 */ +typedef const char *(RETRO_CALLCONV *retro_vfs_dirent_get_name_t)(struct retro_vfs_dir_handle *dirstream); + +/* Check if the last entry read was a directory. Returns true if it was, false otherwise (or on error). + * Introduced in VFS API v3 */ +typedef bool (RETRO_CALLCONV *retro_vfs_dirent_is_dir_t)(struct retro_vfs_dir_handle *dirstream); + +/* Close the directory and release its resources. Must be called if opendir returns non-NULL. Returns 0 on success, -1 on failure. + * Whether the call succeeds ot not, the handle passed as parameter becomes invalid and should no longer be used. + * Introduced in VFS API v3 */ +typedef int (RETRO_CALLCONV *retro_vfs_closedir_t)(struct retro_vfs_dir_handle *dirstream); + +struct retro_vfs_interface +{ + /* VFS API v1 */ + retro_vfs_get_path_t get_path; + retro_vfs_open_t open; + retro_vfs_close_t close; + retro_vfs_size_t size; + retro_vfs_tell_t tell; + retro_vfs_seek_t seek; + retro_vfs_read_t read; + retro_vfs_write_t write; + retro_vfs_flush_t flush; + retro_vfs_remove_t remove; + retro_vfs_rename_t rename; + /* VFS API v2 */ + retro_vfs_truncate_t truncate; + /* VFS API v3 */ + retro_vfs_stat_t stat; + retro_vfs_mkdir_t mkdir; + retro_vfs_opendir_t opendir; + retro_vfs_readdir_t readdir; + retro_vfs_dirent_get_name_t dirent_get_name; + retro_vfs_dirent_is_dir_t dirent_is_dir; + retro_vfs_closedir_t closedir; +}; + +struct retro_vfs_interface_info +{ + /* Set by core: should this be higher than the version the front end supports, + * front end will return false in the RETRO_ENVIRONMENT_GET_VFS_INTERFACE call + * Introduced in VFS API v1 */ + uint32_t required_interface_version; + + /* Frontend writes interface pointer here. The frontend also sets the actual + * version, must be at least required_interface_version. + * Introduced in VFS API v1 */ + struct retro_vfs_interface *iface; +}; + +enum retro_hw_render_interface_type +{ + RETRO_HW_RENDER_INTERFACE_VULKAN = 0, + RETRO_HW_RENDER_INTERFACE_D3D9 = 1, + RETRO_HW_RENDER_INTERFACE_D3D10 = 2, + RETRO_HW_RENDER_INTERFACE_D3D11 = 3, + RETRO_HW_RENDER_INTERFACE_D3D12 = 4, + RETRO_HW_RENDER_INTERFACE_GSKIT_PS2 = 5, + RETRO_HW_RENDER_INTERFACE_DUMMY = INT_MAX +}; + +/* Base struct. All retro_hw_render_interface_* types + * contain at least these fields. */ +struct retro_hw_render_interface +{ + enum retro_hw_render_interface_type interface_type; + unsigned interface_version; +}; + +typedef void (RETRO_CALLCONV *retro_set_led_state_t)(int led, int state); +struct retro_led_interface +{ + retro_set_led_state_t set_led_state; +}; + +/* Retrieves the current state of the MIDI input. + * Returns true if it's enabled, false otherwise. */ +typedef bool (RETRO_CALLCONV *retro_midi_input_enabled_t)(void); + +/* Retrieves the current state of the MIDI output. + * Returns true if it's enabled, false otherwise */ +typedef bool (RETRO_CALLCONV *retro_midi_output_enabled_t)(void); + +/* Reads next byte from the input stream. + * Returns true if byte is read, false otherwise. */ +typedef bool (RETRO_CALLCONV *retro_midi_read_t)(uint8_t *byte); + +/* Writes byte to the output stream. + * 'delta_time' is in microseconds and represent time elapsed since previous write. + * Returns true if byte is written, false otherwise. */ +typedef bool (RETRO_CALLCONV *retro_midi_write_t)(uint8_t byte, uint32_t delta_time); + +/* Flushes previously written data. + * Returns true if successful, false otherwise. */ +typedef bool (RETRO_CALLCONV *retro_midi_flush_t)(void); + +struct retro_midi_interface +{ + retro_midi_input_enabled_t input_enabled; + retro_midi_output_enabled_t output_enabled; + retro_midi_read_t read; + retro_midi_write_t write; + retro_midi_flush_t flush; +}; + +enum retro_hw_render_context_negotiation_interface_type +{ + RETRO_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE_VULKAN = 0, + RETRO_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE_DUMMY = INT_MAX +}; + +/* Base struct. All retro_hw_render_context_negotiation_interface_* types + * contain at least these fields. */ +struct retro_hw_render_context_negotiation_interface +{ + enum retro_hw_render_context_negotiation_interface_type interface_type; + unsigned interface_version; +}; + +/* Serialized state is incomplete in some way. Set if serialization is + * usable in typical end-user cases but should not be relied upon to + * implement frame-sensitive frontend features such as netplay or + * rerecording. */ +#define RETRO_SERIALIZATION_QUIRK_INCOMPLETE (1 << 0) +/* The core must spend some time initializing before serialization is + * supported. retro_serialize() will initially fail; retro_unserialize() + * and retro_serialize_size() may or may not work correctly either. */ +#define RETRO_SERIALIZATION_QUIRK_MUST_INITIALIZE (1 << 1) +/* Serialization size may change within a session. */ +#define RETRO_SERIALIZATION_QUIRK_CORE_VARIABLE_SIZE (1 << 2) +/* Set by the frontend to acknowledge that it supports variable-sized + * states. */ +#define RETRO_SERIALIZATION_QUIRK_FRONT_VARIABLE_SIZE (1 << 3) +/* Serialized state can only be loaded during the same session. */ +#define RETRO_SERIALIZATION_QUIRK_SINGLE_SESSION (1 << 4) +/* Serialized state cannot be loaded on an architecture with a different + * endianness from the one it was saved on. */ +#define RETRO_SERIALIZATION_QUIRK_ENDIAN_DEPENDENT (1 << 5) +/* Serialized state cannot be loaded on a different platform from the one it + * was saved on for reasons other than endianness, such as word size + * dependence */ +#define RETRO_SERIALIZATION_QUIRK_PLATFORM_DEPENDENT (1 << 6) + +#define RETRO_MEMDESC_CONST (1 << 0) /* The frontend will never change this memory area once retro_load_game has returned. */ +#define RETRO_MEMDESC_BIGENDIAN (1 << 1) /* The memory area contains big endian data. Default is little endian. */ +#define RETRO_MEMDESC_SYSTEM_RAM (1 << 2) /* The memory area is system RAM. This is main RAM of the gaming system. */ +#define RETRO_MEMDESC_SAVE_RAM (1 << 3) /* The memory area is save RAM. This RAM is usually found on a game cartridge, backed up by a battery. */ +#define RETRO_MEMDESC_VIDEO_RAM (1 << 4) /* The memory area is video RAM (VRAM) */ +#define RETRO_MEMDESC_ALIGN_2 (1 << 16) /* All memory access in this area is aligned to their own size, or 2, whichever is smaller. */ +#define RETRO_MEMDESC_ALIGN_4 (2 << 16) +#define RETRO_MEMDESC_ALIGN_8 (3 << 16) +#define RETRO_MEMDESC_MINSIZE_2 (1 << 24) /* All memory in this region is accessed at least 2 bytes at the time. */ +#define RETRO_MEMDESC_MINSIZE_4 (2 << 24) +#define RETRO_MEMDESC_MINSIZE_8 (3 << 24) +struct retro_memory_descriptor +{ + uint64_t flags; + + /* Pointer to the start of the relevant ROM or RAM chip. + * It's strongly recommended to use 'offset' if possible, rather than + * doing math on the pointer. + * + * If the same byte is mapped my multiple descriptors, their descriptors + * must have the same pointer. + * If 'start' does not point to the first byte in the pointer, put the + * difference in 'offset' instead. + * + * May be NULL if there's nothing usable here (e.g. hardware registers and + * open bus). No flags should be set if the pointer is NULL. + * It's recommended to minimize the number of descriptors if possible, + * but not mandatory. */ + void *ptr; + size_t offset; + + /* This is the location in the emulated address space + * where the mapping starts. */ + size_t start; + + /* Which bits must be same as in 'start' for this mapping to apply. + * The first memory descriptor to claim a certain byte is the one + * that applies. + * A bit which is set in 'start' must also be set in this. + * Can be zero, in which case each byte is assumed mapped exactly once. + * In this case, 'len' must be a power of two. */ + size_t select; + + /* If this is nonzero, the set bits are assumed not connected to the + * memory chip's address pins. */ + size_t disconnect; + + /* This one tells the size of the current memory area. + * If, after start+disconnect are applied, the address is higher than + * this, the highest bit of the address is cleared. + * + * If the address is still too high, the next highest bit is cleared. + * Can be zero, in which case it's assumed to be infinite (as limited + * by 'select' and 'disconnect'). */ + size_t len; + + /* To go from emulated address to physical address, the following + * order applies: + * Subtract 'start', pick off 'disconnect', apply 'len', add 'offset'. */ + + /* The address space name must consist of only a-zA-Z0-9_-, + * should be as short as feasible (maximum length is 8 plus the NUL), + * and may not be any other address space plus one or more 0-9A-F + * at the end. + * However, multiple memory descriptors for the same address space is + * allowed, and the address space name can be empty. NULL is treated + * as empty. + * + * Address space names are case sensitive, but avoid lowercase if possible. + * The same pointer may exist in multiple address spaces. + * + * Examples: + * blank+blank - valid (multiple things may be mapped in the same namespace) + * 'Sp'+'Sp' - valid (multiple things may be mapped in the same namespace) + * 'A'+'B' - valid (neither is a prefix of each other) + * 'S'+blank - valid ('S' is not in 0-9A-F) + * 'a'+blank - valid ('a' is not in 0-9A-F) + * 'a'+'A' - valid (neither is a prefix of each other) + * 'AR'+blank - valid ('R' is not in 0-9A-F) + * 'ARB'+blank - valid (the B can't be part of the address either, because + * there is no namespace 'AR') + * blank+'B' - not valid, because it's ambigous which address space B1234 + * would refer to. + * The length can't be used for that purpose; the frontend may want + * to append arbitrary data to an address, without a separator. */ + const char *addrspace; + + /* TODO: When finalizing this one, add a description field, which should be + * "WRAM" or something roughly equally long. */ + + /* TODO: When finalizing this one, replace 'select' with 'limit', which tells + * which bits can vary and still refer to the same address (limit = ~select). + * TODO: limit? range? vary? something else? */ + + /* TODO: When finalizing this one, if 'len' is above what 'select' (or + * 'limit') allows, it's bankswitched. Bankswitched data must have both 'len' + * and 'select' != 0, and the mappings don't tell how the system switches the + * banks. */ + + /* TODO: When finalizing this one, fix the 'len' bit removal order. + * For len=0x1800, pointer 0x1C00 should go to 0x1400, not 0x0C00. + * Algorithm: Take bits highest to lowest, but if it goes above len, clear + * the most recent addition and continue on the next bit. + * TODO: Can the above be optimized? Is "remove the lowest bit set in both + * pointer and 'len'" equivalent? */ + + /* TODO: Some emulators (MAME?) emulate big endian systems by only accessing + * the emulated memory in 32-bit chunks, native endian. But that's nothing + * compared to Darek Mihocka <http://www.emulators.com/docs/nx07_vm101.htm> + * (section Emulation 103 - Nearly Free Byte Reversal) - he flips the ENTIRE + * RAM backwards! I'll want to represent both of those, via some flags. + * + * I suspect MAME either didn't think of that idea, or don't want the #ifdef. + * Not sure which, nor do I really care. */ + + /* TODO: Some of those flags are unused and/or don't really make sense. Clean + * them up. */ +}; + +/* The frontend may use the largest value of 'start'+'select' in a + * certain namespace to infer the size of the address space. + * + * If the address space is larger than that, a mapping with .ptr=NULL + * should be at the end of the array, with .select set to all ones for + * as long as the address space is big. + * + * Sample descriptors (minus .ptr, and RETRO_MEMFLAG_ on the flags): + * SNES WRAM: + * .start=0x7E0000, .len=0x20000 + * (Note that this must be mapped before the ROM in most cases; some of the + * ROM mappers + * try to claim $7E0000, or at least $7E8000.) + * SNES SPC700 RAM: + * .addrspace="S", .len=0x10000 + * SNES WRAM mirrors: + * .flags=MIRROR, .start=0x000000, .select=0xC0E000, .len=0x2000 + * .flags=MIRROR, .start=0x800000, .select=0xC0E000, .len=0x2000 + * SNES WRAM mirrors, alternate equivalent descriptor: + * .flags=MIRROR, .select=0x40E000, .disconnect=~0x1FFF + * (Various similar constructions can be created by combining parts of + * the above two.) + * SNES LoROM (512KB, mirrored a couple of times): + * .flags=CONST, .start=0x008000, .select=0x408000, .disconnect=0x8000, .len=512*1024 + * .flags=CONST, .start=0x400000, .select=0x400000, .disconnect=0x8000, .len=512*1024 + * SNES HiROM (4MB): + * .flags=CONST, .start=0x400000, .select=0x400000, .len=4*1024*1024 + * .flags=CONST, .offset=0x8000, .start=0x008000, .select=0x408000, .len=4*1024*1024 + * SNES ExHiROM (8MB): + * .flags=CONST, .offset=0, .start=0xC00000, .select=0xC00000, .len=4*1024*1024 + * .flags=CONST, .offset=4*1024*1024, .start=0x400000, .select=0xC00000, .len=4*1024*1024 + * .flags=CONST, .offset=0x8000, .start=0x808000, .select=0xC08000, .len=4*1024*1024 + * .flags=CONST, .offset=4*1024*1024+0x8000, .start=0x008000, .select=0xC08000, .len=4*1024*1024 + * Clarify the size of the address space: + * .ptr=NULL, .select=0xFFFFFF + * .len can be implied by .select in many of them, but was included for clarity. + */ + +struct retro_memory_map +{ + const struct retro_memory_descriptor *descriptors; + unsigned num_descriptors; +}; + +struct retro_controller_description +{ + /* Human-readable description of the controller. Even if using a generic + * input device type, this can be set to the particular device type the + * core uses. */ + const char *desc; + + /* Device type passed to retro_set_controller_port_device(). If the device + * type is a sub-class of a generic input device type, use the + * RETRO_DEVICE_SUBCLASS macro to create an ID. + * + * E.g. RETRO_DEVICE_SUBCLASS(RETRO_DEVICE_JOYPAD, 1). */ + unsigned id; +}; + +struct retro_controller_info +{ + const struct retro_controller_description *types; + unsigned num_types; +}; + +struct retro_subsystem_memory_info +{ + /* The extension associated with a memory type, e.g. "psram". */ + const char *extension; + + /* The memory type for retro_get_memory(). This should be at + * least 0x100 to avoid conflict with standardized + * libretro memory types. */ + unsigned type; +}; + +struct retro_subsystem_rom_info +{ + /* Describes what the content is (SGB BIOS, GB ROM, etc). */ + const char *desc; + + /* Same definition as retro_get_system_info(). */ + const char *valid_extensions; + + /* Same definition as retro_get_system_info(). */ + bool need_fullpath; + + /* Same definition as retro_get_system_info(). */ + bool block_extract; + + /* This is set if the content is required to load a game. + * If this is set to false, a zeroed-out retro_game_info can be passed. */ + bool required; + + /* Content can have multiple associated persistent + * memory types (retro_get_memory()). */ + const struct retro_subsystem_memory_info *memory; + unsigned num_memory; +}; + +struct retro_subsystem_info +{ + /* Human-readable string of the subsystem type, e.g. "Super GameBoy" */ + const char *desc; + + /* A computer friendly short string identifier for the subsystem type. + * This name must be [a-z]. + * E.g. if desc is "Super GameBoy", this can be "sgb". + * This identifier can be used for command-line interfaces, etc. + */ + const char *ident; + + /* Infos for each content file. The first entry is assumed to be the + * "most significant" content for frontend purposes. + * E.g. with Super GameBoy, the first content should be the GameBoy ROM, + * as it is the most "significant" content to a user. + * If a frontend creates new file paths based on the content used + * (e.g. savestates), it should use the path for the first ROM to do so. */ + const struct retro_subsystem_rom_info *roms; + + /* Number of content files associated with a subsystem. */ + unsigned num_roms; + + /* The type passed to retro_load_game_special(). */ + unsigned id; +}; + +typedef void (RETRO_CALLCONV *retro_proc_address_t)(void); + +/* libretro API extension functions: + * (None here so far). + * + * Get a symbol from a libretro core. + * Cores should only return symbols which are actual + * extensions to the libretro API. + * + * Frontends should not use this to obtain symbols to standard + * libretro entry points (static linking or dlsym). + * + * The symbol name must be equal to the function name, + * e.g. if void retro_foo(void); exists, the symbol must be called "retro_foo". + * The returned function pointer must be cast to the corresponding type. + */ +typedef retro_proc_address_t (RETRO_CALLCONV *retro_get_proc_address_t)(const char *sym); + +struct retro_get_proc_address_interface +{ + retro_get_proc_address_t get_proc_address; +}; + +enum retro_log_level +{ + RETRO_LOG_DEBUG = 0, + RETRO_LOG_INFO, + RETRO_LOG_WARN, + RETRO_LOG_ERROR, + + RETRO_LOG_DUMMY = INT_MAX +}; + +/* Logging function. Takes log level argument as well. */ +typedef void (RETRO_CALLCONV *retro_log_printf_t)(enum retro_log_level level, + const char *fmt, ...); + +struct retro_log_callback +{ + retro_log_printf_t log; +}; + +/* Performance related functions */ + +/* ID values for SIMD CPU features */ +#define RETRO_SIMD_SSE (1 << 0) +#define RETRO_SIMD_SSE2 (1 << 1) +#define RETRO_SIMD_VMX (1 << 2) +#define RETRO_SIMD_VMX128 (1 << 3) +#define RETRO_SIMD_AVX (1 << 4) +#define RETRO_SIMD_NEON (1 << 5) +#define RETRO_SIMD_SSE3 (1 << 6) +#define RETRO_SIMD_SSSE3 (1 << 7) +#define RETRO_SIMD_MMX (1 << 8) +#define RETRO_SIMD_MMXEXT (1 << 9) +#define RETRO_SIMD_SSE4 (1 << 10) +#define RETRO_SIMD_SSE42 (1 << 11) +#define RETRO_SIMD_AVX2 (1 << 12) +#define RETRO_SIMD_VFPU (1 << 13) +#define RETRO_SIMD_PS (1 << 14) +#define RETRO_SIMD_AES (1 << 15) +#define RETRO_SIMD_VFPV3 (1 << 16) +#define RETRO_SIMD_VFPV4 (1 << 17) +#define RETRO_SIMD_POPCNT (1 << 18) +#define RETRO_SIMD_MOVBE (1 << 19) +#define RETRO_SIMD_CMOV (1 << 20) +#define RETRO_SIMD_ASIMD (1 << 21) + +typedef uint64_t retro_perf_tick_t; +typedef int64_t retro_time_t; + +struct retro_perf_counter +{ + const char *ident; + retro_perf_tick_t start; + retro_perf_tick_t total; + retro_perf_tick_t call_cnt; + + bool registered; +}; + +/* Returns current time in microseconds. + * Tries to use the most accurate timer available. + */ +typedef retro_time_t (RETRO_CALLCONV *retro_perf_get_time_usec_t)(void); + +/* A simple counter. Usually nanoseconds, but can also be CPU cycles. + * Can be used directly if desired (when creating a more sophisticated + * performance counter system). + * */ +typedef retro_perf_tick_t (RETRO_CALLCONV *retro_perf_get_counter_t)(void); + +/* Returns a bit-mask of detected CPU features (RETRO_SIMD_*). */ +typedef uint64_t (RETRO_CALLCONV *retro_get_cpu_features_t)(void); + +/* Asks frontend to log and/or display the state of performance counters. + * Performance counters can always be poked into manually as well. + */ +typedef void (RETRO_CALLCONV *retro_perf_log_t)(void); + +/* Register a performance counter. + * ident field must be set with a discrete value and other values in + * retro_perf_counter must be 0. + * Registering can be called multiple times. To avoid calling to + * frontend redundantly, you can check registered field first. */ +typedef void (RETRO_CALLCONV *retro_perf_register_t)(struct retro_perf_counter *counter); + +/* Starts a registered counter. */ +typedef void (RETRO_CALLCONV *retro_perf_start_t)(struct retro_perf_counter *counter); + +/* Stops a registered counter. */ +typedef void (RETRO_CALLCONV *retro_perf_stop_t)(struct retro_perf_counter *counter); + +/* For convenience it can be useful to wrap register, start and stop in macros. + * E.g.: + * #ifdef LOG_PERFORMANCE + * #define RETRO_PERFORMANCE_INIT(perf_cb, name) static struct retro_perf_counter name = {#name}; if (!name.registered) perf_cb.perf_register(&(name)) + * #define RETRO_PERFORMANCE_START(perf_cb, name) perf_cb.perf_start(&(name)) + * #define RETRO_PERFORMANCE_STOP(perf_cb, name) perf_cb.perf_stop(&(name)) + * #else + * ... Blank macros ... + * #endif + * + * These can then be used mid-functions around code snippets. + * + * extern struct retro_perf_callback perf_cb; * Somewhere in the core. + * + * void do_some_heavy_work(void) + * { + * RETRO_PERFORMANCE_INIT(cb, work_1; + * RETRO_PERFORMANCE_START(cb, work_1); + * heavy_work_1(); + * RETRO_PERFORMANCE_STOP(cb, work_1); + * + * RETRO_PERFORMANCE_INIT(cb, work_2); + * RETRO_PERFORMANCE_START(cb, work_2); + * heavy_work_2(); + * RETRO_PERFORMANCE_STOP(cb, work_2); + * } + * + * void retro_deinit(void) + * { + * perf_cb.perf_log(); * Log all perf counters here for example. + * } + */ + +struct retro_perf_callback +{ + retro_perf_get_time_usec_t get_time_usec; + retro_get_cpu_features_t get_cpu_features; + + retro_perf_get_counter_t get_perf_counter; + retro_perf_register_t perf_register; + retro_perf_start_t perf_start; + retro_perf_stop_t perf_stop; + retro_perf_log_t perf_log; +}; + +/* FIXME: Document the sensor API and work out behavior. + * It will be marked as experimental until then. + */ +enum retro_sensor_action +{ + RETRO_SENSOR_ACCELEROMETER_ENABLE = 0, + RETRO_SENSOR_ACCELEROMETER_DISABLE, + RETRO_SENSOR_GYROSCOPE_ENABLE, + RETRO_SENSOR_GYROSCOPE_DISABLE, + RETRO_SENSOR_ILLUMINANCE_ENABLE, + RETRO_SENSOR_ILLUMINANCE_DISABLE, + + RETRO_SENSOR_DUMMY = INT_MAX +}; + +/* Id values for SENSOR types. */ +#define RETRO_SENSOR_ACCELEROMETER_X 0 +#define RETRO_SENSOR_ACCELEROMETER_Y 1 +#define RETRO_SENSOR_ACCELEROMETER_Z 2 +#define RETRO_SENSOR_GYROSCOPE_X 3 +#define RETRO_SENSOR_GYROSCOPE_Y 4 +#define RETRO_SENSOR_GYROSCOPE_Z 5 +#define RETRO_SENSOR_ILLUMINANCE 6 + +typedef bool (RETRO_CALLCONV *retro_set_sensor_state_t)(unsigned port, + enum retro_sensor_action action, unsigned rate); + +typedef float (RETRO_CALLCONV *retro_sensor_get_input_t)(unsigned port, unsigned id); + +struct retro_sensor_interface +{ + retro_set_sensor_state_t set_sensor_state; + retro_sensor_get_input_t get_sensor_input; +}; + +enum retro_camera_buffer +{ + RETRO_CAMERA_BUFFER_OPENGL_TEXTURE = 0, + RETRO_CAMERA_BUFFER_RAW_FRAMEBUFFER, + + RETRO_CAMERA_BUFFER_DUMMY = INT_MAX +}; + +/* Starts the camera driver. Can only be called in retro_run(). */ +typedef bool (RETRO_CALLCONV *retro_camera_start_t)(void); + +/* Stops the camera driver. Can only be called in retro_run(). */ +typedef void (RETRO_CALLCONV *retro_camera_stop_t)(void); + +/* Callback which signals when the camera driver is initialized + * and/or deinitialized. + * retro_camera_start_t can be called in initialized callback. + */ +typedef void (RETRO_CALLCONV *retro_camera_lifetime_status_t)(void); + +/* A callback for raw framebuffer data. buffer points to an XRGB8888 buffer. + * Width, height and pitch are similar to retro_video_refresh_t. + * First pixel is top-left origin. + */ +typedef void (RETRO_CALLCONV *retro_camera_frame_raw_framebuffer_t)(const uint32_t *buffer, + unsigned width, unsigned height, size_t pitch); + +/* A callback for when OpenGL textures are used. + * + * texture_id is a texture owned by camera driver. + * Its state or content should be considered immutable, except for things like + * texture filtering and clamping. + * + * texture_target is the texture target for the GL texture. + * These can include e.g. GL_TEXTURE_2D, GL_TEXTURE_RECTANGLE, and possibly + * more depending on extensions. + * + * affine points to a packed 3x3 column-major matrix used to apply an affine + * transform to texture coordinates. (affine_matrix * vec3(coord_x, coord_y, 1.0)) + * After transform, normalized texture coord (0, 0) should be bottom-left + * and (1, 1) should be top-right (or (width, height) for RECTANGLE). + * + * GL-specific typedefs are avoided here to avoid relying on gl.h in + * the API definition. + */ +typedef void (RETRO_CALLCONV *retro_camera_frame_opengl_texture_t)(unsigned texture_id, + unsigned texture_target, const float *affine); + +struct retro_camera_callback +{ + /* Set by libretro core. + * Example bitmask: caps = (1 << RETRO_CAMERA_BUFFER_OPENGL_TEXTURE) | (1 << RETRO_CAMERA_BUFFER_RAW_FRAMEBUFFER). + */ + uint64_t caps; + + /* Desired resolution for camera. Is only used as a hint. */ + unsigned width; + unsigned height; + + /* Set by frontend. */ + retro_camera_start_t start; + retro_camera_stop_t stop; + + /* Set by libretro core if raw framebuffer callbacks will be used. */ + retro_camera_frame_raw_framebuffer_t frame_raw_framebuffer; + + /* Set by libretro core if OpenGL texture callbacks will be used. */ + retro_camera_frame_opengl_texture_t frame_opengl_texture; + + /* Set by libretro core. Called after camera driver is initialized and + * ready to be started. + * Can be NULL, in which this callback is not called. + */ + retro_camera_lifetime_status_t initialized; + + /* Set by libretro core. Called right before camera driver is + * deinitialized. + * Can be NULL, in which this callback is not called. + */ + retro_camera_lifetime_status_t deinitialized; +}; + +/* Sets the interval of time and/or distance at which to update/poll + * location-based data. + * + * To ensure compatibility with all location-based implementations, + * values for both interval_ms and interval_distance should be provided. + * + * interval_ms is the interval expressed in milliseconds. + * interval_distance is the distance interval expressed in meters. + */ +typedef void (RETRO_CALLCONV *retro_location_set_interval_t)(unsigned interval_ms, + unsigned interval_distance); + +/* Start location services. The device will start listening for changes to the + * current location at regular intervals (which are defined with + * retro_location_set_interval_t). */ +typedef bool (RETRO_CALLCONV *retro_location_start_t)(void); + +/* Stop location services. The device will stop listening for changes + * to the current location. */ +typedef void (RETRO_CALLCONV *retro_location_stop_t)(void); + +/* Get the position of the current location. Will set parameters to + * 0 if no new location update has happened since the last time. */ +typedef bool (RETRO_CALLCONV *retro_location_get_position_t)(double *lat, double *lon, + double *horiz_accuracy, double *vert_accuracy); + +/* Callback which signals when the location driver is initialized + * and/or deinitialized. + * retro_location_start_t can be called in initialized callback. + */ +typedef void (RETRO_CALLCONV *retro_location_lifetime_status_t)(void); + +struct retro_location_callback +{ + retro_location_start_t start; + retro_location_stop_t stop; + retro_location_get_position_t get_position; + retro_location_set_interval_t set_interval; + + retro_location_lifetime_status_t initialized; + retro_location_lifetime_status_t deinitialized; +}; + +enum retro_rumble_effect +{ + RETRO_RUMBLE_STRONG = 0, + RETRO_RUMBLE_WEAK = 1, + + RETRO_RUMBLE_DUMMY = INT_MAX +}; + +/* Sets rumble state for joypad plugged in port 'port'. + * Rumble effects are controlled independently, + * and setting e.g. strong rumble does not override weak rumble. + * Strength has a range of [0, 0xffff]. + * + * Returns true if rumble state request was honored. + * Calling this before first retro_run() is likely to return false. */ +typedef bool (RETRO_CALLCONV *retro_set_rumble_state_t)(unsigned port, + enum retro_rumble_effect effect, uint16_t strength); + +struct retro_rumble_interface +{ + retro_set_rumble_state_t set_rumble_state; +}; + +/* Notifies libretro that audio data should be written. */ +typedef void (RETRO_CALLCONV *retro_audio_callback_t)(void); + +/* True: Audio driver in frontend is active, and callback is + * expected to be called regularily. + * False: Audio driver in frontend is paused or inactive. + * Audio callback will not be called until set_state has been + * called with true. + * Initial state is false (inactive). + */ +typedef void (RETRO_CALLCONV *retro_audio_set_state_callback_t)(bool enabled); + +struct retro_audio_callback +{ + retro_audio_callback_t callback; + retro_audio_set_state_callback_t set_state; +}; + +/* Notifies a libretro core of time spent since last invocation + * of retro_run() in microseconds. + * + * It will be called right before retro_run() every frame. + * The frontend can tamper with timing to support cases like + * fast-forward, slow-motion and framestepping. + * + * In those scenarios the reference frame time value will be used. */ +typedef int64_t retro_usec_t; +typedef void (RETRO_CALLCONV *retro_frame_time_callback_t)(retro_usec_t usec); +struct retro_frame_time_callback +{ + retro_frame_time_callback_t callback; + /* Represents the time of one frame. It is computed as + * 1000000 / fps, but the implementation will resolve the + * rounding to ensure that framestepping, etc is exact. */ + retro_usec_t reference; +}; + +/* Notifies a libretro core of the current occupancy + * level of the frontend audio buffer. + * + * - active: 'true' if audio buffer is currently + * in use. Will be 'false' if audio is + * disabled in the frontend + * + * - occupancy: Given as a value in the range [0,100], + * corresponding to the occupancy percentage + * of the audio buffer + * + * - underrun_likely: 'true' if the frontend expects an + * audio buffer underrun during the + * next frame (indicates that a core + * should attempt frame skipping) + * + * It will be called right before retro_run() every frame. */ +typedef void (RETRO_CALLCONV *retro_audio_buffer_status_callback_t)( + bool active, unsigned occupancy, bool underrun_likely); +struct retro_audio_buffer_status_callback +{ + retro_audio_buffer_status_callback_t callback; +}; + +/* Pass this to retro_video_refresh_t if rendering to hardware. + * Passing NULL to retro_video_refresh_t is still a frame dupe as normal. + * */ +#define RETRO_HW_FRAME_BUFFER_VALID ((void*)-1) + +/* Invalidates the current HW context. + * Any GL state is lost, and must not be deinitialized explicitly. + * If explicit deinitialization is desired by the libretro core, + * it should implement context_destroy callback. + * If called, all GPU resources must be reinitialized. + * Usually called when frontend reinits video driver. + * Also called first time video driver is initialized, + * allowing libretro core to initialize resources. + */ +typedef void (RETRO_CALLCONV *retro_hw_context_reset_t)(void); + +/* Gets current framebuffer which is to be rendered to. + * Could change every frame potentially. + */ +typedef uintptr_t (RETRO_CALLCONV *retro_hw_get_current_framebuffer_t)(void); + +/* Get a symbol from HW context. */ +typedef retro_proc_address_t (RETRO_CALLCONV *retro_hw_get_proc_address_t)(const char *sym); + +enum retro_hw_context_type +{ + RETRO_HW_CONTEXT_NONE = 0, + /* OpenGL 2.x. Driver can choose to use latest compatibility context. */ + RETRO_HW_CONTEXT_OPENGL = 1, + /* OpenGL ES 2.0. */ + RETRO_HW_CONTEXT_OPENGLES2 = 2, + /* Modern desktop core GL context. Use version_major/ + * version_minor fields to set GL version. */ + RETRO_HW_CONTEXT_OPENGL_CORE = 3, + /* OpenGL ES 3.0 */ + RETRO_HW_CONTEXT_OPENGLES3 = 4, + /* OpenGL ES 3.1+. Set version_major/version_minor. For GLES2 and GLES3, + * use the corresponding enums directly. */ + RETRO_HW_CONTEXT_OPENGLES_VERSION = 5, + + /* Vulkan, see RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE. */ + RETRO_HW_CONTEXT_VULKAN = 6, + + /* Direct3D, set version_major to select the type of interface + * returned by RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE */ + RETRO_HW_CONTEXT_DIRECT3D = 7, + + RETRO_HW_CONTEXT_DUMMY = INT_MAX +}; + +struct retro_hw_render_callback +{ + /* Which API to use. Set by libretro core. */ + enum retro_hw_context_type context_type; + + /* Called when a context has been created or when it has been reset. + * An OpenGL context is only valid after context_reset() has been called. + * + * When context_reset is called, OpenGL resources in the libretro + * implementation are guaranteed to be invalid. + * + * It is possible that context_reset is called multiple times during an + * application lifecycle. + * If context_reset is called without any notification (context_destroy), + * the OpenGL context was lost and resources should just be recreated + * without any attempt to "free" old resources. + */ + retro_hw_context_reset_t context_reset; + + /* Set by frontend. + * TODO: This is rather obsolete. The frontend should not + * be providing preallocated framebuffers. */ + retro_hw_get_current_framebuffer_t get_current_framebuffer; + + /* Set by frontend. + * Can return all relevant functions, including glClear on Windows. */ + retro_hw_get_proc_address_t get_proc_address; + + /* Set if render buffers should have depth component attached. + * TODO: Obsolete. */ + bool depth; + + /* Set if stencil buffers should be attached. + * TODO: Obsolete. */ + bool stencil; + + /* If depth and stencil are true, a packed 24/8 buffer will be added. + * Only attaching stencil is invalid and will be ignored. */ + + /* Use conventional bottom-left origin convention. If false, + * standard libretro top-left origin semantics are used. + * TODO: Move to GL specific interface. */ + bool bottom_left_origin; + + /* Major version number for core GL context or GLES 3.1+. */ + unsigned version_major; + + /* Minor version number for core GL context or GLES 3.1+. */ + unsigned version_minor; + + /* If this is true, the frontend will go very far to avoid + * resetting context in scenarios like toggling fullscreen, etc. + * TODO: Obsolete? Maybe frontend should just always assume this ... + */ + bool cache_context; + + /* The reset callback might still be called in extreme situations + * such as if the context is lost beyond recovery. + * + * For optimal stability, set this to false, and allow context to be + * reset at any time. + */ + + /* A callback to be called before the context is destroyed in a + * controlled way by the frontend. */ + retro_hw_context_reset_t context_destroy; + + /* OpenGL resources can be deinitialized cleanly at this step. + * context_destroy can be set to NULL, in which resources will + * just be destroyed without any notification. + * + * Even when context_destroy is non-NULL, it is possible that + * context_reset is called without any destroy notification. + * This happens if context is lost by external factors (such as + * notified by GL_ARB_robustness). + * + * In this case, the context is assumed to be already dead, + * and the libretro implementation must not try to free any OpenGL + * resources in the subsequent context_reset. + */ + + /* Creates a debug context. */ + bool debug_context; +}; + +/* Callback type passed in RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK. + * Called by the frontend in response to keyboard events. + * down is set if the key is being pressed, or false if it is being released. + * keycode is the RETROK value of the char. + * character is the text character of the pressed key. (UTF-32). + * key_modifiers is a set of RETROKMOD values or'ed together. + * + * The pressed/keycode state can be indepedent of the character. + * It is also possible that multiple characters are generated from a + * single keypress. + * Keycode events should be treated separately from character events. + * However, when possible, the frontend should try to synchronize these. + * If only a character is posted, keycode should be RETROK_UNKNOWN. + * + * Similarily if only a keycode event is generated with no corresponding + * character, character should be 0. + */ +typedef void (RETRO_CALLCONV *retro_keyboard_event_t)(bool down, unsigned keycode, + uint32_t character, uint16_t key_modifiers); + +struct retro_keyboard_callback +{ + retro_keyboard_event_t callback; +}; + +/* Callbacks for RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE & + * RETRO_ENVIRONMENT_SET_DISK_CONTROL_EXT_INTERFACE. + * Should be set for implementations which can swap out multiple disk + * images in runtime. + * + * If the implementation can do this automatically, it should strive to do so. + * However, there are cases where the user must manually do so. + * + * Overview: To swap a disk image, eject the disk image with + * set_eject_state(true). + * Set the disk index with set_image_index(index). Insert the disk again + * with set_eject_state(false). + */ + +/* If ejected is true, "ejects" the virtual disk tray. + * When ejected, the disk image index can be set. + */ +typedef bool (RETRO_CALLCONV *retro_set_eject_state_t)(bool ejected); + +/* Gets current eject state. The initial state is 'not ejected'. */ +typedef bool (RETRO_CALLCONV *retro_get_eject_state_t)(void); + +/* Gets current disk index. First disk is index 0. + * If return value is >= get_num_images(), no disk is currently inserted. + */ +typedef unsigned (RETRO_CALLCONV *retro_get_image_index_t)(void); + +/* Sets image index. Can only be called when disk is ejected. + * The implementation supports setting "no disk" by using an + * index >= get_num_images(). + */ +typedef bool (RETRO_CALLCONV *retro_set_image_index_t)(unsigned index); + +/* Gets total number of images which are available to use. */ +typedef unsigned (RETRO_CALLCONV *retro_get_num_images_t)(void); + +struct retro_game_info; + +/* Replaces the disk image associated with index. + * Arguments to pass in info have same requirements as retro_load_game(). + * Virtual disk tray must be ejected when calling this. + * + * Replacing a disk image with info = NULL will remove the disk image + * from the internal list. + * As a result, calls to get_image_index() can change. + * + * E.g. replace_image_index(1, NULL), and previous get_image_index() + * returned 4 before. + * Index 1 will be removed, and the new index is 3. + */ +typedef bool (RETRO_CALLCONV *retro_replace_image_index_t)(unsigned index, + const struct retro_game_info *info); + +/* Adds a new valid index (get_num_images()) to the internal disk list. + * This will increment subsequent return values from get_num_images() by 1. + * This image index cannot be used until a disk image has been set + * with replace_image_index. */ +typedef bool (RETRO_CALLCONV *retro_add_image_index_t)(void); + +/* Sets initial image to insert in drive when calling + * core_load_game(). + * Since we cannot pass the initial index when loading + * content (this would require a major API change), this + * is set by the frontend *before* calling the core's + * retro_load_game()/retro_load_game_special() implementation. + * A core should therefore cache the index/path values and handle + * them inside retro_load_game()/retro_load_game_special(). + * - If 'index' is invalid (index >= get_num_images()), the + * core should ignore the set value and instead use 0 + * - 'path' is used purely for error checking - i.e. when + * content is loaded, the core should verify that the + * disk specified by 'index' has the specified file path. + * This is to guard against auto selecting the wrong image + * if (for example) the user should modify an existing M3U + * playlist. We have to let the core handle this because + * set_initial_image() must be called before loading content, + * i.e. the frontend cannot access image paths in advance + * and thus cannot perform the error check itself. + * If set path and content path do not match, the core should + * ignore the set 'index' value and instead use 0 + * Returns 'false' if index or 'path' are invalid, or core + * does not support this functionality + */ +typedef bool (RETRO_CALLCONV *retro_set_initial_image_t)(unsigned index, const char *path); + +/* Fetches the path of the specified disk image file. + * Returns 'false' if index is invalid (index >= get_num_images()) + * or path is otherwise unavailable. + */ +typedef bool (RETRO_CALLCONV *retro_get_image_path_t)(unsigned index, char *path, size_t len); + +/* Fetches a core-provided 'label' for the specified disk + * image file. In the simplest case this may be a file name + * (without extension), but for cores with more complex + * content requirements information may be provided to + * facilitate user disk swapping - for example, a core + * running floppy-disk-based content may uniquely label + * save disks, data disks, level disks, etc. with names + * corresponding to in-game disk change prompts (so the + * frontend can provide better user guidance than a 'dumb' + * disk index value). + * Returns 'false' if index is invalid (index >= get_num_images()) + * or label is otherwise unavailable. + */ +typedef bool (RETRO_CALLCONV *retro_get_image_label_t)(unsigned index, char *label, size_t len); + +struct retro_disk_control_callback +{ + retro_set_eject_state_t set_eject_state; + retro_get_eject_state_t get_eject_state; + + retro_get_image_index_t get_image_index; + retro_set_image_index_t set_image_index; + retro_get_num_images_t get_num_images; + + retro_replace_image_index_t replace_image_index; + retro_add_image_index_t add_image_index; +}; + +struct retro_disk_control_ext_callback +{ + retro_set_eject_state_t set_eject_state; + retro_get_eject_state_t get_eject_state; + + retro_get_image_index_t get_image_index; + retro_set_image_index_t set_image_index; + retro_get_num_images_t get_num_images; + + retro_replace_image_index_t replace_image_index; + retro_add_image_index_t add_image_index; + + /* NOTE: Frontend will only attempt to record/restore + * last used disk index if both set_initial_image() + * and get_image_path() are implemented */ + retro_set_initial_image_t set_initial_image; /* Optional - may be NULL */ + + retro_get_image_path_t get_image_path; /* Optional - may be NULL */ + retro_get_image_label_t get_image_label; /* Optional - may be NULL */ +}; + +enum retro_pixel_format +{ + /* 0RGB1555, native endian. + * 0 bit must be set to 0. + * This pixel format is default for compatibility concerns only. + * If a 15/16-bit pixel format is desired, consider using RGB565. */ + RETRO_PIXEL_FORMAT_0RGB1555 = 0, + + /* XRGB8888, native endian. + * X bits are ignored. */ + RETRO_PIXEL_FORMAT_XRGB8888 = 1, + + /* RGB565, native endian. + * This pixel format is the recommended format to use if a 15/16-bit + * format is desired as it is the pixel format that is typically + * available on a wide range of low-power devices. + * + * It is also natively supported in APIs like OpenGL ES. */ + RETRO_PIXEL_FORMAT_RGB565 = 2, + + /* Ensure sizeof() == sizeof(int). */ + RETRO_PIXEL_FORMAT_UNKNOWN = INT_MAX +}; + +struct retro_message +{ + const char *msg; /* Message to be displayed. */ + unsigned frames; /* Duration in frames of message. */ +}; + +enum retro_message_target +{ + RETRO_MESSAGE_TARGET_ALL = 0, + RETRO_MESSAGE_TARGET_OSD, + RETRO_MESSAGE_TARGET_LOG +}; + +enum retro_message_type +{ + RETRO_MESSAGE_TYPE_NOTIFICATION = 0, + RETRO_MESSAGE_TYPE_NOTIFICATION_ALT, + RETRO_MESSAGE_TYPE_STATUS, + RETRO_MESSAGE_TYPE_PROGRESS +}; + +struct retro_message_ext +{ + /* Message string to be displayed/logged */ + const char *msg; + /* Duration (in ms) of message when targeting the OSD */ + unsigned duration; + /* Message priority when targeting the OSD + * > When multiple concurrent messages are sent to + * the frontend and the frontend does not have the + * capacity to display them all, messages with the + * *highest* priority value should be shown + * > There is no upper limit to a message priority + * value (within the bounds of the unsigned data type) + * > In the reference frontend (RetroArch), the same + * priority values are used for frontend-generated + * notifications, which are typically assigned values + * between 0 and 3 depending upon importance */ + unsigned priority; + /* Message logging level (info, warn, error, etc.) */ + enum retro_log_level level; + /* Message destination: OSD, logging interface or both */ + enum retro_message_target target; + /* Message 'type' when targeting the OSD + * > RETRO_MESSAGE_TYPE_NOTIFICATION: Specifies that a + * message should be handled in identical fashion to + * a standard frontend-generated notification + * > RETRO_MESSAGE_TYPE_NOTIFICATION_ALT: Specifies that + * message is a notification that requires user attention + * or action, but that it should be displayed in a manner + * that differs from standard frontend-generated notifications. + * This would typically correspond to messages that should be + * displayed immediately (independently from any internal + * frontend message queue), and/or which should be visually + * distinguishable from frontend-generated notifications. + * For example, a core may wish to inform the user of + * information related to a disk-change event. It is + * expected that the frontend itself may provide a + * notification in this case; if the core sends a + * message of type RETRO_MESSAGE_TYPE_NOTIFICATION, an + * uncomfortable 'double-notification' may occur. A message + * of RETRO_MESSAGE_TYPE_NOTIFICATION_ALT should therefore + * be presented such that visual conflict with regular + * notifications does not occur + * > RETRO_MESSAGE_TYPE_STATUS: Indicates that message + * is not a standard notification. This typically + * corresponds to 'status' indicators, such as a core's + * internal FPS, which are intended to be displayed + * either permanently while a core is running, or in + * a manner that does not suggest user attention or action + * is required. 'Status' type messages should therefore be + * displayed in a different on-screen location and in a manner + * easily distinguishable from both standard frontend-generated + * notifications and messages of type RETRO_MESSAGE_TYPE_NOTIFICATION_ALT + * > RETRO_MESSAGE_TYPE_PROGRESS: Indicates that message reports + * the progress of an internal core task. For example, in cases + * where a core itself handles the loading of content from a file, + * this may correspond to the percentage of the file that has been + * read. Alternatively, an audio/video playback core may use a + * message of type RETRO_MESSAGE_TYPE_PROGRESS to display the current + * playback position as a percentage of the runtime. 'Progress' type + * messages should therefore be displayed as a literal progress bar, + * where: + * - 'retro_message_ext.msg' is the progress bar title/label + * - 'retro_message_ext.progress' determines the length of + * the progress bar + * NOTE: Message type is a *hint*, and may be ignored + * by the frontend. If a frontend lacks support for + * displaying messages via alternate means than standard + * frontend-generated notifications, it will treat *all* + * messages as having the type RETRO_MESSAGE_TYPE_NOTIFICATION */ + enum retro_message_type type; + /* Task progress when targeting the OSD and message is + * of type RETRO_MESSAGE_TYPE_PROGRESS + * > -1: Unmetered/indeterminate + * > 0-100: Current progress percentage + * NOTE: Since message type is a hint, a frontend may ignore + * progress values. Where relevant, a core should therefore + * include progress percentage within the message string, + * such that the message intent remains clear when displayed + * as a standard frontend-generated notification */ + int8_t progress; +}; + +/* Describes how the libretro implementation maps a libretro input bind + * to its internal input system through a human readable string. + * This string can be used to better let a user configure input. */ +struct retro_input_descriptor +{ + /* Associates given parameters with a description. */ + unsigned port; + unsigned device; + unsigned index; + unsigned id; + + /* Human readable description for parameters. + * The pointer must remain valid until + * retro_unload_game() is called. */ + const char *description; +}; + +struct retro_system_info +{ + /* All pointers are owned by libretro implementation, and pointers must + * remain valid until it is unloaded. */ + + const char *library_name; /* Descriptive name of library. Should not + * contain any version numbers, etc. */ + const char *library_version; /* Descriptive version of core. */ + + const char *valid_extensions; /* A string listing probably content + * extensions the core will be able to + * load, separated with pipe. + * I.e. "bin|rom|iso". + * Typically used for a GUI to filter + * out extensions. */ + + /* Libretro cores that need to have direct access to their content + * files, including cores which use the path of the content files to + * determine the paths of other files, should set need_fullpath to true. + * + * Cores should strive for setting need_fullpath to false, + * as it allows the frontend to perform patching, etc. + * + * If need_fullpath is true and retro_load_game() is called: + * - retro_game_info::path is guaranteed to have a valid path + * - retro_game_info::data and retro_game_info::size are invalid + * + * If need_fullpath is false and retro_load_game() is called: + * - retro_game_info::path may be NULL + * - retro_game_info::data and retro_game_info::size are guaranteed + * to be valid + * + * See also: + * - RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY + * - RETRO_ENVIRONMENT_GET_SAVE_DIRECTORY + */ + bool need_fullpath; + + /* If true, the frontend is not allowed to extract any archives before + * loading the real content. + * Necessary for certain libretro implementations that load games + * from zipped archives. */ + bool block_extract; +}; + +/* Defines overrides which modify frontend handling of + * specific content file types. + * An array of retro_system_content_info_override is + * passed to RETRO_ENVIRONMENT_SET_CONTENT_INFO_OVERRIDE + * NOTE: In the following descriptions, references to + * retro_load_game() may be replaced with + * retro_load_game_special() */ +struct retro_system_content_info_override +{ + /* A list of file extensions for which the override + * should apply, delimited by a 'pipe' character + * (e.g. "md|sms|gg") + * Permitted file extensions are limited to those + * included in retro_system_info::valid_extensions + * and/or retro_subsystem_rom_info::valid_extensions */ + const char *extensions; + + /* Overrides the need_fullpath value set in + * retro_system_info and/or retro_subsystem_rom_info. + * To reiterate: + * + * If need_fullpath is true and retro_load_game() is called: + * - retro_game_info::path is guaranteed to contain a valid + * path to an existent file + * - retro_game_info::data and retro_game_info::size are invalid + * + * If need_fullpath is false and retro_load_game() is called: + * - retro_game_info::path may be NULL + * - retro_game_info::data and retro_game_info::size are guaranteed + * to be valid + * + * In addition: + * + * If need_fullpath is true and retro_load_game() is called: + * - retro_game_info_ext::full_path is guaranteed to contain a valid + * path to an existent file + * - retro_game_info_ext::archive_path may be NULL + * - retro_game_info_ext::archive_file may be NULL + * - retro_game_info_ext::dir is guaranteed to contain a valid path + * to the directory in which the content file exists + * - retro_game_info_ext::name is guaranteed to contain the + * basename of the content file, without extension + * - retro_game_info_ext::ext is guaranteed to contain the + * extension of the content file in lower case format + * - retro_game_info_ext::data and retro_game_info_ext::size + * are invalid + * + * If need_fullpath is false and retro_load_game() is called: + * - If retro_game_info_ext::file_in_archive is false: + * - retro_game_info_ext::full_path is guaranteed to contain + * a valid path to an existent file + * - retro_game_info_ext::archive_path may be NULL + * - retro_game_info_ext::archive_file may be NULL + * - retro_game_info_ext::dir is guaranteed to contain a + * valid path to the directory in which the content file exists + * - retro_game_info_ext::name is guaranteed to contain the + * basename of the content file, without extension + * - retro_game_info_ext::ext is guaranteed to contain the + * extension of the content file in lower case format + * - If retro_game_info_ext::file_in_archive is true: + * - retro_game_info_ext::full_path may be NULL + * - retro_game_info_ext::archive_path is guaranteed to + * contain a valid path to an existent compressed file + * inside which the content file is located + * - retro_game_info_ext::archive_file is guaranteed to + * contain a valid path to an existent content file + * inside the compressed file referred to by + * retro_game_info_ext::archive_path + * e.g. for a compressed file '/path/to/foo.zip' + * containing 'bar.sfc' + * > retro_game_info_ext::archive_path will be '/path/to/foo.zip' + * > retro_game_info_ext::archive_file will be 'bar.sfc' + * - retro_game_info_ext::dir is guaranteed to contain a + * valid path to the directory in which the compressed file + * (containing the content file) exists + * - retro_game_info_ext::name is guaranteed to contain + * EITHER + * 1) the basename of the compressed file (containing + * the content file), without extension + * OR + * 2) the basename of the content file inside the + * compressed file, without extension + * In either case, a core should consider 'name' to + * be the canonical name/ID of the the content file + * - retro_game_info_ext::ext is guaranteed to contain the + * extension of the content file inside the compressed file, + * in lower case format + * - retro_game_info_ext::data and retro_game_info_ext::size are + * guaranteed to be valid */ + bool need_fullpath; + + /* If need_fullpath is false, specifies whether the content + * data buffer available in retro_load_game() is 'persistent' + * + * If persistent_data is false and retro_load_game() is called: + * - retro_game_info::data and retro_game_info::size + * are valid only until retro_load_game() returns + * - retro_game_info_ext::data and retro_game_info_ext::size + * are valid only until retro_load_game() returns + * + * If persistent_data is true and retro_load_game() is called: + * - retro_game_info::data and retro_game_info::size + * are valid until retro_deinit() returns + * - retro_game_info_ext::data and retro_game_info_ext::size + * are valid until retro_deinit() returns */ + bool persistent_data; +}; + +/* Similar to retro_game_info, but provides extended + * information about the source content file and + * game memory buffer status. + * And array of retro_game_info_ext is returned by + * RETRO_ENVIRONMENT_GET_GAME_INFO_EXT + * NOTE: In the following descriptions, references to + * retro_load_game() may be replaced with + * retro_load_game_special() */ +struct retro_game_info_ext +{ + /* - If file_in_archive is false, contains a valid + * path to an existent content file (UTF-8 encoded) + * - If file_in_archive is true, may be NULL */ + const char *full_path; + + /* - If file_in_archive is false, may be NULL + * - If file_in_archive is true, contains a valid path + * to an existent compressed file inside which the + * content file is located (UTF-8 encoded) */ + const char *archive_path; + + /* - If file_in_archive is false, may be NULL + * - If file_in_archive is true, contain a valid path + * to an existent content file inside the compressed + * file referred to by archive_path (UTF-8 encoded) + * e.g. for a compressed file '/path/to/foo.zip' + * containing 'bar.sfc' + * > archive_path will be '/path/to/foo.zip' + * > archive_file will be 'bar.sfc' */ + const char *archive_file; + + /* - If file_in_archive is false, contains a valid path + * to the directory in which the content file exists + * (UTF-8 encoded) + * - If file_in_archive is true, contains a valid path + * to the directory in which the compressed file + * (containing the content file) exists (UTF-8 encoded) */ + const char *dir; + + /* Contains the canonical name/ID of the content file + * (UTF-8 encoded). Intended for use when identifying + * 'complementary' content named after the loaded file - + * i.e. companion data of a different format (a CD image + * required by a ROM), texture packs, internally handled + * save files, etc. + * - If file_in_archive is false, contains the basename + * of the content file, without extension + * - If file_in_archive is true, then string is + * implementation specific. A frontend may choose to + * set a name value of: + * EITHER + * 1) the basename of the compressed file (containing + * the content file), without extension + * OR + * 2) the basename of the content file inside the + * compressed file, without extension + * RetroArch sets the 'name' value according to (1). + * A frontend that supports routine loading of + * content from archives containing multiple unrelated + * content files may set the 'name' value according + * to (2). */ + const char *name; + + /* - If file_in_archive is false, contains the extension + * of the content file in lower case format + * - If file_in_archive is true, contains the extension + * of the content file inside the compressed file, + * in lower case format */ + const char *ext; + + /* String of implementation specific meta-data. */ + const char *meta; + + /* Memory buffer of loaded game content. Will be NULL: + * IF + * - retro_system_info::need_fullpath is true and + * retro_system_content_info_override::need_fullpath + * is unset + * OR + * - retro_system_content_info_override::need_fullpath + * is true */ + const void *data; + + /* Size of game content memory buffer, in bytes */ + size_t size; + + /* True if loaded content file is inside a compressed + * archive */ + bool file_in_archive; + + /* - If data is NULL, value is unset/ignored + * - If data is non-NULL: + * - If persistent_data is false, data and size are + * valid only until retro_load_game() returns + * - If persistent_data is true, data and size are + * are valid until retro_deinit() returns */ + bool persistent_data; +}; + +struct retro_game_geometry +{ + unsigned base_width; /* Nominal video width of game. */ + unsigned base_height; /* Nominal video height of game. */ + unsigned max_width; /* Maximum possible width of game. */ + unsigned max_height; /* Maximum possible height of game. */ + + float aspect_ratio; /* Nominal aspect ratio of game. If + * aspect_ratio is <= 0.0, an aspect ratio + * of base_width / base_height is assumed. + * A frontend could override this setting, + * if desired. */ +}; + +struct retro_system_timing +{ + double fps; /* FPS of video content. */ + double sample_rate; /* Sampling rate of audio. */ +}; + +struct retro_system_av_info +{ + struct retro_game_geometry geometry; + struct retro_system_timing timing; +}; + +struct retro_variable +{ + /* Variable to query in RETRO_ENVIRONMENT_GET_VARIABLE. + * If NULL, obtains the complete environment string if more + * complex parsing is necessary. + * The environment string is formatted as key-value pairs + * delimited by semicolons as so: + * "key1=value1;key2=value2;..." + */ + const char *key; + + /* Value to be obtained. If key does not exist, it is set to NULL. */ + const char *value; +}; + +struct retro_core_option_display +{ + /* Variable to configure in RETRO_ENVIRONMENT_SET_CORE_OPTIONS_DISPLAY */ + const char *key; + + /* Specifies whether variable should be displayed + * when presenting core options to the user */ + bool visible; +}; + +/* Maximum number of values permitted for a core option + * > Note: We have to set a maximum value due the limitations + * of the C language - i.e. it is not possible to create an + * array of structs each containing a variable sized array, + * so the retro_core_option_definition values array must + * have a fixed size. The size limit of 128 is a balancing + * act - it needs to be large enough to support all 'sane' + * core options, but setting it too large may impact low memory + * platforms. In practise, if a core option has more than + * 128 values then the implementation is likely flawed. + * To quote the above API reference: + * "The number of possible options should be very limited + * i.e. it should be feasible to cycle through options + * without a keyboard." + */ +#define RETRO_NUM_CORE_OPTION_VALUES_MAX 128 + +struct retro_core_option_value +{ + /* Expected option value */ + const char *value; + + /* Human-readable value label. If NULL, value itself + * will be displayed by the frontend */ + const char *label; +}; + +struct retro_core_option_definition +{ + /* Variable to query in RETRO_ENVIRONMENT_GET_VARIABLE. */ + const char *key; + + /* Human-readable core option description (used as menu label) */ + const char *desc; + + /* Human-readable core option information (used as menu sublabel) */ + const char *info; + + /* Array of retro_core_option_value structs, terminated by NULL */ + struct retro_core_option_value values[RETRO_NUM_CORE_OPTION_VALUES_MAX]; + + /* Default core option value. Must match one of the values + * in the retro_core_option_value array, otherwise will be + * ignored */ + const char *default_value; +}; + +struct retro_core_options_intl +{ + /* Pointer to an array of retro_core_option_definition structs + * - US English implementation + * - Must point to a valid array */ + struct retro_core_option_definition *us; + + /* Pointer to an array of retro_core_option_definition structs + * - Implementation for current frontend language + * - May be NULL */ + struct retro_core_option_definition *local; +}; + +struct retro_game_info +{ + const char *path; /* Path to game, UTF-8 encoded. + * Sometimes used as a reference for building other paths. + * May be NULL if game was loaded from stdin or similar, + * but in this case some cores will be unable to load `data`. + * So, it is preferable to fabricate something here instead + * of passing NULL, which will help more cores to succeed. + * retro_system_info::need_fullpath requires + * that this path is valid. */ + const void *data; /* Memory buffer of loaded game. Will be NULL + * if need_fullpath was set. */ + size_t size; /* Size of memory buffer. */ + const char *meta; /* String of implementation specific meta-data. */ +}; + +#define RETRO_MEMORY_ACCESS_WRITE (1 << 0) + /* The core will write to the buffer provided by retro_framebuffer::data. */ +#define RETRO_MEMORY_ACCESS_READ (1 << 1) + /* The core will read from retro_framebuffer::data. */ +#define RETRO_MEMORY_TYPE_CACHED (1 << 0) + /* The memory in data is cached. + * If not cached, random writes and/or reading from the buffer is expected to be very slow. */ +struct retro_framebuffer +{ + void *data; /* The framebuffer which the core can render into. + Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER. + The initial contents of data are unspecified. */ + unsigned width; /* The framebuffer width used by the core. Set by core. */ + unsigned height; /* The framebuffer height used by the core. Set by core. */ + size_t pitch; /* The number of bytes between the beginning of a scanline, + and beginning of the next scanline. + Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER. */ + enum retro_pixel_format format; /* The pixel format the core must use to render into data. + This format could differ from the format used in + SET_PIXEL_FORMAT. + Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER. */ + + unsigned access_flags; /* How the core will access the memory in the framebuffer. + RETRO_MEMORY_ACCESS_* flags. + Set by core. */ + unsigned memory_flags; /* Flags telling core how the memory has been mapped. + RETRO_MEMORY_TYPE_* flags. + Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER. */ +}; + +/* Used by a libretro core to override the current + * fastforwarding mode of the frontend */ +struct retro_fastforwarding_override +{ + /* Specifies the runtime speed multiplier that + * will be applied when 'fastforward' is true. + * For example, a value of 5.0 when running 60 FPS + * content will cap the fast-forward rate at 300 FPS. + * Note that the target multiplier may not be achieved + * if the host hardware has insufficient processing + * power. + * Setting a value of 0.0 (or greater than 0.0 but + * less than 1.0) will result in an uncapped + * fast-forward rate (limited only by hardware + * capacity). + * If the value is negative, it will be ignored + * (i.e. the frontend will use a runtime speed + * multiplier of its own choosing) */ + float ratio; + + /* If true, fastforwarding mode will be enabled. + * If false, fastforwarding mode will be disabled. */ + bool fastforward; + + /* If true, and if supported by the frontend, an + * on-screen notification will be displayed while + * 'fastforward' is true. + * If false, and if supported by the frontend, any + * on-screen fast-forward notifications will be + * suppressed */ + bool notification; + + /* If true, the core will have sole control over + * when fastforwarding mode is enabled/disabled; + * the frontend will not be able to change the + * state set by 'fastforward' until either + * 'inhibit_toggle' is set to false, or the core + * is unloaded */ + bool inhibit_toggle; +}; + +/* Callbacks */ + +/* Environment callback. Gives implementations a way of performing + * uncommon tasks. Extensible. */ +typedef bool (RETRO_CALLCONV *retro_environment_t)(unsigned cmd, void *data); + +/* Render a frame. Pixel format is 15-bit 0RGB1555 native endian + * unless changed (see RETRO_ENVIRONMENT_SET_PIXEL_FORMAT). + * + * Width and height specify dimensions of buffer. + * Pitch specifices length in bytes between two lines in buffer. + * + * For performance reasons, it is highly recommended to have a frame + * that is packed in memory, i.e. pitch == width * byte_per_pixel. + * Certain graphic APIs, such as OpenGL ES, do not like textures + * that are not packed in memory. + */ +typedef void (RETRO_CALLCONV *retro_video_refresh_t)(const void *data, unsigned width, + unsigned height, size_t pitch); + +/* Renders a single audio frame. Should only be used if implementation + * generates a single sample at a time. + * Format is signed 16-bit native endian. + */ +typedef void (RETRO_CALLCONV *retro_audio_sample_t)(int16_t left, int16_t right); + +/* Renders multiple audio frames in one go. + * + * One frame is defined as a sample of left and right channels, interleaved. + * I.e. int16_t buf[4] = { l, r, l, r }; would be 2 frames. + * Only one of the audio callbacks must ever be used. + */ +typedef size_t (RETRO_CALLCONV *retro_audio_sample_batch_t)(const int16_t *data, + size_t frames); + +/* Polls input. */ +typedef void (RETRO_CALLCONV *retro_input_poll_t)(void); + +/* Queries for input for player 'port'. device will be masked with + * RETRO_DEVICE_MASK. + * + * Specialization of devices such as RETRO_DEVICE_JOYPAD_MULTITAP that + * have been set with retro_set_controller_port_device() + * will still use the higher level RETRO_DEVICE_JOYPAD to request input. + */ +typedef int16_t (RETRO_CALLCONV *retro_input_state_t)(unsigned port, unsigned device, + unsigned index, unsigned id); + +/* Sets callbacks. retro_set_environment() is guaranteed to be called + * before retro_init(). + * + * The rest of the set_* functions are guaranteed to have been called + * before the first call to retro_run() is made. */ +RETRO_API void retro_set_environment(retro_environment_t); +RETRO_API void retro_set_video_refresh(retro_video_refresh_t); +RETRO_API void retro_set_audio_sample(retro_audio_sample_t); +RETRO_API void retro_set_audio_sample_batch(retro_audio_sample_batch_t); +RETRO_API void retro_set_input_poll(retro_input_poll_t); +RETRO_API void retro_set_input_state(retro_input_state_t); + +/* Library global initialization/deinitialization. */ +RETRO_API void retro_init(void); +RETRO_API void retro_deinit(void); + +/* Must return RETRO_API_VERSION. Used to validate ABI compatibility + * when the API is revised. */ +RETRO_API unsigned retro_api_version(void); + +/* Gets statically known system info. Pointers provided in *info + * must be statically allocated. + * Can be called at any time, even before retro_init(). */ +RETRO_API void retro_get_system_info(struct retro_system_info *info); + +/* Gets information about system audio/video timings and geometry. + * Can be called only after retro_load_game() has successfully completed. + * NOTE: The implementation of this function might not initialize every + * variable if needed. + * E.g. geom.aspect_ratio might not be initialized if core doesn't + * desire a particular aspect ratio. */ +RETRO_API void retro_get_system_av_info(struct retro_system_av_info *info); + +/* Sets device to be used for player 'port'. + * By default, RETRO_DEVICE_JOYPAD is assumed to be plugged into all + * available ports. + * Setting a particular device type is not a guarantee that libretro cores + * will only poll input based on that particular device type. It is only a + * hint to the libretro core when a core cannot automatically detect the + * appropriate input device type on its own. It is also relevant when a + * core can change its behavior depending on device type. + * + * As part of the core's implementation of retro_set_controller_port_device, + * the core should call RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS to notify the + * frontend if the descriptions for any controls have changed as a + * result of changing the device type. + */ +RETRO_API void retro_set_controller_port_device(unsigned port, unsigned device); + +/* Resets the current game. */ +RETRO_API void retro_reset(void); + +/* Runs the game for one video frame. + * During retro_run(), input_poll callback must be called at least once. + * + * If a frame is not rendered for reasons where a game "dropped" a frame, + * this still counts as a frame, and retro_run() should explicitly dupe + * a frame if GET_CAN_DUPE returns true. + * In this case, the video callback can take a NULL argument for data. + */ +RETRO_API void retro_run(void); + +/* Returns the amount of data the implementation requires to serialize + * internal state (save states). + * Between calls to retro_load_game() and retro_unload_game(), the + * returned size is never allowed to be larger than a previous returned + * value, to ensure that the frontend can allocate a save state buffer once. + */ +RETRO_API size_t retro_serialize_size(void); + +/* Serializes internal state. If failed, or size is lower than + * retro_serialize_size(), it should return false, true otherwise. */ +RETRO_API bool retro_serialize(void *data, size_t size); +RETRO_API bool retro_unserialize(const void *data, size_t size); + +RETRO_API void retro_cheat_reset(void); +RETRO_API void retro_cheat_set(unsigned index, bool enabled, const char *code); + +/* Loads a game. + * Return true to indicate successful loading and false to indicate load failure. + */ +RETRO_API bool retro_load_game(const struct retro_game_info *game); + +/* Loads a "special" kind of game. Should not be used, + * except in extreme cases. */ +RETRO_API bool retro_load_game_special( + unsigned game_type, + const struct retro_game_info *info, size_t num_info +); + +/* Unloads the currently loaded game. Called before retro_deinit(void). */ +RETRO_API void retro_unload_game(void); + +/* Gets region of game. */ +RETRO_API unsigned retro_get_region(void); + +/* Gets region of memory. */ +RETRO_API void *retro_get_memory_data(unsigned id); +RETRO_API size_t retro_get_memory_size(unsigned id); + +#ifdef __cplusplus +} +#endif + +#endif @@ -0,0 +1,411 @@ +#include <stdarg.h> +#include <stdio.h> +#include <string.h> +#include "core.h" +#include "config.h" +#include "libpicofe/config_file.h" +#include "libpicofe/input.h" +#include "main.h" +#include "menu.h" +#include "plat.h" + +#ifdef MMENU +#include <dlfcn.h> +#include <mmenu.h> +#include <SDL/SDL.h> +void* mmenu = NULL; +static int resume_slot = -1; +char save_template_path[MAX_PATH]; +#endif + +bool should_quit = false; +int current_audio_buffer_size; +char core_name[MAX_PATH]; +char* content_path; + +static uint32_t vsyncs; +static uint32_t renders; +static float vsyncsps; +static float rendersps; + +static void extract_core_name(const char* core_file) { + char *suffix = NULL; + + strncpy(core_name, basename(core_file), MAX_PATH); + core_name[sizeof(core_name) - 1] = 0; + + suffix = strrchr(core_name, '_'); + if (suffix && !strcmp(suffix, "_libretro.so")) + *suffix = 0; + else { + suffix = strrchr(core_name, '.'); + if (suffix && !strcmp(suffix, ".so")) + *suffix = 0; + } +} + +static void toggle_fast_forward(int force_off) +{ + static int frameskip_style_was; + static int max_frameskip_was; + static int limit_frames_was; + static int enable_audio_was; + static int fast_forward; + + if (force_off && !fast_forward) + return; + + fast_forward = !fast_forward; + + if (fast_forward) { + if (!strcmp(core_name, "gpsp")) { + frameskip_style_was = options_get_value_index("gpsp_frameskip"); + max_frameskip_was = options_get_value_index("gpsp_frameskip_interval"); + options_set_value("gpsp_frameskip", "fixed_interval"); + options_set_value("gpsp_frameskip_interval", "5"); + } else if (!strcmp(core_name, "snes9x2002")) { + frameskip_style_was = options_get_value_index("snes9x2002_frameskip"); + max_frameskip_was = options_get_value_index("snes9x2002_frameskip_interval"); + options_set_value("snes9x2002_frameskip", "auto"); + options_set_value("snes9x2002_frameskip_interval", "5"); + } + + limit_frames_was = limit_frames; + enable_audio_was = enable_audio; + limit_frames = 0; + enable_audio = 0; + } else { + if (!strcmp(core_name, "gpsp")) { + options_set_value_index("gpsp_frameskip", frameskip_style_was); + options_set_value_index("gpsp_frameskip_interval", max_frameskip_was); + } else if (!strcmp(core_name, "snes9x2002")) { + options_set_value_index("snes9x2002_frameskip", frameskip_style_was); + options_set_value_index("snes9x2002_frameskip_interval", max_frameskip_was); + } + + limit_frames = limit_frames_was; + enable_audio = enable_audio_was; + } +} + +void set_defaults(void) +{ + show_fps = 0; + limit_frames = 1; + enable_audio = 1; + audio_buffer_size = 5; + scale_size = SCALE_SIZE_NONE; + scale_filter = SCALE_FILTER_NEAREST; + scale_update_scaler(); + + if (current_audio_buffer_size < audio_buffer_size) + current_audio_buffer_size = audio_buffer_size; + + for (int i = 0; i < core_options.len; i++) { + const char *key = options_get_key(i); + if (key) + core_options.entries[i].value = options_default_index(key); + } + + options_update_changed(); +} + +int save_config(int is_game) +{ + char config_filename[MAX_PATH]; + FILE *config_file; + + config_file_name(config_filename, MAX_PATH, is_game); + config_file = fopen(config_filename, "wb"); + if (!config_file) { + fprintf(stderr, "Could not write config to %s\n", config_filename); + return -1; + } + + config_write(config_file); + config_write_keys(config_file); + + fclose(config_file); + return 0; +} + +static void alloc_config_buffer(char **config_ptr) { + char config_filename[MAX_PATH]; + FILE *config_file; + size_t length; + + config_file_name(config_filename, MAX_PATH, 1); + config_file = fopen(config_filename, "rb"); + if (!config_file) { + config_file_name(config_filename, MAX_PATH, 0); + config_file = fopen(config_filename, "rb"); + } + + if (!config_file) + return; + + PA_INFO("Loading config from %s\n", config_filename); + + fseek(config_file, 0, SEEK_END); + length = ftell(config_file); + fseek(config_file, 0, SEEK_SET); + + *config_ptr = calloc(1, length); + + fread(*config_ptr, 1, length, config_file); + fclose(config_file); +} + +void load_config(void) +{ + char *config = NULL; + alloc_config_buffer(&config); + + if (config) { + config_read(config); + free(config); + } +} + +static void load_config_keys(void) +{ + char *config = NULL; + int kcount = 0; + const int *defbinds = NULL; + + alloc_config_buffer(&config); + + if (config) { + config_read_keys(config); + free(config); + + /* Force input device 0 menu to be bound to the default key */ + in_get_config(0, IN_CFG_BIND_COUNT, &kcount); + defbinds = in_get_dev_def_binds(0); + + for(int i = 0; i < kcount; i++) { + if (defbinds[IN_BIND_OFFS(i, IN_BINDTYPE_EMU)] == 1 << EACTION_MENU) { + in_bind_key(0, i, 1 << EACTION_MENU, IN_BINDTYPE_EMU, 0); + } + } + } +} + +void handle_emu_action(emu_action action) +{ + static emu_action prev_action = EACTION_NONE; + if (prev_action != EACTION_NONE && prev_action == action) return; + + switch (action) + { + case EACTION_NONE: + break; + case EACTION_MENU: + toggle_fast_forward(1); /* Force FF off */ + sram_write(); +#ifdef MMENU + if (mmenu) { + ShowMenu_t ShowMenu = (ShowMenu_t)dlsym(mmenu, "ShowMenu"); + SDL_Surface *screen = SDL_GetVideoSurface(); + MenuReturnStatus status = ShowMenu(content_path, save_template_path, screen, kMenuEventKeyDown); + + if (status==kStatusExitGame) { + should_quit = 1; + plat_video_menu_leave(); + } + else if (status==kStatusOpenMenu) { + menu_loop(); + } + else if (status>=kStatusLoadSlot) { + state_slot = status - kStatusLoadSlot; + state_read(); + } + else if (status>=kStatusSaveSlot) { + state_slot = status - kStatusSaveSlot; + state_write(); + } + + // release that menu key + SDL_Event sdlevent; + sdlevent.type = SDL_KEYUP; + sdlevent.key.keysym.sym = SDLK_ESCAPE; + SDL_PushEvent(&sdlevent); + } + else { +#endif + menu_loop(); +#ifdef MMENU + } +#endif + break; + case EACTION_TOGGLE_FPS: + show_fps = !show_fps; + /* Force the hud to clear */ + plat_video_set_msg(" "); + break; + case EACTION_SAVE_STATE: + state_write(); + break; + case EACTION_LOAD_STATE: + state_read(); + break; + case EACTION_TOGGLE_FF: + toggle_fast_forward(0); + break; + case EACTION_QUIT: + should_quit = 1; + break; + default: + break; + } + + prev_action = action; +} + +void pa_log(enum retro_log_level level, const char *fmt, ...) { + char buf[1024] = {0}; + va_list args; + va_start(args, fmt); + vsnprintf(buf, sizeof(buf), fmt, args); + va_end(args); + + switch(level) { +#ifdef DEBUG + case RETRO_LOG_DEBUG: + printf("DEBUG: %s", buf); + break; +#endif + case RETRO_LOG_INFO: + printf("INFO: %s", buf); + break; + case RETRO_LOG_WARN: + fprintf(stderr, "WARN: %s", buf); + break; + case RETRO_LOG_ERROR: + fprintf(stderr, "ERROR: %s", buf); + break; + default: + break; + } +} + +void pa_track_render(void) { + renders++; +} + +static void count_fps(void) +{ + char msg[HUD_LEN]; + + static unsigned int nextsec = 0; + unsigned int ticks = 0; + + if (show_fps) { + ticks = plat_get_ticks_ms(); + if (ticks > nextsec) { + float last_time = (ticks - nextsec + 1000) / 1000.0f; + + if (last_time > 0) { + vsyncsps = vsyncs / last_time; + rendersps = renders / last_time; + vsyncs = 0; + renders = 0; + nextsec = ticks + 1000; + } + } + vsyncs++; + + snprintf(msg, HUD_LEN, "FPS: %.1f (%.0f)", rendersps, vsyncsps); + plat_video_set_msg(msg); + } +} + +static void adjust_audio(void) { + static int prev_audio_buffer_size = 0; + + if (!prev_audio_buffer_size) + prev_audio_buffer_size = audio_buffer_size; + + current_audio_buffer_size = + audio_buffer_size > audio_buffer_size_override + ? audio_buffer_size + : audio_buffer_size_override; + + if (prev_audio_buffer_size != current_audio_buffer_size) { + PA_INFO("Resizing audio buffer from %d to %d frames\n", + prev_audio_buffer_size, + current_audio_buffer_size); + + plat_sound_resize_buffer(); + prev_audio_buffer_size = current_audio_buffer_size; + } + + if (current_core.retro_audio_buffer_status) { + float occupancy = 1.0 - plat_sound_capacity(); + current_core.retro_audio_buffer_status(true, (int)(occupancy * 100), occupancy < 0.50); + } +} + +int main(int argc, char **argv) { + if (argc != 3) { + printf("Usage: picoarch LIBRETRO_CORE CONTENT"); + return -1; + } + + extract_core_name(argv[1]); + content_path = argv[2]; + + set_defaults(); + + if (core_load(argv[1])) { + quit(-1); + } + + if (core_load_content(argv[2])) { + quit(-1); + } + + if (plat_init()) { + quit(-1); + } + + /* Must happen after initializing plat_input */ + load_config_keys(); + + if (menu_init()) { + quit(-1); + } + +#ifdef MMENU + + mmenu = dlopen("libmmenu.so", RTLD_LAZY); + if (mmenu) { + ResumeSlot_t ResumeSlot = (ResumeSlot_t)dlsym(mmenu, "ResumeSlot"); + if (ResumeSlot) resume_slot = ResumeSlot(); + } + + if (resume_slot!=-1) { + state_slot = resume_slot; + state_read(); + resume_slot = -1; + } +#endif + + do { + count_fps(); + adjust_audio(); + current_core.retro_run(); + if (!should_quit) + plat_video_flip(); + } while (!should_quit); + + return quit(0); +} + +int quit(int code) { + sram_write(); + menu_finish(); + core_unload(); + plat_finish(); + exit(code); +} @@ -0,0 +1,64 @@ +#ifndef __MAIN_H__ +#define __MAIN_H__ + +#include <stdbool.h> +#include <string.h> +#include "options.h" +#include "libretro.h" + +#define MAX_PATH 512 + +typedef enum { + EACTION_NONE = 0, + EACTION_MENU, + EACTION_TOGGLE_FPS, + EACTION_TOGGLE_FF, + EACTION_SAVE_STATE, + EACTION_LOAD_STATE, + EACTION_QUIT, +} emu_action; + +extern bool should_quit; +extern int current_audio_buffer_size; +extern char core_name[MAX_PATH]; +extern char* content_path; + +#ifdef MMENU +extern void* mmenu; +extern char save_template_path[MAX_PATH]; +#endif + + +#define MAX(a, b) (a) > (b) ? (a) : (b) +#define MIN(a, b) (a) < (b) ? (a) : (b) + +static inline bool has_suffix_i(const char *str, const char *suffix) { + const char *p = strrchr(str, suffix[0]); + if (!p) p = str; + return !strcasecmp(p, suffix); +} + +#define array_size(x) (sizeof(x) / sizeof(x[0])) + +#ifdef DEBUG_LOGGING +#define PA_DEBUG(...) pa_log(RETRO_LOG_DEBUG, __VA_ARGS__) +#else +#define PA_DEBUG(...) +#endif + +#define PA_INFO(...) pa_log(RETRO_LOG_INFO, __VA_ARGS__) +#define PA_WARN(...) pa_log(RETRO_LOG_WARN, __VA_ARGS__) +#define PA_ERROR(...) pa_log(RETRO_LOG_ERROR, __VA_ARGS__) +#define PA_FATAL(...) do { pa_log(RETRO_LOG_ERROR, __VA_ARGS__); quit(-1); } while(0) + + +void set_defaults(void); +int save_config(int is_game); +void load_config(void); + +void handle_emu_action(emu_action action); +void pa_log(enum retro_log_level level, const char *fmt, ...); +void pa_track_render(void); +int quit(int code); + +#endif /* __MAIN_H__ */ @@ -0,0 +1,409 @@ +#include <sys/stat.h> +#include "core.h" +#include "main.h" +#include "menu.h" +#include "options.h" +#include "plat.h" +#include "scale.h" + +#define MENU_ALIGN_LEFT 0 +#define MENU_X2 0 + +typedef enum +{ + MA_NONE = 1, + MA_MAIN_RESUME_GAME, + MA_MAIN_SAVE_STATE, + MA_MAIN_LOAD_STATE, + MA_MAIN_CORE_OPTS, + MA_MAIN_RESET_GAME, + MA_MAIN_CREDITS, + MA_MAIN_EXIT, + MA_OPT_SAVECFG, + MA_OPT_SAVECFG_GAME, + MA_CTRL_PLAYER1, + MA_CTRL_EMU, +} menu_id; + +me_bind_action me_ctrl_actions[] = +{ + { "UP ", 1 << RETRO_DEVICE_ID_JOYPAD_UP}, + { "DOWN ", 1 << RETRO_DEVICE_ID_JOYPAD_DOWN }, + { "LEFT ", 1 << RETRO_DEVICE_ID_JOYPAD_LEFT }, + { "RIGHT ", 1 << RETRO_DEVICE_ID_JOYPAD_RIGHT }, + { "A BUTTON ", 1 << RETRO_DEVICE_ID_JOYPAD_A }, + { "B BUTTON ", 1 << RETRO_DEVICE_ID_JOYPAD_B }, + { "X BUTTON ", 1 << RETRO_DEVICE_ID_JOYPAD_X }, + { "Y BUTTON ", 1 << RETRO_DEVICE_ID_JOYPAD_Y }, + { "START ", 1 << RETRO_DEVICE_ID_JOYPAD_START }, + { "SELECT ", 1 << RETRO_DEVICE_ID_JOYPAD_SELECT }, + { "L BUTTON ", 1 << RETRO_DEVICE_ID_JOYPAD_L }, + { "R BUTTON ", 1 << RETRO_DEVICE_ID_JOYPAD_R }, + { "L2 BUTTON ", 1 << RETRO_DEVICE_ID_JOYPAD_L2 }, + { "R2 BUTTON ", 1 << RETRO_DEVICE_ID_JOYPAD_R2 }, + { NULL, 0 } +}; + +me_bind_action gba_ctrl_actions[] = +{ + { "UP ", 1 << RETRO_DEVICE_ID_JOYPAD_UP}, + { "DOWN ", 1 << RETRO_DEVICE_ID_JOYPAD_DOWN }, + { "LEFT ", 1 << RETRO_DEVICE_ID_JOYPAD_LEFT }, + { "RIGHT ", 1 << RETRO_DEVICE_ID_JOYPAD_RIGHT }, + { "A BUTTON ", 1 << RETRO_DEVICE_ID_JOYPAD_A }, + { "B BUTTON ", 1 << RETRO_DEVICE_ID_JOYPAD_B }, + { "A TURBO ", 1 << RETRO_DEVICE_ID_JOYPAD_X }, + { "B TURBO ", 1 << RETRO_DEVICE_ID_JOYPAD_Y }, + { "START ", 1 << RETRO_DEVICE_ID_JOYPAD_START }, + { "SELECT ", 1 << RETRO_DEVICE_ID_JOYPAD_SELECT }, + { "L BUTTON ", 1 << RETRO_DEVICE_ID_JOYPAD_L }, + { "R BUTTON ", 1 << RETRO_DEVICE_ID_JOYPAD_R }, + /* { "FAST FWD ", 1 << RETRO_DEVICE_ID_JOYPAD_R2 }, */ + { NULL, 0 } +}; + +me_bind_action snes_ctrl_actions[] = +{ + { "UP ", 1 << RETRO_DEVICE_ID_JOYPAD_UP}, + { "DOWN ", 1 << RETRO_DEVICE_ID_JOYPAD_DOWN }, + { "LEFT ", 1 << RETRO_DEVICE_ID_JOYPAD_LEFT }, + { "RIGHT ", 1 << RETRO_DEVICE_ID_JOYPAD_RIGHT }, + { "A BUTTON ", 1 << RETRO_DEVICE_ID_JOYPAD_A }, + { "B BUTTON ", 1 << RETRO_DEVICE_ID_JOYPAD_B }, + { "X BUTTON ", 1 << RETRO_DEVICE_ID_JOYPAD_X }, + { "Y BUTTON ", 1 << RETRO_DEVICE_ID_JOYPAD_Y }, + { "START ", 1 << RETRO_DEVICE_ID_JOYPAD_START }, + { "SELECT ", 1 << RETRO_DEVICE_ID_JOYPAD_SELECT }, + { "L BUTTON ", 1 << RETRO_DEVICE_ID_JOYPAD_L }, + { "R BUTTON ", 1 << RETRO_DEVICE_ID_JOYPAD_R }, + { NULL, 0 } +}; + +/* Must be a superset of all possible actions. This is used when + * saving config, and if an entry isn't here, the saver won't see + * it. */ +me_bind_action emuctrl_actions[] = +{ + { "Save State ", 1 << EACTION_SAVE_STATE }, + { "Load State ", 1 << EACTION_LOAD_STATE }, + { "Show/Hide FPS ", 1 << EACTION_TOGGLE_FPS }, + { "Toggle FF ", 1 << EACTION_TOGGLE_FF }, + { NULL, 0 } +}; + +static int emu_check_save_file(int slot, int *time) +{ + char fname[MAX_PATH]; + struct stat status; + int ret; + + state_file_name(fname, sizeof(fname), slot); + + ret = stat(fname, &status); + if (ret != 0) + return 0; + + return 1; +} + +static int emu_save_load_game(int load, int unused) +{ + int ret; + + if (load) + ret = state_read(); + else + ret = state_write(); + + return ret; +} + +// RGB565 +static unsigned short fname2color(const char *fname) +{ + return 0xFFFF; +} + +#include "libpicofe/menu.c" + +static const char *menu_loop_romsel(char *curr_path, int len, + const char **filter_exts, + int (*extra_filter)(struct dirent **namelist, int count, + const char *basedir)) __attribute__((unused)); + +static void draw_menu_message(const char *msg, void (*draw_more)(void)) __attribute__((unused)); + +static const char *mgn_saveloadcfg(int id, int *offs) +{ + return ""; +} + +static int mh_restore_defaults(int id, int keys) +{ + set_defaults(); + menu_update_msg("defaults restored"); + return 1; +} + +static int mh_savecfg(int id, int keys) +{ + if (save_config(id == MA_OPT_SAVECFG_GAME ? 1 : 0) == 0) + menu_update_msg("config saved"); + else + menu_update_msg("failed to write config"); + + return 1; +} + +static int menu_loop_core_options(int id, int keys) +{ + static int sel = 0; + menu_entry *e_menu_core_options; + + e_menu_core_options = (menu_entry *)calloc(core_options.visible_len + 1, sizeof(menu_entry)); + + if (!e_menu_core_options) { + PA_ERROR("Error allocating core options\n"); + return 0; + } + + for(int i = 0, menu_idx = 0; i < core_options.len; i++) { + const char *key; + struct core_option_entry *entry; + menu_entry *option; + key = core_options.defs ? core_options.defs[i].key : core_options.vars[i].key; + if (options_is_blocked(key)) + continue; + + entry = options_get_entry(key); + option = &e_menu_core_options[menu_idx]; + + option->name = entry->desc; + option->beh = MB_OPT_ENUM; + option->var = options_get_value_ptr(key); + option->enabled = 1; + option->need_to_save = 1; + option->selectable = 1; + option->data = options_get_options(key); + option->help = entry->info; + menu_idx++; + } + + me_loop(e_menu_core_options, &sel); + + options_update_changed(); + + free(e_menu_core_options); + return 0; +} + +static const char h_restore_def[] = "Switches back to default / recommended\n" + "configuration"; + +static const char h_show_fps[] = "Shows frames and vsyncs per second"; + +static const char h_audio_buffer_size[] = + "The size of the audio buffer, in frames. Higher\n" + "values reduce the risk of audio crackling at the\n" + "cost of delayed sound."; + +static const char h_scale_size[] = + "How much to stretch the screen when scaling. Native\n" + "does no stretching. Aspect uses the correct aspect\n" + "ratio. Full uses the whole screen."; + +static const char h_scale_filter[] = + "When stretching, how missing pixels are filled.\n" + "Nearest copies the last pixel. Sharp keeps pixels\n" + "aligned where possible. Smooth adds a blur effect."; + + +static const char *men_scale_size[] = { "Native", "Aspect", "Full", NULL}; +static const char *men_scale_filter[] = { "Nearest", "Sharp", "Smooth", NULL}; + +static menu_entry e_menu_video_options[] = +{ + mee_onoff_h ("Show FPS", 0, show_fps, 1, h_show_fps), + mee_enum_h ("Screen size", 0, scale_size, men_scale_size, h_scale_size), + mee_enum_h ("Filter", 0, scale_filter, men_scale_filter, h_scale_filter), + mee_range_h ("Audio buffer", 0, audio_buffer_size, 1, 15, h_audio_buffer_size), + mee_end, +}; + +static int menu_loop_video_options(int id, int keys) +{ + static int sel = 0; + + me_loop(e_menu_video_options, &sel); + scale_update_scaler(); + + return 0; +} + +static int key_config_loop_wrap(int id, int keys) +{ + me_bind_action *actions = me_ctrl_actions; + size_t action_size = array_size(me_ctrl_actions); + me_bind_action *emu_actions = emuctrl_actions; + size_t emu_action_size = array_size(emuctrl_actions); + + if (!strcmp(core_name, "gpsp")) { + actions = gba_ctrl_actions; + action_size = array_size(gba_ctrl_actions); + } else if (strstr(core_name, "snes")) { + actions = snes_ctrl_actions; + action_size = array_size(snes_ctrl_actions); + } + + switch (id) { + case MA_CTRL_PLAYER1: + key_config_loop(actions, action_size - 1, 0); + break; + case MA_CTRL_EMU: + key_config_loop(emu_actions, emu_action_size - 1, -1); + break; + default: + break; + } + return 0; +} + +static menu_entry e_menu_keyconfig[] = +{ + mee_handler_id ("Player controls", MA_CTRL_PLAYER1, key_config_loop_wrap), + mee_handler_id ("Emulator controls", MA_CTRL_EMU, key_config_loop_wrap), + mee_cust_nosave ("Save global config", MA_OPT_SAVECFG, mh_savecfg, mgn_saveloadcfg), + mee_cust_nosave ("Save game config", MA_OPT_SAVECFG_GAME, mh_savecfg, mgn_saveloadcfg), + mee_end, +}; + +static int menu_loop_keyconfig(int id, int keys) +{ + static int sel = 0; + me_loop(e_menu_keyconfig, &sel); + return 0; +} + +static menu_entry e_menu_config_options[] = +{ + mee_cust_nosave ("Save global config", MA_OPT_SAVECFG, mh_savecfg, mgn_saveloadcfg), + mee_cust_nosave ("Save game config", MA_OPT_SAVECFG_GAME, mh_savecfg, mgn_saveloadcfg), + mee_handler_h ("Restore defaults", mh_restore_defaults, h_restore_def), + mee_end, +}; + +static int menu_loop_config_options(int id, int keys) +{ + static int sel = 0; + + me_loop(e_menu_config_options, &sel); + + return 0; +} + +static int main_menu_handler(int id, int keys) +{ + switch (id) + { + case MA_MAIN_RESUME_GAME: + return 1; + case MA_MAIN_SAVE_STATE: + return menu_loop_savestate(0); + case MA_MAIN_LOAD_STATE: + return menu_loop_savestate(1); + case MA_MAIN_RESET_GAME: + current_core.retro_reset(); + return 1; + case MA_MAIN_EXIT: + should_quit = 1; + return 1; + default: + lprintf("%s: something unknown selected\n", __FUNCTION__); + break; + } + + return 0; +} + +static menu_entry e_menu_main[] = +{ + mee_handler_id("Resume game", MA_MAIN_RESUME_GAME, main_menu_handler), + mee_handler_id("Save State", MA_MAIN_SAVE_STATE, main_menu_handler), + mee_handler_id("Load State", MA_MAIN_LOAD_STATE, main_menu_handler), + mee_handler_id("Emulator options", MA_MAIN_CORE_OPTS, menu_loop_core_options), + mee_handler ("Audio and Video", menu_loop_video_options), + mee_handler ("Controls", menu_loop_keyconfig), + /* mee_handler_id("Cheats", MA_MAIN_CHEATS, main_menu_handler), */ + mee_handler ("Save config", menu_loop_config_options), + mee_handler_id("Reset game", MA_MAIN_RESET_GAME, main_menu_handler), + mee_handler_id("Exit", MA_MAIN_EXIT, main_menu_handler), + mee_end, +}; + +static void draw_savestate_bg(int slot) +{ +} + +void menu_loop(void) +{ + static int sel = 0; + plat_video_menu_enter(1); + + me_enable(e_menu_main, MA_MAIN_CORE_OPTS, core_options.visible_len > 0); + +#ifdef MMENU + me_enable(e_menu_main, MA_MAIN_SAVE_STATE, mmenu == NULL); + me_enable(e_menu_main, MA_MAIN_LOAD_STATE, mmenu == NULL); +#endif + + memcpy(g_menubg_ptr, g_menuscreen_ptr, g_menuscreen_h * g_menuscreen_pp * sizeof(uint16_t)); + + menu_darken_bg(g_menubg_ptr, g_menubg_ptr, g_menuscreen_h * g_menuscreen_pp, 0); + me_loop_d(e_menu_main, &sel, NULL, NULL); + + /* wait until menu, ok, back is released */ + while (in_menu_wait_any(NULL, 50) & (PBTN_MENU|PBTN_MOK|PBTN_MBACK)) + ; + memset(g_menubg_ptr, 0, g_menuscreen_h * g_menuscreen_pp * sizeof(uint16_t)); + + /* Force the hud to clear */ + plat_video_set_msg(" "); + plat_video_menu_leave(); +} + +int menu_init(void) +{ + menu_init_base(); + + g_menubg_src_ptr = calloc(g_menuscreen_w * g_menuscreen_h * 2, 1); + g_menubg_ptr = calloc(g_menuscreen_w * g_menuscreen_h * 2, 1); + if (g_menubg_src_ptr == NULL || g_menubg_ptr == NULL) { + fprintf(stderr, "OOM\n"); + return -1; + } + return 0; +} + +void menu_finish(void) +{ + if (g_menubg_src_ptr) { + free(g_menubg_src_ptr); + } + + if (g_menubg_ptr) { + free(g_menubg_ptr); + } +} + +static void debug_menu_loop(void) +{ +} + +void menu_update_msg(const char *msg) +{ + strncpy(menu_error_msg, msg, sizeof(menu_error_msg)); + menu_error_msg[sizeof(menu_error_msg) - 1] = 0; + + menu_error_time = plat_get_ticks_ms(); + PA_INFO("%s\n", menu_error_msg); +} @@ -0,0 +1,11 @@ +#ifndef _MENU_H__ +#define _MENU_H__ + +#include "config.h" +#include "libpicofe/menu.h" + +int menu_init(void); +void menu_loop(void); +void menu_finish(void); + +#endif diff --git a/options.c b/options.c new file mode 100644 index 0000000..92918d4 --- /dev/null +++ b/options.c @@ -0,0 +1,337 @@ +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include "main.h" +#include "options.h" + +int show_fps; +int limit_frames; +int enable_audio; +int audio_buffer_size; +enum scale_size scale_size; +enum scale_filter scale_filter; + +struct core_options core_options; + +#define MAX_DESC_LEN 20 + +static void truncate(char *string, int max_len) { + size_t len = strlen(string) + 1; + if (len <= max_len) return; + + strncpy(&string[max_len - 4], "...\0", 4); +} + +static const char *blocked_options[] = { "gpsp_save_method", NULL}; + +static bool option_blocked(const char *key) { + for (int i = 0; blocked_options[i]; i++) { + if (!strcmp(blocked_options[i], key)) + return true; + } + return false; +} + +static int options_default_override(const char *key) { + if (!strcmp(key, "snes9x2002_frameskip")) { + return 1; + } else if (!strcmp(key, "snes9x2002_frameskip_interval")) { + return 3; + } + + return -1; +} + +void options_init(const struct retro_core_option_definition *defs) { + int i; + + for (i = 0; defs[i].key; i++) + ; + + core_options.visible_len = core_options.len = i; + core_options.defs = defs; + + core_options.entries = (struct core_option_entry *)calloc(core_options.len, sizeof(struct core_option_entry)); + if (!core_options.entries) { + PA_ERROR("Error allocating option entries\n"); + options_free(); + return; + } + + for (i = 0; i < core_options.len; i++) { + int j, len; + struct core_option_entry *entry = &core_options.entries[i]; + + entry->def = &core_options.defs[i]; + entry->value = options_default_index(entry->def->key); + entry->prev_value = entry->value; + entry->info = entry->def->info; + entry->blocked = option_blocked(entry->def->key); + if (entry->blocked) + core_options.visible_len--; + + len = strlen(entry->def->desc) + 1; + entry->desc = (char *)calloc(len, sizeof(char)); + if (!entry->desc) { + PA_ERROR("Error allocating option entries\n"); + options_free(); + return; + } + + strncpy(entry->desc, entry->def->desc, len); + truncate(entry->desc, MAX_DESC_LEN); + + for (j = 0; entry->def->values[j].value; j++) + ; + j++; /* Make room for NULL entry */ + + entry->options = (const char **)calloc(j, sizeof(char *)); + if (!entry->options) { + PA_ERROR("Error allocating option entries\n"); + options_free(); + return; + } + + + for (j = 0; entry->def->values[j].value; j++) { + const char *label = entry->def->values[j].label; + if (!label) { + label = entry->def->values[j].value; + } + entry->options[j] = label; + } + } +} + +void options_init_variables(const struct retro_variable *vars) { + int i; + + for (i = 0; vars[i].key; i++) + ; + + core_options.visible_len = core_options.len = i; + core_options.vars = vars; + + core_options.entries = (struct core_option_entry *)calloc(core_options.len, sizeof(struct core_option_entry)); + if (!core_options.entries) { + PA_ERROR("Error allocating option entries\n"); + options_free(); + return; + } + + for (i = 0; i < core_options.len; i++) { + int j = 0; + int len; + struct core_option_entry *entry = &core_options.entries[i]; + char *p; + char *opt_ptr; + char *value; + + entry->var = &core_options.vars[i]; + entry->value = options_default_index(entry->var->key); + entry->prev_value = entry->value; + entry->blocked = option_blocked(entry->var->key); + if (entry->blocked) + core_options.visible_len--; + + len = strlen(entry->var->value) + 1; + value = (char *)calloc(len, sizeof(char)); + if (!value) { + PA_ERROR("Error allocating option entries\n"); + options_free(); + return; + } + + entry->retro_var_value = value; + + strncpy(value, entry->var->value, len); + + p = strchr(value, ';'); + if (p && *(p + 1) == ' ') { + *p = '\0'; + entry->desc = value; + truncate(entry->desc, MAX_DESC_LEN); + p++; + p++; + } + + opt_ptr = p; + + for(j = 0; (p = strchr(p, '|')); p++, j++) + ; + j++; /* Make room for last entry (not ending in |) */ + j++; /* Make room for NULL entry */ + + entry->options = (const char **)calloc(j, sizeof(char *)); + if (!entry->options) { + PA_ERROR("Error allocating option entries\n"); + options_free(); + return; + } + + p = opt_ptr; + for (j = 0; (p = strchr(p, '|')); j++) { + entry->options[j] = opt_ptr; + *p = '\0'; + p++; + opt_ptr = p; + } + entry->options[j] = opt_ptr; + } +} + +bool options_changed(void) { + bool was_changed = core_options.changed; + core_options.changed = false; + return was_changed; +} + +void options_update_changed(void) { + if (core_options.changed) + return; + + for(int i = 0; i < core_options.len; i++) { + struct core_option_entry* entry = &core_options.entries[i]; + if (entry->value != entry->prev_value) { + core_options.changed = true; + entry->prev_value = entry->value; + } + } +} + +const char* options_get_key(int index) { + if (core_options.defs) { + return core_options.defs[index].key; + } else { + return core_options.vars[index].key; + } +} + +struct core_option_entry* options_get_entry(const char* key) { + for(int i = 0; i < core_options.len; i++) { + const char *opt_key = core_options.defs ? + core_options.defs[i].key : + core_options.vars[i].key; + + if (!strcmp(opt_key, key)) { + return &core_options.entries[i]; + } + } + return NULL; +} + + +bool options_is_blocked(const char *key) { + struct core_option_entry* entry = options_get_entry(key); + if (entry) { + return entry->blocked; + } + return true; +} + +const char* options_get_value(const char* key) { + struct core_option_entry* entry = options_get_entry(key); + if (entry) { + if (entry->def) { + return entry->def->values[entry->value].value; + } else { + return entry->options[entry->value]; + } + } + return NULL; +} + +int* options_get_value_ptr(const char* key) { + struct core_option_entry* entry = options_get_entry(key); + if (entry) { + return &(entry->value); + } + return NULL; +} + +int options_get_value_index(const char* key) { + struct core_option_entry* entry = options_get_entry(key); + if (entry) { + return entry->value; + } + return 0; +} + +void options_set_value(const char* key, const char *value) { + struct core_option_entry* entry = options_get_entry(key); + if (entry) { + const char *option = NULL; + entry->value = options_default_index(key); + + if (entry->def) { + for (int i = 0; (option = entry->def->values[i].value); i++) { + if (!strcmp(option, value)) { + entry->value = i; + options_update_changed(); + return; + } + } + } else { + for (int i = 0; (option = entry->options[i]); i++) { + if (!strcmp(option, value)) { + entry->value = i; + options_update_changed(); + return; + } + } + } + } +} + +void options_set_value_index(const char* key, int value) { + struct core_option_entry* entry = options_get_entry(key); + if (entry) { + entry->value = value; + options_update_changed(); + } +} + +int options_default_index(const char *key) { + const char *value; + struct core_option_entry *entry; + int default_override = options_default_override(key); + if (default_override >= 0) + return default_override; + + entry = options_get_entry(key); + if (!entry || !entry->def) + return 0; + + for(int i = 0; (value = entry->def->values[i].value); i++) { + if (!strcmp(value, entry->def->default_value)) { + return i; + } + } + return 0; +} + +const char** options_get_options(const char* key) { + struct core_option_entry* entry = options_get_entry(key); + if (entry) { + return entry->options; + } + return NULL; +} + +void options_free(void) { + if (core_options.entries) { + for (int i = 0; i < core_options.len; i++) { + struct core_option_entry* entry = &core_options.entries[i]; + if (entry->options) { + free(entry->options); + } + if (entry->retro_var_value) { + free(entry->retro_var_value); + } else if (entry->desc) { + free(entry->desc); + } + } + free(core_options.entries); + } + memset(&core_options, 0, sizeof(core_options)); +} diff --git a/options.h b/options.h new file mode 100644 index 0000000..51838ef --- /dev/null +++ b/options.h @@ -0,0 +1,56 @@ +#ifndef _OPTIONS_H__ +#define _OPTIONS_H__ +#include "libretro.h" +#include "scale.h" + +extern int show_fps; +extern int limit_frames; +extern int enable_audio; +extern int audio_buffer_size; +extern enum scale_size scale_size; +extern enum scale_filter scale_filter; + +struct core_option_entry { + int value; + int prev_value; + char *desc; + char *retro_var_value; + bool blocked; + const char *info; + const char **options; + const struct retro_core_option_definition *def; + const struct retro_variable *var; +}; + +struct core_options { + size_t len; + size_t visible_len; + bool changed; + struct core_option_entry *entries; + const struct retro_core_option_definition *defs; + const struct retro_variable *vars; +}; + +extern struct core_options core_options; + +void options_init(const struct retro_core_option_definition *defs); +void options_init_variables(const struct retro_variable *vars); +bool options_changed(void); +void options_update_changed(void); +const char* options_get_key(int index); + +struct core_option_entry* options_get_entry(const char* key); +bool options_is_blocked(const char *key); + +const char* options_get_value(const char* key); +int* options_get_value_ptr(const char* key); +int options_get_value_index(const char* key); + +void options_set_value(const char* key, const char *value); +void options_set_value_index(const char* key, int value); + +int options_default_index(const char *key); +const char** options_get_options(const char* key); +void options_free(void); + +#endif diff --git a/patches/gpsp/0001-trimui-support.patch b/patches/gpsp/0001-trimui-support.patch new file mode 100644 index 0000000..b3dd044 --- /dev/null +++ b/patches/gpsp/0001-trimui-support.patch @@ -0,0 +1,103 @@ +diff --git a/Makefile b/Makefile +index f043a85..b2a5562 100644 +--- a/Makefile ++++ b/Makefile +@@ -451,6 +451,20 @@ else ifeq ($(platform), rs90) + HAVE_DYNAREC := 1 + CPU_ARCH := mips + ++else ifeq ($(platform), trimui) ++ TARGET := $(TARGET_NAME)_libretro.so ++ CC = $(CROSS_COMPILE)gcc ++ SHARED := -shared -Wl,--version-script=link.T -mcpu=arm926ej-s -mtune=arm926ej-s ++ CFLAGS += -ffast-math -fdata-sections -ffunction-sections -flto -fno-PIC ++ LDFLAGS += -flto ++ ifeq (,$(DEBUG)) ++ LDFLAGS += -s ++ endif ++ HAVE_DYNAREC := 1 ++ CPU_ARCH_ARM_BLENDING_OPTS := 1 ++ CPU_ARCH := arm ++ OPTIMIZE := -Ofast -DNDEBUG ++ + # Windows + else + TARGET := $(TARGET_NAME)_libretro.dll +@@ -479,7 +493,14 @@ ifeq ($(DEBUG), 1) + OPTIMIZE := -O0 -g + else + OPTIMIZE_SAFE := -O2 -DNDEBUG +- OPTIMIZE := -O3 -DNDEBUG ++ OPTIMIZE ?= -O3 -DNDEBUG ++endif ++ ++ifeq ($(PROFILE), GENERATE) ++ CFLAGS += -fprofile-generate=./profile/gpsp ++ LDFLAGS += -lgcov ++else ifeq ($(PROFILE), APPLY) ++ CFLAGS += -fprofile-use -fprofile-dir=../profile/gpsp -fbranch-probabilities + endif + + DEFINES := -DHAVE_STRINGS_H -DHAVE_STDINT_H -DHAVE_INTTYPES_H -D__LIBRETRO__ -DINLINE=inline -Wall +diff --git a/arm/arm_stub.S b/arm/arm_stub.S +index 4058b22..03e9996 100644 +--- a/arm/arm_stub.S ++++ b/arm/arm_stub.S +@@ -79,8 +79,26 @@ _##symbol: + #define IOREG_OFF 0x8D00 + + +-#define extract_u16(rd, rs) \ ++#if __ARM_ARCH >= 6 ++#define extract_u16(rd, rs) ;\ + uxth rd, rs ++#else ++#define extract_u16(rd, rs) ;\ ++ bic rd, rs, #0xff000000 ;\ ++ bic rd, rd, #0x00ff0000 ++#endif ++ ++#if __ARM_ARCH >= 6 ++#define sat_u4(rd, rs, shift) ;\ ++ usat rd, #4, rs, shift ++#else ++#define sat_u4(rd, rs, shift) ;\ ++ mov rd, rs, shift ;\ ++ bic rd, rd, rd, asr #31 ;\ ++ sub rd, rd, #15 ;\ ++ and rd, rd, rd, asr #31 ;\ ++ add rd, rd, #15 ++#endif + + @ Will load the register set from memory into the appropriate cached registers. + @ See arm_emit.h for listing explanation. +@@ -539,7 +557,7 @@ return_to_main: + #define execute_store_builder(store_type, str_op, str_op16, load_op, tnum) ;\ + ;\ + defsymbl(execute_store_u##store_type) ;\ +- usat r2, #4, r0, asr #24 /* r2 contains [0-15] */;\ ++ sat_u4(r2, r0, asr #24) /* r2 contains [0-15] */;\ + add r2, r2, #((STORE_TBL_OFF + 16*4*tnum) >> 2) /* add table offset */;\ + ldr pc, [reg_base, r2, lsl #2] /* load handler addr */;\ + nop ;\ +@@ -628,7 +646,7 @@ execute_store_builder(32, str, str, ldr, 2) + @ This is a store that is executed in a strm case (so no SMC checks in-between) + + defsymbl(execute_store_u32_safe) +- usat r2, #4, r0, asr #24 ++ sat_u4(r2, r0, asr #24) + add r2, r2, #((STORE_TBL_OFF + 16*4*3) >> 2) + ldr pc, [reg_base, r2, lsl #2] + nop +@@ -773,9 +791,9 @@ lookup_pc_arm: + defsymbl(execute_load_##load_type) ;\ + .if albits >= 1 ;\ + ror r1, r0, #(albits) /* move alignment bits to MSB */;\ +- usat r1, #4, r1, asr #(24-albits) /* r1 contains [0-15] */;\ ++ sat_u4(r1, r1, asr #(24-albits)) /* r1 contains [0-15] */;\ + .else ;\ +- usat r1, #4, r0, asr #24 /* r1 contains [0-15] */;\ ++ sat_u4(r1, r0, asr #24) /* r1 contains [0-15] */;\ + .endif ;\ + add r1, r1, #((STORE_TBL_OFF + 16*4*tnum) >> 2) /* add table offset */;\ + ldr pc, [reg_base, r1, lsl #2] /* load handler addr */;\ diff --git a/patches/gpsp/0002-core-options.patch b/patches/gpsp/0002-core-options.patch new file mode 100644 index 0000000..086c5ed --- /dev/null +++ b/patches/gpsp/0002-core-options.patch @@ -0,0 +1,149 @@ +diff --git a/libretro_core_options.h b/libretro_core_options.h +index c23a2c3..ae3c70c 100644 +--- a/libretro_core_options.h ++++ b/libretro_core_options.h +@@ -56,11 +56,13 @@ struct retro_core_option_definition option_defs_us[] = { + { + "gpsp_bios", + "BIOS", +- "Choose the BIOS image to use. The official BIOS must be provided by the user. Using a non-official (or builtin) BIOS might result in incompatibility problems with some games. Best results are to be achieved with the official Nintendo BIOS.", ++ "Choose the BIOS image to use. The official BIOS\n" ++ "must be provided by the user. Using a builtin\n" ++ "BIOS might result in compatibility problems.", + { +- { "auto", "Auto select" }, +- { "builtin", "Builtin BIOS" }, +- { "official", "Original BIOS" }, ++ { "auto", "auto" }, ++ { "builtin", "builtin" }, ++ { "official", "original" }, + { NULL, NULL }, + }, + "auto" +@@ -68,10 +70,11 @@ struct retro_core_option_definition option_defs_us[] = { + { + "gpsp_boot_mode", + "Boot mode", +- "Choose whether to boot the BIOS before the game or not. There's not much difference in either modes.", ++ "Choose whether to boot the BIOS before the game\n" ++ "or not.", + { +- { "game", "Boot to game" }, +- { "bios", "Boot to BIOS" }, ++ { "game", "game" }, ++ { "bios", "BIOS" }, + { NULL, NULL }, + }, + "game" +@@ -79,20 +82,23 @@ struct retro_core_option_definition option_defs_us[] = { + { + "gpsp_frameskip", + "Frameskip", +- "Skip frames to avoid audio buffer under-run (crackling). Improves performance at the expense of visual smoothness. 'Auto' skips frames when advised by the frontend. 'Auto (Threshold)' utilises the 'Frameskip Threshold (%)' setting. 'Fixed Interval' utilises the 'Frameskip Interval' setting.", ++ "Skip frames to avoid audio crackling. Improves\n" ++ "performance at the expense of visual smoothness.", + { + { "disabled", NULL }, + { "auto", "Auto" }, +- { "auto_threshold", "Auto (Threshold)" }, +- { "fixed_interval", "Fixed Interval" }, ++ { "auto_threshold", "Threshold" }, ++ { "fixed_interval", "Fixed" }, + { NULL, NULL }, + }, +- "disabled" ++ "auto" + }, + { + "gpsp_frameskip_threshold", +- "Frameskip Threshold (%)", +- "When 'Frameskip' is set to 'Auto (Threshold)', specifies the audio buffer occupancy threshold (percentage) below which frames will be skipped. Higher values reduce the risk of crackling by causing frames to be dropped more frequently.", ++ "FS Threshold (%)", ++ "When 'Frameskip' is set to 'Threshold', sets\n" ++ "how low the audio buffer can get before frames\n" ++ "will be skipped.", + { + { "15", NULL }, + { "18", NULL }, +@@ -116,8 +122,9 @@ struct retro_core_option_definition option_defs_us[] = { + }, + { + "gpsp_frameskip_interval", +- "Frameskip Interval", +- "When 'Frameskip' is set to 'Fixed Interval', the value set here is the number of frames omitted after a frame is rendered - i.e. '0' = 60fps, '1' = 30fps, '2' = 15fps, etc.", ++ "FS Interval", ++ "The maximum number of frames that can be skipped\n" ++ "before a new frame is rendered.", + { + { "0", NULL }, + { "1", NULL }, +@@ -132,46 +139,49 @@ struct retro_core_option_definition option_defs_us[] = { + { "10", NULL }, + { NULL, NULL }, + }, +- "1" ++ "3" + }, + { + "gpsp_color_correction", + "Color Correction", +- "Adjusts output colors to match the display of real GBA hardware.", ++ "Adjusts output colors to match real GBA hardware.", + { +- { "enabled", NULL }, + { "disabled", NULL }, ++ { "enabled", NULL }, + { NULL, NULL }, + }, + "disabled" + }, + { + "gpsp_frame_mixing", +- "Interframe Blending", +- "Simulates LCD ghosting effects by performing a 50:50 mix of the current and previous frames. Required for correct operation when playing games that exploit LCD ghosting for transparency effects (F-Zero, the Boktai series, etc.).", ++ "Frame Blending", ++ "Simulates LCD ghosting effects.", + { +- { "enabled", NULL }, + { "disabled", NULL }, ++ { "enabled", NULL }, + { NULL, NULL }, + }, + "disabled" + }, + { + "gpsp_save_method", +- "Backup Save Method (Restart)", +- "Choose the data format used for cartridge save files. 'gpSP' can be used for compatibility with the stand-alone version of gpSP. 'libretro' provides better integration with the frontend.", ++ "Save Format", ++ "Choose the data format used for cartridge save\n" ++ "files. Must restart to take effect.", + { + { "gpSP", NULL }, + { "libretro", NULL }, + { NULL, NULL }, + }, +- "gpSP" ++ "libretro" + }, + #if defined(HAVE_DYNAREC) + { + "gpsp_drc", + "Dynamic Recompiler", +- "Dynamically recompile CPU instructions to native instructions. Greatly improves performance, but may reduce accuracy.", ++ "Dynamically recompile CPU instructions to native\n" ++ "instructions. Greatly improves performance, but\n" ++ "may reduce accuracy.", + { + { "enabled", NULL }, + { "disabled", NULL }, +@@ -183,7 +193,8 @@ struct retro_core_option_definition option_defs_us[] = { + { + "gpsp_turbo_period", + "Turbo Button Period", +- "Specify the repeat interval (in frames) when holding down the Turbo A/B buttons.", ++ "Specify the repeat interval (in frames) when\n" ++ "holding down the Turbo A/B buttons.", + { + { "4", NULL }, + { "5", NULL }, diff --git a/patches/gpsp/0003-frameskip-changes.patch b/patches/gpsp/0003-frameskip-changes.patch new file mode 100644 index 0000000..3444df9 --- /dev/null +++ b/patches/gpsp/0003-frameskip-changes.patch @@ -0,0 +1,22 @@ +diff --git a/libretro.c b/libretro.c +index f31235b..241a69e 100644 +--- a/libretro.c ++++ b/libretro.c +@@ -1099,7 +1099,7 @@ void retro_run(void) + 1 : 0; + + if (!skip_next_frame || +- (frameskip_counter >= FRAMESKIP_MAX)) ++ (frameskip_counter >= frameskip_interval)) + { + skip_next_frame = 0; + frameskip_counter = 0; +@@ -1116,7 +1116,7 @@ void retro_run(void) + 1 : 0; + + if (!skip_next_frame || +- (frameskip_counter >= FRAMESKIP_MAX)) ++ (frameskip_counter >= frameskip_interval)) + { + skip_next_frame = 0; + frameskip_counter = 0; diff --git a/patches/gpsp/1000-avoid-audio-popping.patch b/patches/gpsp/1000-avoid-audio-popping.patch new file mode 100644 index 0000000..ed868a4 --- /dev/null +++ b/patches/gpsp/1000-avoid-audio-popping.patch @@ -0,0 +1,16 @@ +diff --git a/sound.h b/sound.h +index 08d1de5..93221d5 100644 +--- a/sound.h ++++ b/sound.h +@@ -24,8 +24,10 @@ + #define BUFFER_SIZE_MASK (BUFFER_SIZE - 1) + + #define GBA_SOUND_FREQUENCY (64 * 1024) ++#define GBA_60HZ_RATE 16853760.0f /* 228*(272+960)*60 */ + +-#define GBC_BASE_RATE ((float)(16 * 1024 * 1024)) ++// run GBA at 60Hz (~0.5% faster) to better match host display ++#define GBC_BASE_RATE GBA_60HZ_RATE + + typedef enum + { diff --git a/patches/snes9x2002/0001-trimui-support.patch b/patches/snes9x2002/0001-trimui-support.patch new file mode 100644 index 0000000..eadb54c --- /dev/null +++ b/patches/snes9x2002/0001-trimui-support.patch @@ -0,0 +1,50 @@ +diff --git a/Makefile b/Makefile +index e42d169..a1f8794 100644 +--- a/Makefile ++++ b/Makefile +@@ -244,6 +244,23 @@ else ifeq ($(platform), gcw0) + CFLAGS += -fno-builtin -fno-exceptions + CFLAGS += -DPATH_MAX=256 -DFAST_LSB_WORD_ACCESS + ++else ifeq ($(platform), trimui) ++ TARGET := $(TARGET_NAME)_libretro.so ++ CC = $(CROSS_COMPILE)gcc ++ AR = $(CROSS_COMPILE)ar ++ SHARED := -shared -Wl,--version-script=libretro/link.T -Wl,--no-undefined ++ CFLAGS += -fsingle-precision-constant -fno-PIC -flto ++ CFLAGS += -DLSB_FIRST -DFAST_ALIGNED_LSB_WORD_ACCESS -DRIGHTSHIFT_IS_SAR ++ CFLAGS += -std=c99 -fomit-frame-pointer -ffast-math -mcpu=arm926ej-s -mtune=arm926ej-s ++ LDFLAGS += -flto ++ OFLAGS += -Ofast -DNDEBUG=1 ++ ARM_ASM = 1 ++ ASM_CPU = 0 ++ ASM_SPC700 = 0 ++ ifeq (,$(DEBUG)) ++ LDFLAGS += -s ++ endif ++ + # Windows MSVC 2010 x64 + else ifeq ($(platform), windows_msvc2010_x64) + CC = cl.exe +@@ -381,12 +398,21 @@ LIBRETRO_DIR := ./libretro + + ifeq ($(DEBUG), 1) + DEFINES += -O0 -g ++else ifneq (,$(OFLAGS)) ++DEFINES += $(OFLAGS) + else ifneq (,$(findstring msvc,$(platform))) + DEFINES += -O2 -DNDEBUG=1 + else + DEFINES += -O3 -DNDEBUG=1 + endif + ++ifeq ($(PROFILE), GENERATE) ++ CFLAGS += -fprofile-generate=./profile/snes9x2002 ++ LDFLAGS += -lgcov ++else ifeq ($(PROFILE), APPLY) ++ CFLAGS += -fprofile-use -fprofile-dir=../profile/snes9x2002 -fbranch-probabilities ++endif ++ + ifneq (,$(findstring msvc,$(platform))) + ifeq ($(DEBUG),1) + DEFINES += -MTd diff --git a/patches/snes9x2002/0002-core-options.patch b/patches/snes9x2002/0002-core-options.patch new file mode 100644 index 0000000..a908343 --- /dev/null +++ b/patches/snes9x2002/0002-core-options.patch @@ -0,0 +1,13 @@ +diff --git a/libretro/libretro.c b/libretro/libretro.c +index 81ce4aa..bc64376 100644 +--- a/libretro/libretro.c ++++ b/libretro/libretro.c +@@ -339,7 +339,7 @@ void retro_init (void) + { + static const struct retro_variable vars[] = + { +- { "snes9x2002_overclock_cycles", "Reduce Slowdown (Hack, Unsafe, Restart); disabled|compatible|max" }, ++ { "snes9x2002_overclock_cycles", "Overclock (Restart); disabled|compatible|max" }, + { NULL, NULL }, + }; + diff --git a/patches/snes9x2002/1000-update-libretro-h.patch b/patches/snes9x2002/1000-update-libretro-h.patch new file mode 100644 index 0000000..b5984f2 --- /dev/null +++ b/patches/snes9x2002/1000-update-libretro-h.patch @@ -0,0 +1,876 @@ +diff --git a/libretro/libretro-common/include/libretro.h b/libretro/libretro-common/include/libretro.h +index f97a969..32aa15f 100644 +--- a/libretro/libretro-common/include/libretro.h ++++ b/libretro/libretro-common/include/libretro.h +@@ -1,4 +1,4 @@ +-/* Copyright (C) 2010-2018 The RetroArch team ++/* Copyright (C) 2010-2020 The RetroArch team + * + * --------------------------------------------------------------------------------------- + * The following license statement only applies to this libretro API header (libretro.h). +@@ -278,6 +278,11 @@ enum retro_language + RETRO_LANGUAGE_ARABIC = 16, + RETRO_LANGUAGE_GREEK = 17, + RETRO_LANGUAGE_TURKISH = 18, ++ RETRO_LANGUAGE_SLOVAK = 19, ++ RETRO_LANGUAGE_PERSIAN = 20, ++ RETRO_LANGUAGE_HEBREW = 21, ++ RETRO_LANGUAGE_ASTURIAN = 22, ++ RETRO_LANGUAGE_FINNISH = 23, + RETRO_LANGUAGE_LAST, + + /* Ensure sizeof(enum) == sizeof(int) */ +@@ -708,6 +713,9 @@ enum retro_mod + * state of rumble motors in controllers. + * A strong and weak motor is supported, and they can be + * controlled indepedently. ++ * Should be called from either retro_init() or retro_load_game(). ++ * Should not be called from retro_set_environment(). ++ * Returns false if rumble functionality is unavailable. + */ + #define RETRO_ENVIRONMENT_GET_INPUT_DEVICE_CAPABILITIES 24 + /* uint64_t * -- +@@ -1087,10 +1095,10 @@ enum retro_mod + + #define RETRO_ENVIRONMENT_GET_TARGET_REFRESH_RATE (50 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* float * -- +- * Float value that lets us know what target refresh rate ++ * Float value that lets us know what target refresh rate + * is curently in use by the frontend. + * +- * The core can use the returned value to set an ideal ++ * The core can use the returned value to set an ideal + * refresh rate/framerate. + */ + +@@ -1098,7 +1106,7 @@ enum retro_mod + /* bool * -- + * Boolean value that indicates whether or not the frontend supports + * input bitmasks being returned by retro_input_state_t. The advantage +- * of this is that retro_input_state_t has to be only called once to ++ * of this is that retro_input_state_t has to be only called once to + * grab all button states instead of multiple times. + * + * If it returns true, you can pass RETRO_DEVICE_ID_JOYPAD_MASK as 'id' +@@ -1174,7 +1182,7 @@ enum retro_mod + * "foo_option", + * "Speed hack coprocessor X", + * "Provides increased performance at the expense of reduced accuracy", +- * { ++ * { + * { "false", NULL }, + * { "true", NULL }, + * { "unstable", "Turbo (Unstable)" }, +@@ -1246,6 +1254,245 @@ enum retro_mod + * default when calling SET_VARIABLES/SET_CORE_OPTIONS. + */ + ++#define RETRO_ENVIRONMENT_GET_PREFERRED_HW_RENDER 56 ++ /* unsigned * -- ++ * ++ * Allows an implementation to ask frontend preferred hardware ++ * context to use. Core should use this information to deal ++ * with what specific context to request with SET_HW_RENDER. ++ * ++ * 'data' points to an unsigned variable ++ */ ++ ++#define RETRO_ENVIRONMENT_GET_DISK_CONTROL_INTERFACE_VERSION 57 ++ /* unsigned * -- ++ * Unsigned value is the API version number of the disk control ++ * interface supported by the frontend. If callback return false, ++ * API version is assumed to be 0. ++ * ++ * In legacy code, the disk control interface is defined by passing ++ * a struct of type retro_disk_control_callback to ++ * RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE. ++ * This may be still be done regardless of the disk control ++ * interface version. ++ * ++ * If version is >= 1 however, the disk control interface may ++ * instead be defined by passing a struct of type ++ * retro_disk_control_ext_callback to ++ * RETRO_ENVIRONMENT_SET_DISK_CONTROL_EXT_INTERFACE. ++ * This allows the core to provide additional information about ++ * disk images to the frontend and/or enables extra ++ * disk control functionality by the frontend. ++ */ ++ ++#define RETRO_ENVIRONMENT_SET_DISK_CONTROL_EXT_INTERFACE 58 ++ /* const struct retro_disk_control_ext_callback * -- ++ * Sets an interface which frontend can use to eject and insert ++ * disk images, and also obtain information about individual ++ * disk image files registered by the core. ++ * This is used for games which consist of multiple images and ++ * must be manually swapped out by the user (e.g. PSX, floppy disk ++ * based systems). ++ */ ++ ++#define RETRO_ENVIRONMENT_GET_MESSAGE_INTERFACE_VERSION 59 ++ /* unsigned * -- ++ * Unsigned value is the API version number of the message ++ * interface supported by the frontend. If callback returns ++ * false, API version is assumed to be 0. ++ * ++ * In legacy code, messages may be displayed in an ++ * implementation-specific manner by passing a struct ++ * of type retro_message to RETRO_ENVIRONMENT_SET_MESSAGE. ++ * This may be still be done regardless of the message ++ * interface version. ++ * ++ * If version is >= 1 however, messages may instead be ++ * displayed by passing a struct of type retro_message_ext ++ * to RETRO_ENVIRONMENT_SET_MESSAGE_EXT. This allows the ++ * core to specify message logging level, priority and ++ * destination (OSD, logging interface or both). ++ */ ++ ++#define RETRO_ENVIRONMENT_SET_MESSAGE_EXT 60 ++ /* const struct retro_message_ext * -- ++ * Sets a message to be displayed in an implementation-specific ++ * manner for a certain amount of 'frames'. Additionally allows ++ * the core to specify message logging level, priority and ++ * destination (OSD, logging interface or both). ++ * Should not be used for trivial messages, which should simply be ++ * logged via RETRO_ENVIRONMENT_GET_LOG_INTERFACE (or as a ++ * fallback, stderr). ++ */ ++ ++#define RETRO_ENVIRONMENT_GET_INPUT_MAX_USERS 61 ++ /* unsigned * -- ++ * Unsigned value is the number of active input devices ++ * provided by the frontend. This may change between ++ * frames, but will remain constant for the duration ++ * of each frame. ++ * If callback returns true, a core need not poll any ++ * input device with an index greater than or equal to ++ * the number of active devices. ++ * If callback returns false, the number of active input ++ * devices is unknown. In this case, all input devices ++ * should be considered active. ++ */ ++ ++#define RETRO_ENVIRONMENT_SET_AUDIO_BUFFER_STATUS_CALLBACK 62 ++ /* const struct retro_audio_buffer_status_callback * -- ++ * Lets the core know the occupancy level of the frontend ++ * audio buffer. Can be used by a core to attempt frame ++ * skipping in order to avoid buffer under-runs. ++ * A core may pass NULL to disable buffer status reporting ++ * in the frontend. ++ */ ++ ++#define RETRO_ENVIRONMENT_SET_MINIMUM_AUDIO_LATENCY 63 ++ /* const unsigned * -- ++ * Sets minimum frontend audio latency in milliseconds. ++ * Resultant audio latency may be larger than set value, ++ * or smaller if a hardware limit is encountered. A frontend ++ * is expected to honour requests up to 512 ms. ++ * ++ * - If value is less than current frontend ++ * audio latency, callback has no effect ++ * - If value is zero, default frontend audio ++ * latency is set ++ * ++ * May be used by a core to increase audio latency and ++ * therefore decrease the probability of buffer under-runs ++ * (crackling) when performing 'intensive' operations. ++ * A core utilising RETRO_ENVIRONMENT_SET_AUDIO_BUFFER_STATUS_CALLBACK ++ * to implement audio-buffer-based frame skipping may achieve ++ * optimal results by setting the audio latency to a 'high' ++ * (typically 6x or 8x) integer multiple of the expected ++ * frame time. ++ * ++ * WARNING: This can only be called from within retro_run(). ++ * Calling this can require a full reinitialization of audio ++ * drivers in the frontend, so it is important to call it very ++ * sparingly, and usually only with the users explicit consent. ++ * An eventual driver reinitialize will happen so that audio ++ * callbacks happening after this call within the same retro_run() ++ * call will target the newly initialized driver. ++ */ ++ ++#define RETRO_ENVIRONMENT_SET_FASTFORWARDING_OVERRIDE 64 ++ /* const struct retro_fastforwarding_override * -- ++ * Used by a libretro core to override the current ++ * fastforwarding mode of the frontend. ++ * If NULL is passed to this function, the frontend ++ * will return true if fastforwarding override ++ * functionality is supported (no change in ++ * fastforwarding state will occur in this case). ++ */ ++ ++#define RETRO_ENVIRONMENT_SET_CONTENT_INFO_OVERRIDE 65 ++ /* const struct retro_system_content_info_override * -- ++ * Allows an implementation to override 'global' content ++ * info parameters reported by retro_get_system_info(). ++ * Overrides also affect subsystem content info parameters ++ * set via RETRO_ENVIRONMENT_SET_SUBSYSTEM_INFO. ++ * This function must be called inside retro_set_environment(). ++ * If callback returns false, content info overrides ++ * are unsupported by the frontend, and will be ignored. ++ * If callback returns true, extended game info may be ++ * retrieved by calling RETRO_ENVIRONMENT_GET_GAME_INFO_EXT ++ * in retro_load_game() or retro_load_game_special(). ++ * ++ * 'data' points to an array of retro_system_content_info_override ++ * structs terminated by a { NULL, false, false } element. ++ * If 'data' is NULL, no changes will be made to the frontend; ++ * a core may therefore pass NULL in order to test whether ++ * the RETRO_ENVIRONMENT_SET_CONTENT_INFO_OVERRIDE and ++ * RETRO_ENVIRONMENT_GET_GAME_INFO_EXT callbacks are supported ++ * by the frontend. ++ * ++ * For struct member descriptions, see the definition of ++ * struct retro_system_content_info_override. ++ * ++ * Example: ++ * ++ * - struct retro_system_info: ++ * { ++ * "My Core", // library_name ++ * "v1.0", // library_version ++ * "m3u|md|cue|iso|chd|sms|gg|sg", // valid_extensions ++ * true, // need_fullpath ++ * false // block_extract ++ * } ++ * ++ * - Array of struct retro_system_content_info_override: ++ * { ++ * { ++ * "md|sms|gg", // extensions ++ * false, // need_fullpath ++ * true // persistent_data ++ * }, ++ * { ++ * "sg", // extensions ++ * false, // need_fullpath ++ * false // persistent_data ++ * }, ++ * { NULL, false, false } ++ * } ++ * ++ * Result: ++ * - Files of type m3u, cue, iso, chd will not be ++ * loaded by the frontend. Frontend will pass a ++ * valid path to the core, and core will handle ++ * loading internally ++ * - Files of type md, sms, gg will be loaded by ++ * the frontend. A valid memory buffer will be ++ * passed to the core. This memory buffer will ++ * remain valid until retro_deinit() returns ++ * - Files of type sg will be loaded by the frontend. ++ * A valid memory buffer will be passed to the core. ++ * This memory buffer will remain valid until ++ * retro_load_game() (or retro_load_game_special()) ++ * returns ++ * ++ * NOTE: If an extension is listed multiple times in ++ * an array of retro_system_content_info_override ++ * structs, only the first instance will be registered ++ */ ++ ++#define RETRO_ENVIRONMENT_GET_GAME_INFO_EXT 66 ++ /* const struct retro_game_info_ext ** -- ++ * Allows an implementation to fetch extended game ++ * information, providing additional content path ++ * and memory buffer status details. ++ * This function may only be called inside ++ * retro_load_game() or retro_load_game_special(). ++ * If callback returns false, extended game information ++ * is unsupported by the frontend. In this case, only ++ * regular retro_game_info will be available. ++ * RETRO_ENVIRONMENT_GET_GAME_INFO_EXT is guaranteed ++ * to return true if RETRO_ENVIRONMENT_SET_CONTENT_INFO_OVERRIDE ++ * returns true. ++ * ++ * 'data' points to an array of retro_game_info_ext structs. ++ * ++ * For struct member descriptions, see the definition of ++ * struct retro_game_info_ext. ++ * ++ * - If function is called inside retro_load_game(), ++ * the retro_game_info_ext array is guaranteed to ++ * have a size of 1 - i.e. the returned pointer may ++ * be used to access directly the members of the ++ * first retro_game_info_ext struct, for example: ++ * ++ * struct retro_game_info_ext *game_info_ext; ++ * if (environ_cb(RETRO_ENVIRONMENT_GET_GAME_INFO_EXT, &game_info_ext)) ++ * printf("Content Directory: %s\n", game_info_ext->dir); ++ * ++ * - If the function is called inside retro_load_game_special(), ++ * the retro_game_info_ext array is guaranteed to have a ++ * size equal to the num_info argument passed to ++ * retro_load_game_special() ++ */ ++ + /* VFS functionality */ + + /* File paths: +@@ -1382,17 +1629,17 @@ typedef int (RETRO_CALLCONV *retro_vfs_closedir_t)(struct retro_vfs_dir_handle * + struct retro_vfs_interface + { + /* VFS API v1 */ +- retro_vfs_get_path_t get_path; +- retro_vfs_open_t open; +- retro_vfs_close_t close; +- retro_vfs_size_t size; +- retro_vfs_tell_t tell; +- retro_vfs_seek_t seek; +- retro_vfs_read_t read; +- retro_vfs_write_t write; +- retro_vfs_flush_t flush; +- retro_vfs_remove_t remove; +- retro_vfs_rename_t rename; ++ retro_vfs_get_path_t get_path; ++ retro_vfs_open_t open; ++ retro_vfs_close_t close; ++ retro_vfs_size_t size; ++ retro_vfs_tell_t tell; ++ retro_vfs_seek_t seek; ++ retro_vfs_read_t read; ++ retro_vfs_write_t write; ++ retro_vfs_flush_t flush; ++ retro_vfs_remove_t remove; ++ retro_vfs_rename_t rename; + /* VFS API v2 */ + retro_vfs_truncate_t truncate; + /* VFS API v3 */ +@@ -1420,11 +1667,11 @@ struct retro_vfs_interface_info + + enum retro_hw_render_interface_type + { +- RETRO_HW_RENDER_INTERFACE_VULKAN = 0, +- RETRO_HW_RENDER_INTERFACE_D3D9 = 1, +- RETRO_HW_RENDER_INTERFACE_D3D10 = 2, +- RETRO_HW_RENDER_INTERFACE_D3D11 = 3, +- RETRO_HW_RENDER_INTERFACE_D3D12 = 4, ++ RETRO_HW_RENDER_INTERFACE_VULKAN = 0, ++ RETRO_HW_RENDER_INTERFACE_D3D9 = 1, ++ RETRO_HW_RENDER_INTERFACE_D3D10 = 2, ++ RETRO_HW_RENDER_INTERFACE_D3D11 = 3, ++ RETRO_HW_RENDER_INTERFACE_D3D12 = 4, + RETRO_HW_RENDER_INTERFACE_GSKIT_PS2 = 5, + RETRO_HW_RENDER_INTERFACE_DUMMY = INT_MAX + }; +@@ -1922,6 +2169,10 @@ enum retro_sensor_action + { + RETRO_SENSOR_ACCELEROMETER_ENABLE = 0, + RETRO_SENSOR_ACCELEROMETER_DISABLE, ++ RETRO_SENSOR_GYROSCOPE_ENABLE, ++ RETRO_SENSOR_GYROSCOPE_DISABLE, ++ RETRO_SENSOR_ILLUMINANCE_ENABLE, ++ RETRO_SENSOR_ILLUMINANCE_DISABLE, + + RETRO_SENSOR_DUMMY = INT_MAX + }; +@@ -1930,6 +2181,10 @@ enum retro_sensor_action + #define RETRO_SENSOR_ACCELEROMETER_X 0 + #define RETRO_SENSOR_ACCELEROMETER_Y 1 + #define RETRO_SENSOR_ACCELEROMETER_Z 2 ++#define RETRO_SENSOR_GYROSCOPE_X 3 ++#define RETRO_SENSOR_GYROSCOPE_Y 4 ++#define RETRO_SENSOR_GYROSCOPE_Z 5 ++#define RETRO_SENSOR_ILLUMINANCE 6 + + typedef bool (RETRO_CALLCONV *retro_set_sensor_state_t)(unsigned port, + enum retro_sensor_action action, unsigned rate); +@@ -2127,6 +2382,30 @@ struct retro_frame_time_callback + retro_usec_t reference; + }; + ++/* Notifies a libretro core of the current occupancy ++ * level of the frontend audio buffer. ++ * ++ * - active: 'true' if audio buffer is currently ++ * in use. Will be 'false' if audio is ++ * disabled in the frontend ++ * ++ * - occupancy: Given as a value in the range [0,100], ++ * corresponding to the occupancy percentage ++ * of the audio buffer ++ * ++ * - underrun_likely: 'true' if the frontend expects an ++ * audio buffer underrun during the ++ * next frame (indicates that a core ++ * should attempt frame skipping) ++ * ++ * It will be called right before retro_run() every frame. */ ++typedef void (RETRO_CALLCONV *retro_audio_buffer_status_callback_t)( ++ bool active, unsigned occupancy, bool underrun_likely); ++struct retro_audio_buffer_status_callback ++{ ++ retro_audio_buffer_status_callback_t callback; ++}; ++ + /* Pass this to retro_video_refresh_t if rendering to hardware. + * Passing NULL to retro_video_refresh_t is still a frame dupe as normal. + * */ +@@ -2287,7 +2566,8 @@ struct retro_keyboard_callback + retro_keyboard_event_t callback; + }; + +-/* Callbacks for RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE. ++/* Callbacks for RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE & ++ * RETRO_ENVIRONMENT_SET_DISK_CONTROL_EXT_INTERFACE. + * Should be set for implementations which can swap out multiple disk + * images in runtime. + * +@@ -2345,6 +2625,53 @@ typedef bool (RETRO_CALLCONV *retro_replace_image_index_t)(unsigned index, + * with replace_image_index. */ + typedef bool (RETRO_CALLCONV *retro_add_image_index_t)(void); + ++/* Sets initial image to insert in drive when calling ++ * core_load_game(). ++ * Since we cannot pass the initial index when loading ++ * content (this would require a major API change), this ++ * is set by the frontend *before* calling the core's ++ * retro_load_game()/retro_load_game_special() implementation. ++ * A core should therefore cache the index/path values and handle ++ * them inside retro_load_game()/retro_load_game_special(). ++ * - If 'index' is invalid (index >= get_num_images()), the ++ * core should ignore the set value and instead use 0 ++ * - 'path' is used purely for error checking - i.e. when ++ * content is loaded, the core should verify that the ++ * disk specified by 'index' has the specified file path. ++ * This is to guard against auto selecting the wrong image ++ * if (for example) the user should modify an existing M3U ++ * playlist. We have to let the core handle this because ++ * set_initial_image() must be called before loading content, ++ * i.e. the frontend cannot access image paths in advance ++ * and thus cannot perform the error check itself. ++ * If set path and content path do not match, the core should ++ * ignore the set 'index' value and instead use 0 ++ * Returns 'false' if index or 'path' are invalid, or core ++ * does not support this functionality ++ */ ++typedef bool (RETRO_CALLCONV *retro_set_initial_image_t)(unsigned index, const char *path); ++ ++/* Fetches the path of the specified disk image file. ++ * Returns 'false' if index is invalid (index >= get_num_images()) ++ * or path is otherwise unavailable. ++ */ ++typedef bool (RETRO_CALLCONV *retro_get_image_path_t)(unsigned index, char *path, size_t len); ++ ++/* Fetches a core-provided 'label' for the specified disk ++ * image file. In the simplest case this may be a file name ++ * (without extension), but for cores with more complex ++ * content requirements information may be provided to ++ * facilitate user disk swapping - for example, a core ++ * running floppy-disk-based content may uniquely label ++ * save disks, data disks, level disks, etc. with names ++ * corresponding to in-game disk change prompts (so the ++ * frontend can provide better user guidance than a 'dumb' ++ * disk index value). ++ * Returns 'false' if index is invalid (index >= get_num_images()) ++ * or label is otherwise unavailable. ++ */ ++typedef bool (RETRO_CALLCONV *retro_get_image_label_t)(unsigned index, char *label, size_t len); ++ + struct retro_disk_control_callback + { + retro_set_eject_state_t set_eject_state; +@@ -2358,6 +2685,27 @@ struct retro_disk_control_callback + retro_add_image_index_t add_image_index; + }; + ++struct retro_disk_control_ext_callback ++{ ++ retro_set_eject_state_t set_eject_state; ++ retro_get_eject_state_t get_eject_state; ++ ++ retro_get_image_index_t get_image_index; ++ retro_set_image_index_t set_image_index; ++ retro_get_num_images_t get_num_images; ++ ++ retro_replace_image_index_t replace_image_index; ++ retro_add_image_index_t add_image_index; ++ ++ /* NOTE: Frontend will only attempt to record/restore ++ * last used disk index if both set_initial_image() ++ * and get_image_path() are implemented */ ++ retro_set_initial_image_t set_initial_image; /* Optional - may be NULL */ ++ ++ retro_get_image_path_t get_image_path; /* Optional - may be NULL */ ++ retro_get_image_label_t get_image_label; /* Optional - may be NULL */ ++}; ++ + enum retro_pixel_format + { + /* 0RGB1555, native endian. +@@ -2388,6 +2736,104 @@ struct retro_message + unsigned frames; /* Duration in frames of message. */ + }; + ++enum retro_message_target ++{ ++ RETRO_MESSAGE_TARGET_ALL = 0, ++ RETRO_MESSAGE_TARGET_OSD, ++ RETRO_MESSAGE_TARGET_LOG ++}; ++ ++enum retro_message_type ++{ ++ RETRO_MESSAGE_TYPE_NOTIFICATION = 0, ++ RETRO_MESSAGE_TYPE_NOTIFICATION_ALT, ++ RETRO_MESSAGE_TYPE_STATUS, ++ RETRO_MESSAGE_TYPE_PROGRESS ++}; ++ ++struct retro_message_ext ++{ ++ /* Message string to be displayed/logged */ ++ const char *msg; ++ /* Duration (in ms) of message when targeting the OSD */ ++ unsigned duration; ++ /* Message priority when targeting the OSD ++ * > When multiple concurrent messages are sent to ++ * the frontend and the frontend does not have the ++ * capacity to display them all, messages with the ++ * *highest* priority value should be shown ++ * > There is no upper limit to a message priority ++ * value (within the bounds of the unsigned data type) ++ * > In the reference frontend (RetroArch), the same ++ * priority values are used for frontend-generated ++ * notifications, which are typically assigned values ++ * between 0 and 3 depending upon importance */ ++ unsigned priority; ++ /* Message logging level (info, warn, error, etc.) */ ++ enum retro_log_level level; ++ /* Message destination: OSD, logging interface or both */ ++ enum retro_message_target target; ++ /* Message 'type' when targeting the OSD ++ * > RETRO_MESSAGE_TYPE_NOTIFICATION: Specifies that a ++ * message should be handled in identical fashion to ++ * a standard frontend-generated notification ++ * > RETRO_MESSAGE_TYPE_NOTIFICATION_ALT: Specifies that ++ * message is a notification that requires user attention ++ * or action, but that it should be displayed in a manner ++ * that differs from standard frontend-generated notifications. ++ * This would typically correspond to messages that should be ++ * displayed immediately (independently from any internal ++ * frontend message queue), and/or which should be visually ++ * distinguishable from frontend-generated notifications. ++ * For example, a core may wish to inform the user of ++ * information related to a disk-change event. It is ++ * expected that the frontend itself may provide a ++ * notification in this case; if the core sends a ++ * message of type RETRO_MESSAGE_TYPE_NOTIFICATION, an ++ * uncomfortable 'double-notification' may occur. A message ++ * of RETRO_MESSAGE_TYPE_NOTIFICATION_ALT should therefore ++ * be presented such that visual conflict with regular ++ * notifications does not occur ++ * > RETRO_MESSAGE_TYPE_STATUS: Indicates that message ++ * is not a standard notification. This typically ++ * corresponds to 'status' indicators, such as a core's ++ * internal FPS, which are intended to be displayed ++ * either permanently while a core is running, or in ++ * a manner that does not suggest user attention or action ++ * is required. 'Status' type messages should therefore be ++ * displayed in a different on-screen location and in a manner ++ * easily distinguishable from both standard frontend-generated ++ * notifications and messages of type RETRO_MESSAGE_TYPE_NOTIFICATION_ALT ++ * > RETRO_MESSAGE_TYPE_PROGRESS: Indicates that message reports ++ * the progress of an internal core task. For example, in cases ++ * where a core itself handles the loading of content from a file, ++ * this may correspond to the percentage of the file that has been ++ * read. Alternatively, an audio/video playback core may use a ++ * message of type RETRO_MESSAGE_TYPE_PROGRESS to display the current ++ * playback position as a percentage of the runtime. 'Progress' type ++ * messages should therefore be displayed as a literal progress bar, ++ * where: ++ * - 'retro_message_ext.msg' is the progress bar title/label ++ * - 'retro_message_ext.progress' determines the length of ++ * the progress bar ++ * NOTE: Message type is a *hint*, and may be ignored ++ * by the frontend. If a frontend lacks support for ++ * displaying messages via alternate means than standard ++ * frontend-generated notifications, it will treat *all* ++ * messages as having the type RETRO_MESSAGE_TYPE_NOTIFICATION */ ++ enum retro_message_type type; ++ /* Task progress when targeting the OSD and message is ++ * of type RETRO_MESSAGE_TYPE_PROGRESS ++ * > -1: Unmetered/indeterminate ++ * > 0-100: Current progress percentage ++ * NOTE: Since message type is a hint, a frontend may ignore ++ * progress values. Where relevant, a core should therefore ++ * include progress percentage within the message string, ++ * such that the message intent remains clear when displayed ++ * as a standard frontend-generated notification */ ++ int8_t progress; ++}; ++ + /* Describes how the libretro implementation maps a libretro input bind + * to its internal input system through a human readable string. + * This string can be used to better let a user configure input. */ +@@ -2408,7 +2854,7 @@ struct retro_input_descriptor + struct retro_system_info + { + /* All pointers are owned by libretro implementation, and pointers must +- * remain valid until retro_deinit() is called. */ ++ * remain valid until it is unloaded. */ + + const char *library_name; /* Descriptive name of library. Should not + * contain any version numbers, etc. */ +@@ -2450,6 +2896,213 @@ struct retro_system_info + bool block_extract; + }; + ++/* Defines overrides which modify frontend handling of ++ * specific content file types. ++ * An array of retro_system_content_info_override is ++ * passed to RETRO_ENVIRONMENT_SET_CONTENT_INFO_OVERRIDE ++ * NOTE: In the following descriptions, references to ++ * retro_load_game() may be replaced with ++ * retro_load_game_special() */ ++struct retro_system_content_info_override ++{ ++ /* A list of file extensions for which the override ++ * should apply, delimited by a 'pipe' character ++ * (e.g. "md|sms|gg") ++ * Permitted file extensions are limited to those ++ * included in retro_system_info::valid_extensions ++ * and/or retro_subsystem_rom_info::valid_extensions */ ++ const char *extensions; ++ ++ /* Overrides the need_fullpath value set in ++ * retro_system_info and/or retro_subsystem_rom_info. ++ * To reiterate: ++ * ++ * If need_fullpath is true and retro_load_game() is called: ++ * - retro_game_info::path is guaranteed to contain a valid ++ * path to an existent file ++ * - retro_game_info::data and retro_game_info::size are invalid ++ * ++ * If need_fullpath is false and retro_load_game() is called: ++ * - retro_game_info::path may be NULL ++ * - retro_game_info::data and retro_game_info::size are guaranteed ++ * to be valid ++ * ++ * In addition: ++ * ++ * If need_fullpath is true and retro_load_game() is called: ++ * - retro_game_info_ext::full_path is guaranteed to contain a valid ++ * path to an existent file ++ * - retro_game_info_ext::archive_path may be NULL ++ * - retro_game_info_ext::archive_file may be NULL ++ * - retro_game_info_ext::dir is guaranteed to contain a valid path ++ * to the directory in which the content file exists ++ * - retro_game_info_ext::name is guaranteed to contain the ++ * basename of the content file, without extension ++ * - retro_game_info_ext::ext is guaranteed to contain the ++ * extension of the content file in lower case format ++ * - retro_game_info_ext::data and retro_game_info_ext::size ++ * are invalid ++ * ++ * If need_fullpath is false and retro_load_game() is called: ++ * - If retro_game_info_ext::file_in_archive is false: ++ * - retro_game_info_ext::full_path is guaranteed to contain ++ * a valid path to an existent file ++ * - retro_game_info_ext::archive_path may be NULL ++ * - retro_game_info_ext::archive_file may be NULL ++ * - retro_game_info_ext::dir is guaranteed to contain a ++ * valid path to the directory in which the content file exists ++ * - retro_game_info_ext::name is guaranteed to contain the ++ * basename of the content file, without extension ++ * - retro_game_info_ext::ext is guaranteed to contain the ++ * extension of the content file in lower case format ++ * - If retro_game_info_ext::file_in_archive is true: ++ * - retro_game_info_ext::full_path may be NULL ++ * - retro_game_info_ext::archive_path is guaranteed to ++ * contain a valid path to an existent compressed file ++ * inside which the content file is located ++ * - retro_game_info_ext::archive_file is guaranteed to ++ * contain a valid path to an existent content file ++ * inside the compressed file referred to by ++ * retro_game_info_ext::archive_path ++ * e.g. for a compressed file '/path/to/foo.zip' ++ * containing 'bar.sfc' ++ * > retro_game_info_ext::archive_path will be '/path/to/foo.zip' ++ * > retro_game_info_ext::archive_file will be 'bar.sfc' ++ * - retro_game_info_ext::dir is guaranteed to contain a ++ * valid path to the directory in which the compressed file ++ * (containing the content file) exists ++ * - retro_game_info_ext::name is guaranteed to contain ++ * EITHER ++ * 1) the basename of the compressed file (containing ++ * the content file), without extension ++ * OR ++ * 2) the basename of the content file inside the ++ * compressed file, without extension ++ * In either case, a core should consider 'name' to ++ * be the canonical name/ID of the the content file ++ * - retro_game_info_ext::ext is guaranteed to contain the ++ * extension of the content file inside the compressed file, ++ * in lower case format ++ * - retro_game_info_ext::data and retro_game_info_ext::size are ++ * guaranteed to be valid */ ++ bool need_fullpath; ++ ++ /* If need_fullpath is false, specifies whether the content ++ * data buffer available in retro_load_game() is 'persistent' ++ * ++ * If persistent_data is false and retro_load_game() is called: ++ * - retro_game_info::data and retro_game_info::size ++ * are valid only until retro_load_game() returns ++ * - retro_game_info_ext::data and retro_game_info_ext::size ++ * are valid only until retro_load_game() returns ++ * ++ * If persistent_data is true and retro_load_game() is called: ++ * - retro_game_info::data and retro_game_info::size ++ * are valid until retro_deinit() returns ++ * - retro_game_info_ext::data and retro_game_info_ext::size ++ * are valid until retro_deinit() returns */ ++ bool persistent_data; ++}; ++ ++/* Similar to retro_game_info, but provides extended ++ * information about the source content file and ++ * game memory buffer status. ++ * And array of retro_game_info_ext is returned by ++ * RETRO_ENVIRONMENT_GET_GAME_INFO_EXT ++ * NOTE: In the following descriptions, references to ++ * retro_load_game() may be replaced with ++ * retro_load_game_special() */ ++struct retro_game_info_ext ++{ ++ /* - If file_in_archive is false, contains a valid ++ * path to an existent content file (UTF-8 encoded) ++ * - If file_in_archive is true, may be NULL */ ++ const char *full_path; ++ ++ /* - If file_in_archive is false, may be NULL ++ * - If file_in_archive is true, contains a valid path ++ * to an existent compressed file inside which the ++ * content file is located (UTF-8 encoded) */ ++ const char *archive_path; ++ ++ /* - If file_in_archive is false, may be NULL ++ * - If file_in_archive is true, contain a valid path ++ * to an existent content file inside the compressed ++ * file referred to by archive_path (UTF-8 encoded) ++ * e.g. for a compressed file '/path/to/foo.zip' ++ * containing 'bar.sfc' ++ * > archive_path will be '/path/to/foo.zip' ++ * > archive_file will be 'bar.sfc' */ ++ const char *archive_file; ++ ++ /* - If file_in_archive is false, contains a valid path ++ * to the directory in which the content file exists ++ * (UTF-8 encoded) ++ * - If file_in_archive is true, contains a valid path ++ * to the directory in which the compressed file ++ * (containing the content file) exists (UTF-8 encoded) */ ++ const char *dir; ++ ++ /* Contains the canonical name/ID of the content file ++ * (UTF-8 encoded). Intended for use when identifying ++ * 'complementary' content named after the loaded file - ++ * i.e. companion data of a different format (a CD image ++ * required by a ROM), texture packs, internally handled ++ * save files, etc. ++ * - If file_in_archive is false, contains the basename ++ * of the content file, without extension ++ * - If file_in_archive is true, then string is ++ * implementation specific. A frontend may choose to ++ * set a name value of: ++ * EITHER ++ * 1) the basename of the compressed file (containing ++ * the content file), without extension ++ * OR ++ * 2) the basename of the content file inside the ++ * compressed file, without extension ++ * RetroArch sets the 'name' value according to (1). ++ * A frontend that supports routine loading of ++ * content from archives containing multiple unrelated ++ * content files may set the 'name' value according ++ * to (2). */ ++ const char *name; ++ ++ /* - If file_in_archive is false, contains the extension ++ * of the content file in lower case format ++ * - If file_in_archive is true, contains the extension ++ * of the content file inside the compressed file, ++ * in lower case format */ ++ const char *ext; ++ ++ /* String of implementation specific meta-data. */ ++ const char *meta; ++ ++ /* Memory buffer of loaded game content. Will be NULL: ++ * IF ++ * - retro_system_info::need_fullpath is true and ++ * retro_system_content_info_override::need_fullpath ++ * is unset ++ * OR ++ * - retro_system_content_info_override::need_fullpath ++ * is true */ ++ const void *data; ++ ++ /* Size of game content memory buffer, in bytes */ ++ size_t size; ++ ++ /* True if loaded content file is inside a compressed ++ * archive */ ++ bool file_in_archive; ++ ++ /* - If data is NULL, value is unset/ignored ++ * - If data is non-NULL: ++ * - If persistent_data is false, data and size are ++ * valid only until retro_load_game() returns ++ * - If persistent_data is true, data and size are ++ * are valid until retro_deinit() returns */ ++ bool persistent_data; ++}; ++ + struct retro_game_geometry + { + unsigned base_width; /* Nominal video width of game. */ +@@ -2607,6 +3260,47 @@ struct retro_framebuffer + Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER. */ + }; + ++/* Used by a libretro core to override the current ++ * fastforwarding mode of the frontend */ ++struct retro_fastforwarding_override ++{ ++ /* Specifies the runtime speed multiplier that ++ * will be applied when 'fastforward' is true. ++ * For example, a value of 5.0 when running 60 FPS ++ * content will cap the fast-forward rate at 300 FPS. ++ * Note that the target multiplier may not be achieved ++ * if the host hardware has insufficient processing ++ * power. ++ * Setting a value of 0.0 (or greater than 0.0 but ++ * less than 1.0) will result in an uncapped ++ * fast-forward rate (limited only by hardware ++ * capacity). ++ * If the value is negative, it will be ignored ++ * (i.e. the frontend will use a runtime speed ++ * multiplier of its own choosing) */ ++ float ratio; ++ ++ /* If true, fastforwarding mode will be enabled. ++ * If false, fastforwarding mode will be disabled. */ ++ bool fastforward; ++ ++ /* If true, and if supported by the frontend, an ++ * on-screen notification will be displayed while ++ * 'fastforward' is true. ++ * If false, and if supported by the frontend, any ++ * on-screen fast-forward notifications will be ++ * suppressed */ ++ bool notification; ++ ++ /* If true, the core will have sole control over ++ * when fastforwarding mode is enabled/disabled; ++ * the frontend will not be able to change the ++ * state set by 'fastforward' until either ++ * 'inhibit_toggle' is set to false, or the core ++ * is unloaded */ ++ bool inhibit_toggle; ++}; ++ + /* Callbacks */ + + /* Environment callback. Gives implementations a way of performing diff --git a/patches/snes9x2002/1001-audio-frameskip.patch b/patches/snes9x2002/1001-audio-frameskip.patch new file mode 100644 index 0000000..2154500 --- /dev/null +++ b/patches/snes9x2002/1001-audio-frameskip.patch @@ -0,0 +1,247 @@ +diff --git a/libretro/libretro.c b/libretro/libretro.c +index bc64376..b09354a 100644 +--- a/libretro/libretro.c ++++ b/libretro/libretro.c +@@ -96,6 +96,21 @@ bool8 ROMAPUEnabled = 0; + bool overclock_cycles = false; + int one_c, slow_one_c, two_c; + ++static unsigned frameskip_type = 0; ++static unsigned frameskip_threshold = 0; ++static uint16_t frameskip_counter = 0; ++static unsigned frameskip_interval = 0; ++ ++static bool retro_audio_buff_active = false; ++static unsigned retro_audio_buff_occupancy = 0; ++static bool retro_audio_buff_underrun = false; ++/* Maximum number of consecutive frames that ++ * can be skipped */ ++#define FRAMESKIP_MAX 30 ++ ++static unsigned retro_audio_latency = 0; ++static bool update_audio_latency = false; ++ + static memstream_t *s_stream = NULL; + + static int s_open(const char *fname, const char *mode) +@@ -208,6 +223,57 @@ void retro_get_system_info(struct retro_system_info *info) + info->block_extract = false; + } + ++static void retro_audio_buff_status_cb( ++ bool active, unsigned occupancy, bool underrun_likely) ++{ ++ retro_audio_buff_active = active; ++ retro_audio_buff_occupancy = occupancy; ++ retro_audio_buff_underrun = underrun_likely; ++} ++ ++static void retro_set_audio_buff_status_cb(void) ++{ ++ if (frameskip_type > 0) ++ { ++ struct retro_audio_buffer_status_callback buf_status_cb; ++ ++ buf_status_cb.callback = retro_audio_buff_status_cb; ++ if (!environ_cb(RETRO_ENVIRONMENT_SET_AUDIO_BUFFER_STATUS_CALLBACK, ++ &buf_status_cb)) ++ { ++ retro_audio_buff_active = false; ++ retro_audio_buff_occupancy = 0; ++ retro_audio_buff_underrun = false; ++ retro_audio_latency = 0; ++ } ++ else ++ { ++ /* Frameskip is enabled - increase frontend ++ * audio latency to minimise potential ++ * buffer underruns */ ++ uint32_t frame_time_usec = Settings.FrameTime; ++ ++ if (Settings.ForceNTSC) ++ frame_time_usec = Settings.FrameTimeNTSC; ++ if (Settings.ForcePAL) ++ frame_time_usec = Settings.FrameTimePAL; ++ ++ /* Set latency to 6x current frame time... */ ++ retro_audio_latency = (unsigned)(6 * frame_time_usec / 1000); ++ ++ /* ...then round up to nearest multiple of 32 */ ++ retro_audio_latency = (retro_audio_latency + 0x1F) & ~0x1F; ++ } ++ } ++ else ++ { ++ environ_cb(RETRO_ENVIRONMENT_SET_AUDIO_BUFFER_STATUS_CALLBACK, NULL); ++ retro_audio_latency = 0; ++ } ++ ++ update_audio_latency = true; ++} ++ + static int16 audio_buf[0x10000]; + static unsigned avail; + static float samplerate = 32040.5f; +@@ -339,6 +405,9 @@ void retro_init (void) + { + static const struct retro_variable vars[] = + { ++ { "snes9x2002_frameskip", "Frameskip ; disabled|auto|threshold" }, ++ { "snes9x2002_frameskip_threshold", "FS Threshold (%); 30|40|50|60" }, ++ { "snes9x2002_frameskip_interval", "FS Interval; 1|2|3|4|5|6|7|8|9" }, + { "snes9x2002_overclock_cycles", "Overclock (Restart); disabled|compatible|max" }, + { NULL, NULL }, + }; +@@ -383,6 +452,14 @@ void retro_deinit(void) + GFX.SubZBuffer_buffer = NULL; + + libretro_supports_bitmasks = false; ++ frameskip_type = 0; ++ frameskip_threshold = 0; ++ frameskip_counter = 0; ++ retro_audio_buff_active = false; ++ retro_audio_buff_occupancy = 0; ++ retro_audio_buff_underrun = false; ++ retro_audio_latency = 0; ++ update_audio_latency = false; + } + + void retro_reset (void) +@@ -423,9 +500,42 @@ static void report_buttons (void) + } + } + +-static void check_variables(void) ++static void check_variables(bool first_run) + { + struct retro_variable var; ++ bool prev_force_ntsc; ++ bool prev_force_pal; ++ bool prev_frameskip_type; ++ ++ var.key = "snes9x2002_frameskip"; ++ var.value = NULL; ++ ++ prev_frameskip_type = frameskip_type; ++ frameskip_type = 0; ++ ++ if (environ_cb(RETRO_ENVIRONMENT_GET_VARIABLE, &var) && var.value) ++ { ++ if (strcmp(var.value, "auto") == 0) ++ frameskip_type = 1; ++ if (strcmp(var.value, "threshold") == 0) ++ frameskip_type = 2; ++ } ++ ++ var.key = "snes9x2002_frameskip_threshold"; ++ var.value = NULL; ++ ++ frameskip_threshold = 30; ++ ++ if (environ_cb(RETRO_ENVIRONMENT_GET_VARIABLE, &var) && var.value) ++ frameskip_threshold = strtol(var.value, NULL, 10); ++ ++ var.key = "snes9x2002_frameskip_interval"; ++ var.value = NULL; ++ ++ frameskip_interval = 1; ++ ++ if (environ_cb(RETRO_ENVIRONMENT_GET_VARIABLE, &var) && var.value) ++ frameskip_interval = strtol(var.value, NULL, 10); + + var.key = "snes9x2002_overclock_cycles"; + var.value = NULL; +@@ -449,6 +559,13 @@ static void check_variables(void) + else + overclock_cycles = false; + } ++ ++ /* Reinitialise frameskipping, if required */ ++ if (!first_run && ++ ((frameskip_type != prev_frameskip_type) || ++ (Settings.ForceNTSC != prev_force_ntsc) || ++ (Settings.ForcePAL != prev_force_pal))) ++ retro_set_audio_buff_status_cb(); + } + + //#define FRAME_SKIP +@@ -458,7 +575,7 @@ void retro_run (void) + bool updated = false; + + if (environ_cb(RETRO_ENVIRONMENT_GET_VARIABLE_UPDATE, &updated) && updated) +- check_variables(); ++ check_variables(false); + + #ifdef FRAME_SKIP + IPPU.RenderThisFrame = !IPPU.RenderThisFrame; +@@ -466,6 +583,53 @@ void retro_run (void) + IPPU.RenderThisFrame = TRUE; + #endif + ++ /* Check whether current frame should ++ * be skipped */ ++ if ((frameskip_type > 0) && ++ retro_audio_buff_active && ++ IPPU.RenderThisFrame) ++ { ++ bool skip_frame; ++ ++ switch (frameskip_type) ++ { ++ case 1: /* auto */ ++ skip_frame = retro_audio_buff_underrun; ++ break; ++ case 2: /* threshold */ ++ skip_frame = (retro_audio_buff_occupancy < frameskip_threshold); ++ break; ++ default: ++ skip_frame = false; ++ break; ++ } ++ ++ if (skip_frame) ++ { ++ if(frameskip_counter < frameskip_interval) ++ { ++ IPPU.RenderThisFrame = false; ++ frameskip_counter++; ++ } ++ else ++ frameskip_counter = 0; ++ } ++ else ++ frameskip_counter = 0; ++ } ++ ++ /* If frameskip/timing settings have changed, ++ * update frontend audio latency ++ * > Can do this before or after the frameskip ++ * check, but doing it after means we at least ++ * retain the current frame's audio output */ ++ if (update_audio_latency) ++ { ++ environ_cb(RETRO_ENVIRONMENT_SET_MINIMUM_AUDIO_LATENCY, ++ &retro_audio_latency); ++ update_audio_latency = false; ++ } ++ + poll_cb(); + report_buttons(); + +@@ -559,7 +723,7 @@ bool retro_load_game(const struct retro_game_info *game) + bool8 loaded; + enum retro_pixel_format fmt = RETRO_PIXEL_FORMAT_RGB565; + +- check_variables(); ++ check_variables(true); + + if (!environ_cb(RETRO_ENVIRONMENT_SET_PIXEL_FORMAT, &fmt)) + return false; +@@ -585,6 +749,7 @@ bool retro_load_game(const struct retro_game_info *game) + + memset(audio_buf, 0, sizeof(audio_buf)); + ++ retro_set_audio_buff_status_cb(); + return true; + } + diff --git a/patches/snes9x2005/0001-trimui-support.patch b/patches/snes9x2005/0001-trimui-support.patch new file mode 100644 index 0000000..9424312 --- /dev/null +++ b/patches/snes9x2005/0001-trimui-support.patch @@ -0,0 +1,46 @@ +diff --git a/Makefile b/Makefile +index b293853..5704da3 100644 +--- a/Makefile ++++ b/Makefile +@@ -282,6 +282,20 @@ else ifeq ($(platform), gcw0) + FLAGS += -fomit-frame-pointer -ffast-math -march=mips32 -mtune=mips32r2 -mhard-float + FLAGS += -DFAST_LSB_WORD_ACCESS + ++else ifeq ($(platform), trimui) ++ TARGET := $(TARGET_NAME)_libretro.so ++ CC = $(CROSS_COMPILE)gcc ++ AR = $(CROSS_COMPILE)ar ++ SHARED := -shared -Wl,--version-script=link.T -Wl,--no-undefined ++ CFLAGS += -fsingle-precision-constant -fno-PIC -flto ++ CFLAGS += -DLSB_FIRST -DFAST_ALIGNED_LSB_WORD_ACCESS -DRIGHTSHIFT_IS_SAR ++ CFLAGS += -std=c99 -fomit-frame-pointer -ffast-math -mcpu=arm926ej-s -mtune=arm926ej-s ++ LDFLAGS += -flto ++ OPTIMIZE += -Ofast -DNDEBUG=1 ++ ifeq (,$(DEBUG)) ++ LDFLAGS += -s ++ endif ++ + # (armv7 a7, hard point, neon based) ### + # NESC, SNESC, C64 mini + else ifeq ($(platform), classic_armv7_a7) +@@ -570,10 +584,20 @@ endif + + ifeq ($(DEBUG),1) + FLAGS += -O0 -g ++else ifneq (,$(OPTIMIZE)) ++ FLAGS += $(OPTIMIZE) + else + FLAGS += -O2 -DNDEBUG + endif + ++ ++ifeq ($(PROFILE), GENERATE) ++ CFLAGS += -fprofile-generate=./profile/snes9x2005 ++ LDFLAGS += -lgcov ++else ifeq ($(PROFILE), APPLY) ++ CFLAGS += -fprofile-use -fprofile-dir=../profile/snes9x2005 -fbranch-probabilities ++endif ++ + ifneq (,$(findstring msvc,$(platform))) + ifeq ($(DEBUG),1) + FLAGS += -MTd diff --git a/patches/snes9x2005/0002-core-options.patch b/patches/snes9x2005/0002-core-options.patch new file mode 100644 index 0000000..8fea741 --- /dev/null +++ b/patches/snes9x2005/0002-core-options.patch @@ -0,0 +1,64 @@ +diff --git a/libretro_core_options.h b/libretro_core_options.h +index 032cefd..63e17ae 100644 +--- a/libretro_core_options.h ++++ b/libretro_core_options.h +@@ -57,7 +57,9 @@ struct retro_core_option_definition option_defs_us[] = { + { + "catsfc_VideoMode", + "Console Region", +- "Specify which region the system is from. 'PAL' is 50hz, 'NTSC' is 60hz. Games will run faster or slower than normal if the incorrect region is selected.", ++ "'PAL' is 50hz, 'NTSC' is 60hz. Games will run\n" ++ "faster or slower than normal if the incorrect\n" ++ "region is selected.", + { + { "auto", "Auto" }, + { "NTSC", NULL }, +@@ -69,19 +71,22 @@ struct retro_core_option_definition option_defs_us[] = { + { + "catsfc_frameskip", + "Frameskip", +- "Skip frames to avoid audio buffer under-run (crackling). Improves performance at the expense of visual smoothness. 'Auto' skips frames when advised by the frontend. 'Manual' utilises the 'Frameskip Threshold (%)' setting.", ++ "Skip frames to avoid audio crackling. Improves\n" ++ "performance at the expense of visual smoothness.", + { + { "disabled", NULL }, + { "auto", "Auto" }, + { "manual", "Manual" }, + { NULL, NULL }, + }, +- "disabled" ++ "auto" + }, + { + "catsfc_frameskip_threshold", +- "Frameskip Threshold (%)", +- "When 'Frameskip' is set to 'Manual', specifies the audio buffer occupancy threshold (percentage) below which frames will be skipped. Higher values reduce the risk of crackling by causing frames to be dropped more frequently.", ++ "FS Threshold (%)", ++ "When 'Frameskip' is set to 'Threshold', sets\n" ++ "how low the audio buffer can get before frames\n" ++ "will be skipped.", + { + { "15", NULL }, + { "18", NULL }, +@@ -105,8 +110,10 @@ struct retro_core_option_definition option_defs_us[] = { + }, + { + "catsfc_overclock_cycles", +- "Reduce Slowdown (Hack, Unsafe, Restart)", +- "Many games for the SNES suffered from slowdown due to the weak main CPU. This option helps allievate that at the cost of possible bugs. COMPATIBLE: Reduce slowdown but keep as much game compatibility as much as possible. MAX: Reduce slowdown as much as possible but will break more games.", ++ "Overclock (Restart)", ++ "Alleviate normal SNES slowdown. Compatible keeps\n" ++ "as much compatibility as possible. Max will reduce\n" ++ "more slowdown but break more games.", + { + { "disabled", NULL }, + { "compatible", "Compatible" }, +@@ -117,7 +124,7 @@ struct retro_core_option_definition option_defs_us[] = { + }, + { + "catsfc_reduce_sprite_flicker", +- "Reduce Flickering (Hack, Unsafe)", ++ "Reduce Flicker", + "Raises sprite limit to reduce flickering in games.", + { + { "disabled", NULL }, diff --git a/patches/snes9x2005/1000-frameskip-interval.patch b/patches/snes9x2005/1000-frameskip-interval.patch new file mode 100644 index 0000000..a0b6ef0 --- /dev/null +++ b/patches/snes9x2005/1000-frameskip-interval.patch @@ -0,0 +1,105 @@ +diff --git a/libretro.c b/libretro.c +index c368d8f..f4675ed 100644 +--- a/libretro.c ++++ b/libretro.c +@@ -57,13 +57,11 @@ static int32_t samplerate = (((SNES_CLOCK_SPEED * 6) / (32 * ONE_APU_CYCLE))); + static unsigned frameskip_type = 0; + static unsigned frameskip_threshold = 0; + static uint16_t frameskip_counter = 0; ++static unsigned frameskip_interval = 0; + + static bool retro_audio_buff_active = false; + static unsigned retro_audio_buff_occupancy = 0; + static bool retro_audio_buff_underrun = false; +-/* Maximum number of consecutive frames that +- * can be skipped */ +-#define FRAMESKIP_MAX 30 + + static unsigned retro_audio_latency = 0; + static bool update_audio_latency = false; +@@ -341,6 +339,7 @@ void retro_deinit(void) + frameskip_type = 0; + frameskip_threshold = 0; + frameskip_counter = 0; ++ frameskip_interval = 0; + retro_audio_buff_active = false; + retro_audio_buff_occupancy = 0; + retro_audio_buff_underrun = false; +@@ -414,7 +413,7 @@ static void check_variables(bool first_run) + { + if (strcmp(var.value, "auto") == 0) + frameskip_type = 1; +- else if (strcmp(var.value, "manual") == 0) ++ else if (strcmp(var.value, "auto_threshold") == 0) + frameskip_type = 2; + } + +@@ -426,6 +425,14 @@ static void check_variables(bool first_run) + if (environ_cb(RETRO_ENVIRONMENT_GET_VARIABLE, &var) && var.value) + frameskip_threshold = strtol(var.value, NULL, 10); + ++ var.key = "catsfc_frameskip_interval"; ++ var.value = NULL; ++ ++ frameskip_interval = 4; ++ ++ if (environ_cb(RETRO_ENVIRONMENT_GET_VARIABLE, &var) && var.value) ++ frameskip_interval = strtol(var.value, NULL, 10); ++ + var.key = "catsfc_overclock_cycles"; + var.value = NULL; + +@@ -531,7 +538,7 @@ void retro_run(void) + + if (skip_frame) + { +- if(frameskip_counter < FRAMESKIP_MAX) ++ if(frameskip_counter < frameskip_interval) + { + IPPU.RenderThisFrame = false; + frameskip_counter++; +diff --git a/libretro_core_options.h b/libretro_core_options.h +index 8620a4a..dc79a38 100644 +--- a/libretro_core_options.h ++++ b/libretro_core_options.h +@@ -74,9 +74,9 @@ struct retro_core_option_definition option_defs_us[] = { + "Skip frames to avoid audio crackling. Improves\n" + "performance at the expense of visual smoothness.", + { +- { "disabled", NULL }, +- { "auto", "Auto" }, +- { "manual", "Manual" }, ++ { "disabled", NULL }, ++ { "auto", "Auto" }, ++ { "auto_threshold", "Threshold" }, + { NULL, NULL }, + }, + "auto" +@@ -108,6 +108,27 @@ struct retro_core_option_definition option_defs_us[] = { + }, + "33" + }, ++ { ++ "catsfc_frameskip_interval", ++ "FS Interval", ++ "The maximum number of frames that can be skipped\n" ++ "before a new frame is rendered.", ++ { ++ { "0", NULL }, ++ { "1", NULL }, ++ { "2", NULL }, ++ { "3", NULL }, ++ { "4", NULL }, ++ { "5", NULL }, ++ { "6", NULL }, ++ { "7", NULL }, ++ { "8", NULL }, ++ { "9", NULL }, ++ { "10", NULL }, ++ { NULL, NULL }, ++ }, ++ "4" ++ }, + { + "catsfc_overclock_cycles", + "Overclock (Restart)", @@ -0,0 +1,28 @@ +#ifndef __PLAT_H__ +#define __PLAT_H__ + +#include "libpicofe/plat.h" + +struct audio_frame { + int16_t left; + int16_t right; +}; + +#define HUD_LEN 39 + +int plat_init(void); +void plat_finish(void); +void plat_minimize(void); +void *plat_prepare_screenshot(int *w, int *h, int *bpp); + +void plat_video_open(void); +void plat_video_set_msg(const char *new_msg); +void plat_video_process(const void *data, unsigned width, unsigned height, size_t pitch); +void plat_video_flip(void); +void plat_video_close(void); + +float plat_sound_capacity(void); +void plat_sound_write(const struct audio_frame *data, int frames); +void plat_sound_resize_buffer(void); + +#endif /* __PLAT_H__ */ diff --git a/plat_linux.c b/plat_linux.c new file mode 100644 index 0000000..bce33ab --- /dev/null +++ b/plat_linux.c @@ -0,0 +1,64 @@ +#include <SDL/SDL.h> +#include "main.h" +#include "libretro.h" +#include "libpicofe/plat.h" +#include "libpicofe/input.h" +#include "libpicofe/in_sdl.h" + +#define SAMPLE_RATE 48000 + +static const struct in_default_bind in_sdl_defbinds[] = { + { SDLK_UP, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_UP }, + { SDLK_DOWN, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_DOWN }, + { SDLK_LEFT, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_LEFT }, + { SDLK_RIGHT, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_RIGHT }, + { SDLK_LCTRL, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_B }, + { SDLK_SPACE, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_A }, + { SDLK_LSHIFT, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_X }, + { SDLK_LALT, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_Y }, + { SDLK_RETURN, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_START }, + { SDLK_RCTRL, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_SELECT }, + { SDLK_TAB, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_L }, + { SDLK_BACKSPACE, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_R }, + { SDLK_q, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_L2 }, + { SDLK_BACKSLASH, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_R2 }, + { SDLK_ESCAPE, IN_BINDTYPE_EMU, EACTION_MENU }, + { 0, 0, 0 } +}; + +const struct menu_keymap in_sdl_key_map[] = +{ + { SDLK_UP, PBTN_UP }, + { SDLK_DOWN, PBTN_DOWN }, + { SDLK_LEFT, PBTN_LEFT }, + { SDLK_RIGHT, PBTN_RIGHT }, + { SDLK_SPACE, PBTN_MOK }, + { SDLK_LCTRL, PBTN_MBACK }, + { SDLK_LALT, PBTN_MA2 }, + { SDLK_LSHIFT, PBTN_MA3 }, + { SDLK_TAB, PBTN_L }, + { SDLK_BACKSPACE, PBTN_R }, + { SDLK_ESCAPE, PBTN_MENU }, +}; + +const struct menu_keymap in_sdl_joy_map[] = +{ + { SDLK_UP, PBTN_UP }, + { SDLK_DOWN, PBTN_DOWN }, + { SDLK_LEFT, PBTN_LEFT }, + { SDLK_RIGHT, PBTN_RIGHT }, + { SDLK_WORLD_0, PBTN_MOK }, + { SDLK_WORLD_1, PBTN_MBACK }, + { SDLK_WORLD_2, PBTN_MA2 }, + { SDLK_WORLD_3, PBTN_MA3 }, +}; + +static const struct in_pdata in_sdl_platform_data = { + .defbinds = in_sdl_defbinds, + .key_map = in_sdl_key_map, + .kmap_size = array_size(in_sdl_key_map), + .joy_map = in_sdl_joy_map, + .jmap_size = array_size(in_sdl_joy_map), +}; + +#include "plat_sdl.c" diff --git a/plat_sdl.c b/plat_sdl.c new file mode 100644 index 0000000..7223a0d --- /dev/null +++ b/plat_sdl.c @@ -0,0 +1,277 @@ +#include <SDL/SDL.h> +#include "core.h" +#include "libpicofe/fonts.h" +#include "libpicofe/menu.h" +#include "libpicofe/plat.h" +#include "plat.h" +#include "scale.h" + +static SDL_Surface* screen; + +struct audio_state { + int buf_w; + int max_buf_w; + int buf_r; + size_t buf_len; + struct audio_frame *buf; + int freq; + int in_sample_rate; + int out_sample_rate; +}; + +struct audio_state audio; + +static char msg[HUD_LEN]; + +static void video_clear_msg(uint16_t *dst, uint32_t h, uint32_t pitch) +{ + memset(dst + (h - 10) * pitch, 0, 10 * pitch * sizeof(uint16_t)); +} + +static void video_print_msg(uint16_t *dst, uint32_t h, uint32_t pitch, char *msg) +{ + basic_text_out16_nf(dst, pitch, 2, h - 10, msg); +} + +static int audio_resample_nearest(struct audio_frame data) { + static int diff = 0; + int consumed = 0; + + if (diff <= 0) { + audio.buf[audio.buf_w++] = data; + if (audio.buf_w >= audio.buf_len) audio.buf_w = 0; + + diff += audio.in_sample_rate; + } + + if (diff > 0) { + consumed++; + diff -= audio.out_sample_rate; + } + + return consumed; +} + +static void *fb_flip(void) +{ + SDL_Flip(screen); + return screen->pixels; +} + +void plat_video_menu_enter(int is_rom_loaded) +{ +} + +void plat_video_menu_begin(void) +{ + g_menuscreen_ptr = fb_flip(); +} + +void plat_video_menu_end(void) +{ + g_menuscreen_ptr = fb_flip(); +} + +void plat_video_menu_leave(void) +{ + SDL_LockSurface(screen); + memset(g_menuscreen_ptr, 0, SCREEN_WIDTH * SCREEN_HEIGHT * SCREEN_BPP); + SDL_UnlockSurface(screen); + g_menuscreen_ptr = fb_flip(); + SDL_LockSurface(screen); + memset(g_menuscreen_ptr, 0, SCREEN_WIDTH * SCREEN_HEIGHT * SCREEN_BPP); + SDL_UnlockSurface(screen); +} + +void plat_video_open(void) +{ +} + +void plat_video_set_msg(const char *new_msg) +{ + snprintf(msg, HUD_LEN, "%s", new_msg); +} + +void plat_video_process(const void *data, unsigned width, unsigned height, size_t pitch) { + SDL_LockSurface(screen); + + if (msg[0]) + video_clear_msg(screen->pixels, screen->h, screen->pitch / SCREEN_BPP); + + scale(width, height, pitch, data, screen->pixels); + + if (msg[0]) + video_print_msg(screen->pixels, screen->h, screen->pitch / SCREEN_BPP, msg); + + SDL_UnlockSurface(screen); +} + +void plat_video_flip(void) +{ + g_menuscreen_ptr = fb_flip(); + msg[0] = 0; +} + +void plat_video_close(void) +{ +} + +static void plat_sound_callback(void *unused, uint8_t *stream, int len) +{ + int16_t *p = (int16_t *)stream; + len /= (sizeof(int16_t) * 2); + + while (audio.buf_r != audio.buf_w && len > 0) { + *p++ = audio.buf[audio.buf_r].left; + *p++ = audio.buf[audio.buf_r].right; + audio.max_buf_w = audio.buf_r; + + len--; + audio.buf_r++; + + if (audio.buf_r >= audio.buf_len) audio.buf_r = 0; + } + + while(len > 0) { + *p++ = 0; + --len; + } +} + +static void plat_sound_finish(void) +{ + SDL_PauseAudio(1); + SDL_CloseAudio(); + if (audio.buf) { + free(audio.buf); + audio.buf = NULL; + } +} + +static int plat_sound_init(void) +{ + if (SDL_InitSubSystem(SDL_INIT_AUDIO)) { + return -1; + } + + SDL_AudioSpec spec, received; + + spec.freq = SAMPLE_RATE; + spec.format = AUDIO_S16; + spec.channels = 2; + spec.samples = 512; + spec.callback = plat_sound_callback; + + if (SDL_OpenAudio(&spec, &received) < 0) { + plat_sound_finish(); + return -1; + } + + audio.in_sample_rate = sample_rate; + audio.out_sample_rate = received.freq; + plat_sound_resize_buffer(); + + SDL_PauseAudio(0); + return 0; +} + +float plat_sound_capacity(void) +{ + int buffered = 0; + if (audio.buf_w != audio.buf_r) { + buffered = audio.buf_w > audio.buf_r ? + audio.buf_w - audio.buf_r : + (audio.buf_w + audio.buf_len) - audio.buf_r; + } + + return 1.0 - (float)buffered / audio.buf_len; +} + +#define BATCH_SIZE 100 +void plat_sound_write(const struct audio_frame *data, int frames) +{ + int consumed = 0; + SDL_LockAudio(); + + while (frames > 0) { + int tries = 0; + int amount = MIN(BATCH_SIZE, frames); + + while (tries < 10 && audio.buf_w == audio.max_buf_w) { + tries++; + SDL_UnlockAudio(); + + if (!limit_frames) + return; + + plat_sleep_ms(1); + SDL_LockAudio(); + } + + while (amount && audio.buf_w != audio.max_buf_w) { + consumed = audio_resample_nearest(*data); + data += consumed; + amount -= consumed; + frames -= consumed; + } + } + SDL_UnlockAudio(); +} + +void plat_sound_resize_buffer(void) { + size_t buf_size; + audio.buf_len = current_audio_buffer_size * audio.in_sample_rate / frame_rate; + buf_size = audio.buf_len * sizeof(struct audio_frame); + audio.buf = realloc(audio.buf, buf_size); + + if (!audio.buf) { + PA_ERROR("Error initializing sound buffer\n"); + plat_sound_finish(); + return; + } + + memset(audio.buf, 0, buf_size); + audio.buf_w = 0; + audio.buf_r = 0; + audio.max_buf_w = audio.buf_len - 1; +} + +void plat_sdl_event_handler(void *event_) +{ +} + +int plat_init(void) +{ + SDL_Init(SDL_INIT_VIDEO); + screen = SDL_SetVideoMode(SCREEN_WIDTH, SCREEN_HEIGHT, SCREEN_BPP * 8, SDL_SWSURFACE); + + if (screen == NULL) { + PA_ERROR("%s, failed to set video mode\n", __func__); + return -1; + } + + SDL_ShowCursor(0); + + g_menuscreen_w = SCREEN_WIDTH; + g_menuscreen_h = SCREEN_HEIGHT; + g_menuscreen_pp = SCREEN_WIDTH; + g_menuscreen_ptr = fb_flip(); + + if (in_sdl_init(&in_sdl_platform_data, plat_sdl_event_handler)) { + PA_ERROR("SDL input failed to init: %s\n", SDL_GetError()); + return -1; + } + in_probe(); + + if (plat_sound_init()) { + PA_ERROR("SDL sound failed to init: %s\n", SDL_GetError()); + return -1; + } + return 0; +} + +void plat_finish(void) +{ + plat_sound_finish(); + SDL_Quit(); +} diff --git a/plat_trimui.c b/plat_trimui.c new file mode 100644 index 0000000..c91a416 --- /dev/null +++ b/plat_trimui.c @@ -0,0 +1,81 @@ +#include <SDL/SDL.h> +#include "main.h" +#include "libretro.h" +#include "libpicofe/plat.h" +#include "libpicofe/input.h" +#include "libpicofe/in_sdl.h" + +#define SAMPLE_RATE 48000 + +static const struct in_default_bind in_sdl_defbinds[] = { + { SDLK_UP, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_UP }, + { SDLK_DOWN, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_DOWN }, + { SDLK_LEFT, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_LEFT }, + { SDLK_RIGHT, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_RIGHT }, + { SDLK_LCTRL, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_B }, + { SDLK_SPACE, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_A }, + { SDLK_LSHIFT, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_X }, + { SDLK_LALT, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_Y }, + { SDLK_RETURN, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_START }, + { SDLK_RCTRL, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_SELECT }, + { SDLK_TAB, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_L }, + { SDLK_BACKSPACE, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_R }, + { SDLK_q, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_L2 }, + { SDLK_BACKSLASH, IN_BINDTYPE_PLAYER12, RETRO_DEVICE_ID_JOYPAD_R2 }, + { SDLK_ESCAPE, IN_BINDTYPE_EMU, EACTION_MENU }, + { 0, 0, 0 } +}; + +const struct menu_keymap in_sdl_key_map[] = +{ + { SDLK_UP, PBTN_UP }, + { SDLK_DOWN, PBTN_DOWN }, + { SDLK_LEFT, PBTN_LEFT }, + { SDLK_RIGHT, PBTN_RIGHT }, + { SDLK_SPACE, PBTN_MOK }, + { SDLK_LCTRL, PBTN_MBACK }, + { SDLK_LALT, PBTN_MA2 }, + { SDLK_LSHIFT, PBTN_MA3 }, + { SDLK_TAB, PBTN_L }, + { SDLK_BACKSPACE, PBTN_R }, + { SDLK_ESCAPE, PBTN_MENU }, +}; + +const struct menu_keymap in_sdl_joy_map[] = +{ + { SDLK_UP, PBTN_UP }, + { SDLK_DOWN, PBTN_DOWN }, + { SDLK_LEFT, PBTN_LEFT }, + { SDLK_RIGHT, PBTN_RIGHT }, + { SDLK_WORLD_0, PBTN_MOK }, + { SDLK_WORLD_1, PBTN_MBACK }, + { SDLK_WORLD_2, PBTN_MA2 }, + { SDLK_WORLD_3, PBTN_MA3 }, +}; + +static const char * const in_sdl_key_names[SDLK_LAST] = { + [SDLK_UP] = "up", + [SDLK_DOWN] = "down", + [SDLK_LEFT] = "left", + [SDLK_RIGHT] = "right", + [SDLK_LSHIFT] = "x", + [SDLK_LCTRL] = "b", + [SDLK_SPACE] = "a", + [SDLK_LALT] = "y", + [SDLK_RETURN] = "start", + [SDLK_RCTRL] = "select", + [SDLK_TAB] = "l", + [SDLK_BACKSPACE] = "r", + [SDLK_ESCAPE] = "menu", +}; + +static const struct in_pdata in_sdl_platform_data = { + .defbinds = in_sdl_defbinds, + .key_map = in_sdl_key_map, + .kmap_size = array_size(in_sdl_key_map), + .joy_map = in_sdl_joy_map, + .jmap_size = array_size(in_sdl_joy_map), + .key_names = in_sdl_key_names, +}; + +#include "plat_sdl.c" @@ -0,0 +1,909 @@ +#include <string.h> +#include "core.h" +#include "options.h" +#include "scale.h" + +#define prefetch(a,b) __builtin_prefetch(a,b) +#define likely(x) __builtin_expect((x),1) +#define unlikely(x) __builtin_expect((x),0) + +typedef void (*scaler_t)(unsigned w, unsigned h, size_t pitch, const void *src, void *dst); + +struct dimensions { + unsigned w; + unsigned h; + size_t pitch; +}; + +static scaler_t scaler; +static unsigned dst_w, dst_h, dst_offs; +struct dimensions prev; + +static void scale_memcpy(unsigned w, unsigned h, size_t pitch, const void *src, void *dst) { + dst += dst_offs; + memcpy(dst, src, h * pitch); +} + +static void scale_1x(unsigned w, unsigned h, size_t pitch, const void *src, void *dst) { + dst += dst_offs; + + for (int y = 0; y < h; y++) { + memcpy(dst + y * SCREEN_PITCH, src + y * pitch, pitch); + } +} + +static void scale_nearest(unsigned w, unsigned h, size_t pitch, const void *src_bytes, void *dst_bytes) { + const uint16_t *src = (const uint16_t *)src_bytes; + uint16_t *dst = (uint16_t *)dst_bytes; + int dy = -(dst_h / 2); + unsigned lines = 0; + + dst += dst_offs / sizeof(dst[0]); + + while (lines < h) { + int dx = -(dst_w / 2); + const uint16_t *psrc = src; + uint16_t *pdst = dst; + bool copy = false; + + if (copy) { + copy = false; + memcpy(dst, dst - SCREEN_PITCH / sizeof(dst[0]), SCREEN_PITCH); + } else if (dy <= 0) { + while (psrc - src < w) { + if (dx <= 0) { + *pdst++ = *psrc; + dx += w; + } + + if (dx > 0) { + psrc++; + dx -= dst_w; + } + } + } + + if (dy <= 0) { + dy += h; + dst += SCREEN_PITCH / sizeof(dst[0]); + } + + if (dy > 0) { + dy -= dst_h; + src += pitch / sizeof(src[0]); + lines++; + } else { + copy = true; + } + } +} + +/* drowsnug's nofilter upscaler, edited by eggs for smoothness */ +#define AVERAGE16(c1, c2) (((c1) + (c2) + (((c1) ^ (c2)) & 0x0821))>>1) //More accurate +static void scale_sharp_240x160_320xXXX(unsigned _w, unsigned _h, size_t _pitch, const void *src_bytes, void *dst_bytes) +{ + int Eh = 0; + int dh = 0; + int width = 240; + int vf = 0; + const uint16_t *src = (const uint16_t *)src_bytes; + uint16_t *dst = (uint16_t *)dst_bytes; + + dst += dst_offs / sizeof(uint16_t); + + int x, y; + for (y = 0; y < dst_h; y++) + { + int source = dh * width; + for (x = 0; x < 320/4; x++) + { + register uint16_t a, b, c; + + a = src[source]; + b = src[source+1]; + c = src[source+2]; + + if(vf == 1){ + a = AVERAGE16(a, src[source+width]); + b = AVERAGE16(b, src[source+width+1]); + c = AVERAGE16(c, src[source+width+2]); + } + + *dst++ = a; + *dst++ = AVERAGE16(AVERAGE16(a,b),b); + *dst++ = AVERAGE16(b,AVERAGE16(b,c)); + *dst++ = c; + source+=3; + + } + Eh += 160; + if(Eh >= dst_h) { + Eh -= dst_h; + dh++; + vf = 0; + } + else + vf = 1; + } +} + +static void scale_sharp_256xXXX_320xXXX(unsigned w, unsigned h, size_t pitch, const void *src_bytes, void *dst_bytes) +{ + int Eh = 0; + int dh = 0; + int vf = 0; + const uint16_t *src = (const uint16_t *)src_bytes; + uint16_t *dst = (uint16_t *)dst_bytes; + size_t pxpitch = pitch / 2; + + dst += dst_offs / sizeof(uint16_t); + + int x, y; + for (y = 0; y < dst_h; y++) + { + int source = dh * pxpitch; + for (x = 0; x < 320/5; x++) + { + register uint16_t a, b, c, d; + + a = src[source]; + b = src[source+1]; + c = src[source+2]; + d = src[source+3]; + + if(vf == 1){ + a = AVERAGE16(a, src[source+pxpitch]); + b = AVERAGE16(b, src[source+pxpitch+1]); + c = AVERAGE16(c, src[source+pxpitch+2]); + d = AVERAGE16(d, src[source+pxpitch+3]); + } + + *dst++ = a; + *dst++ = AVERAGE16(AVERAGE16(a,b),b); + *dst++ = AVERAGE16(b,c); + *dst++ = AVERAGE16(c,AVERAGE16(c,d)); + *dst++ = d; + source+=4; + + } + Eh += h; + if(Eh >= dst_h) { + Eh -= dst_h; + dh++; + vf = 0; + } + else + vf = 1; + } +} + +/* gpsp-bittboy bilinear scalers https://github.com/retrofirmware/gpsp-bittboy */ + +#define Average(A, B) ((((A) & 0xF7DE) >> 1) + (((B) & 0xF7DE) >> 1) + ((A) & (B) & 0x0821)) + +/* Calculates the average of two pairs of RGB565 pixels. The result is, in + * the lower bits, the average of both lower pixels, and in the upper bits, + * the average of both upper pixels. */ +#define Average32(A, B) ((((A) & 0xF7DEF7DE) >> 1) + (((B) & 0xF7DEF7DE) >> 1) + ((A) & (B) & 0x08210821)) + +/* Raises a pixel from the lower half to the upper half of a pair. */ +#define Raise(N) ((N) << 16) + +/* Extracts the upper pixel of a pair into the lower pixel of a pair. */ +#define Hi(N) ((N) >> 16) + +/* Extracts the lower pixel of a pair. */ +#define Lo(N) ((N) & 0xFFFF) + +/* Calculates the average of two RGB565 pixels. The source of the pixels is + * the lower 16 bits of both parameters. The result is in the lower 16 bits. + * The average is weighted so that the first pixel contributes 3/4 of its + * color and the second pixel contributes 1/4. */ +#define AverageQuarters3_1(A, B) ( (((A) & 0xF7DE) >> 1) + (((A) & 0xE79C) >> 2) + (((B) & 0xE79C) >> 2) + ((( (( ((A) & 0x1863) + ((A) & 0x0821) ) << 1) + ((B) & 0x1863) ) >> 2) & 0x1863) ) + +static inline void scale_bilinearish_240x160_320x240(unsigned src_x, unsigned src_y, size_t src_pitch, const void *src, void *dst) +{ + /* Before: + * a b c d e f + * g h i j k l + * + * After (multiple letters = average): + * a ab bc c d de ef f + * ag abgh bchi ci dj dejk efkl fl + * g gh hi i j jk kl l + */ + uint16_t *to = (uint16_t *)dst; + const uint16_t *from = (const uint16_t *)src; + const uint32_t dst_pitch = SCREEN_PITCH; + + const uint32_t dst_x = src_x * 4 / 3; + const uint32_t src_skip = src_pitch - src_x * sizeof(uint16_t), + dst_skip = dst_pitch - dst_x * sizeof(uint16_t); + + uint32_t x, y; + + for (y = 0; y < src_y; y += 2) { + for (x = 0; x < src_x / 6; x++) { + // -- Row 1 -- + // Read RGB565 elements in the source grid. + // The notation is high_low (little-endian). + uint32_t b_a = (*(uint32_t*) (from )), + d_c = (*(uint32_t*) (from + 2)), + f_e = (*(uint32_t*) (from + 4)); + + // Generate ab_a from b_a. + *(uint32_t*) (to) = likely(Hi(b_a) == Lo(b_a)) + ? b_a + : Lo(b_a) /* 'a' verbatim to low pixel */ | + Raise(Average(Hi(b_a), Lo(b_a))) /* ba to high pixel */; + + // Generate c_bc from b_a and d_c. + *(uint32_t*) (to + 2) = likely(Hi(b_a) == Lo(d_c)) + ? Lo(d_c) | Raise(Lo(d_c)) + : Raise(Lo(d_c)) /* 'c' verbatim to high pixel */ | + Average(Lo(d_c), Hi(b_a)) /* bc to low pixel */; + + // Generate de_d from d_c and f_e. + *(uint32_t*) (to + 4) = likely(Hi(d_c) == Lo(f_e)) + ? Lo(f_e) | Raise(Lo(f_e)) + : Hi(d_c) /* 'd' verbatim to low pixel */ | + Raise(Average(Lo(f_e), Hi(d_c))) /* de to high pixel */; + + // Generate f_ef from f_e. + *(uint32_t*) (to + 6) = likely(Hi(f_e) == Lo(f_e)) + ? f_e + : Raise(Hi(f_e)) /* 'f' verbatim to high pixel */ | + Average(Hi(f_e), Lo(f_e)) /* ef to low pixel */; + + if (likely(y + 1 < src_y)) // Is there a source row 2? + { + // -- Row 2 -- + uint32_t h_g = (*(uint32_t*) ((uint8_t*) from + src_pitch )), + j_i = (*(uint32_t*) ((uint8_t*) from + src_pitch + 4)), + l_k = (*(uint32_t*) ((uint8_t*) from + src_pitch + 8)); + + // Generate abgh_ag from b_a and h_g. + uint32_t bh_ag = Average32(b_a, h_g); + *(uint32_t*) ((uint8_t*) to + dst_pitch) = likely(Hi(bh_ag) == Lo(bh_ag)) + ? bh_ag + : Lo(bh_ag) /* ag verbatim to low pixel */ | + Raise(Average(Hi(bh_ag), Lo(bh_ag))) /* abgh to high pixel */; + + // Generate ci_bchi from b_a, d_c, h_g and j_i. + uint32_t ci_bh = + Hi(bh_ag) /* bh verbatim to low pixel */ | + Raise(Average(Lo(d_c), Lo(j_i))) /* ci to high pixel */; + *(uint32_t*) ((uint8_t*) to + dst_pitch + 4) = likely(Hi(ci_bh) == Lo(ci_bh)) + ? ci_bh + : Raise(Hi(ci_bh)) /* ci verbatim to high pixel */ | + Average(Hi(ci_bh), Lo(ci_bh)) /* bchi to low pixel */; + + // Generate fl_efkl from f_e and l_k. + uint32_t fl_ek = Average32(f_e, l_k); + *(uint32_t*) ((uint8_t*) to + dst_pitch + 12) = likely(Hi(fl_ek) == Lo(fl_ek)) + ? fl_ek + : Raise(Hi(fl_ek)) /* fl verbatim to high pixel */ | + Average(Hi(fl_ek), Lo(fl_ek)) /* efkl to low pixel */; + + // Generate dejk_dj from d_c, f_e, j_i and l_k. + uint32_t ek_dj = + Raise(Lo(fl_ek)) /* ek verbatim to high pixel */ | + Average(Hi(d_c), Hi(j_i)) /* dj to low pixel */; + *(uint32_t*) ((uint8_t*) to + dst_pitch + 8) = likely(Hi(ek_dj) == Lo(ek_dj)) + ? ek_dj + : Lo(ek_dj) /* dj verbatim to low pixel */ | + Raise(Average(Hi(ek_dj), Lo(ek_dj))) /* dejk to high pixel */; + + // -- Row 3 -- + // Generate gh_g from h_g. + *(uint32_t*) ((uint8_t*) to + dst_pitch * 2) = likely(Hi(h_g) == Lo(h_g)) + ? h_g + : Lo(h_g) /* 'g' verbatim to low pixel */ | + Raise(Average(Hi(h_g), Lo(h_g))) /* gh to high pixel */; + + // Generate i_hi from g_h and j_i. + *(uint32_t*) ((uint8_t*) to + dst_pitch * 2 + 4) = likely(Hi(h_g) == Lo(j_i)) + ? Lo(j_i) | Raise(Lo(j_i)) + : Raise(Lo(j_i)) /* 'i' verbatim to high pixel */ | + Average(Lo(j_i), Hi(h_g)) /* hi to low pixel */; + + // Generate jk_j from j_i and l_k. + *(uint32_t*) ((uint8_t*) to + dst_pitch * 2 + 8) = likely(Hi(j_i) == Lo(l_k)) + ? Lo(l_k) | Raise(Lo(l_k)) + : Hi(j_i) /* 'j' verbatim to low pixel */ | + Raise(Average(Hi(j_i), Lo(l_k))) /* jk to high pixel */; + + // Generate l_kl from l_k. + *(uint32_t*) ((uint8_t*) to + dst_pitch * 2 + 12) = likely(Hi(l_k) == Lo(l_k)) + ? l_k + : Raise(Hi(l_k)) /* 'l' verbatim to high pixel */ | + Average(Hi(l_k), Lo(l_k)) /* kl to low pixel */; + } + + from += 6; + to += 8; + } + + // Skip past the waste at the end of the first line, if any, + // then past 1 whole lines of source and 2 of destination. + from = (uint16_t*) ((uint8_t*) from + src_skip + src_pitch); + to = (uint16_t*) ((uint8_t*) to + dst_skip + 2 * dst_pitch); + } +} + +static inline void scale_bilinearish_240x160_320x213(unsigned src_x, unsigned src_y, size_t src_pitch, const void *src, void *dst) +{ + /* Before: + * a b c d e f + * g h i j k l + * m n o p q r + * + * After (multiple letters = average): + * a ab bc c d de ef f + * ag abgh bchi ci dj dejk efkl fl + * gm ghmn hino io jp jkpq klqr lr + * m mn no o p pq qr r + */ + + uint16_t *to = (uint16_t *)dst + dst_offs / sizeof(uint16_t); + const uint16_t *from = (const uint16_t *)src; + const uint32_t dst_pitch = SCREEN_PITCH; + + const uint32_t dst_x = src_x * 4 / 3; + const uint32_t src_skip = src_pitch - src_x * sizeof(uint16_t), + dst_skip = dst_pitch - dst_x * sizeof(uint16_t); + + uint32_t x, y; + + for (y = 0; y < src_y; y += 3) { + for (x = 0; x < src_x / 6; x++) { + // -- Row 1 -- + // Read RGB565 elements in the source grid. + // The notation is high_low (little-endian). + uint32_t b_a = (*(uint32_t*) (from )), + d_c = (*(uint32_t*) (from + 2)), + f_e = (*(uint32_t*) (from + 4)); + + // Generate ab_a from b_a. + *(uint32_t*) (to) = likely(Hi(b_a) == Lo(b_a)) + ? b_a + : Lo(b_a) /* 'a' verbatim to low pixel */ | + Raise(Average(Hi(b_a), Lo(b_a))) /* ba to high pixel */; + + // Generate c_bc from b_a and d_c. + *(uint32_t*) (to + 2) = likely(Hi(b_a) == Lo(d_c)) + ? Lo(d_c) | Raise(Lo(d_c)) + : Raise(Lo(d_c)) /* 'c' verbatim to high pixel */ | + Average(Lo(d_c), Hi(b_a)) /* bc to low pixel */; + + // Generate de_d from d_c and f_e. + *(uint32_t*) (to + 4) = likely(Hi(d_c) == Lo(f_e)) + ? Lo(f_e) | Raise(Lo(f_e)) + : Hi(d_c) /* 'd' verbatim to low pixel */ | + Raise(Average(Lo(f_e), Hi(d_c))) /* de to high pixel */; + + // Generate f_ef from f_e. + *(uint32_t*) (to + 6) = likely(Hi(f_e) == Lo(f_e)) + ? f_e + : Raise(Hi(f_e)) /* 'f' verbatim to high pixel */ | + Average(Hi(f_e), Lo(f_e)) /* ef to low pixel */; + + if (likely(y + 1 < src_y)) // Is there a source row 2? + { + // -- Row 2 -- + uint32_t h_g = (*(uint32_t*) ((uint8_t*) from + src_pitch )), + j_i = (*(uint32_t*) ((uint8_t*) from + src_pitch + 4)), + l_k = (*(uint32_t*) ((uint8_t*) from + src_pitch + 8)); + + // Generate abgh_ag from b_a and h_g. + uint32_t bh_ag = Average32(b_a, h_g); + *(uint32_t*) ((uint8_t*) to + dst_pitch) = likely(Hi(bh_ag) == Lo(bh_ag)) + ? bh_ag + : Lo(bh_ag) /* ag verbatim to low pixel */ | + Raise(Average(Hi(bh_ag), Lo(bh_ag))) /* abgh to high pixel */; + + // Generate ci_bchi from b_a, d_c, h_g and j_i. + uint32_t ci_bh = + Hi(bh_ag) /* bh verbatim to low pixel */ | + Raise(Average(Lo(d_c), Lo(j_i))) /* ci to high pixel */; + *(uint32_t*) ((uint8_t*) to + dst_pitch + 4) = likely(Hi(ci_bh) == Lo(ci_bh)) + ? ci_bh + : Raise(Hi(ci_bh)) /* ci verbatim to high pixel */ | + Average(Hi(ci_bh), Lo(ci_bh)) /* bchi to low pixel */; + + // Generate fl_efkl from f_e and l_k. + uint32_t fl_ek = Average32(f_e, l_k); + *(uint32_t*) ((uint8_t*) to + dst_pitch + 12) = likely(Hi(fl_ek) == Lo(fl_ek)) + ? fl_ek + : Raise(Hi(fl_ek)) /* fl verbatim to high pixel */ | + Average(Hi(fl_ek), Lo(fl_ek)) /* efkl to low pixel */; + + // Generate dejk_dj from d_c, f_e, j_i and l_k. + uint32_t ek_dj = + Raise(Lo(fl_ek)) /* ek verbatim to high pixel */ | + Average(Hi(d_c), Hi(j_i)) /* dj to low pixel */; + *(uint32_t*) ((uint8_t*) to + dst_pitch + 8) = likely(Hi(ek_dj) == Lo(ek_dj)) + ? ek_dj + : Lo(ek_dj) /* dj verbatim to low pixel */ | + Raise(Average(Hi(ek_dj), Lo(ek_dj))) /* dejk to high pixel */; + + if (likely(y + 2 < src_y)) // Is there a source row 3? + { + // -- Row 3 -- + uint32_t n_m = (*(uint32_t*) ((uint8_t*) from + src_pitch * 2 )), + p_o = (*(uint32_t*) ((uint8_t*) from + src_pitch * 2 + 4)), + r_q = (*(uint32_t*) ((uint8_t*) from + src_pitch * 2 + 8)); + + // Generate ghmn_gm from h_g and n_m. + uint32_t hn_gm = Average32(h_g, n_m); + *(uint32_t*) ((uint8_t*) to + dst_pitch * 2) = likely(Hi(hn_gm) == Lo(hn_gm)) + ? hn_gm + : Lo(hn_gm) /* gm verbatim to low pixel */ | + Raise(Average(Hi(hn_gm), Lo(hn_gm))) /* ghmn to high pixel */; + + // Generate io_hino from h_g, j_i, n_m and p_o. + uint32_t io_hn = + Hi(hn_gm) /* hn verbatim to low pixel */ | + Raise(Average(Lo(j_i), Lo(p_o))) /* io to high pixel */; + *(uint32_t*) ((uint8_t*) to + dst_pitch * 2 + 4) = likely(Hi(io_hn) == Lo(io_hn)) + ? io_hn + : Raise(Hi(io_hn)) /* io verbatim to high pixel */ | + Average(Hi(io_hn), Lo(io_hn)) /* hino to low pixel */; + + // Generate lr_klqr from l_k and r_q. + uint32_t lr_kq = Average32(l_k, r_q); + *(uint32_t*) ((uint8_t*) to + dst_pitch * 2 + 12) = likely(Hi(lr_kq) == Lo(lr_kq)) + ? lr_kq + : Raise(Hi(lr_kq)) /* lr verbatim to high pixel */ | + Average(Hi(lr_kq), Lo(lr_kq)) /* klqr to low pixel */; + + // Generate jkpq_jp from j_i, l_k, p_o and r_q. + uint32_t kq_jp = + Raise(Lo(lr_kq)) /* kq verbatim to high pixel */ | + Average(Hi(j_i), Hi(p_o)) /* jp to low pixel */; + *(uint32_t*) ((uint8_t*) to + dst_pitch * 2 + 8) = likely(Hi(kq_jp) == Lo(kq_jp)) + ? kq_jp + : Lo(kq_jp) /* jp verbatim to low pixel */ | + Raise(Average(Hi(kq_jp), Lo(kq_jp))) /* jkpq to high pixel */; + + // -- Row 4 -- + // Generate mn_m from n_m. + *(uint32_t*) ((uint8_t*) to + dst_pitch * 3) = likely(Hi(n_m) == Lo(n_m)) + ? n_m + : Lo(n_m) /* 'm' verbatim to low pixel */ | + Raise(Average(Hi(n_m), Lo(n_m))) /* mn to high pixel */; + + // Generate o_no from n_m and p_o. + *(uint32_t*) ((uint8_t*) to + dst_pitch * 3 + 4) = likely(Hi(n_m) == Lo(p_o)) + ? Lo(p_o) | Raise(Lo(p_o)) + : Raise(Lo(p_o)) /* 'o' verbatim to high pixel */ | + Average(Lo(p_o), Hi(n_m)) /* no to low pixel */; + + // Generate pq_p from p_o and r_q. + *(uint32_t*) ((uint8_t*) to + dst_pitch * 3 + 8) = likely(Hi(p_o) == Lo(r_q)) + ? Lo(r_q) | Raise(Lo(r_q)) + : Hi(p_o) /* 'p' verbatim to low pixel */ | + Raise(Average(Hi(p_o), Lo(r_q))) /* pq to high pixel */; + + // Generate r_qr from r_q. + *(uint32_t*) ((uint8_t*) to + dst_pitch * 3 + 12) = likely(Hi(r_q) == Lo(r_q)) + ? r_q + : Raise(Hi(r_q)) /* 'r' verbatim to high pixel */ | + Average(Hi(r_q), Lo(r_q)) /* qr to low pixel */; + } + } + + from += 6; + to += 8; + } + + // Skip past the waste at the end of the first line, if any, + // then past 2 whole lines of source and 3 of destination. + from = (uint16_t*) ((uint8_t*) from + src_skip + 2 * src_pitch); + to = (uint16_t*) ((uint8_t*) to + dst_skip + 3 * dst_pitch); + } +} + +/* + * Approximately bilinear scaler, 256x224 to 320x240 + * + * Copyright (C) 2014 hi-ban, Nebuleon <nebuleon.fumika@gmail.com> + * + * This function and all auxiliary functions are free software; you can + * redistribute them and/or modify them under the terms of the GNU Lesser + * General Public License as published by the Free Software Foundation; either + * version 2.1 of the License, or (at your option) any later version. + * + * These functions are distributed in the hope that they will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +// Support math +#define Half(A) (((A) >> 1) & 0x7BEF) +#define Quarter(A) (((A) >> 2) & 0x39E7) +// Error correction expressions to piece back the lower bits together +#define RestHalf(A) ((A) & 0x0821) +#define RestQuarter(A) ((A) & 0x1863) + +// Error correction expressions for quarters of pixels +#define Corr1_3(A, B) Quarter(RestQuarter(A) + (RestHalf(B) << 1) + RestQuarter(B)) +#define Corr3_1(A, B) Quarter((RestHalf(A) << 1) + RestQuarter(A) + RestQuarter(B)) + +// Error correction expressions for halves +#define Corr1_1(A, B) ((A) & (B) & 0x0821) + +// Quarters +#define Weight1_3(A, B) (Quarter(A) + Half(B) + Quarter(B) + Corr1_3(A, B)) +#define Weight3_1(A, B) (Half(A) + Quarter(A) + Quarter(B) + Corr3_1(A, B)) + +// Halves +#define Weight1_1(A, B) (Half(A) + Half(B) + Corr1_1(A, B)) + +/* Upscales a 256x224 image to 320x240 using an approximate bilinear + * resampling algorithm that only uses integer math. + * + * Input: + * src: A packed 256x224 pixel image. The pixel format of this image is + * RGB 565. + * width: The width of the source image. Should always be 256. + * Output: + * dst: A packed 320x240 pixel image. The pixel format of this image is + * RGB 565. + */ +void scale_bilinearish_256x224_320x240(unsigned src_x, unsigned src_y, size_t src_pitch, const void *src, void *dst) +{ + uint16_t* Src16 = (uint16_t*) src; + uint16_t* Dst16 = (uint16_t*) dst; + unsigned pxpitch = src_pitch / 2; + // There are 64 blocks of 4 pixels horizontally, and 14 of 16 vertically. + // Each block of 4x16 becomes 5x17. + uint32_t BlockX, BlockY; + uint16_t* BlockSrc; + uint16_t* BlockDst; + for (BlockY = 0; BlockY < 14; BlockY++) + { + BlockSrc = Src16 + BlockY * pxpitch * 16; + BlockDst = Dst16 + BlockY * 320 * 17; + for (BlockX = 0; BlockX < 64; BlockX++) + { + /* Horizontally: + * Before(4): + * (a)(b)(c)(d) + * After(5): + * (a)(abbb)(bc)(cccd)(d) + * + * Vertically: + * Before(16): After(17): + * (a) (a) + * (b) (b) + * (c) (c) + * (d) (cddd) + * (e) (deee) + * (f) (efff) + * (g) (fggg) + * (h) (ghhh) + * (i) (hi) + * (j) (iiij) + * (k) (jjjk) + * (l) (kkkl) + * (m) (lllm) + * (n) (mmmn) + * (o) (n) + * (p) (o) + * (p) + */ + + // -- Row 1 -- + uint16_t _1 = *(BlockSrc ); + *(BlockDst ) = _1; + uint16_t _2 = *(BlockSrc + 1); + *(BlockDst + 1) = Weight1_3( _1, _2); + uint16_t _3 = *(BlockSrc + 2); + *(BlockDst + 2) = Weight1_1( _2, _3); + uint16_t _4 = *(BlockSrc + 3); + *(BlockDst + 3) = Weight3_1( _3, _4); + *(BlockDst + 4) = _4; + + // -- Row 2 -- + uint16_t _5 = *(BlockSrc + pxpitch * 1 ); + *(BlockDst + 320 * 1 ) = _5; + uint16_t _6 = *(BlockSrc + pxpitch * 1 + 1); + *(BlockDst + 320 * 1 + 1) = Weight1_3( _5, _6); + uint16_t _7 = *(BlockSrc + pxpitch * 1 + 2); + *(BlockDst + 320 * 1 + 2) = Weight1_1( _6, _7); + uint16_t _8 = *(BlockSrc + pxpitch * 1 + 3); + *(BlockDst + 320 * 1 + 3) = Weight3_1( _7, _8); + *(BlockDst + 320 * 1 + 4) = _8; + + // -- Row 3 -- + uint16_t _9 = *(BlockSrc + pxpitch * 2 ); + *(BlockDst + 320 * 2 ) = _9; + uint16_t _10 = *(BlockSrc + pxpitch * 2 + 1); + *(BlockDst + 320 * 2 + 1) = Weight1_3( _9, _10); + uint16_t _11 = *(BlockSrc + pxpitch * 2 + 2); + *(BlockDst + 320 * 2 + 2) = Weight1_1(_10, _11); + uint16_t _12 = *(BlockSrc + pxpitch * 2 + 3); + *(BlockDst + 320 * 2 + 3) = Weight3_1(_11, _12); + *(BlockDst + 320 * 2 + 4) = _12; + + // -- Row 4 -- + uint16_t _13 = *(BlockSrc + pxpitch * 3 ); + *(BlockDst + 320 * 3 ) = Weight1_3( _9, _13); + uint16_t _14 = *(BlockSrc + pxpitch * 3 + 1); + *(BlockDst + 320 * 3 + 1) = Weight1_3(Weight1_3( _9, _10), Weight1_3(_13, _14)); + uint16_t _15 = *(BlockSrc + pxpitch * 3 + 2); + *(BlockDst + 320 * 3 + 2) = Weight1_3(Weight1_1(_10, _11), Weight1_1(_14, _15)); + uint16_t _16 = *(BlockSrc + pxpitch * 3 + 3); + *(BlockDst + 320 * 3 + 3) = Weight1_3(Weight3_1(_11, _12), Weight3_1(_15, _16)); + *(BlockDst + 320 * 3 + 4) = Weight1_3(_12, _16); + + // -- Row 5 -- + uint16_t _17 = *(BlockSrc + pxpitch * 4 ); + *(BlockDst + 320 * 4 ) = Weight1_3(_13, _17); + uint16_t _18 = *(BlockSrc + pxpitch * 4 + 1); + *(BlockDst + 320 * 4 + 1) = Weight1_3(Weight1_3(_13, _14), Weight1_3(_17, _18)); + uint16_t _19 = *(BlockSrc + pxpitch * 4 + 2); + *(BlockDst + 320 * 4 + 2) = Weight1_3(Weight1_1(_14, _15), Weight1_1(_18, _19)); + uint16_t _20 = *(BlockSrc + pxpitch * 4 + 3); + *(BlockDst + 320 * 4 + 3) = Weight1_3(Weight3_1(_15, _16), Weight3_1(_19, _20)); + *(BlockDst + 320 * 4 + 4) = Weight1_3(_16, _20); + + // -- Row 6 -- + uint16_t _21 = *(BlockSrc + pxpitch * 5 ); + *(BlockDst + 320 * 5 ) = Weight1_3(_17, _21); + uint16_t _22 = *(BlockSrc + pxpitch * 5 + 1); + *(BlockDst + 320 * 5 + 1) = Weight1_3(Weight1_3(_17, _18), Weight1_3(_21, _22)); + uint16_t _23 = *(BlockSrc + pxpitch * 5 + 2); + *(BlockDst + 320 * 5 + 2) = Weight1_3(Weight1_1(_18, _19), Weight1_1(_22, _23)); + uint16_t _24 = *(BlockSrc + pxpitch * 5 + 3); + *(BlockDst + 320 * 5 + 3) = Weight1_3(Weight3_1(_19, _20), Weight3_1(_23, _24)); + *(BlockDst + 320 * 5 + 4) = Weight1_3(_20, _24); + + // -- Row 7 -- + uint16_t _25 = *(BlockSrc + pxpitch * 6 ); + *(BlockDst + 320 * 6 ) = Weight1_3(_21, _25); + uint16_t _26 = *(BlockSrc + pxpitch * 6 + 1); + *(BlockDst + 320 * 6 + 1) = Weight1_3(Weight1_3(_21, _22), Weight1_3(_25, _26)); + uint16_t _27 = *(BlockSrc + pxpitch * 6 + 2); + *(BlockDst + 320 * 6 + 2) = Weight1_3(Weight1_1(_22, _23), Weight1_1(_26, _27)); + uint16_t _28 = *(BlockSrc + pxpitch * 6 + 3); + *(BlockDst + 320 * 6 + 3) = Weight1_3(Weight3_1(_23, _24), Weight3_1(_27, _28)); + *(BlockDst + 320 * 6 + 4) = Weight1_3(_24, _28); + + // -- Row 8 -- + uint16_t _29 = *(BlockSrc + pxpitch * 7 ); + *(BlockDst + 320 * 7 ) = Weight1_3(_25, _29); + uint16_t _30 = *(BlockSrc + pxpitch * 7 + 1); + *(BlockDst + 320 * 7 + 1) = Weight1_3(Weight1_3(_25, _26), Weight1_3(_29, _30)); + uint16_t _31 = *(BlockSrc + pxpitch * 7 + 2); + *(BlockDst + 320 * 7 + 2) = Weight1_3(Weight1_1(_26, _27), Weight1_1(_30, _31)); + uint16_t _32 = *(BlockSrc + pxpitch * 7 + 3); + *(BlockDst + 320 * 7 + 3) = Weight1_3(Weight3_1(_27, _28), Weight3_1(_31, _32)); + *(BlockDst + 320 * 7 + 4) = Weight1_3(_28, _32); + + // -- Row 9 -- + uint16_t _33 = *(BlockSrc + pxpitch * 8 ); + *(BlockDst + 320 * 8 ) = Weight1_1(_29, _33); + uint16_t _34 = *(BlockSrc + pxpitch * 8 + 1); + *(BlockDst + 320 * 8 + 1) = Weight1_1(Weight1_3(_29, _30), Weight1_3(_33, _34)); + uint16_t _35 = *(BlockSrc + pxpitch * 8 + 2); + *(BlockDst + 320 * 8 + 2) = Weight1_1(Weight1_1(_30, _31), Weight1_1(_34, _35)); + uint16_t _36 = *(BlockSrc + pxpitch * 8 + 3); + *(BlockDst + 320 * 8 + 3) = Weight1_1(Weight3_1(_31, _32), Weight3_1(_35, _36)); + *(BlockDst + 320 * 8 + 4) = Weight1_1(_32, _36); + + // -- Row 10 -- + uint16_t _37 = *(BlockSrc + pxpitch * 9 ); + *(BlockDst + 320 * 9 ) = Weight3_1(_33, _37); + uint16_t _38 = *(BlockSrc + pxpitch * 9 + 1); + *(BlockDst + 320 * 9 + 1) = Weight3_1(Weight1_3(_33, _34), Weight1_3(_37, _38)); + uint16_t _39 = *(BlockSrc + pxpitch * 9 + 2); + *(BlockDst + 320 * 9 + 2) = Weight3_1(Weight1_1(_34, _35), Weight1_1(_38, _39)); + uint16_t _40 = *(BlockSrc + pxpitch * 9 + 3); + *(BlockDst + 320 * 9 + 3) = Weight3_1(Weight3_1(_35, _36), Weight3_1(_39, _40)); + *(BlockDst + 320 * 9 + 4) = Weight3_1(_36, _40); + + // -- Row 11 -- + uint16_t _41 = *(BlockSrc + pxpitch * 10 ); + *(BlockDst + 320 * 10 ) = Weight3_1(_37, _41); + uint16_t _42 = *(BlockSrc + pxpitch * 10 + 1); + *(BlockDst + 320 * 10 + 1) = Weight3_1(Weight1_3(_37, _38), Weight1_3(_41, _42)); + uint16_t _43 = *(BlockSrc + pxpitch * 10 + 2); + *(BlockDst + 320 * 10 + 2) = Weight3_1(Weight1_1(_38, _39), Weight1_1(_42, _43)); + uint16_t _44 = *(BlockSrc + pxpitch * 10 + 3); + *(BlockDst + 320 * 10 + 3) = Weight3_1(Weight3_1(_39, _40), Weight3_1(_43, _44)); + *(BlockDst + 320 * 10 + 4) = Weight3_1(_40, _44); + + // -- Row 12 -- + uint16_t _45 = *(BlockSrc + pxpitch * 11 ); + *(BlockDst + 320 * 11 ) = Weight3_1(_41, _45); + uint16_t _46 = *(BlockSrc + pxpitch * 11 + 1); + *(BlockDst + 320 * 11 + 1) = Weight3_1(Weight1_3(_41, _42), Weight1_3(_45, _46)); + uint16_t _47 = *(BlockSrc + pxpitch * 11 + 2); + *(BlockDst + 320 * 11 + 2) = Weight3_1(Weight1_1(_42, _43), Weight1_1(_46, _47)); + uint16_t _48 = *(BlockSrc + pxpitch * 11 + 3); + *(BlockDst + 320 * 11 + 3) = Weight3_1(Weight3_1(_43, _44), Weight3_1(_47, _48)); + *(BlockDst + 320 * 11 + 4) = Weight3_1(_44, _48); + + // -- Row 13 -- + uint16_t _49 = *(BlockSrc + pxpitch * 12 ); + *(BlockDst + 320 * 12 ) = Weight3_1(_45, _49); + uint16_t _50 = *(BlockSrc + pxpitch * 12 + 1); + *(BlockDst + 320 * 12 + 1) = Weight3_1(Weight1_3(_45, _46), Weight1_3(_49, _50)); + uint16_t _51 = *(BlockSrc + pxpitch * 12 + 2); + *(BlockDst + 320 * 12 + 2) = Weight3_1(Weight1_1(_46, _47), Weight1_1(_50, _51)); + uint16_t _52 = *(BlockSrc + pxpitch * 12 + 3); + *(BlockDst + 320 * 12 + 3) = Weight3_1(Weight3_1(_47, _48), Weight3_1(_51, _52)); + *(BlockDst + 320 * 12 + 4) = Weight3_1(_48, _52); + + // -- Row 14 -- + uint16_t _53 = *(BlockSrc + pxpitch * 13 ); + *(BlockDst + 320 * 13 ) = Weight3_1(_49, _53); + uint16_t _54 = *(BlockSrc + pxpitch * 13 + 1); + *(BlockDst + 320 * 13 + 1) = Weight3_1(Weight1_3(_49, _50), Weight1_3(_53, _54)); + uint16_t _55 = *(BlockSrc + pxpitch * 13 + 2); + *(BlockDst + 320 * 13 + 2) = Weight3_1(Weight1_1(_50, _51), Weight1_1(_54, _55)); + uint16_t _56 = *(BlockSrc + pxpitch * 13 + 3); + *(BlockDst + 320 * 13 + 3) = Weight3_1(Weight3_1(_51, _52), Weight3_1(_55, _56)); + *(BlockDst + 320 * 13 + 4) = Weight3_1(_52, _56); + + // -- Row 15 -- + *(BlockDst + 320 * 14 ) = _53; + *(BlockDst + 320 * 14 + 1) = Weight1_3(_53, _54); + *(BlockDst + 320 * 14 + 2) = Weight1_1(_54, _55); + *(BlockDst + 320 * 14 + 3) = Weight3_1(_55, _56); + *(BlockDst + 320 * 14 + 4) = _56; + + // -- Row 16 -- + uint16_t _57 = *(BlockSrc + pxpitch * 14 ); + *(BlockDst + 320 * 15 ) = _57; + uint16_t _58 = *(BlockSrc + pxpitch * 14 + 1); + *(BlockDst + 320 * 15 + 1) = Weight1_3(_57, _58); + uint16_t _59 = *(BlockSrc + pxpitch * 14 + 2); + *(BlockDst + 320 * 15 + 2) = Weight1_1(_58, _59); + uint16_t _60 = *(BlockSrc + pxpitch * 14 + 3); + *(BlockDst + 320 * 15 + 3) = Weight3_1(_59, _60); + *(BlockDst + 320 * 15 + 4) = _60; + + // -- Row 17 -- + uint16_t _61 = *(BlockSrc + pxpitch * 15 ); + *(BlockDst + 320 * 16 ) = _61; + uint16_t _62 = *(BlockSrc + pxpitch * 15 + 1); + *(BlockDst + 320 * 16 + 1) = Weight1_3(_61, _62); + uint16_t _63 = *(BlockSrc + pxpitch * 15 + 2); + *(BlockDst + 320 * 16 + 2) = Weight1_1(_62, _63); + uint16_t _64 = *(BlockSrc + pxpitch * 15 + 3); + *(BlockDst + 320 * 16 + 3) = Weight3_1(_63, _64); + *(BlockDst + 320 * 16 + 4) = _64; + + BlockSrc += 4; + BlockDst += 5; + } + } +} + +void scale_bilinearish_256x240_320x240(unsigned src_x, unsigned src_y, size_t src_pitch, const void *src, void *dst) +{ + uint16_t* Src16 = (uint16_t*) src; + uint16_t* Dst16 = (uint16_t*) dst; + unsigned pxpitch = src_pitch / 2; + // There are 64 blocks of 4 pixels horizontally, and 239 of 1 vertically. + // Each block of 4x1 becomes 5x1. + uint32_t BlockX, BlockY; + uint16_t* BlockSrc; + uint16_t* BlockDst; + for (BlockY = 0; BlockY < 239; BlockY++) + { + BlockSrc = Src16 + BlockY * pxpitch * 1; + BlockDst = Dst16 + BlockY * 320 * 1; + for (BlockX = 0; BlockX < 64; BlockX++) + { + /* Horizontally: + * Before(4): + * (a)(b)(c)(d) + * After(5): + * (a)(abbb)(bc)(cccd)(d) + */ + + // -- Row 1 -- + uint16_t _1 = *(BlockSrc ); + *(BlockDst ) = _1; + uint16_t _2 = *(BlockSrc + 1); + *(BlockDst + 1) = Weight1_3( _1, _2); + uint16_t _3 = *(BlockSrc + 2); + *(BlockDst + 2) = Weight1_1( _2, _3); + uint16_t _4 = *(BlockSrc + 3); + *(BlockDst + 3) = Weight3_1( _3, _4); + *(BlockDst + 4) = _4; + + BlockSrc += 4; + BlockDst += 5; + } + } +} + +static void scale_select_scaler(unsigned w, unsigned h, size_t pitch) { + scaler = NULL; + + if (scale_size == SCALE_SIZE_FULL) { + dst_w = SCREEN_WIDTH; + dst_h = SCREEN_HEIGHT; + dst_offs = 0; + } else if (scale_size == SCALE_SIZE_ASPECT) { + dst_w = SCREEN_WIDTH; + dst_h = SCREEN_WIDTH / aspect_ratio + 0.5; + dst_offs = ((SCREEN_HEIGHT-dst_h)/2) * SCREEN_PITCH; + + if (dst_h > SCREEN_HEIGHT) { + dst_w = SCREEN_HEIGHT * aspect_ratio + 0.5; + dst_h = SCREEN_HEIGHT; + dst_offs = ((SCREEN_WIDTH-dst_w)/2); + } + } else if (scale_size == SCALE_SIZE_NONE && w <= SCREEN_WIDTH && h <= SCREEN_HEIGHT) { + unsigned dst_x = ((SCREEN_WIDTH - w) * SCREEN_BPP / 2); + unsigned dst_y = ((SCREEN_HEIGHT - h) / 2); + dst_offs = dst_y * SCREEN_PITCH + dst_x; + + if (pitch == SCREEN_PITCH) { + scaler = scale_memcpy; + } else { + scaler = scale_1x; + } + + return; + } + + if (!scaler && w == 240 && h == 160) { + if (scale_filter == SCALE_FILTER_SHARP) { + scaler = scale_sharp_240x160_320xXXX; + return; + } else if (scale_filter == SCALE_FILTER_SMOOTH) { + if (scale_size == SCALE_SIZE_ASPECT) { + scaler = scale_bilinearish_240x160_320x213; + } else { + scaler = scale_bilinearish_240x160_320x240; + } + return; + } + } + + if (!scaler && aspect_ratio == 4.0f / 3.0f && w == 256) { + if (scale_filter == SCALE_FILTER_SHARP) { + scaler = scale_sharp_256xXXX_320xXXX; + } else if (scale_filter == SCALE_FILTER_SMOOTH) { + if (h == 240) { + scaler = scale_bilinearish_256x240_320x240; + } else if (h == 224) { + scaler = scale_bilinearish_256x224_320x240; + } + } + } + + if (!scaler && scale_filter == SCALE_FILTER_NEAREST) { + scaler = scale_nearest; + return; + } + + if (!scaler) { + scaler = scale_1x; + } +} + +void scale_update_scaler(void) { + scale_select_scaler(prev.w, prev.h, prev.pitch); +} + +void scale(unsigned w, unsigned h, size_t pitch, const void *src, void *dst) { + if (w != prev.w || h != prev.h || pitch != prev.pitch) { + scale_select_scaler(w, h, pitch); + prev.w = w; prev.h = h; prev.pitch = pitch; + } + + scaler(w, h, pitch, src, dst); +} @@ -0,0 +1,24 @@ +#ifndef __SCALE_H__ +#define __SCALE_H__ + +#define SCREEN_WIDTH 320 +#define SCREEN_HEIGHT 240 +#define SCREEN_BPP 2 +#define SCREEN_PITCH (SCREEN_BPP * SCREEN_WIDTH) + +enum scale_size { + SCALE_SIZE_NONE, + SCALE_SIZE_ASPECT, + SCALE_SIZE_FULL, +}; + +enum scale_filter { + SCALE_FILTER_NEAREST, + SCALE_FILTER_SHARP, + SCALE_FILTER_SMOOTH, +}; + +void scale_update_scaler(void); +void scale(unsigned w, unsigned h, size_t pitch, const void *src, void *dst); + +#endif @@ -0,0 +1,200 @@ +#include <stdlib.h> +#include <string.h> +#include "main.h" +#include "unzip.h" +#include "zlib.h" + +#define HEADER_SIZE 30 +#define CHUNK 65536 + +#define LE_READ16(buf) ((uint16_t)(((uint8_t *)(buf))[1] << 8 | ((uint8_t *)(buf))[0])) +#define LE_READ32(buf) ((uint32_t)(((uint8_t *)(buf))[3] << 24 | ((uint8_t *)(buf))[2] << 16 | ((uint8_t *)(buf))[1] << 8 | ((uint8_t *)(buf))[0])) + +struct file_info { + uint32_t compressed_size; + int (*inflate)(FILE *zip, FILE *dest, size_t size); + char filename[MAX_PATH]; +}; + +static int write_uncompressed(FILE *zip, FILE *dest, size_t size) { + uint8_t buf[CHUNK]; + + while (size) { + size_t wsize = MIN(size, CHUNK); + + if (size != fread(buf, 1, wsize, zip)) { + return -1; + } + if (size != fwrite(buf, 1, wsize, zip)) { + return -1; + } + size -= wsize; + } + return 0; +} + +static int write_inflate(FILE *zip, FILE *dest, size_t size) { + z_stream stream = {0}; + size_t have = 0; + uint8_t in[CHUNK]; + uint8_t out[CHUNK]; + int ret = -1; + + ret = inflateInit2(&stream, -MAX_WBITS); + if (ret != Z_OK) + return ret; + + do { + size_t insize = MIN(size, CHUNK); + + stream.avail_in = fread(in, 1, insize, zip); + if (ferror(zip)) { + (void)inflateEnd(&stream); + return Z_ERRNO; + } + + if (!stream.avail_in) + break; + stream.next_in = in; + + do { + stream.avail_out = CHUNK; + stream.next_out = out; + + ret = inflate(&stream, Z_NO_FLUSH); + switch(ret) { + case Z_NEED_DICT: + ret = Z_DATA_ERROR; + case Z_DATA_ERROR: + case Z_MEM_ERROR: + (void)inflateEnd(&stream); + return ret; + } + + have = CHUNK - stream.avail_out; + if (fwrite(out, 1, have, dest) != have || ferror(dest)) { + (void)inflateEnd(&stream); + return Z_ERRNO; + } + } while (stream.avail_out == 0); + + size -= insize; + } while (size && ret != Z_STREAM_END); + + (void)inflateEnd(&stream); + + if (!size || ret == Z_STREAM_END) { + return Z_OK; + } else { + return Z_DATA_ERROR; + } +} + +static int find_entry(FILE *zip, const char **extensions, struct file_info *info) { + int ret = -1; + uint8_t header[HEADER_SIZE]; + uint32_t next = 0; + uint16_t file_name_size = 0; + char extension[10]; + + while(1) { + bool match = false; + + if (next) + fseek(zip, next, SEEK_CUR); + + if (HEADER_SIZE != fread(header, 1, HEADER_SIZE, zip)) + break; + + if (header[0] != 0x50 || header[1] != 0x4b || header[2] != 0x03 || header[3] != 0x04) + break; + + if ((uint16_t)(header[6]) & 0x0008) { + PA_ERROR("Unsupported zip file\n"); + break; + } + + file_name_size = LE_READ16(&header[26]); + if (file_name_size >= MAX_PATH) + break; + + if (file_name_size != fread(info->filename, 1, file_name_size, zip)) + break; + + info->filename[file_name_size] = '\0'; + info->compressed_size = LE_READ32(&header[18]); + + fseek(zip, LE_READ16(&header[28]), SEEK_CUR); + + next = info->compressed_size; + + for (int i = 0; extensions[i]; i++) { + snprintf(extension, 10, ".%s", extensions[i]); + if (has_suffix_i(info->filename, extension)) { + match = true; + break; + } + } + + if (!match) + continue; + + switch (LE_READ16(&header[8])) { + case 0: /* Uncompressed */ + info->inflate = write_uncompressed; + case 8: /* DEFLATE */ + info->inflate = write_inflate; + } + + ret = 0; + break; + } + return ret; +} + +int unzip_tmp(FILE *zip, const char **extensions, char *filename, size_t len) { + int ret = -1; + struct file_info info = {0}; + FILE *dest = NULL; + + if (!find_entry(zip, extensions, &info)) { + int fd = 0; + snprintf(filename, len, "/tmp/pa-XXXXXX%s", basename(info.filename)); + + fd = mkstemps(filename, strlen(info.filename)); + dest = fdopen(fd, "w"); + + if (!dest) { + PA_ERROR("Error creating temporary file for decompression\n"); + goto finish; + } + + if (info.inflate(zip, dest, info.compressed_size)) { + PA_ERROR("Error decompressing file\n"); + goto finish; + } + + ret = 0; + } + +finish: + if (dest) + fclose(dest); + return ret; +} + +int unzip(FILE *zip, const char **extensions, FILE *dest) { + int ret = -1; + struct file_info info = {0}; + + if(!find_entry(zip, extensions, &info)) { + if (!info.inflate(zip, dest, info.compressed_size)) { + ret = 0; + } else { + PA_ERROR("Error decompressing file\n"); + } + + } + + return ret; +} @@ -0,0 +1,9 @@ +#ifndef __UNZIP_H_ +#define __UNZIP_H_ + +#include <stdio.h> + +int unzip_tmp(FILE *zip, const char **extensions, char *filename, size_t len); +int unzip(FILE *zip, const char **extensions, FILE *dest); + +#endif |