From 5cdca08335bb37edfff3ab6da15f2e0cecbfaa97 Mon Sep 17 00:00:00 2001 From: aliaspider Date: Wed, 22 Mar 2023 21:57:51 +0100 Subject: [PATCH] libretro port --- .clang-format | 2 +- .gitignore | 11 + CMakeLists.txt | 11 + cmake/BuildParameters.cmake | 42 + cmake/SearchForStuff.cmake | 11 + common/CMakeLists.txt | 2 +- common/GL/Context.cpp | 8 +- common/GL/ContextRetroGL.cpp | 93 + common/GL/ContextRetroGL.h | 40 + common/Perf.h | 1 + common/Vulkan/Builders.cpp | 1 + common/WindowInfo.h | 3 +- libretro/CMakeLists.txt | 69 + libretro/Console.cpp | 81 + libretro/DEV9.cpp | 189 ++ libretro/InputRecording.cpp | 103 + libretro/SPU2.cpp | 48 + libretro/USB.cpp | 31 + libretro/build.cmake | 256 ++ libretro/input.cpp | 277 ++ libretro/input.h | 9 + libretro/libretro.h | 3026 ++++++++++++++++++++ libretro/libretro_d3d.h | 56 + libretro/main.cpp | 1069 +++++++ libretro/options.cpp | 44 + libretro/options.h | 203 ++ pcsx2/CDVD/CDVD.cpp | 2 + pcsx2/CMakeLists.txt | 60 +- pcsx2/Config.h | 3 + pcsx2/Frontend/CommonHotkeys.cpp | 4 + pcsx2/Frontend/FullscreenUI.cpp | 14 +- pcsx2/Frontend/GameList.cpp | 2 + pcsx2/Frontend/LogSink.cpp | 3 +- pcsx2/Frontend/OpenGLHostDisplay.cpp | 9 +- pcsx2/GS.cpp | 2 + pcsx2/GS.h | 13 +- pcsx2/GS/GS.cpp | 11 + pcsx2/GS/GS.h | 9 + pcsx2/GS/Renderers/Common/GSFastList.h | 1 + pcsx2/GS/Renderers/Common/GSRenderer.cpp | 5 + pcsx2/GS/Renderers/Common/GSTexture.cpp | 4 + pcsx2/GS/Renderers/DX11/GSDevice11.cpp | 89 + pcsx2/GS/Renderers/DX11/GSDevice11.h | 7 + pcsx2/GS/Renderers/DX11/GSTexture11.cpp | 4 + pcsx2/GS/Renderers/OpenGL/GSDeviceOGL.cpp | 31 +- pcsx2/GS/Renderers/OpenGL/GSTextureOGL.cpp | 8 +- pcsx2/GS/Renderers/SW/GSTextureSW.cpp | 4 + pcsx2/GSDumpReplayer.cpp | 2 + pcsx2/MTGS.cpp | 117 +- pcsx2/MTVU.cpp | 2 + pcsx2/PAD/Host/PAD.cpp | 4 + pcsx2/PAD/Host/StateManagement.cpp | 2 + pcsx2/PINE.cpp | 6 +- pcsx2/Pcsx2Config.cpp | 5 + pcsx2/SPU2/Mixer.cpp | 6 +- pcsx2/SPU2/Reverb.cpp | 2 +- pcsx2/SPU2/spu2sys.cpp | 2 + pcsx2/StateWrapper.h | 1 + pcsx2/System.cpp | 2 +- pcsx2/VMManager.cpp | 3 +- pcsx2/VirtualMemory.cpp | 3 + 61 files changed, 6082 insertions(+), 46 deletions(-) create mode 100644 common/GL/ContextRetroGL.cpp create mode 100644 common/GL/ContextRetroGL.h create mode 100644 libretro/CMakeLists.txt create mode 100644 libretro/Console.cpp create mode 100644 libretro/DEV9.cpp create mode 100644 libretro/InputRecording.cpp create mode 100644 libretro/SPU2.cpp create mode 100644 libretro/USB.cpp create mode 100644 libretro/build.cmake create mode 100644 libretro/input.cpp create mode 100644 libretro/input.h create mode 100644 libretro/libretro.h create mode 100644 libretro/libretro_d3d.h create mode 100644 libretro/main.cpp create mode 100644 libretro/options.cpp create mode 100644 libretro/options.h diff --git a/.clang-format b/.clang-format index 892b6acfabccd5..be22fb1c42de6c 100644 --- a/.clang-format +++ b/.clang-format @@ -61,7 +61,7 @@ KeepEmptyLinesAtTheStartOfBlocks: true MacroBlockBegin: '' MacroBlockEnd: '' MaxEmptyLinesToKeep: 3 -NamespaceIndentation: All +NamespaceIndentation: None ObjCBlockIndentWidth: 2 ObjCSpaceAfterProperty: false ObjCSpaceBeforeProtocolList: true diff --git a/.gitignore b/.gitignore index f0f79ef187219b..080ab5d0efa4b8 100644 --- a/.gitignore +++ b/.gitignore @@ -99,3 +99,14 @@ oprofile_data/ CMakeSettings.json /ci-artifacts/ /out/ + +bin/* +build*/ +*.cflags +*.config +*.creator +*.creator.user.* +*.cxxflags +*.files +*.includes +*.autosave diff --git a/CMakeLists.txt b/CMakeLists.txt index a76f32457d32a5..ac57f61f5280d4 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -32,6 +32,13 @@ include(Pcsx2Utils) check_no_parenthesis_in_path() detectOperatingSystem() check_compiler_version("7.0" "7.0") +if(NOT MSVC) + find_program(CCACHE_FOUND ccache) + if(CCACHE_FOUND) + set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ${CCACHE_FOUND}) + set_property(GLOBAL PROPERTY RULE_LAUNCH_LINK ${CCACHE_FOUND}) + endif() +endif() #------------------------------------------------------------------------------- # Include specific module @@ -60,6 +67,10 @@ if (QT_BUILD) endif() endif() +if(LIBRETRO) + add_subdirectory(libretro) +endif() + # tests if(ACTUALLY_ENABLE_TESTS) set(gtest_force_shared_crt ON CACHE BOOL "" FORCE) diff --git a/cmake/BuildParameters.cmake b/cmake/BuildParameters.cmake index 83f2347459d60e..9ab939a3b068fc 100644 --- a/cmake/BuildParameters.cmake +++ b/cmake/BuildParameters.cmake @@ -6,6 +6,7 @@ set(PCSX2_DEFS "") #------------------------------------------------------------------------------- option(DISABLE_BUILD_DATE "Disable including the binary compile date") option(ENABLE_TESTS "Enables building the unit tests" ON) +option(LIBRETRO "Enables building the libretro core" OFF) set(USE_SYSTEM_LIBS "AUTO" CACHE STRING "Use system libraries instead of bundled libraries. ON - Always use system and fail if unavailable, OFF - Always use bundled, AUTO - Use system if available, otherwise use bundled. Default is AUTO") optional_system_library(fmt) optional_system_library(ryml) @@ -13,6 +14,20 @@ optional_system_library(zstd) optional_system_library(libzip) optional_system_library(SDL2) option(LTO_PCSX2_CORE "Enable LTO/IPO/LTCG on the subset of pcsx2 that benefits most from it but not anything else") + +if(LIBRETRO) + set(ENABLE_TESTS OFF) + set(CMAKE_BUILD_PO FALSE) + set(BUILD_REPLAY_LOADERS FALSE) + set(CUBEB_API FALSE) + set(DISABLE_SETCAP TRUE) + set(USE_VULKAN FALSE) + set(USE_DISCORD_PRESENCE FALSE) + set(USE_ACHIEVEMENTS OFF) + set(QT_BUILD OFF) + add_definitions(-D__LIBRETRO__ -DwxUSE_GUI=0) +endif() + option(USE_VTUNE "Plug VTUNE to profile GS JIT.") option(USE_ACHIEVEMENTS "Build with RetroAchievements support" ON) option(USE_DISCORD_PRESENCE "Enable support for Discord Rich Presence" ON) @@ -135,6 +150,32 @@ endif() string(REPLACE " " ";" ARCH_FLAG_LIST "${ARCH_FLAG}") add_compile_options("${ARCH_FLAG_LIST}") +#if(MSVC) +# set(ARCH_FLAG) +# # add_compile_options(/permissive-) +# # add_compile_options(/Zc:inline) +# # add_compile_options(/Zc:throwingNew) +# # add_compile_options(/volatile:iso) +# #string(APPEND CMAKE_EXE_LINKER_FLAGS " /NXCOMPAT") +## add_compile_options(/EHsc) +# add_compile_options(/EHa) +# add_compile_options(/MP) +# if(CMAKE_BUILD_TYPE MATCHES "Release") +# add_definitions(-DNDEBUG) +# else() +# if(CMAKE_BUILD_TYPE MATCHES "Debug") +# add_definitions(-D_DEBUG -DPCSX2_DEVBUILD -DPCSX2_DEBUG) +# else() +# add_definitions(-DNDEBUG -DPCSX2_DEVBUILD -D_DEVEL) +# endif() +# add_compile_options(/Zi) +# add_link_options(/DEBUG) +# endif() +# add_definitions(-D__WIN32__ -DWIN32 -D_WINDOWS -D_CRT_SECURE_NO_WARNINGS -D_CRT_SECURE_NO_DEPRECATE) +# add_definitions(${PLUGIN_SUPPORT}) +# add_definitions(-D_ARCH_64=1 -D_M_X86_64 -D__M_X86_64) +# add_definitions(/wd4063 /wd4100 /wd4267 /wd4244 /wd4244 /wd4312 /wd4334) +#else(MSVC) #------------------------------------------------------------------------------- # Set some default compiler flags #------------------------------------------------------------------------------- @@ -238,6 +279,7 @@ endif() if(USE_PGO_OPTIMIZE) add_compile_options(-fprofile-use) endif() +#endif(MSVC) list(APPEND PCSX2_DEFS "$<$:PCSX2_DEVBUILD;PCSX2_DEBUG;_DEBUG>" diff --git a/cmake/SearchForStuff.cmake b/cmake/SearchForStuff.cmake index ea84fd65cc8dbc..da570585450ef3 100644 --- a/cmake/SearchForStuff.cmake +++ b/cmake/SearchForStuff.cmake @@ -44,7 +44,9 @@ else() find_package(ZLIB REQUIRED) ## Use pcsx2 package to find module +# if (NOT MSVC) include(FindLibc) +# endif() ## Use CheckLib package to find module include(CheckLib) @@ -89,6 +91,15 @@ else() endif() endif(WIN32) +#if(MSVC) +# add_definitions(-DPTW32_STATIC_LIB) +## add_definitions(-D__CLEANUP_SEH) +# add_subdirectory(${CMAKE_SOURCE_DIR}/3rdparty/pthreads4w) +# include_directories(${CMAKE_SOURCE_DIR}/3rdparty/pthreads4w/include) +# add_subdirectory(${CMAKE_SOURCE_DIR}/3rdparty/baseclasses) +## include_directories(${CMAKE_SOURCE_DIR}/3rdparty/baseclasses) +#endif() + # Require threads on all OSes. find_package(Threads REQUIRED) diff --git a/common/CMakeLists.txt b/common/CMakeLists.txt index 2c3c9a8442681a..b913256f9c03b9 100644 --- a/common/CMakeLists.txt +++ b/common/CMakeLists.txt @@ -305,6 +305,6 @@ target_include_directories(common PUBLIC ../3rdparty/include ../) target_compile_definitions(common PUBLIC "${PCSX2_DEFS}") target_compile_options(common PRIVATE "${PCSX2_WARNINGS}") -if(COMMAND target_precompile_headers) +if(COMMAND target_precompile_headers AND NOT CCACHE_FOUND) target_precompile_headers(common PRIVATE PrecompiledHeader.h) endif() diff --git a/common/GL/Context.cpp b/common/GL/Context.cpp index 8af1b834c2fbf2..b3c13d42581da6 100644 --- a/common/GL/Context.cpp +++ b/common/GL/Context.cpp @@ -28,7 +28,9 @@ #include #endif -#if defined(_WIN32) && !defined(_M_ARM64) +#if defined(__LIBRETRO__) +#include "common/GL/ContextRetroGL.h" +#elif defined(_WIN32) && !defined(_M_ARM64) #include "common/GL/ContextWGL.h" #elif defined(__APPLE__) #include "common/GL/ContextAGL.h" @@ -100,6 +102,9 @@ namespace GL } std::unique_ptr context; +#if defined(__LIBRETRO__) + context = ContextRetroGL::Create(wi, versions_to_try); +#else #if defined(_WIN32) && !defined(_M_ARM64) context = ContextWGL::Create(wi, versions_to_try); #elif defined(__APPLE__) @@ -114,6 +119,7 @@ namespace GL #if defined(WAYLAND_API) if (wi.type == WindowInfo::Type::Wayland) context = ContextEGLWayland::Create(wi, versions_to_try); +#endif #endif if (!context) diff --git a/common/GL/ContextRetroGL.cpp b/common/GL/ContextRetroGL.cpp new file mode 100644 index 00000000000000..b300b02619e03a --- /dev/null +++ b/common/GL/ContextRetroGL.cpp @@ -0,0 +1,93 @@ +/* PCSX2 - PS2 Emulator for PCs + * Copyright (C) 2002-2021 PCSX2 Dev Team + * + * PCSX2 is free software: you can redistribute it and/or modify it under the terms + * of the GNU Lesser General Public License as published by the Free Software Found- + * ation, either version 3 of the License, or (at your option) any later version. + * + * PCSX2 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 PCSX2. + * If not, see . + */ + +#include "common/PrecompiledHeader.h" + +#include "common/Console.h" +#include "ContextRetroGL.h" +#include +#include +#include "common/WindowInfo.h" +#include "GS/Renderers/Common/GSDevice.h" +#include "GS/GSVector.h" + +#include +extern retro_video_refresh_t video_cb; +extern retro_hw_render_callback hw_render; + +namespace GL +{ + ContextRetroGL::ContextRetroGL(const WindowInfo& wi) + : Context(wi) + { + } + + ContextRetroGL::~ContextRetroGL() + { + } + + std::unique_ptr ContextRetroGL::Create(const WindowInfo& wi, gsl::span versions_to_try) + { + std::unique_ptr context = std::make_unique(wi); + return context; + } + + void* ContextRetroGL::GetProcAddress(const char* name) + { + return reinterpret_cast(hw_render.get_proc_address(name)); + } + + bool ContextRetroGL::ChangeSurface(const WindowInfo& new_wi) + { + return true; + } + + void ContextRetroGL::ResizeSurface(u32 new_surface_width /*= 0*/, u32 new_surface_height /*= 0*/) + { + m_wi.surface_width = new_surface_width; + m_wi.surface_height = new_surface_height; + } + + bool ContextRetroGL::SwapBuffers() + { + if(g_gs_device->GetCurrent()) + video_cb(RETRO_HW_FRAME_BUFFER_VALID, g_gs_device->GetCurrent()->GetWidth(), g_gs_device->GetCurrent()->GetHeight(), 0); + else + video_cb(NULL, 640, 480, 0); + return true; + } + + bool ContextRetroGL::MakeCurrent() + { + return true; + } + + bool ContextRetroGL::DoneCurrent() + { + return true; + } + + bool ContextRetroGL::SetSwapInterval(s32 interval) + { + return true; + } + + std::unique_ptr ContextRetroGL::CreateSharedContext(const WindowInfo& wi) + { + std::unique_ptr context = std::make_unique(wi); + return context; + } + +} // namespace GL diff --git a/common/GL/ContextRetroGL.h b/common/GL/ContextRetroGL.h new file mode 100644 index 00000000000000..04795c75ffeb1c --- /dev/null +++ b/common/GL/ContextRetroGL.h @@ -0,0 +1,40 @@ +/* PCSX2 - PS2 Emulator for PCs + * Copyright (C) 2002-2021 PCSX2 Dev Team + * + * PCSX2 is free software: you can redistribute it and/or modify it under the terms + * of the GNU Lesser General Public License as published by the Free Software Found- + * ation, either version 3 of the License, or (at your option) any later version. + * + * PCSX2 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 PCSX2. + * If not, see . + */ + +#pragma once + +#include "common/GL/Context.h" + +namespace GL +{ + class ContextRetroGL : public Context + { + public: + ContextRetroGL(const WindowInfo& wi); + ~ContextRetroGL() override; + + static std::unique_ptr Create(const WindowInfo& wi, gsl::span versions_to_try); + + void* GetProcAddress(const char* name) override; + virtual bool ChangeSurface(const WindowInfo& new_wi) override; + virtual void ResizeSurface(u32 new_surface_width = 0, u32 new_surface_height = 0) override; + bool SwapBuffers() override; + bool MakeCurrent() override; + bool DoneCurrent() override; + bool SetSwapInterval(s32 interval) override; + virtual std::unique_ptr CreateSharedContext(const WindowInfo& wi) override; + }; + +} // namespace GL diff --git a/common/Perf.h b/common/Perf.h index 57324aefc771c6..bbad0531b92c45 100644 --- a/common/Perf.h +++ b/common/Perf.h @@ -15,6 +15,7 @@ #pragma once +#include #include #include #include "common/Pcsx2Types.h" diff --git a/common/Vulkan/Builders.cpp b/common/Vulkan/Builders.cpp index bf2e8f6882ddf0..cb1af50d7420d9 100644 --- a/common/Vulkan/Builders.cpp +++ b/common/Vulkan/Builders.cpp @@ -13,6 +13,7 @@ * If not, see . */ +#include #include "common/Vulkan/Builders.h" #include "common/Vulkan/Util.h" #include "common/Assertions.h" diff --git a/common/WindowInfo.h b/common/WindowInfo.h index 44845b0eed8008..eb20d3d1778126 100644 --- a/common/WindowInfo.h +++ b/common/WindowInfo.h @@ -25,7 +25,8 @@ struct WindowInfo Win32, X11, Wayland, - MacOS + MacOS, + Libretro }; /// The type of the surface. Surfaceless indicates it will not be displayed on screen at all. diff --git a/libretro/CMakeLists.txt b/libretro/CMakeLists.txt new file mode 100644 index 00000000000000..2afee18462b8ce --- /dev/null +++ b/libretro/CMakeLists.txt @@ -0,0 +1,69 @@ + +add_library(pcsx2_libretro SHARED) + +#target_link_libraries(PCSX2 PRIVATE +# ${wxWidgets_LIBRARIES} +# ${AIO_LIBRARIES} +# ${GLIB_LIBRARIES} +# ${GLIB_GIO_LIBRARIES} +#) + +#add_link_options(-fuse-ld=gold) +#add_link_options(-Wl,--gc-sections,--print-symbol-counts,sym.log) + +target_sources(pcsx2_libretro PRIVATE + ${CMAKE_SOURCE_DIR}/libretro/main.cpp + ${CMAKE_SOURCE_DIR}/libretro/options.cpp + ${CMAKE_SOURCE_DIR}/libretro/input.cpp + ${CMAKE_SOURCE_DIR}/libretro/Console.cpp + ${CMAKE_SOURCE_DIR}/libretro/SPU2.cpp + ${CMAKE_SOURCE_DIR}/libretro/DEV9.cpp + ${CMAKE_SOURCE_DIR}/libretro/USB.cpp + ${CMAKE_SOURCE_DIR}/libretro/InputRecording.cpp + + ${CMAKE_SOURCE_DIR}/common/GL/ContextRetroGL.cpp +# ${CMAKE_SOURCE_DIR}/pcsx2/USB/USBNull.cpp +# ${pcsx2LTOSources} +# ${pcsx2GuiSources} +) + +target_link_libraries(pcsx2_libretro PRIVATE + PCSX2_FLAGS + PCSX2 +) + +target_include_directories(PCSX2_FLAGS INTERFACE + "${CMAKE_SOURCE_DIR}/libretro" +) + +target_include_directories(pcsx2_libretro PRIVATE + "${CMAKE_SOURCE_DIR}" + "${CMAKE_SOURCE_DIR}/libretro" + "${CMAKE_SOURCE_DIR}/common/include" + "${CMAKE_SOURCE_DIR}/3rdparty/include" + "${CMAKE_SOURCE_DIR}/pcsx2" +) + +#include_directories(. ${CMAKE_SOURCE_DIR}/libretro ${CMAKE_SOURCE_DIR}/common) +set_target_properties(pcsx2_libretro PROPERTIES + LIBRARY_OUTPUT_NAME pcsx2_libretro + PREFIX "" +) + +# set(LIBRARY_OUTPUT_PATH "${CMAKE_BINARY_DIR}") + +if(CMAKE_C_COMPILER_ID MATCHES "Clang") + set(CLANG 1) +endif() + +if(NOT MSVC AND NOT CLANG) + set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--no-undefined") +endif() + +if(PACKAGE_MODE) + install(TARGETS pcsx2_libretro DESTINATION ${BIN_DIR}) +else(PACKAGE_MODE) + install(TARGETS pcsx2_libretro DESTINATION ${CMAKE_SOURCE_DIR}/bin) +endif(PACKAGE_MODE) + +#setup_main_executable(pcsx2-libretro) \ No newline at end of file diff --git a/libretro/Console.cpp b/libretro/Console.cpp new file mode 100644 index 00000000000000..6cf876094664fb --- /dev/null +++ b/libretro/Console.cpp @@ -0,0 +1,81 @@ + +#include +#include "common/Console.h" + +extern retro_log_printf_t log_cb; +static ConsoleColors log_color = Color_Default; + +static void RetroLog_DoSetColor(ConsoleColors color) +{ + if (color != Color_Current) + log_color = color; +} + +static void RetroLog_DoWrite(const char* fmt) +{ + retro_log_level level = RETRO_LOG_INFO; + switch (log_color) + { + case Color_StrongRed: // intended for errors + level = RETRO_LOG_ERROR; + break; + case Color_StrongOrange: // intended for warnings + level = RETRO_LOG_WARN; + break; + case Color_Cyan: // faint visibility, intended for logging PS2/IOP output + case Color_Yellow: // faint visibility, intended for logging PS2/IOP output + case Color_White: // faint visibility, intended for logging PS2/IOP output + level = RETRO_LOG_DEBUG; + break; + default: + case Color_Default: + case Color_Black: + case Color_Green: + case Color_Red: + case Color_Blue: + case Color_Magenta: + case Color_Orange: + case Color_Gray: + case Color_StrongBlack: + case Color_StrongGreen: // intended for infrequent state information + case Color_StrongBlue: // intended for block headings + case Color_StrongMagenta: + case Color_StrongGray: + case Color_StrongCyan: + case Color_StrongYellow: + case Color_StrongWhite: + break; + } + + log_cb(level, "%s", fmt); +} + +static void RetroLog_SetTitle(const char* title) +{ + log_cb(RETRO_LOG_INFO, "%s\n", title); +} + +static void RetroLog_Newline() +{ + // RetroLog_DoWrite(L"\n"); +} + +static void RetroLog_DoWriteLn(const char* fmt) +{ + RetroLog_DoWrite(fmt); +} + +static const IConsoleWriter ConsoleWriter_Libretro = + { + RetroLog_DoWrite, + RetroLog_DoWriteLn, + RetroLog_DoSetColor, + + RetroLog_DoWrite, + RetroLog_Newline, + RetroLog_SetTitle, + + 0, // instance-level indentation (should always be 0) +}; + +const IConsoleWriter* PatchesCon = &ConsoleWriter_Libretro; diff --git a/libretro/DEV9.cpp b/libretro/DEV9.cpp new file mode 100644 index 00000000000000..2ccc93a1a71281 --- /dev/null +++ b/libretro/DEV9.cpp @@ -0,0 +1,189 @@ + +#include + +// Our IRQ call. +void (*DEV9irq)(int); + +void DEV9configure() +{ +} + +s32 DEV9init() +{ + DevCon.WriteLn("Initializing dev9null"); + return 0; +} + +void DEV9shutdown() +{ + DevCon.WriteLn("Shutting down Dev9null."); +} + +s32 DEV9open() +{ + DevCon.WriteLn("Opening Dev9null."); + // Get anything ready we need to. Opening and creating hard + // drive files, for example. + return 0; +} + +void DEV9close() +{ + DevCon.WriteLn("Closing Dev9null."); + // Close files opened. +} + +u8 DEV9read8(u32 addr) +{ + u8 value = 0; + + switch (addr) { + // case 0x1F80146E: // DEV9 hardware type (0x32 for an expansion bay) + case 0x10000038: /*value = dev9Ru8(addr);*/ + break; // We need to have at least one case to avoid warnings. + default: + //value = dev9Ru8(addr); + DevCon.WriteLn("*Unknown 8 bit read at address %lx", addr); + break; + } + return value; +} + +u16 DEV9read16(u32 addr) +{ + u16 value = 0; + + switch (addr) { + // Addresses you may want to catch here include: + // case 0x1F80146E: // DEV9 hardware type (0x32 for an expansion bay) + // case 0x10000002: // The Smart Chip revision. Should be 0x11 + // case 0x10000004: // More type info: bit 0 - smap; bit 1 - hd; bit 5 - flash + // case 0x1000000E: // Similar to the last; bit 1 should be set if a hd is hooked up. + // case 0x10000028: // intr_stat + // case 0x10000038: // hard drives seem to like reading and writing the max dma size per transfer here. + // case 0x1000002A: // intr_mask + // case 0x10000040: // pio_data + // case 0x10000044: // nsector + // case 0x10000046: // sector + // case 0x10000048: // lcyl + // case 0x1000004A: // hcyl + // case 0x1000004C: // select + // case 0x1000004E: // status + // case 0x1000005C: // status + // case 0x10000064: // if_ctrl + case 0x10000038: /*value = dev9Ru16(addr);*/ + break; + default: + //value = dev9Ru16(addr); + DevCon.WriteLn("*Unknown 16 bit read at address %lx", addr); + break; + } + + return value; +} + +u32 DEV9read32(u32 addr) +{ + u32 value = 0; + + switch (addr) { + case 0x10000038: /*value = dev9Ru32(addr);*/ + break; + default: + //value = dev9Ru32(addr); + DevCon.WriteLn("*Unknown 32 bit read at address %lx", addr); + break; + } + + return value; +} + +void DEV9write8(u32 addr, u8 value) +{ + switch (addr) { + case 0x10000038: /*dev9Ru8(addr) = value;*/ + break; + default: + DevCon.WriteLn("*Unknown 8 bit write; address %lx = %x", addr, value); + //dev9Ru8(addr) = value; + break; + } +} + +void DEV9write16(u32 addr, u16 value) +{ + switch (addr) { + // Remember that list on DEV9read16? You'll want to write to a + // lot of them, too. + case 0x10000038: /*dev9Ru16(addr) = value;*/ + break; + default: + DevCon.WriteLn("*Unknown 16 bit write; address %lx = %x", addr, value); + //dev9Ru16(addr) = value; + break; + } +} + +void DEV9write32(u32 addr, u32 value) +{ + switch (addr) { + case 0x10000038: /*dev9Ru32(addr) = value;*/ + break; + default: + DevCon.WriteLn("*Unknown 32 bit write; address %lx = %x", addr, value); + //dev9Ru32(addr) = value; + break; + } +} + +s32 DEV9dmaRead(s32 channel, u32 *data, u32 bytesLeft, u32 *bytesProcessed) +{ + // You'll want to put your own DMA8 reading code here. + // Time to interact with your fake (or real) hardware. + DevCon.WriteLn("Reading DMA8 Mem."); + *bytesProcessed = bytesLeft; + return 0; +} + +s32 DEV9dmaWrite(s32 channel, u32 *data, u32 bytesLeft, u32 *bytesProcessed) +{ + // See above. + DevCon.WriteLn("Writing DMA8 Mem."); + *bytesProcessed = bytesLeft; + return 0; +} + +void DEV9dmaInterrupt(s32 channel) +{ + // See above. +} + +void DEV9readDMA8Mem(u32 *pMem, int size) +{ + // You'll want to put your own DMA8 reading code here. + // Time to interact with your fake (or real) hardware. + DevCon.WriteLn("Reading DMA8 Mem."); +} + +void DEV9writeDMA8Mem(u32 *pMem, int size) +{ + // See above. + DevCon.WriteLn("Writing DMA8 Mem."); +} + +int DEV9irqHandler(void) +{ + return 0; +} + +void DEV9setSettingsDir(const char *dir) +{ +} + +void DEV9async(u32 cycles) +{ +} + +void DEV9CheckChanges(const Pcsx2Config& old_config) +{ +} diff --git a/libretro/InputRecording.cpp b/libretro/InputRecording.cpp new file mode 100644 index 00000000000000..2c83ebb0f8ba9e --- /dev/null +++ b/libretro/InputRecording.cpp @@ -0,0 +1,103 @@ + +#include "Recording/InputRecording.h" + + +InputRecording g_InputRecording; + +bool InputRecording::create(const std::string& fileName, const bool fromSaveState, const std::string& authorName) +{ + return true; +} + +bool InputRecording::play(const std::string& filename) +{ + return true; +} + +void InputRecording::closeActiveFile() +{ +} + +void InputRecording::stop() +{ +} + +void InputRecording::handleControllerDataUpdate() +{ +} + +void InputRecording::saveControllerData(const PadData& data, const int port, const int slot) +{ +} + +std::optional InputRecording::updateControllerData(const int port, const int slot) +{ + return {}; +} + +void InputRecording::processRecordQueue() +{ +} + +std::string InputRecording::resolveGameName() +{ + return ""; +} + +void InputRecording::incFrameCounter() +{ +} + +u64 InputRecording::getFrameCounter() const +{ + return 0; +} + +bool InputRecording::isActive() const +{ + return false; +} + +void InputRecording::handleExceededFrameCounter() +{ +} + +void InputRecording::handleReset() +{ +} + +void InputRecording::handleLoadingSavestate() +{ +} + +bool InputRecording::isTypeSavestate() const +{ + return false; +} + +void InputRecording::setStartingFrame(u32 startingFrame) +{ +} + +void InputRecording::adjustFrameCounterOnReRecord(u32 newFrameCounter) +{ +} + +InputRecordingControls& InputRecording::getControls() +{ + return m_controls; +} + +const InputRecordingFile& InputRecording::getData() const +{ + return m_file; +} + +void InputRecording::initializeState() +{ +} + +bool InputRecordingFile::close() noexcept +{ + return true; +} diff --git a/libretro/SPU2.cpp b/libretro/SPU2.cpp new file mode 100644 index 00000000000000..9a061e7d887359 --- /dev/null +++ b/libretro/SPU2.cpp @@ -0,0 +1,48 @@ + +#include "SPU2/Global.h" +#include "SPU2/spu2.h" +#include "SPU2/SndOut.h" + +void SndBuffer::Cleanup() +{ +} + +void SndBuffer::ClearContents() +{ +} + +void SndBuffer::ResetBuffers() +{ +} + +void SPU2::SetOutputPaused(bool paused) +{ +} + +void SPU2::SetOutputVolume(s32 volume) +{ +} + +bool SPU2::IsAudioCaptureActive() +{ + return false; +} + +void SPU2::SetAudioCaptureActive(bool active) +{ +} + +u32 OutputModule = 0; +int FindOutputModuleById(const char* omodid) +{ + return 0; +} + +void DspUpdate() +{ +} + +s32 DspLoadLibrary(wchar_t* fileName, int modnum) +{ + return 0; +} diff --git a/libretro/USB.cpp b/libretro/USB.cpp new file mode 100644 index 00000000000000..32fd4b760bfe7a --- /dev/null +++ b/libretro/USB.cpp @@ -0,0 +1,31 @@ + +#include "USB/USB.h" +#include "SaveState.h" + +void USB::CheckForConfigChanges(const Pcsx2Config& old_config) +{ +} + +bool USB::DoState(StateWrapper& sw) +{ + return true; +} + +void USBconfigure() {} + +s32 USBinit() { return 0; } +void USBasync(u32 cycles) {} +void USBshutdown() +{ +} +void USBclose() {} +void USBreset() {} +bool USBopen() { return true; } +s32 USBfreeze(FreezeAction mode, freezeData* data) { return 0; } + +u8 USBread8(u32 addr) { return 0; } +u16 USBread16(u32 addr) { return 0; } +u32 USBread32(u32 addr) { return 0; } +void USBwrite8(u32 addr, u8 value) {} +void USBwrite16(u32 addr, u16 value) {} +void USBwrite32(u32 addr, u32 value) {} diff --git a/libretro/build.cmake b/libretro/build.cmake new file mode 100644 index 00000000000000..2af22c31b36010 --- /dev/null +++ b/libretro/build.cmake @@ -0,0 +1,256 @@ + +LIST(REMOVE_ITEM pcsx2SPU2Sources + SPU2/Debug.cpp + SPU2/Wavedump_wav.cpp + + SPU2/SndOut.cpp + SPU2/SndOut_SDL.cpp + SPU2/SndOut_Portaudio.cpp + SPU2/Timestretcher.cpp + SPU2/wx/wxConfig.cpp + SPU2/Linux/Alsa.cpp + SPU2/Linux/Config.cpp + SPU2/Linux/ConfigSoundTouch.cpp + SPU2/Linux/Dialogs.cpp +) + +list(REMOVE_ITEM pcsx2SPU2Headers + SPU2/Host/Config.cpp + SPU2/Host/ConfigDebug.cpp + SPU2/Host/ConfigSoundTouch.cpp +) +set(pcsx2GuiSources + gui/AppAssert.cpp + gui/AppConfig.cpp + gui/AppCoreThread.cpp + gui/AppEventSources.cpp + gui/AppHost.cpp + gui/AppUserMode.cpp + gui/AppInit.cpp + gui/AppMain.cpp + gui/AppRes.cpp + gui/CheckedStaticBox.cpp + gui/ConsoleLogger.cpp + gui/Dialogs/AboutBoxDialog.cpp + gui/Dialogs/GSDumpDialog.cpp + gui/Dialogs/AssertionDialog.cpp + gui/Dialogs/BaseConfigurationDialog.cpp + gui/Dialogs/ConfirmationDialogs.cpp + gui/Dialogs/ConvertMemoryCardDialog.cpp + gui/Dialogs/CreateMemoryCardDialog.cpp + gui/Dialogs/FirstTimeWizard.cpp + gui/Dialogs/ImportSettingsDialog.cpp + gui/Dialogs/LogOptionsDialog.cpp + gui/Dialogs/McdConfigDialog.cpp + gui/Dialogs/PickUserModeDialog.cpp + gui/Dialogs/SysConfigDialog.cpp + gui/Dialogs/PINEDialog.cpp + gui/Debugger/BreakpointWindow.cpp + gui/Debugger/CtrlDisassemblyView.cpp + gui/Debugger/CtrlRegisterList.cpp + gui/Debugger/CtrlMemView.cpp + gui/Debugger/CtrlMemSearch.cpp + gui/Debugger/DebuggerLists.cpp + gui/Debugger/DisassemblyDialog.cpp + gui/Debugger/DebugEvents.cpp + gui/DriveList.cpp + gui/ExecutorThread.cpp + gui/FastFormatString.cpp + gui/FileUtils.cpp + gui/FrameForGS.cpp + gui/GlobalCommands.cpp + gui/IniInterface.cpp + gui/i18n.cpp + gui/IsoDropTarget.cpp + gui/MainFrame.cpp + gui/MainMenuClicks.cpp + gui/MessageBoxes.cpp + gui/Mutex.cpp + gui/MSWstuff.cpp + gui/Panels/BaseApplicableConfigPanel.cpp + gui/Panels/BiosSelectorPanel.cpp + gui/Panels/CpuPanel.cpp + gui/Panels/DirPickerPanel.cpp + gui/Panels/GameFixesPanel.cpp + gui/Panels/GSWindowPanel.cpp + gui/Panels/LogOptionsPanels.cpp + gui/Panels/MemoryCardListPanel.cpp + gui/Panels/MemoryCardListView.cpp + gui/Panels/MiscPanelStuff.cpp + gui/Panels/PathsPanel.cpp + gui/Panels/SpeedhacksPanel.cpp + gui/Panels/VideoPanel.cpp + gui/PathUtils.cpp + gui/PersistentThread.cpp + gui/pxCheckBox.cpp + gui/pxRadioPanel.cpp + gui/pxStaticText.cpp + gui/pxTranslate.cpp + gui/pxWindowTextWriter.cpp + gui/RecentIsoList.cpp + gui/Saveslots.cpp + gui/StringHelpers.cpp + gui/SysCoreThread.cpp + gui/SysState.cpp + gui/SysThreadBase.cpp + gui/ThreadingDialogs.cpp + gui/UpdateUI.cpp + gui/wxAppWithHelpers.cpp + gui/wxGuiTools.cpp + gui/wxHelpers.cpp + gui/wxSettingsInterface.cpp + ) + +LIST(REMOVE_ITEM pcsx2GuiSources + +# gui/AppHost.cpp + + gui/CheckedStaticBox.cpp + gui/Dialogs/AboutBoxDialog.cpp + gui/Dialogs/GSDumpDialog.cpp + gui/Dialogs/AssertionDialog.cpp + gui/Dialogs/BaseConfigurationDialog.cpp + gui/Dialogs/ConfirmationDialogs.cpp + gui/Dialogs/ConvertMemoryCardDialog.cpp + gui/Dialogs/CreateMemoryCardDialog.cpp + gui/Dialogs/FirstTimeWizard.cpp + gui/Dialogs/ImportSettingsDialog.cpp + gui/Dialogs/LogOptionsDialog.cpp + gui/Dialogs/McdConfigDialog.cpp + gui/Dialogs/PickUserModeDialog.cpp + gui/Dialogs/SysConfigDialog.cpp + gui/Dialogs/PINEDialog.cpp + gui/Debugger/BreakpointWindow.cpp + gui/Debugger/CtrlDisassemblyView.cpp + gui/Debugger/CtrlRegisterList.cpp + gui/Debugger/CtrlMemView.cpp + gui/Debugger/CtrlMemSearch.cpp + gui/Debugger/DebuggerLists.cpp + gui/Debugger/DisassemblyDialog.cpp + gui/Debugger/DebugEvents.cpp + gui/CpuUsageProvider.cpp + gui/DriveList.cpp + gui/FrameForGS.cpp + gui/GlobalCommands.cpp + gui/IsoDropTarget.cpp + gui/MainFrame.cpp + gui/MainMenuClicks.cpp + gui/MessageBoxes.cpp + gui/Panels/BaseApplicableConfigPanel.cpp + gui/Panels/BiosSelectorPanel.cpp + gui/Panels/CpuPanel.cpp + gui/Panels/DirPickerPanel.cpp + gui/Panels/GameFixesPanel.cpp + gui/Panels/GSWindowPanel.cpp + gui/Panels/LogOptionsPanels.cpp + gui/Panels/MemoryCardListPanel.cpp + gui/Panels/MemoryCardListView.cpp + gui/Panels/MiscPanelStuff.cpp + gui/Panels/PathsPanel.cpp + gui/Panels/PluginSelectorPanel.cpp + gui/Panels/SpeedhacksPanel.cpp + gui/Panels/VideoPanel.cpp + gui/pxCheckBox.cpp + gui/pxRadioPanel.cpp + gui/pxStaticText.cpp + gui/pxWindowTextWriter.cpp + gui/RecentIsoList.cpp + gui/Saveslots.cpp + gui/SysState.cpp + gui/ThreadingDialogs.cpp + gui/UpdateUI.cpp + gui/wxGuiTools.cpp + gui/wxHelpers.cpp +) + +LIST(REMOVE_ITEM pcsx2GuiHeaders + gui/ThreadingDialogs.cpp +) + +LIST(REMOVE_ITEM pcsx2LinuxSources + gui/CpuUsageProviderLnx.cpp + Linux/LnxKeyCodes.cpp +) + +LIST(REMOVE_ITEM pcsx2WindowsSources + windows/PatchBrowser.cpp +) + +LIST(REMOVE_ITEM pcsx2PADSources + PAD/Linux/Device.cpp + PAD/Linux/InputManager.cpp + PAD/Linux/SDL/joystick.cpp + PAD/Linux/keyboard.cpp + PAD/Linux/KeyStatus.cpp + PAD/Linux/wx_dialog/dialog.cpp + PAD/Linux/wx_dialog/opPanel.cpp + PAD/Linux/wx_dialog/GamepadConfiguration.cpp + PAD/Linux/wx_dialog/JoystickConfiguration.cpp + PAD/Linux/Config.cpp + PAD/Linux/linux.cpp +) + +LIST(REMOVE_ITEM pcsx2GSSources + GS/GSCapture.cpp + GS/GSPng.cpp + GS/Renderers/Common/GSOsdManager.cpp + GS/Window/GSLinuxDialog.cpp + GS/Window/GSwxDialog.cpp +) + +set(pcsx2DEV9Sources) +set(pcsx2DEV9Headers) +set(pcsx2USBSources) +set(pcsx2USBHeaders) +set(pcsx2RecordingSources) +set(pcsx2RecordingVirtualPadResources) +set(pcsx2RecordingHeaders) +set(pcsx2ZipToolsSources) +set(pcsx2ZipToolsHeaders) + +set(pcsx2FrontendSources) + +target_link_libraries(PCSX2 PRIVATE + ${wxWidgets_LIBRARIES} + ${AIO_LIBRARIES} + ${GLIB_LIBRARIES} + ${GLIB_GIO_LIBRARIES} +) + +#add_link_options(-fuse-ld=gold) +#add_link_options(-Wl,--gc-sections,--print-symbol-counts,sym.log) + +target_sources(PCSX2 PRIVATE + ${CMAKE_SOURCE_DIR}/libretro/main.cpp + ${CMAKE_SOURCE_DIR}/libretro/options.cpp + ${CMAKE_SOURCE_DIR}/libretro/input.cpp + ${CMAKE_SOURCE_DIR}/common/GL/ContextRetroGL.cpp +# USB/USBNull.cpp + ${pcsx2LTOSources} + ${pcsx2GuiSources} +) + +target_link_libraries(PCSX2 PRIVATE + PCSX2_FLAGS +) +include_directories(. ${CMAKE_SOURCE_DIR}/libretro ${CMAKE_SOURCE_DIR}/common) +set_target_properties(PCSX2 PROPERTIES + LIBRARY_OUTPUT_NAME pcsx2_libretro + PREFIX "" +) + +# set(LIBRARY_OUTPUT_PATH "${CMAKE_BINARY_DIR}") + +if(CMAKE_C_COMPILER_ID MATCHES "Clang") + set(CLANG 1) +endif() + +if(NOT MSVC AND NOT CLANG) + set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--no-undefined") +endif() + +if(PACKAGE_MODE) + install(TARGETS PCSX2 DESTINATION ${BIN_DIR}) +else(PACKAGE_MODE) + install(TARGETS PCSX2 DESTINATION ${CMAKE_SOURCE_DIR}/bin) +endif(PACKAGE_MODE) diff --git a/libretro/input.cpp b/libretro/input.cpp new file mode 100644 index 00000000000000..927c190b9cb8dc --- /dev/null +++ b/libretro/input.cpp @@ -0,0 +1,277 @@ +#include "PrecompiledHeader.h" + +#include +#include +#include +#include + +#include "input.h" +//#include "PS2Edefs.h" + +#include "PAD/Host/StateManagement.h" +#include "PAD/Host/KeyStatus.h" +#include "Frontend/InputManager.h" + +extern retro_environment_t environ_cb; +static retro_input_poll_t poll_cb; +static retro_input_state_t input_cb; +struct retro_rumble_interface rumble; + +//PADconf g_conf; + +static struct retro_input_descriptor desc[] = { + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_LEFT, "Left"}, + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_UP, "Up"}, + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_DOWN, "Down"}, + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_RIGHT, "Right"}, + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_X, "Triangle"}, + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_A, "Circle"}, + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_B, "Cross"}, + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_Y, "Square"}, + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_L, "L"}, + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_R, "R"}, + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_L2, "L2"}, + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_R2, "R2"}, + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_L3, "L3"}, + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_R3, "R3"}, + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_START, "Start"}, + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_SELECT, "Select"}, + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_LEFT, RETRO_DEVICE_ID_ANALOG_X, "L-Analog X"}, + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_LEFT, RETRO_DEVICE_ID_ANALOG_Y, "L-Analog Y"}, + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_RIGHT, RETRO_DEVICE_ID_ANALOG_X, "R-Analog X"}, + {0, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_RIGHT, RETRO_DEVICE_ID_ANALOG_Y, "R-Analog Y"}, + + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_LEFT, "Left"}, + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_UP, "Up"}, + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_DOWN, "Down"}, + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_RIGHT, "Right"}, + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_X, "Triangle"}, + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_A, "Circle"}, + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_B, "Cross"}, + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_Y, "Square"}, + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_L, "L"}, + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_R, "R"}, + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_L2, "L2"}, + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_R2, "R2"}, + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_L3, "L3"}, + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_R3, "R3"}, + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_START, "Start"}, + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, RETRO_DEVICE_ID_JOYPAD_SELECT, "Select"}, + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_LEFT, RETRO_DEVICE_ID_ANALOG_X, "L-Analog X"}, + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_LEFT, RETRO_DEVICE_ID_ANALOG_Y, "L-Analog Y"}, + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_RIGHT, RETRO_DEVICE_ID_ANALOG_X, "R-Analog X"}, + {1, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_RIGHT, RETRO_DEVICE_ID_ANALOG_Y, "R-Analog Y"}, + + {0}, +}; + +namespace Input +{ + +void Init() +{ + environ_cb(RETRO_ENVIRONMENT_GET_RUMBLE_INTERFACE, &rumble); + static const struct retro_controller_description ds2_desc[] = { + {"DualShock 2", RETRO_DEVICE_ANALOG}, + }; + + static const struct retro_controller_info ports[] = { + {ds2_desc, sizeof(ds2_desc) / sizeof(*ds2_desc)}, + {ds2_desc, sizeof(ds2_desc) / sizeof(*ds2_desc)}, + {}, + }; + + environ_cb(RETRO_ENVIRONMENT_SET_CONTROLLER_INFO, (void*)ports); + // environ_cb(RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS, desc); +} + +void Shutdown() +{ +} + +void Update() +{ + poll_cb(); +#ifdef __ANDROID__ + /* Android doesn't support input polling on all threads by default + * this will force the poll for this frame to happen in the main thread + * in case the frontend is doing late-polling */ + input_cb(0, 0, 0, 0); +#endif + Pad::rumble_all(); +} + +} // namespace Input + +void retro_set_input_poll(retro_input_poll_t cb) +{ + poll_cb = cb; +} + +void retro_set_input_state(retro_input_state_t cb) +{ + input_cb = cb; +} + +void retro_set_controller_port_device(unsigned port, unsigned device) +{ + environ_cb(RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS, desc); +} + +void PADabout() +{ +} + +s32 PADtest() +{ + return 0; +} + +//s32 _PADopen(const WindowInfo& wi) +//{ +// return 0; +//} + +void _PADclose() +{ +} + +void PADupdate(int pad) +{ +} + +//std::vector> s_vgamePad; + +void EnumerateDevices() +{ +} + +//void Device::DoRumble(unsigned type, unsigned pad) +//{ +// if (pad >= GAMEPAD_NUMBER) +// return; + +// if (type == 0) +// rumble.set_rumble_state(pad, RETRO_RUMBLE_WEAK, 0xFFFF); +// else +// rumble.set_rumble_state(pad, RETRO_RUMBLE_STRONG, 0xFFFF); +//} + +void PADconfigure() +{ +} + +void PADSaveConfig() +{ +} + +void PADLoadConfig() +{ +} + +//void KeyStatus::Init() +//{ +//} + +static int keymap[] = + { + RETRO_DEVICE_ID_JOYPAD_L2, // PAD_L2 + RETRO_DEVICE_ID_JOYPAD_R2, // PAD_R2 + RETRO_DEVICE_ID_JOYPAD_L, // PAD_L1 + RETRO_DEVICE_ID_JOYPAD_R, // PAD_R1 + RETRO_DEVICE_ID_JOYPAD_X, // PAD_TRIANGLE + RETRO_DEVICE_ID_JOYPAD_A, // PAD_CIRCLE + RETRO_DEVICE_ID_JOYPAD_B, // PAD_CROSS + RETRO_DEVICE_ID_JOYPAD_Y, // PAD_SQUARE + RETRO_DEVICE_ID_JOYPAD_SELECT, // PAD_SELECT + RETRO_DEVICE_ID_JOYPAD_L3, // PAD_L3 + RETRO_DEVICE_ID_JOYPAD_R3, // PAD_R3 + RETRO_DEVICE_ID_JOYPAD_START, // PAD_START + RETRO_DEVICE_ID_JOYPAD_UP, // PAD_UP + RETRO_DEVICE_ID_JOYPAD_RIGHT, // PAD_RIGHT + RETRO_DEVICE_ID_JOYPAD_DOWN, // PAD_DOWN + RETRO_DEVICE_ID_JOYPAD_LEFT, // PAD_LEFT +}; + + +u32 PAD::KeyStatus::GetButtons(u32 pad) +{ + u32 mask = input_cb(pad, RETRO_DEVICE_JOYPAD, 0, RETRO_DEVICE_ID_JOYPAD_MASK); + u32 new_mask = 0; + for (int i = 0; i < 16; i++) + new_mask |= !(mask & (1 << keymap[i])) << i; + + return new_mask; +} + +u8 PAD::KeyStatus::GetPressure(u32 pad, u32 index) +{ + int val = 0; + switch (index) + { + case PAD_R_LEFT: + case PAD_R_RIGHT: + val = input_cb(pad, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_RIGHT, RETRO_DEVICE_ID_ANALOG_X); + break; + + case PAD_R_DOWN: + case PAD_R_UP: + val = input_cb(pad, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_RIGHT, RETRO_DEVICE_ID_ANALOG_Y); + break; + + case PAD_L_LEFT: + case PAD_L_RIGHT: + val = input_cb(pad, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_LEFT, RETRO_DEVICE_ID_ANALOG_X); + break; + + case PAD_L_DOWN: + case PAD_L_UP: + val = input_cb(pad, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_LEFT, RETRO_DEVICE_ID_ANALOG_Y); + break; + + default: + if (index < 16) + val = input_cb(pad, RETRO_DEVICE_ANALOG, RETRO_DEVICE_INDEX_ANALOG_BUTTON, keymap[index]); + break; + } + + if (index < 16) + return 0xFF - (val >> 7); + + return 0x80 + (val >> 8); +} + +PAD::KeyStatus::KeyStatus() +{ +} + +void PAD::KeyStatus::Init() +{ +} + +void PAD::KeyStatus::Set(u32 pad, u32 index, float value) +{ +} + +void InputManager::PollSources() +{ +} +void InputManager::CloseSources() +{ +} + +void InputManager::ReloadSources(SettingsInterface& si, std::unique_lock& settings_lock) +{ +} + +void InputManager::ReloadBindings(SettingsInterface& si, SettingsInterface& binding_si) +{ +} +void InputManager::PauseVibration() +{ +} + +const char* InputManager::InputSourceToString(InputSourceType clazz) +{ + return ""; +} diff --git a/libretro/input.h b/libretro/input.h new file mode 100644 index 00000000000000..c9535b4f7a6718 --- /dev/null +++ b/libretro/input.h @@ -0,0 +1,9 @@ + +#pragma once + +namespace Input +{ +void Init(); +void Update(); +void Shutdown(); +} diff --git a/libretro/libretro.h b/libretro/libretro.h new file mode 100644 index 00000000000000..c8a3cb763c7a48 --- /dev/null +++ b/libretro/libretro.h @@ -0,0 +1,3026 @@ +/* Copyright (C) 2010-2020 The RetroArch team + * + * --------------------------------------------------------------------------------------- + * The following license statement only applies to this libretro API header (libretro.h). + * --------------------------------------------------------------------------------------- + * + * Permission is hereby granted, free of charge, + * to any person obtaining a copy of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation the rights to + * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, + * and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, + * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. + * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, + * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ + +#ifndef LIBRETRO_H__ +#define LIBRETRO_H__ + +#include +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +#ifndef __cplusplus +#if defined(_MSC_VER) && _MSC_VER < 1800 && !defined(SN_TARGET_PS3) +/* Hack applied for MSVC when compiling in C89 mode + * as it isn't C99-compliant. */ +#define bool unsigned char +#define true 1 +#define false 0 +#else +#include +#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 device is similar to Guncon-2 for PlayStation 2. + * It reports X/Y coordinates in screen space (similar to the pointer) + * in the range [-0x8000, 0x7fff] in both axes, with zero being center and + * -0x8000 being out of bounds. + * As well as reporting on/off screen state. It features a trigger, + * start/select buttons, auxiliary action buttons and a + * directional pad. A forced off-screen shot can be requested for + * auto-reloading function in some games. + */ +#define RETRO_DEVICE_LIGHTGUN 4 + +/* The ANALOG device is an extension to JOYPAD (RetroPad). + * Similar to DualShock2 it adds two analog sticks and all buttons can + * be analog. This is treated as a separate device type as it returns + * axis values in the full analog range of [-0x7fff, 0x7fff], + * although some devices may return -0x8000. + * Positive X axis is right. Positive Y axis is down. + * Buttons are returned in the range [0, 0x7fff]. + * Only use ANALOG type when polling for analog values. + */ +#define RETRO_DEVICE_ANALOG 5 + +/* Abstracts the concept of a pointing mechanism, e.g. touch. + * This allows libretro to query in absolute coordinates where on the + * screen a mouse (or something similar) is being placed. + * For a touch centric device, coordinates reported are the coordinates + * of the press. + * + * Coordinates in X and Y are reported as: + * [-0x7fff, 0x7fff]: -0x7fff corresponds to the far left/top of the screen, + * and 0x7fff corresponds to the far right/bottom of the screen. + * The "screen" is here defined as area that is passed to the frontend and + * later displayed on the monitor. + * + * The frontend is free to scale/resize this screen as it sees fit, however, + * (X, Y) = (-0x7fff, -0x7fff) will correspond to the top-left pixel of the + * game image, etc. + * + * To check if the pointer coordinates are valid (e.g. a touch display + * actually being touched), PRESSED returns 1 or 0. + * + * If using a mouse on a desktop, PRESSED will usually correspond to the + * left mouse button, but this is a frontend decision. + * PRESSED will only return 1 if the pointer is inside the game screen. + * + * For multi-touch, the index variable can be used to successively query + * more presses. + * If index = 0 returns true for _PRESSED, coordinates can be extracted + * with _X, _Y for index = 0. One can then query _PRESSED, _X, _Y with + * index = 1, and so on. + * Eventually _PRESSED will return false for an index. No further presses + * are registered at this point. */ +#define RETRO_DEVICE_POINTER 6 + +/* Buttons for the RetroPad (JOYPAD). + * The placement of these is equivalent to placements on the + * Super Nintendo controller. + * L2/R2/L3/R3 buttons correspond to the PS1 DualShock. + * Also used as id values for RETRO_DEVICE_INDEX_ANALOG_BUTTON */ +#define RETRO_DEVICE_ID_JOYPAD_B 0 +#define RETRO_DEVICE_ID_JOYPAD_Y 1 +#define RETRO_DEVICE_ID_JOYPAD_SELECT 2 +#define RETRO_DEVICE_ID_JOYPAD_START 3 +#define RETRO_DEVICE_ID_JOYPAD_UP 4 +#define RETRO_DEVICE_ID_JOYPAD_DOWN 5 +#define RETRO_DEVICE_ID_JOYPAD_LEFT 6 +#define RETRO_DEVICE_ID_JOYPAD_RIGHT 7 +#define RETRO_DEVICE_ID_JOYPAD_A 8 +#define RETRO_DEVICE_ID_JOYPAD_X 9 +#define RETRO_DEVICE_ID_JOYPAD_L 10 +#define RETRO_DEVICE_ID_JOYPAD_R 11 +#define RETRO_DEVICE_ID_JOYPAD_L2 12 +#define RETRO_DEVICE_ID_JOYPAD_R2 13 +#define RETRO_DEVICE_ID_JOYPAD_L3 14 +#define RETRO_DEVICE_ID_JOYPAD_R3 15 + +#define RETRO_DEVICE_ID_JOYPAD_MASK 256 + +/* Index / Id values for ANALOG device. */ +#define RETRO_DEVICE_INDEX_ANALOG_LEFT 0 +#define RETRO_DEVICE_INDEX_ANALOG_RIGHT 1 +#define RETRO_DEVICE_INDEX_ANALOG_BUTTON 2 +#define RETRO_DEVICE_ID_ANALOG_X 0 +#define RETRO_DEVICE_ID_ANALOG_Y 1 + +/* Id values for MOUSE. */ +#define RETRO_DEVICE_ID_MOUSE_X 0 +#define RETRO_DEVICE_ID_MOUSE_Y 1 +#define RETRO_DEVICE_ID_MOUSE_LEFT 2 +#define RETRO_DEVICE_ID_MOUSE_RIGHT 3 +#define RETRO_DEVICE_ID_MOUSE_WHEELUP 4 +#define RETRO_DEVICE_ID_MOUSE_WHEELDOWN 5 +#define RETRO_DEVICE_ID_MOUSE_MIDDLE 6 +#define RETRO_DEVICE_ID_MOUSE_HORIZ_WHEELUP 7 +#define RETRO_DEVICE_ID_MOUSE_HORIZ_WHEELDOWN 8 +#define RETRO_DEVICE_ID_MOUSE_BUTTON_4 9 +#define RETRO_DEVICE_ID_MOUSE_BUTTON_5 10 + +/* Id values for LIGHTGUN. */ +#define RETRO_DEVICE_ID_LIGHTGUN_SCREEN_X 13 /*Absolute Position*/ +#define RETRO_DEVICE_ID_LIGHTGUN_SCREEN_Y 14 /*Absolute*/ +#define RETRO_DEVICE_ID_LIGHTGUN_IS_OFFSCREEN 15 /*Status Check*/ +#define RETRO_DEVICE_ID_LIGHTGUN_TRIGGER 2 +#define RETRO_DEVICE_ID_LIGHTGUN_RELOAD 16 /*Forced off-screen shot*/ +#define RETRO_DEVICE_ID_LIGHTGUN_AUX_A 3 +#define RETRO_DEVICE_ID_LIGHTGUN_AUX_B 4 +#define RETRO_DEVICE_ID_LIGHTGUN_START 6 +#define RETRO_DEVICE_ID_LIGHTGUN_SELECT 7 +#define RETRO_DEVICE_ID_LIGHTGUN_AUX_C 8 +#define RETRO_DEVICE_ID_LIGHTGUN_DPAD_UP 9 +#define RETRO_DEVICE_ID_LIGHTGUN_DPAD_DOWN 10 +#define RETRO_DEVICE_ID_LIGHTGUN_DPAD_LEFT 11 +#define RETRO_DEVICE_ID_LIGHTGUN_DPAD_RIGHT 12 +/* deprecated */ +#define RETRO_DEVICE_ID_LIGHTGUN_X 0 /*Relative Position*/ +#define RETRO_DEVICE_ID_LIGHTGUN_Y 1 /*Relative*/ +#define RETRO_DEVICE_ID_LIGHTGUN_CURSOR 3 /*Use Aux:A*/ +#define RETRO_DEVICE_ID_LIGHTGUN_TURBO 4 /*Use Aux:B*/ +#define RETRO_DEVICE_ID_LIGHTGUN_PAUSE 5 /*Use Start*/ + +/* Id values for POINTER. */ +#define RETRO_DEVICE_ID_POINTER_X 0 +#define RETRO_DEVICE_ID_POINTER_Y 1 +#define RETRO_DEVICE_ID_POINTER_PRESSED 2 +#define RETRO_DEVICE_ID_POINTER_COUNT 3 + +/* Returned from retro_get_region(). */ +#define RETRO_REGION_NTSC 0 +#define RETRO_REGION_PAL 1 + +/* Id values for LANGUAGE */ +enum retro_language +{ + RETRO_LANGUAGE_ENGLISH = 0, + RETRO_LANGUAGE_JAPANESE = 1, + RETRO_LANGUAGE_FRENCH = 2, + RETRO_LANGUAGE_SPANISH = 3, + RETRO_LANGUAGE_GERMAN = 4, + RETRO_LANGUAGE_ITALIAN = 5, + RETRO_LANGUAGE_DUTCH = 6, + RETRO_LANGUAGE_PORTUGUESE_BRAZIL = 7, + RETRO_LANGUAGE_PORTUGUESE_PORTUGAL = 8, + RETRO_LANGUAGE_RUSSIAN = 9, + RETRO_LANGUAGE_KOREAN = 10, + RETRO_LANGUAGE_CHINESE_TRADITIONAL = 11, + RETRO_LANGUAGE_CHINESE_SIMPLIFIED = 12, + RETRO_LANGUAGE_ESPERANTO = 13, + RETRO_LANGUAGE_POLISH = 14, + RETRO_LANGUAGE_VIETNAMESE = 15, + RETRO_LANGUAGE_ARABIC = 16, + RETRO_LANGUAGE_GREEK = 17, + RETRO_LANGUAGE_TURKISH = 18, + RETRO_LANGUAGE_SLOVAK = 19, + RETRO_LANGUAGE_PERSIAN = 20, + RETRO_LANGUAGE_HEBREW = 21, + RETRO_LANGUAGE_ASTURIAN = 22, + RETRO_LANGUAGE_LAST, + + /* Ensure sizeof(enum) == sizeof(int) */ + RETRO_LANGUAGE_DUMMY = INT_MAX +}; + +/* Passed to retro_get_memory_data/size(). + * If the memory type doesn't apply to the + * implementation NULL/0 can be returned. + */ +#define RETRO_MEMORY_MASK 0xff + +/* Regular save RAM. This RAM is usually found on a game cartridge, + * backed up by a battery. + * If save game data is too complex for a single memory buffer, + * the SAVE_DIRECTORY (preferably) or SYSTEM_DIRECTORY environment + * callback can be used. */ +#define RETRO_MEMORY_SAVE_RAM 0 + +/* Some games have a built-in clock to keep track of time. + * This memory is usually just a couple of bytes to keep track of time. + */ +#define RETRO_MEMORY_RTC 1 + +/* System ram lets a frontend peek into a game systems main RAM. */ +#define RETRO_MEMORY_SYSTEM_RAM 2 + +/* Video ram lets a frontend peek into a game systems video RAM (VRAM). */ +#define RETRO_MEMORY_VIDEO_RAM 3 + +/* Keysyms used for ID in input state callback when polling RETRO_KEYBOARD. */ +enum retro_key +{ + RETROK_UNKNOWN = 0, + RETROK_FIRST = 0, + RETROK_BACKSPACE = 8, + RETROK_TAB = 9, + RETROK_CLEAR = 12, + RETROK_RETURN = 13, + RETROK_PAUSE = 19, + RETROK_ESCAPE = 27, + RETROK_SPACE = 32, + RETROK_EXCLAIM = 33, + RETROK_QUOTEDBL = 34, + RETROK_HASH = 35, + RETROK_DOLLAR = 36, + RETROK_AMPERSAND = 38, + RETROK_QUOTE = 39, + RETROK_LEFTPAREN = 40, + RETROK_RIGHTPAREN = 41, + RETROK_ASTERISK = 42, + RETROK_PLUS = 43, + RETROK_COMMA = 44, + RETROK_MINUS = 45, + RETROK_PERIOD = 46, + RETROK_SLASH = 47, + RETROK_0 = 48, + RETROK_1 = 49, + RETROK_2 = 50, + RETROK_3 = 51, + RETROK_4 = 52, + RETROK_5 = 53, + RETROK_6 = 54, + RETROK_7 = 55, + RETROK_8 = 56, + RETROK_9 = 57, + RETROK_COLON = 58, + RETROK_SEMICOLON = 59, + RETROK_LESS = 60, + RETROK_EQUALS = 61, + RETROK_GREATER = 62, + RETROK_QUESTION = 63, + RETROK_AT = 64, + RETROK_LEFTBRACKET = 91, + RETROK_BACKSLASH = 92, + RETROK_RIGHTBRACKET = 93, + RETROK_CARET = 94, + RETROK_UNDERSCORE = 95, + RETROK_BACKQUOTE = 96, + RETROK_a = 97, + RETROK_b = 98, + RETROK_c = 99, + RETROK_d = 100, + RETROK_e = 101, + RETROK_f = 102, + RETROK_g = 103, + RETROK_h = 104, + RETROK_i = 105, + RETROK_j = 106, + RETROK_k = 107, + RETROK_l = 108, + RETROK_m = 109, + RETROK_n = 110, + RETROK_o = 111, + RETROK_p = 112, + RETROK_q = 113, + RETROK_r = 114, + RETROK_s = 115, + RETROK_t = 116, + RETROK_u = 117, + RETROK_v = 118, + RETROK_w = 119, + RETROK_x = 120, + RETROK_y = 121, + RETROK_z = 122, + RETROK_LEFTBRACE = 123, + RETROK_BAR = 124, + RETROK_RIGHTBRACE = 125, + RETROK_TILDE = 126, + RETROK_DELETE = 127, + + RETROK_KP0 = 256, + RETROK_KP1 = 257, + RETROK_KP2 = 258, + RETROK_KP3 = 259, + RETROK_KP4 = 260, + RETROK_KP5 = 261, + RETROK_KP6 = 262, + RETROK_KP7 = 263, + RETROK_KP8 = 264, + RETROK_KP9 = 265, + RETROK_KP_PERIOD = 266, + RETROK_KP_DIVIDE = 267, + RETROK_KP_MULTIPLY = 268, + RETROK_KP_MINUS = 269, + RETROK_KP_PLUS = 270, + RETROK_KP_ENTER = 271, + RETROK_KP_EQUALS = 272, + + RETROK_UP = 273, + RETROK_DOWN = 274, + RETROK_RIGHT = 275, + RETROK_LEFT = 276, + RETROK_INSERT = 277, + RETROK_HOME = 278, + RETROK_END = 279, + RETROK_PAGEUP = 280, + RETROK_PAGEDOWN = 281, + + RETROK_F1 = 282, + RETROK_F2 = 283, + RETROK_F3 = 284, + RETROK_F4 = 285, + RETROK_F5 = 286, + RETROK_F6 = 287, + RETROK_F7 = 288, + RETROK_F8 = 289, + RETROK_F9 = 290, + RETROK_F10 = 291, + RETROK_F11 = 292, + RETROK_F12 = 293, + RETROK_F13 = 294, + RETROK_F14 = 295, + RETROK_F15 = 296, + + RETROK_NUMLOCK = 300, + RETROK_CAPSLOCK = 301, + RETROK_SCROLLOCK = 302, + RETROK_RSHIFT = 303, + RETROK_LSHIFT = 304, + RETROK_RCTRL = 305, + RETROK_LCTRL = 306, + RETROK_RALT = 307, + RETROK_LALT = 308, + RETROK_RMETA = 309, + RETROK_LMETA = 310, + RETROK_LSUPER = 311, + RETROK_RSUPER = 312, + RETROK_MODE = 313, + RETROK_COMPOSE = 314, + + RETROK_HELP = 315, + RETROK_PRINT = 316, + RETROK_SYSREQ = 317, + RETROK_BREAK = 318, + RETROK_MENU = 319, + RETROK_POWER = 320, + RETROK_EURO = 321, + RETROK_UNDO = 322, + RETROK_OEM_102 = 323, + + RETROK_LAST, + + RETROK_DUMMY = INT_MAX /* Ensure sizeof(enum) == sizeof(int) */ +}; + +enum retro_mod +{ + RETROKMOD_NONE = 0x0000, + + RETROKMOD_SHIFT = 0x01, + RETROKMOD_CTRL = 0x02, + RETROKMOD_ALT = 0x04, + RETROKMOD_META = 0x08, + + RETROKMOD_NUMLOCK = 0x10, + RETROKMOD_CAPSLOCK = 0x20, + RETROKMOD_SCROLLOCK = 0x40, + + RETROKMOD_DUMMY = INT_MAX /* Ensure sizeof(enum) == sizeof(int) */ +}; + +/* If set, this call is not part of the public libretro API yet. It can + * change or be removed at any time. */ +#define RETRO_ENVIRONMENT_EXPERIMENTAL 0x10000 +/* Environment callback to be used internally in frontend. */ +#define RETRO_ENVIRONMENT_PRIVATE 0x20000 + +/* Environment commands. */ +#define RETRO_ENVIRONMENT_SET_ROTATION 1 /* const unsigned * -- + * Sets screen rotation of graphics. + * Valid values are 0, 1, 2, 3, which rotates screen by 0, 90, 180, + * 270 degrees counter-clockwise respectively. + */ +#define RETRO_ENVIRONMENT_GET_OVERSCAN 2 /* bool * -- + * NOTE: As of 2019 this callback is considered deprecated in favor of + * using core options to manage overscan in a more nuanced, core-specific way. + * + * Boolean value whether or not the implementation should use overscan, + * or crop away overscan. + */ +#define RETRO_ENVIRONMENT_GET_CAN_DUPE 3 /* bool * -- + * Boolean value whether or not frontend supports frame duping, + * passing NULL to video frame callback. + */ + + /* Environ 4, 5 are no longer supported (GET_VARIABLE / SET_VARIABLES), + * and reserved to avoid possible ABI clash. + */ + +#define RETRO_ENVIRONMENT_SET_MESSAGE 6 /* const struct retro_message * -- + * Sets a message to be displayed in implementation-specific manner + * for a certain amount of 'frames'. + * Should not be used for trivial messages, which should simply be + * logged via RETRO_ENVIRONMENT_GET_LOG_INTERFACE (or as a + * fallback, stderr). + */ +#define RETRO_ENVIRONMENT_SHUTDOWN 7 /* N/A (NULL) -- + * Requests the frontend to shutdown. + * Should only be used if game has a specific + * way to shutdown the game from a menu item or similar. + */ +#define RETRO_ENVIRONMENT_SET_PERFORMANCE_LEVEL 8 + /* const unsigned * -- + * Gives a hint to the frontend how demanding this implementation + * is on a system. E.g. reporting a level of 2 means + * this implementation should run decently on all frontends + * of level 2 and up. + * + * It can be used by the frontend to potentially warn + * about too demanding implementations. + * + * The levels are "floating". + * + * This function can be called on a per-game basis, + * as certain games an implementation can play might be + * particularly demanding. + * If called, it should be called in retro_load_game(). + */ +#define RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY 9 + /* const char ** -- + * Returns the "system" directory of the frontend. + * This directory can be used to store system specific + * content such as BIOSes, configuration data, etc. + * The returned value can be NULL. + * If so, no such directory is defined, + * and it's up to the implementation to find a suitable directory. + * + * NOTE: Some cores used this folder also for "save" data such as + * memory cards, etc, for lack of a better place to put it. + * This is now discouraged, and if possible, cores should try to + * use the new GET_SAVE_DIRECTORY. + */ +#define RETRO_ENVIRONMENT_SET_PIXEL_FORMAT 10 + /* const enum retro_pixel_format * -- + * Sets the internal pixel format used by the implementation. + * The default pixel format is RETRO_PIXEL_FORMAT_0RGB1555. + * This pixel format however, is deprecated (see enum retro_pixel_format). + * If the call returns false, the frontend does not support this pixel + * format. + * + * This function should be called inside retro_load_game() or + * retro_get_system_av_info(). + */ +#define RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS 11 + /* const struct retro_input_descriptor * -- + * Sets an array of retro_input_descriptors. + * It is up to the frontend to present this in a usable way. + * The array is terminated by retro_input_descriptor::description + * being set to NULL. + * This function can be called at any time, but it is recommended + * to call it as early as possible. + */ +#define RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK 12 + /* const struct retro_keyboard_callback * -- + * Sets a callback function used to notify core about keyboard events. + */ +#define RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE 13 + /* const struct retro_disk_control_callback * -- + * Sets an interface which frontend can use to eject and insert + * disk images. + * This is used for games which consist of multiple images and + * must be manually swapped out by the user (e.g. PSX). + */ +#define RETRO_ENVIRONMENT_SET_HW_RENDER 14 + /* struct retro_hw_render_callback * -- + * Sets an interface to let a libretro core render with + * hardware acceleration. + * Should be called in retro_load_game(). + * If successful, libretro cores will be able to render to a + * frontend-provided framebuffer. + * The size of this framebuffer will be at least as large as + * max_width/max_height provided in get_av_info(). + * If HW rendering is used, pass only RETRO_HW_FRAME_BUFFER_VALID or + * NULL to retro_video_refresh_t. + */ +#define RETRO_ENVIRONMENT_GET_VARIABLE 15 + /* struct retro_variable * -- + * Interface to acquire user-defined information from environment + * that cannot feasibly be supported in a multi-system way. + * 'key' should be set to a key which has already been set by + * SET_VARIABLES. + * 'data' will be set to a value or NULL. + */ +#define RETRO_ENVIRONMENT_SET_VARIABLES 16 + /* const struct retro_variable * -- + * Allows an implementation to signal the environment + * which variables it might want to check for later using + * GET_VARIABLE. + * This allows the frontend to present these variables to + * a user dynamically. + * This should be called the first time as early as + * possible (ideally in retro_set_environment). + * Afterward it may be called again for the core to communicate + * updated options to the frontend, but the number of core + * options must not change from the number in the initial call. + * + * 'data' points to an array of retro_variable structs + * terminated by a { NULL, NULL } element. + * retro_variable::key should be namespaced to not collide + * with other implementations' keys. E.g. A core called + * 'foo' should use keys named as 'foo_option'. + * retro_variable::value should contain a human readable + * description of the key as well as a '|' delimited list + * of expected values. + * + * The number of possible options should be very limited, + * i.e. it should be feasible to cycle through options + * without a keyboard. + * + * First entry should be treated as a default. + * + * Example entry: + * { "foo_option", "Speed hack coprocessor X; false|true" } + * + * Text before first ';' is description. This ';' must be + * followed by a space, and followed by a list of possible + * values split up with '|'. + * + * Only strings are operated on. The possible values will + * generally be displayed and stored as-is by the frontend. + */ +#define RETRO_ENVIRONMENT_GET_VARIABLE_UPDATE 17 + /* bool * -- + * Result is set to true if some variables are updated by + * frontend since last call to RETRO_ENVIRONMENT_GET_VARIABLE. + * Variables should be queried with GET_VARIABLE. + */ +#define RETRO_ENVIRONMENT_SET_SUPPORT_NO_GAME 18 + /* const bool * -- + * If true, the libretro implementation supports calls to + * retro_load_game() with NULL as argument. + * Used by cores which can run without particular game data. + * This should be called within retro_set_environment() only. + */ +#define RETRO_ENVIRONMENT_GET_LIBRETRO_PATH 19 + /* const char ** -- + * Retrieves the absolute path from where this libretro + * implementation was loaded. + * NULL is returned if the libretro was loaded statically + * (i.e. linked statically to frontend), or if the path cannot be + * determined. + * Mostly useful in cooperation with SET_SUPPORT_NO_GAME as assets can + * be loaded without ugly hacks. + */ + + /* Environment 20 was an obsolete version of SET_AUDIO_CALLBACK. + * It was not used by any known core at the time, + * and was removed from the API. */ +#define RETRO_ENVIRONMENT_SET_FRAME_TIME_CALLBACK 21 + /* const struct retro_frame_time_callback * -- + * Lets the core know how much time has passed since last + * invocation of retro_run(). + * The frontend can tamper with the timing to fake fast-forward, + * slow-motion, frame stepping, etc. + * In this case the delta time will use the reference value + * in frame_time_callback.. + */ +#define RETRO_ENVIRONMENT_SET_AUDIO_CALLBACK 22 + /* const struct retro_audio_callback * -- + * Sets an interface which is used to notify a libretro core about audio + * being available for writing. + * The callback can be called from any thread, so a core using this must + * have a thread safe audio implementation. + * It is intended for games where audio and video are completely + * asynchronous and audio can be generated on the fly. + * This interface is not recommended for use with emulators which have + * highly synchronous audio. + * + * The callback only notifies about writability; the libretro core still + * has to call the normal audio callbacks + * to write audio. The audio callbacks must be called from within the + * notification callback. + * The amount of audio data to write is up to the implementation. + * Generally, the audio callback will be called continously in a loop. + * + * Due to thread safety guarantees and lack of sync between audio and + * video, a frontend can selectively disallow this interface based on + * internal configuration. A core using this interface must also + * implement the "normal" audio interface. + * + * A libretro core using SET_AUDIO_CALLBACK should also make use of + * SET_FRAME_TIME_CALLBACK. + */ +#define RETRO_ENVIRONMENT_GET_RUMBLE_INTERFACE 23 + /* struct retro_rumble_interface * -- + * Gets an interface which is used by a libretro core to set + * state of rumble motors in controllers. + * A strong and weak motor is supported, and they can be + * controlled indepedently. + */ +#define RETRO_ENVIRONMENT_GET_INPUT_DEVICE_CAPABILITIES 24 + /* uint64_t * -- + * Gets a bitmask telling which device type are expected to be + * handled properly in a call to retro_input_state_t. + * Devices which are not handled or recognized always return + * 0 in retro_input_state_t. + * Example bitmask: caps = (1 << RETRO_DEVICE_JOYPAD) | (1 << RETRO_DEVICE_ANALOG). + * Should only be called in retro_run(). + */ +#define RETRO_ENVIRONMENT_GET_SENSOR_INTERFACE (25 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* struct retro_sensor_interface * -- + * Gets access to the sensor interface. + * The purpose of this interface is to allow + * setting state related to sensors such as polling rate, + * enabling/disable it entirely, etc. + * Reading sensor state is done via the normal + * input_state_callback API. + */ +#define RETRO_ENVIRONMENT_GET_CAMERA_INTERFACE (26 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* struct retro_camera_callback * -- + * Gets an interface to a video camera driver. + * A libretro core can use this interface to get access to a + * video camera. + * New video frames are delivered in a callback in same + * thread as retro_run(). + * + * GET_CAMERA_INTERFACE should be called in retro_load_game(). + * + * Depending on the camera implementation used, camera frames + * will be delivered as a raw framebuffer, + * or as an OpenGL texture directly. + * + * The core has to tell the frontend here which types of + * buffers can be handled properly. + * An OpenGL texture can only be handled when using a + * libretro GL core (SET_HW_RENDER). + * It is recommended to use a libretro GL core when + * using camera interface. + * + * The camera is not started automatically. The retrieved start/stop + * functions must be used to explicitly + * start and stop the camera driver. + */ +#define RETRO_ENVIRONMENT_GET_LOG_INTERFACE 27 + /* struct retro_log_callback * -- + * Gets an interface for logging. This is useful for + * logging in a cross-platform way + * as certain platforms cannot use stderr for logging. + * It also allows the frontend to + * show logging information in a more suitable way. + * If this interface is not used, libretro cores should + * log to stderr as desired. + */ +#define RETRO_ENVIRONMENT_GET_PERF_INTERFACE 28 + /* struct retro_perf_callback * -- + * Gets an interface for performance counters. This is useful + * for performance logging in a cross-platform way and for detecting + * architecture-specific features, such as SIMD support. + */ +#define RETRO_ENVIRONMENT_GET_LOCATION_INTERFACE 29 + /* struct retro_location_callback * -- + * Gets access to the location interface. + * The purpose of this interface is to be able to retrieve + * location-based information from the host device, + * such as current latitude / longitude. + */ +#define RETRO_ENVIRONMENT_GET_CONTENT_DIRECTORY 30 /* Old name, kept for compatibility. */ +#define RETRO_ENVIRONMENT_GET_CORE_ASSETS_DIRECTORY 30 + /* const char ** -- + * Returns the "core assets" directory of the frontend. + * This directory can be used to store specific assets that the + * core relies upon, such as art assets, + * input data, etc etc. + * The returned value can be NULL. + * If so, no such directory is defined, + * and it's up to the implementation to find a suitable directory. + */ +#define RETRO_ENVIRONMENT_GET_SAVE_DIRECTORY 31 + /* const char ** -- + * Returns the "save" directory of the frontend, unless there is no + * save directory available. The save directory should be used to + * store SRAM, memory cards, high scores, etc, if the libretro core + * cannot use the regular memory interface (retro_get_memory_data()). + * + * If the frontend cannot designate a save directory, it will return + * NULL to indicate that the core should attempt to operate without a + * save directory set. + * + * NOTE: early libretro cores used the system directory for save + * files. Cores that need to be backwards-compatible can still check + * GET_SYSTEM_DIRECTORY. + */ +#define RETRO_ENVIRONMENT_SET_SYSTEM_AV_INFO 32 + /* const struct retro_system_av_info * -- + * Sets a new av_info structure. This can only be called from + * within retro_run(). + * This should *only* be used if the core is completely altering the + * internal resolutions, aspect ratios, timings, sampling rate, etc. + * Calling this can require a full reinitialization of video/audio + * drivers in the frontend, + * + * so it is important to call it very sparingly, and usually only with + * the users explicit consent. + * An eventual driver reinitialize will happen so that video and + * audio callbacks + * happening after this call within the same retro_run() call will + * target the newly initialized driver. + * + * This callback makes it possible to support configurable resolutions + * in games, which can be useful to + * avoid setting the "worst case" in max_width/max_height. + * + * ***HIGHLY RECOMMENDED*** Do not call this callback every time + * resolution changes in an emulator core if it's + * expected to be a temporary change, for the reasons of possible + * driver reinitialization. + * This call is not a free pass for not trying to provide + * correct values in retro_get_system_av_info(). If you need to change + * things like aspect ratio or nominal width/height, + * use RETRO_ENVIRONMENT_SET_GEOMETRY, which is a softer variant + * of SET_SYSTEM_AV_INFO. + * + * If this returns false, the frontend does not acknowledge a + * changed av_info struct. + */ +#define RETRO_ENVIRONMENT_SET_PROC_ADDRESS_CALLBACK 33 + /* const struct retro_get_proc_address_interface * -- + * Allows a libretro core to announce support for the + * get_proc_address() interface. + * This interface allows for a standard way to extend libretro where + * use of environment calls are too indirect, + * e.g. for cases where the frontend wants to call directly into the core. + * + * If a core wants to expose this interface, SET_PROC_ADDRESS_CALLBACK + * **MUST** be called from within retro_set_environment(). + */ +#define RETRO_ENVIRONMENT_SET_SUBSYSTEM_INFO 34 + /* const struct retro_subsystem_info * -- + * This environment call introduces the concept of libretro "subsystems". + * A subsystem is a variant of a libretro core which supports + * different kinds of games. + * The purpose of this is to support e.g. emulators which might + * have special needs, e.g. Super Nintendo's Super GameBoy, Sufami Turbo. + * It can also be used to pick among subsystems in an explicit way + * if the libretro implementation is a multi-system emulator itself. + * + * Loading a game via a subsystem is done with retro_load_game_special(), + * and this environment call allows a libretro core to expose which + * subsystems are supported for use with retro_load_game_special(). + * A core passes an array of retro_game_special_info which is terminated + * with a zeroed out retro_game_special_info struct. + * + * If a core wants to use this functionality, SET_SUBSYSTEM_INFO + * **MUST** be called from within retro_set_environment(). + */ +#define RETRO_ENVIRONMENT_SET_CONTROLLER_INFO 35 + /* const struct retro_controller_info * -- + * This environment call lets a libretro core tell the frontend + * which controller subclasses are recognized in calls to + * retro_set_controller_port_device(). + * + * Some emulators such as Super Nintendo support multiple lightgun + * types which must be specifically selected from. It is therefore + * sometimes necessary for a frontend to be able to tell the core + * about a special kind of input device which is not specifcally + * provided by the Libretro API. + * + * In order for a frontend to understand the workings of those devices, + * they must be defined as a specialized subclass of the generic device + * types already defined in the libretro API. + * + * The core must pass an array of const struct retro_controller_info which + * is terminated with a blanked out struct. Each element of the + * retro_controller_info struct corresponds to the ascending port index + * that is passed to retro_set_controller_port_device() when that function + * is called to indicate to the core that the frontend has changed the + * active device subclass. SEE ALSO: retro_set_controller_port_device() + * + * The ascending input port indexes provided by the core in the struct + * are generally presented by frontends as ascending User # or Player #, + * such as Player 1, Player 2, Player 3, etc. Which device subclasses are + * supported can vary per input port. + * + * The first inner element of each entry in the retro_controller_info array + * is a retro_controller_description struct that specifies the names and + * codes of all device subclasses that are available for the corresponding + * User or Player, beginning with the generic Libretro device that the + * subclasses are derived from. The second inner element of each entry is the + * total number of subclasses that are listed in the retro_controller_description. + * + * NOTE: Even if special device types are set in the libretro core, + * libretro should only poll input based on the base input device types. + */ +#define RETRO_ENVIRONMENT_SET_MEMORY_MAPS (36 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* const struct retro_memory_map * -- + * This environment call lets a libretro core tell the frontend + * about the memory maps this core emulates. + * This can be used to implement, for example, cheats in a core-agnostic way. + * + * Should only be used by emulators; it doesn't make much sense for + * anything else. + * It is recommended to expose all relevant pointers through + * retro_get_memory_* as well. + * + * Can be called from retro_init and retro_load_game. + */ +#define RETRO_ENVIRONMENT_SET_GEOMETRY 37 + /* const struct retro_game_geometry * -- + * This environment call is similar to SET_SYSTEM_AV_INFO for changing + * video parameters, but provides a guarantee that drivers will not be + * reinitialized. + * This can only be called from within retro_run(). + * + * The purpose of this call is to allow a core to alter nominal + * width/heights as well as aspect ratios on-the-fly, which can be + * useful for some emulators to change in run-time. + * + * max_width/max_height arguments are ignored and cannot be changed + * with this call as this could potentially require a reinitialization or a + * non-constant time operation. + * If max_width/max_height are to be changed, SET_SYSTEM_AV_INFO is required. + * + * A frontend must guarantee that this environment call completes in + * constant time. + */ +#define RETRO_ENVIRONMENT_GET_USERNAME 38 + /* const char ** + * Returns the specified username of the frontend, if specified by the user. + * This username can be used as a nickname for a core that has online facilities + * or any other mode where personalization of the user is desirable. + * The returned value can be NULL. + * If this environ callback is used by a core that requires a valid username, + * a default username should be specified by the core. + */ +#define RETRO_ENVIRONMENT_GET_LANGUAGE 39 + /* unsigned * -- + * Returns the specified language of the frontend, if specified by the user. + * It can be used by the core for localization purposes. + */ +#define RETRO_ENVIRONMENT_GET_CURRENT_SOFTWARE_FRAMEBUFFER (40 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* struct retro_framebuffer * -- + * Returns a preallocated framebuffer which the core can use for rendering + * the frame into when not using SET_HW_RENDER. + * The framebuffer returned from this call must not be used + * after the current call to retro_run() returns. + * + * The goal of this call is to allow zero-copy behavior where a core + * can render directly into video memory, avoiding extra bandwidth cost by copying + * memory from core to video memory. + * + * If this call succeeds and the core renders into it, + * the framebuffer pointer and pitch can be passed to retro_video_refresh_t. + * If the buffer from GET_CURRENT_SOFTWARE_FRAMEBUFFER is to be used, + * the core must pass the exact + * same pointer as returned by GET_CURRENT_SOFTWARE_FRAMEBUFFER; + * i.e. passing a pointer which is offset from the + * buffer is undefined. The width, height and pitch parameters + * must also match exactly to the values obtained from GET_CURRENT_SOFTWARE_FRAMEBUFFER. + * + * It is possible for a frontend to return a different pixel format + * than the one used in SET_PIXEL_FORMAT. This can happen if the frontend + * needs to perform conversion. + * + * It is still valid for a core to render to a different buffer + * even if GET_CURRENT_SOFTWARE_FRAMEBUFFER succeeds. + * + * A frontend must make sure that the pointer obtained from this function is + * writeable (and readable). + */ +#define RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE (41 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* const struct retro_hw_render_interface ** -- + * Returns an API specific rendering interface for accessing API specific data. + * Not all HW rendering APIs support or need this. + * The contents of the returned pointer is specific to the rendering API + * being used. See the various headers like libretro_vulkan.h, etc. + * + * GET_HW_RENDER_INTERFACE cannot be called before context_reset has been called. + * Similarly, after context_destroyed callback returns, + * the contents of the HW_RENDER_INTERFACE are invalidated. + */ +#define RETRO_ENVIRONMENT_SET_SUPPORT_ACHIEVEMENTS (42 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* const bool * -- + * If true, the libretro implementation supports achievements + * either via memory descriptors set with RETRO_ENVIRONMENT_SET_MEMORY_MAPS + * or via retro_get_memory_data/retro_get_memory_size. + * + * This must be called before the first call to retro_run. + */ +#define RETRO_ENVIRONMENT_SET_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE (43 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* const struct retro_hw_render_context_negotiation_interface * -- + * Sets an interface which lets the libretro core negotiate with frontend how a context is created. + * The semantics of this interface depends on which API is used in SET_HW_RENDER earlier. + * This interface will be used when the frontend is trying to create a HW rendering context, + * so it will be used after SET_HW_RENDER, but before the context_reset callback. + */ +#define RETRO_ENVIRONMENT_SET_SERIALIZATION_QUIRKS 44 + /* uint64_t * -- + * Sets quirk flags associated with serialization. The frontend will zero any flags it doesn't + * recognize or support. Should be set in either retro_init or retro_load_game, but not both. + */ +#define RETRO_ENVIRONMENT_SET_HW_SHARED_CONTEXT (44 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* N/A (null) * -- + * The frontend will try to use a 'shared' hardware context (mostly applicable + * to OpenGL) when a hardware context is being set up. + * + * Returns true if the frontend supports shared hardware contexts and false + * if the frontend does not support shared hardware contexts. + * + * This will do nothing on its own until SET_HW_RENDER env callbacks are + * being used. + */ +#define RETRO_ENVIRONMENT_GET_VFS_INTERFACE (45 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* struct retro_vfs_interface_info * -- + * Gets access to the VFS interface. + * VFS presence needs to be queried prior to load_game or any + * get_system/save/other_directory being called to let front end know + * core supports VFS before it starts handing out paths. + * It is recomended to do so in retro_set_environment + */ +#define RETRO_ENVIRONMENT_GET_LED_INTERFACE (46 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* struct retro_led_interface * -- + * Gets an interface which is used by a libretro core to set + * state of LEDs. + */ +#define RETRO_ENVIRONMENT_GET_AUDIO_VIDEO_ENABLE (47 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* int * -- + * Tells the core if the frontend wants audio or video. + * If disabled, the frontend will discard the audio or video, + * so the core may decide to skip generating a frame or generating audio. + * This is mainly used for increasing performance. + * Bit 0 (value 1): Enable Video + * Bit 1 (value 2): Enable Audio + * Bit 2 (value 4): Use Fast Savestates. + * Bit 3 (value 8): Hard Disable Audio + * Other bits are reserved for future use and will default to zero. + * If video is disabled: + * * The frontend wants the core to not generate any video, + * including presenting frames via hardware acceleration. + * * The frontend's video frame callback will do nothing. + * * After running the frame, the video output of the next frame should be + * no different than if video was enabled, and saving and loading state + * should have no issues. + * If audio is disabled: + * * The frontend wants the core to not generate any audio. + * * The frontend's audio callbacks will do nothing. + * * After running the frame, the audio output of the next frame should be + * no different than if audio was enabled, and saving and loading state + * should have no issues. + * Fast Savestates: + * * Guaranteed to be created by the same binary that will load them. + * * Will not be written to or read from the disk. + * * Suggest that the core assumes loading state will succeed. + * * Suggest that the core updates its memory buffers in-place if possible. + * * Suggest that the core skips clearing memory. + * * Suggest that the core skips resetting the system. + * * Suggest that the core may skip validation steps. + * Hard Disable Audio: + * * Used for a secondary core when running ahead. + * * Indicates that the frontend will never need audio from the core. + * * Suggests that the core may stop synthesizing audio, but this should not + * compromise emulation accuracy. + * * Audio output for the next frame does not matter, and the frontend will + * never need an accurate audio state in the future. + * * State will never be saved when using Hard Disable Audio. + */ +#define RETRO_ENVIRONMENT_GET_MIDI_INTERFACE (48 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* struct retro_midi_interface ** -- + * Returns a MIDI interface that can be used for raw data I/O. + */ + +#define RETRO_ENVIRONMENT_GET_FASTFORWARDING (49 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* bool * -- + * Boolean value that indicates whether or not the frontend is in + * fastforwarding mode. + */ + +#define RETRO_ENVIRONMENT_GET_TARGET_REFRESH_RATE (50 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* float * -- + * Float value that lets us know what target refresh rate + * is curently in use by the frontend. + * + * The core can use the returned value to set an ideal + * refresh rate/framerate. + */ + +#define RETRO_ENVIRONMENT_GET_INPUT_BITMASKS (51 | RETRO_ENVIRONMENT_EXPERIMENTAL) + /* bool * -- + * Boolean value that indicates whether or not the frontend supports + * input bitmasks being returned by retro_input_state_t. The advantage + * of this is that retro_input_state_t has to be only called once to + * grab all button states instead of multiple times. + * + * If it returns true, you can pass RETRO_DEVICE_ID_JOYPAD_MASK as 'id' + * to retro_input_state_t (make sure 'device' is set to RETRO_DEVICE_JOYPAD). + * It will return a bitmask of all the digital buttons. + */ + +#define RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION 52 + /* unsigned * -- + * Unsigned value is the API version number of the core options + * interface supported by the frontend. If callback return false, + * API version is assumed to be 0. + * + * In legacy code, core options are set by passing an array of + * retro_variable structs to RETRO_ENVIRONMENT_SET_VARIABLES. + * This may be still be done regardless of the core options + * interface version. + * + * If version is >= 1 however, core options may instead be set by + * passing an array of retro_core_option_definition structs to + * RETRO_ENVIRONMENT_SET_CORE_OPTIONS, or a 2D array of + * retro_core_option_definition structs to RETRO_ENVIRONMENT_SET_CORE_OPTIONS_INTL. + * This allows the core to additionally set option sublabel information + * and/or provide localisation support. + */ + +#define RETRO_ENVIRONMENT_SET_CORE_OPTIONS 53 + /* const struct retro_core_option_definition ** -- + * Allows an implementation to signal the environment + * which variables it might want to check for later using + * GET_VARIABLE. + * This allows the frontend to present these variables to + * a user dynamically. + * This should only be called if RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION + * returns an API version of >= 1. + * This should be called instead of RETRO_ENVIRONMENT_SET_VARIABLES. + * This should be called the first time as early as + * possible (ideally in retro_set_environment). + * Afterwards it may be called again for the core to communicate + * updated options to the frontend, but the number of core + * options must not change from the number in the initial call. + * + * 'data' points to an array of retro_core_option_definition structs + * terminated by a { NULL, NULL, NULL, {{0}}, NULL } element. + * retro_core_option_definition::key should be namespaced to not collide + * with other implementations' keys. e.g. A core called + * 'foo' should use keys named as 'foo_option'. + * retro_core_option_definition::desc should contain a human readable + * description of the key. + * retro_core_option_definition::info should contain any additional human + * readable information text that a typical user may need to + * understand the functionality of the option. + * retro_core_option_definition::values is an array of retro_core_option_value + * structs terminated by a { NULL, NULL } element. + * > retro_core_option_definition::values[index].value is an expected option + * value. + * > retro_core_option_definition::values[index].label is a human readable + * label used when displaying the value on screen. If NULL, + * the value itself is used. + * retro_core_option_definition::default_value is the default core option + * setting. It must match one of the expected option values in the + * retro_core_option_definition::values array. If it does not, or the + * default value is NULL, the first entry in the + * retro_core_option_definition::values array is treated as the default. + * + * The number of possible options should be very limited, + * and must be less than RETRO_NUM_CORE_OPTION_VALUES_MAX. + * i.e. it should be feasible to cycle through options + * without a keyboard. + * + * Example entry: + * { + * "foo_option", + * "Speed hack coprocessor X", + * "Provides increased performance at the expense of reduced accuracy", + * { + * { "false", NULL }, + * { "true", NULL }, + * { "unstable", "Turbo (Unstable)" }, + * { NULL, NULL }, + * }, + * "false" + * } + * + * Only strings are operated on. The possible values will + * generally be displayed and stored as-is by the frontend. + */ + +#define RETRO_ENVIRONMENT_SET_CORE_OPTIONS_INTL 54 + /* const struct retro_core_options_intl * -- + * Allows an implementation to signal the environment + * which variables it might want to check for later using + * GET_VARIABLE. + * This allows the frontend to present these variables to + * a user dynamically. + * This should only be called if RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION + * returns an API version of >= 1. + * This should be called instead of RETRO_ENVIRONMENT_SET_VARIABLES. + * This should be called the first time as early as + * possible (ideally in retro_set_environment). + * Afterwards it may be called again for the core to communicate + * updated options to the frontend, but the number of core + * options must not change from the number in the initial call. + * + * This is fundamentally the same as RETRO_ENVIRONMENT_SET_CORE_OPTIONS, + * with the addition of localisation support. The description of the + * RETRO_ENVIRONMENT_SET_CORE_OPTIONS callback should be consulted + * for further details. + * + * 'data' points to a retro_core_options_intl struct. + * + * retro_core_options_intl::us is a pointer to an array of + * retro_core_option_definition structs defining the US English + * core options implementation. It must point to a valid array. + * + * retro_core_options_intl::local is a pointer to an array of + * retro_core_option_definition structs defining core options for + * the current frontend language. It may be NULL (in which case + * retro_core_options_intl::us is used by the frontend). Any items + * missing from this array will be read from retro_core_options_intl::us + * instead. + * + * NOTE: Default core option values are always taken from the + * retro_core_options_intl::us array. Any default values in + * retro_core_options_intl::local array will be ignored. + */ + +#define RETRO_ENVIRONMENT_SET_CORE_OPTIONS_DISPLAY 55 + /* struct retro_core_option_display * -- + * + * Allows an implementation to signal the environment to show + * or hide a variable when displaying core options. This is + * considered a *suggestion*. The frontend is free to ignore + * this callback, and its implementation not considered mandatory. + * + * 'data' points to a retro_core_option_display struct + * + * retro_core_option_display::key is a variable identifier + * which has already been set by SET_VARIABLES/SET_CORE_OPTIONS. + * + * retro_core_option_display::visible is a boolean, specifying + * whether variable should be displayed + * + * Note that all core option variables will be set visible by + * default when calling SET_VARIABLES/SET_CORE_OPTIONS. + */ + +#define RETRO_ENVIRONMENT_GET_PREFERRED_HW_RENDER 56 + /* unsigned * -- + * + * Allows an implementation to ask frontend preferred hardware + * context to use. Core should use this information to deal + * with what specific context to request with SET_HW_RENDER. + * + * 'data' points to an unsigned variable + */ + +#define RETRO_ENVIRONMENT_GET_DISK_CONTROL_INTERFACE_VERSION 57 + /* unsigned * -- + * Unsigned value is the API version number of the disk control + * interface supported by the frontend. If callback return false, + * API version is assumed to be 0. + * + * In legacy code, the disk control interface is defined by passing + * a struct of type retro_disk_control_callback to + * RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE. + * This may be still be done regardless of the disk control + * interface version. + * + * If version is >= 1 however, the disk control interface may + * instead be defined by passing a struct of type + * retro_disk_control_ext_callback to + * RETRO_ENVIRONMENT_SET_DISK_CONTROL_EXT_INTERFACE. + * This allows the core to provide additional information about + * disk images to the frontend and/or enables extra + * disk control functionality by the frontend. + */ + +#define RETRO_ENVIRONMENT_SET_DISK_CONTROL_EXT_INTERFACE 58 + /* const struct retro_disk_control_ext_callback * -- + * Sets an interface which frontend can use to eject and insert + * disk images, and also obtain information about individual + * disk image files registered by the core. + * This is used for games which consist of multiple images and + * must be manually swapped out by the user (e.g. PSX, floppy disk + * based systems). + */ + +#define RETRO_ENVIRONMENT_GET_MESSAGE_INTERFACE_VERSION 59 + /* unsigned * -- + * Unsigned value is the API version number of the message + * interface supported by the frontend. If callback returns + * false, API version is assumed to be 0. + * + * In legacy code, messages may be displayed in an + * implementation-specific manner by passing a struct + * of type retro_message to RETRO_ENVIRONMENT_SET_MESSAGE. + * This may be still be done regardless of the message + * interface version. + * + * If version is >= 1 however, messages may instead be + * displayed by passing a struct of type retro_message_ext + * to RETRO_ENVIRONMENT_SET_MESSAGE_EXT. This allows the + * core to specify message logging level, priority and + * destination (OSD, logging interface or both). + */ + +#define RETRO_ENVIRONMENT_SET_MESSAGE_EXT 60 + /* const struct retro_message_ext * -- + * Sets a message to be displayed in an implementation-specific + * manner for a certain amount of 'frames'. Additionally allows + * the core to specify message logging level, priority and + * destination (OSD, logging interface or both). + * Should not be used for trivial messages, which should simply be + * logged via RETRO_ENVIRONMENT_GET_LOG_INTERFACE (or as a + * fallback, stderr). + */ + +#define RETRO_ENVIRONMENT_GET_INPUT_MAX_USERS 61 + /* unsigned * -- + * Unsigned value is the number of active input devices + * provided by the frontend. This may change between + * frames, but will remain constant for the duration + * of each frame. + * If callback returns true, a core need not poll any + * input device with an index greater than or equal to + * the number of active devices. + * If callback returns false, the number of active input + * devices is unknown. In this case, all input devices + * should be considered active. + */ + +/* VFS functionality */ + +/* File paths: + * File paths passed as parameters when using this API shall be well formed UNIX-style, + * using "/" (unquoted forward slash) as directory separator regardless of the platform's native separator. + * Paths shall also include at least one forward slash ("game.bin" is an invalid path, use "./game.bin" instead). + * Other than the directory separator, cores shall not make assumptions about path format: + * "C:/path/game.bin", "http://example.com/game.bin", "#game/game.bin", "./game.bin" (without quotes) are all valid paths. + * Cores may replace the basename or remove path components from the end, and/or add new components; + * however, cores shall not append "./", "../" or multiple consecutive forward slashes ("//") to paths they request to front end. + * The frontend is encouraged to make such paths work as well as it can, but is allowed to give up if the core alters paths too much. + * Frontends are encouraged, but not required, to support native file system paths (modulo replacing the directory separator, if applicable). + * Cores are allowed to try using them, but must remain functional if the front rejects such requests. + * Cores are encouraged to use the libretro-common filestream functions for file I/O, + * as they seamlessly integrate with VFS, deal with directory separator replacement as appropriate + * and provide platform-specific fallbacks in cases where front ends do not support VFS. */ + +/* Opaque file handle + * Introduced in VFS API v1 */ +struct retro_vfs_file_handle; + +/* Opaque directory handle + * Introduced in VFS API v3 */ +struct retro_vfs_dir_handle; + +/* File open flags + * Introduced in VFS API v1 */ +#define RETRO_VFS_FILE_ACCESS_READ (1 << 0) /* Read only mode */ +#define RETRO_VFS_FILE_ACCESS_WRITE (1 << 1) /* Write only mode, discard contents and overwrites existing file unless RETRO_VFS_FILE_ACCESS_UPDATE is also specified */ +#define RETRO_VFS_FILE_ACCESS_READ_WRITE (RETRO_VFS_FILE_ACCESS_READ | RETRO_VFS_FILE_ACCESS_WRITE) /* Read-write mode, discard contents and overwrites existing file unless RETRO_VFS_FILE_ACCESS_UPDATE is also specified*/ +#define RETRO_VFS_FILE_ACCESS_UPDATE_EXISTING (1 << 2) /* Prevents discarding content of existing files opened for writing */ + +/* These are only hints. The frontend may choose to ignore them. Other than RAM/CPU/etc use, + and how they react to unlikely external interference (for example someone else writing to that file, + or the file's server going down), behavior will not change. */ +#define RETRO_VFS_FILE_ACCESS_HINT_NONE (0) +/* Indicate that the file will be accessed many times. The frontend should aggressively cache everything. */ +#define RETRO_VFS_FILE_ACCESS_HINT_FREQUENT_ACCESS (1 << 0) + +/* Seek positions */ +#define RETRO_VFS_SEEK_POSITION_START 0 +#define RETRO_VFS_SEEK_POSITION_CURRENT 1 +#define RETRO_VFS_SEEK_POSITION_END 2 + +/* stat() result flags + * Introduced in VFS API v3 */ +#define RETRO_VFS_STAT_IS_VALID (1 << 0) +#define RETRO_VFS_STAT_IS_DIRECTORY (1 << 1) +#define RETRO_VFS_STAT_IS_CHARACTER_SPECIAL (1 << 2) + +/* Get path from opaque handle. Returns the exact same path passed to file_open when getting the handle + * Introduced in VFS API v1 */ +typedef const char *(RETRO_CALLCONV *retro_vfs_get_path_t)(struct retro_vfs_file_handle *stream); + +/* Open a file for reading or writing. If path points to a directory, this will + * fail. Returns the opaque file handle, or NULL for error. + * Introduced in VFS API v1 */ +typedef struct retro_vfs_file_handle *(RETRO_CALLCONV *retro_vfs_open_t)(const char *path, unsigned mode, unsigned hints); + +/* Close the file and release its resources. Must be called if open_file returns non-NULL. Returns 0 on success, -1 on failure. + * Whether the call succeeds ot not, the handle passed as parameter becomes invalid and should no longer be used. + * Introduced in VFS API v1 */ +typedef int (RETRO_CALLCONV *retro_vfs_close_t)(struct retro_vfs_file_handle *stream); + +/* Return the size of the file in bytes, or -1 for error. + * Introduced in VFS API v1 */ +typedef int64_t (RETRO_CALLCONV *retro_vfs_size_t)(struct retro_vfs_file_handle *stream); + +/* Truncate file to specified size. Returns 0 on success or -1 on error + * Introduced in VFS API v2 */ +typedef int64_t (RETRO_CALLCONV *retro_vfs_truncate_t)(struct retro_vfs_file_handle *stream, int64_t length); + +/* Get the current read / write position for the file. Returns -1 for error. + * Introduced in VFS API v1 */ +typedef int64_t (RETRO_CALLCONV *retro_vfs_tell_t)(struct retro_vfs_file_handle *stream); + +/* Set the current read/write position for the file. Returns the new position, -1 for error. + * Introduced in VFS API v1 */ +typedef int64_t (RETRO_CALLCONV *retro_vfs_seek_t)(struct retro_vfs_file_handle *stream, int64_t offset, int seek_position); + +/* Read data from a file. Returns the number of bytes read, or -1 for error. + * Introduced in VFS API v1 */ +typedef int64_t (RETRO_CALLCONV *retro_vfs_read_t)(struct retro_vfs_file_handle *stream, void *s, uint64_t len); + +/* Write data to a file. Returns the number of bytes written, or -1 for error. + * Introduced in VFS API v1 */ +typedef int64_t (RETRO_CALLCONV *retro_vfs_write_t)(struct retro_vfs_file_handle *stream, const void *s, uint64_t len); + +/* Flush pending writes to file, if using buffered IO. Returns 0 on sucess, or -1 on failure. + * Introduced in VFS API v1 */ +typedef int (RETRO_CALLCONV *retro_vfs_flush_t)(struct retro_vfs_file_handle *stream); + +/* Delete the specified file. Returns 0 on success, -1 on failure + * Introduced in VFS API v1 */ +typedef int (RETRO_CALLCONV *retro_vfs_remove_t)(const char *path); + +/* Rename the specified file. Returns 0 on success, -1 on failure + * Introduced in VFS API v1 */ +typedef int (RETRO_CALLCONV *retro_vfs_rename_t)(const char *old_path, const char *new_path); + +/* Stat the specified file. Retruns a bitmask of RETRO_VFS_STAT_* flags, none are set if path was not valid. + * Additionally stores file size in given variable, unless NULL is given. + * Introduced in VFS API v3 */ +typedef int (RETRO_CALLCONV *retro_vfs_stat_t)(const char *path, int32_t *size); + +/* Create the specified directory. Returns 0 on success, -1 on unknown failure, -2 if already exists. + * Introduced in VFS API v3 */ +typedef int (RETRO_CALLCONV *retro_vfs_mkdir_t)(const char *dir); + +/* Open the specified directory for listing. Returns the opaque dir handle, or NULL for error. + * Support for the include_hidden argument may vary depending on the platform. + * Introduced in VFS API v3 */ +typedef struct retro_vfs_dir_handle *(RETRO_CALLCONV *retro_vfs_opendir_t)(const char *dir, bool include_hidden); + +/* Read the directory entry at the current position, and move the read pointer to the next position. + * Returns true on success, false if already on the last entry. + * Introduced in VFS API v3 */ +typedef bool (RETRO_CALLCONV *retro_vfs_readdir_t)(struct retro_vfs_dir_handle *dirstream); + +/* Get the name of the last entry read. Returns a string on success, or NULL for error. + * The returned string pointer is valid until the next call to readdir or closedir. + * Introduced in VFS API v3 */ +typedef const char *(RETRO_CALLCONV *retro_vfs_dirent_get_name_t)(struct retro_vfs_dir_handle *dirstream); + +/* Check if the last entry read was a directory. Returns true if it was, false otherwise (or on error). + * Introduced in VFS API v3 */ +typedef bool (RETRO_CALLCONV *retro_vfs_dirent_is_dir_t)(struct retro_vfs_dir_handle *dirstream); + +/* Close the directory and release its resources. Must be called if opendir returns non-NULL. Returns 0 on success, -1 on failure. + * Whether the call succeeds ot not, the handle passed as parameter becomes invalid and should no longer be used. + * Introduced in VFS API v3 */ +typedef int (RETRO_CALLCONV *retro_vfs_closedir_t)(struct retro_vfs_dir_handle *dirstream); + +struct retro_vfs_interface +{ + /* VFS API v1 */ + retro_vfs_get_path_t get_path; + retro_vfs_open_t open; + retro_vfs_close_t close; + retro_vfs_size_t size; + retro_vfs_tell_t tell; + retro_vfs_seek_t seek; + retro_vfs_read_t read; + retro_vfs_write_t write; + retro_vfs_flush_t flush; + retro_vfs_remove_t remove; + retro_vfs_rename_t rename; + /* VFS API v2 */ + retro_vfs_truncate_t truncate; + /* VFS API v3 */ + retro_vfs_stat_t stat; + retro_vfs_mkdir_t mkdir; + retro_vfs_opendir_t opendir; + retro_vfs_readdir_t readdir; + retro_vfs_dirent_get_name_t dirent_get_name; + retro_vfs_dirent_is_dir_t dirent_is_dir; + retro_vfs_closedir_t closedir; +}; + +struct retro_vfs_interface_info +{ + /* Set by core: should this be higher than the version the front end supports, + * front end will return false in the RETRO_ENVIRONMENT_GET_VFS_INTERFACE call + * Introduced in VFS API v1 */ + uint32_t required_interface_version; + + /* Frontend writes interface pointer here. The frontend also sets the actual + * version, must be at least required_interface_version. + * Introduced in VFS API v1 */ + struct retro_vfs_interface *iface; +}; + +enum retro_hw_render_interface_type +{ + RETRO_HW_RENDER_INTERFACE_VULKAN = 0, + RETRO_HW_RENDER_INTERFACE_D3D9 = 1, + RETRO_HW_RENDER_INTERFACE_D3D10 = 2, + RETRO_HW_RENDER_INTERFACE_D3D11 = 3, + RETRO_HW_RENDER_INTERFACE_D3D12 = 4, + RETRO_HW_RENDER_INTERFACE_GSKIT_PS2 = 5, + RETRO_HW_RENDER_INTERFACE_DUMMY = INT_MAX +}; + +/* Base struct. All retro_hw_render_interface_* types + * contain at least these fields. */ +struct retro_hw_render_interface +{ + enum retro_hw_render_interface_type interface_type; + unsigned interface_version; +}; + +typedef void (RETRO_CALLCONV *retro_set_led_state_t)(int led, int state); +struct retro_led_interface +{ + retro_set_led_state_t set_led_state; +}; + +/* Retrieves the current state of the MIDI input. + * Returns true if it's enabled, false otherwise. */ +typedef bool (RETRO_CALLCONV *retro_midi_input_enabled_t)(void); + +/* Retrieves the current state of the MIDI output. + * Returns true if it's enabled, false otherwise */ +typedef bool (RETRO_CALLCONV *retro_midi_output_enabled_t)(void); + +/* Reads next byte from the input stream. + * Returns true if byte is read, false otherwise. */ +typedef bool (RETRO_CALLCONV *retro_midi_read_t)(uint8_t *byte); + +/* Writes byte to the output stream. + * 'delta_time' is in microseconds and represent time elapsed since previous write. + * Returns true if byte is written, false otherwise. */ +typedef bool (RETRO_CALLCONV *retro_midi_write_t)(uint8_t byte, uint32_t delta_time); + +/* Flushes previously written data. + * Returns true if successful, false otherwise. */ +typedef bool (RETRO_CALLCONV *retro_midi_flush_t)(void); + +struct retro_midi_interface +{ + retro_midi_input_enabled_t input_enabled; + retro_midi_output_enabled_t output_enabled; + retro_midi_read_t read; + retro_midi_write_t write; + retro_midi_flush_t flush; +}; + +enum retro_hw_render_context_negotiation_interface_type +{ + RETRO_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE_VULKAN = 0, + RETRO_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE_DUMMY = INT_MAX +}; + +/* Base struct. All retro_hw_render_context_negotiation_interface_* types + * contain at least these fields. */ +struct retro_hw_render_context_negotiation_interface +{ + enum retro_hw_render_context_negotiation_interface_type interface_type; + unsigned interface_version; +}; + +/* Serialized state is incomplete in some way. Set if serialization is + * usable in typical end-user cases but should not be relied upon to + * implement frame-sensitive frontend features such as netplay or + * rerecording. */ +#define RETRO_SERIALIZATION_QUIRK_INCOMPLETE (1 << 0) +/* The core must spend some time initializing before serialization is + * supported. retro_serialize() will initially fail; retro_unserialize() + * and retro_serialize_size() may or may not work correctly either. */ +#define RETRO_SERIALIZATION_QUIRK_MUST_INITIALIZE (1 << 1) +/* Serialization size may change within a session. */ +#define RETRO_SERIALIZATION_QUIRK_CORE_VARIABLE_SIZE (1 << 2) +/* Set by the frontend to acknowledge that it supports variable-sized + * states. */ +#define RETRO_SERIALIZATION_QUIRK_FRONT_VARIABLE_SIZE (1 << 3) +/* Serialized state can only be loaded during the same session. */ +#define RETRO_SERIALIZATION_QUIRK_SINGLE_SESSION (1 << 4) +/* Serialized state cannot be loaded on an architecture with a different + * endianness from the one it was saved on. */ +#define RETRO_SERIALIZATION_QUIRK_ENDIAN_DEPENDENT (1 << 5) +/* Serialized state cannot be loaded on a different platform from the one it + * was saved on for reasons other than endianness, such as word size + * dependence */ +#define RETRO_SERIALIZATION_QUIRK_PLATFORM_DEPENDENT (1 << 6) + +#define RETRO_MEMDESC_CONST (1 << 0) /* The frontend will never change this memory area once retro_load_game has returned. */ +#define RETRO_MEMDESC_BIGENDIAN (1 << 1) /* The memory area contains big endian data. Default is little endian. */ +#define RETRO_MEMDESC_SYSTEM_RAM (1 << 2) /* The memory area is system RAM. This is main RAM of the gaming system. */ +#define RETRO_MEMDESC_SAVE_RAM (1 << 3) /* The memory area is save RAM. This RAM is usually found on a game cartridge, backed up by a battery. */ +#define RETRO_MEMDESC_VIDEO_RAM (1 << 4) /* The memory area is video RAM (VRAM) */ +#define RETRO_MEMDESC_ALIGN_2 (1 << 16) /* All memory access in this area is aligned to their own size, or 2, whichever is smaller. */ +#define RETRO_MEMDESC_ALIGN_4 (2 << 16) +#define RETRO_MEMDESC_ALIGN_8 (3 << 16) +#define RETRO_MEMDESC_MINSIZE_2 (1 << 24) /* All memory in this region is accessed at least 2 bytes at the time. */ +#define RETRO_MEMDESC_MINSIZE_4 (2 << 24) +#define RETRO_MEMDESC_MINSIZE_8 (3 << 24) +struct retro_memory_descriptor +{ + uint64_t flags; + + /* Pointer to the start of the relevant ROM or RAM chip. + * It's strongly recommended to use 'offset' if possible, rather than + * doing math on the pointer. + * + * If the same byte is mapped my multiple descriptors, their descriptors + * must have the same pointer. + * If 'start' does not point to the first byte in the pointer, put the + * difference in 'offset' instead. + * + * May be NULL if there's nothing usable here (e.g. hardware registers and + * open bus). No flags should be set if the pointer is NULL. + * It's recommended to minimize the number of descriptors if possible, + * but not mandatory. */ + void *ptr; + size_t offset; + + /* This is the location in the emulated address space + * where the mapping starts. */ + size_t start; + + /* Which bits must be same as in 'start' for this mapping to apply. + * The first memory descriptor to claim a certain byte is the one + * that applies. + * A bit which is set in 'start' must also be set in this. + * Can be zero, in which case each byte is assumed mapped exactly once. + * In this case, 'len' must be a power of two. */ + size_t select; + + /* If this is nonzero, the set bits are assumed not connected to the + * memory chip's address pins. */ + size_t disconnect; + + /* This one tells the size of the current memory area. + * If, after start+disconnect are applied, the address is higher than + * this, the highest bit of the address is cleared. + * + * If the address is still too high, the next highest bit is cleared. + * Can be zero, in which case it's assumed to be infinite (as limited + * by 'select' and 'disconnect'). */ + size_t len; + + /* To go from emulated address to physical address, the following + * order applies: + * Subtract 'start', pick off 'disconnect', apply 'len', add 'offset'. */ + + /* The address space name must consist of only a-zA-Z0-9_-, + * should be as short as feasible (maximum length is 8 plus the NUL), + * and may not be any other address space plus one or more 0-9A-F + * at the end. + * However, multiple memory descriptors for the same address space is + * allowed, and the address space name can be empty. NULL is treated + * as empty. + * + * Address space names are case sensitive, but avoid lowercase if possible. + * The same pointer may exist in multiple address spaces. + * + * Examples: + * blank+blank - valid (multiple things may be mapped in the same namespace) + * 'Sp'+'Sp' - valid (multiple things may be mapped in the same namespace) + * 'A'+'B' - valid (neither is a prefix of each other) + * 'S'+blank - valid ('S' is not in 0-9A-F) + * 'a'+blank - valid ('a' is not in 0-9A-F) + * 'a'+'A' - valid (neither is a prefix of each other) + * 'AR'+blank - valid ('R' is not in 0-9A-F) + * 'ARB'+blank - valid (the B can't be part of the address either, because + * there is no namespace 'AR') + * blank+'B' - not valid, because it's ambigous which address space B1234 + * would refer to. + * The length can't be used for that purpose; the frontend may want + * to append arbitrary data to an address, without a separator. */ + const char *addrspace; + + /* TODO: When finalizing this one, add a description field, which should be + * "WRAM" or something roughly equally long. */ + + /* TODO: When finalizing this one, replace 'select' with 'limit', which tells + * which bits can vary and still refer to the same address (limit = ~select). + * TODO: limit? range? vary? something else? */ + + /* TODO: When finalizing this one, if 'len' is above what 'select' (or + * 'limit') allows, it's bankswitched. Bankswitched data must have both 'len' + * and 'select' != 0, and the mappings don't tell how the system switches the + * banks. */ + + /* TODO: When finalizing this one, fix the 'len' bit removal order. + * For len=0x1800, pointer 0x1C00 should go to 0x1400, not 0x0C00. + * Algorithm: Take bits highest to lowest, but if it goes above len, clear + * the most recent addition and continue on the next bit. + * TODO: Can the above be optimized? Is "remove the lowest bit set in both + * pointer and 'len'" equivalent? */ + + /* TODO: Some emulators (MAME?) emulate big endian systems by only accessing + * the emulated memory in 32-bit chunks, native endian. But that's nothing + * compared to Darek Mihocka + * (section Emulation 103 - Nearly Free Byte Reversal) - he flips the ENTIRE + * RAM backwards! I'll want to represent both of those, via some flags. + * + * I suspect MAME either didn't think of that idea, or don't want the #ifdef. + * Not sure which, nor do I really care. */ + + /* TODO: Some of those flags are unused and/or don't really make sense. Clean + * them up. */ +}; + +/* The frontend may use the largest value of 'start'+'select' in a + * certain namespace to infer the size of the address space. + * + * If the address space is larger than that, a mapping with .ptr=NULL + * should be at the end of the array, with .select set to all ones for + * as long as the address space is big. + * + * Sample descriptors (minus .ptr, and RETRO_MEMFLAG_ on the flags): + * SNES WRAM: + * .start=0x7E0000, .len=0x20000 + * (Note that this must be mapped before the ROM in most cases; some of the + * ROM mappers + * try to claim $7E0000, or at least $7E8000.) + * SNES SPC700 RAM: + * .addrspace="S", .len=0x10000 + * SNES WRAM mirrors: + * .flags=MIRROR, .start=0x000000, .select=0xC0E000, .len=0x2000 + * .flags=MIRROR, .start=0x800000, .select=0xC0E000, .len=0x2000 + * SNES WRAM mirrors, alternate equivalent descriptor: + * .flags=MIRROR, .select=0x40E000, .disconnect=~0x1FFF + * (Various similar constructions can be created by combining parts of + * the above two.) + * SNES LoROM (512KB, mirrored a couple of times): + * .flags=CONST, .start=0x008000, .select=0x408000, .disconnect=0x8000, .len=512*1024 + * .flags=CONST, .start=0x400000, .select=0x400000, .disconnect=0x8000, .len=512*1024 + * SNES HiROM (4MB): + * .flags=CONST, .start=0x400000, .select=0x400000, .len=4*1024*1024 + * .flags=CONST, .offset=0x8000, .start=0x008000, .select=0x408000, .len=4*1024*1024 + * SNES ExHiROM (8MB): + * .flags=CONST, .offset=0, .start=0xC00000, .select=0xC00000, .len=4*1024*1024 + * .flags=CONST, .offset=4*1024*1024, .start=0x400000, .select=0xC00000, .len=4*1024*1024 + * .flags=CONST, .offset=0x8000, .start=0x808000, .select=0xC08000, .len=4*1024*1024 + * .flags=CONST, .offset=4*1024*1024+0x8000, .start=0x008000, .select=0xC08000, .len=4*1024*1024 + * Clarify the size of the address space: + * .ptr=NULL, .select=0xFFFFFF + * .len can be implied by .select in many of them, but was included for clarity. + */ + +struct retro_memory_map +{ + const struct retro_memory_descriptor *descriptors; + unsigned num_descriptors; +}; + +struct retro_controller_description +{ + /* Human-readable description of the controller. Even if using a generic + * input device type, this can be set to the particular device type the + * core uses. */ + const char *desc; + + /* Device type passed to retro_set_controller_port_device(). If the device + * type is a sub-class of a generic input device type, use the + * RETRO_DEVICE_SUBCLASS macro to create an ID. + * + * E.g. RETRO_DEVICE_SUBCLASS(RETRO_DEVICE_JOYPAD, 1). */ + unsigned id; +}; + +struct retro_controller_info +{ + const struct retro_controller_description *types; + unsigned num_types; +}; + +struct retro_subsystem_memory_info +{ + /* The extension associated with a memory type, e.g. "psram". */ + const char *extension; + + /* The memory type for retro_get_memory(). This should be at + * least 0x100 to avoid conflict with standardized + * libretro memory types. */ + unsigned type; +}; + +struct retro_subsystem_rom_info +{ + /* Describes what the content is (SGB BIOS, GB ROM, etc). */ + const char *desc; + + /* Same definition as retro_get_system_info(). */ + const char *valid_extensions; + + /* Same definition as retro_get_system_info(). */ + bool need_fullpath; + + /* Same definition as retro_get_system_info(). */ + bool block_extract; + + /* This is set if the content is required to load a game. + * If this is set to false, a zeroed-out retro_game_info can be passed. */ + bool required; + + /* Content can have multiple associated persistent + * memory types (retro_get_memory()). */ + const struct retro_subsystem_memory_info *memory; + unsigned num_memory; +}; + +struct retro_subsystem_info +{ + /* Human-readable string of the subsystem type, e.g. "Super GameBoy" */ + const char *desc; + + /* A computer friendly short string identifier for the subsystem type. + * This name must be [a-z]. + * E.g. if desc is "Super GameBoy", this can be "sgb". + * This identifier can be used for command-line interfaces, etc. + */ + const char *ident; + + /* Infos for each content file. The first entry is assumed to be the + * "most significant" content for frontend purposes. + * E.g. with Super GameBoy, the first content should be the GameBoy ROM, + * as it is the most "significant" content to a user. + * If a frontend creates new file paths based on the content used + * (e.g. savestates), it should use the path for the first ROM to do so. */ + const struct retro_subsystem_rom_info *roms; + + /* Number of content files associated with a subsystem. */ + unsigned num_roms; + + /* The type passed to retro_load_game_special(). */ + unsigned id; +}; + +typedef void (RETRO_CALLCONV *retro_proc_address_t)(void); + +/* libretro API extension functions: + * (None here so far). + * + * Get a symbol from a libretro core. + * Cores should only return symbols which are actual + * extensions to the libretro API. + * + * Frontends should not use this to obtain symbols to standard + * libretro entry points (static linking or dlsym). + * + * The symbol name must be equal to the function name, + * e.g. if void retro_foo(void); exists, the symbol must be called "retro_foo". + * The returned function pointer must be cast to the corresponding type. + */ +typedef retro_proc_address_t (RETRO_CALLCONV *retro_get_proc_address_t)(const char *sym); + +struct retro_get_proc_address_interface +{ + retro_get_proc_address_t get_proc_address; +}; + +enum retro_log_level +{ + RETRO_LOG_DEBUG = 0, + RETRO_LOG_INFO, + RETRO_LOG_WARN, + RETRO_LOG_ERROR, + + RETRO_LOG_DUMMY = INT_MAX +}; + +/* Logging function. Takes log level argument as well. */ +typedef void (RETRO_CALLCONV *retro_log_printf_t)(enum retro_log_level level, + const char *fmt, ...); + +struct retro_log_callback +{ + retro_log_printf_t log; +}; + +/* Performance related functions */ + +/* ID values for SIMD CPU features */ +#define RETRO_SIMD_SSE (1 << 0) +#define RETRO_SIMD_SSE2 (1 << 1) +#define RETRO_SIMD_VMX (1 << 2) +#define RETRO_SIMD_VMX128 (1 << 3) +#define RETRO_SIMD_AVX (1 << 4) +#define RETRO_SIMD_NEON (1 << 5) +#define RETRO_SIMD_SSE3 (1 << 6) +#define RETRO_SIMD_SSSE3 (1 << 7) +#define RETRO_SIMD_MMX (1 << 8) +#define RETRO_SIMD_MMXEXT (1 << 9) +#define RETRO_SIMD_SSE4 (1 << 10) +#define RETRO_SIMD_SSE42 (1 << 11) +#define RETRO_SIMD_AVX2 (1 << 12) +#define RETRO_SIMD_VFPU (1 << 13) +#define RETRO_SIMD_PS (1 << 14) +#define RETRO_SIMD_AES (1 << 15) +#define RETRO_SIMD_VFPV3 (1 << 16) +#define RETRO_SIMD_VFPV4 (1 << 17) +#define RETRO_SIMD_POPCNT (1 << 18) +#define RETRO_SIMD_MOVBE (1 << 19) +#define RETRO_SIMD_CMOV (1 << 20) +#define RETRO_SIMD_ASIMD (1 << 21) + +typedef uint64_t retro_perf_tick_t; +typedef int64_t retro_time_t; + +struct retro_perf_counter +{ + const char *ident; + retro_perf_tick_t start; + retro_perf_tick_t total; + retro_perf_tick_t call_cnt; + + bool registered; +}; + +/* Returns current time in microseconds. + * Tries to use the most accurate timer available. + */ +typedef retro_time_t (RETRO_CALLCONV *retro_perf_get_time_usec_t)(void); + +/* A simple counter. Usually nanoseconds, but can also be CPU cycles. + * Can be used directly if desired (when creating a more sophisticated + * performance counter system). + * */ +typedef retro_perf_tick_t (RETRO_CALLCONV *retro_perf_get_counter_t)(void); + +/* Returns a bit-mask of detected CPU features (RETRO_SIMD_*). */ +typedef uint64_t (RETRO_CALLCONV *retro_get_cpu_features_t)(void); + +/* Asks frontend to log and/or display the state of performance counters. + * Performance counters can always be poked into manually as well. + */ +typedef void (RETRO_CALLCONV *retro_perf_log_t)(void); + +/* Register a performance counter. + * ident field must be set with a discrete value and other values in + * retro_perf_counter must be 0. + * Registering can be called multiple times. To avoid calling to + * frontend redundantly, you can check registered field first. */ +typedef void (RETRO_CALLCONV *retro_perf_register_t)(struct retro_perf_counter *counter); + +/* Starts a registered counter. */ +typedef void (RETRO_CALLCONV *retro_perf_start_t)(struct retro_perf_counter *counter); + +/* Stops a registered counter. */ +typedef void (RETRO_CALLCONV *retro_perf_stop_t)(struct retro_perf_counter *counter); + +/* For convenience it can be useful to wrap register, start and stop in macros. + * E.g.: + * #ifdef LOG_PERFORMANCE + * #define RETRO_PERFORMANCE_INIT(perf_cb, name) static struct retro_perf_counter name = {#name}; if (!name.registered) perf_cb.perf_register(&(name)) + * #define RETRO_PERFORMANCE_START(perf_cb, name) perf_cb.perf_start(&(name)) + * #define RETRO_PERFORMANCE_STOP(perf_cb, name) perf_cb.perf_stop(&(name)) + * #else + * ... Blank macros ... + * #endif + * + * These can then be used mid-functions around code snippets. + * + * extern struct retro_perf_callback perf_cb; * Somewhere in the core. + * + * void do_some_heavy_work(void) + * { + * RETRO_PERFORMANCE_INIT(cb, work_1; + * RETRO_PERFORMANCE_START(cb, work_1); + * heavy_work_1(); + * RETRO_PERFORMANCE_STOP(cb, work_1); + * + * RETRO_PERFORMANCE_INIT(cb, work_2); + * RETRO_PERFORMANCE_START(cb, work_2); + * heavy_work_2(); + * RETRO_PERFORMANCE_STOP(cb, work_2); + * } + * + * void retro_deinit(void) + * { + * perf_cb.perf_log(); * Log all perf counters here for example. + * } + */ + +struct retro_perf_callback +{ + retro_perf_get_time_usec_t get_time_usec; + retro_get_cpu_features_t get_cpu_features; + + retro_perf_get_counter_t get_perf_counter; + retro_perf_register_t perf_register; + retro_perf_start_t perf_start; + retro_perf_stop_t perf_stop; + retro_perf_log_t perf_log; +}; + +/* FIXME: Document the sensor API and work out behavior. + * It will be marked as experimental until then. + */ +enum retro_sensor_action +{ + RETRO_SENSOR_ACCELEROMETER_ENABLE = 0, + RETRO_SENSOR_ACCELEROMETER_DISABLE, + RETRO_SENSOR_GYROSCOPE_ENABLE, + RETRO_SENSOR_GYROSCOPE_DISABLE, + RETRO_SENSOR_ILLUMINANCE_ENABLE, + RETRO_SENSOR_ILLUMINANCE_DISABLE, + + RETRO_SENSOR_DUMMY = INT_MAX +}; + +/* Id values for SENSOR types. */ +#define RETRO_SENSOR_ACCELEROMETER_X 0 +#define RETRO_SENSOR_ACCELEROMETER_Y 1 +#define RETRO_SENSOR_ACCELEROMETER_Z 2 +#define RETRO_SENSOR_GYROSCOPE_X 3 +#define RETRO_SENSOR_GYROSCOPE_Y 4 +#define RETRO_SENSOR_GYROSCOPE_Z 5 +#define RETRO_SENSOR_ILLUMINANCE 6 + +typedef bool (RETRO_CALLCONV *retro_set_sensor_state_t)(unsigned port, + enum retro_sensor_action action, unsigned rate); + +typedef float (RETRO_CALLCONV *retro_sensor_get_input_t)(unsigned port, unsigned id); + +struct retro_sensor_interface +{ + retro_set_sensor_state_t set_sensor_state; + retro_sensor_get_input_t get_sensor_input; +}; + +enum retro_camera_buffer +{ + RETRO_CAMERA_BUFFER_OPENGL_TEXTURE = 0, + RETRO_CAMERA_BUFFER_RAW_FRAMEBUFFER, + + RETRO_CAMERA_BUFFER_DUMMY = INT_MAX +}; + +/* Starts the camera driver. Can only be called in retro_run(). */ +typedef bool (RETRO_CALLCONV *retro_camera_start_t)(void); + +/* Stops the camera driver. Can only be called in retro_run(). */ +typedef void (RETRO_CALLCONV *retro_camera_stop_t)(void); + +/* Callback which signals when the camera driver is initialized + * and/or deinitialized. + * retro_camera_start_t can be called in initialized callback. + */ +typedef void (RETRO_CALLCONV *retro_camera_lifetime_status_t)(void); + +/* A callback for raw framebuffer data. buffer points to an XRGB8888 buffer. + * Width, height and pitch are similar to retro_video_refresh_t. + * First pixel is top-left origin. + */ +typedef void (RETRO_CALLCONV *retro_camera_frame_raw_framebuffer_t)(const uint32_t *buffer, + unsigned width, unsigned height, size_t pitch); + +/* A callback for when OpenGL textures are used. + * + * texture_id is a texture owned by camera driver. + * Its state or content should be considered immutable, except for things like + * texture filtering and clamping. + * + * texture_target is the texture target for the GL texture. + * These can include e.g. GL_TEXTURE_2D, GL_TEXTURE_RECTANGLE, and possibly + * more depending on extensions. + * + * affine points to a packed 3x3 column-major matrix used to apply an affine + * transform to texture coordinates. (affine_matrix * vec3(coord_x, coord_y, 1.0)) + * After transform, normalized texture coord (0, 0) should be bottom-left + * and (1, 1) should be top-right (or (width, height) for RECTANGLE). + * + * GL-specific typedefs are avoided here to avoid relying on gl.h in + * the API definition. + */ +typedef void (RETRO_CALLCONV *retro_camera_frame_opengl_texture_t)(unsigned texture_id, + unsigned texture_target, const float *affine); + +struct retro_camera_callback +{ + /* Set by libretro core. + * Example bitmask: caps = (1 << RETRO_CAMERA_BUFFER_OPENGL_TEXTURE) | (1 << RETRO_CAMERA_BUFFER_RAW_FRAMEBUFFER). + */ + uint64_t caps; + + /* Desired resolution for camera. Is only used as a hint. */ + unsigned width; + unsigned height; + + /* Set by frontend. */ + retro_camera_start_t start; + retro_camera_stop_t stop; + + /* Set by libretro core if raw framebuffer callbacks will be used. */ + retro_camera_frame_raw_framebuffer_t frame_raw_framebuffer; + + /* Set by libretro core if OpenGL texture callbacks will be used. */ + retro_camera_frame_opengl_texture_t frame_opengl_texture; + + /* Set by libretro core. Called after camera driver is initialized and + * ready to be started. + * Can be NULL, in which this callback is not called. + */ + retro_camera_lifetime_status_t initialized; + + /* Set by libretro core. Called right before camera driver is + * deinitialized. + * Can be NULL, in which this callback is not called. + */ + retro_camera_lifetime_status_t deinitialized; +}; + +/* Sets the interval of time and/or distance at which to update/poll + * location-based data. + * + * To ensure compatibility with all location-based implementations, + * values for both interval_ms and interval_distance should be provided. + * + * interval_ms is the interval expressed in milliseconds. + * interval_distance is the distance interval expressed in meters. + */ +typedef void (RETRO_CALLCONV *retro_location_set_interval_t)(unsigned interval_ms, + unsigned interval_distance); + +/* Start location services. The device will start listening for changes to the + * current location at regular intervals (which are defined with + * retro_location_set_interval_t). */ +typedef bool (RETRO_CALLCONV *retro_location_start_t)(void); + +/* Stop location services. The device will stop listening for changes + * to the current location. */ +typedef void (RETRO_CALLCONV *retro_location_stop_t)(void); + +/* Get the position of the current location. Will set parameters to + * 0 if no new location update has happened since the last time. */ +typedef bool (RETRO_CALLCONV *retro_location_get_position_t)(double *lat, double *lon, + double *horiz_accuracy, double *vert_accuracy); + +/* Callback which signals when the location driver is initialized + * and/or deinitialized. + * retro_location_start_t can be called in initialized callback. + */ +typedef void (RETRO_CALLCONV *retro_location_lifetime_status_t)(void); + +struct retro_location_callback +{ + retro_location_start_t start; + retro_location_stop_t stop; + retro_location_get_position_t get_position; + retro_location_set_interval_t set_interval; + + retro_location_lifetime_status_t initialized; + retro_location_lifetime_status_t deinitialized; +}; + +enum retro_rumble_effect +{ + RETRO_RUMBLE_STRONG = 0, + RETRO_RUMBLE_WEAK = 1, + + RETRO_RUMBLE_DUMMY = INT_MAX +}; + +/* Sets rumble state for joypad plugged in port 'port'. + * Rumble effects are controlled independently, + * and setting e.g. strong rumble does not override weak rumble. + * Strength has a range of [0, 0xffff]. + * + * Returns true if rumble state request was honored. + * Calling this before first retro_run() is likely to return false. */ +typedef bool (RETRO_CALLCONV *retro_set_rumble_state_t)(unsigned port, + enum retro_rumble_effect effect, uint16_t strength); + +struct retro_rumble_interface +{ + retro_set_rumble_state_t set_rumble_state; +}; + +/* Notifies libretro that audio data should be written. */ +typedef void (RETRO_CALLCONV *retro_audio_callback_t)(void); + +/* True: Audio driver in frontend is active, and callback is + * expected to be called regularily. + * False: Audio driver in frontend is paused or inactive. + * Audio callback will not be called until set_state has been + * called with true. + * Initial state is false (inactive). + */ +typedef void (RETRO_CALLCONV *retro_audio_set_state_callback_t)(bool enabled); + +struct retro_audio_callback +{ + retro_audio_callback_t callback; + retro_audio_set_state_callback_t set_state; +}; + +/* Notifies a libretro core of time spent since last invocation + * of retro_run() in microseconds. + * + * It will be called right before retro_run() every frame. + * The frontend can tamper with timing to support cases like + * fast-forward, slow-motion and framestepping. + * + * In those scenarios the reference frame time value will be used. */ +typedef int64_t retro_usec_t; +typedef void (RETRO_CALLCONV *retro_frame_time_callback_t)(retro_usec_t usec); +struct retro_frame_time_callback +{ + retro_frame_time_callback_t callback; + /* Represents the time of one frame. It is computed as + * 1000000 / fps, but the implementation will resolve the + * rounding to ensure that framestepping, etc is exact. */ + retro_usec_t reference; +}; + +/* Pass this to retro_video_refresh_t if rendering to hardware. + * Passing NULL to retro_video_refresh_t is still a frame dupe as normal. + * */ +#define RETRO_HW_FRAME_BUFFER_VALID ((void*)-1) + +/* Invalidates the current HW context. + * Any GL state is lost, and must not be deinitialized explicitly. + * If explicit deinitialization is desired by the libretro core, + * it should implement context_destroy callback. + * If called, all GPU resources must be reinitialized. + * Usually called when frontend reinits video driver. + * Also called first time video driver is initialized, + * allowing libretro core to initialize resources. + */ +typedef void (RETRO_CALLCONV *retro_hw_context_reset_t)(void); + +/* Gets current framebuffer which is to be rendered to. + * Could change every frame potentially. + */ +typedef uintptr_t (RETRO_CALLCONV *retro_hw_get_current_framebuffer_t)(void); + +/* Get a symbol from HW context. */ +typedef retro_proc_address_t (RETRO_CALLCONV *retro_hw_get_proc_address_t)(const char *sym); + +enum retro_hw_context_type +{ + RETRO_HW_CONTEXT_NONE = 0, + /* OpenGL 2.x. Driver can choose to use latest compatibility context. */ + RETRO_HW_CONTEXT_OPENGL = 1, + /* OpenGL ES 2.0. */ + RETRO_HW_CONTEXT_OPENGLES2 = 2, + /* Modern desktop core GL context. Use version_major/ + * version_minor fields to set GL version. */ + RETRO_HW_CONTEXT_OPENGL_CORE = 3, + /* OpenGL ES 3.0 */ + RETRO_HW_CONTEXT_OPENGLES3 = 4, + /* OpenGL ES 3.1+. Set version_major/version_minor. For GLES2 and GLES3, + * use the corresponding enums directly. */ + RETRO_HW_CONTEXT_OPENGLES_VERSION = 5, + + /* Vulkan, see RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE. */ + RETRO_HW_CONTEXT_VULKAN = 6, + + /* Direct3D, set version_major to select the type of interface + * returned by RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE */ + RETRO_HW_CONTEXT_DIRECT3D = 7, + + RETRO_HW_CONTEXT_DUMMY = INT_MAX +}; + +struct retro_hw_render_callback +{ + /* Which API to use. Set by libretro core. */ + enum retro_hw_context_type context_type; + + /* Called when a context has been created or when it has been reset. + * An OpenGL context is only valid after context_reset() has been called. + * + * When context_reset is called, OpenGL resources in the libretro + * implementation are guaranteed to be invalid. + * + * It is possible that context_reset is called multiple times during an + * application lifecycle. + * If context_reset is called without any notification (context_destroy), + * the OpenGL context was lost and resources should just be recreated + * without any attempt to "free" old resources. + */ + retro_hw_context_reset_t context_reset; + + /* Set by frontend. + * TODO: This is rather obsolete. The frontend should not + * be providing preallocated framebuffers. */ + retro_hw_get_current_framebuffer_t get_current_framebuffer; + + /* Set by frontend. + * Can return all relevant functions, including glClear on Windows. */ + retro_hw_get_proc_address_t get_proc_address; + + /* Set if render buffers should have depth component attached. + * TODO: Obsolete. */ + bool depth; + + /* Set if stencil buffers should be attached. + * TODO: Obsolete. */ + bool stencil; + + /* If depth and stencil are true, a packed 24/8 buffer will be added. + * Only attaching stencil is invalid and will be ignored. */ + + /* Use conventional bottom-left origin convention. If false, + * standard libretro top-left origin semantics are used. + * TODO: Move to GL specific interface. */ + bool bottom_left_origin; + + /* Major version number for core GL context or GLES 3.1+. */ + unsigned version_major; + + /* Minor version number for core GL context or GLES 3.1+. */ + unsigned version_minor; + + /* If this is true, the frontend will go very far to avoid + * resetting context in scenarios like toggling fullscreen, etc. + * TODO: Obsolete? Maybe frontend should just always assume this ... + */ + bool cache_context; + + /* The reset callback might still be called in extreme situations + * such as if the context is lost beyond recovery. + * + * For optimal stability, set this to false, and allow context to be + * reset at any time. + */ + + /* A callback to be called before the context is destroyed in a + * controlled way by the frontend. */ + retro_hw_context_reset_t context_destroy; + + /* OpenGL resources can be deinitialized cleanly at this step. + * context_destroy can be set to NULL, in which resources will + * just be destroyed without any notification. + * + * Even when context_destroy is non-NULL, it is possible that + * context_reset is called without any destroy notification. + * This happens if context is lost by external factors (such as + * notified by GL_ARB_robustness). + * + * In this case, the context is assumed to be already dead, + * and the libretro implementation must not try to free any OpenGL + * resources in the subsequent context_reset. + */ + + /* Creates a debug context. */ + bool debug_context; +}; + +/* Callback type passed in RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK. + * Called by the frontend in response to keyboard events. + * down is set if the key is being pressed, or false if it is being released. + * keycode is the RETROK value of the char. + * character is the text character of the pressed key. (UTF-32). + * key_modifiers is a set of RETROKMOD values or'ed together. + * + * The pressed/keycode state can be indepedent of the character. + * It is also possible that multiple characters are generated from a + * single keypress. + * Keycode events should be treated separately from character events. + * However, when possible, the frontend should try to synchronize these. + * If only a character is posted, keycode should be RETROK_UNKNOWN. + * + * Similarily if only a keycode event is generated with no corresponding + * character, character should be 0. + */ +typedef void (RETRO_CALLCONV *retro_keyboard_event_t)(bool down, unsigned keycode, + uint32_t character, uint16_t key_modifiers); + +struct retro_keyboard_callback +{ + retro_keyboard_event_t callback; +}; + +/* Callbacks for RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE & + * RETRO_ENVIRONMENT_SET_DISK_CONTROL_EXT_INTERFACE. + * Should be set for implementations which can swap out multiple disk + * images in runtime. + * + * If the implementation can do this automatically, it should strive to do so. + * However, there are cases where the user must manually do so. + * + * Overview: To swap a disk image, eject the disk image with + * set_eject_state(true). + * Set the disk index with set_image_index(index). Insert the disk again + * with set_eject_state(false). + */ + +/* If ejected is true, "ejects" the virtual disk tray. + * When ejected, the disk image index can be set. + */ +typedef bool (RETRO_CALLCONV *retro_set_eject_state_t)(bool ejected); + +/* Gets current eject state. The initial state is 'not ejected'. */ +typedef bool (RETRO_CALLCONV *retro_get_eject_state_t)(void); + +/* Gets current disk index. First disk is index 0. + * If return value is >= get_num_images(), no disk is currently inserted. + */ +typedef unsigned (RETRO_CALLCONV *retro_get_image_index_t)(void); + +/* Sets image index. Can only be called when disk is ejected. + * The implementation supports setting "no disk" by using an + * index >= get_num_images(). + */ +typedef bool (RETRO_CALLCONV *retro_set_image_index_t)(unsigned index); + +/* Gets total number of images which are available to use. */ +typedef unsigned (RETRO_CALLCONV *retro_get_num_images_t)(void); + +struct retro_game_info; + +/* Replaces the disk image associated with index. + * Arguments to pass in info have same requirements as retro_load_game(). + * Virtual disk tray must be ejected when calling this. + * + * Replacing a disk image with info = NULL will remove the disk image + * from the internal list. + * As a result, calls to get_image_index() can change. + * + * E.g. replace_image_index(1, NULL), and previous get_image_index() + * returned 4 before. + * Index 1 will be removed, and the new index is 3. + */ +typedef bool (RETRO_CALLCONV *retro_replace_image_index_t)(unsigned index, + const struct retro_game_info *info); + +/* Adds a new valid index (get_num_images()) to the internal disk list. + * This will increment subsequent return values from get_num_images() by 1. + * This image index cannot be used until a disk image has been set + * with replace_image_index. */ +typedef bool (RETRO_CALLCONV *retro_add_image_index_t)(void); + +/* Sets initial image to insert in drive when calling + * core_load_game(). + * Since we cannot pass the initial index when loading + * content (this would require a major API change), this + * is set by the frontend *before* calling the core's + * retro_load_game()/retro_load_game_special() implementation. + * A core should therefore cache the index/path values and handle + * them inside retro_load_game()/retro_load_game_special(). + * - If 'index' is invalid (index >= get_num_images()), the + * core should ignore the set value and instead use 0 + * - 'path' is used purely for error checking - i.e. when + * content is loaded, the core should verify that the + * disk specified by 'index' has the specified file path. + * This is to guard against auto selecting the wrong image + * if (for example) the user should modify an existing M3U + * playlist. We have to let the core handle this because + * set_initial_image() must be called before loading content, + * i.e. the frontend cannot access image paths in advance + * and thus cannot perform the error check itself. + * If set path and content path do not match, the core should + * ignore the set 'index' value and instead use 0 + * Returns 'false' if index or 'path' are invalid, or core + * does not support this functionality + */ +typedef bool (RETRO_CALLCONV *retro_set_initial_image_t)(unsigned index, const char *path); + +/* Fetches the path of the specified disk image file. + * Returns 'false' if index is invalid (index >= get_num_images()) + * or path is otherwise unavailable. + */ +typedef bool (RETRO_CALLCONV *retro_get_image_path_t)(unsigned index, char *path, size_t len); + +/* Fetches a core-provided 'label' for the specified disk + * image file. In the simplest case this may be a file name + * (without extension), but for cores with more complex + * content requirements information may be provided to + * facilitate user disk swapping - for example, a core + * running floppy-disk-based content may uniquely label + * save disks, data disks, level disks, etc. with names + * corresponding to in-game disk change prompts (so the + * frontend can provide better user guidance than a 'dumb' + * disk index value). + * Returns 'false' if index is invalid (index >= get_num_images()) + * or label is otherwise unavailable. + */ +typedef bool (RETRO_CALLCONV *retro_get_image_label_t)(unsigned index, char *label, size_t len); + +struct retro_disk_control_callback +{ + retro_set_eject_state_t set_eject_state; + retro_get_eject_state_t get_eject_state; + + retro_get_image_index_t get_image_index; + retro_set_image_index_t set_image_index; + retro_get_num_images_t get_num_images; + + retro_replace_image_index_t replace_image_index; + retro_add_image_index_t add_image_index; +}; + +struct retro_disk_control_ext_callback +{ + retro_set_eject_state_t set_eject_state; + retro_get_eject_state_t get_eject_state; + + retro_get_image_index_t get_image_index; + retro_set_image_index_t set_image_index; + retro_get_num_images_t get_num_images; + + retro_replace_image_index_t replace_image_index; + retro_add_image_index_t add_image_index; + + /* NOTE: Frontend will only attempt to record/restore + * last used disk index if both set_initial_image() + * and get_image_path() are implemented */ + retro_set_initial_image_t set_initial_image; /* Optional - may be NULL */ + + retro_get_image_path_t get_image_path; /* Optional - may be NULL */ + retro_get_image_label_t get_image_label; /* Optional - may be NULL */ +}; + +enum retro_pixel_format +{ + /* 0RGB1555, native endian. + * 0 bit must be set to 0. + * This pixel format is default for compatibility concerns only. + * If a 15/16-bit pixel format is desired, consider using RGB565. */ + RETRO_PIXEL_FORMAT_0RGB1555 = 0, + + /* XRGB8888, native endian. + * X bits are ignored. */ + RETRO_PIXEL_FORMAT_XRGB8888 = 1, + + /* RGB565, native endian. + * This pixel format is the recommended format to use if a 15/16-bit + * format is desired as it is the pixel format that is typically + * available on a wide range of low-power devices. + * + * It is also natively supported in APIs like OpenGL ES. */ + RETRO_PIXEL_FORMAT_RGB565 = 2, + + /* Ensure sizeof() == sizeof(int). */ + RETRO_PIXEL_FORMAT_UNKNOWN = INT_MAX +}; + +struct retro_message +{ + const char *msg; /* Message to be displayed. */ + unsigned frames; /* Duration in frames of message. */ +}; + +enum retro_message_target +{ + RETRO_MESSAGE_TARGET_ALL = 0, + RETRO_MESSAGE_TARGET_OSD, + RETRO_MESSAGE_TARGET_LOG +}; + +enum retro_message_type +{ + RETRO_MESSAGE_TYPE_NOTIFICATION = 0, + RETRO_MESSAGE_TYPE_NOTIFICATION_ALT, + RETRO_MESSAGE_TYPE_STATUS, + RETRO_MESSAGE_TYPE_PROGRESS +}; + +struct retro_message_ext +{ + /* Message string to be displayed/logged */ + const char *msg; + /* Duration (in ms) of message when targeting the OSD */ + unsigned duration; + /* Message priority when targeting the OSD + * > When multiple concurrent messages are sent to + * the frontend and the frontend does not have the + * capacity to display them all, messages with the + * *highest* priority value should be shown + * > There is no upper limit to a message priority + * value (within the bounds of the unsigned data type) + * > In the reference frontend (RetroArch), the same + * priority values are used for frontend-generated + * notifications, which are typically assigned values + * between 0 and 3 depending upon importance */ + unsigned priority; + /* Message logging level (info, warn, error, etc.) */ + enum retro_log_level level; + /* Message destination: OSD, logging interface or both */ + enum retro_message_target target; + /* Message 'type' when targeting the OSD + * > RETRO_MESSAGE_TYPE_NOTIFICATION: Specifies that a + * message should be handled in identical fashion to + * a standard frontend-generated notification + * > RETRO_MESSAGE_TYPE_NOTIFICATION_ALT: Specifies that + * message is a notification that requires user attention + * or action, but that it should be displayed in a manner + * that differs from standard frontend-generated notifications. + * This would typically correspond to messages that should be + * displayed immediately (independently from any internal + * frontend message queue), and/or which should be visually + * distinguishable from frontend-generated notifications. + * For example, a core may wish to inform the user of + * information related to a disk-change event. It is + * expected that the frontend itself may provide a + * notification in this case; if the core sends a + * message of type RETRO_MESSAGE_TYPE_NOTIFICATION, an + * uncomfortable 'double-notification' may occur. A message + * of RETRO_MESSAGE_TYPE_NOTIFICATION_ALT should therefore + * be presented such that visual conflict with regular + * notifications does not occur + * > RETRO_MESSAGE_TYPE_STATUS: Indicates that message + * is not a standard notification. This typically + * corresponds to 'status' indicators, such as a core's + * internal FPS, which are intended to be displayed + * either permanently while a core is running, or in + * a manner that does not suggest user attention or action + * is required. 'Status' type messages should therefore be + * displayed in a different on-screen location and in a manner + * easily distinguishable from both standard frontend-generated + * notifications and messages of type RETRO_MESSAGE_TYPE_NOTIFICATION_ALT + * > RETRO_MESSAGE_TYPE_PROGRESS: Indicates that message reports + * the progress of an internal core task. For example, in cases + * where a core itself handles the loading of content from a file, + * this may correspond to the percentage of the file that has been + * read. Alternatively, an audio/video playback core may use a + * message of type RETRO_MESSAGE_TYPE_PROGRESS to display the current + * playback position as a percentage of the runtime. 'Progress' type + * messages should therefore be displayed as a literal progress bar, + * where: + * - 'retro_message_ext.msg' is the progress bar title/label + * - 'retro_message_ext.progress' determines the length of + * the progress bar + * NOTE: Message type is a *hint*, and may be ignored + * by the frontend. If a frontend lacks support for + * displaying messages via alternate means than standard + * frontend-generated notifications, it will treat *all* + * messages as having the type RETRO_MESSAGE_TYPE_NOTIFICATION */ + enum retro_message_type type; + /* Task progress when targeting the OSD and message is + * of type RETRO_MESSAGE_TYPE_PROGRESS + * > -1: Unmetered/indeterminate + * > 0-100: Current progress percentage + * NOTE: Since message type is a hint, a frontend may ignore + * progress values. Where relevant, a core should therefore + * include progress percentage within the message string, + * such that the message intent remains clear when displayed + * as a standard frontend-generated notification */ + int8_t progress; +}; + +/* Describes how the libretro implementation maps a libretro input bind + * to its internal input system through a human readable string. + * This string can be used to better let a user configure input. */ +struct retro_input_descriptor +{ + /* Associates given parameters with a description. */ + unsigned port; + unsigned device; + unsigned index; + unsigned id; + + /* Human readable description for parameters. + * The pointer must remain valid until + * retro_unload_game() is called. */ + const char *description; +}; + +struct retro_system_info +{ + /* All pointers are owned by libretro implementation, and pointers must + * remain valid until 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. */ + + /* Libretro cores that need to have direct access to their content + * files, including cores which use the path of the content files to + * determine the paths of other files, should set need_fullpath to true. + * + * Cores should strive for setting need_fullpath to false, + * as it allows the frontend to perform patching, etc. + * + * If need_fullpath is true and retro_load_game() is called: + * - retro_game_info::path is guaranteed to have a valid path + * - retro_game_info::data and retro_game_info::size are invalid + * + * If need_fullpath is false and retro_load_game() is called: + * - retro_game_info::path may be NULL + * - retro_game_info::data and retro_game_info::size are guaranteed + * to be valid + * + * See also: + * - RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY + * - RETRO_ENVIRONMENT_GET_SAVE_DIRECTORY + */ + bool need_fullpath; + + /* If true, the frontend is not allowed to extract any archives before + * loading the real content. + * Necessary for certain libretro implementations that load games + * from zipped archives. */ + bool block_extract; +}; + +struct retro_game_geometry +{ + unsigned base_width; /* Nominal video width of game. */ + unsigned base_height; /* Nominal video height of game. */ + unsigned max_width; /* Maximum possible width of game. */ + unsigned max_height; /* Maximum possible height of game. */ + + float aspect_ratio; /* Nominal aspect ratio of game. If + * aspect_ratio is <= 0.0, an aspect ratio + * of base_width / base_height is assumed. + * A frontend could override this setting, + * if desired. */ +}; + +struct retro_system_timing +{ + double fps; /* FPS of video content. */ + double sample_rate; /* Sampling rate of audio. */ +}; + +struct retro_system_av_info +{ + struct retro_game_geometry geometry; + struct retro_system_timing timing; +}; + +struct retro_variable +{ + /* Variable to query in RETRO_ENVIRONMENT_GET_VARIABLE. + * If NULL, obtains the complete environment string if more + * complex parsing is necessary. + * The environment string is formatted as key-value pairs + * delimited by semicolons as so: + * "key1=value1;key2=value2;..." + */ + const char *key; + + /* Value to be obtained. If key does not exist, it is set to NULL. */ + const char *value; +}; + +struct retro_core_option_display +{ + /* Variable to configure in RETRO_ENVIRONMENT_SET_CORE_OPTIONS_DISPLAY */ + const char *key; + + /* Specifies whether variable should be displayed + * when presenting core options to the user */ + bool visible; +}; + +/* Maximum number of values permitted for a core option + * > Note: We have to set a maximum value due the limitations + * of the C language - i.e. it is not possible to create an + * array of structs each containing a variable sized array, + * so the retro_core_option_definition values array must + * have a fixed size. The size limit of 128 is a balancing + * act - it needs to be large enough to support all 'sane' + * core options, but setting it too large may impact low memory + * platforms. In practise, if a core option has more than + * 128 values then the implementation is likely flawed. + * To quote the above API reference: + * "The number of possible options should be very limited + * i.e. it should be feasible to cycle through options + * without a keyboard." + */ +#define RETRO_NUM_CORE_OPTION_VALUES_MAX 128 + +struct retro_core_option_value +{ + /* Expected option value */ + const char *value; + + /* Human-readable value label. If NULL, value itself + * will be displayed by the frontend */ + const char *label; +}; + +struct retro_core_option_definition +{ + /* Variable to query in RETRO_ENVIRONMENT_GET_VARIABLE. */ + const char *key; + + /* Human-readable core option description (used as menu label) */ + const char *desc; + + /* Human-readable core option information (used as menu sublabel) */ + const char *info; + + /* Array of retro_core_option_value structs, terminated by NULL */ + struct retro_core_option_value values[RETRO_NUM_CORE_OPTION_VALUES_MAX]; + + /* Default core option value. Must match one of the values + * in the retro_core_option_value array, otherwise will be + * ignored */ + const char *default_value; +}; + +struct retro_core_options_intl +{ + /* Pointer to an array of retro_core_option_definition structs + * - US English implementation + * - Must point to a valid array */ + struct retro_core_option_definition *us; + + /* Pointer to an array of retro_core_option_definition structs + * - Implementation for current frontend language + * - May be NULL */ + struct retro_core_option_definition *local; +}; + +struct retro_game_info +{ + const char *path; /* Path to game, UTF-8 encoded. + * Sometimes used as a reference for building other paths. + * May be NULL if game was loaded from stdin or similar, + * but in this case some cores will be unable to load `data`. + * So, it is preferable to fabricate something here instead + * of passing NULL, which will help more cores to succeed. + * retro_system_info::need_fullpath requires + * that this path is valid. */ + const void *data; /* Memory buffer of loaded game. Will be NULL + * if need_fullpath was set. */ + size_t size; /* Size of memory buffer. */ + const char *meta; /* String of implementation specific meta-data. */ +}; + +#define RETRO_MEMORY_ACCESS_WRITE (1 << 0) + /* The core will write to the buffer provided by retro_framebuffer::data. */ +#define RETRO_MEMORY_ACCESS_READ (1 << 1) + /* The core will read from retro_framebuffer::data. */ +#define RETRO_MEMORY_TYPE_CACHED (1 << 0) + /* The memory in data is cached. + * If not cached, random writes and/or reading from the buffer is expected to be very slow. */ +struct retro_framebuffer +{ + void *data; /* The framebuffer which the core can render into. + Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER. + The initial contents of data are unspecified. */ + unsigned width; /* The framebuffer width used by the core. Set by core. */ + unsigned height; /* The framebuffer height used by the core. Set by core. */ + size_t pitch; /* The number of bytes between the beginning of a scanline, + and beginning of the next scanline. + Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER. */ + enum retro_pixel_format format; /* The pixel format the core must use to render into data. + This format could differ from the format used in + SET_PIXEL_FORMAT. + Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER. */ + + unsigned access_flags; /* How the core will access the memory in the framebuffer. + RETRO_MEMORY_ACCESS_* flags. + Set by core. */ + unsigned memory_flags; /* Flags telling core how the memory has been mapped. + RETRO_MEMORY_TYPE_* flags. + Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER. */ +}; + +/* Callbacks */ + +/* Environment callback. Gives implementations a way of performing + * uncommon tasks. Extensible. */ +typedef bool (RETRO_CALLCONV *retro_environment_t)(unsigned cmd, void *data); + +/* Render a frame. Pixel format is 15-bit 0RGB1555 native endian + * unless changed (see RETRO_ENVIRONMENT_SET_PIXEL_FORMAT). + * + * Width and height specify dimensions of buffer. + * Pitch specifices length in bytes between two lines in buffer. + * + * For performance reasons, it is highly recommended to have a frame + * that is packed in memory, i.e. pitch == width * byte_per_pixel. + * Certain graphic APIs, such as OpenGL ES, do not like textures + * that are not packed in memory. + */ +typedef void (RETRO_CALLCONV *retro_video_refresh_t)(const void *data, unsigned width, + unsigned height, size_t pitch); + +/* Renders a single audio frame. Should only be used if implementation + * generates a single sample at a time. + * Format is signed 16-bit native endian. + */ +typedef void (RETRO_CALLCONV *retro_audio_sample_t)(int16_t left, int16_t right); + +/* Renders multiple audio frames in one go. + * + * One frame is defined as a sample of left and right channels, interleaved. + * I.e. int16_t buf[4] = { l, r, l, r }; would be 2 frames. + * Only one of the audio callbacks must ever be used. + */ +typedef size_t (RETRO_CALLCONV *retro_audio_sample_batch_t)(const int16_t *data, + size_t frames); + +/* Polls input. */ +typedef void (RETRO_CALLCONV *retro_input_poll_t)(void); + +/* Queries for input for player 'port'. device will be masked with + * RETRO_DEVICE_MASK. + * + * Specialization of devices such as RETRO_DEVICE_JOYPAD_MULTITAP that + * have been set with retro_set_controller_port_device() + * will still use the higher level RETRO_DEVICE_JOYPAD to request input. + */ +typedef int16_t (RETRO_CALLCONV *retro_input_state_t)(unsigned port, unsigned device, + unsigned index, unsigned id); + +/* Sets callbacks. retro_set_environment() is guaranteed to be called + * before retro_init(). + * + * The rest of the set_* functions are guaranteed to have been called + * before the first call to retro_run() is made. */ +RETRO_API void retro_set_environment(retro_environment_t); +RETRO_API void retro_set_video_refresh(retro_video_refresh_t); +RETRO_API void retro_set_audio_sample(retro_audio_sample_t); +RETRO_API void retro_set_audio_sample_batch(retro_audio_sample_batch_t); +RETRO_API void retro_set_input_poll(retro_input_poll_t); +RETRO_API void retro_set_input_state(retro_input_state_t); + +/* Library global initialization/deinitialization. */ +RETRO_API void retro_init(void); +RETRO_API void retro_deinit(void); + +/* Must return RETRO_API_VERSION. Used to validate ABI compatibility + * when the API is revised. */ +RETRO_API unsigned retro_api_version(void); + +/* Gets statically known system info. Pointers provided in *info + * must be statically allocated. + * Can be called at any time, even before retro_init(). */ +RETRO_API void retro_get_system_info(struct retro_system_info *info); + +/* Gets information about system audio/video timings and geometry. + * Can be called only after retro_load_game() has successfully completed. + * NOTE: The implementation of this function might not initialize every + * variable if needed. + * E.g. geom.aspect_ratio might not be initialized if core doesn't + * desire a particular aspect ratio. */ +RETRO_API void retro_get_system_av_info(struct retro_system_av_info *info); + +/* Sets device to be used for player 'port'. + * By default, RETRO_DEVICE_JOYPAD is assumed to be plugged into all + * available ports. + * Setting a particular device type is not a guarantee that libretro cores + * will only poll input based on that particular device type. It is only a + * hint to the libretro core when a core cannot automatically detect the + * appropriate input device type on its own. It is also relevant when a + * core can change its behavior depending on device type. + * + * As part of the core's implementation of retro_set_controller_port_device, + * the core should call RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS to notify the + * frontend if the descriptions for any controls have changed as a + * result of changing the device type. + */ +RETRO_API void retro_set_controller_port_device(unsigned port, unsigned device); + +/* Resets the current game. */ +RETRO_API void retro_reset(void); + +/* Runs the game for one video frame. + * During retro_run(), input_poll callback must be called at least once. + * + * If a frame is not rendered for reasons where a game "dropped" a frame, + * this still counts as a frame, and retro_run() should explicitly dupe + * a frame if GET_CAN_DUPE returns true. + * In this case, the video callback can take a NULL argument for data. + */ +RETRO_API void retro_run(void); + +/* Returns the amount of data the implementation requires to serialize + * internal state (save states). + * Between calls to retro_load_game() and retro_unload_game(), the + * returned size is never allowed to be larger than a previous returned + * value, to ensure that the frontend can allocate a save state buffer once. + */ +RETRO_API size_t retro_serialize_size(void); + +/* Serializes internal state. If failed, or size is lower than + * retro_serialize_size(), it should return false, true otherwise. */ +RETRO_API bool retro_serialize(void *data, size_t size); +RETRO_API bool retro_unserialize(const void *data, size_t size); + +RETRO_API void retro_cheat_reset(void); +RETRO_API void retro_cheat_set(unsigned index, bool enabled, const char *code); + +/* Loads a game. + * Return true to indicate successful loading and false to indicate load failure. + */ +RETRO_API bool retro_load_game(const struct retro_game_info *game); + +/* Loads a "special" kind of game. Should not be used, + * except in extreme cases. */ +RETRO_API bool retro_load_game_special( + unsigned game_type, + const struct retro_game_info *info, size_t num_info +); + +/* Unloads the currently loaded game. Called before retro_deinit(void). */ +RETRO_API void retro_unload_game(void); + +/* Gets region of game. */ +RETRO_API unsigned retro_get_region(void); + +/* Gets region of memory. */ +RETRO_API void *retro_get_memory_data(unsigned id); +RETRO_API size_t retro_get_memory_size(unsigned id); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/libretro/libretro_d3d.h b/libretro/libretro_d3d.h new file mode 100644 index 00000000000000..05c7c99df2325e --- /dev/null +++ b/libretro/libretro_d3d.h @@ -0,0 +1,56 @@ +/* Copyright (C) 2010-2016 The RetroArch team + * + * --------------------------------------------------------------------------------------------- + * The following license statement only applies to this libretro API header (libretro_vulkan.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_DIRECT3D_H__ +#define LIBRETRO_DIRECT3D_H__ + +#include "libretro.h" + +#include +#include + +#define RETRO_HW_RENDER_INTERFACE_D3D11_VERSION 1 + +struct retro_hw_render_interface_d3d11 +{ + /* Must be set to RETRO_HW_RENDER_INTERFACE_D3D11. */ + enum retro_hw_render_interface_type interface_type; + /* Must be set to RETRO_HW_RENDER_INTERFACE_D3D11_VERSION. */ + unsigned interface_version; + + /* Opaque handle to the d3d11 backend in the frontend + * which must be passed along to all function pointers + * in this interface. + */ + void* handle; + ID3D11Device *device; + ID3D11DeviceContext *context; + D3D_FEATURE_LEVEL featureLevel; + pD3DCompile D3DCompile; +}; + + +#endif /* LIBRETRO_DIRECT3D_H__ */ diff --git a/libretro/main.cpp b/libretro/main.cpp new file mode 100644 index 00000000000000..1746c067b48691 --- /dev/null +++ b/libretro/main.cpp @@ -0,0 +1,1069 @@ + +#include "PrecompiledHeader.h" + +#ifdef WIN32 +#include +#undef Yield +#endif + + +#include +#include +#include +#include + +#include "options.h" + +#include "GS.h" +#include "input.h" +#include "svnrev.h" +#include "SPU2/Global.h" +#include "ps2/BiosTools.h" +#include "CDVD/CDVD.h" +#include "MTVU.h" +#include "Counters.h" +#include "HostDisplay.h" +#include "common/StringUtil.h" +#include "common/Path.h" +#include "common/FileSystem.h" +#include "common/MemorySettingsInterface.h" +#include "common/SafeArray.inl" + +#include "pcsx2/Frontend/CommonHost.h" +#include "pcsx2/Frontend/FullscreenUI.h" +#include "pcsx2/Frontend/GameList.h" +#include "pcsx2/Frontend/InputManager.h" +#include "pcsx2/Frontend/ImGuiManager.h" +#include "pcsx2/Frontend/LogSink.h" +#include "pcsx2/Frontend/LayeredSettingsInterface.h" +#include "pcsx2/VMManager.h" +#include "pcsx2/StateWrapper.h" +#include "HostDisplay.h" +#include "HostSettings.h" + +#include "SPU2/spu2.h" +#include "PAD/Host/PAD.h" + +//#define PERF_TEST +#ifdef PERF_TEST +static struct retro_perf_callback perf_cb; + +#define RETRO_PERFORMANCE_INIT(name) \ + retro_perf_tick_t current_ticks; \ + static struct retro_perf_counter name = {#name}; \ + if (!name.registered) \ + perf_cb.perf_register(&(name)); \ + current_ticks = name.total + +#define RETRO_PERFORMANCE_START(name) perf_cb.perf_start(&(name)) +#define RETRO_PERFORMANCE_STOP(name) \ + perf_cb.perf_stop(&(name)); \ + current_ticks = name.total - current_ticks; +#else +#define RETRO_PERFORMANCE_INIT(name) +#define RETRO_PERFORMANCE_START(name) +#define RETRO_PERFORMANCE_STOP(name) +#endif + +namespace Options +{ +static Option bios("pcsx2_bios", "Bios"); // will be filled in retro_init() +static Option fast_boot("pcsx2_fastboot", "Fast Boot", true); + +GfxOption renderer("pcsx2_renderer", "Renderer", {"Auto", "OpenGL", +#ifdef _WIN32 + "D3D11", +#endif + "Software", "Null"}); + +} // namespace Options + +retro_environment_t environ_cb; +retro_video_refresh_t video_cb; +struct retro_hw_render_callback hw_render; +retro_log_printf_t log_cb; +static retro_audio_sample_batch_t batch_cb; +static retro_audio_sample_t sample_cb; + +static const int samples_max = 0x800; +static int write_pos = 0; +static s16 snd_buffer[samples_max << 1]; +static std::mutex snd_mutex; + +static VMState cpu_thread_state; +static MemorySettingsInterface s_settings_interface; + +static std::thread cpu_thread; +alignas(16) static SysMtgsThread s_mtgs_thread; + +SysMtgsThread& GetMTGS() +{ + return s_mtgs_thread; +} + +void retro_set_video_refresh(retro_video_refresh_t cb) +{ + video_cb = cb; +} + +void retro_set_audio_sample_batch(retro_audio_sample_batch_t cb) +{ + batch_cb = cb; +} + +void retro_set_audio_sample(retro_audio_sample_t cb) +{ + sample_cb = cb; +} + +bool SndBuffer::Init(const char* modname) +{ + write_pos = 0; + return true; +} + +void SndBuffer::Write(StereoOut16 Sample) +{ + std::unique_lock locker(snd_mutex); + if (write_pos < (samples_max << 1)) + { + snd_buffer[write_pos++] = Sample.Left; + snd_buffer[write_pos++] = Sample.Right; + } +} + +void retro_set_environment(retro_environment_t cb) +{ + environ_cb = cb; + bool no_game = true; + environ_cb(RETRO_ENVIRONMENT_SET_SUPPORT_NO_GAME, &no_game); +#ifdef PERF_TEST + environ_cb(RETRO_ENVIRONMENT_GET_PERF_INTERFACE, &perf_cb); +#endif +} + +static std::vector disk_images; +static int image_index = 0; + +static bool RETRO_CALLCONV get_eject_state(void) +{ + return cdvdRead(0x0B); +} + +static bool RETRO_CALLCONV set_eject_state(bool ejected) +{ + if (get_eject_state() == ejected) + return false; + + GetMTGS().SignalVsync(); + VMManager::SetPaused(true); + + if (ejected) + cdvdCtrlTrayOpen(); + else + { + if (image_index < 0 || image_index >= (int)disk_images.size()) + VMManager::ChangeDisc(CDVD_SourceType::NoDisc, ""); + else + VMManager::ChangeDisc(CDVD_SourceType::Iso, disk_images[image_index]); + cdvdCtrlTrayClose(); + } + + VMManager::SetPaused(false); + return true; +} + +static unsigned RETRO_CALLCONV get_image_index(void) +{ + return image_index; +} +static bool RETRO_CALLCONV set_image_index(unsigned index) +{ + if (get_eject_state()) + { + image_index = index; + return true; + } + + return false; +} +static unsigned RETRO_CALLCONV get_num_images(void) +{ + return disk_images.size(); +} + +static bool RETRO_CALLCONV replace_image_index(unsigned index, const struct retro_game_info* info) +{ + if (index >= disk_images.size()) + return false; + + if (!info->path) + { + disk_images.erase(disk_images.begin() + index); + if (!disk_images.size()) + image_index = -1; + else if (image_index > (int)index) + image_index--; + } + else + disk_images[index] = info->path; + + return true; +} + +static bool RETRO_CALLCONV add_image_index(void) +{ + disk_images.push_back(nullptr); + return true; +} + +static bool RETRO_CALLCONV set_initial_image(unsigned index, const char* path) +{ + if (index >= disk_images.size()) + index = 0; + + image_index = index; + + return true; +} + +static bool RETRO_CALLCONV get_image_path(unsigned index, char* path, size_t len) +{ + if (index >= disk_images.size()) + return false; + + if (!disk_images[index]) + return false; + + strncpy(path, disk_images[index], len); + return true; +} +static bool RETRO_CALLCONV get_image_label(unsigned index, char* label, size_t len) +{ + if (index >= disk_images.size()) + return false; + + if (!disk_images[index]) + return false; + + strncpy(label, disk_images[index], len); + return true; +} + +void retro_init(void) +{ + enum retro_pixel_format xrgb888 = RETRO_PIXEL_FORMAT_XRGB8888; + environ_cb(RETRO_ENVIRONMENT_SET_PIXEL_FORMAT, &xrgb888); + struct retro_log_callback log; + if (environ_cb(RETRO_ENVIRONMENT_GET_LOG_INTERFACE, &log)) + { + log_cb = log.log; +#if 0 + Console_SetActiveHandler(ConsoleWriter_Libretro); +#endif + } + + vu1Thread.Reset(); + + if (Options::bios.empty()) + { + std::string bios_dir; + const char* system = nullptr; + environ_cb(RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY, &system); + bios_dir = Path::Combine(system, "/pcsx2/bios"); + + FileSystem::FindResultsArray results; + if (FileSystem::FindFiles(bios_dir.c_str(), "*", FILESYSTEM_FIND_FILES, &results)) + { + static constexpr u32 MIN_BIOS_SIZE = 4 * _1mb; + static constexpr u32 MAX_BIOS_SIZE = 8 * _1mb; + u32 version, region; + std::string description, zone; + for (const FILESYSTEM_FIND_DATA& fd : results) + { + if (fd.Size < MIN_BIOS_SIZE || fd.Size > MAX_BIOS_SIZE) + continue; + + if (IsBIOS(fd.FileName.c_str(), version, description, region, zone)) + Options::bios.push_back(description, std::string(Path::GetFileName(fd.FileName))); + } + } + } + + Options::SetVariables(); + + static retro_disk_control_ext_callback disk_control = { + set_eject_state, + get_eject_state, + get_image_index, + set_image_index, + get_num_images, + replace_image_index, + add_image_index, + set_initial_image, + get_image_path, + get_image_label, + }; + + environ_cb(RETRO_ENVIRONMENT_SET_DISK_CONTROL_EXT_INTERFACE, &disk_control); +} + +void retro_deinit(void) +{ + // WIN32 doesn't allow canceling threads from global constructors/destructors in a shared library. + vu1Thread.Close(); +#ifdef PERF_TEST + perf_cb.perf_log(); +#endif +} + +void retro_get_system_info(retro_system_info* info) +{ +#ifdef GIT_REV + info->library_version = GIT_REV; +#else + static char version[] = "#.#.#"; + version[0] = '0' + PCSX2_VersionHi; + version[2] = '0' + PCSX2_VersionMid; + version[4] = '0' + PCSX2_VersionLo; + info->library_version = version; +#endif + + info->library_name = "pcsx2"; + info->valid_extensions = "elf|iso|ciso|cue|bin|gz"; + info->need_fullpath = true; + info->block_extract = true; +} + +void retro_get_system_av_info(retro_system_av_info* info) +{ + if (Options::renderer == "Software" || Options::renderer == "Null") + { + info->geometry.base_width = 640; + info->geometry.base_height = 480; + } + else + { + info->geometry.base_width = 640 * Options::upscale_multiplier; + info->geometry.base_height = 480 * Options::upscale_multiplier; + } + + info->geometry.max_width = info->geometry.base_width; + info->geometry.max_height = info->geometry.base_height; + + info->geometry.aspect_ratio = 4.0f / 3.0f; + info->timing.fps = (retro_get_region() == RETRO_REGION_NTSC) ? (60.0f / 1.001f) : 50.0f; + info->timing.sample_rate = 48000; +} + +void retro_reset(void) +{ + GetMTGS().Flush(); + VMManager::Reset(); + { + std::unique_lock locker(snd_mutex); + write_pos = 0; + } +} + +static void context_reset() +{ + printf("Context reset\n"); + + WindowInfo wi; + wi.surface_width = 640 * Options::upscale_multiplier; + wi.surface_height = 480 * Options::upscale_multiplier; + wi.surface_scale = 1.0f; + wi.type = WindowInfo::Type::Libretro; + + RenderAPI api; + switch(hw_render.context_type) + { +#ifdef _WIN32 + case RETRO_HW_CONTEXT_DIRECT3D: + if(hw_render.version_major == 11) + api = RenderAPI::D3D11; + else + api = RenderAPI::D3D12; + break; +#endif + case RETRO_HW_CONTEXT_VULKAN: + api = RenderAPI::Vulkan; + break; + + default: + api = RenderAPI::OpenGL; + break; + } + + g_host_display = HostDisplay::CreateForAPI(api); + g_host_display->CreateDevice(wi, VsyncMode::Off); + g_host_display->MakeCurrent(); + g_host_display->SetupDevice(); + +// GSConfig.UpscaleMultiplier = Options::upscale_multiplier; + EmuConfig.GS.UpscaleMultiplier = Options::upscale_multiplier; + GetMTGS().TryOpenGS(); + VMManager::SetPaused(false); +} +static void context_destroy() +{ + VMManager::SetPaused(true); + while(cpu_thread_state != VMState::Paused) + GetMTGS().Flush(); + GetMTGS().CloseGS(); + g_host_display.reset(); + printf("Context destroy\n"); +} + +static bool set_hw_render(retro_hw_context_type type) +{ + hw_render.context_type = type; + hw_render.context_reset = context_reset; + hw_render.context_destroy = context_destroy; + hw_render.bottom_left_origin = true; + hw_render.depth = true; + hw_render.cache_context = true; + + switch (type) + { +#ifdef _WIN32 + case RETRO_HW_CONTEXT_DIRECT3D: + hw_render.version_major = 11; + hw_render.version_minor = 0; + break; +#endif + case RETRO_HW_CONTEXT_OPENGL_CORE: + hw_render.version_major = 3; + hw_render.version_minor = 3; + hw_render.cache_context = false; + break; + + case RETRO_HW_CONTEXT_OPENGL: + hw_render.version_major = 3; + hw_render.version_minor = 0; + break; + + case RETRO_HW_CONTEXT_OPENGLES3: + hw_render.version_major = 3; + hw_render.version_minor = 0; + break; + + case RETRO_HW_CONTEXT_NONE: + return true; + + default: + return false; + } + + return environ_cb(RETRO_ENVIRONMENT_SET_HW_RENDER, &hw_render); +} + +bool select_hw_render() +{ + if (Options::renderer == "Auto") + { + retro_hw_context_type context_type = RETRO_HW_CONTEXT_OPENGL_CORE; + environ_cb(RETRO_ENVIRONMENT_GET_PREFERRED_HW_RENDER, &context_type); + if (set_hw_render(context_type)) + return true; + } +#ifdef _WIN32 + if (Options::renderer == "D3D11") + return set_hw_render(RETRO_HW_CONTEXT_DIRECT3D); +#endif + if (Options::renderer == "Null") + return set_hw_render(RETRO_HW_CONTEXT_NONE); + + if (set_hw_render(RETRO_HW_CONTEXT_OPENGL_CORE)) + return true; + if (set_hw_render(RETRO_HW_CONTEXT_OPENGL)) + return true; + if (set_hw_render(RETRO_HW_CONTEXT_OPENGLES3)) + return true; +#ifdef _WIN32 + if (set_hw_render(RETRO_HW_CONTEXT_DIRECT3D)) + return true; +#endif + + return false; +} + +static void executeVM() +{ + for (;;) + { + cpu_thread_state = VMManager::GetState(); + switch (VMManager::GetState()) + { + case VMState::Initializing: + pxFailRel("Shouldn't be in the starting state state"); + continue; + + case VMState::Paused: + continue; + + case VMState::Running: + VMManager::Execute(); + continue; + + case VMState::Resetting: + VMManager::Reset(); + continue; + + case VMState::Stopping: +// VMManager::Shutdown(false); + return; + + default: + continue; + } + } +} + +void cpu_thread_entry(VMBootParameters boot_params) +{ + VMManager::Initialize(boot_params); + VMManager::SetState(VMState::Running); + + while (VMManager::GetState() != VMState::Shutdown) + { + if (!VMManager::HasValidVM()) + continue; + + executeVM(); + } +} + +bool retro_load_game(const struct retro_game_info* game) +{ + CommonHost::InitializeCriticalFolders(); + Host::Internal::SetBaseSettingsLayer(&s_settings_interface); + CommonHost::SetDefaultSettings(s_settings_interface, true, true, true, true, true); + CommonHost::LoadStartupSettings(); + CommonHost::CPUThreadInitialize(); + + + const char* system_base = nullptr; + environ_cb(RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY, &system_base); + std::string system = Path::Combine(system_base, "pcsx2"); + + EmuFolders::AppRoot = system; + EmuFolders::DataRoot = system; + EmuFolders::Bios = Path::Combine(system, "bios"); + EmuFolders::Resources = Path::Combine(system, "resources"); + EmuFolders::MemoryCards = Path::Combine(system, "memcards"); + EmuFolders::GameSettings = Path::Combine(system, "gamesettings"); + + + if (Options::bios.empty()) + { + log_cb(RETRO_LOG_ERROR, "Could not find any valid PS2 Bios File in %s\n", EmuFolders::Bios.c_str()); + return false; + } + + s_settings_interface.SetBoolValue("EmuCore/GS", "FrameLimitEnable", false); + s_settings_interface.SetFloatValue("EmuCore/GS", "upscale_multiplier", Options::upscale_multiplier); + s_settings_interface.SetBoolValue("EmuCore", "EnableFastBoot", Options::fast_boot); + + EmuConfig.BaseFilenames.Bios = Options::bios.Get(); + EmuConfig.CurrentIRX = ""; // By default no IRX injection +// EmuConfig.UseBOOT2Injection = Options::fast_boot; +// EmuConfig.GS.FrameLimitEnable = false; +// EmuConfig.GS.UpscaleMultiplier = Options::upscale_multiplier; +// EmuConfig.GS.SynchronousMTGS = true; + + write_pos = 0; + + Input::Init(); + +// g_host_display = HostDisplay::CreateForAPI(RenderAPI::OpenGL); + Options::renderer.UpdateAndLock(); // disallow changes to Options::renderer outside of retro_load_game. + + if(!select_hw_render()) + return false; + + switch (hw_render.context_type) + { + case RETRO_HW_CONTEXT_DIRECT3D: + s_settings_interface.SetIntValue("EmuCore/GS", "Renderer", (int)GSRendererType::DX11); + break; + case RETRO_HW_CONTEXT_NONE: + s_settings_interface.SetIntValue("EmuCore/GS", "Renderer", (int)GSRendererType::Null); + break; + default: + if(Options::renderer == "Software") + s_settings_interface.SetIntValue("EmuCore/GS", "Renderer", (int)GSRendererType::SW); + else + s_settings_interface.SetIntValue("EmuCore/GS", "Renderer", (int)GSRendererType::OGL); + break; + } + + VMManager::ApplySettings(); + + VMBootParameters boot_params; + boot_params.filename = game->path; + cpu_thread = std::thread(cpu_thread_entry, boot_params); + + return true; +} + +bool retro_load_game_special(unsigned game_type, const struct retro_game_info* info, + size_t num_info) +{ + return false; +} + +void retro_unload_game(void) +{ + VMManager::Shutdown(false); +// GetMTGS().CloseGS(); + cpu_thread.join(); + CommonHost::CPUThreadShutdown(); + ((LayeredSettingsInterface*)Host::GetSettingsInterface())->SetLayer(LayeredSettingsInterface::LAYER_BASE, nullptr); +// g_host_display.reset(); +} + + +void retro_run(void) +{ + Options::CheckVariables(); + + Input::Update(); + + if (Options::upscale_multiplier.Updated()) + { + retro_system_av_info av_info; + retro_get_system_av_info(&av_info); +#if 1 + environ_cb(RETRO_ENVIRONMENT_SET_SYSTEM_AV_INFO, &av_info); +#else + environ_cb(RETRO_ENVIRONMENT_SET_GEOMETRY, &av_info.geometry); + GetMTGS().ClosePlugin(); + GetMTGS().OpenPlugin(); +#endif + } + + // GetCoreThread().Resume(); + GetMTGS().TryOpenGS(); + while (VMManager::GetState() == VMState::Initializing) + GetMTGS().StepFrame(); + + if (VMManager::GetState() == VMState::Paused) + VMManager::SetState(VMState::Running); + + RETRO_PERFORMANCE_INIT(pcsx2_run); + RETRO_PERFORMANCE_START(pcsx2_run); + + if (write_pos > (0x100 << 1)) + { + std::unique_lock locker(snd_mutex); + batch_cb(snd_buffer, write_pos >> 1); + write_pos = 0; + } + + GetMTGS().StepFrame(); + + if (write_pos > (0x100 << 1)) + { + std::unique_lock locker(snd_mutex); + batch_cb(snd_buffer, write_pos >> 1); + write_pos = 0; + } + + RETRO_PERFORMANCE_STOP(pcsx2_run); +} + +size_t retro_serialize_size(void) +{ + freezeData fP = {0, nullptr}; + + size_t size = _8mb; + size += Ps2MemSize::MainRam; + size += Ps2MemSize::IopRam; + size += Ps2MemSize::Hardware; + size += Ps2MemSize::IopHardware; + size += Ps2MemSize::Scratch; + size += VU0_MEMSIZE; + size += VU1_MEMSIZE; + size += VU0_PROGSIZE; + size += VU1_PROGSIZE; + SPU2freeze(FreezeAction::Size, &fP); + size += fP.size; + PADfreeze(FreezeAction::Size, &fP); + size += fP.size; + GSfreeze(FreezeAction::Size, &fP); + size += fP.size; + + return size; +} + +bool retro_serialize(void* data, size_t size) +{ + VMManager::SetPaused(true); + while(cpu_thread_state != VMState::Paused) + GetMTGS().Flush(); + + VmStateBuffer buffer; + memSavingState saveme(buffer); + freezeData fP; + + saveme.FreezeBios(); + saveme.FreezeInternals(); + + saveme.FreezeMem(eeMem->Main, sizeof(eeMem->Main)); + saveme.FreezeMem(iopMem->Main, sizeof(iopMem->Main)); + saveme.FreezeMem(eeHw, sizeof(eeHw)); + saveme.FreezeMem(iopHw, sizeof(iopHw)); + saveme.FreezeMem(eeMem->Scratch, sizeof(eeMem->Scratch)); + saveme.FreezeMem(vuRegs[0].Mem, VU0_MEMSIZE); + saveme.FreezeMem(vuRegs[1].Mem, VU1_MEMSIZE); + saveme.FreezeMem(vuRegs[0].Micro, VU0_PROGSIZE); + saveme.FreezeMem(vuRegs[1].Micro, VU1_PROGSIZE); + + fP.size = 0; + fP.data = nullptr; + SPU2freeze(FreezeAction::Size, &fP); + saveme.PrepBlock(fP.size); + fP.data = saveme.GetBlockPtr(); + SPU2freeze(FreezeAction::Save, &fP); + saveme.CommitBlock(fP.size); + + fP.size = 0; + fP.data = nullptr; + PADfreeze(FreezeAction::Size, &fP); + saveme.PrepBlock(fP.size); + fP.data = saveme.GetBlockPtr(); + PADfreeze(FreezeAction::Save, &fP); + saveme.CommitBlock(fP.size); + + fP.size = 0; + fP.data = nullptr; + GSfreeze(FreezeAction::Size, &fP); + saveme.PrepBlock(fP.size); + fP.data = saveme.GetBlockPtr(); + GSfreeze(FreezeAction::Save, &fP); + saveme.CommitBlock(fP.size); + + pxAssert(size >= (size_t)buffer.GetLength()); + printf("size : %i, buffer: %i\n", size , buffer.GetLength()); + memcpy(data, buffer.GetPtr(), buffer.GetLength()); + + + VMManager::SetPaused(false); + return true; +} + +bool retro_unserialize(const void* data, size_t size) +{ + VMManager::SetPaused(true); + while(cpu_thread_state != VMState::Paused) + GetMTGS().Flush(); + + VmStateBuffer buffer; + buffer.MakeRoomFor(size); + memcpy(buffer.GetPtr(), data, size); + memLoadingState loadme(buffer); + freezeData fP; + + loadme.FreezeBios(); + loadme.FreezeInternals(); + + SysClearExecutionCache(); + loadme.FreezeMem(eeMem->Main, sizeof(eeMem->Main)); + loadme.FreezeMem(iopMem->Main, sizeof(iopMem->Main)); + loadme.FreezeMem(eeHw, sizeof(eeHw)); + loadme.FreezeMem(iopHw, sizeof(iopHw)); + loadme.FreezeMem(eeMem->Scratch, sizeof(eeMem->Scratch)); + loadme.FreezeMem(vuRegs[0].Mem, VU0_MEMSIZE); + loadme.FreezeMem(vuRegs[1].Mem, VU1_MEMSIZE); + loadme.FreezeMem(vuRegs[0].Micro, VU0_PROGSIZE); + loadme.FreezeMem(vuRegs[1].Micro, VU1_PROGSIZE); + + fP.size = 0; + fP.data = nullptr; + SPU2freeze(FreezeAction::Size, &fP); + loadme.PrepBlock(fP.size); + fP.data = loadme.GetBlockPtr(); + SPU2freeze(FreezeAction::Load, &fP); + loadme.CommitBlock(fP.size); + + fP.size = 0; + fP.data = nullptr; + PADfreeze(FreezeAction::Size, &fP); + loadme.PrepBlock(fP.size); + fP.data = loadme.GetBlockPtr(); + PADfreeze(FreezeAction::Load, &fP); + loadme.CommitBlock(fP.size); + + fP.size = 0; + fP.data = nullptr; + GSfreeze(FreezeAction::Size, &fP); + loadme.PrepBlock(fP.size); + fP.data = loadme.GetBlockPtr(); + GSfreeze(FreezeAction::Load, &fP); + loadme.CommitBlock(fP.size); + + VMManager::SetPaused(false); + return true; +} + +unsigned retro_get_region(void) +{ + return RETRO_REGION_NTSC; +} + +unsigned retro_api_version() +{ + return RETRO_API_VERSION; +} + +size_t retro_get_memory_size(unsigned id) +{ + return 0; +} + +void* retro_get_memory_data(unsigned id) +{ + return NULL; +} + +void retro_cheat_reset(void) +{ +} + +void retro_cheat_set(unsigned index, bool enabled, const char* code) +{ +} + +void SaveStateBase::InputRecordingFreeze() +{ +#if 0 + FreezeTag("InputRecording"); + Freeze(g_FrameCount); +#endif +} + +#include "Host.h" + +void Host::AddOSDMessage(std::string message, float duration) +{ + +} +void Host::AddKeyedOSDMessage(std::string key, std::string message, float duration) +{ + +} +void Host::AddIconOSDMessage(std::string key, const char* icon, const std::string_view& message, float duration) +{ + +} + +#include "common/Path.h" +#include "common/FileSystem.h" + +std::optional> Host::ReadResourceFile(const char* filename) +{ + const std::string path(Path::Combine(EmuFolders::Resources, filename)); + std::optional> ret(FileSystem::ReadBinaryFile(path.c_str())); + if (!ret.has_value()) + Console.Error("Failed to read resource file '%s'", filename); + return ret; +} + +std::optional Host::ReadResourceFileToString(const char* filename) +{ + const std::string path(Path::Combine(EmuFolders::Resources, filename)); + std::optional ret(FileSystem::ReadFileToString(path.c_str())); + if (!ret.has_value()) + Console.Error("Failed to read resource file to string '%s'", filename); + return ret; +} + +std::optional Host::GetResourceFileTimestamp(const char* filename) +{ + const std::string path(Path::Combine(EmuFolders::Resources, filename)); + FILESYSTEM_STAT_DATA sd; + if (!FileSystem::StatFile(filename, &sd)) + return std::nullopt; + + return sd.ModificationTime; +} + +void Host::AddFormattedOSDMessage(float duration, const char* format, ...) +{ + +} +void Host::AddKeyedFormattedOSDMessage(std::string key, float duration, const char* format, ...) +{ + +} +void Host::RemoveKeyedOSDMessage(std::string key) +{ + +} +void Host::ClearOSDMessages() +{ + +} + +void Host::ReportErrorAsync(const std::string_view& title, const std::string_view& message) +{ + if (!title.empty() && !message.empty()) + { + Console.Error( + "ReportErrorAsync: %.*s: %.*s", static_cast(title.size()), title.data(), static_cast(message.size()), message.data()); + } + else if (!message.empty()) + { + Console.Error("ReportErrorAsync: %.*s", static_cast(message.size()), message.data()); + } +} + +bool Host::ConfirmMessage(const std::string_view& title, const std::string_view& message) +{ + return true; +} + +void Host::ResizeHostDisplay(u32 new_window_width, u32 new_window_height, float new_window_scale) +{ +} + +void Host::UpdateHostDisplay() +{ +} + +bool Host::AcquireHostDisplay(RenderAPI api, bool clear_state_on_fail) +{ + return true; +} + +HostDisplay::PresentResult Host::BeginPresentFrame(bool frame_skip) +{ + if (write_pos > (0x100 << 1)) + { + std::unique_lock locker(snd_mutex); + batch_cb(snd_buffer, write_pos >> 1); + write_pos = 0; + } + return g_host_display->BeginPresent(frame_skip); +} + +void Host::EndPresentFrame() +{ + g_host_display->EndPresent(); +} + +void Host::ReleaseHostDisplay(bool clear_state) +{ +} + +void Host::OnPerformanceMetricsUpdated() +{ +} + +void Host::OnVMPaused() +{ +} + +void Host::OnVMResumed() +{ +} + +void Host::RequestResizeHostDisplay(s32 width, s32 height) +{ +} + +void Host::OnVMStarting() +{ +} + +void Host::OnVMStarted() +{ +} + +void Host::OnVMDestroyed() +{ +} + +void Host::OnGameChanged(const std::string& disc_path, const std::string& elf_override, const std::string& game_serial, + const std::string& game_name, u32 game_crc) +{ +} + +void Host::OnSaveStateLoading(const std::string_view& filename) +{ +} + +void Host::OnSaveStateLoaded(const std::string_view& filename, bool was_successful) +{ +} + +void Host::OnSaveStateSaved(const std::string_view& filename) +{ +} + +void Host::CancelGameListRefresh() +{ +} + +void Host::CPUThreadVSync() +{ +} + +void Host::LoadSettings(SettingsInterface& si, std::unique_lock& lock) +{ + CommonHost::LoadSettings(si, lock); +} + +void Host::CheckForSettingsChanges(const Pcsx2Config& old_config) +{ + CommonHost::CheckForSettingsChanges(old_config); +} + +void Host::SetDefaultUISettings(SettingsInterface& si) +{ +} + +void Host::RequestVMShutdown(bool allow_confirm, bool allow_save_state, bool default_save_state) +{ + VMManager::SetState(VMState::Stopping); +} + + +void FullscreenUI::CheckForConfigChanges(const Pcsx2Config& old_config) +{ +} + +void CommonHost::Internal::ResetVMHotkeyState() +{ +} + +void FullscreenUI::OnVMStarted() +{ +} + +void FullscreenUI::OnVMDestroyed() +{ +} + +void FullscreenUI::OnRunningGameChanged(std::string path, std::string serial, std::string title, u32 crc) +{ +} + +bool FullscreenUI::IsInitialized() +{ + return true; +} + +std::optional Host::GetTopLevelWindowInfo() +{ + WindowInfo wi; + wi.surface_width = 640; + wi.surface_height = 480; + wi.surface_scale = 1.0f; + wi.type = WindowInfo::Type::Libretro; + + return wi; +} + diff --git a/libretro/options.cpp b/libretro/options.cpp new file mode 100644 index 00000000000000..3018e840f0e4ea --- /dev/null +++ b/libretro/options.cpp @@ -0,0 +1,44 @@ + +#include +#include "options.h" + +namespace Options +{ +static std::vector& GetOptionGroup(Groups group) +{ + /* this garentees that 'list' is constructed first before being accessed other global constructors.*/ + static std::vector list[OPTIONS_GROUPS_MAX]; + return list[group]; +} + +void OptionBase::Register(Groups group) +{ + GetOptionGroup(group).push_back(this); +} + +void SetVariables() +{ + std::vector vars; + for (int grp = 0; grp < OPTIONS_GROUPS_MAX; grp++) + for (OptionBase* option : GetOptionGroup((Groups)grp)) + if (!option->empty()) + vars.push_back(option->getVariable()); + + if (vars.empty()) + return; + + vars.push_back({}); + environ_cb(RETRO_ENVIRONMENT_SET_VARIABLES, (void*)vars.data()); +} + +void CheckVariables() +{ + bool updated = false; + if (environ_cb(RETRO_ENVIRONMENT_GET_VARIABLE_UPDATE, &updated) && !updated) + return; + + for (int grp = 0; grp < OPTIONS_GROUPS_MAX; grp++) + for (OptionBase* option : GetOptionGroup((Groups)grp)) + option->SetDirty(); +} +} // namespace Options diff --git a/libretro/options.h b/libretro/options.h new file mode 100644 index 00000000000000..ae68df4cd83127 --- /dev/null +++ b/libretro/options.h @@ -0,0 +1,203 @@ +#pragma once + +#include +#include +#include +#include + +extern retro_environment_t environ_cb; + +namespace Options +{ + +enum Groups +{ + OPTIONS_BASE, + OPTIONS_GFX, + OPTIONS_EMU, + OPTIONS_GROUPS_MAX +}; + +class OptionBase +{ +public: + void SetDirty() { m_dirty = true; } + retro_variable getVariable() { return {m_id, m_options.c_str()}; } + virtual bool empty() = 0; + +protected: + OptionBase(const char* id, const char* name, Groups group) + : m_id(id) + , m_name(name) + { + m_options = m_name; + m_options.push_back(';'); + Register(group); + } + + const char* m_id; + const char* m_name; + bool m_dirty = true; + std::string m_options; + +private: + void Register(Groups group); +}; + +template +class Option : public OptionBase +{ + static_assert(group < OPTIONS_GROUPS_MAX, "invalid option group index"); + Option(Option&) = delete; + Option(Option&&) = delete; + Option& operator=(Option&) = delete; + +public: + Option(const char* id, const char* name) + : OptionBase(id, name, group) + { + } + + Option(const char* id, const char* name, T initial) + : OptionBase(id, name, group) + { + push_back(initial ? "enabled" : "disabled", initial); + push_back(!initial ? "enabled" : "disabled", !initial); + } + + Option(const char* id, const char* name, std::initializer_list> list) + : OptionBase(id, name, group) + { + for (auto option : list) + push_back(option.first, option.second); + } + + Option(const char* id, const char* name, std::initializer_list list) + : OptionBase(id, name, group) + { + for (auto option : list) + push_back(option); + } + + Option(const char* id, const char* name, T first, std::initializer_list list) + : OptionBase(id, name, group) + { + for (auto option : list) + push_back(option, first + (int)m_list.size()); + } + + Option(const char* id, const char* name, T first, int count, int step = 1) + : OptionBase(id, name, group) + { + for (T i = first; i < first + count; i += step) + push_back(std::to_string(i), i); + } + + void push_back(std::string option, T value) + { + if (m_list.empty()) + { + m_options += std::string(" ") + option; + m_value = value; + } + else + m_options += std::string("|") + option; + + m_list.push_back({option, value}); + } + + template () && std::is_constructible()> + void push_back(const char* option) + { + push_back(option, option); + } +#if 0 + template <> + void push_back(const char* option) + { + if (m_list.empty()) + push_back(option, 0); + else + push_back(option, m_list.back().second + 1); + } +#endif + bool Updated() + { + if (m_dirty && !m_locked) + { + m_dirty = false; + + retro_variable var{m_id}; + T value = m_list.front().second; + + if (environ_cb && environ_cb(RETRO_ENVIRONMENT_GET_VARIABLE, &var) && var.value) + { + for (auto option : m_list) + { + if (option.first == var.value) + { + value = option.second; + break; + } + } + } + + if (m_value != value) + { + m_value = value; + return true; + } + } + + return false; + } + + void UpdateAndLock() + { + m_locked = false; + Updated(); + m_locked = true; + } + + operator T() + { + Updated(); + return m_value; + } + + T Get() + { + return (T) * this; + } + + template + bool operator==(S value) + { + return (T) * this == value; + } + + template + bool operator!=(S value) + { + return (T) * this != value; + } + + virtual bool empty() override { return m_list.empty(); } + +private: + bool m_locked = false; + T m_value; + std::vector> m_list; +}; + +template +using EmuOption = Option; +template +using GfxOption = Option; + +void SetVariables(); +void CheckVariables(); + +extern GfxOption upscale_multiplier; +extern GfxOption renderer; +} // namespace Options diff --git a/pcsx2/CDVD/CDVD.cpp b/pcsx2/CDVD/CDVD.cpp index f55e20e6edc99f..66365811d6387b 100644 --- a/pcsx2/CDVD/CDVD.cpp +++ b/pcsx2/CDVD/CDVD.cpp @@ -1431,6 +1431,7 @@ static uint cdvdStartSeek(uint newsector, CDVD_MODE_TYPE mode) void cdvdUpdateTrayState() { +//#ifndef __LIBRETRO__ if (cdvd.Tray.cdvdActionSeconds > 0) { if (--cdvd.Tray.cdvdActionSeconds == 0) @@ -1464,6 +1465,7 @@ void cdvdUpdateTrayState() } } } +//#endif } void cdvdVsync() diff --git a/pcsx2/CMakeLists.txt b/pcsx2/CMakeLists.txt index 22282b0dd271b0..0832e86a6e57d0 100644 --- a/pcsx2/CMakeLists.txt +++ b/pcsx2/CMakeLists.txt @@ -36,6 +36,10 @@ else() ) endif() +if(CCACHE_FOUND) + set(CommonFlags ${CommonFlags} -Werror=date-time) +endif() + if(GCC_VERSION VERSION_EQUAL "8.0" OR GCC_VERSION VERSION_GREATER "8.0") # gs is pretty bad at this target_compile_options(PCSX2_FLAGS INTERFACE -Wno-packed-not-aligned -Wno-class-memaccess) @@ -1067,6 +1071,44 @@ set(pcsx2x86Headers x86/R5900_Profiler.h ) +if(LIBRETRO) + set(pcsx2DEV9Sources) + set(pcsx2DEV9Headers) + set(pcsx2USBSources) + set(pcsx2USBHeaders) + set(pcsx2RecordingSources) + set(pcsx2RecordingVirtualPadResources) + set(pcsx2RecordingHeaders) + set(pcsx2ZipToolsSources) + set(pcsx2ZipToolsHeaders) + + LIST(REMOVE_ITEM pcsx2PADSources + PAD/Host/KeyStatus.cpp + ) + + LIST(REMOVE_ITEM pcsx2FrontendSources + Frontend/FullscreenUI.cpp + Frontend/ImGuiManager.cpp + Frontend/ImGuiOverlays.cpp + Frontend/CommonHotkeys.cpp + Frontend/InputManager.cpp + ) + LIST(REMOVE_ITEM pcsx2SPU2Sources + # SPU2/Debug.cpp + # SPU2/Wavedump_wav.cpp + + SPU2/SndOut.cpp + SPU2/SndOut_SDL.cpp + SPU2/SndOut_Portaudio.cpp + SPU2/Config.cpp + SPU2/ConfigSoundTouch.cpp + SPU2/Timestretcher.cpp + SPU2/wx/wxConfig.cpp + SPU2/Linux/Alsa.cpp + SPU2/Linux/Dialogs.cpp + ) +endif() + # These ones benefit a lot from LTO set(pcsx2LTOSources ${pcsx2Sources} @@ -1169,10 +1211,15 @@ target_link_libraries(PCSX2_FLAGS INTERFACE ) target_link_libraries(PCSX2_FLAGS INTERFACE - demangler simpleini ) +if(NOT LIBRETRO) + target_link_libraries(PCSX2_FLAGS INTERFACE + demangler + ) +endif() + if(WIN32) target_link_libraries(PCSX2_FLAGS INTERFACE WIL::WIL @@ -1205,6 +1252,15 @@ else() ) endif() +#if(LIBRETRO AND MSVC) +## include_directories(x86/ix86-32 IPU System) +## add_definitions(-D_ARCH_32=1 -D_M_X86_32) #32-bit +# add_definitions(-D_M_X86 -D__i386__ -DTIXML_USE_STL -D_SCL_SECURE_NO_WARNINGS) +# add_definitions(-D_ARCH_64=1 -D_M_X86_64 -D__M_X86_64) #64-bit +# target_link_libraries(PCSX2 PRIVATE baseclasses) +# target_link_libraries(PCSX2 PRIVATE comctl32 ws2_32 shlwapi winmm rpcrt4) +#endif() + # additonal include directories target_include_directories(PCSX2_FLAGS INTERFACE . @@ -1216,7 +1272,7 @@ target_include_directories(PCSX2_FLAGS INTERFACE "${FFMPEG_INCLUDE_DIRS}" ) -if(COMMAND target_precompile_headers) +if(COMMAND target_precompile_headers AND NOT CCACHE_FOUND) message("Using precompiled headers.") target_precompile_headers(PCSX2_FLAGS INTERFACE PrecompiledHeader.h) endif() diff --git a/pcsx2/Config.h b/pcsx2/Config.h index 8893e459c36e2e..8e2b65880c2b94 100644 --- a/pcsx2/Config.h +++ b/pcsx2/Config.h @@ -15,6 +15,7 @@ #pragma once +#include "PrecompiledHeader.h" #include "common/emitter/tools.h" #include "common/General.h" #include @@ -1273,7 +1274,9 @@ struct Pcsx2Config FramerateOptions Framerate; SPU2Options SPU2; DEV9Options DEV9; +#ifndef __LIBRETRO__ USBOptions USB; +#endif TraceLogFilters Trace; diff --git a/pcsx2/Frontend/CommonHotkeys.cpp b/pcsx2/Frontend/CommonHotkeys.cpp index 043437847cdba4..d347161a0a741c 100644 --- a/pcsx2/Frontend/CommonHotkeys.cpp +++ b/pcsx2/Frontend/CommonHotkeys.cpp @@ -43,7 +43,11 @@ void CommonHost::Internal::ResetVMHotkeyState() static void HotkeyAdjustTargetSpeed(double delta) { +#ifdef ENABLE_ACHIEVEMENTS const double min_speed = Achievements::ChallengeModeActive() ? 1.0 : 0.1; +#else + const double min_speed = 1.0; +#endif EmuConfig.Framerate.NominalScalar = std::max(min_speed, EmuConfig.GS.LimitScalar + delta); VMManager::SetLimiterMode(LimiterModeType::Nominal); Host::AddIconOSDMessage("SpeedChanged", ICON_FA_CLOCK, diff --git a/pcsx2/Frontend/FullscreenUI.cpp b/pcsx2/Frontend/FullscreenUI.cpp index f894b402133005..56930712a80406 100644 --- a/pcsx2/Frontend/FullscreenUI.cpp +++ b/pcsx2/Frontend/FullscreenUI.cpp @@ -6947,22 +6947,12 @@ void FullscreenUI::DrawAchievementsLoginWindow() #else -bool FullscreenUI::OpenAchievementsWindow() -{ - return false; -} - -bool FullscreenUI::OpenLeaderboardsWindow() +void FullscreenUI::OpenAchievementsWindow() { - return false; } -void FullscreenUI::DrawAchievementsSettingsPage() +void FullscreenUI::OpenLeaderboardsWindow() { - BeginMenuButtons(); - ActiveButton(ICON_FA_BAN " This build was not compiled with RetroAchievements support.", false, false, - ImGuiFullscreen::LAYOUT_MENU_BUTTON_HEIGHT_NO_SUMMARY); - EndMenuButtons(); } void FullscreenUI::DrawAchievementsLoginWindow() diff --git a/pcsx2/Frontend/GameList.cpp b/pcsx2/Frontend/GameList.cpp index 5ee3ecf28d2dca..faf19250e3262d 100644 --- a/pcsx2/Frontend/GameList.cpp +++ b/pcsx2/Frontend/GameList.cpp @@ -1170,6 +1170,7 @@ std::string GameList::GetNewCoverImagePathForEntry(const Entry* entry, const cha bool GameList::DownloadCovers(const std::vector& url_templates, bool use_serial, ProgressCallback* progress, std::function save_callback) { +#ifndef __LIBRETRO__ if (!progress) progress = ProgressCallback::NullProgressCallback; @@ -1290,5 +1291,6 @@ bool GameList::DownloadCovers(const std::vector& url_templates, boo progress->IncrementProgressValue(); } +#endif return true; } diff --git a/pcsx2/Frontend/LogSink.cpp b/pcsx2/Frontend/LogSink.cpp index dec8b66c4dc968..ad7fa77bbfe9b4 100644 --- a/pcsx2/Frontend/LogSink.cpp +++ b/pcsx2/Frontend/LogSink.cpp @@ -412,8 +412,9 @@ void CommonHost::UpdateLogging(SettingsInterface& si) // Input Recording Logs SysConsole.recordingConsole.Enabled = any_logging_sinks && si.GetBoolValue("Logging", "EnableInputRecordingLogs", true); SysConsole.controlInfo.Enabled = any_logging_sinks && si.GetBoolValue("Logging", "EnableControllerLogs", false); - +#ifndef __LIBRETRO__ UpdateLoggingSinks(system_console_enabled, file_logging_enabled); +#endif } void CommonHost::SetDefaultLoggingSettings(SettingsInterface& si) diff --git a/pcsx2/Frontend/OpenGLHostDisplay.cpp b/pcsx2/Frontend/OpenGLHostDisplay.cpp index 4ce0a8c15b947f..b1ac2cfeb0ff8e 100644 --- a/pcsx2/Frontend/OpenGLHostDisplay.cpp +++ b/pcsx2/Frontend/OpenGLHostDisplay.cpp @@ -14,7 +14,7 @@ */ #include "PrecompiledHeader.h" - +#include "GS/GS.h" #include "OpenGLHostDisplay.h" #include "common/Assertions.h" #include "common/Console.h" @@ -137,7 +137,7 @@ void OpenGLHostDisplay::SetVSync(VsyncMode mode) // Window framebuffer has to be bound to call SetSwapInterval. GLint current_fbo = 0; glGetIntegerv(GL_DRAW_FRAMEBUFFER_BINDING, ¤t_fbo); - glBindFramebuffer(GL_DRAW_FRAMEBUFFER, 0); + glBindFramebuffer(GL_DRAW_FRAMEBUFFER, GL_DEFAULT_FRAMEBUFFER); if (mode != VsyncMode::Adaptive || !m_gl_context->SetSwapInterval(-1)) m_gl_context->SetSwapInterval(static_cast(mode != VsyncMode::Off)); @@ -341,7 +341,7 @@ HostDisplay::PresentResult OpenGLHostDisplay::BeginPresent(bool frame_skip) return PresentResult::FrameSkipped; glDisable(GL_SCISSOR_TEST); - glBindFramebuffer(GL_DRAW_FRAMEBUFFER, 0); + glBindFramebuffer(GL_DRAW_FRAMEBUFFER, GL_DEFAULT_FRAMEBUFFER); glColorMask(GL_TRUE, GL_TRUE, GL_TRUE, GL_TRUE); glClearColor(0.0f, 0.0f, 0.0f, 1.0f); glClear(GL_COLOR_BUFFER_BIT); @@ -354,9 +354,10 @@ void OpenGLHostDisplay::EndPresent() { glDisable(GL_SCISSOR_TEST); glDisable(GL_STENCIL_TEST); - +#ifndef __LIBRETRO__ ImGui::Render(); ImGui_ImplOpenGL3_RenderDrawData(ImGui::GetDrawData()); +#endif GL::Program::ResetLastProgram(); if (m_gpu_timing_enabled) diff --git a/pcsx2/GS.cpp b/pcsx2/GS.cpp index 8b869ecdcdadfd..233fd708b69720 100644 --- a/pcsx2/GS.cpp +++ b/pcsx2/GS.cpp @@ -45,6 +45,7 @@ void gsReset() void gsUpdateFrequency(Pcsx2Config& config) { +#ifndef __LIBRETRO__ if (config.GS.FrameLimitEnable) { switch (config.LimiterMode) @@ -66,6 +67,7 @@ void gsUpdateFrequency(Pcsx2Config& config) } } else +#endif { config.GS.LimitScalar = 0.0f; } diff --git a/pcsx2/GS.h b/pcsx2/GS.h index 1636c22c2f564a..f30efba04d4e21 100644 --- a/pcsx2/GS.h +++ b/pcsx2/GS.h @@ -362,7 +362,11 @@ class SysMtgsThread std::mutex m_lock_Stack; #endif +#ifdef __LIBRETRO__ + std::thread::id m_thread; +#else std::thread m_thread; +#endif Threading::ThreadHandle m_thread_handle; std::atomic_bool m_open_flag{false}; std::atomic_bool m_shutdown_flag{false}; @@ -407,6 +411,13 @@ class SysMtgsThread void PostVsyncStart(bool registers_written); void InitAndReadFIFO(u8* mem, u32 qwc); +#ifdef __LIBRETRO__ + void StepFrame(); + void Flush(); + void SignalVsync(); + void MainLoop(bool flush_all = false); +#endif + void RunOnGSThread(AsyncCallType func); void ApplySettings(); void ResizeDisplayWindow(int width, int height, float scale); @@ -420,10 +431,10 @@ class SysMtgsThread u32* width, u32* height, std::vector* pixels); void SetRunIdle(bool enabled); -protected: bool TryOpenGS(); void CloseGS(); +protected: void ThreadEntryPoint(); void MainLoop(); diff --git a/pcsx2/GS/GS.cpp b/pcsx2/GS/GS.cpp index cdf4ed4d9b87e6..1e11303dbc655d 100644 --- a/pcsx2/GS/GS.cpp +++ b/pcsx2/GS/GS.cpp @@ -65,6 +65,17 @@ static HRESULT s_hr = E_FAIL; #endif +#ifdef __LIBRETRO__ +//#include "Window/GSWndRetro.h" +#include "options.h" +namespace Options { +GfxOption upscale_multiplier("pcsx2_upscale_multiplier", "Internal Resolution", + {{"Native PS2", 1}, {"2x Native ~720p", 2}, {"3x Native ~1080p", 3},{"4x Native ~1440p 2K", 4}, + {"5x Native ~1620p 3K", 5}, {"6x Native ~2160p 4K", 6}, {"8x Native ~2880p 5K", 8}}); +static GfxOption sw_renderer_threads("pcsx2_sw_renderer_threads", "Software Renderer Threads", 2, 10); +} +#endif + #include // do NOT undefine this/put it above includes, as x11 people love to redefine diff --git a/pcsx2/GS/GS.h b/pcsx2/GS/GS.h index a58850d3cde1a6..9b7de62e8d6b40 100644 --- a/pcsx2/GS/GS.h +++ b/pcsx2/GS/GS.h @@ -100,3 +100,12 @@ struct GSError struct GSRecoverableError : GSError { }; + +#ifdef __LIBRETRO__ +#include +#include "options.h" +extern retro_hw_render_callback hw_render; +#define GL_DEFAULT_FRAMEBUFFER hw_render.get_current_framebuffer() +#else +#define GL_DEFAULT_FRAMEBUFFER 0 +#endif diff --git a/pcsx2/GS/Renderers/Common/GSFastList.h b/pcsx2/GS/Renderers/Common/GSFastList.h index 2c0797f86432e4..3b61088ae51c36 100644 --- a/pcsx2/GS/Renderers/Common/GSFastList.h +++ b/pcsx2/GS/Renderers/Common/GSFastList.h @@ -15,6 +15,7 @@ #pragma once +#include #include "common/AlignedMalloc.h" template diff --git a/pcsx2/GS/Renderers/Common/GSRenderer.cpp b/pcsx2/GS/Renderers/Common/GSRenderer.cpp index 51d21dc10d7d46..3b3d968868c8ca 100644 --- a/pcsx2/GS/Renderers/Common/GSRenderer.cpp +++ b/pcsx2/GS/Renderers/Common/GSRenderer.cpp @@ -528,10 +528,15 @@ void GSRenderer::VSync(u32 field, bool registers_written) if (current && !blank_frame) { src_rect = CalculateDrawSrcRect(current); +#ifdef __LIBRETRO__ + src_uv = GSVector4(0, 0, 1, 1); + draw_rect = GSVector4(0, 0, current->GetWidth(), current->GetHeight()); +#else src_uv = GSVector4(src_rect) / GSVector4(current->GetSize()).xyxy(); draw_rect = CalculateDrawDstRect(g_host_display->GetWindowWidth(), g_host_display->GetWindowHeight(), src_rect, current->GetSize(), g_host_display->GetDisplayAlignment(), g_host_display->UsesLowerLeftOrigin(), GetVideoMode() == GSVideoMode::SDTV_480P || (GSConfig.PCRTCOverscan && GSConfig.PCRTCOffsets)); +#endif s_last_draw_rect = draw_rect; if (GSConfig.CASMode != GSCASMode::Disabled) diff --git a/pcsx2/GS/Renderers/Common/GSTexture.cpp b/pcsx2/GS/Renderers/Common/GSTexture.cpp index 15a5fdd3df3282..0e890aea834e45 100644 --- a/pcsx2/GS/Renderers/Common/GSTexture.cpp +++ b/pcsx2/GS/Renderers/Common/GSTexture.cpp @@ -36,6 +36,9 @@ GSTexture::GSTexture() bool GSTexture::Save(const std::string& fn) { +#ifdef __LIBRETRO__ + return true; +#else #ifdef PCSX2_DEVBUILD GSPng::Format format = GSPng::RGB_A_PNG; #else @@ -63,6 +66,7 @@ bool GSTexture::Save(const std::string& fn) const int compression = GSConfig.PNGCompressionLevel; return GSPng::Save(format, fn, dl->GetMapPointer(), m_size.x, m_size.y, dl->GetMapPitch(), compression, g_gs_device->IsRBSwapped()); +#endif } void GSTexture::Swap(GSTexture* tex) diff --git a/pcsx2/GS/Renderers/DX11/GSDevice11.cpp b/pcsx2/GS/Renderers/DX11/GSDevice11.cpp index b17e6b0737ab1d..bb457ccf1d4b54 100644 --- a/pcsx2/GS/Renderers/DX11/GSDevice11.cpp +++ b/pcsx2/GS/Renderers/DX11/GSDevice11.cpp @@ -81,6 +81,22 @@ bool GSDevice11::Create() D3D11_RASTERIZER_DESC rd; D3D11_BLEND_DESC bsd; +#ifdef __LIBRETRO__ + retro_hw_render_interface_d3d11 *d3d11 = nullptr; + if (!environ_cb(RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE, (void **)&d3d11) || !d3d11) { + printf("Failed to get HW rendering interface!\n"); + return false; + } + + if (d3d11->interface_version != RETRO_HW_RENDER_INTERFACE_D3D11_VERSION) { + printf("HW render interface mismatch, expected %u, got %u!\n", RETRO_HW_RENDER_INTERFACE_D3D11_VERSION, d3d11->interface_version); + return false; + } + + m_dev = d3d11->device; + m_ctx = d3d11->context; + D3D_FEATURE_LEVEL level = d3d11->featureLevel; +#else D3D_FEATURE_LEVEL level; if (g_host_display->GetRenderAPI() != RenderAPI::D3D11) @@ -109,6 +125,8 @@ bool GSDevice11::Create() Console.WriteLn("Not using shader cache."); } +#endif + // Set maximum texture size limit based on supported feature level. if (support_feature_level_11_0) m_d3d_texsize = D3D11_REQ_TEXTURE2D_U_OR_V_DIMENSION; @@ -386,10 +404,81 @@ void GSDevice11::SetFeatures() void GSDevice11::ResetAPIState() { +#ifdef __LIBRETRO__ // needs to be moved somewhere else + D3D11_TEXTURE2D_DESC desc{}; + desc.Width = w; + desc.Height = h; + desc.MipLevels = 1; + desc.ArraySize = 1; + desc.Format = DXGI_FORMAT_R8G8B8A8_UNORM; + desc.SampleDesc.Count = 1; + desc.SampleDesc.Quality = 0; + desc.Usage = D3D11_USAGE_DEFAULT; + desc.BindFlags = D3D11_BIND_RENDER_TARGET | D3D11_BIND_SHADER_RESOURCE; + desc.CPUAccessFlags = 0; + desc.MiscFlags = 0; + + D3D11_SUBRESOURCE_DATA srsc = {}; + srsc.pSysMem = malloc(w*h*4); + srsc.SysMemPitch = w * 4; + srsc.SysMemSlicePitch = w * h * 4; + memset((void*)srsc.pSysMem, 0xFF, w*h*3); + + + CComPtr texture; + if (FAILED(m_dev->CreateTexture2D(&desc, nullptr, &texture))) + return false; + free((void*)srsc.pSysMem); + + m_backbuffer = new GSTexture11(texture); +#endif // Clear out the GS, since the imgui draw doesn't get rid of it. m_ctx->GSSetShader(nullptr, nullptr, 0); } +#ifdef __LIBRETRO__ +void GSDevice11::Flip() // needs to be in void D3D11HostDisplay::EndPresent() +{ +// if(!m_current) +// return; + + ID3D11RenderTargetView *nullView = nullptr; + m_ctx->OMSetRenderTargets(1, &nullView, nullptr); + + ID3D11ShaderResourceView* srv = *(GSTexture11*)m_backbuffer; + m_ctx->PSSetShaderResources(0, 1, &srv); + + extern retro_video_refresh_t video_cb; + video_cb(RETRO_HW_FRAME_BUFFER_VALID, m_backbuffer->GetWidth(), m_backbuffer->GetHeight(), 0); + + /* restore State */ + uint32 stride = m_state.vb_stride; + uint32 offset = 0; + m_ctx->IASetVertexBuffers(0, 1, &m_state.vb, &stride, &offset); + m_ctx->IASetIndexBuffer(m_state.ib, DXGI_FORMAT_R32_UINT, 0); + m_ctx->IASetInputLayout(m_state.layout); + m_ctx->IASetPrimitiveTopology(m_state.topology); + m_ctx->VSSetShader(m_state.vs, NULL, 0); + m_ctx->VSSetConstantBuffers(0, 1, &m_state.vs_cb); + m_ctx->GSSetShader(m_state.gs, NULL, 0); + m_ctx->GSSetConstantBuffers(0, 1, &m_state.gs_cb); + m_ctx->PSSetShader(m_state.ps, NULL, 0); + m_ctx->PSSetConstantBuffers(0, 1, &m_state.ps_cb); + m_ctx->PSSetShaderResources(0, m_state.ps_sr_views.size(), m_state.ps_sr_views.data()); + m_ctx->PSSetSamplers(0, countof(m_state.ps_ss), m_state.ps_ss); + m_ctx->OMSetDepthStencilState(m_state.dss, m_state.sref); + float BlendFactor[] = {m_state.bf, m_state.bf, m_state.bf, 0}; + m_ctx->OMSetBlendState(m_state.bs, BlendFactor, 0xffffffff); +#if 0 + m_ctx->OMSetRenderTargets(1, &m_state.rt_view, m_state.dsv); + D3D11_VIEWPORT vp = {m_hack_topleft_offset, m_hack_topleft_offset, + (float)m_state.viewport.x, (float)m_state.viewport.y, 0.0f, 1.0f}; + m_ctx->RSSetViewports(1, &vp); + m_ctx->RSSetScissorRects(1, m_state.scissor); +#endif +} +#endif + void GSDevice11::RestoreAPIState() { const UINT vb_offset = 0; diff --git a/pcsx2/GS/Renderers/DX11/GSDevice11.h b/pcsx2/GS/Renderers/DX11/GSDevice11.h index 7fde04dfcf9e3a..e9ac8987e7d70d 100644 --- a/pcsx2/GS/Renderers/DX11/GSDevice11.h +++ b/pcsx2/GS/Renderers/DX11/GSDevice11.h @@ -24,6 +24,11 @@ #include #include +#ifdef __LIBRETRO__ +#include "libretro_d3d.h" +extern retro_environment_t environ_cb; +#endif + struct GSVertexShader11 { wil::com_ptr_nothrow vs; @@ -137,7 +142,9 @@ class GSDevice11 final : public GSDevice wil::com_ptr_nothrow m_dev; wil::com_ptr_nothrow m_ctx; wil::com_ptr_nothrow m_annotation; +#ifndef __LIBRETRO__ wil::com_ptr_nothrow m_swapchain; +#endif wil::com_ptr_nothrow m_vb; wil::com_ptr_nothrow m_ib; u32 m_vb_pos = 0; // bytes diff --git a/pcsx2/GS/Renderers/DX11/GSTexture11.cpp b/pcsx2/GS/Renderers/DX11/GSTexture11.cpp index b25e285134bf3f..7616eb0539476a 100644 --- a/pcsx2/GS/Renderers/DX11/GSTexture11.cpp +++ b/pcsx2/GS/Renderers/DX11/GSTexture11.cpp @@ -117,6 +117,9 @@ void GSTexture11::Unmap() bool GSTexture11::Save(const std::string& fn) { +#ifdef __LIBRETRO__ + return true; +#else D3D11_TEXTURE2D_DESC desc = m_desc; desc.Usage = D3D11_USAGE_STAGING; desc.BindFlags = 0; @@ -208,6 +211,7 @@ bool GSTexture11::Save(const std::string& fn) GSDevice11::GetInstance()->GetD3DContext()->Unmap(res.get(), 0); return success; +#endif } void GSTexture11::GenerateMipmap() diff --git a/pcsx2/GS/Renderers/OpenGL/GSDeviceOGL.cpp b/pcsx2/GS/Renderers/OpenGL/GSDeviceOGL.cpp index 32cc6fabdfde3a..abd938dce579cf 100644 --- a/pcsx2/GS/Renderers/OpenGL/GSDeviceOGL.cpp +++ b/pcsx2/GS/Renderers/OpenGL/GSDeviceOGL.cpp @@ -204,7 +204,7 @@ bool GSDeviceOGL::Create() // Always read from the first buffer glBindFramebuffer(GL_READ_FRAMEBUFFER, m_fbo_read); glReadBuffer(GL_COLOR_ATTACHMENT0); - glBindFramebuffer(GL_READ_FRAMEBUFFER, 0); + glBindFramebuffer(GL_READ_FRAMEBUFFER, GL_DEFAULT_FRAMEBUFFER); } // **************************************************************** @@ -584,7 +584,10 @@ void GSDeviceOGL::RestoreAPIState() { glBindVertexArray(m_vertex_array_object); - glBindFramebuffer(GL_DRAW_FRAMEBUFFER, GLState::fbo); + if(GLState::fbo) + glBindFramebuffer(GL_DRAW_FRAMEBUFFER, GLState::fbo); + else + glBindFramebuffer(GL_DRAW_FRAMEBUFFER, GL_DEFAULT_FRAMEBUFFER); glViewportIndexedf(0, 0, 0, static_cast(GLState::viewport.x), static_cast(GLState::viewport.y)); glScissorIndexed(0, GLState::scissor.x, GLState::scissor.y, GLState::scissor.width(), GLState::scissor.height()); @@ -1142,8 +1145,15 @@ void GSDeviceOGL::CopyRect(GSTexture* sTex, GSTexture* dTex, const GSVector4i& r } else { - glBindFramebuffer(GL_READ_FRAMEBUFFER, m_fbo_read); - glBindFramebuffer(GL_DRAW_FRAMEBUFFER, m_fbo_write); + if(m_fbo_read) + glBindFramebuffer(GL_READ_FRAMEBUFFER, m_fbo_read); + else + glBindFramebuffer(GL_READ_FRAMEBUFFER, GL_DEFAULT_FRAMEBUFFER); + if(m_fbo_write) + glBindFramebuffer(GL_DRAW_FRAMEBUFFER, m_fbo_write); + else + glBindFramebuffer(GL_DRAW_FRAMEBUFFER, GL_DEFAULT_FRAMEBUFFER); + glFramebufferTexture2D(GL_READ_FRAMEBUFFER, GL_COLOR_ATTACHMENT0, GL_TEXTURE_2D, sid, 0); glFramebufferTexture2D(GL_DRAW_FRAMEBUFFER, GL_COLOR_ATTACHMENT0, GL_TEXTURE_2D, did, 0); @@ -1152,8 +1162,12 @@ void GSDeviceOGL::CopyRect(GSTexture* sTex, GSTexture* dTex, const GSVector4i& r glBlitFramebuffer(r.x, r.y, r.x + w, r.y + h, destX + r.x, destY + r.y, destX + r.x + w, destY + r.y + h, GL_COLOR_BUFFER_BIT, GL_NEAREST); glEnable(GL_SCISSOR_TEST); - glBindFramebuffer(GL_DRAW_FRAMEBUFFER, GLState::fbo); - glBindFramebuffer(GL_READ_FRAMEBUFFER, 0); + if(GLState::fbo) + glBindFramebuffer(GL_DRAW_FRAMEBUFFER, GLState::fbo); + else + glBindFramebuffer(GL_DRAW_FRAMEBUFFER, GL_DEFAULT_FRAMEBUFFER); + + glBindFramebuffer(GL_READ_FRAMEBUFFER, GL_DEFAULT_FRAMEBUFFER); } } @@ -1717,7 +1731,10 @@ void GSDeviceOGL::OMSetFBO(GLuint fbo) if (GLState::fbo != fbo) { GLState::fbo = fbo; - glBindFramebuffer(GL_DRAW_FRAMEBUFFER, fbo); + if(fbo) + glBindFramebuffer(GL_DRAW_FRAMEBUFFER, fbo); + else + glBindFramebuffer(GL_DRAW_FRAMEBUFFER, GL_DEFAULT_FRAMEBUFFER); } } diff --git a/pcsx2/GS/Renderers/OpenGL/GSTextureOGL.cpp b/pcsx2/GS/Renderers/OpenGL/GSTextureOGL.cpp index 20b35f8d654a5a..6459b4b8c738c1 100644 --- a/pcsx2/GS/Renderers/OpenGL/GSTextureOGL.cpp +++ b/pcsx2/GS/Renderers/OpenGL/GSTextureOGL.cpp @@ -350,6 +350,9 @@ void GSTextureOGL::GenerateMipmap() bool GSTextureOGL::Save(const std::string& fn) { +#ifdef __LIBRETRO__ + return true; +#else // Collect the texture data u32 pitch = 4 * m_size.x; u32 buf_size = pitch * m_size.y * 2; // Note *2 for security (depth/stencil) @@ -367,7 +370,7 @@ bool GSTextureOGL::Save(const std::string& fn) glFramebufferTexture2D(GL_READ_FRAMEBUFFER, GL_DEPTH_ATTACHMENT, GL_TEXTURE_2D, m_texture_id, 0); glReadPixels(0, 0, m_size.x, m_size.y, GL_DEPTH_COMPONENT, GL_UNSIGNED_INT, image.get()); - glBindFramebuffer(GL_READ_FRAMEBUFFER, 0); + glBindFramebuffer(GL_READ_FRAMEBUFFER, GL_DEFAULT_FRAMEBUFFER); fmt = GSPng::RGB_A_PNG; } @@ -399,10 +402,11 @@ bool GSTextureOGL::Save(const std::string& fn) glReadPixels(0, 0, m_size.x, m_size.y, GL_RED, GL_UNSIGNED_BYTE, image.get()); } - glBindFramebuffer(GL_READ_FRAMEBUFFER, 0); + glBindFramebuffer(GL_READ_FRAMEBUFFER, GL_DEFAULT_FRAMEBUFFER); } return GSPng::Save(fmt, fn, image.get(), m_size.x, m_size.y, pitch, GSConfig.PNGCompressionLevel); +#endif } void GSTextureOGL::Swap(GSTexture* tex) diff --git a/pcsx2/GS/Renderers/SW/GSTextureSW.cpp b/pcsx2/GS/Renderers/SW/GSTextureSW.cpp index 3190e86a092d5a..854de10c474055 100644 --- a/pcsx2/GS/Renderers/SW/GSTextureSW.cpp +++ b/pcsx2/GS/Renderers/SW/GSTextureSW.cpp @@ -86,6 +86,9 @@ void GSTextureSW::Unmap() bool GSTextureSW::Save(const std::string& fn) { +#ifdef __LIBRETRO__ + return true; +#else #ifdef PCSX2_DEVBUILD GSPng::Format fmt = GSPng::RGB_A_PNG; #else @@ -93,6 +96,7 @@ bool GSTextureSW::Save(const std::string& fn) #endif int compression = GSConfig.PNGCompressionLevel; return GSPng::Save(fmt, fn, static_cast(m_data), m_size.x, m_size.y, m_pitch, compression); +#endif } void GSTextureSW::Swap(GSTexture* tex) diff --git a/pcsx2/GSDumpReplayer.cpp b/pcsx2/GSDumpReplayer.cpp index faa36677596130..96dbcbc68ac7e9 100644 --- a/pcsx2/GSDumpReplayer.cpp +++ b/pcsx2/GSDumpReplayer.cpp @@ -368,6 +368,7 @@ void GSDumpReplayerCpuClear(u32 addr, u32 size) void GSDumpReplayer::RenderUI() { +#ifndef __LIBRETRO__ const float scale = ImGuiManager::GetGlobalScale(); const float shadow_offset = std::ceil(1.0f * scale); const float margin = std::ceil(10.0f * scale); @@ -397,4 +398,5 @@ void GSDumpReplayer::RenderUI() DRAW_LINE(font, text.c_str(), IM_COL32(255, 255, 255, 255)); #undef DRAW_LINE +#endif } diff --git a/pcsx2/MTGS.cpp b/pcsx2/MTGS.cpp index b72422885152ab..bce669efef0760 100644 --- a/pcsx2/MTGS.cpp +++ b/pcsx2/MTGS.cpp @@ -82,18 +82,30 @@ SysMtgsThread::~SysMtgsThread() void SysMtgsThread::StartThread() { +#ifdef __LIBRETRO__ + if (m_thread != std::thread::id({})) +#else if (m_thread.joinable()) +#endif return; pxAssertRel(!m_open_flag.load(), "GS thread should not be opened when starting"); m_sem_event.Reset(); m_shutdown_flag.store(false, std::memory_order_release); +#ifdef __LIBRETRO__ + GSinit(); +#else m_thread = std::thread(&SysMtgsThread::ThreadEntryPoint, this); +#endif } void SysMtgsThread::ShutdownThread() { +#ifdef __LIBRETRO__ + if (m_thread == std::thread::id({})) +#else if (!m_thread.joinable()) +#endif return; // just go straight to shutdown, don't wait-for-open again @@ -103,7 +115,11 @@ void SysMtgsThread::ShutdownThread() // make sure the thread actually exits m_sem_event.NotifyOfWork(); +#ifdef __LIBRETRO__ + m_thread = {}; +#else m_thread.join(); +#endif } void SysMtgsThread::ThreadEntryPoint() @@ -147,10 +163,10 @@ void SysMtgsThread::ThreadEntryPoint() // wait until we're asked to try again... continue; } - +#ifndef __LIBRETRO__ // we're ready to go MainLoop(); - +#endif // when we come back here, it's because we closed (or shutdown) // that means the emu thread should be blocked, waiting for us to be done pxAssertRel(!m_open_flag.load(std::memory_order_relaxed), "Open flag is clear on close"); @@ -271,16 +287,32 @@ union PacketTagType bool SysMtgsThread::TryOpenGS() { +#ifdef __LIBRETRO__ + if(IsOpen()) + return true; + + m_thread = std::this_thread::get_id(); +#endif + std::memcpy(RingBuffer.Regs, PS2MEM_GS, sizeof(PS2MEM_GS)); if (!GSopen(EmuConfig.GS, EmuConfig.GS.Renderer, RingBuffer.Regs)) return false; GSsetGameCRC(ElfCRC); +#ifdef __LIBRETRO__ + m_open_flag.store(true, std::memory_order_release); + // notify emu thread that we finished opening (or failed) + m_open_or_close_done.Post(); +#endif return true; } +#ifdef __LIBRETRO__ +void SysMtgsThread::MainLoop(bool flush_all) +#else void SysMtgsThread::MainLoop() +#endif { // Threading info: run in MTGS thread // m_ReadPos is only update by the MTGS thread so it is safe to load it with a relaxed atomic @@ -469,7 +501,10 @@ void SysMtgsThread::MainLoop() ((GSRegSIGBLID&)RingBuffer.Regs[0x1080]) = (GSRegSIGBLID&)remainder[2]; // CSR & 0x2000; is the pageflip id. - GSvsync((((u32&)RingBuffer.Regs[0x1000]) & 0x2000) ? 0 : 1, remainder[4] != 0); +#ifdef __LIBRETRO__ + if(!flush_all) +#endif + GSvsync((((u32&)RingBuffer.Regs[0x1000]) & 0x2000) ? 0 : 1, remainder[4] != 0); m_QueuedFrameCount.fetch_sub(1); if (m_VsyncSignalListener.exchange(false)) @@ -550,9 +585,24 @@ void SysMtgsThread::MainLoop() // Make sure to post the signal after the m_ReadPos has been updated... m_SignalRingEnable.store(false, std::memory_order_release); m_sem_OnRingReset.Post(); +#ifndef __LIBRETRO__ continue; +#endif } } +#ifdef __LIBRETRO__ + if(!flush_all && tag.command == GS_RINGTYPE_VSYNC) { + mtvu_lock.unlock(); + return; + } + if(flush_all && + !gifUnit.gifPath[GIF_PATH_1].getReadAmount() && + !gifUnit.gifPath[GIF_PATH_2].getReadAmount() && + !gifUnit.gifPath[GIF_PATH_3].getReadAmount()){ + mtvu_lock.unlock(); + return; + } +#endif } // TODO: With the new race-free WorkSema do we still need these? @@ -578,10 +628,52 @@ void SysMtgsThread::MainLoop() m_ReadPos.store(m_WritePos.load(std::memory_order_acquire), std::memory_order_relaxed); m_sem_event.Kill(); } +#ifdef __LIBRETRO__ +void SysMtgsThread::StepFrame() +{ + pxAssert(std::this_thread::get_id() == m_thread); + MainLoop(false); +} +void SysMtgsThread::Flush() +{ + if (m_VsyncSignalListener.exchange(false)) + m_sem_Vsync.Post(); + + pxAssert(std::this_thread::get_id() == m_thread); + if(!gifUnit.gifPath[GIF_PATH_1].getReadAmount() && + !gifUnit.gifPath[GIF_PATH_2].getReadAmount() && + !gifUnit.gifPath[GIF_PATH_3].getReadAmount()) + return; + + SetEvent(); + MainLoop(true); +} + +void SysMtgsThread::SignalVsync() +{ + if (m_VsyncSignalListener.exchange(false)) + m_sem_Vsync.Post(); +} + +#endif void SysMtgsThread::CloseGS() { +#ifdef __LIBRETRO__ + if( m_SignalRingEnable.exchange(false) ) + { + //Console.Warning( "(MTGS Thread) Dangling RingSignal on empty buffer! signalpos=0x%06x", m_SignalRingPosition.exchange(0) ) ); + m_SignalRingPosition.store(0, std::memory_order_release); + m_sem_OnRingReset.Post(); + } + if (m_VsyncSignalListener.exchange(false)) + m_sem_Vsync.Post(); +#endif GSclose(); +#ifdef __LIBRETRO__ + m_open_flag.store(false, std::memory_order_release); + m_open_or_close_done.Post(); +#endif } // Waits for the GS to empty out the entire ring buffer contents. @@ -590,7 +682,15 @@ void SysMtgsThread::CloseGS() // If isMTVU, then this implies this function is being called from the MTVU thread... void SysMtgsThread::WaitGS(bool syncRegs, bool weakWait, bool isMTVU) { +#ifdef __LIBRETRO__ + if(std::this_thread::get_id() == m_thread) + { + GetMTGS().Flush(); + return; + } +#else pxAssertDev(std::this_thread::get_id() != m_thread.get_id(), "This method is only allowed from threads *not* named MTGS."); +#endif if (!pxAssertDev(IsOpen(), "MTGS Warning! WaitGS issued on a closed thread.")) return; @@ -862,9 +962,10 @@ bool SysMtgsThread::WaitForOpen() return true; StartThread(); - +#ifndef __LIBRETRO__ // request open, and kick the thread. m_open_flag.store(true, std::memory_order_release); +#endif m_sem_event.NotifyOfWork(); // wait for it to finish its stuff @@ -882,21 +983,25 @@ void SysMtgsThread::WaitForClose() { if (!IsOpen()) return; - +#ifndef __LIBRETRO__ // ask the thread to stop processing work, by clearing the open flag m_open_flag.store(false, std::memory_order_release); - +#endif // and kick the thread if it's sleeping m_sem_event.NotifyOfWork(); // and wait for it to finish up.. m_open_or_close_done.Wait(); + + m_thread = {}; } void SysMtgsThread::Freeze(FreezeAction mode, MTGS_FreezeData& data) { pxAssertRel(IsOpen(), "GS thread is open"); +#ifndef __LIBRETRO__ pxAssertDev(std::this_thread::get_id() != m_thread.get_id(), "This method is only allowed from threads *not* named MTGS."); +#endif SendPointerPacket(GS_RINGTYPE_FREEZE, (int)mode, &data); WaitGS(); } diff --git a/pcsx2/MTVU.cpp b/pcsx2/MTVU.cpp index 26ec5bf3be56b1..fc32a1f9df1d21 100644 --- a/pcsx2/MTVU.cpp +++ b/pcsx2/MTVU.cpp @@ -90,7 +90,9 @@ void SaveStateBase::mtvuFreeze() VU_Thread::VU_Thread() { +#ifndef __LIBRETRO__ /* can't call thread functions/locks from dlload in windows */ Reset(); +#endif } VU_Thread::~VU_Thread() diff --git a/pcsx2/PAD/Host/PAD.cpp b/pcsx2/PAD/Host/PAD.cpp index fa13ec7fdad955..695dfc0bf8ebb5 100644 --- a/pcsx2/PAD/Host/PAD.cpp +++ b/pcsx2/PAD/Host/PAD.cpp @@ -251,6 +251,7 @@ const char* PAD::GetDefaultPadType(u32 pad) void PAD::SetDefaultControllerConfig(SettingsInterface& si) { +#ifndef __LIBRETRO__ si.ClearSection("InputSources"); si.ClearSection("Hotkeys"); si.ClearSection("Pad"); @@ -314,6 +315,7 @@ void PAD::SetDefaultControllerConfig(SettingsInterface& si) // PCSX2 Controller Settings - Controller 1 / Controller 2 / ... // Use the automapper to set this up. MapController(si, 0, InputManager::GetGenericBindingMapping("Keyboard")); +#endif } void PAD::SetDefaultHotkeyConfig(SettingsInterface& si) @@ -527,6 +529,7 @@ void PAD::ClearPortBindings(SettingsInterface& si, u32 port) void PAD::CopyConfiguration(SettingsInterface* dest_si, const SettingsInterface& src_si, bool copy_pad_config, bool copy_pad_bindings, bool copy_hotkey_bindings) { +#ifndef __LIBRETRO__ if (copy_pad_config) { dest_si->CopyBoolValue(src_si, "Pad", "MultitapPort1"); @@ -612,6 +615,7 @@ void PAD::CopyConfiguration(SettingsInterface* dest_si, const SettingsInterface& for (const HotkeyInfo* hki : hotkeys) dest_si->CopyStringListValue(src_si, "Hotkeys", hki->name); } +#endif } static u32 TryMapGenericMapping(SettingsInterface& si, const std::string& section, diff --git a/pcsx2/PAD/Host/StateManagement.cpp b/pcsx2/PAD/Host/StateManagement.cpp index 71e30eba29f485..152d432333921e 100644 --- a/pcsx2/PAD/Host/StateManagement.cpp +++ b/pcsx2/PAD/Host/StateManagement.cpp @@ -135,10 +135,12 @@ void Pad::rumble(unsigned port) currentVibrate[0] = nextVibrate[0]; currentVibrate[1] = nextVibrate[1]; +#ifndef __LIBRETRO__ InputManager::SetPadVibrationIntensity(port, std::min(static_cast(currentVibrate[0]) * g_key_status.GetVibrationScale(port, 0) * (1.0f / 255.0f), 1.0f), std::min(static_cast(currentVibrate[1]) * g_key_status.GetVibrationScale(port, 1) * (1.0f / 255.0f), 1.0f) ); +#endif } void Pad::stop_vibrate_all() diff --git a/pcsx2/PINE.cpp b/pcsx2/PINE.cpp index fbea8dbea68e5d..04fe4f1435dae2 100644 --- a/pcsx2/PINE.cpp +++ b/pcsx2/PINE.cpp @@ -406,22 +406,26 @@ PINEServer::IPCBuffer PINEServer::ParseCommand(char* buf, char* ret_buffer, u32 } case MsgSaveState: { +#ifndef __LIBRETRO__ if (!m_vm->HasActiveMachine()) goto error; if (!SafetyChecks(buf_cnt, 1, ret_cnt, 0, buf_size)) goto error; StateCopy_SaveToSlot(FromArray(&buf[buf_cnt], 0)); buf_cnt += 1; +#endif break; - } + } case MsgLoadState: { +#ifndef __LIBRETRO__ if (!m_vm->HasActiveMachine()) goto error; if (!SafetyChecks(buf_cnt, 1, ret_cnt, 0, buf_size)) goto error; StateCopy_LoadFromSlot(FromArray(&buf[buf_cnt], 0), false); buf_cnt += 1; +#endif break; } case MsgTitle: diff --git a/pcsx2/Pcsx2Config.cpp b/pcsx2/Pcsx2Config.cpp index e3a23edb87f14b..03558a1788b040 100644 --- a/pcsx2/Pcsx2Config.cpp +++ b/pcsx2/Pcsx2Config.cpp @@ -1183,6 +1183,7 @@ void Pcsx2Config::FramerateOptions::LoadSave(SettingsWrapper& wrap) SettingsWrapEntry(SlomoScalar); } +#ifndef __LIBRETRO__ Pcsx2Config::USBOptions::USBOptions() { for (u32 i = 0; i < static_cast(Ports.size()); i++) @@ -1238,6 +1239,8 @@ bool Pcsx2Config::USBOptions::operator!=(const USBOptions& right) const return !this->operator==(right); } +#endif + #ifdef ENABLE_ACHIEVEMENTS Pcsx2Config::AchievementsOptions::AchievementsOptions() @@ -1346,7 +1349,9 @@ void Pcsx2Config::LoadSave(SettingsWrapper& wrap) Debugger.LoadSave(wrap); Trace.LoadSave(wrap); +#ifndef __LIBRETRO__ USB.LoadSave(wrap); +#endif #ifdef ENABLE_ACHIEVEMENTS Achievements.LoadSave(wrap); diff --git a/pcsx2/SPU2/Mixer.cpp b/pcsx2/SPU2/Mixer.cpp index d0d39e28ab9d3e..62faa1d4be1587 100644 --- a/pcsx2/SPU2/Mixer.cpp +++ b/pcsx2/SPU2/Mixer.cpp @@ -632,7 +632,7 @@ __forceinline /*(PlayMode&4) ? StereoOut32::Empty : */ ApplyVolume(Cores[0].ReadInput(), Cores[0].InpVol), // CDDA is on Core 1: - (PlayMode & 8) ? StereoOut32::Empty : ApplyVolume(Cores[1].ReadInput(), Cores[1].InpVol)}; + (PlayMode & 8) ? StereoOut32(0, 0) : ApplyVolume(Cores[1].ReadInput(), Cores[1].InpVol)}; #ifdef PCSX2_DEVBUILD WaveDump::WriteCore(0, CoreSrc_Input, InputData[0]); @@ -644,10 +644,10 @@ __forceinline MixCoreVoices(VoiceData[0], 0); MixCoreVoices(VoiceData[1], 1); - StereoOut32 Ext(Cores[0].Mix(VoiceData[0], InputData[0], StereoOut32::Empty)); + StereoOut32 Ext(Cores[0].Mix(VoiceData[0], InputData[0], StereoOut32(0, 0))); if ((PlayMode & 4) || (Cores[0].Mute != 0)) - Ext = StereoOut32::Empty; + Ext = StereoOut32(0, 0); else { Ext = clamp_mix(ApplyVolume(Ext, Cores[0].MasterVol)); diff --git a/pcsx2/SPU2/Reverb.cpp b/pcsx2/SPU2/Reverb.cpp index 9c61e36e1b94dd..cc5d128e36d9c0 100644 --- a/pcsx2/SPU2/Reverb.cpp +++ b/pcsx2/SPU2/Reverb.cpp @@ -149,7 +149,7 @@ StereoOut32 V_Core::DoReverb(const StereoOut32& Input) { if (EffectsBufferSize <= 0) { - return StereoOut32::Empty; + return StereoOut32(0, 0); } RevbDownBuf[0][RevbSampleBufPos & 63] = Input.Left; diff --git a/pcsx2/SPU2/spu2sys.cpp b/pcsx2/SPU2/spu2sys.cpp index bb90ff4b4175f3..0b811af26cf501 100644 --- a/pcsx2/SPU2/spu2sys.cpp +++ b/pcsx2/SPU2/spu2sys.cpp @@ -404,10 +404,12 @@ __forceinline void TimeUpdate(u32 cClocks) lClocks = cClocks - dClocks; } +#ifndef __LIBRETRO__ if (EmuConfig.SPU2.SynchMode == Pcsx2Config::SPU2Options::SynchronizationMode::ASync) SndBuffer::UpdateTempoChangeAsyncMixing(); else TickInterval = 768; // Reset to default, in case the user hotswitched from async to something else. +#endif //Update Mixing Progress while (dClocks >= TickInterval) diff --git a/pcsx2/StateWrapper.h b/pcsx2/StateWrapper.h index 0631848352f0dc..1274022a1d2647 100644 --- a/pcsx2/StateWrapper.h +++ b/pcsx2/StateWrapper.h @@ -22,6 +22,7 @@ #include #include #include +#include class String; diff --git a/pcsx2/System.cpp b/pcsx2/System.cpp index a207d97407887b..6f34e9d93ba83c 100644 --- a/pcsx2/System.cpp +++ b/pcsx2/System.cpp @@ -169,7 +169,7 @@ static VirtualMemoryManagerPtr makeMemoryManager(const char* name, const char* f // VTLB will throw a fit if we try to put EE main memory here continue; } - auto mgr = std::make_shared(name, file_mapping_name, base, size, /*upper_bounds=*/0, /*strict=*/true); + auto mgr = std::make_shared(name, file_mapping_name, base, size, /*upper_bounds=*/0, /*strict=*/false); if (mgr->IsOk()) { return mgr; diff --git a/pcsx2/VMManager.cpp b/pcsx2/VMManager.cpp index 41cbb67440f508..445536c1b712d9 100644 --- a/pcsx2/VMManager.cpp +++ b/pcsx2/VMManager.cpp @@ -1637,7 +1637,7 @@ void VMManager::Internal::VSyncOnCPUThread() } Host::CPUThreadVSync(); - +#ifndef __LIBRETRO__ if (EmuConfig.EnableRecordingTools) { // This code is called _before_ Counter's vsync end, and _after_ vsync start @@ -1654,6 +1654,7 @@ void VMManager::Internal::VSyncOnCPUThread() // so we can either read from it, or overwrite it! g_InputRecording.handleControllerDataUpdate(); } +#endif } void VMManager::CheckForCPUConfigChanges(const Pcsx2Config& old_config) diff --git a/pcsx2/VirtualMemory.cpp b/pcsx2/VirtualMemory.cpp index e479883e21ba13..5d8d22da783f72 100644 --- a/pcsx2/VirtualMemory.cpp +++ b/pcsx2/VirtualMemory.cpp @@ -334,6 +334,9 @@ void RecompiledCodeReserve::Assign(VirtualMemoryManagerPtr allocator, size_t off void RecompiledCodeReserve::Reset() { +#if defined(_WIN32) && defined(__LIBRETRO__) // TODO: investigate +#define IsDevBuild true +#endif if (IsDevBuild && m_baseptr) { // Clear the recompiled code block to 0xcc (INT3) -- this helps disasm tools show