From ca90853a88f21aa8b4e2c564e7db8c09ed1be30d Mon Sep 17 00:00:00 2001 From: zeromus Date: Mon, 17 Apr 2017 22:48:16 -0500 Subject: [PATCH] add LibretroBridge, c++ bits which facilitate c# interop through the hazards of libco (more refined counterpart of what was tested for libsneshawk) --- LibretroBridge/vs2015/.editorconfig | 4 + LibretroBridge/vs2015/LibretroBridge.cpp | 849 +++++++ LibretroBridge/vs2015/LibretroBridge.sln | 22 + LibretroBridge/vs2015/LibretroBridge.vcxproj | 187 ++ LibretroBridge/vs2015/dynamic.h | 168 ++ LibretroBridge/vs2015/features_cpu.c | 776 +++++++ LibretroBridge/vs2015/libco/amd64.c | 104 + LibretroBridge/vs2015/libco/libco.h | 38 + LibretroBridge/vs2015/libco/sjlj-multi.c | 237 ++ LibretroBridge/vs2015/libco/x86.c | 117 + LibretroBridge/vs2015/libretro.h | 2163 ++++++++++++++++++ 11 files changed, 4665 insertions(+) create mode 100644 LibretroBridge/vs2015/.editorconfig create mode 100644 LibretroBridge/vs2015/LibretroBridge.cpp create mode 100644 LibretroBridge/vs2015/LibretroBridge.sln create mode 100644 LibretroBridge/vs2015/LibretroBridge.vcxproj create mode 100644 LibretroBridge/vs2015/dynamic.h create mode 100644 LibretroBridge/vs2015/features_cpu.c create mode 100644 LibretroBridge/vs2015/libco/amd64.c create mode 100644 LibretroBridge/vs2015/libco/libco.h create mode 100644 LibretroBridge/vs2015/libco/sjlj-multi.c create mode 100644 LibretroBridge/vs2015/libco/x86.c create mode 100644 LibretroBridge/vs2015/libretro.h diff --git a/LibretroBridge/vs2015/.editorconfig b/LibretroBridge/vs2015/.editorconfig new file mode 100644 index 0000000000..b39b7e5480 --- /dev/null +++ b/LibretroBridge/vs2015/.editorconfig @@ -0,0 +1,4 @@ +root = true + +[*] +indent_style = tab diff --git a/LibretroBridge/vs2015/LibretroBridge.cpp b/LibretroBridge/vs2015/LibretroBridge.cpp new file mode 100644 index 0000000000..234b310932 --- /dev/null +++ b/LibretroBridge/vs2015/LibretroBridge.cpp @@ -0,0 +1,849 @@ +//derived from libsnes +//types of messages: +//cmd: frontend->core: "command to core" a command from the frontend which causes emulation to proceed. when sending a command, the frontend should wait for an eMessage::BRK_Complete before proceeding, although a debugger might proceed after any BRK +//query: frontend->core: "query to core" a query from the frontend which can (and should) be satisfied immediately by the core but which does not result in emulation processes (notably, nothing resembling a CMD and nothing which can trigger a BRK) +//sig: core->frontend: "core signal" a synchronous operation called from the emulation process which the frontend should handle immediately without issuing any calls into the core +//brk: core->frontend: "core break" the emulation process has suspended. the frontend is free to do whatever it wishes. + +#define _CRT_NONSTDC_NO_DEPRECATE + +#include + +#include +#include +#include +#include +#include +#include + +#include + +#define bool unsigned char +#include "libretro.h" +#undef bool + +extern "C" uint64_t cpu_features_get(); + +#include "libco/libco.h" + +//can't use retroarch's dynamic.h, it's too full of weird stuff. don't need it anyway + +typedef uint8_t u8; +typedef uint16_t u16; +typedef uint64_t u64; +typedef uint32_t u32; + +typedef u8 u8bool; + +typedef int16_t s16; +typedef int32_t s32; +typedef int64_t s64; + +typedef void(*Action)(); + +struct retro_core_t +{ + void(*retro_init)(void); + void(*retro_deinit)(void); + unsigned(*retro_api_version)(void); + void(*retro_get_system_info)(struct retro_system_info*); + void(*retro_get_system_av_info)(struct retro_system_av_info*); + void(*retro_set_environment)(retro_environment_t); + void(*retro_set_video_refresh)(retro_video_refresh_t); + void(*retro_set_audio_sample)(retro_audio_sample_t); + void(*retro_set_audio_sample_batch)(retro_audio_sample_batch_t); + void(*retro_set_input_poll)(retro_input_poll_t); + void(*retro_set_input_state)(retro_input_state_t); + void(*retro_set_controller_port_device)(unsigned, unsigned); + void(*retro_reset)(void); + void(*retro_run)(void); + size_t(*retro_serialize_size)(void); + u8bool(*retro_serialize)(void*, size_t); + u8bool(*retro_unserialize)(const void*, size_t); + void(*retro_cheat_reset)(void); + void(*retro_cheat_set)(unsigned, u8bool, const char*); + u8bool(*retro_load_game)(const struct retro_game_info*); + u8bool(*retro_load_game_special)(unsigned, + const struct retro_game_info*, size_t); + void(*retro_unload_game)(void); + unsigned(*retro_get_region)(void); + void *(*retro_get_memory_data)(unsigned); + size_t(*retro_get_memory_size)(unsigned); +}; + +enum eMessage : s32 +{ + NotSet, + + Resume, + + QUERY_FIRST, + QUERY_LAST, + + CMD_FIRST, + CMD_SetEnvironment, + CMD_LoadNoGame, + CMD_LoadData, + CMD_LoadPath, + CMD_Deinit, + CMD_Reset, + CMD_Run, + CMD_Serialize, + CMD_Unserialize, + CMD_LAST, + + SIG_VideoUpdate, + + BRK_InputState, +}; + +enum eStatus : s32 +{ + eStatus_Idle, + eStatus_CMD, + eStatus_BRK +}; + +enum BufId : s32 { + Param0 = 0, + Param1 = 1, + SystemDirectory = 2, + SaveDirectory = 3, + CoreDirectory = 4, + CoreAssetsDirectory = 5, + BufId_Num //excess sized by 1.. no big deal +}; + +//TODO: do any of these need to be volatile? +struct CommStruct +{ + //the cmd being executed + eMessage cmd; + + //the status of the core + eStatus status; + + //the SIG or BRK that the core is halted in + eMessage reason; + + //flexible in/out parameters + //these are all "overloaded" a little so it isn't clear what's used for what in for any particular message.. + //but I think it will beat having to have some kind of extremely verbose custom layouts for every message + u32 id, addr, value, size; + u32 port, device, index, slot; //for input state + + //variables meant for stateful communication (not parameters) + //may be in, out, or inout. it's pretty sloppy. + struct { + //set by the core + retro_system_info retro_system_info; + retro_system_av_info retro_system_av_info; + size_t retro_serialize_size; + u32 retro_region; + u32 retro_api_version; + retro_pixel_format pixel_format; //default is 0 -- RETRO_PIXEL_FORMAT_0RGB1555 + s32 rotation_ccw; + bool support_no_game; + retro_get_proc_address_t core_get_proc_address; + + retro_game_geometry retro_game_geometry; + u8bool retro_game_geometry_dirty; //c# can clear this when it's acknowledged (but I think we might handle it from here? not sure) + + //defined by the core. values arent put here, this is just the variables defined by the core + //todo: shutdown tidy + s32 variable_count; + const char** variable_keys; + const char** variable_comments; + + //c# sets these with thunked callbacks + retro_perf_callback retro_perf_callback; + + //various stashed stuff solely for c# convenience + u64 processor_features; + + s32 fb_width, fb_height; //core sets these; c# picks up, and.. + s32* fb_bufptr; //..sets this for the core to spill its data nito + + } env; + + //always used in pairs + void* buf[BufId_Num]; + s32 buf_size[BufId_Num]; + + //=========================================================== + //private stuff + + std::string *variables; + bool variables_dirty; + + + void* privbuf[BufId_Num]; //TODO remember to tidy this.. (needs to be done in snes too) + void SetString(int id, const char* str) + { + size_t len = strlen(str); + CopyBuffer(id, (void*)str, len+1); + } + void CopyBuffer(int id, void* ptr, s32 size) + { + if (privbuf[id]) free(privbuf[id]); + buf[id] = privbuf[id] = malloc(size); + memcpy(buf[id], ptr, size); + buf_size[id] = size; + } + + void SetBuffer(int id, void* ptr, s32 size) + { + buf[id] = ptr; + buf_size[id] = size; + } + + struct { + } strings; + + HMODULE dllModule; + retro_core_t funs; + + void LoadSymbols() + { + //retroarch would throw an error here if the FP ws null. maybe better than throwing an error later, but are all the functions required? +# define SYMBOL(x) { \ + FARPROC func = GetProcAddress(dllModule, #x); \ + memcpy(&funs.x, &func, sizeof(func)); \ + } + + SYMBOL(retro_init); + SYMBOL(retro_deinit); + + SYMBOL(retro_api_version); + SYMBOL(retro_get_system_info); + SYMBOL(retro_get_system_av_info); + + SYMBOL(retro_set_environment); + SYMBOL(retro_set_video_refresh); + SYMBOL(retro_set_audio_sample); + SYMBOL(retro_set_audio_sample_batch); + SYMBOL(retro_set_input_poll); + SYMBOL(retro_set_input_state); + + SYMBOL(retro_set_controller_port_device); + + SYMBOL(retro_reset); + SYMBOL(retro_run); + + SYMBOL(retro_serialize_size); + SYMBOL(retro_serialize); + SYMBOL(retro_unserialize); + + SYMBOL(retro_cheat_reset); + SYMBOL(retro_cheat_set); + + SYMBOL(retro_load_game); + SYMBOL(retro_load_game_special); + + SYMBOL(retro_unload_game); + SYMBOL(retro_get_region); + SYMBOL(retro_get_memory_data); + SYMBOL(retro_get_memory_size); + } + + retro_core_t fn; + +} comm; + +//coroutines +cothread_t co_control, co_emu, co_emu_suspended; + +//internal state +Action CMD_cb; + +void BREAK(eMessage msg) { + comm.status = eStatus_BRK; + comm.reason = msg; + co_emu_suspended = co_active(); + co_switch(co_control); + comm.status = eStatus_CMD; +} + +//all this does is run commands on the emulation thread infinitely forever +//(I should probably make a mechanism for bailing...) +void new_emuthread() +{ + for (;;) + { + //process the current CMD + CMD_cb(); + + //when that returned, we're definitely done with the CMD--so we're now IDLE + comm.status = eStatus_Idle; + + co_switch(co_control); + } +} + +void retro_log_printf(enum retro_log_level level, const char *fmt, ...) +{ + va_list args; + va_start(args, fmt); + vprintf(fmt,args); + va_end(args); +} + +u8bool retro_environment(unsigned cmd, void *data) +{ + switch (cmd) + { + case RETRO_ENVIRONMENT_SET_ROTATION: + comm.env.rotation_ccw = (int)*(const unsigned*)data * 90; + return true; + case RETRO_ENVIRONMENT_GET_OVERSCAN: + return false; //could return true to crop overscan + case RETRO_ENVIRONMENT_GET_CAN_DUPE: + return true; + case RETRO_ENVIRONMENT_SET_MESSAGE: + { + //TODO: try to respect design principle by forwarding to frontend with the timer + auto &msg = *(retro_message*)data; + printf("%s\n",msg.msg); + return true; + } + case RETRO_ENVIRONMENT_SHUTDOWN: + //TODO low priority + return false; + case RETRO_ENVIRONMENT_SET_PERFORMANCE_LEVEL: + //unneeded + return false; + case RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY: + *(const char**)data = (const char*)comm.buf[SystemDirectory]; + return true; + case RETRO_ENVIRONMENT_SET_PIXEL_FORMAT: + comm.env.pixel_format = *(const enum retro_pixel_format*)data; + return true; + case RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS: + //TODO medium priority + return false; + case RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK: + //TODO high priority (to support keyboard consoles, probably high value for us. but that may take a lot of infrastructure work) + return false; + case RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE: + //TODO high priority (to support disc systems) + return false; + case RETRO_ENVIRONMENT_SET_HW_RENDER: + //TODO high priority (to support 3d renderers + return false; + + case RETRO_ENVIRONMENT_GET_VARIABLE: + { + //according to retroarch's `core_option_manager_get` this is what we should do + comm.variables_dirty = false; + + auto req = (retro_variable *)data; + req->value = nullptr; + + for(int i=0;ikey)) + { + req->value = comm.variables[i].c_str(); + return true; + } + } + + return true; + } + + case RETRO_ENVIRONMENT_SET_VARIABLES: + { + auto var = (retro_variable *)data; + int nVars = 0; + while(var->key) + nVars++, var++; + comm.variables = new std::string[nVars]; + comm.env.variable_count = nVars; + comm.env.variable_keys = new const char*[nVars]; + comm.env.variable_comments = new const char*[nVars]; + var = (retro_variable *)data; + for(int i=0;ilog = retro_log_printf; + return true; + case RETRO_ENVIRONMENT_GET_PERF_INTERFACE: + *((retro_perf_callback *)data) = comm.env.retro_perf_callback; + return true; + case RETRO_ENVIRONMENT_GET_LOCATION_INTERFACE: + //TODO low priority + return false; + + case RETRO_ENVIRONMENT_GET_CORE_ASSETS_DIRECTORY: + *(const char**)data = (const char*)comm.buf[CoreAssetsDirectory]; + return true; + case RETRO_ENVIRONMENT_GET_SAVE_DIRECTORY: + *(const char**)data = (const char*)comm.buf[SaveDirectory]; + return true; + case RETRO_ENVIRONMENT_SET_SYSTEM_AV_INFO: + printf("NEED RETRO_ENVIRONMENT_SET_SYSTEM_AV_INFO\n"); + return false; + case RETRO_ENVIRONMENT_SET_PROC_ADDRESS_CALLBACK: + comm.env.core_get_proc_address = ((retro_get_proc_address_interface*)data)->get_proc_address; + return true; + + case RETRO_ENVIRONMENT_SET_SUBSYSTEM_INFO: + //needs retro_load_game_special to be useful; not supported yet + return false; + + case RETRO_ENVIRONMENT_SET_CONTROLLER_INFO: + //TODO medium priority probably + return false; + + case RETRO_ENVIRONMENT_SET_GEOMETRY: + comm.env.retro_game_geometry = *((const retro_game_geometry *)data); + comm.env.retro_game_geometry_dirty = true; + return true; + + case RETRO_ENVIRONMENT_GET_USERNAME: + //we definitely want to return false here so the core will do something deterministic + return false; + + case RETRO_ENVIRONMENT_GET_LANGUAGE: + *((unsigned *)data) = RETRO_LANGUAGE_ENGLISH; + return true; + } + + return false; +} + +template static inline int* address(int width, int height, int pitch, int x, int y, int* dstbuf, int* optimize0dst) +{ + switch (ROT) + { + case 0: + return optimize0dst; + + case 90: + //TODO: + return optimize0dst; + + case 180: + //TODO: + return optimize0dst; + + case 270: + { + int dx = width - y - 1; + int dy = x; + return dstbuf + dy * width + dx; + } + + default: + //impossible + return 0; + } + +} + +template void Blit555(short* srcbuf, s32* dstbuf, int width, int height, int pitch) +{ + s32* dst = dstbuf; + for (int y = 0; y < height; y++) + { + short* row = srcbuf; + for (int x = 0; x < width; x++) + { + short ci = *row; + int r = ci & 0x001f; + int g = ci & 0x03e0; + int b = ci & 0x7c00; + + r = (r << 3) | (r >> 2); + g = (g >> 2) | (g >> 7); + b = (b >> 7) | (b >> 12); + int co = r | g | b | 0xff000000; + + *address(width, height, pitch, x, y, dstbuf, dst) = co; + dst++; + row++; + } + srcbuf += pitch/2; + } +} + +template void Blit565(short* srcbuf, s32* dstbuf, int width, int height, int pitch) +{ + s32* dst = dstbuf; + for (int y = 0; y < height; y++) + { + short* row = srcbuf; + for (int x = 0; x < width; x++) + { + short ci = *row; + int r = ci & 0x001f; + int g = (ci & 0x07e0) >> 5; + int b = (ci & 0xf800) >> 11; + + r = (r << 3) | (r >> 2); + g = (g << 2) | (g >> 4); + b = (b << 3) | (b >> 2); + int co = (b << 16) | (g << 8) | r; + + *address(width, height, pitch, x, y, dstbuf, dst) = co; + dst++; + row++; + } + srcbuf += pitch/2; + } +} + +template void Blit888(int* srcbuf, s32* dstbuf, int width, int height, int pitch) +{ + s32* dst = dstbuf; + for (int y = 0; y < height; y++) + { + int* row = srcbuf; + for (int x = 0; x < width; x++) + { + int ci = *row; + int co = ci | 0xff000000; + *address(width,height,pitch,x,y,dstbuf,dst) = co; + dst++; + row++; + } + srcbuf += pitch/4; + } +} + +void retro_video_refresh(const void *data, unsigned width, unsigned height, size_t pitch) +{ + //handle a "dup frame" -- same as previous frame. so there isn't anything to be done here + if (!data) + return; + + comm.env.fb_width = (s32)width; + comm.env.fb_height = (s32)height; + + //notify c# of these new settings and let it allocate a buffer suitable for receiving the output (so we can work directly into c#'s int[]) + //c# can read the settings right out of the comm env + //NOPE: not needed. for now, anyway. may want to notify later + //BREAK(eMessage::SIG_VideoUpdate); + + + ////if (BufferWidth != width) BufferWidth = (int)width; + ////if (BufferHeight != height) BufferHeight = (int)height; + ////if (BufferWidth * BufferHeight != rawvidbuff.Length) + //// rawvidbuff = new int[BufferWidth * BufferHeight]; + + ////if we have rotation, we might have a geometry mismatch and in any event we need a temp buffer to do the rotation from + ////but that's a general problem, isnt it? + //if (comm.env.fb.raw == nullptr || comm.env.fb.raw_length != width * height) + //{ + // if(comm.env.fb.raw) + // delete[] comm.env.fb.raw; + // comm.env.fb.raw = new u32[width * height]; + // comm.env.fb.width = width; + // comm.env.fb.height = height; + //} + + int w = (int)width; + int h = (int)height; + int p = (int)pitch; + + switch(comm.env.pixel_format) + { + + case RETRO_PIXEL_FORMAT_0RGB1555: + switch (comm.env.rotation_ccw) + { + case 0: Blit555<0>((short*)data, comm.env.fb_bufptr, w, h, p); break; + case 90: Blit555<90>((short*)data, comm.env.fb_bufptr, w, h, p); break; + case 180: Blit555<180>((short*)data, comm.env.fb_bufptr, w, h, p); break; + case 270: Blit555<270>((short*)data, comm.env.fb_bufptr, w, h, p); break; + } + break; + + case RETRO_PIXEL_FORMAT_XRGB8888: + switch(comm.env.rotation_ccw) + { + case 0: Blit888<0>((int*)data, comm.env.fb_bufptr, w, h, p); break; + case 90: Blit888<90>((int*)data, comm.env.fb_bufptr, w, h, p); break; + case 180: Blit888<180>((int*)data, comm.env.fb_bufptr, w, h, p); break; + case 270: Blit888<270>((int*)data, comm.env.fb_bufptr, w, h, p); break; + } + break; + + case RETRO_PIXEL_FORMAT_RGB565: + switch (comm.env.rotation_ccw) + { + case 0: Blit565<0>((short*)data, comm.env.fb_bufptr, w, h, p); break; + case 90: Blit565<90>((short*)data, comm.env.fb_bufptr, w, h, p); break; + case 180: Blit565<180>((short*)data, comm.env.fb_bufptr, w, h, p); break; + case 270: Blit565<270>((short*)data, comm.env.fb_bufptr, w, h, p); break; + } + break; + } + +} + +void retro_audio_sample(s16 left, s16 right) +{ +} +size_t retro_audio_sample_batch(const s16 *data, size_t frames) +{ + return 0; +} +void retro_input_poll() +{ +} +s16 retro_input_state(unsigned port, unsigned device, unsigned index, unsigned id) +{ + //we have to bail to c# for this, it's too complex. + comm.port = port; + comm.device = device; + comm.index = index; + comm.id = id; + + BREAK(eMessage::BRK_InputState); + + return (s16)comm.value; +} + +//loads the game, too +//REQUIREMENTS: +//set SystemDirectory, SaveDirectory, CoreDirectory, CoreAssetsDirectory are set +//retro_perf_callback is set +static void LoadHandler(eMessage msg) +{ + //retro_set_environment() is guaranteed to be called before retro_init(). + + comm.funs.retro_init(); + + retro_game_info rgi; + memset(&rgi,0,sizeof(rgi)); + + if (msg == eMessage::CMD_LoadNoGame) {} + else + { + rgi.path = (const char*)comm.buf[BufId::Param0]; + if (msg == eMessage::CMD_LoadData) + { + rgi.data = comm.buf[BufId::Param1]; + rgi.size = comm.buf_size[BufId::Param1]; + } + } + + comm.funs.retro_load_game(&rgi); + + //Can be called only after retro_load_game() has successfully completed. + comm.funs.retro_get_system_av_info(&comm.env.retro_system_av_info); + + //guaranteed to have been called before the first call to retro_run() is made. + //(I've put this after the retro_system_av_info runs, in case that's important + comm.funs.retro_set_video_refresh(retro_video_refresh); + + comm.funs.retro_set_audio_sample(retro_audio_sample); + comm.funs.retro_set_audio_sample_batch(retro_audio_sample_batch); + comm.funs.retro_set_input_poll(retro_input_poll); + comm.funs.retro_set_input_state(retro_input_state); + + //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. + comm.env.retro_serialize_size = comm.funs.retro_serialize_size(); + + //not sure when this can be called, but it's surely safe here + comm.env.retro_region = comm.funs.retro_get_region(); +} + +void cmd_LoadNoGame() { LoadHandler(eMessage::CMD_LoadNoGame); } +void cmd_LoadData() { LoadHandler(eMessage::CMD_LoadData); } +void cmd_LoadPath() { LoadHandler(eMessage::CMD_LoadPath); } + +void cmd_Deinit() +{ + //not sure if we need this + comm.funs.retro_unload_game(); + comm.funs.retro_deinit(); + //TODO: tidy +} + +void cmd_Reset() +{ + comm.funs.retro_reset(); +} + +void cmd_Run() +{ + comm.funs.retro_run(); +} + +void cmd_Serialize() +{ + comm.value = !!comm.funs.retro_serialize(comm.buf[BufId::Param0], comm.buf_size[BufId::Param0]); +} + +void cmd_Unserialize() +{ + comm.value = !!comm.funs.retro_unserialize(comm.buf[BufId::Param0], comm.buf_size[BufId::Param0]); +} + +//TODO +//void(*retro_set_controller_port_device)(unsigned, unsigned); +//void *(*retro_get_memory_data)(unsigned); +//size_t(*retro_get_memory_size)(unsigned); + +//TODO low priority +//void(*retro_cheat_reset)(void); +//void(*retro_cheat_set)(unsigned, bool, const char*); +//bool(*retro_load_game_special)(unsigned, + +//TODO maybe not sensible though +//void(*retro_unload_game)(void); + +void cmd_SetEnvironment() +{ + //stuff that can't be done until our environment is setup (the core will immediately query the environment) + comm.funs.retro_set_environment(retro_environment); +} + +const Action kHandlers_CMD[] = { + cmd_SetEnvironment, + cmd_LoadNoGame, + cmd_LoadData, + cmd_LoadPath, + cmd_Deinit, + cmd_Reset, + cmd_Run, + cmd_Serialize, + cmd_Unserialize, +}; + +const Action kHandlers_QUERY[] = { + nullptr +}; + +//------------------------------------------------ +//DLL INTERFACE + +BOOL WINAPI DllMain(_In_ HINSTANCE hinstDLL, _In_ DWORD fdwReason, _In_ LPVOID lpvReserved) +{ + return TRUE; +} + + +extern "C" __declspec(dllexport) void* __cdecl DllInit(HMODULE dllModule) +{ + memset(&comm,0,sizeof(comm)); + + //make a coroutine thread to run the emulation in. we'll switch back to this cothread when communicating with the frontend + co_control = co_active(); + co_emu = co_create(128*1024 * sizeof(void*), new_emuthread); + + //grab all the function pointers we need. + comm.dllModule = dllModule; + comm.LoadSymbols(); + + //libretro startup steps + //"Can be called at any time, even before retro_init()." + comm.funs.retro_get_system_info(&comm.env.retro_system_info); + comm.env.retro_api_version = (u32)comm.funs.retro_api_version(); + + //now after this we return to the c# side to let some more setup happen + + return &comm; +} + + +extern "C" __declspec(dllexport) void __cdecl Message(eMessage msg) +{ + if (msg == eMessage::Resume) + { + cothread_t temp = co_emu_suspended; + co_emu_suspended = NULL; + co_switch(temp); + } + + if (msg >= eMessage::CMD_FIRST && msg <= eMessage::CMD_LAST) + { + //CMD is only valid if status is idle + if (comm.status != eStatus_Idle) + { + printf("ERROR: cmd during non-idle\n"); + return; + } + + comm.status = eStatus_CMD; + comm.cmd = msg; + + CMD_cb = kHandlers_CMD[msg - eMessage::CMD_FIRST - 1]; + co_switch(co_emu); + + //we could be in ANY STATE when we return from here + } + + //QUERY can run any time + //but... some of them might not be safe for re-entrancy. + //later, we should have metadata for messages that indicates that + if (msg >= eMessage::QUERY_FIRST && msg <= eMessage::QUERY_LAST) + { + Action cb = kHandlers_QUERY[msg - eMessage::QUERY_FIRST - 1]; + if (cb) cb(); + } +} + + +//receives the given buffer and COPIES it. use this for returning values from SIGs +extern "C" __declspec(dllexport) void __cdecl CopyBuffer(int id, void* ptr, s32 size) +{ + comm.CopyBuffer(id, ptr, size); +} + +//receives the given buffer and STASHES IT. use this (carefully) for sending params for CMDs +extern "C" __declspec(dllexport) void __cdecl SetBuffer(int id, void* ptr, s32 size) +{ + comm.SetBuffer(id, ptr, size); +} + +extern "C" __declspec(dllexport) void __cdecl SetVariable(const char* key, const char* val) +{ + for(int i=0;i + + + + Debug + Win32 + + + Release + Win32 + + + Debug + x64 + + + Release + x64 + + + + + + + + + + + + + {AEACAA89-FDA2-40C6-910C-85AEB9726452} + Win32Proj + LibretroBridge + 8.1 + + + + DynamicLibrary + true + v140_xp + NotSet + false + + + DynamicLibrary + false + v140_xp + true + NotSet + + + DynamicLibrary + true + v140_xp + NotSet + false + + + DynamicLibrary + false + v140_xp + true + NotSet + + + + + + + + + + + + + + + + + + + + + true + ..\..\output\dll\ + .obj\$(Configuration)\ + + + true + ..\..\output\dll\ + .obj\$(Configuration)\ + + + false + ..\..\output\dll\ + .obj\$(Configuration)\ + + + false + ..\..\output\dll\ + .obj\$(Configuration)\ + + + + + + Level3 + Disabled + WIN32;_DEBUG;_WINDOWS;_USRDLL;LIBRETRO_EXPORTS;%(PreprocessorDefinitions) + MultiThreadedDebugDLL + StreamingSIMDExtensions + Fast + false + + + Windows + true + Default + + + + + + + Level3 + Disabled + _DEBUG;_WINDOWS;_USRDLL;LIBRETRO_EXPORTS;%(PreprocessorDefinitions) + MultiThreadedDebugDLL + StreamingSIMDExtensions + Fast + false + + + Windows + true + Default + + + + + Level3 + + + MaxSpeed + false + true + WIN32;NDEBUG;_WINDOWS;_USRDLL;LIBRETRO_EXPORTS;%(PreprocessorDefinitions) + MultiThreaded + StreamingSIMDExtensions + Fast + + + Windows + true + true + true + + + + + Level3 + + + MaxSpeed + false + true + NDEBUG;_WINDOWS;_USRDLL;LIBRETRO_EXPORTS;%(PreprocessorDefinitions) + MultiThreaded + StreamingSIMDExtensions + Fast + + + Windows + true + true + true + + + + + + + + + + + \ No newline at end of file diff --git a/LibretroBridge/vs2015/dynamic.h b/LibretroBridge/vs2015/dynamic.h new file mode 100644 index 0000000000..49cd807b75 --- /dev/null +++ b/LibretroBridge/vs2015/dynamic.h @@ -0,0 +1,168 @@ +/* RetroArch - A frontend for libretro. +* Copyright (C) 2010-2014 - Hans-Kristian Arntzen +* Copyright (C) 2011-2016 - Daniel De Matteis +* +* RetroArch is free software: you can redistribute it and/or modify it under the terms +* of the GNU General Public License as published by the Free Software Found- +* ation, either version 3 of the License, or (at your option) any later version. +* +* RetroArch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; +* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR +* PURPOSE. See the GNU General Public License for more details. +* +* You should have received a copy of the GNU General Public License along with RetroArch. +* If not, see . +*/ + +#ifndef __DYNAMIC_H +#define __DYNAMIC_H + +#include +#include +#include + +#include "core_type.h" + +RETRO_BEGIN_DECLS + +/** +* libretro_get_environment_info: +* @func : Function pointer for get_environment_info. +* @load_no_content : If true, core should be able to auto-start +* without any content loaded. +* +* Sets environment callback in order to get statically known +* information from it. +* +* Fetched via environment callbacks instead of +* retro_get_system_info(), as this info is part of extensions. +* +* Should only be called once right after core load to +* avoid overwriting the "real" environ callback. +* +* For statically linked cores, pass retro_set_environment as argument. +*/ +void libretro_get_environment_info(void(*)(retro_environment_t), + bool *load_no_content); + +/** +* libretro_get_system_info: +* @path : Path to libretro library. +* @info : System info information. +* @load_no_content : If true, core should be able to auto-start +* without any content loaded. +* +* Gets system info from an arbitrary lib. +* The struct returned must be freed as strings are allocated dynamically. +* +* Returns: true (1) if successful, otherwise false (0). +**/ +bool libretro_get_system_info(const char *path, + struct retro_system_info *info, bool *load_no_content); + +/** +* libretro_free_system_info: +* @info : Pointer to system info information. +* +* Frees system information. +**/ +void libretro_free_system_info(struct retro_system_info *info); + +/** +* libretro_get_current_core_pathname: +* @name : Sanitized name of libretro core. +* @size : Size of @name +* +* Transforms a library id to a name suitable as a pathname. +**/ +void libretro_get_current_core_pathname(char *name, size_t size); + +const struct retro_subsystem_info *libretro_find_subsystem_info( + const struct retro_subsystem_info *info, + unsigned num_info, const char *ident); + +/** +* libretro_find_controller_description: +* @info : Pointer to controller info handle. +* @id : Identifier of controller to search +* for. +* +* Search for a controller of type @id in @info. +* +* Returns: controller description of found controller on success, +* otherwise NULL. +**/ +const struct retro_controller_description * +libretro_find_controller_description( + const struct retro_controller_info *info, unsigned id); + +/** +* rarch_environment_cb: +* @cmd : Identifier of command. +* @data : Pointer to data. +* +* Environment callback function implementation. +* +* Returns: true (1) if environment callback command could +* be performed, otherwise false (0). +**/ +bool rarch_environment_cb(unsigned cmd, void *data); + +struct retro_core_t +{ + void(*retro_init)(void); + void(*retro_deinit)(void); + unsigned(*retro_api_version)(void); + void(*retro_get_system_info)(struct retro_system_info*); + void(*retro_get_system_av_info)(struct retro_system_av_info*); + void(*retro_set_environment)(retro_environment_t); + void(*retro_set_video_refresh)(retro_video_refresh_t); + void(*retro_set_audio_sample)(retro_audio_sample_t); + void(*retro_set_audio_sample_batch)(retro_audio_sample_batch_t); + void(*retro_set_input_poll)(retro_input_poll_t); + void(*retro_set_input_state)(retro_input_state_t); + void(*retro_set_controller_port_device)(unsigned, unsigned); + void(*retro_reset)(void); + void(*retro_run)(void); + size_t(*retro_serialize_size)(void); + bool(*retro_serialize)(void*, size_t); + bool(*retro_unserialize)(const void*, size_t); + void(*retro_cheat_reset)(void); + void(*retro_cheat_set)(unsigned, bool, const char*); + bool(*retro_load_game)(const struct retro_game_info*); + bool(*retro_load_game_special)(unsigned, + const struct retro_game_info*, size_t); + void(*retro_unload_game)(void); + unsigned(*retro_get_region)(void); + void *(*retro_get_memory_data)(unsigned); + size_t(*retro_get_memory_size)(unsigned); +}; + +/** +* init_libretro_sym: +* @type : Type of core to be loaded. +* If CORE_TYPE_DUMMY, will +* load dummy symbols. +* +* Initializes libretro symbols and +* setups environment callback functions. Returns true on success, +* or false if symbols could not be loaded. +**/ +bool init_libretro_sym(enum rarch_core_type type, + struct retro_core_t *core); + +/** +* uninit_libretro_sym: +* +* Frees libretro core. +* +* Frees all core options, +* associated state, and +* unbind all libretro callback symbols. +**/ +void uninit_libretro_sym(struct retro_core_t *core); + +RETRO_END_DECLS + +#endif + diff --git a/LibretroBridge/vs2015/features_cpu.c b/LibretroBridge/vs2015/features_cpu.c new file mode 100644 index 0000000000..fc7f84e445 --- /dev/null +++ b/LibretroBridge/vs2015/features_cpu.c @@ -0,0 +1,776 @@ +/* Copyright (C) 2010-2017 The RetroArch team + * + * --------------------------------------------------------------------------------------- + * The following license statement only applies to this file (features_cpu.c). + * --------------------------------------------------------------------------------------- + * + * 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. + */ + +//modified for bizhawk's libretro shim +#define __i686__ 1 + +#include +#include + +#if defined(_WIN32) +#include +#else +#include +#endif + +//#include +//#include +#include "libretro.h" +//#include + +#if defined(_WIN32) && !defined(_XBOX) +#include +#endif + +#if defined(__CELLOS_LV2__) +#ifndef _PPU_INTRINSICS_H +#include +#endif +#elif defined(_XBOX360) +#include +#elif defined(_POSIX_MONOTONIC_CLOCK) || defined(ANDROID) || defined(__QNX__) || defined(DJGPP) +/* POSIX_MONOTONIC_CLOCK is not being defined in Android headers despite support being present. */ +#include +#endif + +#if defined(__QNX__) && !defined(CLOCK_MONOTONIC) +#define CLOCK_MONOTONIC 2 +#endif + +#if defined(PSP) +#include +#include +#endif + +#if defined(VITA) +#include +#include +#endif + +#if defined(__PSL1GHT__) +#include +#elif defined(__CELLOS_LV2__) +#include +#endif + +#ifdef GEKKO +#include +#endif + +#ifdef WIIU +#include +#endif + +#if defined(_3DS) +#include <3ds/svc.h> +#include <3ds/os.h> +#endif + +/* iOS/OSX specific. Lacks clock_gettime(), so implement it. */ +#ifdef __MACH__ +#include + +#ifndef CLOCK_MONOTONIC +#define CLOCK_MONOTONIC 0 +#endif + +#ifndef CLOCK_REALTIME +#define CLOCK_REALTIME 0 +#endif + +/* this function is part of iOS 10 now */ +static int ra_clock_gettime(int clk_ik, struct timespec *t) +{ + struct timeval now; + int rv = gettimeofday(&now, NULL); + if (rv) + return rv; + t->tv_sec = now.tv_sec; + t->tv_nsec = now.tv_usec * 1000; + return 0; +} +#endif + +#if defined(__MACH__) && __IPHONE_OS_VERSION_MIN_REQUIRED < 100000 +#else +#define ra_clock_gettime clock_gettime +#endif + + +#ifdef EMSCRIPTEN +#include +#endif + +#if defined(BSD) || defined(__APPLE__) +#include +#endif + +#include + +/** + * cpu_features_get_perf_counter: + * + * Gets performance counter. + * + * Returns: performance counter. + **/ +retro_perf_tick_t cpu_features_get_perf_counter(void) +{ + retro_perf_tick_t time_ticks = 0; +#if defined(_WIN32) + long tv_sec, tv_usec; + static const unsigned __int64 epoch = 11644473600000000ULL; + FILETIME file_time; + SYSTEMTIME system_time; + ULARGE_INTEGER ularge; + + GetSystemTime(&system_time); + SystemTimeToFileTime(&system_time, &file_time); + ularge.LowPart = file_time.dwLowDateTime; + ularge.HighPart = file_time.dwHighDateTime; + + tv_sec = (long)((ularge.QuadPart - epoch) / 10000000L); + tv_usec = (long)(system_time.wMilliseconds * 1000); + time_ticks = (1000000 * tv_sec + tv_usec); +#elif defined(__linux__) || defined(__QNX__) || defined(__MACH__) + struct timespec tv = {0}; + if (ra_clock_gettime(CLOCK_MONOTONIC, &tv) == 0) + time_ticks = (retro_perf_tick_t)tv.tv_sec * 1000000000 + + (retro_perf_tick_t)tv.tv_nsec; + +#elif defined(__GNUC__) && defined(__i386__) || defined(__i486__) || defined(__i686__) + __asm__ volatile ("rdtsc" : "=A" (time_ticks)); +#elif defined(__GNUC__) && defined(__x86_64__) + unsigned a, d; + __asm__ volatile ("rdtsc" : "=a" (a), "=d" (d)); + time_ticks = (retro_perf_tick_t)a | ((retro_perf_tick_t)d << 32); +#elif defined(__ARM_ARCH_6__) + __asm__ volatile( "mrc p15, 0, %0, c9, c13, 0" : "=r"(time_ticks) ); +#elif defined(__CELLOS_LV2__) || defined(_XBOX360) || defined(__powerpc__) || defined(__ppc__) || defined(__POWERPC__) + time_ticks = __mftb(); +#elif defined(GEKKO) + time_ticks = gettime(); +#elif defined(PSP) + sceRtcGetCurrentTick((uint64_t*)&time_ticks); +#elif defined(VITA) + sceRtcGetCurrentTick((SceRtcTick*)&time_ticks); +#elif defined(_3DS) + time_ticks = svcGetSystemTick(); +#elif defined(WIIU) + time_ticks = OSGetSystemTime(); +#elif defined(__mips__) + struct timeval tv; + gettimeofday(&tv,NULL); + time_ticks = (1000000 * tv.tv_sec + tv.tv_usec); +#endif + + return time_ticks; +} + +/** + * cpu_features_get_time_usec: + * + * Gets time in microseconds. + * + * Returns: time in microseconds. + **/ +retro_time_t cpu_features_get_time_usec(void) +{ +#if defined(_WIN32) + static LARGE_INTEGER freq; + LARGE_INTEGER count; + + /* Frequency is guaranteed to not change. */ + if (!freq.QuadPart && !QueryPerformanceFrequency(&freq)) + return 0; + + if (!QueryPerformanceCounter(&count)) + return 0; + return count.QuadPart * 1000000 / freq.QuadPart; +#elif defined(__CELLOS_LV2__) + return sys_time_get_system_time(); +#elif defined(GEKKO) + return ticks_to_microsecs(gettime()); +#elif defined(_POSIX_MONOTONIC_CLOCK) || defined(__QNX__) || defined(ANDROID) || defined(__MACH__) + struct timespec tv = {0}; + if (ra_clock_gettime(CLOCK_MONOTONIC, &tv) < 0) + return 0; + return tv.tv_sec * INT64_C(1000000) + (tv.tv_nsec + 500) / 1000; +#elif defined(EMSCRIPTEN) + return emscripten_get_now() * 1000; +#elif defined(__mips__) || defined(DJGPP) + struct timeval tv; + gettimeofday(&tv,NULL); + return (1000000 * tv.tv_sec + tv.tv_usec); +#elif defined(_3DS) + return osGetTime() * 1000; +#elif defined(VITA) + return sceKernelGetProcessTimeWide(); +#elif defined(WIIU) + return ticks_to_us(OSGetSystemTime()); +#else +#error "Your platform does not have a timer function implemented in cpu_features_get_time_usec(). Cannot continue." +#endif +} + +#if defined(__x86_64__) || defined(__i386__) || defined(__i486__) || defined(__i686__) +#define CPU_X86 +#endif + +#if defined(_MSC_VER) && !defined(_XBOX) +#if (_MSC_VER > 1310) +#include +#endif +#endif + +#if defined(CPU_X86) && !defined(__MACH__) +void x86_cpuid(int func, int flags[4]) +{ + /* On Android, we compile RetroArch with PIC, and we + * are not allowed to clobber the ebx register. */ +#ifdef __x86_64__ +#define REG_b "rbx" +#define REG_S "rsi" +#else +#define REG_b "ebx" +#define REG_S "esi" +#endif + +#if defined(__GNUC__) + __asm__ volatile ( + "mov %%" REG_b ", %%" REG_S "\n" + "cpuid\n" + "xchg %%" REG_b ", %%" REG_S "\n" + : "=a"(flags[0]), "=S"(flags[1]), "=c"(flags[2]), "=d"(flags[3]) + : "a"(func)); +#elif defined(_MSC_VER) + __cpuid(flags, func); +#else + printf("Unknown compiler. Cannot check CPUID with inline assembly.\n"); + memset(flags, 0, 4 * sizeof(int)); +#endif +} + +/* Only runs on i686 and above. Needs to be conditionally run. */ +static uint64_t xgetbv_x86(uint32_t idx) +{ +#if defined(__GNUC__) + uint32_t eax, edx; + __asm__ volatile ( + /* Older GCC versions (Apple's GCC for example) do + * not understand xgetbv instruction. + * Stamp out the machine code directly. + */ + ".byte 0x0f, 0x01, 0xd0\n" + : "=a"(eax), "=d"(edx) : "c"(idx)); + return ((uint64_t)edx << 32) | eax; +#elif _MSC_FULL_VER >= 160040219 + /* Intrinsic only works on 2010 SP1 and above. */ + return _xgetbv(idx); +#else + printf("Unknown compiler. Cannot check xgetbv bits.\n"); + return 0; +#endif +} +#endif + +#if defined(__ARM_NEON__) +static void arm_enable_runfast_mode(void) +{ + /* RunFast mode. Enables flush-to-zero and some + * floating point optimizations. */ + static const unsigned x = 0x04086060; + static const unsigned y = 0x03000000; + int r; + __asm__ volatile( + "fmrx %0, fpscr \n\t" /* r0 = FPSCR */ + "and %0, %0, %1 \n\t" /* r0 = r0 & 0x04086060 */ + "orr %0, %0, %2 \n\t" /* r0 = r0 | 0x03000000 */ + "fmxr fpscr, %0 \n\t" /* FPSCR = r0 */ + : "=r"(r) + : "r"(x), "r"(y) + ); +} +#endif + +#if defined(__linux__) && !defined(CPU_X86) +static unsigned char check_arm_cpu_feature(const char* feature) +{ + char line[1024]; + unsigned char status = 0; + RFILE *fp = filestream_open("/proc/cpuinfo", RFILE_MODE_READ_TEXT, -1); + + if (!fp) + return 0; + + while (filestream_gets(fp, line, sizeof(line)) != NULL) + { + if (strncmp(line, "Features\t: ", 11)) + continue; + + if (strstr(line + 11, feature) != NULL) + status = 1; + + break; + } + + filestream_close(fp); + + return status; +} + +#if !defined(_SC_NPROCESSORS_ONLN) +/* Parse an decimal integer starting from 'input', but not going further + * than 'limit'. Return the value into '*result'. + * + * NOTE: Does not skip over leading spaces, or deal with sign characters. + * NOTE: Ignores overflows. + * + * The function returns NULL in case of error (bad format), or the new + * position after the decimal number in case of success (which will always + * be <= 'limit'). + */ +static const char *parse_decimal(const char* input, + const char* limit, int* result) +{ + const char* p = input; + int val = 0; + + while (p < limit) + { + int d = (*p - '0'); + if ((unsigned)d >= 10U) + break; + val = val*10 + d; + p++; + } + if (p == input) + return NULL; + + *result = val; + return p; +} + +/* Parse a textual list of cpus and store the result inside a CpuList object. + * Input format is the following: + * - comma-separated list of items (no spaces) + * - each item is either a single decimal number (cpu index), or a range made + * of two numbers separated by a single dash (-). Ranges are inclusive. + * + * Examples: 0 + * 2,4-127,128-143 + * 0-1 + */ +static void cpulist_parse(CpuList* list, char **buf, ssize_t length) +{ + const char* p = (const char*)buf; + const char* end = p + length; + + /* NOTE: the input line coming from sysfs typically contains a + * trailing newline, so take care of it in the code below + */ + while (p < end && *p != '\n') + { + int val, start_value, end_value; + /* Find the end of current item, and put it into 'q' */ + const char *q = (const char*)memchr(p, ',', end-p); + + if (!q) + q = end; + + /* Get first value */ + p = parse_decimal(p, q, &start_value); + if (p == NULL) + return; + + end_value = start_value; + + /* If we're not at the end of the item, expect a dash and + * and integer; extract end value. + */ + if (p < q && *p == '-') + { + p = parse_decimal(p+1, q, &end_value); + if (p == NULL) + return; + } + + /* Set bits CPU list bits */ + for (val = start_value; val <= end_value; val++) + { + if ((unsigned)val < 32) + list->mask |= (uint32_t)(1U << val); + } + + /* Jump to next item */ + p = q; + if (p < end) + p++; + } +} + +/* Read a CPU list from one sysfs file */ +static void cpulist_read_from(CpuList* list, const char* filename) +{ + ssize_t length; + char *buf = NULL; + + list->mask = 0; + + if (filestream_read_file(filename, (void**)&buf, &length) != 1) + return; + + cpulist_parse(list, &buf, length); + if (buf) + free(buf); + buf = NULL; +} +#endif + +#endif + +/** + * cpu_features_get_core_amount: + * + * Gets the amount of available CPU cores. + * + * Returns: amount of CPU cores available. + **/ +unsigned cpu_features_get_core_amount(void) +{ +#if defined(_WIN32) && !defined(_XBOX) + /* Win32 */ + SYSTEM_INFO sysinfo; + GetSystemInfo(&sysinfo); + return sysinfo.dwNumberOfProcessors; +#elif defined(GEKKO) + return 1; +#elif defined(PSP) + return 1; +#elif defined(VITA) + return 4; +#elif defined(_3DS) + return 1; +#elif defined(WIIU) + return 3; +#elif defined(_SC_NPROCESSORS_ONLN) + /* Linux, most UNIX-likes. */ + long ret = sysconf(_SC_NPROCESSORS_ONLN); + if (ret <= 0) + return (unsigned)1; + return (unsigned)ret; +#elif defined(BSD) || defined(__APPLE__) + /* BSD */ + /* Copypasta from stackoverflow, dunno if it works. */ + int num_cpu = 0; + int mib[4]; + size_t len = sizeof(num_cpu); + + mib[0] = CTL_HW; + mib[1] = HW_AVAILCPU; + sysctl(mib, 2, &num_cpu, &len, NULL, 0); + if (num_cpu < 1) + { + mib[1] = HW_NCPU; + sysctl(mib, 2, &num_cpu, &len, NULL, 0); + if (num_cpu < 1) + num_cpu = 1; + } + return num_cpu; +#elif defined(__linux__) + CpuList cpus_present[1]; + CpuList cpus_possible[1]; + int amount = 0; + + cpulist_read_from(cpus_present, "/sys/devices/system/cpu/present"); + cpulist_read_from(cpus_possible, "/sys/devices/system/cpu/possible"); + + /* Compute the intersection of both sets to get the actual number of + * CPU cores that can be used on this device by the kernel. + */ + cpus_present->mask &= cpus_possible->mask; + amount = __builtin_popcount(cpus_present->mask); + + if (amount == 0) + return 1; + return amount; +#elif defined(_XBOX360) + return 3; +#else + /* No idea, assume single core. */ + return 1; +#endif +} + +/* According to http://en.wikipedia.org/wiki/CPUID */ +#define VENDOR_INTEL_b 0x756e6547 +#define VENDOR_INTEL_c 0x6c65746e +#define VENDOR_INTEL_d 0x49656e69 + +/** + * cpu_features_get: + * + * Gets CPU features.. + * + * Returns: bitmask of all CPU features available. + **/ +uint64_t cpu_features_get(void) +{ + int flags[4]; + int vendor_shuffle[3]; + char vendor[13]; + size_t len = 0; + uint64_t cpu_flags = 0; + uint64_t cpu = 0; + unsigned max_flag = 0; +#if defined(CPU_X86) && !defined(__MACH__) + int vendor_is_intel = 0; + const int avx_flags = (1 << 27) | (1 << 28); +#endif + + char buf[sizeof(" MMX MMXEXT SSE SSE2 SSE3 SSSE3 SS4 SSE4.2 AES AVX AVX2 NEON VMX VMX128 VFPU PS")]; + + memset(buf, 0, sizeof(buf)); + + (void)len; + (void)cpu_flags; + (void)flags; + (void)max_flag; + (void)vendor; + (void)vendor_shuffle; + +#if defined(__MACH__) + len = sizeof(size_t); + if (sysctlbyname("hw.optional.mmx", NULL, &len, NULL, 0) == 0) + { + cpu |= RETRO_SIMD_MMX; + cpu |= RETRO_SIMD_MMXEXT; + } + + len = sizeof(size_t); + if (sysctlbyname("hw.optional.floatingpoint", NULL, &len, NULL, 0) == 0) + { + cpu |= RETRO_SIMD_CMOV; + } + + len = sizeof(size_t); + if (sysctlbyname("hw.optional.sse", NULL, &len, NULL, 0) == 0) + cpu |= RETRO_SIMD_SSE; + + len = sizeof(size_t); + if (sysctlbyname("hw.optional.sse2", NULL, &len, NULL, 0) == 0) + cpu |= RETRO_SIMD_SSE2; + + len = sizeof(size_t); + if (sysctlbyname("hw.optional.sse3", NULL, &len, NULL, 0) == 0) + cpu |= RETRO_SIMD_SSE3; + + len = sizeof(size_t); + if (sysctlbyname("hw.optional.supplementalsse3", NULL, &len, NULL, 0) == 0) + cpu |= RETRO_SIMD_SSSE3; + + len = sizeof(size_t); + if (sysctlbyname("hw.optional.sse4_1", NULL, &len, NULL, 0) == 0) + cpu |= RETRO_SIMD_SSE4; + + len = sizeof(size_t); + if (sysctlbyname("hw.optional.sse4_2", NULL, &len, NULL, 0) == 0) + cpu |= RETRO_SIMD_SSE42; + + len = sizeof(size_t); + if (sysctlbyname("hw.optional.aes", NULL, &len, NULL, 0) == 0) + cpu |= RETRO_SIMD_AES; + + len = sizeof(size_t); + if (sysctlbyname("hw.optional.avx1_0", NULL, &len, NULL, 0) == 0) + cpu |= RETRO_SIMD_AVX; + + len = sizeof(size_t); + if (sysctlbyname("hw.optional.avx2_0", NULL, &len, NULL, 0) == 0) + cpu |= RETRO_SIMD_AVX2; + + len = sizeof(size_t); + if (sysctlbyname("hw.optional.altivec", NULL, &len, NULL, 0) == 0) + cpu |= RETRO_SIMD_VMX; + + len = sizeof(size_t); + if (sysctlbyname("hw.optional.neon", NULL, &len, NULL, 0) == 0) + cpu |= RETRO_SIMD_NEON; + +#elif defined(CPU_X86) + (void)avx_flags; + + x86_cpuid(0, flags); + vendor_shuffle[0] = flags[1]; + vendor_shuffle[1] = flags[3]; + vendor_shuffle[2] = flags[2]; + + vendor[0] = '\0'; + memcpy(vendor, vendor_shuffle, sizeof(vendor_shuffle)); + + /* printf("[CPUID]: Vendor: %s\n", vendor); */ + + vendor_is_intel = ( + flags[1] == VENDOR_INTEL_b && + flags[2] == VENDOR_INTEL_c && + flags[3] == VENDOR_INTEL_d); + + max_flag = flags[0]; + if (max_flag < 1) /* Does CPUID not support func = 1? (unlikely ...) */ + return 0; + + x86_cpuid(1, flags); + + if (flags[3] & (1 << 15)) + cpu |= RETRO_SIMD_CMOV; + + if (flags[3] & (1 << 23)) + cpu |= RETRO_SIMD_MMX; + + if (flags[3] & (1 << 25)) + { + /* SSE also implies MMXEXT (according to FFmpeg source). */ + cpu |= RETRO_SIMD_SSE; + cpu |= RETRO_SIMD_MMXEXT; + } + + + if (flags[3] & (1 << 26)) + cpu |= RETRO_SIMD_SSE2; + + if (flags[2] & (1 << 0)) + cpu |= RETRO_SIMD_SSE3; + + if (flags[2] & (1 << 9)) + cpu |= RETRO_SIMD_SSSE3; + + if (flags[2] & (1 << 19)) + cpu |= RETRO_SIMD_SSE4; + + if (flags[2] & (1 << 20)) + cpu |= RETRO_SIMD_SSE42; + + if ((flags[2] & (1 << 23))) + cpu |= RETRO_SIMD_POPCNT; + + if (vendor_is_intel && (flags[2] & (1 << 22))) + cpu |= RETRO_SIMD_MOVBE; + + if (flags[2] & (1 << 25)) + cpu |= RETRO_SIMD_AES; + + + /* Must only perform xgetbv check if we have + * AVX CPU support (guaranteed to have at least i686). */ + if (((flags[2] & avx_flags) == avx_flags) + && ((xgetbv_x86(0) & 0x6) == 0x6)) + cpu |= RETRO_SIMD_AVX; + + if (max_flag >= 7) + { + x86_cpuid(7, flags); + if (flags[1] & (1 << 5)) + cpu |= RETRO_SIMD_AVX2; + } + + x86_cpuid(0x80000000, flags); + max_flag = flags[0]; + if (max_flag >= 0x80000001u) + { + x86_cpuid(0x80000001, flags); + if (flags[3] & (1 << 23)) + cpu |= RETRO_SIMD_MMX; + if (flags[3] & (1 << 22)) + cpu |= RETRO_SIMD_MMXEXT; + } +#elif defined(__linux__) + if (check_arm_cpu_feature("neon")) + { + cpu |= RETRO_SIMD_NEON; +#ifdef __ARM_NEON__ + arm_enable_runfast_mode(); +#endif + } + + if (check_arm_cpu_feature("vfpv3")) + cpu |= RETRO_SIMD_VFPV3; + + if (check_arm_cpu_feature("vfpv4")) + cpu |= RETRO_SIMD_VFPV4; + + if (check_arm_cpu_feature("asimd")) + { + cpu |= RETRO_SIMD_ASIMD; +#ifdef __ARM_NEON__ + cpu |= RETRO_SIMD_NEON; + arm_enable_runfast_mode(); +#endif + } + +#if 0 + check_arm_cpu_feature("swp"); + check_arm_cpu_feature("half"); + check_arm_cpu_feature("thumb"); + check_arm_cpu_feature("fastmult"); + check_arm_cpu_feature("vfp"); + check_arm_cpu_feature("edsp"); + check_arm_cpu_feature("thumbee"); + check_arm_cpu_feature("tls"); + check_arm_cpu_feature("idiva"); + check_arm_cpu_feature("idivt"); +#endif + +#elif defined(__ARM_NEON__) + cpu |= RETRO_SIMD_NEON; + arm_enable_runfast_mode(); +#elif defined(__ALTIVEC__) + cpu |= RETRO_SIMD_VMX; +#elif defined(XBOX360) + cpu |= RETRO_SIMD_VMX128; +#elif defined(PSP) + cpu |= RETRO_SIMD_VFPU; +#elif defined(GEKKO) + cpu |= RETRO_SIMD_PS; +#endif + + //if (cpu & RETRO_SIMD_MMX) strlcat(buf, " MMX", sizeof(buf)); + //if (cpu & RETRO_SIMD_MMXEXT) strlcat(buf, " MMXEXT", sizeof(buf)); + //if (cpu & RETRO_SIMD_SSE) strlcat(buf, " SSE", sizeof(buf)); + //if (cpu & RETRO_SIMD_SSE2) strlcat(buf, " SSE2", sizeof(buf)); + //if (cpu & RETRO_SIMD_SSE3) strlcat(buf, " SSE3", sizeof(buf)); + //if (cpu & RETRO_SIMD_SSSE3) strlcat(buf, " SSSE3", sizeof(buf)); + //if (cpu & RETRO_SIMD_SSE4) strlcat(buf, " SSE4", sizeof(buf)); + //if (cpu & RETRO_SIMD_SSE42) strlcat(buf, " SSE4.2", sizeof(buf)); + //if (cpu & RETRO_SIMD_AES) strlcat(buf, " AES", sizeof(buf)); + //if (cpu & RETRO_SIMD_AVX) strlcat(buf, " AVX", sizeof(buf)); + //if (cpu & RETRO_SIMD_AVX2) strlcat(buf, " AVX2", sizeof(buf)); + //if (cpu & RETRO_SIMD_NEON) strlcat(buf, " NEON", sizeof(buf)); + //if (cpu & RETRO_SIMD_VFPV3) strlcat(buf, " VFPv3", sizeof(buf)); + //if (cpu & RETRO_SIMD_VFPV4) strlcat(buf, " VFPv4", sizeof(buf)); + //if (cpu & RETRO_SIMD_VMX) strlcat(buf, " VMX", sizeof(buf)); + //if (cpu & RETRO_SIMD_VMX128) strlcat(buf, " VMX128", sizeof(buf)); + //if (cpu & RETRO_SIMD_VFPU) strlcat(buf, " VFPU", sizeof(buf)); + //if (cpu & RETRO_SIMD_PS) strlcat(buf, " PS", sizeof(buf)); + //if (cpu & RETRO_SIMD_ASIMD) strlcat(buf, " ASIMD", sizeof(buf)); + + return cpu; +} diff --git a/LibretroBridge/vs2015/libco/amd64.c b/LibretroBridge/vs2015/libco/amd64.c new file mode 100644 index 0000000000..5f1cfca97a --- /dev/null +++ b/LibretroBridge/vs2015/libco/amd64.c @@ -0,0 +1,104 @@ +/* + libco.amd64 (2009-10-12) + author: byuu + license: public domain +*/ + +#define LIBCO_C +#include "libco.h" +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +static thread_local long long co_active_buffer[64]; +static thread_local cothread_t co_active_handle = 0; +static void (*co_swap)(cothread_t, cothread_t) = 0; + +#ifdef _WIN32 + //ABI: Win64 + static unsigned char co_swap_function[] = { + 0x48, 0x89, 0x22, 0x48, 0x8B, 0x21, 0x58, 0x48, 0x89, 0x6A, 0x08, 0x48, 0x89, 0x72, 0x10, 0x48, + 0x89, 0x7A, 0x18, 0x48, 0x89, 0x5A, 0x20, 0x4C, 0x89, 0x62, 0x28, 0x4C, 0x89, 0x6A, 0x30, 0x4C, + 0x89, 0x72, 0x38, 0x4C, 0x89, 0x7A, 0x40, 0x48, 0x81, 0xC2, 0x80, 0x00, 0x00, 0x00, 0x48, 0x83, + 0xE2, 0xF0, 0x0F, 0x29, 0x32, 0x0F, 0x29, 0x7A, 0x10, 0x44, 0x0F, 0x29, 0x42, 0x20, 0x44, 0x0F, + 0x29, 0x4A, 0x30, 0x44, 0x0F, 0x29, 0x52, 0x40, 0x44, 0x0F, 0x29, 0x5A, 0x50, 0x44, 0x0F, 0x29, + 0x62, 0x60, 0x44, 0x0F, 0x29, 0x6A, 0x70, 0x44, 0x0F, 0x29, 0xB2, 0x80, 0x00, 0x00, 0x00, 0x44, + 0x0F, 0x29, 0xBA, 0x90, 0x00, 0x00, 0x00, 0x48, 0x8B, 0x69, 0x08, 0x48, 0x8B, 0x71, 0x10, 0x48, + 0x8B, 0x79, 0x18, 0x48, 0x8B, 0x59, 0x20, 0x4C, 0x8B, 0x61, 0x28, 0x4C, 0x8B, 0x69, 0x30, 0x4C, + 0x8B, 0x71, 0x38, 0x4C, 0x8B, 0x79, 0x40, 0x48, 0x81, 0xC1, 0x80, 0x00, 0x00, 0x00, 0x48, 0x83, + 0xE1, 0xF0, 0x0F, 0x29, 0x31, 0x0F, 0x29, 0x79, 0x10, 0x44, 0x0F, 0x29, 0x41, 0x20, 0x44, 0x0F, + 0x29, 0x49, 0x30, 0x44, 0x0F, 0x29, 0x51, 0x40, 0x44, 0x0F, 0x29, 0x59, 0x50, 0x44, 0x0F, 0x29, + 0x61, 0x60, 0x44, 0x0F, 0x29, 0x69, 0x70, 0x44, 0x0F, 0x29, 0xB1, 0x80, 0x00, 0x00, 0x00, 0x44, + 0x0F, 0x29, 0xB9, 0x90, 0x00, 0x00, 0x00, 0xFF, 0xE0, + }; + + #include + + void co_init() { + DWORD old_privileges; + VirtualProtect(co_swap_function, sizeof co_swap_function, PAGE_EXECUTE_READWRITE, &old_privileges); + } +#else + //ABI: SystemV + static unsigned char co_swap_function[] = { + 0x48, 0x89, 0x26, 0x48, 0x8B, 0x27, 0x58, 0x48, 0x89, 0x6E, 0x08, 0x48, 0x89, 0x5E, 0x10, 0x4C, + 0x89, 0x66, 0x18, 0x4C, 0x89, 0x6E, 0x20, 0x4C, 0x89, 0x76, 0x28, 0x4C, 0x89, 0x7E, 0x30, 0x48, + 0x8B, 0x6F, 0x08, 0x48, 0x8B, 0x5F, 0x10, 0x4C, 0x8B, 0x67, 0x18, 0x4C, 0x8B, 0x6F, 0x20, 0x4C, + 0x8B, 0x77, 0x28, 0x4C, 0x8B, 0x7F, 0x30, 0xFF, 0xE0, + }; + + #include + #include + + void co_init() { + unsigned long long addr = (unsigned long long)co_swap_function; + unsigned long long base = addr - (addr % sysconf(_SC_PAGESIZE)); + unsigned long long size = (addr - base) + sizeof co_swap_function; + mprotect((void*)base, size, PROT_READ | PROT_WRITE | PROT_EXEC); + } +#endif + +static void crash() { + assert(0); /* called only if cothread_t entrypoint returns */ +} + +cothread_t co_active() { + if(!co_active_handle) co_active_handle = &co_active_buffer; + return co_active_handle; +} + +cothread_t co_create(unsigned int size, void (*entrypoint)(void)) { + cothread_t handle; + if(!co_swap) { + co_init(); + co_swap = (void (*)(cothread_t, cothread_t))co_swap_function; + } + if(!co_active_handle) co_active_handle = &co_active_buffer; + size += 512; /* allocate additional space for storage */ + size &= ~15; /* align stack to 16-byte boundary */ + + if(handle = (cothread_t)malloc(size)) { + long long *p = (long long*)((char*)handle + size); /* seek to top of stack */ + *--p = (long long)crash; /* crash if entrypoint returns */ + *--p = (long long)entrypoint; /* start of function */ + *(long long*)handle = (long long)p; /* stack pointer */ + } + + return handle; +} + +void co_delete(cothread_t handle) { + free(handle); +} + +void co_switch(cothread_t handle) { + register cothread_t co_previous_handle = co_active_handle; + co_swap(co_active_handle = handle, co_previous_handle); +} + +#ifdef __cplusplus +} +#endif diff --git a/LibretroBridge/vs2015/libco/libco.h b/LibretroBridge/vs2015/libco/libco.h new file mode 100644 index 0000000000..a32f95fdad --- /dev/null +++ b/LibretroBridge/vs2015/libco/libco.h @@ -0,0 +1,38 @@ +/* + libco + version: 0.16 (2010-12-24) + license: public domain +*/ + +#ifndef LIBCO_H +#define LIBCO_H + +#ifdef LIBCO_C + #ifdef LIBCO_MP + #define thread_local __thread + #else + #define thread_local + #endif +#endif + +#ifdef __cplusplus +extern "C" { +#endif + +typedef void* cothread_t; +typedef void (*coentry_t)(void); + +void* co_getstack(cothread_t); +cothread_t co_active(); +cothread_t co_create_withstack(void* stack, int stacksize, coentry_t); +cothread_t co_create(unsigned int, coentry_t); +void co_delete(cothread_t); +void co_switch(cothread_t); +cothread_t co_primary(); + +#ifdef __cplusplus +} +#endif + +/* ifndef LIBCO_H */ +#endif diff --git a/LibretroBridge/vs2015/libco/sjlj-multi.c b/LibretroBridge/vs2015/libco/sjlj-multi.c new file mode 100644 index 0000000000..2ba14cfe84 --- /dev/null +++ b/LibretroBridge/vs2015/libco/sjlj-multi.c @@ -0,0 +1,237 @@ +/* +original author: Nach +license: public domain + +additional work: zeromus +note: more ARM compilers are supported here (check the ifdefs in _JUMP_BUFFER) +and: work has been done to make this coexist more peaceably with .net +*/ + + + +#define LIBCO_C +#include "libco.h" +#include +#include +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +typedef struct +{ + jmp_buf context; + coentry_t coentry; + void *stack; + unsigned long seh_frame, stack_top, stack_bottom; + cothread_t caller; + int ownstack; +} cothread_struct; + +static thread_local cothread_struct _co_primary; +static thread_local cothread_struct *co_running = 0; + +cothread_t co_primary() { return (cothread_t)&_co_primary; } + + +//------------------- +#ifdef _MSC_VER + +//links of interest +//http://connect.microsoft.com/VisualStudio/feedback/details/100319/really-wierd-behaviour-in-crt-io-coupled-with-some-inline-assembly +//http://en.wikipedia.org/wiki/Thread_Information_Block +//http://social.msdn.microsoft.com/Forums/en-US/vclanguage/thread/72093e46-4524-4f54-9f36-c7e8a309d1db/ //FS warning + + +#define WINVER 0x0400 +#define _WIN32_WINNT 0x0400 +#define WIN32_LEAN_AND_MEAN +#include + +#pragma warning(disable:4733) +#pragma warning(disable:4311) + +static void capture_fs(cothread_struct* rec) +{ + int temp; + __asm mov eax, dword ptr fs:[0]; + __asm mov temp, eax; + rec->seh_frame = temp; + __asm mov eax, dword ptr fs:[4]; + __asm mov temp, eax; + rec->stack_top = temp; + __asm mov eax, dword ptr fs:[8]; + __asm mov temp, eax; + rec->stack_bottom = temp; +} + +static void restore_fs(cothread_struct* rec) +{ + int temp; + temp = rec->seh_frame; + __asm mov eax, temp; + __asm mov dword ptr fs:[0], eax + temp = rec->stack_top; + __asm mov eax, temp; + __asm mov dword ptr fs:[4], eax + temp = rec->stack_bottom; + __asm mov eax, temp; + __asm mov dword ptr fs:[8], eax +} + +static void os_co_wrapper() +{ + cothread_struct* rec = (cothread_struct*)co_active(); + __try + { + rec->coentry(); + } + __except(EXCEPTION_EXECUTE_HANDLER) + { + //unhandled win32 exception in coroutine. + //this coroutine will now be suspended permanently and control will be yielded to caller, for lack of anything better to do. + //perhaps the process should just terminate. + for(;;) + { + //dead coroutine + co_switch(rec->caller); + } + } +} + +static void os_co_create(cothread_struct* rec, unsigned int size, coentry_t coentry) +{ + _JUMP_BUFFER* jb = (_JUMP_BUFFER*)&rec->context; + cothread_struct temp; + + jb->Esp = (unsigned long)rec->stack + size - 4; + jb->Eip = (unsigned long)os_co_wrapper; + + rec->stack_top = jb->Esp + 4; + rec->stack_bottom = (unsigned long)rec->stack; + + //wild assumption about SEH frame.. seems to work + capture_fs(&temp); + rec->seh_frame = temp.seh_frame; +} + +static void os_pre_setjmp(cothread_t target) +{ + cothread_struct* rec = (cothread_struct*)target; + capture_fs(co_running); + rec->caller = co_running; +} + +static void os_pre_longjmp(cothread_struct* rec) +{ + restore_fs(rec); +} + +#elif defined(__ARM_EABI__) || defined(__ARMCC_VERSION) + +//http://sourceware.org/cgi-bin/cvsweb.cgi/src/newlib/libc/machine/arm/setjmp.S?rev=1.5&content-type=text/x-cvsweb-markup&cvsroot=src + +typedef struct +{ +#ifdef LIBCO_ARM_JUMBLED + int r8,r9,r10,r11,lr,r4,r5,r6,r7,sp; +#else + int r4,r5,r6,r7,r8,r9,r10,fp; + #ifndef LIBCO_ARM_NOIP + int ip; + #endif + int sp,lr; +#endif +} _JUMP_BUFFER; + +static void os_co_create(cothread_struct* rec, unsigned int size, coentry_t coentry) +{ + _JUMP_BUFFER* jb = (_JUMP_BUFFER*)&rec->context; + + jb->sp = (unsigned long)rec->stack + size - 4; + jb->lr = (unsigned long)coentry; +} + +static void os_pre_setjmp(cothread_t target) +{ + cothread_struct* rec = (cothread_struct*)target; + rec->caller = co_running; +} + +static void os_pre_longjmp(cothread_struct* rec) +{ +} + +#else +#error "sjlj-multi: unsupported processor, compiler or operating system" +#endif +//------------------- + +cothread_t co_active() +{ + if(!co_running) co_running = &_co_primary; + return (cothread_t)co_running; +} + +void* co_getstack(cothread_t cothread) +{ + return ((cothread_struct*)cothread)->stack; +} + +cothread_t co_create(unsigned int stacksize, coentry_t coentry) +{ + cothread_struct* ret = (cothread_struct*)co_create_withstack(malloc(stacksize), stacksize, coentry); + if(ret) + ret->ownstack = 1; + return (cothread_t)ret; +} + +cothread_t co_create_withstack(void* stack, int stacksize, coentry_t coentry) +{ + cothread_struct *thread; + + if(!co_running) co_running = &_co_primary; + + thread = (cothread_struct*)malloc(sizeof(cothread_struct)); + if(thread) + { + thread->coentry = coentry; + thread->stack = stack; + + { + setjmp(thread->context); + os_co_create(thread,stacksize,coentry); + } + thread->ownstack = 0; + } + + return (cothread_t)thread; +} + +void co_delete(cothread_t cothread) +{ + if(cothread) + { + cothread_struct* thread = (cothread_struct*)cothread; + if (thread->ownstack) + free(thread->stack); + free(cothread); + } +} + +void co_switch(cothread_t cothread) +{ + os_pre_setjmp(cothread); + if(!setjmp(co_running->context)) + { + co_running = (cothread_struct*)cothread; + os_pre_longjmp(co_running); + longjmp(co_running->context,0); + } +} + +#ifdef __cplusplus +} +#endif diff --git a/LibretroBridge/vs2015/libco/x86.c b/LibretroBridge/vs2015/libco/x86.c new file mode 100644 index 0000000000..ebfc239535 --- /dev/null +++ b/LibretroBridge/vs2015/libco/x86.c @@ -0,0 +1,117 @@ +/* + libco.x86 (2009-10-12) + author: byuu + license: public domain +*/ + +#define LIBCO_C +#include "libco.h" +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#if defined(_MSC_VER) + #define fastcall __fastcall +#elif defined(__GNUC__) + #define fastcall __attribute__((fastcall)) +#else + #error "libco: please define fastcall macro" +#endif + +static thread_local long co_active_buffer[64]; +static thread_local cothread_t co_active_handle = 0; +static void (fastcall *co_swap)(cothread_t, cothread_t) = 0; + +//ABI: fastcall +static unsigned char co_swap_function[] = { + 0x89, 0x22, /* mov [edx],esp */ + 0x8b, 0x21, /* mov esp,[ecx] */ + 0x58, /* pop eax */ + 0x89, 0x6a, 0x04, /* mov [edx+0x04],ebp */ + 0x89, 0x72, 0x08, /* mov [edx+0x08],esi */ + 0x89, 0x7a, 0x0c, /* mov [edx+0x0c],edi */ + 0x89, 0x5a, 0x10, /* mov [edx+0x10],ebx */ + 0x8b, 0x69, 0x04, /* mov ebp,[ecx+0x04] */ + 0x8b, 0x71, 0x08, /* mov esi,[ecx+0x08] */ + 0x8b, 0x79, 0x0c, /* mov edi,[ecx+0x0c] */ + 0x8b, 0x59, 0x10, /* mov ebx,[ecx+0x10] */ + 0xff, 0xe0, /* jmp eax */ +}; + +#ifdef _WIN32 +#include + +void co_init(void) +{ + DWORD old_privileges; + VirtualProtect(co_swap_function, + sizeof co_swap_function, PAGE_EXECUTE_READWRITE, &old_privileges); +} +#else +#include +#include + +void co_init(void) +{ + unsigned long addr = (unsigned long)co_swap_function; + unsigned long base = addr - (addr % sysconf(_SC_PAGESIZE)); + unsigned long size = (addr - base) + sizeof co_swap_function; + mprotect((void*)base, size, PROT_READ | PROT_WRITE | PROT_EXEC); +} +#endif + +static void crash(void) +{ + assert(0); /* called only if cothread_t entrypoint returns */ +} + +cothread_t co_active(void) +{ + if(!co_active_handle) + co_active_handle = &co_active_buffer; + return co_active_handle; +} + +cothread_t co_create(unsigned int size, void (*entrypoint)(void)) +{ + cothread_t handle; + if(!co_swap) + { + co_init(); + co_swap = (void (fastcall*)(cothread_t, cothread_t))co_swap_function; + } + + if(!co_active_handle) + co_active_handle = &co_active_buffer; + + size += 256; /* allocate additional space for storage */ + size &= ~15; /* align stack to 16-byte boundary */ + + if((handle = (cothread_t)malloc(size))) + { + long *p = (long*)((char*)handle + size); /* seek to top of stack */ + *--p = (long)crash; /* crash if entrypoint returns */ + *--p = (long)entrypoint; /* start of function */ + *(long*)handle = (long)p; /* stack pointer */ + } + + return handle; +} + +void co_delete(cothread_t handle) +{ + free(handle); +} + +void co_switch(cothread_t handle) +{ + register cothread_t co_previous_handle = co_active_handle; + co_swap(co_active_handle = handle, co_previous_handle); +} + +#ifdef __cplusplus +} +#endif diff --git a/LibretroBridge/vs2015/libretro.h b/LibretroBridge/vs2015/libretro.h new file mode 100644 index 0000000000..89947ebe44 --- /dev/null +++ b/LibretroBridge/vs2015/libretro.h @@ -0,0 +1,2163 @@ +/* Copyright (C) 2010-2017 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 +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#ifndef __cplusplus +#if defined(_MSC_VER) && !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 +#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 && !defined(__CELLOS_LV2__) +# 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 X/Y coordinates are reported relatively to last poll, + * similar to mouse. */ +#define RETRO_DEVICE_LIGHTGUN 4 + +/* The ANALOG device is an extension to JOYPAD (RetroPad). + * Similar to DualShock it adds two analog sticks. + * This is treated as a separate device type as it returns values in the + * full analog range of [-0x8000, 0x7fff]. Positive X axis is right. + * Positive Y axis is down. + * Only use ANALOG type when polling for analog values of the axes. + */ +#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. */ +#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 + +/* Index / Id values for ANALOG device. */ +#define RETRO_DEVICE_INDEX_ANALOG_LEFT 0 +#define RETRO_DEVICE_INDEX_ANALOG_RIGHT 1 +#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 + +/* Id values for LIGHTGUN types. */ +#define RETRO_DEVICE_ID_LIGHTGUN_X 0 +#define RETRO_DEVICE_ID_LIGHTGUN_Y 1 +#define RETRO_DEVICE_ID_LIGHTGUN_TRIGGER 2 +#define RETRO_DEVICE_ID_LIGHTGUN_CURSOR 3 +#define RETRO_DEVICE_ID_LIGHTGUN_TURBO 4 +#define RETRO_DEVICE_ID_LIGHTGUN_PAUSE 5 +#define RETRO_DEVICE_ID_LIGHTGUN_START 6 + +/* 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 + +/* 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 = 7, + RETRO_LANGUAGE_RUSSIAN = 8, + RETRO_LANGUAGE_KOREAN = 9, + RETRO_LANGUAGE_CHINESE_TRADITIONAL = 10, + RETRO_LANGUAGE_CHINESE_SIMPLIFIED = 11, + RETRO_LANGUAGE_ESPERANTO = 12, + RETRO_LANGUAGE_POLISH = 13, + RETRO_LANGUAGE_VIETNAMESE = 14, + 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_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_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. + * Is only implemented if rotation can be accelerated by hardware. + * 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 * -- + * 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 as early as possible (ideally in + * retro_set_environment). + * + * '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_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_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_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. + */ +#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 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. + * This directory can be used to store SRAM, memory cards, + * high scores, etc, if the libretro core + * cannot use the regular memory interface (retro_get_memory_data()). + * + * NOTE: libretro cores used to check GET_SYSTEM_DIRECTORY for + * similar things before. + * They should still check GET_SYSTEM_DIRECTORY if they want to + * be backwards compatible. + * The path here can be NULL. It should only be non-NULL if the + * frontend user has set a specific save path. + */ +#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 types 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 covered by the libretro input API. + * + * In order for a frontend to understand the workings of an input device, + * it must be a specialized type + * of the generic device types already defined in the libretro API. + * + * Which devices are supported can vary per input port. + * The core must pass an array of const struct retro_controller_info which + * is terminated with a blanked out struct. Each element of the struct + * corresponds to an ascending port index to + * retro_set_controller_port_device(). + * 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). + */ + +enum retro_hw_render_interface_type +{ + RETRO_HW_RENDER_INTERFACE_VULKAN = 0, + 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; +}; +#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. + */ + +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; +}; +#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. + */ + +/* 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_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_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_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 + * (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_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 + +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; +}; + +/* 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, + + 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. + * 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); + +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; +}; + +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. */ +}; + +/* 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 retro_deinit() is called. */ + + 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. */ + + /* If true, retro_load_game() is guaranteed to provide a valid pathname + * in retro_game_info::path. + * ::data and ::size are both invalid. + * + * If false, ::data and ::size are guaranteed to be valid, but ::path + * might not be valid. + * + * This is typically set to true for libretro implementations that must + * load from file. + * Implementations should strive for setting this to false, as it allows + * the frontend to perform patching, etc. */ + 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; +}; + +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_game_info +{ + const char *path; /* Path to game, UTF-8 encoded. + * Usually used as a reference. + * May be NULL if rom was loaded from stdin + * or similar. + * retro_system_info::need_fullpath guaranteed + * 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. */ +}; + +/* 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. */ +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. */ +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 a currently loaded game. */ +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