libretro.h 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787
  1. /* Copyright (C) 2010-2013 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. #ifndef LIBRETRO_H__
  23. #define LIBRETRO_H__
  24. #include <stdint.h>
  25. #include <stddef.h>
  26. #include <limits.h>
  27. // Hack applied for MSVC when compiling in C89 mode as it isn't C99 compliant.
  28. #ifdef __cplusplus
  29. extern "C" {
  30. #else
  31. #if defined(_MSC_VER) && !defined(SN_TARGET_PS3) && !defined(__cplusplus)
  32. #define bool unsigned char
  33. #define true 1
  34. #define false 0
  35. #else
  36. #include <stdbool.h>
  37. #endif
  38. #endif
  39. // Used for checking API/ABI mismatches that can break libretro implementations.
  40. // It is not incremented for compatible changes to the API.
  41. #define RETRO_API_VERSION 1
  42. // Libretro's fundamental device abstractions.
  43. #define RETRO_DEVICE_MASK 0xff
  44. #define RETRO_DEVICE_NONE 0
  45. // The JOYPAD is called RetroPad. It is essentially a Super Nintendo controller,
  46. // but with additional L2/R2/L3/R3 buttons, similar to a PS1 DualShock.
  47. #define RETRO_DEVICE_JOYPAD 1
  48. // The mouse is a simple mouse, similar to Super Nintendo's mouse.
  49. // X and Y coordinates are reported relatively to last poll (poll callback).
  50. // It is up to the libretro implementation to keep track of where the mouse pointer is supposed to be on the screen.
  51. // The frontend must make sure not to interfere with its own hardware mouse pointer.
  52. #define RETRO_DEVICE_MOUSE 2
  53. // KEYBOARD device lets one poll for raw key pressed.
  54. // It is poll based, so input callback will return with the current pressed state.
  55. #define RETRO_DEVICE_KEYBOARD 3
  56. // Lightgun X/Y coordinates are reported relatively to last poll, similar to mouse.
  57. #define RETRO_DEVICE_LIGHTGUN 4
  58. // The ANALOG device is an extension to JOYPAD (RetroPad).
  59. // Similar to DualShock it adds two analog sticks.
  60. // This is treated as a separate device type as it returns values in the full analog range
  61. // of [-0x8000, 0x7fff]. Positive X axis is right. Positive Y axis is down.
  62. // Only use ANALOG type when polling for analog values of the axes.
  63. #define RETRO_DEVICE_ANALOG 5
  64. // Abstracts the concept of a pointing mechanism, e.g. touch.
  65. // This allows libretro to query in absolute coordinates where on the screen a mouse (or something similar) is being placed.
  66. // For a touch centric device, coordinates reported are the coordinates of the press.
  67. //
  68. // Coordinates in X and Y are reported as:
  69. // [-0x7fff, 0x7fff]: -0x7fff corresponds to the far left/top of the screen,
  70. // and 0x7fff corresponds to the far right/bottom of the screen.
  71. // The "screen" is here defined as area that is passed to the frontend and later displayed on the monitor.
  72. // The frontend is free to scale/resize this screen as it sees fit, however,
  73. // (X, Y) = (-0x7fff, -0x7fff) will correspond to the top-left pixel of the game image, etc.
  74. //
  75. // To check if the pointer coordinates are valid (e.g. a touch display actually being touched),
  76. // PRESSED returns 1 or 0.
  77. // If using a mouse, PRESSED will usually correspond to the left mouse button.
  78. // PRESSED will only return 1 if the pointer is inside the game screen.
  79. //
  80. // For multi-touch, the index variable can be used to successively query more presses.
  81. // If index = 0 returns true for _PRESSED, coordinates can be extracted
  82. // with _X, _Y for index = 0. One can then query _PRESSED, _X, _Y with index = 1, and so on.
  83. // Eventually _PRESSED will return false for an index. No further presses are registered at this point.
  84. #define RETRO_DEVICE_POINTER 6
  85. // These device types are specializations of the base types above.
  86. // They should only be used in retro_set_controller_type() to inform libretro implementations
  87. // about use of a very specific device type.
  88. //
  89. // In input state callback, however, only the base type should be used in the 'device' field.
  90. #define RETRO_DEVICE_JOYPAD_MULTITAP ((1 << 8) | RETRO_DEVICE_JOYPAD)
  91. #define RETRO_DEVICE_LIGHTGUN_SUPER_SCOPE ((1 << 8) | RETRO_DEVICE_LIGHTGUN)
  92. #define RETRO_DEVICE_LIGHTGUN_JUSTIFIER ((2 << 8) | RETRO_DEVICE_LIGHTGUN)
  93. #define RETRO_DEVICE_LIGHTGUN_JUSTIFIERS ((3 << 8) | RETRO_DEVICE_LIGHTGUN)
  94. // Buttons for the RetroPad (JOYPAD).
  95. // The placement of these is equivalent to placements on the Super Nintendo controller.
  96. // L2/R2/L3/R3 buttons correspond to the PS1 DualShock.
  97. #define RETRO_DEVICE_ID_JOYPAD_B 0
  98. #define RETRO_DEVICE_ID_JOYPAD_Y 1
  99. #define RETRO_DEVICE_ID_JOYPAD_SELECT 2
  100. #define RETRO_DEVICE_ID_JOYPAD_START 3
  101. #define RETRO_DEVICE_ID_JOYPAD_UP 4
  102. #define RETRO_DEVICE_ID_JOYPAD_DOWN 5
  103. #define RETRO_DEVICE_ID_JOYPAD_LEFT 6
  104. #define RETRO_DEVICE_ID_JOYPAD_RIGHT 7
  105. #define RETRO_DEVICE_ID_JOYPAD_A 8
  106. #define RETRO_DEVICE_ID_JOYPAD_X 9
  107. #define RETRO_DEVICE_ID_JOYPAD_L 10
  108. #define RETRO_DEVICE_ID_JOYPAD_R 11
  109. #define RETRO_DEVICE_ID_JOYPAD_L2 12
  110. #define RETRO_DEVICE_ID_JOYPAD_R2 13
  111. #define RETRO_DEVICE_ID_JOYPAD_L3 14
  112. #define RETRO_DEVICE_ID_JOYPAD_R3 15
  113. // Index / Id values for ANALOG device.
  114. #define RETRO_DEVICE_INDEX_ANALOG_LEFT 0
  115. #define RETRO_DEVICE_INDEX_ANALOG_RIGHT 1
  116. #define RETRO_DEVICE_ID_ANALOG_X 0
  117. #define RETRO_DEVICE_ID_ANALOG_Y 1
  118. // Id values for MOUSE.
  119. #define RETRO_DEVICE_ID_MOUSE_X 0
  120. #define RETRO_DEVICE_ID_MOUSE_Y 1
  121. #define RETRO_DEVICE_ID_MOUSE_LEFT 2
  122. #define RETRO_DEVICE_ID_MOUSE_RIGHT 3
  123. // Id values for LIGHTGUN types.
  124. #define RETRO_DEVICE_ID_LIGHTGUN_X 0
  125. #define RETRO_DEVICE_ID_LIGHTGUN_Y 1
  126. #define RETRO_DEVICE_ID_LIGHTGUN_TRIGGER 2
  127. #define RETRO_DEVICE_ID_LIGHTGUN_CURSOR 3
  128. #define RETRO_DEVICE_ID_LIGHTGUN_TURBO 4
  129. #define RETRO_DEVICE_ID_LIGHTGUN_PAUSE 5
  130. #define RETRO_DEVICE_ID_LIGHTGUN_START 6
  131. // Id values for POINTER.
  132. #define RETRO_DEVICE_ID_POINTER_X 0
  133. #define RETRO_DEVICE_ID_POINTER_Y 1
  134. #define RETRO_DEVICE_ID_POINTER_PRESSED 2
  135. // Returned from retro_get_region().
  136. #define RETRO_REGION_NTSC 0
  137. #define RETRO_REGION_PAL 1
  138. // Passed to retro_get_memory_data/size().
  139. // If the memory type doesn't apply to the implementation NULL/0 can be returned.
  140. #define RETRO_MEMORY_MASK 0xff
  141. // Regular save ram. This ram is usually found on a game cartridge, backed up by a battery.
  142. // If save game data is too complex for a single memory buffer,
  143. // the SYSTEM_DIRECTORY environment callback can be used.
  144. #define RETRO_MEMORY_SAVE_RAM 0
  145. // Some games have a built-in clock to keep track of time.
  146. // This memory is usually just a couple of bytes to keep track of time.
  147. #define RETRO_MEMORY_RTC 1
  148. // System ram lets a frontend peek into a game systems main RAM.
  149. #define RETRO_MEMORY_SYSTEM_RAM 2
  150. // Video ram lets a frontend peek into a game systems video RAM (VRAM).
  151. #define RETRO_MEMORY_VIDEO_RAM 3
  152. // Special memory types.
  153. #define RETRO_MEMORY_SNES_BSX_RAM ((1 << 8) | RETRO_MEMORY_SAVE_RAM)
  154. #define RETRO_MEMORY_SNES_BSX_PRAM ((2 << 8) | RETRO_MEMORY_SAVE_RAM)
  155. #define RETRO_MEMORY_SNES_SUFAMI_TURBO_A_RAM ((3 << 8) | RETRO_MEMORY_SAVE_RAM)
  156. #define RETRO_MEMORY_SNES_SUFAMI_TURBO_B_RAM ((4 << 8) | RETRO_MEMORY_SAVE_RAM)
  157. #define RETRO_MEMORY_SNES_GAME_BOY_RAM ((5 << 8) | RETRO_MEMORY_SAVE_RAM)
  158. #define RETRO_MEMORY_SNES_GAME_BOY_RTC ((6 << 8) | RETRO_MEMORY_RTC)
  159. // Special game types passed into retro_load_game_special().
  160. // Only used when multiple ROMs are required.
  161. #define RETRO_GAME_TYPE_BSX 0x101
  162. #define RETRO_GAME_TYPE_BSX_SLOTTED 0x102
  163. #define RETRO_GAME_TYPE_SUFAMI_TURBO 0x103
  164. #define RETRO_GAME_TYPE_SUPER_GAME_BOY 0x104
  165. // Keysyms used for ID in input state callback when polling RETRO_KEYBOARD.
  166. enum retro_key
  167. {
  168. RETROK_UNKNOWN = 0,
  169. RETROK_FIRST = 0,
  170. RETROK_BACKSPACE = 8,
  171. RETROK_TAB = 9,
  172. RETROK_CLEAR = 12,
  173. RETROK_RETURN = 13,
  174. RETROK_PAUSE = 19,
  175. RETROK_ESCAPE = 27,
  176. RETROK_SPACE = 32,
  177. RETROK_EXCLAIM = 33,
  178. RETROK_QUOTEDBL = 34,
  179. RETROK_HASH = 35,
  180. RETROK_DOLLAR = 36,
  181. RETROK_AMPERSAND = 38,
  182. RETROK_QUOTE = 39,
  183. RETROK_LEFTPAREN = 40,
  184. RETROK_RIGHTPAREN = 41,
  185. RETROK_ASTERISK = 42,
  186. RETROK_PLUS = 43,
  187. RETROK_COMMA = 44,
  188. RETROK_MINUS = 45,
  189. RETROK_PERIOD = 46,
  190. RETROK_SLASH = 47,
  191. RETROK_0 = 48,
  192. RETROK_1 = 49,
  193. RETROK_2 = 50,
  194. RETROK_3 = 51,
  195. RETROK_4 = 52,
  196. RETROK_5 = 53,
  197. RETROK_6 = 54,
  198. RETROK_7 = 55,
  199. RETROK_8 = 56,
  200. RETROK_9 = 57,
  201. RETROK_COLON = 58,
  202. RETROK_SEMICOLON = 59,
  203. RETROK_LESS = 60,
  204. RETROK_EQUALS = 61,
  205. RETROK_GREATER = 62,
  206. RETROK_QUESTION = 63,
  207. RETROK_AT = 64,
  208. RETROK_LEFTBRACKET = 91,
  209. RETROK_BACKSLASH = 92,
  210. RETROK_RIGHTBRACKET = 93,
  211. RETROK_CARET = 94,
  212. RETROK_UNDERSCORE = 95,
  213. RETROK_BACKQUOTE = 96,
  214. RETROK_a = 97,
  215. RETROK_b = 98,
  216. RETROK_c = 99,
  217. RETROK_d = 100,
  218. RETROK_e = 101,
  219. RETROK_f = 102,
  220. RETROK_g = 103,
  221. RETROK_h = 104,
  222. RETROK_i = 105,
  223. RETROK_j = 106,
  224. RETROK_k = 107,
  225. RETROK_l = 108,
  226. RETROK_m = 109,
  227. RETROK_n = 110,
  228. RETROK_o = 111,
  229. RETROK_p = 112,
  230. RETROK_q = 113,
  231. RETROK_r = 114,
  232. RETROK_s = 115,
  233. RETROK_t = 116,
  234. RETROK_u = 117,
  235. RETROK_v = 118,
  236. RETROK_w = 119,
  237. RETROK_x = 120,
  238. RETROK_y = 121,
  239. RETROK_z = 122,
  240. RETROK_DELETE = 127,
  241. RETROK_KP0 = 256,
  242. RETROK_KP1 = 257,
  243. RETROK_KP2 = 258,
  244. RETROK_KP3 = 259,
  245. RETROK_KP4 = 260,
  246. RETROK_KP5 = 261,
  247. RETROK_KP6 = 262,
  248. RETROK_KP7 = 263,
  249. RETROK_KP8 = 264,
  250. RETROK_KP9 = 265,
  251. RETROK_KP_PERIOD = 266,
  252. RETROK_KP_DIVIDE = 267,
  253. RETROK_KP_MULTIPLY = 268,
  254. RETROK_KP_MINUS = 269,
  255. RETROK_KP_PLUS = 270,
  256. RETROK_KP_ENTER = 271,
  257. RETROK_KP_EQUALS = 272,
  258. RETROK_UP = 273,
  259. RETROK_DOWN = 274,
  260. RETROK_RIGHT = 275,
  261. RETROK_LEFT = 276,
  262. RETROK_INSERT = 277,
  263. RETROK_HOME = 278,
  264. RETROK_END = 279,
  265. RETROK_PAGEUP = 280,
  266. RETROK_PAGEDOWN = 281,
  267. RETROK_F1 = 282,
  268. RETROK_F2 = 283,
  269. RETROK_F3 = 284,
  270. RETROK_F4 = 285,
  271. RETROK_F5 = 286,
  272. RETROK_F6 = 287,
  273. RETROK_F7 = 288,
  274. RETROK_F8 = 289,
  275. RETROK_F9 = 290,
  276. RETROK_F10 = 291,
  277. RETROK_F11 = 292,
  278. RETROK_F12 = 293,
  279. RETROK_F13 = 294,
  280. RETROK_F14 = 295,
  281. RETROK_F15 = 296,
  282. RETROK_NUMLOCK = 300,
  283. RETROK_CAPSLOCK = 301,
  284. RETROK_SCROLLOCK = 302,
  285. RETROK_RSHIFT = 303,
  286. RETROK_LSHIFT = 304,
  287. RETROK_RCTRL = 305,
  288. RETROK_LCTRL = 306,
  289. RETROK_RALT = 307,
  290. RETROK_LALT = 308,
  291. RETROK_RMETA = 309,
  292. RETROK_LMETA = 310,
  293. RETROK_LSUPER = 311,
  294. RETROK_RSUPER = 312,
  295. RETROK_MODE = 313,
  296. RETROK_COMPOSE = 314,
  297. RETROK_HELP = 315,
  298. RETROK_PRINT = 316,
  299. RETROK_SYSREQ = 317,
  300. RETROK_BREAK = 318,
  301. RETROK_MENU = 319,
  302. RETROK_POWER = 320,
  303. RETROK_EURO = 321,
  304. RETROK_UNDO = 322,
  305. RETROK_LAST,
  306. RETROK_DUMMY = INT_MAX // Ensure sizeof(enum) == sizeof(int)
  307. };
  308. enum retro_mod
  309. {
  310. RETROKMOD_NONE = 0x0000,
  311. RETROKMOD_SHIFT = 0x01,
  312. RETROKMOD_CTRL = 0x02,
  313. RETROKMOD_ALT = 0x04,
  314. RETROKMOD_META = 0x08,
  315. RETROKMOD_NUMLOCK = 0x10,
  316. RETROKMOD_CAPSLOCK = 0x20,
  317. RETROKMOD_SCROLLOCK = 0x40,
  318. RETROKMOD_DUMMY = INT_MAX // Ensure sizeof(enum) == sizeof(int)
  319. };
  320. // If set, this call is not part of the public libretro API yet. It can change or be removed at any time.
  321. #define RETRO_ENVIRONMENT_EXPERIMENTAL 0x10000
  322. // Environment commands.
  323. #define RETRO_ENVIRONMENT_SET_ROTATION 1 // const unsigned * --
  324. // Sets screen rotation of graphics.
  325. // Is only implemented if rotation can be accelerated by hardware.
  326. // Valid values are 0, 1, 2, 3, which rotates screen by 0, 90, 180, 270 degrees
  327. // counter-clockwise respectively.
  328. //
  329. #define RETRO_ENVIRONMENT_GET_OVERSCAN 2 // bool * --
  330. // Boolean value whether or not the implementation should use overscan, or crop away overscan.
  331. //
  332. #define RETRO_ENVIRONMENT_GET_CAN_DUPE 3 // bool * --
  333. // Boolean value whether or not frontend supports frame duping,
  334. // passing NULL to video frame callback.
  335. //
  336. // Environ 4, 5 are no longer supported (GET_VARIABLE / SET_VARIABLES), and reserved to avoid possible ABI clash.
  337. #define RETRO_ENVIRONMENT_SET_MESSAGE 6 // const struct retro_message * --
  338. // Sets a message to be displayed in implementation-specific manner for a certain amount of 'frames'.
  339. // Should not be used for trivial messages, which should simply be logged to stderr.
  340. #define RETRO_ENVIRONMENT_SHUTDOWN 7 // N/A (NULL) --
  341. // Requests the frontend to shutdown.
  342. // Should only be used if game has a specific
  343. // way to shutdown the game from a menu item or similar.
  344. //
  345. #define RETRO_ENVIRONMENT_SET_PERFORMANCE_LEVEL 8
  346. // const unsigned * --
  347. // Gives a hint to the frontend how demanding this implementation
  348. // is on a system. E.g. reporting a level of 2 means
  349. // this implementation should run decently on all frontends
  350. // of level 2 and up.
  351. //
  352. // It can be used by the frontend to potentially warn
  353. // about too demanding implementations.
  354. //
  355. // The levels are "floating", but roughly defined as:
  356. // 0: Low-powered embedded devices such as Raspberry Pi
  357. // 1: 6th generation consoles, such as Wii/Xbox 1, and phones, tablets, etc.
  358. // 2: 7th generation consoles, such as PS3/360, with sub-par CPUs.
  359. // 3: Modern desktop/laptops with reasonably powerful CPUs.
  360. // 4: High-end desktops with very powerful CPUs.
  361. //
  362. // This function can be called on a per-game basis,
  363. // as certain games an implementation can play might be
  364. // particularily demanding.
  365. // If called, it should be called in retro_load_game().
  366. //
  367. #define RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY 9
  368. // const char ** --
  369. // Returns the "system" directory of the frontend.
  370. // This directory can be used to store system specific ROMs such as BIOSes, configuration data, etc.
  371. // The returned value can be NULL.
  372. // If so, no such directory is defined,
  373. // and it's up to the implementation to find a suitable directory.
  374. //
  375. #define RETRO_ENVIRONMENT_SET_PIXEL_FORMAT 10
  376. // const enum retro_pixel_format * --
  377. // Sets the internal pixel format used by the implementation.
  378. // The default pixel format is RETRO_PIXEL_FORMAT_0RGB1555.
  379. // This pixel format however, is deprecated (see enum retro_pixel_format).
  380. // If the call returns false, the frontend does not support this pixel format.
  381. // This function should be called inside retro_load_game() or retro_get_system_av_info().
  382. //
  383. #define RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS 11
  384. // const struct retro_input_descriptor * --
  385. // Sets an array of retro_input_descriptors.
  386. // It is up to the frontend to present this in a usable way.
  387. // The array is terminated by retro_input_descriptor::description being set to NULL.
  388. // This function can be called at any time, but it is recommended to call it as early as possible.
  389. #define RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK 12
  390. // const struct retro_keyboard_callback * --
  391. // Sets a callback function used to notify core about keyboard events.
  392. //
  393. #define RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE 13
  394. // const struct retro_disk_control_callback * --
  395. // Sets an interface which frontend can use to eject and insert disk images.
  396. // This is used for games which consist of multiple images and must be manually
  397. // swapped out by the user (e.g. PSX).
  398. #define RETRO_ENVIRONMENT_SET_HW_RENDER (14 | RETRO_ENVIRONMENT_EXPERIMENTAL)
  399. // struct retro_hw_render_callback * --
  400. // NOTE: This call is currently very experimental, and should not be considered part of the public API.
  401. // The interface could be changed or removed at any time.
  402. // Sets an interface to let a libretro core render with hardware acceleration.
  403. // Should be called in retro_load_game().
  404. // If successful, libretro cores will be able to render to a frontend-provided framebuffer.
  405. // The size of this framebuffer will be at least as large as max_width/max_height provided in get_av_info().
  406. // If HW rendering is used, pass only RETRO_HW_FRAME_BUFFER_VALID or NULL to retro_video_refresh_t.
  407. #define RETRO_ENVIRONMENT_GET_VARIABLE 15
  408. // struct retro_variable * --
  409. // Interface to aquire user-defined information from environment
  410. // that cannot feasibly be supported in a multi-system way.
  411. // 'key' should be set to a key which has already been set by SET_VARIABLES.
  412. // 'data' will be set to a value or NULL.
  413. //
  414. #define RETRO_ENVIRONMENT_SET_VARIABLES 16
  415. // const struct retro_variable * --
  416. // Allows an implementation to signal the environment
  417. // which variables it might want to check for later using GET_VARIABLE.
  418. // This allows the frontend to present these variables to a user dynamically.
  419. // This should be called as early as possible (ideally in retro_set_environment).
  420. //
  421. // 'data' points to an array of retro_variable structs terminated by a { NULL, NULL } element.
  422. // retro_variable::key should be namespaced to not collide with other implementations' keys. E.g. A core called 'foo' should use keys named as 'foo_option'.
  423. // retro_variable::value should contain a human readable description of the key as well as a '|' delimited list of expected values.
  424. // The number of possible options should be very limited, i.e. it should be feasible to cycle through options without a keyboard.
  425. // First entry should be treated as a default.
  426. //
  427. // Example entry:
  428. // { "foo_option", "Speed hack coprocessor X; false|true" }
  429. //
  430. // Text before first ';' is description. This ';' must be followed by a space, and followed by a list of possible values split up with '|'.
  431. // Only strings are operated on. The possible values will generally be displayed and stored as-is by the frontend.
  432. //
  433. #define RETRO_ENVIRONMENT_GET_VARIABLE_UPDATE 17
  434. // bool * --
  435. // Result is set to true if some variables are updated by
  436. // frontend since last call to RETRO_ENVIRONMENT_GET_VARIABLE.
  437. // Variables should be queried with GET_VARIABLE.
  438. //
  439. #define RETRO_ENVIRONMENT_SET_SUPPORT_NO_GAME 18
  440. // const bool * --
  441. // If true, the libretro implementation supports calls to retro_load_game() with NULL as argument.
  442. // Used by cores which can run without particular game data.
  443. // This should be called within retro_set_environment() only.
  444. // Pass this to retro_video_refresh_t if rendering to hardware.
  445. // Passing NULL to retro_video_refresh_t is still a frame dupe as normal.
  446. #define RETRO_HW_FRAME_BUFFER_VALID ((void*)-1)
  447. // Invalidates the current HW context.
  448. // If called, all GPU resources must be reinitialized.
  449. // Usually called when frontend reinits video driver.
  450. // Also called first time video driver is initialized, allowing libretro core to init resources.
  451. typedef void (*retro_hw_context_reset_t)(void);
  452. // Gets current framebuffer which is to be rendered to. Could change every frame potentially.
  453. typedef uintptr_t (*retro_hw_get_current_framebuffer_t)(void);
  454. // Get a symbol from HW context.
  455. typedef void (*retro_proc_address_t)(void);
  456. typedef retro_proc_address_t (*retro_hw_get_proc_address_t)(const char *sym);
  457. enum retro_hw_context_type
  458. {
  459. RETRO_HW_CONTEXT_NONE = 0,
  460. RETRO_HW_CONTEXT_OPENGL, // OpenGL 2.x. Latest version available before 3.x+.
  461. RETRO_HW_CONTEXT_OPENGLES2, // GLES 2.0
  462. RETRO_HW_CONTEXT_DUMMY = INT_MAX
  463. };
  464. struct retro_hw_render_callback
  465. {
  466. enum retro_hw_context_type context_type; // Which API to use. Set by libretro core.
  467. retro_hw_context_reset_t context_reset; // Set by libretro core.
  468. retro_hw_get_current_framebuffer_t get_current_framebuffer; // Set by frontend.
  469. retro_hw_get_proc_address_t get_proc_address; // Set by frontend.
  470. bool depth; // Set if render buffers should have depth component attached.
  471. };
  472. // Callback type passed in RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK. Called by the frontend in response to keyboard events.
  473. // down is set if the key is being pressed, or false if it is being released.
  474. // keycode is the RETROK value of the char.
  475. // character is the text character of the pressed key. (UTF-32).
  476. // key_modifiers is a set of RETROKMOD values or'ed together.
  477. typedef void (*retro_keyboard_event_t)(bool down, unsigned keycode, uint32_t character, uint16_t key_modifiers);
  478. struct retro_keyboard_callback
  479. {
  480. retro_keyboard_event_t callback;
  481. };
  482. // Callbacks for RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE.
  483. // Should be set for implementations which can swap out multiple disk images in runtime.
  484. // If the implementation can do this automatically, it should strive to do so.
  485. // However, there are cases where the user must manually do so.
  486. //
  487. // Overview: To swap a disk image, eject the disk image with set_eject_state(true).
  488. // Set the disk index with set_image_index(index). Insert the disk again with set_eject_state(false).
  489. // If ejected is true, "ejects" the virtual disk tray.
  490. // When ejected, the disk image index can be set.
  491. typedef bool (*retro_set_eject_state_t)(bool ejected);
  492. // Gets current eject state. The initial state is 'not ejected'.
  493. typedef bool (*retro_get_eject_state_t)(void);
  494. // Gets current disk index. First disk is index 0.
  495. // If return value is >= get_num_images(), no disk is currently inserted.
  496. typedef unsigned (*retro_get_image_index_t)(void);
  497. // Sets image index. Can only be called when disk is ejected.
  498. // The implementation supports setting "no disk" by using an index >= get_num_images().
  499. typedef bool (*retro_set_image_index_t)(unsigned index);
  500. // Gets total number of images which are available to use.
  501. typedef unsigned (*retro_get_num_images_t)(void);
  502. //
  503. // Replaces the disk image associated with index.
  504. // Arguments to pass in info have same requirements as retro_load_game().
  505. // Virtual disk tray must be ejected when calling this.
  506. // Replacing a disk image with info = NULL will remove the disk image from the internal list.
  507. // As a result, calls to get_image_index() can change.
  508. //
  509. // E.g. replace_image_index(1, NULL), and previous get_image_index() returned 4 before.
  510. // Index 1 will be removed, and the new index is 3.
  511. struct retro_game_info;
  512. typedef bool (*retro_replace_image_index_t)(unsigned index, const struct retro_game_info *info);
  513. // Adds a new valid index (get_num_images()) to the internal disk list.
  514. // This will increment subsequent return values from get_num_images() by 1.
  515. // This image index cannot be used until a disk image has been set with replace_image_index.
  516. typedef bool (*retro_add_image_index_t)(void);
  517. struct retro_disk_control_callback
  518. {
  519. retro_set_eject_state_t set_eject_state;
  520. retro_get_eject_state_t get_eject_state;
  521. retro_get_image_index_t get_image_index;
  522. retro_set_image_index_t set_image_index;
  523. retro_get_num_images_t get_num_images;
  524. retro_replace_image_index_t replace_image_index;
  525. retro_add_image_index_t add_image_index;
  526. };
  527. enum retro_pixel_format
  528. {
  529. // 0RGB1555, native endian. 0 bit must be set to 0.
  530. // This pixel format is default for compatibility concerns only.
  531. // If a 15/16-bit pixel format is desired, consider using RGB565.
  532. RETRO_PIXEL_FORMAT_0RGB1555 = 0,
  533. // XRGB8888, native endian. X bits are ignored.
  534. RETRO_PIXEL_FORMAT_XRGB8888 = 1,
  535. // RGB565, native endian. This pixel format is the recommended format to use if a 15/16-bit format is desired
  536. // as it is the pixel format that is typically available on a wide range of low-power devices.
  537. // It is also natively supported in APIs like OpenGL ES.
  538. RETRO_PIXEL_FORMAT_RGB565 = 2,
  539. // Ensure sizeof() == sizeof(int).
  540. RETRO_PIXEL_FORMAT_UNKNOWN = INT_MAX
  541. };
  542. struct retro_message
  543. {
  544. const char *msg; // Message to be displayed.
  545. unsigned frames; // Duration in frames of message.
  546. };
  547. // Describes how the libretro implementation maps a libretro input bind
  548. // to its internal input system through a human readable string.
  549. // This string can be used to better let a user configure input.
  550. struct retro_input_descriptor
  551. {
  552. // Associates given parameters with a description.
  553. unsigned port;
  554. unsigned device;
  555. unsigned index;
  556. unsigned id;
  557. const char *description; // Human readable description for parameters.
  558. // The pointer must remain valid until retro_unload_game() is called.
  559. };
  560. struct retro_system_info
  561. {
  562. // All pointers are owned by libretro implementation, and pointers must remain valid until retro_deinit() is called.
  563. const char *library_name; // Descriptive name of library. Should not contain any version numbers, etc.
  564. const char *library_version; // Descriptive version of core.
  565. const char *valid_extensions; // A string listing probably rom extensions the core will be able to load, separated with pipe.
  566. // I.e. "bin|rom|iso".
  567. // Typically used for a GUI to filter out extensions.
  568. bool need_fullpath; // If true, retro_load_game() is guaranteed to provide a valid pathname in retro_game_info::path.
  569. // ::data and ::size are both invalid.
  570. // If false, ::data and ::size are guaranteed to be valid, but ::path might not be valid.
  571. // This is typically set to true for libretro implementations that must load from file.
  572. // Implementations should strive for setting this to false, as it allows the frontend to perform patching, etc.
  573. bool block_extract; // If true, the frontend is not allowed to extract any archives before loading the real ROM.
  574. // Necessary for certain libretro implementations that load games from zipped archives.
  575. };
  576. struct retro_game_geometry
  577. {
  578. unsigned base_width; // Nominal video width of game.
  579. unsigned base_height; // Nominal video height of game.
  580. unsigned max_width; // Maximum possible width of game.
  581. unsigned max_height; // Maximum possible height of game.
  582. float aspect_ratio; // Nominal aspect ratio of game. If aspect_ratio is <= 0.0,
  583. // an aspect ratio of base_width / base_height is assumed.
  584. // A frontend could override this setting if desired.
  585. };
  586. struct retro_system_timing
  587. {
  588. double fps; // FPS of video content.
  589. double sample_rate; // Sampling rate of audio.
  590. };
  591. struct retro_system_av_info
  592. {
  593. struct retro_game_geometry geometry;
  594. struct retro_system_timing timing;
  595. };
  596. struct retro_variable
  597. {
  598. const char *key; // Variable to query in RETRO_ENVIRONMENT_GET_VARIABLE.
  599. // If NULL, obtains the complete environment string if more complex parsing is necessary.
  600. // The environment string is formatted as key-value pairs delimited by semicolons as so:
  601. // "key1=value1;key2=value2;..."
  602. const char *value; // Value to be obtained. If key does not exist, it is set to NULL.
  603. };
  604. struct retro_game_info
  605. {
  606. const char *path; // Path to game, UTF-8 encoded. Usually used as a reference.
  607. // May be NULL if rom was loaded from stdin or similar.
  608. // retro_system_info::need_fullpath guaranteed that this path is valid.
  609. const void *data; // Memory buffer of loaded game. Will be NULL if need_fullpath was set.
  610. size_t size; // Size of memory buffer.
  611. const char *meta; // String of implementation specific meta-data.
  612. };
  613. // Callbacks
  614. //
  615. // Environment callback. Gives implementations a way of performing uncommon tasks. Extensible.
  616. typedef bool (*retro_environment_t)(unsigned cmd, void *data);
  617. // Render a frame. Pixel format is 15-bit 0RGB1555 native endian unless changed (see RETRO_ENVIRONMENT_SET_PIXEL_FORMAT).
  618. // Width and height specify dimensions of buffer.
  619. // Pitch specifices length in bytes between two lines in buffer.
  620. // For performance reasons, it is highly recommended to have a frame that is packed in memory, i.e. pitch == width * byte_per_pixel.
  621. // Certain graphic APIs, such as OpenGL ES, do not like textures that are not packed in memory.
  622. typedef void (*retro_video_refresh_t)(const void *data, unsigned width, unsigned height, size_t pitch);
  623. // Renders a single audio frame. Should only be used if implementation generates a single sample at a time.
  624. // Format is signed 16-bit native endian.
  625. typedef void (*retro_audio_sample_t)(int16_t left, int16_t right);
  626. // Renders multiple audio frames in one go. One frame is defined as a sample of left and right channels, interleaved.
  627. // I.e. int16_t buf[4] = { l, r, l, r }; would be 2 frames.
  628. // Only one of the audio callbacks must ever be used.
  629. typedef size_t (*retro_audio_sample_batch_t)(const int16_t *data, size_t frames);
  630. // Polls input.
  631. typedef void (*retro_input_poll_t)(void);
  632. // Queries for input for player 'port'. device will be masked with RETRO_DEVICE_MASK.
  633. // Specialization of devices such as RETRO_DEVICE_JOYPAD_MULTITAP that have been set with retro_set_controller_port_device()
  634. // will still use the higher level RETRO_DEVICE_JOYPAD to request input.
  635. typedef int16_t (*retro_input_state_t)(unsigned port, unsigned device, unsigned index, unsigned id);
  636. // Sets callbacks. retro_set_environment() is guaranteed to be called before retro_init().
  637. // The rest of the set_* functions are guaranteed to have been called before the first call to retro_run() is made.
  638. void retro_set_environment(retro_environment_t);
  639. void retro_set_video_refresh(retro_video_refresh_t);
  640. void retro_set_audio_sample(retro_audio_sample_t);
  641. void retro_set_audio_sample_batch(retro_audio_sample_batch_t);
  642. void retro_set_input_poll(retro_input_poll_t);
  643. void retro_set_input_state(retro_input_state_t);
  644. // Library global initialization/deinitialization.
  645. void retro_init(void);
  646. void retro_deinit(void);
  647. // Must return RETRO_API_VERSION. Used to validate ABI compatibility when the API is revised.
  648. unsigned retro_api_version(void);
  649. // Gets statically known system info. Pointers provided in *info must be statically allocated.
  650. // Can be called at any time, even before retro_init().
  651. void retro_get_system_info(struct retro_system_info *info);
  652. // Gets information about system audio/video timings and geometry.
  653. // Can be called only after retro_load_game() has successfully completed.
  654. // NOTE: The implementation of this function might not initialize every variable if needed.
  655. // E.g. geom.aspect_ratio might not be initialized if core doesn't desire a particular aspect ratio.
  656. void retro_get_system_av_info(struct retro_system_av_info *info);
  657. // Sets device to be used for player 'port'.
  658. void retro_set_controller_port_device(unsigned port, unsigned device);
  659. // Resets the current game.
  660. void retro_reset(void);
  661. // Runs the game for one video frame.
  662. // During retro_run(), input_poll callback must be called at least once.
  663. //
  664. // If a frame is not rendered for reasons where a game "dropped" a frame,
  665. // this still counts as a frame, and retro_run() should explicitly dupe a frame if GET_CAN_DUPE returns true.
  666. // In this case, the video callback can take a NULL argument for data.
  667. void retro_run(void);
  668. // Returns the amount of data the implementation requires to serialize internal state (save states).
  669. // Beetween calls to retro_load_game() and retro_unload_game(), the returned size is never allowed to be larger than a previous returned value, to
  670. // ensure that the frontend can allocate a save state buffer once.
  671. size_t retro_serialize_size(void);
  672. // Serializes internal state. If failed, or size is lower than retro_serialize_size(), it should return false, true otherwise.
  673. bool retro_serialize(void *data, size_t size);
  674. bool retro_unserialize(const void *data, size_t size);
  675. void retro_cheat_reset(void);
  676. void retro_cheat_set(unsigned index, bool enabled, const char *code);
  677. // Loads a game.
  678. bool retro_load_game(const struct retro_game_info *game);
  679. // Loads a "special" kind of game. Should not be used except in extreme cases.
  680. bool retro_load_game_special(
  681. unsigned game_type,
  682. const struct retro_game_info *info, size_t num_info
  683. );
  684. // Unloads a currently loaded game.
  685. void retro_unload_game(void);
  686. // Gets region of game.
  687. unsigned retro_get_region(void);
  688. // Gets region of memory.
  689. void *retro_get_memory_data(unsigned id);
  690. size_t retro_get_memory_size(unsigned id);
  691. #ifdef __cplusplus
  692. }
  693. #endif
  694. #endif