1 /* Copyright (C) 2010-2018 The RetroArch team 2 * 3 * --------------------------------------------------------------------------------------- 4 * The following license statement only applies to this libretro API header (libretro.h). 5 * --------------------------------------------------------------------------------------- 6 * 7 * Permission is hereby granted, free of charge, 8 * to any person obtaining a copy of this software and associated documentation files (the "Software"), 9 * to deal in the Software without restriction, including without limitation the rights to 10 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, 11 * and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 12 * 13 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 14 * 15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 16 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 18 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 19 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 */ 22 23 #ifndef LIBRETRO_H__ 24 #define LIBRETRO_H__ 25 26 #include <stdint.h> 27 #include <stddef.h> 28 #include <limits.h> 29 30 #ifdef __cplusplus 31 extern "C" { 32 #endif 33 34 #ifndef __cplusplus 35 #if defined(_MSC_VER) && _MSC_VER < 1800 && !defined(SN_TARGET_PS3) 36 /* Hack applied for MSVC when compiling in C89 mode 37 * as it isn't C99-compliant. */ 38 #define bool unsigned char 39 #define true 1 40 #define false 0 41 #else 42 #include <stdbool.h> 43 #endif 44 #endif 45 46 #ifndef RETRO_CALLCONV 47 # if defined(__GNUC__) && defined(__i386__) && !defined(__x86_64__) 48 # define RETRO_CALLCONV __attribute__((cdecl)) 49 # elif defined(_MSC_VER) && defined(_M_X86) && !defined(_M_X64) 50 # define RETRO_CALLCONV __cdecl 51 # else 52 # define RETRO_CALLCONV /* all other platforms only have one calling convention each */ 53 # endif 54 #endif 55 56 #ifndef RETRO_API 57 # if defined(_WIN32) || defined(__CYGWIN__) || defined(__MINGW32__) 58 # ifdef RETRO_IMPORT_SYMBOLS 59 # ifdef __GNUC__ 60 # define RETRO_API RETRO_CALLCONV __attribute__((__dllimport__)) 61 # else 62 # define RETRO_API RETRO_CALLCONV __declspec(dllimport) 63 # endif 64 # else 65 # ifdef __GNUC__ 66 # define RETRO_API RETRO_CALLCONV __attribute__((__dllexport__)) 67 # else 68 # define RETRO_API RETRO_CALLCONV __declspec(dllexport) 69 # endif 70 # endif 71 # else 72 # if defined(__GNUC__) && __GNUC__ >= 4 73 # define RETRO_API RETRO_CALLCONV __attribute__((__visibility__("default"))) 74 # else 75 # define RETRO_API RETRO_CALLCONV 76 # endif 77 # endif 78 #endif 79 80 /* Used for checking API/ABI mismatches that can break libretro 81 * implementations. 82 * It is not incremented for compatible changes to the API. 83 */ 84 #define RETRO_API_VERSION 1 85 86 /* 87 * Libretro's fundamental device abstractions. 88 * 89 * Libretro's input system consists of some standardized device types, 90 * such as a joypad (with/without analog), mouse, keyboard, lightgun 91 * and a pointer. 92 * 93 * The functionality of these devices are fixed, and individual cores 94 * map their own concept of a controller to libretro's abstractions. 95 * This makes it possible for frontends to map the abstract types to a 96 * real input device, and not having to worry about binding input 97 * correctly to arbitrary controller layouts. 98 */ 99 100 #define RETRO_DEVICE_TYPE_SHIFT 8 101 #define RETRO_DEVICE_MASK ((1 << RETRO_DEVICE_TYPE_SHIFT) - 1) 102 #define RETRO_DEVICE_SUBCLASS(base, id) (((id + 1) << RETRO_DEVICE_TYPE_SHIFT) | base) 103 104 /* Input disabled. */ 105 #define RETRO_DEVICE_NONE 0 106 107 /* The JOYPAD is called RetroPad. It is essentially a Super Nintendo 108 * controller, but with additional L2/R2/L3/R3 buttons, similar to a 109 * PS1 DualShock. */ 110 #define RETRO_DEVICE_JOYPAD 1 111 112 /* The mouse is a simple mouse, similar to Super Nintendo's mouse. 113 * X and Y coordinates are reported relatively to last poll (poll callback). 114 * It is up to the libretro implementation to keep track of where the mouse 115 * pointer is supposed to be on the screen. 116 * The frontend must make sure not to interfere with its own hardware 117 * mouse pointer. 118 */ 119 #define RETRO_DEVICE_MOUSE 2 120 121 /* KEYBOARD device lets one poll for raw key pressed. 122 * It is poll based, so input callback will return with the current 123 * pressed state. 124 * For event/text based keyboard input, see 125 * RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK. 126 */ 127 #define RETRO_DEVICE_KEYBOARD 3 128 129 /* LIGHTGUN device is similar to Guncon-2 for PlayStation 2. 130 * It reports X/Y coordinates in screen space (similar to the pointer) 131 * in the range [-0x8000, 0x7fff] in both axes, with zero being center and 132 * -0x8000 being out of bounds. 133 * As well as reporting on/off screen state. It features a trigger, 134 * start/select buttons, auxiliary action buttons and a 135 * directional pad. A forced off-screen shot can be requested for 136 * auto-reloading function in some games. 137 */ 138 #define RETRO_DEVICE_LIGHTGUN 4 139 140 /* The ANALOG device is an extension to JOYPAD (RetroPad). 141 * Similar to DualShock2 it adds two analog sticks and all buttons can 142 * be analog. This is treated as a separate device type as it returns 143 * axis values in the full analog range of [-0x7fff, 0x7fff], 144 * although some devices may return -0x8000. 145 * Positive X axis is right. Positive Y axis is down. 146 * Buttons are returned in the range [0, 0x7fff]. 147 * Only use ANALOG type when polling for analog values. 148 */ 149 #define RETRO_DEVICE_ANALOG 5 150 151 /* Abstracts the concept of a pointing mechanism, e.g. touch. 152 * This allows libretro to query in absolute coordinates where on the 153 * screen a mouse (or something similar) is being placed. 154 * For a touch centric device, coordinates reported are the coordinates 155 * of the press. 156 * 157 * Coordinates in X and Y are reported as: 158 * [-0x7fff, 0x7fff]: -0x7fff corresponds to the far left/top of the screen, 159 * and 0x7fff corresponds to the far right/bottom of the screen. 160 * The "screen" is here defined as area that is passed to the frontend and 161 * later displayed on the monitor. 162 * 163 * The frontend is free to scale/resize this screen as it sees fit, however, 164 * (X, Y) = (-0x7fff, -0x7fff) will correspond to the top-left pixel of the 165 * game image, etc. 166 * 167 * To check if the pointer coordinates are valid (e.g. a touch display 168 * actually being touched), PRESSED returns 1 or 0. 169 * 170 * If using a mouse on a desktop, PRESSED will usually correspond to the 171 * left mouse button, but this is a frontend decision. 172 * PRESSED will only return 1 if the pointer is inside the game screen. 173 * 174 * For multi-touch, the index variable can be used to successively query 175 * more presses. 176 * If index = 0 returns true for _PRESSED, coordinates can be extracted 177 * with _X, _Y for index = 0. One can then query _PRESSED, _X, _Y with 178 * index = 1, and so on. 179 * Eventually _PRESSED will return false for an index. No further presses 180 * are registered at this point. */ 181 #define RETRO_DEVICE_POINTER 6 182 183 /* Buttons for the RetroPad (JOYPAD). 184 * The placement of these is equivalent to placements on the 185 * Super Nintendo controller. 186 * L2/R2/L3/R3 buttons correspond to the PS1 DualShock. 187 * Also used as id values for RETRO_DEVICE_INDEX_ANALOG_BUTTON */ 188 #define RETRO_DEVICE_ID_JOYPAD_B 0 189 #define RETRO_DEVICE_ID_JOYPAD_Y 1 190 #define RETRO_DEVICE_ID_JOYPAD_SELECT 2 191 #define RETRO_DEVICE_ID_JOYPAD_START 3 192 #define RETRO_DEVICE_ID_JOYPAD_UP 4 193 #define RETRO_DEVICE_ID_JOYPAD_DOWN 5 194 #define RETRO_DEVICE_ID_JOYPAD_LEFT 6 195 #define RETRO_DEVICE_ID_JOYPAD_RIGHT 7 196 #define RETRO_DEVICE_ID_JOYPAD_A 8 197 #define RETRO_DEVICE_ID_JOYPAD_X 9 198 #define RETRO_DEVICE_ID_JOYPAD_L 10 199 #define RETRO_DEVICE_ID_JOYPAD_R 11 200 #define RETRO_DEVICE_ID_JOYPAD_L2 12 201 #define RETRO_DEVICE_ID_JOYPAD_R2 13 202 #define RETRO_DEVICE_ID_JOYPAD_L3 14 203 #define RETRO_DEVICE_ID_JOYPAD_R3 15 204 205 #define RETRO_DEVICE_ID_JOYPAD_MASK 256 206 207 /* Index / Id values for ANALOG device. */ 208 #define RETRO_DEVICE_INDEX_ANALOG_LEFT 0 209 #define RETRO_DEVICE_INDEX_ANALOG_RIGHT 1 210 #define RETRO_DEVICE_INDEX_ANALOG_BUTTON 2 211 #define RETRO_DEVICE_ID_ANALOG_X 0 212 #define RETRO_DEVICE_ID_ANALOG_Y 1 213 214 /* Id values for MOUSE. */ 215 #define RETRO_DEVICE_ID_MOUSE_X 0 216 #define RETRO_DEVICE_ID_MOUSE_Y 1 217 #define RETRO_DEVICE_ID_MOUSE_LEFT 2 218 #define RETRO_DEVICE_ID_MOUSE_RIGHT 3 219 #define RETRO_DEVICE_ID_MOUSE_WHEELUP 4 220 #define RETRO_DEVICE_ID_MOUSE_WHEELDOWN 5 221 #define RETRO_DEVICE_ID_MOUSE_MIDDLE 6 222 #define RETRO_DEVICE_ID_MOUSE_HORIZ_WHEELUP 7 223 #define RETRO_DEVICE_ID_MOUSE_HORIZ_WHEELDOWN 8 224 #define RETRO_DEVICE_ID_MOUSE_BUTTON_4 9 225 #define RETRO_DEVICE_ID_MOUSE_BUTTON_5 10 226 227 /* Id values for LIGHTGUN. */ 228 #define RETRO_DEVICE_ID_LIGHTGUN_SCREEN_X 13 /*Absolute Position*/ 229 #define RETRO_DEVICE_ID_LIGHTGUN_SCREEN_Y 14 /*Absolute*/ 230 #define RETRO_DEVICE_ID_LIGHTGUN_IS_OFFSCREEN 15 /*Status Check*/ 231 #define RETRO_DEVICE_ID_LIGHTGUN_TRIGGER 2 232 #define RETRO_DEVICE_ID_LIGHTGUN_RELOAD 16 /*Forced off-screen shot*/ 233 #define RETRO_DEVICE_ID_LIGHTGUN_AUX_A 3 234 #define RETRO_DEVICE_ID_LIGHTGUN_AUX_B 4 235 #define RETRO_DEVICE_ID_LIGHTGUN_START 6 236 #define RETRO_DEVICE_ID_LIGHTGUN_SELECT 7 237 #define RETRO_DEVICE_ID_LIGHTGUN_AUX_C 8 238 #define RETRO_DEVICE_ID_LIGHTGUN_DPAD_UP 9 239 #define RETRO_DEVICE_ID_LIGHTGUN_DPAD_DOWN 10 240 #define RETRO_DEVICE_ID_LIGHTGUN_DPAD_LEFT 11 241 #define RETRO_DEVICE_ID_LIGHTGUN_DPAD_RIGHT 12 242 /* deprecated */ 243 #define RETRO_DEVICE_ID_LIGHTGUN_X 0 /*Relative Position*/ 244 #define RETRO_DEVICE_ID_LIGHTGUN_Y 1 /*Relative*/ 245 #define RETRO_DEVICE_ID_LIGHTGUN_CURSOR 3 /*Use Aux:A*/ 246 #define RETRO_DEVICE_ID_LIGHTGUN_TURBO 4 /*Use Aux:B*/ 247 #define RETRO_DEVICE_ID_LIGHTGUN_PAUSE 5 /*Use Start*/ 248 249 /* Id values for POINTER. */ 250 #define RETRO_DEVICE_ID_POINTER_X 0 251 #define RETRO_DEVICE_ID_POINTER_Y 1 252 #define RETRO_DEVICE_ID_POINTER_PRESSED 2 253 #define RETRO_DEVICE_ID_POINTER_COUNT 3 254 255 /* Returned from retro_get_region(). */ 256 #define RETRO_REGION_NTSC 0 257 #define RETRO_REGION_PAL 1 258 259 /* Id values for LANGUAGE */ 260 enum retro_language 261 { 262 RETRO_LANGUAGE_ENGLISH = 0, 263 RETRO_LANGUAGE_JAPANESE = 1, 264 RETRO_LANGUAGE_FRENCH = 2, 265 RETRO_LANGUAGE_SPANISH = 3, 266 RETRO_LANGUAGE_GERMAN = 4, 267 RETRO_LANGUAGE_ITALIAN = 5, 268 RETRO_LANGUAGE_DUTCH = 6, 269 RETRO_LANGUAGE_PORTUGUESE_BRAZIL = 7, 270 RETRO_LANGUAGE_PORTUGUESE_PORTUGAL = 8, 271 RETRO_LANGUAGE_RUSSIAN = 9, 272 RETRO_LANGUAGE_KOREAN = 10, 273 RETRO_LANGUAGE_CHINESE_TRADITIONAL = 11, 274 RETRO_LANGUAGE_CHINESE_SIMPLIFIED = 12, 275 RETRO_LANGUAGE_ESPERANTO = 13, 276 RETRO_LANGUAGE_POLISH = 14, 277 RETRO_LANGUAGE_VIETNAMESE = 15, 278 RETRO_LANGUAGE_ARABIC = 16, 279 RETRO_LANGUAGE_GREEK = 17, 280 RETRO_LANGUAGE_TURKISH = 18, 281 RETRO_LANGUAGE_LAST, 282 283 /* Ensure sizeof(enum) == sizeof(int) */ 284 RETRO_LANGUAGE_DUMMY = INT_MAX 285 }; 286 287 /* Passed to retro_get_memory_data/size(). 288 * If the memory type doesn't apply to the 289 * implementation NULL/0 can be returned. 290 */ 291 #define RETRO_MEMORY_MASK 0xff 292 293 /* Regular save RAM. This RAM is usually found on a game cartridge, 294 * backed up by a battery. 295 * If save game data is too complex for a single memory buffer, 296 * the SAVE_DIRECTORY (preferably) or SYSTEM_DIRECTORY environment 297 * callback can be used. */ 298 #define RETRO_MEMORY_SAVE_RAM 0 299 300 /* Some games have a built-in clock to keep track of time. 301 * This memory is usually just a couple of bytes to keep track of time. 302 */ 303 #define RETRO_MEMORY_RTC 1 304 305 /* System ram lets a frontend peek into a game systems main RAM. */ 306 #define RETRO_MEMORY_SYSTEM_RAM 2 307 308 /* Video ram lets a frontend peek into a game systems video RAM (VRAM). */ 309 #define RETRO_MEMORY_VIDEO_RAM 3 310 311 /* Keysyms used for ID in input state callback when polling RETRO_KEYBOARD. */ 312 enum retro_key 313 { 314 RETROK_UNKNOWN = 0, 315 RETROK_FIRST = 0, 316 RETROK_BACKSPACE = 8, 317 RETROK_TAB = 9, 318 RETROK_CLEAR = 12, 319 RETROK_RETURN = 13, 320 RETROK_PAUSE = 19, 321 RETROK_ESCAPE = 27, 322 RETROK_SPACE = 32, 323 RETROK_EXCLAIM = 33, 324 RETROK_QUOTEDBL = 34, 325 RETROK_HASH = 35, 326 RETROK_DOLLAR = 36, 327 RETROK_AMPERSAND = 38, 328 RETROK_QUOTE = 39, 329 RETROK_LEFTPAREN = 40, 330 RETROK_RIGHTPAREN = 41, 331 RETROK_ASTERISK = 42, 332 RETROK_PLUS = 43, 333 RETROK_COMMA = 44, 334 RETROK_MINUS = 45, 335 RETROK_PERIOD = 46, 336 RETROK_SLASH = 47, 337 RETROK_0 = 48, 338 RETROK_1 = 49, 339 RETROK_2 = 50, 340 RETROK_3 = 51, 341 RETROK_4 = 52, 342 RETROK_5 = 53, 343 RETROK_6 = 54, 344 RETROK_7 = 55, 345 RETROK_8 = 56, 346 RETROK_9 = 57, 347 RETROK_COLON = 58, 348 RETROK_SEMICOLON = 59, 349 RETROK_LESS = 60, 350 RETROK_EQUALS = 61, 351 RETROK_GREATER = 62, 352 RETROK_QUESTION = 63, 353 RETROK_AT = 64, 354 RETROK_LEFTBRACKET = 91, 355 RETROK_BACKSLASH = 92, 356 RETROK_RIGHTBRACKET = 93, 357 RETROK_CARET = 94, 358 RETROK_UNDERSCORE = 95, 359 RETROK_BACKQUOTE = 96, 360 RETROK_a = 97, 361 RETROK_b = 98, 362 RETROK_c = 99, 363 RETROK_d = 100, 364 RETROK_e = 101, 365 RETROK_f = 102, 366 RETROK_g = 103, 367 RETROK_h = 104, 368 RETROK_i = 105, 369 RETROK_j = 106, 370 RETROK_k = 107, 371 RETROK_l = 108, 372 RETROK_m = 109, 373 RETROK_n = 110, 374 RETROK_o = 111, 375 RETROK_p = 112, 376 RETROK_q = 113, 377 RETROK_r = 114, 378 RETROK_s = 115, 379 RETROK_t = 116, 380 RETROK_u = 117, 381 RETROK_v = 118, 382 RETROK_w = 119, 383 RETROK_x = 120, 384 RETROK_y = 121, 385 RETROK_z = 122, 386 RETROK_LEFTBRACE = 123, 387 RETROK_BAR = 124, 388 RETROK_RIGHTBRACE = 125, 389 RETROK_TILDE = 126, 390 RETROK_DELETE = 127, 391 392 RETROK_KP0 = 256, 393 RETROK_KP1 = 257, 394 RETROK_KP2 = 258, 395 RETROK_KP3 = 259, 396 RETROK_KP4 = 260, 397 RETROK_KP5 = 261, 398 RETROK_KP6 = 262, 399 RETROK_KP7 = 263, 400 RETROK_KP8 = 264, 401 RETROK_KP9 = 265, 402 RETROK_KP_PERIOD = 266, 403 RETROK_KP_DIVIDE = 267, 404 RETROK_KP_MULTIPLY = 268, 405 RETROK_KP_MINUS = 269, 406 RETROK_KP_PLUS = 270, 407 RETROK_KP_ENTER = 271, 408 RETROK_KP_EQUALS = 272, 409 410 RETROK_UP = 273, 411 RETROK_DOWN = 274, 412 RETROK_RIGHT = 275, 413 RETROK_LEFT = 276, 414 RETROK_INSERT = 277, 415 RETROK_HOME = 278, 416 RETROK_END = 279, 417 RETROK_PAGEUP = 280, 418 RETROK_PAGEDOWN = 281, 419 420 RETROK_F1 = 282, 421 RETROK_F2 = 283, 422 RETROK_F3 = 284, 423 RETROK_F4 = 285, 424 RETROK_F5 = 286, 425 RETROK_F6 = 287, 426 RETROK_F7 = 288, 427 RETROK_F8 = 289, 428 RETROK_F9 = 290, 429 RETROK_F10 = 291, 430 RETROK_F11 = 292, 431 RETROK_F12 = 293, 432 RETROK_F13 = 294, 433 RETROK_F14 = 295, 434 RETROK_F15 = 296, 435 436 RETROK_NUMLOCK = 300, 437 RETROK_CAPSLOCK = 301, 438 RETROK_SCROLLOCK = 302, 439 RETROK_RSHIFT = 303, 440 RETROK_LSHIFT = 304, 441 RETROK_RCTRL = 305, 442 RETROK_LCTRL = 306, 443 RETROK_RALT = 307, 444 RETROK_LALT = 308, 445 RETROK_RMETA = 309, 446 RETROK_LMETA = 310, 447 RETROK_LSUPER = 311, 448 RETROK_RSUPER = 312, 449 RETROK_MODE = 313, 450 RETROK_COMPOSE = 314, 451 452 RETROK_HELP = 315, 453 RETROK_PRINT = 316, 454 RETROK_SYSREQ = 317, 455 RETROK_BREAK = 318, 456 RETROK_MENU = 319, 457 RETROK_POWER = 320, 458 RETROK_EURO = 321, 459 RETROK_UNDO = 322, 460 RETROK_OEM_102 = 323, 461 462 RETROK_LAST, 463 464 RETROK_DUMMY = INT_MAX /* Ensure sizeof(enum) == sizeof(int) */ 465 }; 466 467 enum retro_mod 468 { 469 RETROKMOD_NONE = 0x0000, 470 471 RETROKMOD_SHIFT = 0x01, 472 RETROKMOD_CTRL = 0x02, 473 RETROKMOD_ALT = 0x04, 474 RETROKMOD_META = 0x08, 475 476 RETROKMOD_NUMLOCK = 0x10, 477 RETROKMOD_CAPSLOCK = 0x20, 478 RETROKMOD_SCROLLOCK = 0x40, 479 480 RETROKMOD_DUMMY = INT_MAX /* Ensure sizeof(enum) == sizeof(int) */ 481 }; 482 483 /* If set, this call is not part of the public libretro API yet. It can 484 * change or be removed at any time. */ 485 #define RETRO_ENVIRONMENT_EXPERIMENTAL 0x10000 486 /* Environment callback to be used internally in frontend. */ 487 #define RETRO_ENVIRONMENT_PRIVATE 0x20000 488 489 /* Environment commands. */ 490 #define RETRO_ENVIRONMENT_SET_ROTATION 1 /* const unsigned * -- 491 * Sets screen rotation of graphics. 492 * Valid values are 0, 1, 2, 3, which rotates screen by 0, 90, 180, 493 * 270 degrees counter-clockwise respectively. 494 */ 495 #define RETRO_ENVIRONMENT_GET_OVERSCAN 2 /* bool * -- 496 * NOTE: As of 2019 this callback is considered deprecated in favor of 497 * using core options to manage overscan in a more nuanced, core-specific way. 498 * 499 * Boolean value whether or not the implementation should use overscan, 500 * or crop away overscan. 501 */ 502 #define RETRO_ENVIRONMENT_GET_CAN_DUPE 3 /* bool * -- 503 * Boolean value whether or not frontend supports frame duping, 504 * passing NULL to video frame callback. 505 */ 506 507 /* Environ 4, 5 are no longer supported (GET_VARIABLE / SET_VARIABLES), 508 * and reserved to avoid possible ABI clash. 509 */ 510 511 #define RETRO_ENVIRONMENT_SET_MESSAGE 6 /* const struct retro_message * -- 512 * Sets a message to be displayed in implementation-specific manner 513 * for a certain amount of 'frames'. 514 * Should not be used for trivial messages, which should simply be 515 * logged via RETRO_ENVIRONMENT_GET_LOG_INTERFACE (or as a 516 * fallback, stderr). 517 */ 518 #define RETRO_ENVIRONMENT_SHUTDOWN 7 /* N/A (NULL) -- 519 * Requests the frontend to shutdown. 520 * Should only be used if game has a specific 521 * way to shutdown the game from a menu item or similar. 522 */ 523 #define RETRO_ENVIRONMENT_SET_PERFORMANCE_LEVEL 8 524 /* const unsigned * -- 525 * Gives a hint to the frontend how demanding this implementation 526 * is on a system. E.g. reporting a level of 2 means 527 * this implementation should run decently on all frontends 528 * of level 2 and up. 529 * 530 * It can be used by the frontend to potentially warn 531 * about too demanding implementations. 532 * 533 * The levels are "floating". 534 * 535 * This function can be called on a per-game basis, 536 * as certain games an implementation can play might be 537 * particularly demanding. 538 * If called, it should be called in retro_load_game(). 539 */ 540 #define RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY 9 541 /* const char ** -- 542 * Returns the "system" directory of the frontend. 543 * This directory can be used to store system specific 544 * content such as BIOSes, configuration data, etc. 545 * The returned value can be NULL. 546 * If so, no such directory is defined, 547 * and it's up to the implementation to find a suitable directory. 548 * 549 * NOTE: Some cores used this folder also for "save" data such as 550 * memory cards, etc, for lack of a better place to put it. 551 * This is now discouraged, and if possible, cores should try to 552 * use the new GET_SAVE_DIRECTORY. 553 */ 554 #define RETRO_ENVIRONMENT_SET_PIXEL_FORMAT 10 555 /* const enum retro_pixel_format * -- 556 * Sets the internal pixel format used by the implementation. 557 * The default pixel format is RETRO_PIXEL_FORMAT_0RGB1555. 558 * This pixel format however, is deprecated (see enum retro_pixel_format). 559 * If the call returns false, the frontend does not support this pixel 560 * format. 561 * 562 * This function should be called inside retro_load_game() or 563 * retro_get_system_av_info(). 564 */ 565 #define RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS 11 566 /* const struct retro_input_descriptor * -- 567 * Sets an array of retro_input_descriptors. 568 * It is up to the frontend to present this in a usable way. 569 * The array is terminated by retro_input_descriptor::description 570 * being set to NULL. 571 * This function can be called at any time, but it is recommended 572 * to call it as early as possible. 573 */ 574 #define RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK 12 575 /* const struct retro_keyboard_callback * -- 576 * Sets a callback function used to notify core about keyboard events. 577 */ 578 #define RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE 13 579 /* const struct retro_disk_control_callback * -- 580 * Sets an interface which frontend can use to eject and insert 581 * disk images. 582 * This is used for games which consist of multiple images and 583 * must be manually swapped out by the user (e.g. PSX). 584 */ 585 #define RETRO_ENVIRONMENT_SET_HW_RENDER 14 586 /* struct retro_hw_render_callback * -- 587 * Sets an interface to let a libretro core render with 588 * hardware acceleration. 589 * Should be called in retro_load_game(). 590 * If successful, libretro cores will be able to render to a 591 * frontend-provided framebuffer. 592 * The size of this framebuffer will be at least as large as 593 * max_width/max_height provided in get_av_info(). 594 * If HW rendering is used, pass only RETRO_HW_FRAME_BUFFER_VALID or 595 * NULL to retro_video_refresh_t. 596 */ 597 #define RETRO_ENVIRONMENT_GET_VARIABLE 15 598 /* struct retro_variable * -- 599 * Interface to acquire user-defined information from environment 600 * that cannot feasibly be supported in a multi-system way. 601 * 'key' should be set to a key which has already been set by 602 * SET_VARIABLES. 603 * 'data' will be set to a value or NULL. 604 */ 605 #define RETRO_ENVIRONMENT_SET_VARIABLES 16 606 /* const struct retro_variable * -- 607 * Allows an implementation to signal the environment 608 * which variables it might want to check for later using 609 * GET_VARIABLE. 610 * This allows the frontend to present these variables to 611 * a user dynamically. 612 * This should be called the first time as early as 613 * possible (ideally in retro_set_environment). 614 * Afterward it may be called again for the core to communicate 615 * updated options to the frontend, but the number of core 616 * options must not change from the number in the initial call. 617 * 618 * 'data' points to an array of retro_variable structs 619 * terminated by a { NULL, NULL } element. 620 * retro_variable::key should be namespaced to not collide 621 * with other implementations' keys. E.g. A core called 622 * 'foo' should use keys named as 'foo_option'. 623 * retro_variable::value should contain a human readable 624 * description of the key as well as a '|' delimited list 625 * of expected values. 626 * 627 * The number of possible options should be very limited, 628 * i.e. it should be feasible to cycle through options 629 * without a keyboard. 630 * 631 * First entry should be treated as a default. 632 * 633 * Example entry: 634 * { "foo_option", "Speed hack coprocessor X; false|true" } 635 * 636 * Text before first ';' is description. This ';' must be 637 * followed by a space, and followed by a list of possible 638 * values split up with '|'. 639 * 640 * Only strings are operated on. The possible values will 641 * generally be displayed and stored as-is by the frontend. 642 */ 643 #define RETRO_ENVIRONMENT_GET_VARIABLE_UPDATE 17 644 /* bool * -- 645 * Result is set to true if some variables are updated by 646 * frontend since last call to RETRO_ENVIRONMENT_GET_VARIABLE. 647 * Variables should be queried with GET_VARIABLE. 648 */ 649 #define RETRO_ENVIRONMENT_SET_SUPPORT_NO_GAME 18 650 /* const bool * -- 651 * If true, the libretro implementation supports calls to 652 * retro_load_game() with NULL as argument. 653 * Used by cores which can run without particular game data. 654 * This should be called within retro_set_environment() only. 655 */ 656 #define RETRO_ENVIRONMENT_GET_LIBRETRO_PATH 19 657 /* const char ** -- 658 * Retrieves the absolute path from where this libretro 659 * implementation was loaded. 660 * NULL is returned if the libretro was loaded statically 661 * (i.e. linked statically to frontend), or if the path cannot be 662 * determined. 663 * Mostly useful in cooperation with SET_SUPPORT_NO_GAME as assets can 664 * be loaded without ugly hacks. 665 */ 666 667 /* Environment 20 was an obsolete version of SET_AUDIO_CALLBACK. 668 * It was not used by any known core at the time, 669 * and was removed from the API. */ 670 #define RETRO_ENVIRONMENT_SET_FRAME_TIME_CALLBACK 21 671 /* const struct retro_frame_time_callback * -- 672 * Lets the core know how much time has passed since last 673 * invocation of retro_run(). 674 * The frontend can tamper with the timing to fake fast-forward, 675 * slow-motion, frame stepping, etc. 676 * In this case the delta time will use the reference value 677 * in frame_time_callback.. 678 */ 679 #define RETRO_ENVIRONMENT_SET_AUDIO_CALLBACK 22 680 /* const struct retro_audio_callback * -- 681 * Sets an interface which is used to notify a libretro core about audio 682 * being available for writing. 683 * The callback can be called from any thread, so a core using this must 684 * have a thread safe audio implementation. 685 * It is intended for games where audio and video are completely 686 * asynchronous and audio can be generated on the fly. 687 * This interface is not recommended for use with emulators which have 688 * highly synchronous audio. 689 * 690 * The callback only notifies about writability; the libretro core still 691 * has to call the normal audio callbacks 692 * to write audio. The audio callbacks must be called from within the 693 * notification callback. 694 * The amount of audio data to write is up to the implementation. 695 * Generally, the audio callback will be called continously in a loop. 696 * 697 * Due to thread safety guarantees and lack of sync between audio and 698 * video, a frontend can selectively disallow this interface based on 699 * internal configuration. A core using this interface must also 700 * implement the "normal" audio interface. 701 * 702 * A libretro core using SET_AUDIO_CALLBACK should also make use of 703 * SET_FRAME_TIME_CALLBACK. 704 */ 705 #define RETRO_ENVIRONMENT_GET_RUMBLE_INTERFACE 23 706 /* struct retro_rumble_interface * -- 707 * Gets an interface which is used by a libretro core to set 708 * state of rumble motors in controllers. 709 * A strong and weak motor is supported, and they can be 710 * controlled indepedently. 711 */ 712 #define RETRO_ENVIRONMENT_GET_INPUT_DEVICE_CAPABILITIES 24 713 /* uint64_t * -- 714 * Gets a bitmask telling which device type are expected to be 715 * handled properly in a call to retro_input_state_t. 716 * Devices which are not handled or recognized always return 717 * 0 in retro_input_state_t. 718 * Example bitmask: caps = (1 << RETRO_DEVICE_JOYPAD) | (1 << RETRO_DEVICE_ANALOG). 719 * Should only be called in retro_run(). 720 */ 721 #define RETRO_ENVIRONMENT_GET_SENSOR_INTERFACE (25 | RETRO_ENVIRONMENT_EXPERIMENTAL) 722 /* struct retro_sensor_interface * -- 723 * Gets access to the sensor interface. 724 * The purpose of this interface is to allow 725 * setting state related to sensors such as polling rate, 726 * enabling/disable it entirely, etc. 727 * Reading sensor state is done via the normal 728 * input_state_callback API. 729 */ 730 #define RETRO_ENVIRONMENT_GET_CAMERA_INTERFACE (26 | RETRO_ENVIRONMENT_EXPERIMENTAL) 731 /* struct retro_camera_callback * -- 732 * Gets an interface to a video camera driver. 733 * A libretro core can use this interface to get access to a 734 * video camera. 735 * New video frames are delivered in a callback in same 736 * thread as retro_run(). 737 * 738 * GET_CAMERA_INTERFACE should be called in retro_load_game(). 739 * 740 * Depending on the camera implementation used, camera frames 741 * will be delivered as a raw framebuffer, 742 * or as an OpenGL texture directly. 743 * 744 * The core has to tell the frontend here which types of 745 * buffers can be handled properly. 746 * An OpenGL texture can only be handled when using a 747 * libretro GL core (SET_HW_RENDER). 748 * It is recommended to use a libretro GL core when 749 * using camera interface. 750 * 751 * The camera is not started automatically. The retrieved start/stop 752 * functions must be used to explicitly 753 * start and stop the camera driver. 754 */ 755 #define RETRO_ENVIRONMENT_GET_LOG_INTERFACE 27 756 /* struct retro_log_callback * -- 757 * Gets an interface for logging. This is useful for 758 * logging in a cross-platform way 759 * as certain platforms cannot use stderr for logging. 760 * It also allows the frontend to 761 * show logging information in a more suitable way. 762 * If this interface is not used, libretro cores should 763 * log to stderr as desired. 764 */ 765 #define RETRO_ENVIRONMENT_GET_PERF_INTERFACE 28 766 /* struct retro_perf_callback * -- 767 * Gets an interface for performance counters. This is useful 768 * for performance logging in a cross-platform way and for detecting 769 * architecture-specific features, such as SIMD support. 770 */ 771 #define RETRO_ENVIRONMENT_GET_LOCATION_INTERFACE 29 772 /* struct retro_location_callback * -- 773 * Gets access to the location interface. 774 * The purpose of this interface is to be able to retrieve 775 * location-based information from the host device, 776 * such as current latitude / longitude. 777 */ 778 #define RETRO_ENVIRONMENT_GET_CONTENT_DIRECTORY 30 /* Old name, kept for compatibility. */ 779 #define RETRO_ENVIRONMENT_GET_CORE_ASSETS_DIRECTORY 30 780 /* const char ** -- 781 * Returns the "core assets" directory of the frontend. 782 * This directory can be used to store specific assets that the 783 * core relies upon, such as art assets, 784 * input data, etc etc. 785 * The returned value can be NULL. 786 * If so, no such directory is defined, 787 * and it's up to the implementation to find a suitable directory. 788 */ 789 #define RETRO_ENVIRONMENT_GET_SAVE_DIRECTORY 31 790 /* const char ** -- 791 * Returns the "save" directory of the frontend, unless there is no 792 * save directory available. The save directory should be used to 793 * store SRAM, memory cards, high scores, etc, if the libretro core 794 * cannot use the regular memory interface (retro_get_memory_data()). 795 * 796 * If the frontend cannot designate a save directory, it will return 797 * NULL to indicate that the core should attempt to operate without a 798 * save directory set. 799 * 800 * NOTE: early libretro cores used the system directory for save 801 * files. Cores that need to be backwards-compatible can still check 802 * GET_SYSTEM_DIRECTORY. 803 */ 804 #define RETRO_ENVIRONMENT_SET_SYSTEM_AV_INFO 32 805 /* const struct retro_system_av_info * -- 806 * Sets a new av_info structure. This can only be called from 807 * within retro_run(). 808 * This should *only* be used if the core is completely altering the 809 * internal resolutions, aspect ratios, timings, sampling rate, etc. 810 * Calling this can require a full reinitialization of video/audio 811 * drivers in the frontend, 812 * 813 * so it is important to call it very sparingly, and usually only with 814 * the users explicit consent. 815 * An eventual driver reinitialize will happen so that video and 816 * audio callbacks 817 * happening after this call within the same retro_run() call will 818 * target the newly initialized driver. 819 * 820 * This callback makes it possible to support configurable resolutions 821 * in games, which can be useful to 822 * avoid setting the "worst case" in max_width/max_height. 823 * 824 * ***HIGHLY RECOMMENDED*** Do not call this callback every time 825 * resolution changes in an emulator core if it's 826 * expected to be a temporary change, for the reasons of possible 827 * driver reinitialization. 828 * This call is not a free pass for not trying to provide 829 * correct values in retro_get_system_av_info(). If you need to change 830 * things like aspect ratio or nominal width/height, 831 * use RETRO_ENVIRONMENT_SET_GEOMETRY, which is a softer variant 832 * of SET_SYSTEM_AV_INFO. 833 * 834 * If this returns false, the frontend does not acknowledge a 835 * changed av_info struct. 836 */ 837 #define RETRO_ENVIRONMENT_SET_PROC_ADDRESS_CALLBACK 33 838 /* const struct retro_get_proc_address_interface * -- 839 * Allows a libretro core to announce support for the 840 * get_proc_address() interface. 841 * This interface allows for a standard way to extend libretro where 842 * use of environment calls are too indirect, 843 * e.g. for cases where the frontend wants to call directly into the core. 844 * 845 * If a core wants to expose this interface, SET_PROC_ADDRESS_CALLBACK 846 * **MUST** be called from within retro_set_environment(). 847 */ 848 #define RETRO_ENVIRONMENT_SET_SUBSYSTEM_INFO 34 849 /* const struct retro_subsystem_info * -- 850 * This environment call introduces the concept of libretro "subsystems". 851 * A subsystem is a variant of a libretro core which supports 852 * different kinds of games. 853 * The purpose of this is to support e.g. emulators which might 854 * have special needs, e.g. Super Nintendo's Super GameBoy, Sufami Turbo. 855 * It can also be used to pick among subsystems in an explicit way 856 * if the libretro implementation is a multi-system emulator itself. 857 * 858 * Loading a game via a subsystem is done with retro_load_game_special(), 859 * and this environment call allows a libretro core to expose which 860 * subsystems are supported for use with retro_load_game_special(). 861 * A core passes an array of retro_game_special_info which is terminated 862 * with a zeroed out retro_game_special_info struct. 863 * 864 * If a core wants to use this functionality, SET_SUBSYSTEM_INFO 865 * **MUST** be called from within retro_set_environment(). 866 */ 867 #define RETRO_ENVIRONMENT_SET_CONTROLLER_INFO 35 868 /* const struct retro_controller_info * -- 869 * This environment call lets a libretro core tell the frontend 870 * which controller subclasses are recognized in calls to 871 * retro_set_controller_port_device(). 872 * 873 * Some emulators such as Super Nintendo support multiple lightgun 874 * types which must be specifically selected from. It is therefore 875 * sometimes necessary for a frontend to be able to tell the core 876 * about a special kind of input device which is not specifcally 877 * provided by the Libretro API. 878 * 879 * In order for a frontend to understand the workings of those devices, 880 * they must be defined as a specialized subclass of the generic device 881 * types already defined in the libretro API. 882 * 883 * The core must pass an array of const struct retro_controller_info which 884 * is terminated with a blanked out struct. Each element of the 885 * retro_controller_info struct corresponds to the ascending port index 886 * that is passed to retro_set_controller_port_device() when that function 887 * is called to indicate to the core that the frontend has changed the 888 * active device subclass. SEE ALSO: retro_set_controller_port_device() 889 * 890 * The ascending input port indexes provided by the core in the struct 891 * are generally presented by frontends as ascending User # or Player #, 892 * such as Player 1, Player 2, Player 3, etc. Which device subclasses are 893 * supported can vary per input port. 894 * 895 * The first inner element of each entry in the retro_controller_info array 896 * is a retro_controller_description struct that specifies the names and 897 * codes of all device subclasses that are available for the corresponding 898 * User or Player, beginning with the generic Libretro device that the 899 * subclasses are derived from. The second inner element of each entry is the 900 * total number of subclasses that are listed in the retro_controller_description. 901 * 902 * NOTE: Even if special device types are set in the libretro core, 903 * libretro should only poll input based on the base input device types. 904 */ 905 #define RETRO_ENVIRONMENT_SET_MEMORY_MAPS (36 | RETRO_ENVIRONMENT_EXPERIMENTAL) 906 /* const struct retro_memory_map * -- 907 * This environment call lets a libretro core tell the frontend 908 * about the memory maps this core emulates. 909 * This can be used to implement, for example, cheats in a core-agnostic way. 910 * 911 * Should only be used by emulators; it doesn't make much sense for 912 * anything else. 913 * It is recommended to expose all relevant pointers through 914 * retro_get_memory_* as well. 915 * 916 * Can be called from retro_init and retro_load_game. 917 */ 918 #define RETRO_ENVIRONMENT_SET_GEOMETRY 37 919 /* const struct retro_game_geometry * -- 920 * This environment call is similar to SET_SYSTEM_AV_INFO for changing 921 * video parameters, but provides a guarantee that drivers will not be 922 * reinitialized. 923 * This can only be called from within retro_run(). 924 * 925 * The purpose of this call is to allow a core to alter nominal 926 * width/heights as well as aspect ratios on-the-fly, which can be 927 * useful for some emulators to change in run-time. 928 * 929 * max_width/max_height arguments are ignored and cannot be changed 930 * with this call as this could potentially require a reinitialization or a 931 * non-constant time operation. 932 * If max_width/max_height are to be changed, SET_SYSTEM_AV_INFO is required. 933 * 934 * A frontend must guarantee that this environment call completes in 935 * constant time. 936 */ 937 #define RETRO_ENVIRONMENT_GET_USERNAME 38 938 /* const char ** 939 * Returns the specified username of the frontend, if specified by the user. 940 * This username can be used as a nickname for a core that has online facilities 941 * or any other mode where personalization of the user is desirable. 942 * The returned value can be NULL. 943 * If this environ callback is used by a core that requires a valid username, 944 * a default username should be specified by the core. 945 */ 946 #define RETRO_ENVIRONMENT_GET_LANGUAGE 39 947 /* unsigned * -- 948 * Returns the specified language of the frontend, if specified by the user. 949 * It can be used by the core for localization purposes. 950 */ 951 #define RETRO_ENVIRONMENT_GET_CURRENT_SOFTWARE_FRAMEBUFFER (40 | RETRO_ENVIRONMENT_EXPERIMENTAL) 952 /* struct retro_framebuffer * -- 953 * Returns a preallocated framebuffer which the core can use for rendering 954 * the frame into when not using SET_HW_RENDER. 955 * The framebuffer returned from this call must not be used 956 * after the current call to retro_run() returns. 957 * 958 * The goal of this call is to allow zero-copy behavior where a core 959 * can render directly into video memory, avoiding extra bandwidth cost by copying 960 * memory from core to video memory. 961 * 962 * If this call succeeds and the core renders into it, 963 * the framebuffer pointer and pitch can be passed to retro_video_refresh_t. 964 * If the buffer from GET_CURRENT_SOFTWARE_FRAMEBUFFER is to be used, 965 * the core must pass the exact 966 * same pointer as returned by GET_CURRENT_SOFTWARE_FRAMEBUFFER; 967 * i.e. passing a pointer which is offset from the 968 * buffer is undefined. The width, height and pitch parameters 969 * must also match exactly to the values obtained from GET_CURRENT_SOFTWARE_FRAMEBUFFER. 970 * 971 * It is possible for a frontend to return a different pixel format 972 * than the one used in SET_PIXEL_FORMAT. This can happen if the frontend 973 * needs to perform conversion. 974 * 975 * It is still valid for a core to render to a different buffer 976 * even if GET_CURRENT_SOFTWARE_FRAMEBUFFER succeeds. 977 * 978 * A frontend must make sure that the pointer obtained from this function is 979 * writeable (and readable). 980 */ 981 #define RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE (41 | RETRO_ENVIRONMENT_EXPERIMENTAL) 982 /* const struct retro_hw_render_interface ** -- 983 * Returns an API specific rendering interface for accessing API specific data. 984 * Not all HW rendering APIs support or need this. 985 * The contents of the returned pointer is specific to the rendering API 986 * being used. See the various headers like libretro_vulkan.h, etc. 987 * 988 * GET_HW_RENDER_INTERFACE cannot be called before context_reset has been called. 989 * Similarly, after context_destroyed callback returns, 990 * the contents of the HW_RENDER_INTERFACE are invalidated. 991 */ 992 #define RETRO_ENVIRONMENT_SET_SUPPORT_ACHIEVEMENTS (42 | RETRO_ENVIRONMENT_EXPERIMENTAL) 993 /* const bool * -- 994 * If true, the libretro implementation supports achievements 995 * either via memory descriptors set with RETRO_ENVIRONMENT_SET_MEMORY_MAPS 996 * or via retro_get_memory_data/retro_get_memory_size. 997 * 998 * This must be called before the first call to retro_run. 999 */ 1000 #define RETRO_ENVIRONMENT_SET_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE (43 | RETRO_ENVIRONMENT_EXPERIMENTAL) 1001 /* const struct retro_hw_render_context_negotiation_interface * -- 1002 * Sets an interface which lets the libretro core negotiate with frontend how a context is created. 1003 * The semantics of this interface depends on which API is used in SET_HW_RENDER earlier. 1004 * This interface will be used when the frontend is trying to create a HW rendering context, 1005 * so it will be used after SET_HW_RENDER, but before the context_reset callback. 1006 */ 1007 #define RETRO_ENVIRONMENT_SET_SERIALIZATION_QUIRKS 44 1008 /* uint64_t * -- 1009 * Sets quirk flags associated with serialization. The frontend will zero any flags it doesn't 1010 * recognize or support. Should be set in either retro_init or retro_load_game, but not both. 1011 */ 1012 #define RETRO_ENVIRONMENT_SET_HW_SHARED_CONTEXT (44 | RETRO_ENVIRONMENT_EXPERIMENTAL) 1013 /* N/A (null) * -- 1014 * The frontend will try to use a 'shared' hardware context (mostly applicable 1015 * to OpenGL) when a hardware context is being set up. 1016 * 1017 * Returns true if the frontend supports shared hardware contexts and false 1018 * if the frontend does not support shared hardware contexts. 1019 * 1020 * This will do nothing on its own until SET_HW_RENDER env callbacks are 1021 * being used. 1022 */ 1023 #define RETRO_ENVIRONMENT_GET_VFS_INTERFACE (45 | RETRO_ENVIRONMENT_EXPERIMENTAL) 1024 /* struct retro_vfs_interface_info * -- 1025 * Gets access to the VFS interface. 1026 * VFS presence needs to be queried prior to load_game or any 1027 * get_system/save/other_directory being called to let front end know 1028 * core supports VFS before it starts handing out paths. 1029 * It is recomended to do so in retro_set_environment 1030 */ 1031 #define RETRO_ENVIRONMENT_GET_LED_INTERFACE (46 | RETRO_ENVIRONMENT_EXPERIMENTAL) 1032 /* struct retro_led_interface * -- 1033 * Gets an interface which is used by a libretro core to set 1034 * state of LEDs. 1035 */ 1036 #define RETRO_ENVIRONMENT_GET_AUDIO_VIDEO_ENABLE (47 | RETRO_ENVIRONMENT_EXPERIMENTAL) 1037 /* int * -- 1038 * Tells the core if the frontend wants audio or video. 1039 * If disabled, the frontend will discard the audio or video, 1040 * so the core may decide to skip generating a frame or generating audio. 1041 * This is mainly used for increasing performance. 1042 * Bit 0 (value 1): Enable Video 1043 * Bit 1 (value 2): Enable Audio 1044 * Bit 2 (value 4): Use Fast Savestates. 1045 * Bit 3 (value 8): Hard Disable Audio 1046 * Other bits are reserved for future use and will default to zero. 1047 * If video is disabled: 1048 * * The frontend wants the core to not generate any video, 1049 * including presenting frames via hardware acceleration. 1050 * * The frontend's video frame callback will do nothing. 1051 * * After running the frame, the video output of the next frame should be 1052 * no different than if video was enabled, and saving and loading state 1053 * should have no issues. 1054 * If audio is disabled: 1055 * * The frontend wants the core to not generate any audio. 1056 * * The frontend's audio callbacks will do nothing. 1057 * * After running the frame, the audio output of the next frame should be 1058 * no different than if audio was enabled, and saving and loading state 1059 * should have no issues. 1060 * Fast Savestates: 1061 * * Guaranteed to be created by the same binary that will load them. 1062 * * Will not be written to or read from the disk. 1063 * * Suggest that the core assumes loading state will succeed. 1064 * * Suggest that the core updates its memory buffers in-place if possible. 1065 * * Suggest that the core skips clearing memory. 1066 * * Suggest that the core skips resetting the system. 1067 * * Suggest that the core may skip validation steps. 1068 * Hard Disable Audio: 1069 * * Used for a secondary core when running ahead. 1070 * * Indicates that the frontend will never need audio from the core. 1071 * * Suggests that the core may stop synthesizing audio, but this should not 1072 * compromise emulation accuracy. 1073 * * Audio output for the next frame does not matter, and the frontend will 1074 * never need an accurate audio state in the future. 1075 * * State will never be saved when using Hard Disable Audio. 1076 */ 1077 #define RETRO_ENVIRONMENT_GET_MIDI_INTERFACE (48 | RETRO_ENVIRONMENT_EXPERIMENTAL) 1078 /* struct retro_midi_interface ** -- 1079 * Returns a MIDI interface that can be used for raw data I/O. 1080 */ 1081 1082 #define RETRO_ENVIRONMENT_GET_FASTFORWARDING (49 | RETRO_ENVIRONMENT_EXPERIMENTAL) 1083 /* bool * -- 1084 * Boolean value that indicates whether or not the frontend is in 1085 * fastforwarding mode. 1086 */ 1087 1088 #define RETRO_ENVIRONMENT_GET_TARGET_REFRESH_RATE (50 | RETRO_ENVIRONMENT_EXPERIMENTAL) 1089 /* float * -- 1090 * Float value that lets us know what target refresh rate 1091 * is curently in use by the frontend. 1092 * 1093 * The core can use the returned value to set an ideal 1094 * refresh rate/framerate. 1095 */ 1096 1097 #define RETRO_ENVIRONMENT_GET_INPUT_BITMASKS (51 | RETRO_ENVIRONMENT_EXPERIMENTAL) 1098 /* bool * -- 1099 * Boolean value that indicates whether or not the frontend supports 1100 * input bitmasks being returned by retro_input_state_t. The advantage 1101 * of this is that retro_input_state_t has to be only called once to 1102 * grab all button states instead of multiple times. 1103 * 1104 * If it returns true, you can pass RETRO_DEVICE_ID_JOYPAD_MASK as 'id' 1105 * to retro_input_state_t (make sure 'device' is set to RETRO_DEVICE_JOYPAD). 1106 * It will return a bitmask of all the digital buttons. 1107 */ 1108 1109 #define RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION 52 1110 /* unsigned * -- 1111 * Unsigned value is the API version number of the core options 1112 * interface supported by the frontend. If callback return false, 1113 * API version is assumed to be 0. 1114 * 1115 * In legacy code, core options are set by passing an array of 1116 * retro_variable structs to RETRO_ENVIRONMENT_SET_VARIABLES. 1117 * This may be still be done regardless of the core options 1118 * interface version. 1119 * 1120 * If version is >= 1 however, core options may instead be set by 1121 * passing an array of retro_core_option_definition structs to 1122 * RETRO_ENVIRONMENT_SET_CORE_OPTIONS, or a 2D array of 1123 * retro_core_option_definition structs to RETRO_ENVIRONMENT_SET_CORE_OPTIONS_INTL. 1124 * This allows the core to additionally set option sublabel information 1125 * and/or provide localisation support. 1126 */ 1127 1128 #define RETRO_ENVIRONMENT_SET_CORE_OPTIONS 53 1129 /* const struct retro_core_option_definition ** -- 1130 * Allows an implementation to signal the environment 1131 * which variables it might want to check for later using 1132 * GET_VARIABLE. 1133 * This allows the frontend to present these variables to 1134 * a user dynamically. 1135 * This should only be called if RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION 1136 * returns an API version of >= 1. 1137 * This should be called instead of RETRO_ENVIRONMENT_SET_VARIABLES. 1138 * This should be called the first time as early as 1139 * possible (ideally in retro_set_environment). 1140 * Afterwards it may be called again for the core to communicate 1141 * updated options to the frontend, but the number of core 1142 * options must not change from the number in the initial call. 1143 * 1144 * 'data' points to an array of retro_core_option_definition structs 1145 * terminated by a { NULL, NULL, NULL, {{0}}, NULL } element. 1146 * retro_core_option_definition::key should be namespaced to not collide 1147 * with other implementations' keys. e.g. A core called 1148 * 'foo' should use keys named as 'foo_option'. 1149 * retro_core_option_definition::desc should contain a human readable 1150 * description of the key. 1151 * retro_core_option_definition::info should contain any additional human 1152 * readable information text that a typical user may need to 1153 * understand the functionality of the option. 1154 * retro_core_option_definition::values is an array of retro_core_option_value 1155 * structs terminated by a { NULL, NULL } element. 1156 * > retro_core_option_definition::values[index].value is an expected option 1157 * value. 1158 * > retro_core_option_definition::values[index].label is a human readable 1159 * label used when displaying the value on screen. If NULL, 1160 * the value itself is used. 1161 * retro_core_option_definition::default_value is the default core option 1162 * setting. It must match one of the expected option values in the 1163 * retro_core_option_definition::values array. If it does not, or the 1164 * default value is NULL, the first entry in the 1165 * retro_core_option_definition::values array is treated as the default. 1166 * 1167 * The number of possible options should be very limited, 1168 * and must be less than RETRO_NUM_CORE_OPTION_VALUES_MAX. 1169 * i.e. it should be feasible to cycle through options 1170 * without a keyboard. 1171 * 1172 * Example entry: 1173 * { 1174 * "foo_option", 1175 * "Speed hack coprocessor X", 1176 * "Provides increased performance at the expense of reduced accuracy", 1177 * { 1178 * { "false", NULL }, 1179 * { "true", NULL }, 1180 * { "unstable", "Turbo (Unstable)" }, 1181 * { NULL, NULL }, 1182 * }, 1183 * "false" 1184 * } 1185 * 1186 * Only strings are operated on. The possible values will 1187 * generally be displayed and stored as-is by the frontend. 1188 */ 1189 1190 #define RETRO_ENVIRONMENT_SET_CORE_OPTIONS_INTL 54 1191 /* const struct retro_core_options_intl * -- 1192 * Allows an implementation to signal the environment 1193 * which variables it might want to check for later using 1194 * GET_VARIABLE. 1195 * This allows the frontend to present these variables to 1196 * a user dynamically. 1197 * This should only be called if RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION 1198 * returns an API version of >= 1. 1199 * This should be called instead of RETRO_ENVIRONMENT_SET_VARIABLES. 1200 * This should be called the first time as early as 1201 * possible (ideally in retro_set_environment). 1202 * Afterwards it may be called again for the core to communicate 1203 * updated options to the frontend, but the number of core 1204 * options must not change from the number in the initial call. 1205 * 1206 * This is fundamentally the same as RETRO_ENVIRONMENT_SET_CORE_OPTIONS, 1207 * with the addition of localisation support. The description of the 1208 * RETRO_ENVIRONMENT_SET_CORE_OPTIONS callback should be consulted 1209 * for further details. 1210 * 1211 * 'data' points to a retro_core_options_intl struct. 1212 * 1213 * retro_core_options_intl::us is a pointer to an array of 1214 * retro_core_option_definition structs defining the US English 1215 * core options implementation. It must point to a valid array. 1216 * 1217 * retro_core_options_intl::local is a pointer to an array of 1218 * retro_core_option_definition structs defining core options for 1219 * the current frontend language. It may be NULL (in which case 1220 * retro_core_options_intl::us is used by the frontend). Any items 1221 * missing from this array will be read from retro_core_options_intl::us 1222 * instead. 1223 * 1224 * NOTE: Default core option values are always taken from the 1225 * retro_core_options_intl::us array. Any default values in 1226 * retro_core_options_intl::local array will be ignored. 1227 */ 1228 1229 #define RETRO_ENVIRONMENT_SET_CORE_OPTIONS_DISPLAY 55 1230 /* struct retro_core_option_display * -- 1231 * 1232 * Allows an implementation to signal the environment to show 1233 * or hide a variable when displaying core options. This is 1234 * considered a *suggestion*. The frontend is free to ignore 1235 * this callback, and its implementation not considered mandatory. 1236 * 1237 * 'data' points to a retro_core_option_display struct 1238 * 1239 * retro_core_option_display::key is a variable identifier 1240 * which has already been set by SET_VARIABLES/SET_CORE_OPTIONS. 1241 * 1242 * retro_core_option_display::visible is a boolean, specifying 1243 * whether variable should be displayed 1244 * 1245 * Note that all core option variables will be set visible by 1246 * default when calling SET_VARIABLES/SET_CORE_OPTIONS. 1247 */ 1248 1249 /* VFS functionality */ 1250 1251 /* File paths: 1252 * File paths passed as parameters when using this API shall be well formed UNIX-style, 1253 * using "/" (unquoted forward slash) as directory separator regardless of the platform's native separator. 1254 * Paths shall also include at least one forward slash ("game.bin" is an invalid path, use "./game.bin" instead). 1255 * Other than the directory separator, cores shall not make assumptions about path format: 1256 * "C:/path/game.bin", "http://example.com/game.bin", "#game/game.bin", "./game.bin" (without quotes) are all valid paths. 1257 * Cores may replace the basename or remove path components from the end, and/or add new components; 1258 * however, cores shall not append "./", "../" or multiple consecutive forward slashes ("//") to paths they request to front end. 1259 * 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. 1260 * Frontends are encouraged, but not required, to support native file system paths (modulo replacing the directory separator, if applicable). 1261 * Cores are allowed to try using them, but must remain functional if the front rejects such requests. 1262 * Cores are encouraged to use the libretro-common filestream functions for file I/O, 1263 * as they seamlessly integrate with VFS, deal with directory separator replacement as appropriate 1264 * and provide platform-specific fallbacks in cases where front ends do not support VFS. */ 1265 1266 /* Opaque file handle 1267 * Introduced in VFS API v1 */ 1268 struct retro_vfs_file_handle; 1269 1270 /* Opaque directory handle 1271 * Introduced in VFS API v3 */ 1272 struct retro_vfs_dir_handle; 1273 1274 /* File open flags 1275 * Introduced in VFS API v1 */ 1276 #define RETRO_VFS_FILE_ACCESS_READ (1 << 0) /* Read only mode */ 1277 #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 */ 1278 #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*/ 1279 #define RETRO_VFS_FILE_ACCESS_UPDATE_EXISTING (1 << 2) /* Prevents discarding content of existing files opened for writing */ 1280 1281 /* These are only hints. The frontend may choose to ignore them. Other than RAM/CPU/etc use, 1282 and how they react to unlikely external interference (for example someone else writing to that file, 1283 or the file's server going down), behavior will not change. */ 1284 #define RETRO_VFS_FILE_ACCESS_HINT_NONE (0) 1285 /* Indicate that the file will be accessed many times. The frontend should aggressively cache everything. */ 1286 #define RETRO_VFS_FILE_ACCESS_HINT_FREQUENT_ACCESS (1 << 0) 1287 1288 /* Seek positions */ 1289 #define RETRO_VFS_SEEK_POSITION_START 0 1290 #define RETRO_VFS_SEEK_POSITION_CURRENT 1 1291 #define RETRO_VFS_SEEK_POSITION_END 2 1292 1293 /* stat() result flags 1294 * Introduced in VFS API v3 */ 1295 #define RETRO_VFS_STAT_IS_VALID (1 << 0) 1296 #define RETRO_VFS_STAT_IS_DIRECTORY (1 << 1) 1297 #define RETRO_VFS_STAT_IS_CHARACTER_SPECIAL (1 << 2) 1298 1299 /* Get path from opaque handle. Returns the exact same path passed to file_open when getting the handle 1300 * Introduced in VFS API v1 */ 1301 typedef const char *(RETRO_CALLCONV *retro_vfs_get_path_t)(struct retro_vfs_file_handle *stream); 1302 1303 /* Open a file for reading or writing. If path points to a directory, this will 1304 * fail. Returns the opaque file handle, or NULL for error. 1305 * Introduced in VFS API v1 */ 1306 typedef struct retro_vfs_file_handle *(RETRO_CALLCONV *retro_vfs_open_t)(const char *path, unsigned mode, unsigned hints); 1307 1308 /* Close the file and release its resources. Must be called if open_file returns non-NULL. Returns 0 on success, -1 on failure. 1309 * Whether the call succeeds ot not, the handle passed as parameter becomes invalid and should no longer be used. 1310 * Introduced in VFS API v1 */ 1311 typedef int (RETRO_CALLCONV *retro_vfs_close_t)(struct retro_vfs_file_handle *stream); 1312 1313 /* Return the size of the file in bytes, or -1 for error. 1314 * Introduced in VFS API v1 */ 1315 typedef int64_t (RETRO_CALLCONV *retro_vfs_size_t)(struct retro_vfs_file_handle *stream); 1316 1317 /* Truncate file to specified size. Returns 0 on success or -1 on error 1318 * Introduced in VFS API v2 */ 1319 typedef int64_t (RETRO_CALLCONV *retro_vfs_truncate_t)(struct retro_vfs_file_handle *stream, int64_t length); 1320 1321 /* Get the current read / write position for the file. Returns -1 for error. 1322 * Introduced in VFS API v1 */ 1323 typedef int64_t (RETRO_CALLCONV *retro_vfs_tell_t)(struct retro_vfs_file_handle *stream); 1324 1325 /* Set the current read/write position for the file. Returns the new position, -1 for error. 1326 * Introduced in VFS API v1 */ 1327 typedef int64_t (RETRO_CALLCONV *retro_vfs_seek_t)(struct retro_vfs_file_handle *stream, int64_t offset, int seek_position); 1328 1329 /* Read data from a file. Returns the number of bytes read, or -1 for error. 1330 * Introduced in VFS API v1 */ 1331 typedef int64_t (RETRO_CALLCONV *retro_vfs_read_t)(struct retro_vfs_file_handle *stream, void *s, uint64_t len); 1332 1333 /* Write data to a file. Returns the number of bytes written, or -1 for error. 1334 * Introduced in VFS API v1 */ 1335 typedef int64_t (RETRO_CALLCONV *retro_vfs_write_t)(struct retro_vfs_file_handle *stream, const void *s, uint64_t len); 1336 1337 /* Flush pending writes to file, if using buffered IO. Returns 0 on sucess, or -1 on failure. 1338 * Introduced in VFS API v1 */ 1339 typedef int (RETRO_CALLCONV *retro_vfs_flush_t)(struct retro_vfs_file_handle *stream); 1340 1341 /* Delete the specified file. Returns 0 on success, -1 on failure 1342 * Introduced in VFS API v1 */ 1343 typedef int (RETRO_CALLCONV *retro_vfs_remove_t)(const char *path); 1344 1345 /* Rename the specified file. Returns 0 on success, -1 on failure 1346 * Introduced in VFS API v1 */ 1347 typedef int (RETRO_CALLCONV *retro_vfs_rename_t)(const char *old_path, const char *new_path); 1348 1349 /* Stat the specified file. Retruns a bitmask of RETRO_VFS_STAT_* flags, none are set if path was not valid. 1350 * Additionally stores file size in given variable, unless NULL is given. 1351 * Introduced in VFS API v3 */ 1352 typedef int (RETRO_CALLCONV *retro_vfs_stat_t)(const char *path, int32_t *size); 1353 1354 /* Create the specified directory. Returns 0 on success, -1 on unknown failure, -2 if already exists. 1355 * Introduced in VFS API v3 */ 1356 typedef int (RETRO_CALLCONV *retro_vfs_mkdir_t)(const char *dir); 1357 1358 /* Open the specified directory for listing. Returns the opaque dir handle, or NULL for error. 1359 * Support for the include_hidden argument may vary depending on the platform. 1360 * Introduced in VFS API v3 */ 1361 typedef struct retro_vfs_dir_handle *(RETRO_CALLCONV *retro_vfs_opendir_t)(const char *dir, bool include_hidden); 1362 1363 /* Read the directory entry at the current position, and move the read pointer to the next position. 1364 * Returns true on success, false if already on the last entry. 1365 * Introduced in VFS API v3 */ 1366 typedef bool (RETRO_CALLCONV *retro_vfs_readdir_t)(struct retro_vfs_dir_handle *dirstream); 1367 1368 /* Get the name of the last entry read. Returns a string on success, or NULL for error. 1369 * The returned string pointer is valid until the next call to readdir or closedir. 1370 * Introduced in VFS API v3 */ 1371 typedef const char *(RETRO_CALLCONV *retro_vfs_dirent_get_name_t)(struct retro_vfs_dir_handle *dirstream); 1372 1373 /* Check if the last entry read was a directory. Returns true if it was, false otherwise (or on error). 1374 * Introduced in VFS API v3 */ 1375 typedef bool (RETRO_CALLCONV *retro_vfs_dirent_is_dir_t)(struct retro_vfs_dir_handle *dirstream); 1376 1377 /* Close the directory and release its resources. Must be called if opendir returns non-NULL. Returns 0 on success, -1 on failure. 1378 * Whether the call succeeds ot not, the handle passed as parameter becomes invalid and should no longer be used. 1379 * Introduced in VFS API v3 */ 1380 typedef int (RETRO_CALLCONV *retro_vfs_closedir_t)(struct retro_vfs_dir_handle *dirstream); 1381 1382 struct retro_vfs_interface 1383 { 1384 /* VFS API v1 */ 1385 retro_vfs_get_path_t get_path; 1386 retro_vfs_open_t open; 1387 retro_vfs_close_t close; 1388 retro_vfs_size_t size; 1389 retro_vfs_tell_t tell; 1390 retro_vfs_seek_t seek; 1391 retro_vfs_read_t read; 1392 retro_vfs_write_t write; 1393 retro_vfs_flush_t flush; 1394 retro_vfs_remove_t remove; 1395 retro_vfs_rename_t rename; 1396 /* VFS API v2 */ 1397 retro_vfs_truncate_t truncate; 1398 /* VFS API v3 */ 1399 retro_vfs_stat_t stat; 1400 retro_vfs_mkdir_t mkdir; 1401 retro_vfs_opendir_t opendir; 1402 retro_vfs_readdir_t readdir; 1403 retro_vfs_dirent_get_name_t dirent_get_name; 1404 retro_vfs_dirent_is_dir_t dirent_is_dir; 1405 retro_vfs_closedir_t closedir; 1406 }; 1407 1408 struct retro_vfs_interface_info 1409 { 1410 /* Set by core: should this be higher than the version the front end supports, 1411 * front end will return false in the RETRO_ENVIRONMENT_GET_VFS_INTERFACE call 1412 * Introduced in VFS API v1 */ 1413 uint32_t required_interface_version; 1414 1415 /* Frontend writes interface pointer here. The frontend also sets the actual 1416 * version, must be at least required_interface_version. 1417 * Introduced in VFS API v1 */ 1418 struct retro_vfs_interface *iface; 1419 }; 1420 1421 enum retro_hw_render_interface_type 1422 { 1423 RETRO_HW_RENDER_INTERFACE_VULKAN = 0, 1424 RETRO_HW_RENDER_INTERFACE_D3D9 = 1, 1425 RETRO_HW_RENDER_INTERFACE_D3D10 = 2, 1426 RETRO_HW_RENDER_INTERFACE_D3D11 = 3, 1427 RETRO_HW_RENDER_INTERFACE_D3D12 = 4, 1428 RETRO_HW_RENDER_INTERFACE_GSKIT_PS2 = 5, 1429 RETRO_HW_RENDER_INTERFACE_DUMMY = INT_MAX 1430 }; 1431 1432 /* Base struct. All retro_hw_render_interface_* types 1433 * contain at least these fields. */ 1434 struct retro_hw_render_interface 1435 { 1436 enum retro_hw_render_interface_type interface_type; 1437 unsigned interface_version; 1438 }; 1439 1440 typedef void (RETRO_CALLCONV *retro_set_led_state_t)(int led, int state); 1441 struct retro_led_interface 1442 { 1443 retro_set_led_state_t set_led_state; 1444 }; 1445 1446 /* Retrieves the current state of the MIDI input. 1447 * Returns true if it's enabled, false otherwise. */ 1448 typedef bool (RETRO_CALLCONV *retro_midi_input_enabled_t)(void); 1449 1450 /* Retrieves the current state of the MIDI output. 1451 * Returns true if it's enabled, false otherwise */ 1452 typedef bool (RETRO_CALLCONV *retro_midi_output_enabled_t)(void); 1453 1454 /* Reads next byte from the input stream. 1455 * Returns true if byte is read, false otherwise. */ 1456 typedef bool (RETRO_CALLCONV *retro_midi_read_t)(uint8_t *byte); 1457 1458 /* Writes byte to the output stream. 1459 * 'delta_time' is in microseconds and represent time elapsed since previous write. 1460 * Returns true if byte is written, false otherwise. */ 1461 typedef bool (RETRO_CALLCONV *retro_midi_write_t)(uint8_t byte, uint32_t delta_time); 1462 1463 /* Flushes previously written data. 1464 * Returns true if successful, false otherwise. */ 1465 typedef bool (RETRO_CALLCONV *retro_midi_flush_t)(void); 1466 1467 struct retro_midi_interface 1468 { 1469 retro_midi_input_enabled_t input_enabled; 1470 retro_midi_output_enabled_t output_enabled; 1471 retro_midi_read_t read; 1472 retro_midi_write_t write; 1473 retro_midi_flush_t flush; 1474 }; 1475 1476 enum retro_hw_render_context_negotiation_interface_type 1477 { 1478 RETRO_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE_VULKAN = 0, 1479 RETRO_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE_DUMMY = INT_MAX 1480 }; 1481 1482 /* Base struct. All retro_hw_render_context_negotiation_interface_* types 1483 * contain at least these fields. */ 1484 struct retro_hw_render_context_negotiation_interface 1485 { 1486 enum retro_hw_render_context_negotiation_interface_type interface_type; 1487 unsigned interface_version; 1488 }; 1489 1490 /* Serialized state is incomplete in some way. Set if serialization is 1491 * usable in typical end-user cases but should not be relied upon to 1492 * implement frame-sensitive frontend features such as netplay or 1493 * rerecording. */ 1494 #define RETRO_SERIALIZATION_QUIRK_INCOMPLETE (1 << 0) 1495 /* The core must spend some time initializing before serialization is 1496 * supported. retro_serialize() will initially fail; retro_unserialize() 1497 * and retro_serialize_size() may or may not work correctly either. */ 1498 #define RETRO_SERIALIZATION_QUIRK_MUST_INITIALIZE (1 << 1) 1499 /* Serialization size may change within a session. */ 1500 #define RETRO_SERIALIZATION_QUIRK_CORE_VARIABLE_SIZE (1 << 2) 1501 /* Set by the frontend to acknowledge that it supports variable-sized 1502 * states. */ 1503 #define RETRO_SERIALIZATION_QUIRK_FRONT_VARIABLE_SIZE (1 << 3) 1504 /* Serialized state can only be loaded during the same session. */ 1505 #define RETRO_SERIALIZATION_QUIRK_SINGLE_SESSION (1 << 4) 1506 /* Serialized state cannot be loaded on an architecture with a different 1507 * endianness from the one it was saved on. */ 1508 #define RETRO_SERIALIZATION_QUIRK_ENDIAN_DEPENDENT (1 << 5) 1509 /* Serialized state cannot be loaded on a different platform from the one it 1510 * was saved on for reasons other than endianness, such as word size 1511 * dependence */ 1512 #define RETRO_SERIALIZATION_QUIRK_PLATFORM_DEPENDENT (1 << 6) 1513 1514 #define RETRO_MEMDESC_CONST (1 << 0) /* The frontend will never change this memory area once retro_load_game has returned. */ 1515 #define RETRO_MEMDESC_BIGENDIAN (1 << 1) /* The memory area contains big endian data. Default is little endian. */ 1516 #define RETRO_MEMDESC_SYSTEM_RAM (1 << 2) /* The memory area is system RAM. This is main RAM of the gaming system. */ 1517 #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. */ 1518 #define RETRO_MEMDESC_VIDEO_RAM (1 << 4) /* The memory area is video RAM (VRAM) */ 1519 #define RETRO_MEMDESC_ALIGN_2 (1 << 16) /* All memory access in this area is aligned to their own size, or 2, whichever is smaller. */ 1520 #define RETRO_MEMDESC_ALIGN_4 (2 << 16) 1521 #define RETRO_MEMDESC_ALIGN_8 (3 << 16) 1522 #define RETRO_MEMDESC_MINSIZE_2 (1 << 24) /* All memory in this region is accessed at least 2 bytes at the time. */ 1523 #define RETRO_MEMDESC_MINSIZE_4 (2 << 24) 1524 #define RETRO_MEMDESC_MINSIZE_8 (3 << 24) 1525 struct retro_memory_descriptor 1526 { 1527 uint64_t flags; 1528 1529 /* Pointer to the start of the relevant ROM or RAM chip. 1530 * It's strongly recommended to use 'offset' if possible, rather than 1531 * doing math on the pointer. 1532 * 1533 * If the same byte is mapped my multiple descriptors, their descriptors 1534 * must have the same pointer. 1535 * If 'start' does not point to the first byte in the pointer, put the 1536 * difference in 'offset' instead. 1537 * 1538 * May be NULL if there's nothing usable here (e.g. hardware registers and 1539 * open bus). No flags should be set if the pointer is NULL. 1540 * It's recommended to minimize the number of descriptors if possible, 1541 * but not mandatory. */ 1542 void *ptr; 1543 size_t offset; 1544 1545 /* This is the location in the emulated address space 1546 * where the mapping starts. */ 1547 size_t start; 1548 1549 /* Which bits must be same as in 'start' for this mapping to apply. 1550 * The first memory descriptor to claim a certain byte is the one 1551 * that applies. 1552 * A bit which is set in 'start' must also be set in this. 1553 * Can be zero, in which case each byte is assumed mapped exactly once. 1554 * In this case, 'len' must be a power of two. */ 1555 size_t select; 1556 1557 /* If this is nonzero, the set bits are assumed not connected to the 1558 * memory chip's address pins. */ 1559 size_t disconnect; 1560 1561 /* This one tells the size of the current memory area. 1562 * If, after start+disconnect are applied, the address is higher than 1563 * this, the highest bit of the address is cleared. 1564 * 1565 * If the address is still too high, the next highest bit is cleared. 1566 * Can be zero, in which case it's assumed to be infinite (as limited 1567 * by 'select' and 'disconnect'). */ 1568 size_t len; 1569 1570 /* To go from emulated address to physical address, the following 1571 * order applies: 1572 * Subtract 'start', pick off 'disconnect', apply 'len', add 'offset'. */ 1573 1574 /* The address space name must consist of only a-zA-Z0-9_-, 1575 * should be as short as feasible (maximum length is 8 plus the NUL), 1576 * and may not be any other address space plus one or more 0-9A-F 1577 * at the end. 1578 * However, multiple memory descriptors for the same address space is 1579 * allowed, and the address space name can be empty. NULL is treated 1580 * as empty. 1581 * 1582 * Address space names are case sensitive, but avoid lowercase if possible. 1583 * The same pointer may exist in multiple address spaces. 1584 * 1585 * Examples: 1586 * blank+blank - valid (multiple things may be mapped in the same namespace) 1587 * 'Sp'+'Sp' - valid (multiple things may be mapped in the same namespace) 1588 * 'A'+'B' - valid (neither is a prefix of each other) 1589 * 'S'+blank - valid ('S' is not in 0-9A-F) 1590 * 'a'+blank - valid ('a' is not in 0-9A-F) 1591 * 'a'+'A' - valid (neither is a prefix of each other) 1592 * 'AR'+blank - valid ('R' is not in 0-9A-F) 1593 * 'ARB'+blank - valid (the B can't be part of the address either, because 1594 * there is no namespace 'AR') 1595 * blank+'B' - not valid, because it's ambigous which address space B1234 1596 * would refer to. 1597 * The length can't be used for that purpose; the frontend may want 1598 * to append arbitrary data to an address, without a separator. */ 1599 const char *addrspace; 1600 1601 /* TODO: When finalizing this one, add a description field, which should be 1602 * "WRAM" or something roughly equally long. */ 1603 1604 /* TODO: When finalizing this one, replace 'select' with 'limit', which tells 1605 * which bits can vary and still refer to the same address (limit = ~select). 1606 * TODO: limit? range? vary? something else? */ 1607 1608 /* TODO: When finalizing this one, if 'len' is above what 'select' (or 1609 * 'limit') allows, it's bankswitched. Bankswitched data must have both 'len' 1610 * and 'select' != 0, and the mappings don't tell how the system switches the 1611 * banks. */ 1612 1613 /* TODO: When finalizing this one, fix the 'len' bit removal order. 1614 * For len=0x1800, pointer 0x1C00 should go to 0x1400, not 0x0C00. 1615 * Algorithm: Take bits highest to lowest, but if it goes above len, clear 1616 * the most recent addition and continue on the next bit. 1617 * TODO: Can the above be optimized? Is "remove the lowest bit set in both 1618 * pointer and 'len'" equivalent? */ 1619 1620 /* TODO: Some emulators (MAME?) emulate big endian systems by only accessing 1621 * the emulated memory in 32-bit chunks, native endian. But that's nothing 1622 * compared to Darek Mihocka <http://www.emulators.com/docs/nx07_vm101.htm> 1623 * (section Emulation 103 - Nearly Free Byte Reversal) - he flips the ENTIRE 1624 * RAM backwards! I'll want to represent both of those, via some flags. 1625 * 1626 * I suspect MAME either didn't think of that idea, or don't want the #ifdef. 1627 * Not sure which, nor do I really care. */ 1628 1629 /* TODO: Some of those flags are unused and/or don't really make sense. Clean 1630 * them up. */ 1631 }; 1632 1633 /* The frontend may use the largest value of 'start'+'select' in a 1634 * certain namespace to infer the size of the address space. 1635 * 1636 * If the address space is larger than that, a mapping with .ptr=NULL 1637 * should be at the end of the array, with .select set to all ones for 1638 * as long as the address space is big. 1639 * 1640 * Sample descriptors (minus .ptr, and RETRO_MEMFLAG_ on the flags): 1641 * SNES WRAM: 1642 * .start=0x7E0000, .len=0x20000 1643 * (Note that this must be mapped before the ROM in most cases; some of the 1644 * ROM mappers 1645 * try to claim $7E0000, or at least $7E8000.) 1646 * SNES SPC700 RAM: 1647 * .addrspace="S", .len=0x10000 1648 * SNES WRAM mirrors: 1649 * .flags=MIRROR, .start=0x000000, .select=0xC0E000, .len=0x2000 1650 * .flags=MIRROR, .start=0x800000, .select=0xC0E000, .len=0x2000 1651 * SNES WRAM mirrors, alternate equivalent descriptor: 1652 * .flags=MIRROR, .select=0x40E000, .disconnect=~0x1FFF 1653 * (Various similar constructions can be created by combining parts of 1654 * the above two.) 1655 * SNES LoROM (512KB, mirrored a couple of times): 1656 * .flags=CONST, .start=0x008000, .select=0x408000, .disconnect=0x8000, .len=512*1024 1657 * .flags=CONST, .start=0x400000, .select=0x400000, .disconnect=0x8000, .len=512*1024 1658 * SNES HiROM (4MB): 1659 * .flags=CONST, .start=0x400000, .select=0x400000, .len=4*1024*1024 1660 * .flags=CONST, .offset=0x8000, .start=0x008000, .select=0x408000, .len=4*1024*1024 1661 * SNES ExHiROM (8MB): 1662 * .flags=CONST, .offset=0, .start=0xC00000, .select=0xC00000, .len=4*1024*1024 1663 * .flags=CONST, .offset=4*1024*1024, .start=0x400000, .select=0xC00000, .len=4*1024*1024 1664 * .flags=CONST, .offset=0x8000, .start=0x808000, .select=0xC08000, .len=4*1024*1024 1665 * .flags=CONST, .offset=4*1024*1024+0x8000, .start=0x008000, .select=0xC08000, .len=4*1024*1024 1666 * Clarify the size of the address space: 1667 * .ptr=NULL, .select=0xFFFFFF 1668 * .len can be implied by .select in many of them, but was included for clarity. 1669 */ 1670 1671 struct retro_memory_map 1672 { 1673 const struct retro_memory_descriptor *descriptors; 1674 unsigned num_descriptors; 1675 }; 1676 1677 struct retro_controller_description 1678 { 1679 /* Human-readable description of the controller. Even if using a generic 1680 * input device type, this can be set to the particular device type the 1681 * core uses. */ 1682 const char *desc; 1683 1684 /* Device type passed to retro_set_controller_port_device(). If the device 1685 * type is a sub-class of a generic input device type, use the 1686 * RETRO_DEVICE_SUBCLASS macro to create an ID. 1687 * 1688 * E.g. RETRO_DEVICE_SUBCLASS(RETRO_DEVICE_JOYPAD, 1). */ 1689 unsigned id; 1690 }; 1691 1692 struct retro_controller_info 1693 { 1694 const struct retro_controller_description *types; 1695 unsigned num_types; 1696 }; 1697 1698 struct retro_subsystem_memory_info 1699 { 1700 /* The extension associated with a memory type, e.g. "psram". */ 1701 const char *extension; 1702 1703 /* The memory type for retro_get_memory(). This should be at 1704 * least 0x100 to avoid conflict with standardized 1705 * libretro memory types. */ 1706 unsigned type; 1707 }; 1708 1709 struct retro_subsystem_rom_info 1710 { 1711 /* Describes what the content is (SGB BIOS, GB ROM, etc). */ 1712 const char *desc; 1713 1714 /* Same definition as retro_get_system_info(). */ 1715 const char *valid_extensions; 1716 1717 /* Same definition as retro_get_system_info(). */ 1718 bool need_fullpath; 1719 1720 /* Same definition as retro_get_system_info(). */ 1721 bool block_extract; 1722 1723 /* This is set if the content is required to load a game. 1724 * If this is set to false, a zeroed-out retro_game_info can be passed. */ 1725 bool required; 1726 1727 /* Content can have multiple associated persistent 1728 * memory types (retro_get_memory()). */ 1729 const struct retro_subsystem_memory_info *memory; 1730 unsigned num_memory; 1731 }; 1732 1733 struct retro_subsystem_info 1734 { 1735 /* Human-readable string of the subsystem type, e.g. "Super GameBoy" */ 1736 const char *desc; 1737 1738 /* A computer friendly short string identifier for the subsystem type. 1739 * This name must be [a-z]. 1740 * E.g. if desc is "Super GameBoy", this can be "sgb". 1741 * This identifier can be used for command-line interfaces, etc. 1742 */ 1743 const char *ident; 1744 1745 /* Infos for each content file. The first entry is assumed to be the 1746 * "most significant" content for frontend purposes. 1747 * E.g. with Super GameBoy, the first content should be the GameBoy ROM, 1748 * as it is the most "significant" content to a user. 1749 * If a frontend creates new file paths based on the content used 1750 * (e.g. savestates), it should use the path for the first ROM to do so. */ 1751 const struct retro_subsystem_rom_info *roms; 1752 1753 /* Number of content files associated with a subsystem. */ 1754 unsigned num_roms; 1755 1756 /* The type passed to retro_load_game_special(). */ 1757 unsigned id; 1758 }; 1759 1760 typedef void (RETRO_CALLCONV *retro_proc_address_t)(void); 1761 1762 /* libretro API extension functions: 1763 * (None here so far). 1764 * 1765 * Get a symbol from a libretro core. 1766 * Cores should only return symbols which are actual 1767 * extensions to the libretro API. 1768 * 1769 * Frontends should not use this to obtain symbols to standard 1770 * libretro entry points (static linking or dlsym). 1771 * 1772 * The symbol name must be equal to the function name, 1773 * e.g. if void retro_foo(void); exists, the symbol must be called "retro_foo". 1774 * The returned function pointer must be cast to the corresponding type. 1775 */ 1776 typedef retro_proc_address_t (RETRO_CALLCONV *retro_get_proc_address_t)(const char *sym); 1777 1778 struct retro_get_proc_address_interface 1779 { 1780 retro_get_proc_address_t get_proc_address; 1781 }; 1782 1783 enum retro_log_level 1784 { 1785 RETRO_LOG_DEBUG = 0, 1786 RETRO_LOG_INFO, 1787 RETRO_LOG_WARN, 1788 RETRO_LOG_ERROR, 1789 1790 RETRO_LOG_DUMMY = INT_MAX 1791 }; 1792 1793 /* Logging function. Takes log level argument as well. */ 1794 typedef void (RETRO_CALLCONV *retro_log_printf_t)(enum retro_log_level level, 1795 const char *fmt, ...); 1796 1797 struct retro_log_callback 1798 { 1799 retro_log_printf_t log; 1800 }; 1801 1802 /* Performance related functions */ 1803 1804 /* ID values for SIMD CPU features */ 1805 #define RETRO_SIMD_SSE (1 << 0) 1806 #define RETRO_SIMD_SSE2 (1 << 1) 1807 #define RETRO_SIMD_VMX (1 << 2) 1808 #define RETRO_SIMD_VMX128 (1 << 3) 1809 #define RETRO_SIMD_AVX (1 << 4) 1810 #define RETRO_SIMD_NEON (1 << 5) 1811 #define RETRO_SIMD_SSE3 (1 << 6) 1812 #define RETRO_SIMD_SSSE3 (1 << 7) 1813 #define RETRO_SIMD_MMX (1 << 8) 1814 #define RETRO_SIMD_MMXEXT (1 << 9) 1815 #define RETRO_SIMD_SSE4 (1 << 10) 1816 #define RETRO_SIMD_SSE42 (1 << 11) 1817 #define RETRO_SIMD_AVX2 (1 << 12) 1818 #define RETRO_SIMD_VFPU (1 << 13) 1819 #define RETRO_SIMD_PS (1 << 14) 1820 #define RETRO_SIMD_AES (1 << 15) 1821 #define RETRO_SIMD_VFPV3 (1 << 16) 1822 #define RETRO_SIMD_VFPV4 (1 << 17) 1823 #define RETRO_SIMD_POPCNT (1 << 18) 1824 #define RETRO_SIMD_MOVBE (1 << 19) 1825 #define RETRO_SIMD_CMOV (1 << 20) 1826 #define RETRO_SIMD_ASIMD (1 << 21) 1827 1828 typedef uint64_t retro_perf_tick_t; 1829 typedef int64_t retro_time_t; 1830 1831 struct retro_perf_counter 1832 { 1833 const char *ident; 1834 retro_perf_tick_t start; 1835 retro_perf_tick_t total; 1836 retro_perf_tick_t call_cnt; 1837 1838 bool registered; 1839 }; 1840 1841 /* Returns current time in microseconds. 1842 * Tries to use the most accurate timer available. 1843 */ 1844 typedef retro_time_t (RETRO_CALLCONV *retro_perf_get_time_usec_t)(void); 1845 1846 /* A simple counter. Usually nanoseconds, but can also be CPU cycles. 1847 * Can be used directly if desired (when creating a more sophisticated 1848 * performance counter system). 1849 * */ 1850 typedef retro_perf_tick_t (RETRO_CALLCONV *retro_perf_get_counter_t)(void); 1851 1852 /* Returns a bit-mask of detected CPU features (RETRO_SIMD_*). */ 1853 typedef uint64_t (RETRO_CALLCONV *retro_get_cpu_features_t)(void); 1854 1855 /* Asks frontend to log and/or display the state of performance counters. 1856 * Performance counters can always be poked into manually as well. 1857 */ 1858 typedef void (RETRO_CALLCONV *retro_perf_log_t)(void); 1859 1860 /* Register a performance counter. 1861 * ident field must be set with a discrete value and other values in 1862 * retro_perf_counter must be 0. 1863 * Registering can be called multiple times. To avoid calling to 1864 * frontend redundantly, you can check registered field first. */ 1865 typedef void (RETRO_CALLCONV *retro_perf_register_t)(struct retro_perf_counter *counter); 1866 1867 /* Starts a registered counter. */ 1868 typedef void (RETRO_CALLCONV *retro_perf_start_t)(struct retro_perf_counter *counter); 1869 1870 /* Stops a registered counter. */ 1871 typedef void (RETRO_CALLCONV *retro_perf_stop_t)(struct retro_perf_counter *counter); 1872 1873 /* For convenience it can be useful to wrap register, start and stop in macros. 1874 * E.g.: 1875 * #ifdef LOG_PERFORMANCE 1876 * #define RETRO_PERFORMANCE_INIT(perf_cb, name) static struct retro_perf_counter name = {#name}; if (!name.registered) perf_cb.perf_register(&(name)) 1877 * #define RETRO_PERFORMANCE_START(perf_cb, name) perf_cb.perf_start(&(name)) 1878 * #define RETRO_PERFORMANCE_STOP(perf_cb, name) perf_cb.perf_stop(&(name)) 1879 * #else 1880 * ... Blank macros ... 1881 * #endif 1882 * 1883 * These can then be used mid-functions around code snippets. 1884 * 1885 * extern struct retro_perf_callback perf_cb; * Somewhere in the core. 1886 * 1887 * void do_some_heavy_work(void) 1888 * { 1889 * RETRO_PERFORMANCE_INIT(cb, work_1; 1890 * RETRO_PERFORMANCE_START(cb, work_1); 1891 * heavy_work_1(); 1892 * RETRO_PERFORMANCE_STOP(cb, work_1); 1893 * 1894 * RETRO_PERFORMANCE_INIT(cb, work_2); 1895 * RETRO_PERFORMANCE_START(cb, work_2); 1896 * heavy_work_2(); 1897 * RETRO_PERFORMANCE_STOP(cb, work_2); 1898 * } 1899 * 1900 * void retro_deinit(void) 1901 * { 1902 * perf_cb.perf_log(); * Log all perf counters here for example. 1903 * } 1904 */ 1905 1906 struct retro_perf_callback 1907 { 1908 retro_perf_get_time_usec_t get_time_usec; 1909 retro_get_cpu_features_t get_cpu_features; 1910 1911 retro_perf_get_counter_t get_perf_counter; 1912 retro_perf_register_t perf_register; 1913 retro_perf_start_t perf_start; 1914 retro_perf_stop_t perf_stop; 1915 retro_perf_log_t perf_log; 1916 }; 1917 1918 /* FIXME: Document the sensor API and work out behavior. 1919 * It will be marked as experimental until then. 1920 */ 1921 enum retro_sensor_action 1922 { 1923 RETRO_SENSOR_ACCELEROMETER_ENABLE = 0, 1924 RETRO_SENSOR_ACCELEROMETER_DISABLE, 1925 1926 RETRO_SENSOR_DUMMY = INT_MAX 1927 }; 1928 1929 /* Id values for SENSOR types. */ 1930 #define RETRO_SENSOR_ACCELEROMETER_X 0 1931 #define RETRO_SENSOR_ACCELEROMETER_Y 1 1932 #define RETRO_SENSOR_ACCELEROMETER_Z 2 1933 1934 typedef bool (RETRO_CALLCONV *retro_set_sensor_state_t)(unsigned port, 1935 enum retro_sensor_action action, unsigned rate); 1936 1937 typedef float (RETRO_CALLCONV *retro_sensor_get_input_t)(unsigned port, unsigned id); 1938 1939 struct retro_sensor_interface 1940 { 1941 retro_set_sensor_state_t set_sensor_state; 1942 retro_sensor_get_input_t get_sensor_input; 1943 }; 1944 1945 enum retro_camera_buffer 1946 { 1947 RETRO_CAMERA_BUFFER_OPENGL_TEXTURE = 0, 1948 RETRO_CAMERA_BUFFER_RAW_FRAMEBUFFER, 1949 1950 RETRO_CAMERA_BUFFER_DUMMY = INT_MAX 1951 }; 1952 1953 /* Starts the camera driver. Can only be called in retro_run(). */ 1954 typedef bool (RETRO_CALLCONV *retro_camera_start_t)(void); 1955 1956 /* Stops the camera driver. Can only be called in retro_run(). */ 1957 typedef void (RETRO_CALLCONV *retro_camera_stop_t)(void); 1958 1959 /* Callback which signals when the camera driver is initialized 1960 * and/or deinitialized. 1961 * retro_camera_start_t can be called in initialized callback. 1962 */ 1963 typedef void (RETRO_CALLCONV *retro_camera_lifetime_status_t)(void); 1964 1965 /* A callback for raw framebuffer data. buffer points to an XRGB8888 buffer. 1966 * Width, height and pitch are similar to retro_video_refresh_t. 1967 * First pixel is top-left origin. 1968 */ 1969 typedef void (RETRO_CALLCONV *retro_camera_frame_raw_framebuffer_t)(const uint32_t *buffer, 1970 unsigned width, unsigned height, size_t pitch); 1971 1972 /* A callback for when OpenGL textures are used. 1973 * 1974 * texture_id is a texture owned by camera driver. 1975 * Its state or content should be considered immutable, except for things like 1976 * texture filtering and clamping. 1977 * 1978 * texture_target is the texture target for the GL texture. 1979 * These can include e.g. GL_TEXTURE_2D, GL_TEXTURE_RECTANGLE, and possibly 1980 * more depending on extensions. 1981 * 1982 * affine points to a packed 3x3 column-major matrix used to apply an affine 1983 * transform to texture coordinates. (affine_matrix * vec3(coord_x, coord_y, 1.0)) 1984 * After transform, normalized texture coord (0, 0) should be bottom-left 1985 * and (1, 1) should be top-right (or (width, height) for RECTANGLE). 1986 * 1987 * GL-specific typedefs are avoided here to avoid relying on gl.h in 1988 * the API definition. 1989 */ 1990 typedef void (RETRO_CALLCONV *retro_camera_frame_opengl_texture_t)(unsigned texture_id, 1991 unsigned texture_target, const float *affine); 1992 1993 struct retro_camera_callback 1994 { 1995 /* Set by libretro core. 1996 * Example bitmask: caps = (1 << RETRO_CAMERA_BUFFER_OPENGL_TEXTURE) | (1 << RETRO_CAMERA_BUFFER_RAW_FRAMEBUFFER). 1997 */ 1998 uint64_t caps; 1999 2000 /* Desired resolution for camera. Is only used as a hint. */ 2001 unsigned width; 2002 unsigned height; 2003 2004 /* Set by frontend. */ 2005 retro_camera_start_t start; 2006 retro_camera_stop_t stop; 2007 2008 /* Set by libretro core if raw framebuffer callbacks will be used. */ 2009 retro_camera_frame_raw_framebuffer_t frame_raw_framebuffer; 2010 2011 /* Set by libretro core if OpenGL texture callbacks will be used. */ 2012 retro_camera_frame_opengl_texture_t frame_opengl_texture; 2013 2014 /* Set by libretro core. Called after camera driver is initialized and 2015 * ready to be started. 2016 * Can be NULL, in which this callback is not called. 2017 */ 2018 retro_camera_lifetime_status_t initialized; 2019 2020 /* Set by libretro core. Called right before camera driver is 2021 * deinitialized. 2022 * Can be NULL, in which this callback is not called. 2023 */ 2024 retro_camera_lifetime_status_t deinitialized; 2025 }; 2026 2027 /* Sets the interval of time and/or distance at which to update/poll 2028 * location-based data. 2029 * 2030 * To ensure compatibility with all location-based implementations, 2031 * values for both interval_ms and interval_distance should be provided. 2032 * 2033 * interval_ms is the interval expressed in milliseconds. 2034 * interval_distance is the distance interval expressed in meters. 2035 */ 2036 typedef void (RETRO_CALLCONV *retro_location_set_interval_t)(unsigned interval_ms, 2037 unsigned interval_distance); 2038 2039 /* Start location services. The device will start listening for changes to the 2040 * current location at regular intervals (which are defined with 2041 * retro_location_set_interval_t). */ 2042 typedef bool (RETRO_CALLCONV *retro_location_start_t)(void); 2043 2044 /* Stop location services. The device will stop listening for changes 2045 * to the current location. */ 2046 typedef void (RETRO_CALLCONV *retro_location_stop_t)(void); 2047 2048 /* Get the position of the current location. Will set parameters to 2049 * 0 if no new location update has happened since the last time. */ 2050 typedef bool (RETRO_CALLCONV *retro_location_get_position_t)(double *lat, double *lon, 2051 double *horiz_accuracy, double *vert_accuracy); 2052 2053 /* Callback which signals when the location driver is initialized 2054 * and/or deinitialized. 2055 * retro_location_start_t can be called in initialized callback. 2056 */ 2057 typedef void (RETRO_CALLCONV *retro_location_lifetime_status_t)(void); 2058 2059 struct retro_location_callback 2060 { 2061 retro_location_start_t start; 2062 retro_location_stop_t stop; 2063 retro_location_get_position_t get_position; 2064 retro_location_set_interval_t set_interval; 2065 2066 retro_location_lifetime_status_t initialized; 2067 retro_location_lifetime_status_t deinitialized; 2068 }; 2069 2070 enum retro_rumble_effect 2071 { 2072 RETRO_RUMBLE_STRONG = 0, 2073 RETRO_RUMBLE_WEAK = 1, 2074 2075 RETRO_RUMBLE_DUMMY = INT_MAX 2076 }; 2077 2078 /* Sets rumble state for joypad plugged in port 'port'. 2079 * Rumble effects are controlled independently, 2080 * and setting e.g. strong rumble does not override weak rumble. 2081 * Strength has a range of [0, 0xffff]. 2082 * 2083 * Returns true if rumble state request was honored. 2084 * Calling this before first retro_run() is likely to return false. */ 2085 typedef bool (RETRO_CALLCONV *retro_set_rumble_state_t)(unsigned port, 2086 enum retro_rumble_effect effect, uint16_t strength); 2087 2088 struct retro_rumble_interface 2089 { 2090 retro_set_rumble_state_t set_rumble_state; 2091 }; 2092 2093 /* Notifies libretro that audio data should be written. */ 2094 typedef void (RETRO_CALLCONV *retro_audio_callback_t)(void); 2095 2096 /* True: Audio driver in frontend is active, and callback is 2097 * expected to be called regularily. 2098 * False: Audio driver in frontend is paused or inactive. 2099 * Audio callback will not be called until set_state has been 2100 * called with true. 2101 * Initial state is false (inactive). 2102 */ 2103 typedef void (RETRO_CALLCONV *retro_audio_set_state_callback_t)(bool enabled); 2104 2105 struct retro_audio_callback 2106 { 2107 retro_audio_callback_t callback; 2108 retro_audio_set_state_callback_t set_state; 2109 }; 2110 2111 /* Notifies a libretro core of time spent since last invocation 2112 * of retro_run() in microseconds. 2113 * 2114 * It will be called right before retro_run() every frame. 2115 * The frontend can tamper with timing to support cases like 2116 * fast-forward, slow-motion and framestepping. 2117 * 2118 * In those scenarios the reference frame time value will be used. */ 2119 typedef int64_t retro_usec_t; 2120 typedef void (RETRO_CALLCONV *retro_frame_time_callback_t)(retro_usec_t usec); 2121 struct retro_frame_time_callback 2122 { 2123 retro_frame_time_callback_t callback; 2124 /* Represents the time of one frame. It is computed as 2125 * 1000000 / fps, but the implementation will resolve the 2126 * rounding to ensure that framestepping, etc is exact. */ 2127 retro_usec_t reference; 2128 }; 2129 2130 /* Pass this to retro_video_refresh_t if rendering to hardware. 2131 * Passing NULL to retro_video_refresh_t is still a frame dupe as normal. 2132 * */ 2133 #define RETRO_HW_FRAME_BUFFER_VALID ((void*)-1) 2134 2135 /* Invalidates the current HW context. 2136 * Any GL state is lost, and must not be deinitialized explicitly. 2137 * If explicit deinitialization is desired by the libretro core, 2138 * it should implement context_destroy callback. 2139 * If called, all GPU resources must be reinitialized. 2140 * Usually called when frontend reinits video driver. 2141 * Also called first time video driver is initialized, 2142 * allowing libretro core to initialize resources. 2143 */ 2144 typedef void (RETRO_CALLCONV *retro_hw_context_reset_t)(void); 2145 2146 /* Gets current framebuffer which is to be rendered to. 2147 * Could change every frame potentially. 2148 */ 2149 typedef uintptr_t (RETRO_CALLCONV *retro_hw_get_current_framebuffer_t)(void); 2150 2151 /* Get a symbol from HW context. */ 2152 typedef retro_proc_address_t (RETRO_CALLCONV *retro_hw_get_proc_address_t)(const char *sym); 2153 2154 enum retro_hw_context_type 2155 { 2156 RETRO_HW_CONTEXT_NONE = 0, 2157 /* OpenGL 2.x. Driver can choose to use latest compatibility context. */ 2158 RETRO_HW_CONTEXT_OPENGL = 1, 2159 /* OpenGL ES 2.0. */ 2160 RETRO_HW_CONTEXT_OPENGLES2 = 2, 2161 /* Modern desktop core GL context. Use version_major/ 2162 * version_minor fields to set GL version. */ 2163 RETRO_HW_CONTEXT_OPENGL_CORE = 3, 2164 /* OpenGL ES 3.0 */ 2165 RETRO_HW_CONTEXT_OPENGLES3 = 4, 2166 /* OpenGL ES 3.1+. Set version_major/version_minor. For GLES2 and GLES3, 2167 * use the corresponding enums directly. */ 2168 RETRO_HW_CONTEXT_OPENGLES_VERSION = 5, 2169 2170 /* Vulkan, see RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE. */ 2171 RETRO_HW_CONTEXT_VULKAN = 6, 2172 2173 /* Direct3D, set version_major to select the type of interface 2174 * returned by RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE */ 2175 RETRO_HW_CONTEXT_DIRECT3D = 7, 2176 2177 RETRO_HW_CONTEXT_DUMMY = INT_MAX 2178 }; 2179 2180 struct retro_hw_render_callback 2181 { 2182 /* Which API to use. Set by libretro core. */ 2183 enum retro_hw_context_type context_type; 2184 2185 /* Called when a context has been created or when it has been reset. 2186 * An OpenGL context is only valid after context_reset() has been called. 2187 * 2188 * When context_reset is called, OpenGL resources in the libretro 2189 * implementation are guaranteed to be invalid. 2190 * 2191 * It is possible that context_reset is called multiple times during an 2192 * application lifecycle. 2193 * If context_reset is called without any notification (context_destroy), 2194 * the OpenGL context was lost and resources should just be recreated 2195 * without any attempt to "free" old resources. 2196 */ 2197 retro_hw_context_reset_t context_reset; 2198 2199 /* Set by frontend. 2200 * TODO: This is rather obsolete. The frontend should not 2201 * be providing preallocated framebuffers. */ 2202 retro_hw_get_current_framebuffer_t get_current_framebuffer; 2203 2204 /* Set by frontend. 2205 * Can return all relevant functions, including glClear on Windows. */ 2206 retro_hw_get_proc_address_t get_proc_address; 2207 2208 /* Set if render buffers should have depth component attached. 2209 * TODO: Obsolete. */ 2210 bool depth; 2211 2212 /* Set if stencil buffers should be attached. 2213 * TODO: Obsolete. */ 2214 bool stencil; 2215 2216 /* If depth and stencil are true, a packed 24/8 buffer will be added. 2217 * Only attaching stencil is invalid and will be ignored. */ 2218 2219 /* Use conventional bottom-left origin convention. If false, 2220 * standard libretro top-left origin semantics are used. 2221 * TODO: Move to GL specific interface. */ 2222 bool bottom_left_origin; 2223 2224 /* Major version number for core GL context or GLES 3.1+. */ 2225 unsigned version_major; 2226 2227 /* Minor version number for core GL context or GLES 3.1+. */ 2228 unsigned version_minor; 2229 2230 /* If this is true, the frontend will go very far to avoid 2231 * resetting context in scenarios like toggling fullscreen, etc. 2232 * TODO: Obsolete? Maybe frontend should just always assume this ... 2233 */ 2234 bool cache_context; 2235 2236 /* The reset callback might still be called in extreme situations 2237 * such as if the context is lost beyond recovery. 2238 * 2239 * For optimal stability, set this to false, and allow context to be 2240 * reset at any time. 2241 */ 2242 2243 /* A callback to be called before the context is destroyed in a 2244 * controlled way by the frontend. */ 2245 retro_hw_context_reset_t context_destroy; 2246 2247 /* OpenGL resources can be deinitialized cleanly at this step. 2248 * context_destroy can be set to NULL, in which resources will 2249 * just be destroyed without any notification. 2250 * 2251 * Even when context_destroy is non-NULL, it is possible that 2252 * context_reset is called without any destroy notification. 2253 * This happens if context is lost by external factors (such as 2254 * notified by GL_ARB_robustness). 2255 * 2256 * In this case, the context is assumed to be already dead, 2257 * and the libretro implementation must not try to free any OpenGL 2258 * resources in the subsequent context_reset. 2259 */ 2260 2261 /* Creates a debug context. */ 2262 bool debug_context; 2263 }; 2264 2265 /* Callback type passed in RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK. 2266 * Called by the frontend in response to keyboard events. 2267 * down is set if the key is being pressed, or false if it is being released. 2268 * keycode is the RETROK value of the char. 2269 * character is the text character of the pressed key. (UTF-32). 2270 * key_modifiers is a set of RETROKMOD values or'ed together. 2271 * 2272 * The pressed/keycode state can be indepedent of the character. 2273 * It is also possible that multiple characters are generated from a 2274 * single keypress. 2275 * Keycode events should be treated separately from character events. 2276 * However, when possible, the frontend should try to synchronize these. 2277 * If only a character is posted, keycode should be RETROK_UNKNOWN. 2278 * 2279 * Similarily if only a keycode event is generated with no corresponding 2280 * character, character should be 0. 2281 */ 2282 typedef void (RETRO_CALLCONV *retro_keyboard_event_t)(bool down, unsigned keycode, 2283 uint32_t character, uint16_t key_modifiers); 2284 2285 struct retro_keyboard_callback 2286 { 2287 retro_keyboard_event_t callback; 2288 }; 2289 2290 /* Callbacks for RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE. 2291 * Should be set for implementations which can swap out multiple disk 2292 * images in runtime. 2293 * 2294 * If the implementation can do this automatically, it should strive to do so. 2295 * However, there are cases where the user must manually do so. 2296 * 2297 * Overview: To swap a disk image, eject the disk image with 2298 * set_eject_state(true). 2299 * Set the disk index with set_image_index(index). Insert the disk again 2300 * with set_eject_state(false). 2301 */ 2302 2303 /* If ejected is true, "ejects" the virtual disk tray. 2304 * When ejected, the disk image index can be set. 2305 */ 2306 typedef bool (RETRO_CALLCONV *retro_set_eject_state_t)(bool ejected); 2307 2308 /* Gets current eject state. The initial state is 'not ejected'. */ 2309 typedef bool (RETRO_CALLCONV *retro_get_eject_state_t)(void); 2310 2311 /* Gets current disk index. First disk is index 0. 2312 * If return value is >= get_num_images(), no disk is currently inserted. 2313 */ 2314 typedef unsigned (RETRO_CALLCONV *retro_get_image_index_t)(void); 2315 2316 /* Sets image index. Can only be called when disk is ejected. 2317 * The implementation supports setting "no disk" by using an 2318 * index >= get_num_images(). 2319 */ 2320 typedef bool (RETRO_CALLCONV *retro_set_image_index_t)(unsigned index); 2321 2322 /* Gets total number of images which are available to use. */ 2323 typedef unsigned (RETRO_CALLCONV *retro_get_num_images_t)(void); 2324 2325 struct retro_game_info; 2326 2327 /* Replaces the disk image associated with index. 2328 * Arguments to pass in info have same requirements as retro_load_game(). 2329 * Virtual disk tray must be ejected when calling this. 2330 * 2331 * Replacing a disk image with info = NULL will remove the disk image 2332 * from the internal list. 2333 * As a result, calls to get_image_index() can change. 2334 * 2335 * E.g. replace_image_index(1, NULL), and previous get_image_index() 2336 * returned 4 before. 2337 * Index 1 will be removed, and the new index is 3. 2338 */ 2339 typedef bool (RETRO_CALLCONV *retro_replace_image_index_t)(unsigned index, 2340 const struct retro_game_info *info); 2341 2342 /* Adds a new valid index (get_num_images()) to the internal disk list. 2343 * This will increment subsequent return values from get_num_images() by 1. 2344 * This image index cannot be used until a disk image has been set 2345 * with replace_image_index. */ 2346 typedef bool (RETRO_CALLCONV *retro_add_image_index_t)(void); 2347 2348 struct retro_disk_control_callback 2349 { 2350 retro_set_eject_state_t set_eject_state; 2351 retro_get_eject_state_t get_eject_state; 2352 2353 retro_get_image_index_t get_image_index; 2354 retro_set_image_index_t set_image_index; 2355 retro_get_num_images_t get_num_images; 2356 2357 retro_replace_image_index_t replace_image_index; 2358 retro_add_image_index_t add_image_index; 2359 }; 2360 2361 enum retro_pixel_format 2362 { 2363 /* 0RGB1555, native endian. 2364 * 0 bit must be set to 0. 2365 * This pixel format is default for compatibility concerns only. 2366 * If a 15/16-bit pixel format is desired, consider using RGB565. */ 2367 RETRO_PIXEL_FORMAT_0RGB1555 = 0, 2368 2369 /* XRGB8888, native endian. 2370 * X bits are ignored. */ 2371 RETRO_PIXEL_FORMAT_XRGB8888 = 1, 2372 2373 /* RGB565, native endian. 2374 * This pixel format is the recommended format to use if a 15/16-bit 2375 * format is desired as it is the pixel format that is typically 2376 * available on a wide range of low-power devices. 2377 * 2378 * It is also natively supported in APIs like OpenGL ES. */ 2379 RETRO_PIXEL_FORMAT_RGB565 = 2, 2380 2381 /* Ensure sizeof() == sizeof(int). */ 2382 RETRO_PIXEL_FORMAT_UNKNOWN = INT_MAX 2383 }; 2384 2385 struct retro_message 2386 { 2387 const char *msg; /* Message to be displayed. */ 2388 unsigned frames; /* Duration in frames of message. */ 2389 }; 2390 2391 /* Describes how the libretro implementation maps a libretro input bind 2392 * to its internal input system through a human readable string. 2393 * This string can be used to better let a user configure input. */ 2394 struct retro_input_descriptor 2395 { 2396 /* Associates given parameters with a description. */ 2397 unsigned port; 2398 unsigned device; 2399 unsigned index; 2400 unsigned id; 2401 2402 /* Human readable description for parameters. 2403 * The pointer must remain valid until 2404 * retro_unload_game() is called. */ 2405 const char *description; 2406 }; 2407 2408 struct retro_system_info 2409 { 2410 /* All pointers are owned by libretro implementation, and pointers must 2411 * remain valid until retro_deinit() is called. */ 2412 2413 const char *library_name; /* Descriptive name of library. Should not 2414 * contain any version numbers, etc. */ 2415 const char *library_version; /* Descriptive version of core. */ 2416 2417 const char *valid_extensions; /* A string listing probably content 2418 * extensions the core will be able to 2419 * load, separated with pipe. 2420 * I.e. "bin|rom|iso". 2421 * Typically used for a GUI to filter 2422 * out extensions. */ 2423 2424 /* Libretro cores that need to have direct access to their content 2425 * files, including cores which use the path of the content files to 2426 * determine the paths of other files, should set need_fullpath to true. 2427 * 2428 * Cores should strive for setting need_fullpath to false, 2429 * as it allows the frontend to perform patching, etc. 2430 * 2431 * If need_fullpath is true and retro_load_game() is called: 2432 * - retro_game_info::path is guaranteed to have a valid path 2433 * - retro_game_info::data and retro_game_info::size are invalid 2434 * 2435 * If need_fullpath is false and retro_load_game() is called: 2436 * - retro_game_info::path may be NULL 2437 * - retro_game_info::data and retro_game_info::size are guaranteed 2438 * to be valid 2439 * 2440 * See also: 2441 * - RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY 2442 * - RETRO_ENVIRONMENT_GET_SAVE_DIRECTORY 2443 */ 2444 bool need_fullpath; 2445 2446 /* If true, the frontend is not allowed to extract any archives before 2447 * loading the real content. 2448 * Necessary for certain libretro implementations that load games 2449 * from zipped archives. */ 2450 bool block_extract; 2451 }; 2452 2453 struct retro_game_geometry 2454 { 2455 unsigned base_width; /* Nominal video width of game. */ 2456 unsigned base_height; /* Nominal video height of game. */ 2457 unsigned max_width; /* Maximum possible width of game. */ 2458 unsigned max_height; /* Maximum possible height of game. */ 2459 2460 float aspect_ratio; /* Nominal aspect ratio of game. If 2461 * aspect_ratio is <= 0.0, an aspect ratio 2462 * of base_width / base_height is assumed. 2463 * A frontend could override this setting, 2464 * if desired. */ 2465 }; 2466 2467 struct retro_system_timing 2468 { 2469 double fps; /* FPS of video content. */ 2470 double sample_rate; /* Sampling rate of audio. */ 2471 }; 2472 2473 struct retro_system_av_info 2474 { 2475 struct retro_game_geometry geometry; 2476 struct retro_system_timing timing; 2477 }; 2478 2479 struct retro_variable 2480 { 2481 /* Variable to query in RETRO_ENVIRONMENT_GET_VARIABLE. 2482 * If NULL, obtains the complete environment string if more 2483 * complex parsing is necessary. 2484 * The environment string is formatted as key-value pairs 2485 * delimited by semicolons as so: 2486 * "key1=value1;key2=value2;..." 2487 */ 2488 const char *key; 2489 2490 /* Value to be obtained. If key does not exist, it is set to NULL. */ 2491 const char *value; 2492 }; 2493 2494 struct retro_core_option_display 2495 { 2496 /* Variable to configure in RETRO_ENVIRONMENT_SET_CORE_OPTIONS_DISPLAY */ 2497 const char *key; 2498 2499 /* Specifies whether variable should be displayed 2500 * when presenting core options to the user */ 2501 bool visible; 2502 }; 2503 2504 /* Maximum number of values permitted for a core option 2505 * > Note: We have to set a maximum value due the limitations 2506 * of the C language - i.e. it is not possible to create an 2507 * array of structs each containing a variable sized array, 2508 * so the retro_core_option_definition values array must 2509 * have a fixed size. The size limit of 128 is a balancing 2510 * act - it needs to be large enough to support all 'sane' 2511 * core options, but setting it too large may impact low memory 2512 * platforms. In practise, if a core option has more than 2513 * 128 values then the implementation is likely flawed. 2514 * To quote the above API reference: 2515 * "The number of possible options should be very limited 2516 * i.e. it should be feasible to cycle through options 2517 * without a keyboard." 2518 */ 2519 #define RETRO_NUM_CORE_OPTION_VALUES_MAX 128 2520 2521 struct retro_core_option_value 2522 { 2523 /* Expected option value */ 2524 const char *value; 2525 2526 /* Human-readable value label. If NULL, value itself 2527 * will be displayed by the frontend */ 2528 const char *label; 2529 }; 2530 2531 struct retro_core_option_definition 2532 { 2533 /* Variable to query in RETRO_ENVIRONMENT_GET_VARIABLE. */ 2534 const char *key; 2535 2536 /* Human-readable core option description (used as menu label) */ 2537 const char *desc; 2538 2539 /* Human-readable core option information (used as menu sublabel) */ 2540 const char *info; 2541 2542 /* Array of retro_core_option_value structs, terminated by NULL */ 2543 struct retro_core_option_value values[RETRO_NUM_CORE_OPTION_VALUES_MAX]; 2544 2545 /* Default core option value. Must match one of the values 2546 * in the retro_core_option_value array, otherwise will be 2547 * ignored */ 2548 const char *default_value; 2549 }; 2550 2551 struct retro_core_options_intl 2552 { 2553 /* Pointer to an array of retro_core_option_definition structs 2554 * - US English implementation 2555 * - Must point to a valid array */ 2556 struct retro_core_option_definition *us; 2557 2558 /* Pointer to an array of retro_core_option_definition structs 2559 * - Implementation for current frontend language 2560 * - May be NULL */ 2561 struct retro_core_option_definition *local; 2562 }; 2563 2564 struct retro_game_info 2565 { 2566 const char *path; /* Path to game, UTF-8 encoded. 2567 * Sometimes used as a reference for building other paths. 2568 * May be NULL if game was loaded from stdin or similar, 2569 * but in this case some cores will be unable to load `data`. 2570 * So, it is preferable to fabricate something here instead 2571 * of passing NULL, which will help more cores to succeed. 2572 * retro_system_info::need_fullpath requires 2573 * that this path is valid. */ 2574 const void *data; /* Memory buffer of loaded game. Will be NULL 2575 * if need_fullpath was set. */ 2576 size_t size; /* Size of memory buffer. */ 2577 const char *meta; /* String of implementation specific meta-data. */ 2578 }; 2579 2580 #define RETRO_MEMORY_ACCESS_WRITE (1 << 0) 2581 /* The core will write to the buffer provided by retro_framebuffer::data. */ 2582 #define RETRO_MEMORY_ACCESS_READ (1 << 1) 2583 /* The core will read from retro_framebuffer::data. */ 2584 #define RETRO_MEMORY_TYPE_CACHED (1 << 0) 2585 /* The memory in data is cached. 2586 * If not cached, random writes and/or reading from the buffer is expected to be very slow. */ 2587 struct retro_framebuffer 2588 { 2589 void *data; /* The framebuffer which the core can render into. 2590 Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER. 2591 The initial contents of data are unspecified. */ 2592 unsigned width; /* The framebuffer width used by the core. Set by core. */ 2593 unsigned height; /* The framebuffer height used by the core. Set by core. */ 2594 size_t pitch; /* The number of bytes between the beginning of a scanline, 2595 and beginning of the next scanline. 2596 Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER. */ 2597 enum retro_pixel_format format; /* The pixel format the core must use to render into data. 2598 This format could differ from the format used in 2599 SET_PIXEL_FORMAT. 2600 Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER. */ 2601 2602 unsigned access_flags; /* How the core will access the memory in the framebuffer. 2603 RETRO_MEMORY_ACCESS_* flags. 2604 Set by core. */ 2605 unsigned memory_flags; /* Flags telling core how the memory has been mapped. 2606 RETRO_MEMORY_TYPE_* flags. 2607 Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER. */ 2608 }; 2609 2610 /* Callbacks */ 2611 2612 /* Environment callback. Gives implementations a way of performing 2613 * uncommon tasks. Extensible. */ 2614 typedef bool (RETRO_CALLCONV *retro_environment_t)(unsigned cmd, void *data); 2615 2616 /* Render a frame. Pixel format is 15-bit 0RGB1555 native endian 2617 * unless changed (see RETRO_ENVIRONMENT_SET_PIXEL_FORMAT). 2618 * 2619 * Width and height specify dimensions of buffer. 2620 * Pitch specifices length in bytes between two lines in buffer. 2621 * 2622 * For performance reasons, it is highly recommended to have a frame 2623 * that is packed in memory, i.e. pitch == width * byte_per_pixel. 2624 * Certain graphic APIs, such as OpenGL ES, do not like textures 2625 * that are not packed in memory. 2626 */ 2627 typedef void (RETRO_CALLCONV *retro_video_refresh_t)(const void *data, unsigned width, 2628 unsigned height, size_t pitch); 2629 2630 /* Renders a single audio frame. Should only be used if implementation 2631 * generates a single sample at a time. 2632 * Format is signed 16-bit native endian. 2633 */ 2634 typedef void (RETRO_CALLCONV *retro_audio_sample_t)(int16_t left, int16_t right); 2635 2636 /* Renders multiple audio frames in one go. 2637 * 2638 * One frame is defined as a sample of left and right channels, interleaved. 2639 * I.e. int16_t buf[4] = { l, r, l, r }; would be 2 frames. 2640 * Only one of the audio callbacks must ever be used. 2641 */ 2642 typedef size_t (RETRO_CALLCONV *retro_audio_sample_batch_t)(const int16_t *data, 2643 size_t frames); 2644 2645 /* Polls input. */ 2646 typedef void (RETRO_CALLCONV *retro_input_poll_t)(void); 2647 2648 /* Queries for input for player 'port'. device will be masked with 2649 * RETRO_DEVICE_MASK. 2650 * 2651 * Specialization of devices such as RETRO_DEVICE_JOYPAD_MULTITAP that 2652 * have been set with retro_set_controller_port_device() 2653 * will still use the higher level RETRO_DEVICE_JOYPAD to request input. 2654 */ 2655 typedef int16_t (RETRO_CALLCONV *retro_input_state_t)(unsigned port, unsigned device, 2656 unsigned index, unsigned id); 2657 2658 /* Sets callbacks. retro_set_environment() is guaranteed to be called 2659 * before retro_init(). 2660 * 2661 * The rest of the set_* functions are guaranteed to have been called 2662 * before the first call to retro_run() is made. */ 2663 RETRO_API void retro_set_environment(retro_environment_t); 2664 RETRO_API void retro_set_video_refresh(retro_video_refresh_t); 2665 RETRO_API void retro_set_audio_sample(retro_audio_sample_t); 2666 RETRO_API void retro_set_audio_sample_batch(retro_audio_sample_batch_t); 2667 RETRO_API void retro_set_input_poll(retro_input_poll_t); 2668 RETRO_API void retro_set_input_state(retro_input_state_t); 2669 2670 /* Library global initialization/deinitialization. */ 2671 RETRO_API void retro_init(void); 2672 RETRO_API void retro_deinit(void); 2673 2674 /* Must return RETRO_API_VERSION. Used to validate ABI compatibility 2675 * when the API is revised. */ 2676 RETRO_API unsigned retro_api_version(void); 2677 2678 /* Gets statically known system info. Pointers provided in *info 2679 * must be statically allocated. 2680 * Can be called at any time, even before retro_init(). */ 2681 RETRO_API void retro_get_system_info(struct retro_system_info *info); 2682 2683 /* Gets information about system audio/video timings and geometry. 2684 * Can be called only after retro_load_game() has successfully completed. 2685 * NOTE: The implementation of this function might not initialize every 2686 * variable if needed. 2687 * E.g. geom.aspect_ratio might not be initialized if core doesn't 2688 * desire a particular aspect ratio. */ 2689 RETRO_API void retro_get_system_av_info(struct retro_system_av_info *info); 2690 2691 /* Sets device to be used for player 'port'. 2692 * By default, RETRO_DEVICE_JOYPAD is assumed to be plugged into all 2693 * available ports. 2694 * Setting a particular device type is not a guarantee that libretro cores 2695 * will only poll input based on that particular device type. It is only a 2696 * hint to the libretro core when a core cannot automatically detect the 2697 * appropriate input device type on its own. It is also relevant when a 2698 * core can change its behavior depending on device type. 2699 * 2700 * As part of the core's implementation of retro_set_controller_port_device, 2701 * the core should call RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS to notify the 2702 * frontend if the descriptions for any controls have changed as a 2703 * result of changing the device type. 2704 */ 2705 RETRO_API void retro_set_controller_port_device(unsigned port, unsigned device); 2706 2707 /* Resets the current game. */ 2708 RETRO_API void retro_reset(void); 2709 2710 /* Runs the game for one video frame. 2711 * During retro_run(), input_poll callback must be called at least once. 2712 * 2713 * If a frame is not rendered for reasons where a game "dropped" a frame, 2714 * this still counts as a frame, and retro_run() should explicitly dupe 2715 * a frame if GET_CAN_DUPE returns true. 2716 * In this case, the video callback can take a NULL argument for data. 2717 */ 2718 RETRO_API void retro_run(void); 2719 2720 /* Returns the amount of data the implementation requires to serialize 2721 * internal state (save states). 2722 * Between calls to retro_load_game() and retro_unload_game(), the 2723 * returned size is never allowed to be larger than a previous returned 2724 * value, to ensure that the frontend can allocate a save state buffer once. 2725 */ 2726 RETRO_API size_t retro_serialize_size(void); 2727 2728 /* Serializes internal state. If failed, or size is lower than 2729 * retro_serialize_size(), it should return false, true otherwise. */ 2730 RETRO_API bool retro_serialize(void *data, size_t size); 2731 RETRO_API bool retro_unserialize(const void *data, size_t size); 2732 2733 RETRO_API void retro_cheat_reset(void); 2734 RETRO_API void retro_cheat_set(unsigned index, bool enabled, const char *code); 2735 2736 /* Loads a game. 2737 * Return true to indicate successful loading and false to indicate load failure. 2738 */ 2739 RETRO_API bool retro_load_game(const struct retro_game_info *game); 2740 2741 /* Loads a "special" kind of game. Should not be used, 2742 * except in extreme cases. */ 2743 RETRO_API bool retro_load_game_special( 2744 unsigned game_type, 2745 const struct retro_game_info *info, size_t num_info 2746 ); 2747 2748 /* Unloads the currently loaded game. Called before retro_deinit(void). */ 2749 RETRO_API void retro_unload_game(void); 2750 2751 /* Gets region of game. */ 2752 RETRO_API unsigned retro_get_region(void); 2753 2754 /* Gets region of memory. */ 2755 RETRO_API void *retro_get_memory_data(unsigned id); 2756 RETRO_API size_t retro_get_memory_size(unsigned id); 2757 2758 #ifdef __cplusplus 2759 } 2760 #endif 2761 2762 #endif 2763