aboutsummaryrefslogtreecommitdiff
path: root/libretro-common
diff options
context:
space:
mode:
Diffstat (limited to 'libretro-common')
-rw-r--r--libretro-common/compat/compat_posix_string.c104
-rw-r--r--libretro-common/compat/compat_strcasestr.c58
-rw-r--r--libretro-common/compat/compat_strl.c69
-rw-r--r--libretro-common/compat/fopen_utf8.c63
-rw-r--r--libretro-common/encodings/encoding_utf.c512
-rw-r--r--libretro-common/file/file_path.c1381
-rw-r--r--libretro-common/file/file_path_io.c151
-rw-r--r--libretro-common/include/boolean.h4
-rw-r--r--libretro-common/include/compat/fopen_utf8.h34
-rw-r--r--libretro-common/include/compat/msvc.h24
-rw-r--r--libretro-common/include/compat/msvc/stdint.h3
-rw-r--r--libretro-common/include/compat/posix_string.h60
-rw-r--r--libretro-common/include/compat/strcasestr.h48
-rw-r--r--libretro-common/include/compat/strl.h59
-rw-r--r--libretro-common/include/encodings/utf.h67
-rw-r--r--libretro-common/include/file/file_path.h538
-rw-r--r--libretro-common/include/libretro.h3822
-rw-r--r--libretro-common/include/retro_assert.h35
-rw-r--r--libretro-common/include/retro_common_api.h119
-rw-r--r--libretro-common/include/retro_environment.h114
-rw-r--r--libretro-common/include/retro_inline.h2
-rw-r--r--libretro-common/include/retro_miscellaneous.h72
-rw-r--r--libretro-common/include/streams/file_stream.h115
-rw-r--r--libretro-common/include/string/stdstring.h250
-rw-r--r--libretro-common/include/time/rtime.h48
-rw-r--r--libretro-common/include/vfs/vfs.h111
-rw-r--r--libretro-common/include/vfs/vfs_implementation.h76
-rw-r--r--libretro-common/streams/file_stream.c663
-rw-r--r--libretro-common/streams/file_stream_transforms.c159
-rw-r--r--libretro-common/string/stdstring.c536
-rw-r--r--libretro-common/time/rtime.c81
-rw-r--r--libretro-common/vfs/vfs_implementation.c1335
32 files changed, 10683 insertions, 30 deletions
diff --git a/libretro-common/compat/compat_posix_string.c b/libretro-common/compat/compat_posix_string.c
new file mode 100644
index 0000000..6a2f07e
--- /dev/null
+++ b/libretro-common/compat/compat_posix_string.c
@@ -0,0 +1,104 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (compat_posix_string.c).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <ctype.h>
+
+#include <compat/posix_string.h>
+
+#ifdef _WIN32
+
+#undef strcasecmp
+#undef strdup
+#undef isblank
+#undef strtok_r
+#include <ctype.h>
+#include <stdlib.h>
+#include <stddef.h>
+#include <compat/strl.h>
+
+#include <string.h>
+
+int retro_strcasecmp__(const char *a, const char *b)
+{
+ while (*a && *b)
+ {
+ int a_ = tolower(*a);
+ int b_ = tolower(*b);
+
+ if (a_ != b_)
+ return a_ - b_;
+
+ a++;
+ b++;
+ }
+
+ return tolower(*a) - tolower(*b);
+}
+
+char *retro_strdup__(const char *orig)
+{
+ size_t len = strlen(orig) + 1;
+ char *ret = (char*)malloc(len);
+ if (!ret)
+ return NULL;
+
+ strlcpy(ret, orig, len);
+ return ret;
+}
+
+int retro_isblank__(int c)
+{
+ return (c == ' ') || (c == '\t');
+}
+
+char *retro_strtok_r__(char *str, const char *delim, char **saveptr)
+{
+ char *first = NULL;
+ if (!saveptr || !delim)
+ return NULL;
+
+ if (str)
+ *saveptr = str;
+
+ do
+ {
+ char *ptr = NULL;
+ first = *saveptr;
+ while (*first && strchr(delim, *first))
+ *first++ = '\0';
+
+ if (*first == '\0')
+ return NULL;
+
+ ptr = first + 1;
+
+ while (*ptr && !strchr(delim, *ptr))
+ ptr++;
+
+ *saveptr = ptr + (*ptr ? 1 : 0);
+ *ptr = '\0';
+ } while (strlen(first) == 0);
+
+ return first;
+}
+
+#endif
diff --git a/libretro-common/compat/compat_strcasestr.c b/libretro-common/compat/compat_strcasestr.c
new file mode 100644
index 0000000..4129dab
--- /dev/null
+++ b/libretro-common/compat/compat_strcasestr.c
@@ -0,0 +1,58 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (compat_strcasestr.c).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <ctype.h>
+
+#include <compat/strcasestr.h>
+
+/* Pretty much strncasecmp. */
+static int casencmp(const char *a, const char *b, size_t n)
+{
+ size_t i;
+
+ for (i = 0; i < n; i++)
+ {
+ int a_lower = tolower(a[i]);
+ int b_lower = tolower(b[i]);
+ if (a_lower != b_lower)
+ return a_lower - b_lower;
+ }
+
+ return 0;
+}
+
+char *strcasestr_retro__(const char *haystack, const char *needle)
+{
+ size_t i, search_off;
+ size_t hay_len = strlen(haystack);
+ size_t needle_len = strlen(needle);
+
+ if (needle_len > hay_len)
+ return NULL;
+
+ search_off = hay_len - needle_len;
+ for (i = 0; i <= search_off; i++)
+ if (!casencmp(haystack + i, needle, needle_len))
+ return (char*)haystack + i;
+
+ return NULL;
+}
diff --git a/libretro-common/compat/compat_strl.c b/libretro-common/compat/compat_strl.c
new file mode 100644
index 0000000..3172310
--- /dev/null
+++ b/libretro-common/compat/compat_strl.c
@@ -0,0 +1,69 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (compat_strl.c).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <stdlib.h>
+#include <ctype.h>
+
+#include <compat/strl.h>
+
+/* Implementation of strlcpy()/strlcat() based on OpenBSD. */
+
+#ifndef __MACH__
+
+size_t strlcpy(char *dest, const char *source, size_t size)
+{
+ size_t src_size = 0;
+ size_t n = size;
+
+ if (n)
+ while (--n && (*dest++ = *source++)) src_size++;
+
+ if (!n)
+ {
+ if (size) *dest = '\0';
+ while (*source++) src_size++;
+ }
+
+ return src_size;
+}
+
+size_t strlcat(char *dest, const char *source, size_t size)
+{
+ size_t len = strlen(dest);
+
+ dest += len;
+
+ if (len > size)
+ size = 0;
+ else
+ size -= len;
+
+ return len + strlcpy(dest, source, size);
+}
+#endif
+
+char *strldup(const char *s, size_t n)
+{
+ char *dst = (char*)malloc(sizeof(char) * (n + 1));
+ strlcpy(dst, s, n);
+ return dst;
+}
diff --git a/libretro-common/compat/fopen_utf8.c b/libretro-common/compat/fopen_utf8.c
new file mode 100644
index 0000000..85abb59
--- /dev/null
+++ b/libretro-common/compat/fopen_utf8.c
@@ -0,0 +1,63 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (fopen_utf8.c).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <compat/fopen_utf8.h>
+#include <encodings/utf.h>
+#include <stdio.h>
+#include <stdlib.h>
+
+#if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0500 || defined(_XBOX)
+#ifndef LEGACY_WIN32
+#define LEGACY_WIN32
+#endif
+#endif
+
+#ifdef _WIN32
+#undef fopen
+
+void *fopen_utf8(const char * filename, const char * mode)
+{
+#if defined(LEGACY_WIN32)
+ FILE *ret = NULL;
+ char * filename_local = utf8_to_local_string_alloc(filename);
+
+ if (!filename_local)
+ return NULL;
+ ret = fopen(filename_local, mode);
+ if (filename_local)
+ free(filename_local);
+ return ret;
+#else
+ wchar_t * filename_w = utf8_to_utf16_string_alloc(filename);
+ wchar_t * mode_w = utf8_to_utf16_string_alloc(mode);
+ FILE* ret = NULL;
+
+ if (filename_w && mode_w)
+ ret = _wfopen(filename_w, mode_w);
+ if (filename_w)
+ free(filename_w);
+ if (mode_w)
+ free(mode_w);
+ return ret;
+#endif
+}
+#endif
diff --git a/libretro-common/encodings/encoding_utf.c b/libretro-common/encodings/encoding_utf.c
new file mode 100644
index 0000000..2760824
--- /dev/null
+++ b/libretro-common/encodings/encoding_utf.c
@@ -0,0 +1,512 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (encoding_utf.c).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <stdint.h>
+#include <stdlib.h>
+#include <stddef.h>
+#include <string.h>
+
+#include <boolean.h>
+#include <compat/strl.h>
+#include <retro_inline.h>
+
+#include <encodings/utf.h>
+
+#if defined(_WIN32) && !defined(_XBOX)
+#include <windows.h>
+#elif defined(_XBOX)
+#include <xtl.h>
+#endif
+
+#define UTF8_WALKBYTE(string) (*((*(string))++))
+
+static unsigned leading_ones(uint8_t c)
+{
+ unsigned ones = 0;
+ while (c & 0x80)
+ {
+ ones++;
+ c <<= 1;
+ }
+
+ return ones;
+}
+
+/* Simple implementation. Assumes the sequence is
+ * properly synchronized and terminated. */
+
+size_t utf8_conv_utf32(uint32_t *out, size_t out_chars,
+ const char *in, size_t in_size)
+{
+ unsigned i;
+ size_t ret = 0;
+ while (in_size && out_chars)
+ {
+ unsigned extra, shift;
+ uint32_t c;
+ uint8_t first = *in++;
+ unsigned ones = leading_ones(first);
+
+ if (ones > 6 || ones == 1) /* Invalid or desync. */
+ break;
+
+ extra = ones ? ones - 1 : ones;
+ if (1 + extra > in_size) /* Overflow. */
+ break;
+
+ shift = (extra - 1) * 6;
+ c = (first & ((1 << (7 - ones)) - 1)) << (6 * extra);
+
+ for (i = 0; i < extra; i++, in++, shift -= 6)
+ c |= (*in & 0x3f) << shift;
+
+ *out++ = c;
+ in_size -= 1 + extra;
+ out_chars--;
+ ret++;
+ }
+
+ return ret;
+}
+
+bool utf16_conv_utf8(uint8_t *out, size_t *out_chars,
+ const uint16_t *in, size_t in_size)
+{
+ size_t out_pos = 0;
+ size_t in_pos = 0;
+ static const
+ uint8_t utf8_limits[5] = { 0xC0, 0xE0, 0xF0, 0xF8, 0xFC };
+
+ for (;;)
+ {
+ unsigned num_adds;
+ uint32_t value;
+
+ if (in_pos == in_size)
+ {
+ *out_chars = out_pos;
+ return true;
+ }
+ value = in[in_pos++];
+ if (value < 0x80)
+ {
+ if (out)
+ out[out_pos] = (char)value;
+ out_pos++;
+ continue;
+ }
+
+ if (value >= 0xD800 && value < 0xE000)
+ {
+ uint32_t c2;
+
+ if (value >= 0xDC00 || in_pos == in_size)
+ break;
+ c2 = in[in_pos++];
+ if (c2 < 0xDC00 || c2 >= 0xE000)
+ break;
+ value = (((value - 0xD800) << 10) | (c2 - 0xDC00)) + 0x10000;
+ }
+
+ for (num_adds = 1; num_adds < 5; num_adds++)
+ if (value < (((uint32_t)1) << (num_adds * 5 + 6)))
+ break;
+ if (out)
+ out[out_pos] = (char)(utf8_limits[num_adds - 1]
+ + (value >> (6 * num_adds)));
+ out_pos++;
+ do
+ {
+ num_adds--;
+ if (out)
+ out[out_pos] = (char)(0x80
+ + ((value >> (6 * num_adds)) & 0x3F));
+ out_pos++;
+ }while (num_adds != 0);
+ }
+
+ *out_chars = out_pos;
+ return false;
+}
+
+/* Acts mostly like strlcpy.
+ *
+ * Copies the given number of UTF-8 characters,
+ * but at most d_len bytes.
+ *
+ * Always NULL terminates.
+ * Does not copy half a character.
+ *
+ * Returns number of bytes. 's' is assumed valid UTF-8.
+ * Use only if 'chars' is considerably less than 'd_len'. */
+size_t utf8cpy(char *d, size_t d_len, const char *s, size_t chars)
+{
+ const uint8_t *sb = (const uint8_t*)s;
+ const uint8_t *sb_org = sb;
+
+ if (!s)
+ return 0;
+
+ while (*sb && chars-- > 0)
+ {
+ sb++;
+ while ((*sb & 0xC0) == 0x80)
+ sb++;
+ }
+
+ if ((size_t)(sb - sb_org) > d_len-1 /* NUL */)
+ {
+ sb = sb_org + d_len-1;
+ while ((*sb & 0xC0) == 0x80)
+ sb--;
+ }
+
+ memcpy(d, sb_org, sb-sb_org);
+ d[sb-sb_org] = '\0';
+
+ return sb-sb_org;
+}
+
+const char *utf8skip(const char *str, size_t chars)
+{
+ const uint8_t *strb = (const uint8_t*)str;
+
+ if (!chars)
+ return str;
+
+ do
+ {
+ strb++;
+ while ((*strb & 0xC0)==0x80)
+ strb++;
+ chars--;
+ }while (chars);
+
+ return (const char*)strb;
+}
+
+size_t utf8len(const char *string)
+{
+ size_t ret = 0;
+
+ if (!string)
+ return 0;
+
+ while (*string)
+ {
+ if ((*string & 0xC0) != 0x80)
+ ret++;
+ string++;
+ }
+ return ret;
+}
+
+/* Does not validate the input, returns garbage if it's not UTF-8. */
+uint32_t utf8_walk(const char **string)
+{
+ uint8_t first = UTF8_WALKBYTE(string);
+ uint32_t ret = 0;
+
+ if (first < 128)
+ return first;
+
+ ret = (ret << 6) | (UTF8_WALKBYTE(string) & 0x3F);
+ if (first >= 0xE0)
+ {
+ ret = (ret << 6) | (UTF8_WALKBYTE(string) & 0x3F);
+ if (first >= 0xF0)
+ {
+ ret = (ret << 6) | (UTF8_WALKBYTE(string) & 0x3F);
+ return ret | (first & 7) << 18;
+ }
+ return ret | (first & 15) << 12;
+ }
+
+ return ret | (first & 31) << 6;
+}
+
+static bool utf16_to_char(uint8_t **utf_data,
+ size_t *dest_len, const uint16_t *in)
+{
+ unsigned len = 0;
+
+ while (in[len] != '\0')
+ len++;
+
+ utf16_conv_utf8(NULL, dest_len, in, len);
+ *dest_len += 1;
+ *utf_data = (uint8_t*)malloc(*dest_len);
+ if (*utf_data == 0)
+ return false;
+
+ return utf16_conv_utf8(*utf_data, dest_len, in, len);
+}
+
+bool utf16_to_char_string(const uint16_t *in, char *s, size_t len)
+{
+ size_t dest_len = 0;
+ uint8_t *utf16_data = NULL;
+ bool ret = utf16_to_char(&utf16_data, &dest_len, in);
+
+ if (ret)
+ {
+ utf16_data[dest_len] = 0;
+ strlcpy(s, (const char*)utf16_data, len);
+ }
+
+ free(utf16_data);
+ utf16_data = NULL;
+
+ return ret;
+}
+
+#if defined(_WIN32) && !defined(_XBOX) && !defined(UNICODE)
+/* Returned pointer MUST be freed by the caller if non-NULL. */
+static char *mb_to_mb_string_alloc(const char *str,
+ enum CodePage cp_in, enum CodePage cp_out)
+{
+ wchar_t *path_buf_wide = NULL;
+ int path_buf_wide_len = MultiByteToWideChar(cp_in, 0, str, -1, NULL, 0);
+
+ /* Windows 95 will return 0 from these functions with
+ * a UTF8 codepage set without MSLU.
+ *
+ * From an unknown MSDN version (others omit this info):
+ * - CP_UTF8 Windows 98/Me, Windows NT 4.0 and later:
+ * Translate using UTF-8. When this is set, dwFlags must be zero.
+ * - Windows 95: Under the Microsoft Layer for Unicode,
+ * MultiByteToWideChar also supports CP_UTF7 and CP_UTF8.
+ */
+
+ if (!path_buf_wide_len)
+ return strdup(str);
+
+ path_buf_wide = (wchar_t*)
+ calloc(path_buf_wide_len + sizeof(wchar_t), sizeof(wchar_t));
+
+ if (path_buf_wide)
+ {
+ MultiByteToWideChar(cp_in, 0,
+ str, -1, path_buf_wide, path_buf_wide_len);
+
+ if (*path_buf_wide)
+ {
+ int path_buf_len = WideCharToMultiByte(cp_out, 0,
+ path_buf_wide, -1, NULL, 0, NULL, NULL);
+
+ if (path_buf_len)
+ {
+ char *path_buf = (char*)
+ calloc(path_buf_len + sizeof(char), sizeof(char));
+
+ if (path_buf)
+ {
+ WideCharToMultiByte(cp_out, 0,
+ path_buf_wide, -1, path_buf,
+ path_buf_len, NULL, NULL);
+
+ free(path_buf_wide);
+
+ if (*path_buf)
+ return path_buf;
+
+ free(path_buf);
+ return NULL;
+ }
+ }
+ else
+ {
+ free(path_buf_wide);
+ return strdup(str);
+ }
+ }
+
+ free(path_buf_wide);
+ }
+
+ return NULL;
+}
+#endif
+
+/* Returned pointer MUST be freed by the caller if non-NULL. */
+char* utf8_to_local_string_alloc(const char *str)
+{
+ if (str && *str)
+ {
+#if defined(_WIN32) && !defined(_XBOX) && !defined(UNICODE)
+ return mb_to_mb_string_alloc(str, CODEPAGE_UTF8, CODEPAGE_LOCAL);
+#else
+ /* assume string needs no modification if not on Windows */
+ return strdup(str);
+#endif
+ }
+ return NULL;
+}
+
+/* Returned pointer MUST be freed by the caller if non-NULL. */
+char* local_to_utf8_string_alloc(const char *str)
+{
+ if (str && *str)
+ {
+#if defined(_WIN32) && !defined(_XBOX) && !defined(UNICODE)
+ return mb_to_mb_string_alloc(str, CODEPAGE_LOCAL, CODEPAGE_UTF8);
+#else
+ /* assume string needs no modification if not on Windows */
+ return strdup(str);
+#endif
+ }
+ return NULL;
+}
+
+/* Returned pointer MUST be freed by the caller if non-NULL. */
+wchar_t* utf8_to_utf16_string_alloc(const char *str)
+{
+#ifdef _WIN32
+ int len = 0;
+ int out_len = 0;
+#else
+ size_t len = 0;
+ size_t out_len = 0;
+#endif
+ wchar_t *buf = NULL;
+
+ if (!str || !*str)
+ return NULL;
+
+#ifdef _WIN32
+ len = MultiByteToWideChar(CP_UTF8, 0, str, -1, NULL, 0);
+
+ if (len)
+ {
+ buf = (wchar_t*)calloc(len, sizeof(wchar_t));
+
+ if (!buf)
+ return NULL;
+
+ out_len = MultiByteToWideChar(CP_UTF8, 0, str, -1, buf, len);
+ }
+ else
+ {
+ /* fallback to ANSI codepage instead */
+ len = MultiByteToWideChar(CP_ACP, 0, str, -1, NULL, 0);
+
+ if (len)
+ {
+ buf = (wchar_t*)calloc(len, sizeof(wchar_t));
+
+ if (!buf)
+ return NULL;
+
+ out_len = MultiByteToWideChar(CP_ACP, 0, str, -1, buf, len);
+ }
+ }
+
+ if (out_len < 0)
+ {
+ free(buf);
+ return NULL;
+ }
+#else
+ /* NOTE: For now, assume non-Windows platforms' locale is already UTF-8. */
+ len = mbstowcs(NULL, str, 0) + 1;
+
+ if (len)
+ {
+ buf = (wchar_t*)calloc(len, sizeof(wchar_t));
+
+ if (!buf)
+ return NULL;
+
+ out_len = mbstowcs(buf, str, len);
+ }
+
+ if (out_len == (size_t)-1)
+ {
+ free(buf);
+ return NULL;
+ }
+#endif
+
+ return buf;
+}
+
+/* Returned pointer MUST be freed by the caller if non-NULL. */
+char* utf16_to_utf8_string_alloc(const wchar_t *str)
+{
+#ifdef _WIN32
+ int len = 0;
+#else
+ size_t len = 0;
+#endif
+ char *buf = NULL;
+
+ if (!str || !*str)
+ return NULL;
+
+#ifdef _WIN32
+ {
+ UINT code_page = CP_UTF8;
+ len = WideCharToMultiByte(code_page,
+ 0, str, -1, NULL, 0, NULL, NULL);
+
+ /* fallback to ANSI codepage instead */
+ if (!len)
+ {
+ code_page = CP_ACP;
+ len = WideCharToMultiByte(code_page,
+ 0, str, -1, NULL, 0, NULL, NULL);
+ }
+
+ buf = (char*)calloc(len, sizeof(char));
+
+ if (!buf)
+ return NULL;
+
+ if (WideCharToMultiByte(code_page,
+ 0, str, -1, buf, len, NULL, NULL) < 0)
+ {
+ free(buf);
+ return NULL;
+ }
+ }
+#else
+ /* NOTE: For now, assume non-Windows platforms'
+ * locale is already UTF-8. */
+ len = wcstombs(NULL, str, 0) + 1;
+
+ if (len)
+ {
+ buf = (char*)calloc(len, sizeof(char));
+
+ if (!buf)
+ return NULL;
+
+ if (wcstombs(buf, str, len) == (size_t)-1)
+ {
+ free(buf);
+ return NULL;
+ }
+ }
+#endif
+
+ return buf;
+}
diff --git a/libretro-common/file/file_path.c b/libretro-common/file/file_path.c
new file mode 100644
index 0000000..fc11270
--- /dev/null
+++ b/libretro-common/file/file_path.c
@@ -0,0 +1,1381 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (file_path.c).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <time.h>
+#include <errno.h>
+
+#include <sys/stat.h>
+
+#include <boolean.h>
+#include <file/file_path.h>
+#include <retro_assert.h>
+#include <string/stdstring.h>
+#include <time/rtime.h>
+
+/* TODO: There are probably some unnecessary things on this huge include list now but I'm too afraid to touch it */
+#ifdef __APPLE__
+#include <CoreFoundation/CoreFoundation.h>
+#endif
+#ifdef __HAIKU__
+#include <kernel/image.h>
+#endif
+#ifndef __MACH__
+#include <compat/strl.h>
+#include <compat/posix_string.h>
+#endif
+#include <retro_miscellaneous.h>
+#include <encodings/utf.h>
+
+#ifdef _WIN32
+#include <direct.h>
+#else
+#include <unistd.h> /* stat() is defined here */
+#endif
+
+#if !defined(RARCH_CONSOLE) && defined(RARCH_INTERNAL)
+#ifdef __WINRT__
+#include <uwp/uwp_func.h>
+#endif
+#endif
+
+/* Assume W-functions do not work below Win2K and Xbox platforms */
+#if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0500 || defined(_XBOX)
+
+#ifndef LEGACY_WIN32
+#define LEGACY_WIN32
+#endif
+
+#endif
+
+/**
+ * path_get_archive_delim:
+ * @path : path
+ *
+ * Find delimiter of an archive file. Only the first '#'
+ * after a compression extension is considered.
+ *
+ * Returns: pointer to the delimiter in the path if it contains
+ * a path inside a compressed file, otherwise NULL.
+ */
+const char *path_get_archive_delim(const char *path)
+{
+ const char *last_slash = find_last_slash(path);
+ const char *delim = NULL;
+ char buf[5];
+
+ buf[0] = '\0';
+
+ /* We search for delimiters after the last slash
+ * in the file path to avoid capturing delimiter
+ * characters in any parent directory names.
+ * If there are no slashes in the file name, then
+ * the path is just the file basename - in this
+ * case we search the path in its entirety */
+ if (!last_slash)
+ last_slash = path;
+
+ /* Find delimiter position
+ * > Since filenames may contain '#' characters,
+ * must loop until we find the first '#' that
+ * is directly *after* a compression extension */
+ delim = strchr(last_slash, '#');
+
+ while (delim)
+ {
+ /* Check whether this is a known archive type
+ * > Note: The code duplication here is
+ * deliberate, to maximise performance */
+ if (delim - last_slash > 4)
+ {
+ strlcpy(buf, delim - 4, sizeof(buf));
+ buf[4] = '\0';
+
+ string_to_lower(buf);
+
+ /* Check if this is a '.zip', '.apk' or '.7z' file */
+ if (string_is_equal(buf, ".zip") ||
+ string_is_equal(buf, ".apk") ||
+ string_is_equal(buf + 1, ".7z"))
+ return delim;
+ }
+ else if (delim - last_slash > 3)
+ {
+ strlcpy(buf, delim - 3, sizeof(buf));
+ buf[3] = '\0';
+
+ string_to_lower(buf);
+
+ /* Check if this is a '.7z' file */
+ if (string_is_equal(buf, ".7z"))
+ return delim;
+ }
+
+ delim++;
+ delim = strchr(delim, '#');
+ }
+
+ return NULL;
+}
+
+/**
+ * path_get_extension:
+ * @path : path
+ *
+ * Gets extension of file. Only '.'s
+ * after the last slash are considered.
+ *
+ * Returns: extension part from the path.
+ */
+const char *path_get_extension(const char *path)
+{
+ const char *ext;
+ if (!string_is_empty(path) && ((ext = strrchr(path_basename(path), '.'))))
+ return ext + 1;
+ return "";
+}
+
+/**
+ * path_remove_extension:
+ * @path : path
+ *
+ * Mutates path by removing its extension. Removes all
+ * text after and including the last '.'.
+ * Only '.'s after the last slash are considered.
+ *
+ * Returns:
+ * 1) If path has an extension, returns path with the
+ * extension removed.
+ * 2) If there is no extension, returns NULL.
+ * 3) If path is empty or NULL, returns NULL
+ */
+char *path_remove_extension(char *path)
+{
+ char *last = !string_is_empty(path)
+ ? (char*)strrchr(path_basename(path), '.') : NULL;
+ if (!last)
+ return NULL;
+ if (*last)
+ *last = '\0';
+ return path;
+}
+
+/**
+ * path_is_compressed_file:
+ * @path : path
+ *
+ * Checks if path is a compressed file.
+ *
+ * Returns: true (1) if path is a compressed file, otherwise false (0).
+ **/
+bool path_is_compressed_file(const char* path)
+{
+ const char *ext = path_get_extension(path);
+ if (!string_is_empty(ext))
+ if ( string_is_equal_noncase(ext, "zip") ||
+ string_is_equal_noncase(ext, "apk") ||
+ string_is_equal_noncase(ext, "7z"))
+ return true;
+ return false;
+}
+
+/**
+ * fill_pathname:
+ * @out_path : output path
+ * @in_path : input path
+ * @replace : what to replace
+ * @size : buffer size of output path
+ *
+ * FIXME: Verify
+ *
+ * Replaces filename extension with 'replace' and outputs result to out_path.
+ * The extension here is considered to be the string from the last '.'
+ * to the end.
+ *
+ * Only '.'s after the last slash are considered as extensions.
+ * If no '.' is present, in_path and replace will simply be concatenated.
+ * 'size' is buffer size of 'out_path'.
+ * E.g.: in_path = "/foo/bar/baz/boo.c", replace = ".asm" =>
+ * out_path = "/foo/bar/baz/boo.asm"
+ * E.g.: in_path = "/foo/bar/baz/boo.c", replace = "" =>
+ * out_path = "/foo/bar/baz/boo"
+ */
+void fill_pathname(char *out_path, const char *in_path,
+ const char *replace, size_t size)
+{
+ char tmp_path[PATH_MAX_LENGTH];
+ char *tok = NULL;
+
+ tmp_path[0] = '\0';
+
+ strlcpy(tmp_path, in_path, sizeof(tmp_path));
+ if ((tok = (char*)strrchr(path_basename(tmp_path), '.')))
+ *tok = '\0';
+
+ fill_pathname_noext(out_path, tmp_path, replace, size);
+}
+
+/**
+ * fill_pathname_noext:
+ * @out_path : output path
+ * @in_path : input path
+ * @replace : what to replace
+ * @size : buffer size of output path
+ *
+ * Appends a filename extension 'replace' to 'in_path', and outputs
+ * result in 'out_path'.
+ *
+ * Assumes in_path has no extension. If an extension is still
+ * present in 'in_path', it will be ignored.
+ *
+ */
+size_t fill_pathname_noext(char *out_path, const char *in_path,
+ const char *replace, size_t size)
+{
+ strlcpy(out_path, in_path, size);
+ return strlcat(out_path, replace, size);
+}
+
+char *find_last_slash(const char *str)
+{
+ const char *slash = strrchr(str, '/');
+#ifdef _WIN32
+ const char *backslash = strrchr(str, '\\');
+
+ if (!slash || (backslash > slash))
+ return (char*)backslash;
+#endif
+ return (char*)slash;
+}
+
+/**
+ * fill_pathname_slash:
+ * @path : path
+ * @size : size of path
+ *
+ * Assumes path is a directory. Appends a slash
+ * if not already there.
+ **/
+void fill_pathname_slash(char *path, size_t size)
+{
+ size_t path_len;
+ const char *last_slash = find_last_slash(path);
+
+ if (!last_slash)
+ {
+ strlcat(path, PATH_DEFAULT_SLASH(), size);
+ return;
+ }
+
+ path_len = strlen(path);
+ /* Try to preserve slash type. */
+ if (last_slash != (path + path_len - 1))
+ {
+ path[path_len] = last_slash[0];
+ path[path_len+1] = '\0';
+ }
+}
+
+/**
+ * fill_pathname_dir:
+ * @in_dir : input directory path
+ * @in_basename : input basename to be appended to @in_dir
+ * @replace : replacement to be appended to @in_basename
+ * @size : size of buffer
+ *
+ * Appends basename of 'in_basename', to 'in_dir', along with 'replace'.
+ * Basename of in_basename is the string after the last '/' or '\\',
+ * i.e the filename without directories.
+ *
+ * If in_basename has no '/' or '\\', the whole 'in_basename' will be used.
+ * 'size' is buffer size of 'in_dir'.
+ *
+ * E.g..: in_dir = "/tmp/some_dir", in_basename = "/some_content/foo.c",
+ * replace = ".asm" => in_dir = "/tmp/some_dir/foo.c.asm"
+ **/
+size_t fill_pathname_dir(char *in_dir, const char *in_basename,
+ const char *replace, size_t size)
+{
+ const char *base = NULL;
+
+ fill_pathname_slash(in_dir, size);
+ base = path_basename(in_basename);
+ strlcat(in_dir, base, size);
+ return strlcat(in_dir, replace, size);
+}
+
+/**
+ * fill_pathname_base:
+ * @out : output path
+ * @in_path : input path
+ * @size : size of output path
+ *
+ * Copies basename of @in_path into @out_path.
+ **/
+size_t fill_pathname_base(char *out, const char *in_path, size_t size)
+{
+ const char *ptr = path_basename(in_path);
+
+ if (!ptr)
+ ptr = in_path;
+
+ return strlcpy(out, ptr, size);
+}
+
+void fill_pathname_base_noext(char *out,
+ const char *in_path, size_t size)
+{
+ fill_pathname_base(out, in_path, size);
+ path_remove_extension(out);
+}
+
+size_t fill_pathname_base_ext(char *out,
+ const char *in_path, const char *ext,
+ size_t size)
+{
+ fill_pathname_base_noext(out, in_path, size);
+ return strlcat(out, ext, size);
+}
+
+/**
+ * fill_pathname_basedir:
+ * @out_dir : output directory
+ * @in_path : input path
+ * @size : size of output directory
+ *
+ * Copies base directory of @in_path into @out_path.
+ * If in_path is a path without any slashes (relative current directory),
+ * @out_path will get path "./".
+ **/
+void fill_pathname_basedir(char *out_dir,
+ const char *in_path, size_t size)
+{
+ if (out_dir != in_path)
+ strlcpy(out_dir, in_path, size);
+ path_basedir(out_dir);
+}
+
+void fill_pathname_basedir_noext(char *out_dir,
+ const char *in_path, size_t size)
+{
+ fill_pathname_basedir(out_dir, in_path, size);
+ path_remove_extension(out_dir);
+}
+
+/**
+ * fill_pathname_parent_dir_name:
+ * @out_dir : output directory
+ * @in_dir : input directory
+ * @size : size of output directory
+ *
+ * Copies only the parent directory name of @in_dir into @out_dir.
+ * The two buffers must not overlap. Removes trailing '/'.
+ * Returns true on success, false if a slash was not found in the path.
+ **/
+bool fill_pathname_parent_dir_name(char *out_dir,
+ const char *in_dir, size_t size)
+{
+ bool success = false;
+ char *temp = strdup(in_dir);
+ char *last = find_last_slash(temp);
+
+ if (last && last[1] == 0)
+ {
+ *last = '\0';
+ last = find_last_slash(temp);
+ }
+
+ if (last)
+ *last = '\0';
+
+ in_dir = find_last_slash(temp);
+
+ success = in_dir && in_dir[1];
+
+ if (success)
+ strlcpy(out_dir, in_dir + 1, size);
+
+ free(temp);
+ return success;
+}
+
+/**
+ * fill_pathname_parent_dir:
+ * @out_dir : output directory
+ * @in_dir : input directory
+ * @size : size of output directory
+ *
+ * Copies parent directory of @in_dir into @out_dir.
+ * Assumes @in_dir is a directory. Keeps trailing '/'.
+ * If the path was already at the root directory, @out_dir will be an empty string.
+ **/
+void fill_pathname_parent_dir(char *out_dir,
+ const char *in_dir, size_t size)
+{
+ if (out_dir != in_dir)
+ strlcpy(out_dir, in_dir, size);
+ path_parent_dir(out_dir);
+}
+
+/**
+ * fill_dated_filename:
+ * @out_filename : output filename
+ * @ext : extension of output filename
+ * @size : buffer size of output filename
+ *
+ * Creates a 'dated' filename prefixed by 'RetroArch', and
+ * concatenates extension (@ext) to it.
+ *
+ * E.g.:
+ * out_filename = "RetroArch-{month}{day}-{Hours}{Minutes}.{@ext}"
+ **/
+size_t fill_dated_filename(char *out_filename,
+ const char *ext, size_t size)
+{
+ time_t cur_time = time(NULL);
+ struct tm tm_;
+
+ rtime_localtime(&cur_time, &tm_);
+
+ strftime(out_filename, size,
+ "RetroArch-%m%d-%H%M%S", &tm_);
+ return strlcat(out_filename, ext, size);
+}
+
+/**
+ * fill_str_dated_filename:
+ * @out_filename : output filename
+ * @in_str : input string
+ * @ext : extension of output filename
+ * @size : buffer size of output filename
+ *
+ * Creates a 'dated' filename prefixed by the string @in_str, and
+ * concatenates extension (@ext) to it.
+ *
+ * E.g.:
+ * out_filename = "RetroArch-{year}{month}{day}-{Hour}{Minute}{Second}.{@ext}"
+ **/
+void fill_str_dated_filename(char *out_filename,
+ const char *in_str, const char *ext, size_t size)
+{
+ char format[256];
+ struct tm tm_;
+ time_t cur_time = time(NULL);
+
+ format[0] = '\0';
+
+ rtime_localtime(&cur_time, &tm_);
+
+ if (string_is_empty(ext))
+ {
+ strftime(format, sizeof(format), "-%y%m%d-%H%M%S", &tm_);
+ fill_pathname_noext(out_filename, in_str, format, size);
+ }
+ else
+ {
+ strftime(format, sizeof(format), "-%y%m%d-%H%M%S.", &tm_);
+
+ fill_pathname_join_concat_noext(out_filename,
+ in_str, format, ext,
+ size);
+ }
+}
+
+/**
+ * path_basedir:
+ * @path : path
+ *
+ * Extracts base directory by mutating path.
+ * Keeps trailing '/'.
+ **/
+void path_basedir(char *path)
+{
+ char *last = NULL;
+
+ if (strlen(path) < 2)
+ return;
+
+ last = find_last_slash(path);
+
+ if (last)
+ last[1] = '\0';
+ else
+ strlcpy(path, "." PATH_DEFAULT_SLASH(), 3);
+}
+
+/**
+ * path_parent_dir:
+ * @path : path
+ *
+ * Extracts parent directory by mutating path.
+ * Assumes that path is a directory. Keeps trailing '/'.
+ * If the path was already at the root directory, returns empty string
+ **/
+void path_parent_dir(char *path)
+{
+ size_t len = 0;
+
+ if (!path)
+ return;
+
+ len = strlen(path);
+
+ if (len && PATH_CHAR_IS_SLASH(path[len - 1]))
+ {
+ bool path_was_absolute = path_is_absolute(path);
+
+ path[len - 1] = '\0';
+
+ if (path_was_absolute && !find_last_slash(path))
+ {
+ /* We removed the only slash from what used to be an absolute path.
+ * On Linux, this goes from "/" to an empty string and everything works fine,
+ * but on Windows, we went from C:\ to C:, which is not a valid path and that later
+ * gets errornously treated as a relative one by path_basedir and returns "./".
+ * What we really wanted is an empty string. */
+ path[0] = '\0';
+ return;
+ }
+ }
+ path_basedir(path);
+}
+
+/**
+ * path_basename:
+ * @path : path
+ *
+ * Get basename from @path.
+ *
+ * Returns: basename from path.
+ **/
+const char *path_basename(const char *path)
+{
+ /* We cut at the first compression-related hash */
+ const char *delim = path_get_archive_delim(path);
+ if (delim)
+ return delim + 1;
+
+ {
+ /* We cut at the last slash */
+ const char *last = find_last_slash(path);
+ if (last)
+ return last + 1;
+ }
+
+ return path;
+}
+
+/* Specialized version */
+const char *path_basename_nocompression(const char *path)
+{
+ /* We cut at the last slash */
+ const char *last = find_last_slash(path);
+ if (last)
+ return last + 1;
+ return path;
+}
+
+/**
+ * path_is_absolute:
+ * @path : path
+ *
+ * Checks if @path is an absolute path or a relative path.
+ *
+ * Returns: true if path is absolute, false if path is relative.
+ **/
+bool path_is_absolute(const char *path)
+{
+ if (string_is_empty(path))
+ return false;
+
+ if (path[0] == '/')
+ return true;
+
+#if defined(_WIN32)
+ /* Many roads lead to Rome...
+ * Note: Drive letter can only be 1 character long */
+ if (string_starts_with_size(path, "\\\\", STRLEN_CONST("\\\\")) ||
+ string_starts_with_size(path + 1, ":/", STRLEN_CONST(":/")) ||
+ string_starts_with_size(path + 1, ":\\", STRLEN_CONST(":\\")))
+ return true;
+#elif defined(__wiiu__) || defined(VITA)
+ {
+ const char *seperator = strchr(path, ':');
+ if (seperator && (seperator[1] == '/'))
+ return true;
+ }
+#endif
+
+ return false;
+}
+
+/**
+ * path_resolve_realpath:
+ * @buf : input and output buffer for path
+ * @size : size of buffer
+ * @resolve_symlinks : whether to resolve symlinks or not
+ *
+ * Resolves use of ".", "..", multiple slashes etc in absolute paths.
+ *
+ * Relative paths are rebased on the current working dir.
+ *
+ * Returns: @buf if successful, NULL otherwise.
+ * Note: Not implemented on consoles
+ * Note: Symlinks are only resolved on Unix-likes
+ * Note: The current working dir might not be what you expect,
+ * e.g. on Android it is "/"
+ * Use of fill_pathname_resolve_relative() should be prefered
+ **/
+char *path_resolve_realpath(char *buf, size_t size, bool resolve_symlinks)
+{
+#if !defined(RARCH_CONSOLE) && defined(RARCH_INTERNAL)
+#ifdef _WIN32
+ char *ret = NULL;
+ wchar_t abs_path[PATH_MAX_LENGTH];
+ wchar_t *rel_path = utf8_to_utf16_string_alloc(buf);
+
+ if (rel_path)
+ {
+ if (_wfullpath(abs_path, rel_path, PATH_MAX_LENGTH))
+ {
+ char *tmp = utf16_to_utf8_string_alloc(abs_path);
+
+ if (tmp)
+ {
+ strlcpy(buf, tmp, size);
+ free(tmp);
+ ret = buf;
+ }
+ }
+
+ free(rel_path);
+ }
+
+ return ret;
+#else
+ char tmp[PATH_MAX_LENGTH];
+ size_t t;
+ char *p;
+ const char *next;
+ const char *buf_end;
+
+ if (resolve_symlinks)
+ {
+ strlcpy(tmp, buf, sizeof(tmp));
+
+ /* NOTE: realpath() expects at least PATH_MAX_LENGTH bytes in buf.
+ * Technically, PATH_MAX_LENGTH needn't be defined, but we rely on it anyways.
+ * POSIX 2008 can automatically allocate for you,
+ * but don't rely on that. */
+ if (!realpath(tmp, buf))
+ {
+ strlcpy(buf, tmp, size);
+ return NULL;
+ }
+
+ return buf;
+ }
+
+ t = 0; /* length of output */
+ buf_end = buf + strlen(buf);
+
+ if (!path_is_absolute(buf))
+ {
+ size_t len;
+ /* rebase on working directory */
+ if (!getcwd(tmp, PATH_MAX_LENGTH-1))
+ return NULL;
+
+ len = strlen(tmp);
+ t += len;
+
+ if (tmp[len-1] != '/')
+ tmp[t++] = '/';
+
+ if (string_is_empty(buf))
+ goto end;
+
+ p = buf;
+ }
+ else
+ {
+ /* UNIX paths can start with multiple '/', copy those */
+ for (p = buf; *p == '/'; p++)
+ tmp[t++] = '/';
+ }
+
+ /* p points to just after a slash while 'next' points to the next slash
+ * if there are no slashes, they point relative to where one would be */
+ do
+ {
+ next = strchr(p, '/');
+ if (!next)
+ next = buf_end;
+
+ if ((next - p == 2 && p[0] == '.' && p[1] == '.'))
+ {
+ p += 3;
+
+ /* fail for illegal /.., //.. etc */
+ if (t == 1 || tmp[t-2] == '/')
+ return NULL;
+
+ /* delete previous segment in tmp by adjusting size t
+ * tmp[t-1] == '/', find '/' before that */
+ t = t-2;
+ while (tmp[t] != '/')
+ t--;
+ t++;
+ }
+ else if (next - p == 1 && p[0] == '.')
+ p += 2;
+ else if (next - p == 0)
+ p += 1;
+ else
+ {
+ /* fail when truncating */
+ if (t + next-p+1 > PATH_MAX_LENGTH-1)
+ return NULL;
+
+ while (p <= next)
+ tmp[t++] = *p++;
+ }
+
+ }
+ while (next < buf_end);
+
+end:
+ tmp[t] = '\0';
+ strlcpy(buf, tmp, size);
+ return buf;
+#endif
+#endif
+ return NULL;
+}
+
+/**
+ * path_relative_to:
+ * @out : buffer to write the relative path to
+ * @path : path to be expressed relatively
+ * @base : base directory to start out on
+ * @size : size of output buffer
+ *
+ * Turns @path into a path relative to @base and writes it to @out.
+ *
+ * @base is assumed to be a base directory, i.e. a path ending with '/' or '\'.
+ * Both @path and @base are assumed to be absolute paths without "." or "..".
+ *
+ * E.g. path /a/b/e/f.cg with base /a/b/c/d/ turns into ../../e/f.cg
+ **/
+size_t path_relative_to(char *out,
+ const char *path, const char *base, size_t size)
+{
+ size_t i, j;
+ const char *trimmed_path, *trimmed_base;
+
+#ifdef _WIN32
+ /* For different drives, return absolute path */
+ if (strlen(path) >= 2 && strlen(base) >= 2
+ && path[1] == ':' && base[1] == ':'
+ && path[0] != base[0])
+ return strlcpy(out, path, size);
+#endif
+
+ /* Trim common beginning */
+ for (i = 0, j = 0; path[i] && base[i] && path[i] == base[i]; i++)
+ if (path[i] == PATH_DEFAULT_SLASH_C())
+ j = i + 1;
+
+ trimmed_path = path+j;
+ trimmed_base = base+i;
+
+ /* Each segment of base turns into ".." */
+ out[0] = '\0';
+ for (i = 0; trimmed_base[i]; i++)
+ if (trimmed_base[i] == PATH_DEFAULT_SLASH_C())
+ strlcat(out, ".." PATH_DEFAULT_SLASH(), size);
+
+ return strlcat(out, trimmed_path, size);
+}
+
+/**
+ * fill_pathname_resolve_relative:
+ * @out_path : output path
+ * @in_refpath : input reference path
+ * @in_path : input path
+ * @size : size of @out_path
+ *
+ * Joins basedir of @in_refpath together with @in_path.
+ * If @in_path is an absolute path, out_path = in_path.
+ * E.g.: in_refpath = "/foo/bar/baz.a", in_path = "foobar.cg",
+ * out_path = "/foo/bar/foobar.cg".
+ **/
+void fill_pathname_resolve_relative(char *out_path,
+ const char *in_refpath, const char *in_path, size_t size)
+{
+ if (path_is_absolute(in_path))
+ {
+ strlcpy(out_path, in_path, size);
+ return;
+ }
+
+ fill_pathname_basedir(out_path, in_refpath, size);
+ strlcat(out_path, in_path, size);
+ path_resolve_realpath(out_path, size, false);
+}
+
+/**
+ * fill_pathname_join:
+ * @out_path : output path
+ * @dir : directory
+ * @path : path
+ * @size : size of output path
+ *
+ * Joins a directory (@dir) and path (@path) together.
+ * Makes sure not to get two consecutive slashes
+ * between directory and path.
+ **/
+size_t fill_pathname_join(char *out_path,
+ const char *dir, const char *path, size_t size)
+{
+ if (out_path != dir)
+ strlcpy(out_path, dir, size);
+
+ if (*out_path)
+ fill_pathname_slash(out_path, size);
+
+ return strlcat(out_path, path, size);
+}
+
+size_t fill_pathname_join_special_ext(char *out_path,
+ const char *dir, const char *path,
+ const char *last, const char *ext,
+ size_t size)
+{
+ fill_pathname_join(out_path, dir, path, size);
+ if (*out_path)
+ fill_pathname_slash(out_path, size);
+
+ strlcat(out_path, last, size);
+ return strlcat(out_path, ext, size);
+}
+
+size_t fill_pathname_join_concat_noext(char *out_path,
+ const char *dir, const char *path,
+ const char *concat,
+ size_t size)
+{
+ fill_pathname_noext(out_path, dir, path, size);
+ return strlcat(out_path, concat, size);
+}
+
+size_t fill_pathname_join_concat(char *out_path,
+ const char *dir, const char *path,
+ const char *concat,
+ size_t size)
+{
+ fill_pathname_join(out_path, dir, path, size);
+ return strlcat(out_path, concat, size);
+}
+
+void fill_pathname_join_noext(char *out_path,
+ const char *dir, const char *path, size_t size)
+{
+ fill_pathname_join(out_path, dir, path, size);
+ path_remove_extension(out_path);
+}
+
+/**
+ * fill_pathname_join_delim:
+ * @out_path : output path
+ * @dir : directory
+ * @path : path
+ * @delim : delimiter
+ * @size : size of output path
+ *
+ * Joins a directory (@dir) and path (@path) together
+ * using the given delimiter (@delim).
+ **/
+size_t fill_pathname_join_delim(char *out_path, const char *dir,
+ const char *path, const char delim, size_t size)
+{
+ size_t copied;
+ /* behavior of strlcpy is undefined if dst and src overlap */
+ if (out_path == dir)
+ copied = strlen(dir);
+ else
+ copied = strlcpy(out_path, dir, size);
+
+ out_path[copied] = delim;
+ out_path[copied+1] = '\0';
+
+ if (path)
+ copied = strlcat(out_path, path, size);
+ return copied;
+}
+
+size_t fill_pathname_join_delim_concat(char *out_path, const char *dir,
+ const char *path, const char delim, const char *concat,
+ size_t size)
+{
+ fill_pathname_join_delim(out_path, dir, path, delim, size);
+ return strlcat(out_path, concat, size);
+}
+
+/**
+ * fill_short_pathname_representation:
+ * @out_rep : output representation
+ * @in_path : input path
+ * @size : size of output representation
+ *
+ * Generates a short representation of path. It should only
+ * be used for displaying the result; the output representation is not
+ * binding in any meaningful way (for a normal path, this is the same as basename)
+ * In case of more complex URLs, this should cut everything except for
+ * the main image file.
+ *
+ * E.g.: "/path/to/game.img" -> game.img
+ * "/path/to/myarchive.7z#folder/to/game.img" -> game.img
+ */
+size_t fill_short_pathname_representation(char* out_rep,
+ const char *in_path, size_t size)
+{
+ char path_short[PATH_MAX_LENGTH];
+
+ path_short[0] = '\0';
+
+ fill_pathname(path_short, path_basename(in_path), "",
+ sizeof(path_short));
+
+ return strlcpy(out_rep, path_short, size);
+}
+
+void fill_short_pathname_representation_noext(char* out_rep,
+ const char *in_path, size_t size)
+{
+ fill_short_pathname_representation(out_rep, in_path, size);
+ path_remove_extension(out_rep);
+}
+
+void fill_pathname_expand_special(char *out_path,
+ const char *in_path, size_t size)
+{
+#if !defined(RARCH_CONSOLE) && defined(RARCH_INTERNAL)
+ if (in_path[0] == '~')
+ {
+ char *home_dir = (char*)malloc(PATH_MAX_LENGTH * sizeof(char));
+
+ home_dir[0] = '\0';
+
+ fill_pathname_home_dir(home_dir,
+ PATH_MAX_LENGTH * sizeof(char));
+
+ if (*home_dir)
+ {
+ size_t src_size = strlcpy(out_path, home_dir, size);
+ retro_assert(src_size < size);
+
+ out_path += src_size;
+ size -= src_size;
+
+ if (!PATH_CHAR_IS_SLASH(out_path[-1]))
+ {
+ src_size = strlcpy(out_path, PATH_DEFAULT_SLASH(), size);
+ retro_assert(src_size < size);
+
+ out_path += src_size;
+ size -= src_size;
+ }
+
+ in_path += 2;
+ }
+
+ free(home_dir);
+ }
+ else if (in_path[0] == ':')
+ {
+ char *application_dir = (char*)malloc(PATH_MAX_LENGTH * sizeof(char));
+
+ application_dir[0] = '\0';
+
+ fill_pathname_application_dir(application_dir,
+ PATH_MAX_LENGTH * sizeof(char));
+
+ if (*application_dir)
+ {
+ size_t src_size = strlcpy(out_path, application_dir, size);
+ retro_assert(src_size < size);
+
+ out_path += src_size;
+ size -= src_size;
+
+ if (!PATH_CHAR_IS_SLASH(out_path[-1]))
+ {
+ src_size = strlcpy(out_path, PATH_DEFAULT_SLASH(), size);
+ retro_assert(src_size < size);
+
+ out_path += src_size;
+ size -= src_size;
+ }
+
+ in_path += 2;
+ }
+
+ free(application_dir);
+ }
+#endif
+
+ retro_assert(strlcpy(out_path, in_path, size) < size);
+}
+
+void fill_pathname_abbreviate_special(char *out_path,
+ const char *in_path, size_t size)
+{
+#if !defined(RARCH_CONSOLE) && defined(RARCH_INTERNAL)
+ unsigned i;
+ const char *candidates[3];
+ const char *notations[3];
+ char application_dir[PATH_MAX_LENGTH];
+ char home_dir[PATH_MAX_LENGTH];
+
+ application_dir[0] = '\0';
+ home_dir[0] = '\0';
+
+ /* application_dir could be zero-string. Safeguard against this.
+ *
+ * Keep application dir in front of home, moving app dir to a
+ * new location inside home would break otherwise. */
+
+ /* ugly hack - use application_dir pointer
+ * before filling it in. C89 reasons */
+ candidates[0] = application_dir;
+ candidates[1] = home_dir;
+ candidates[2] = NULL;
+
+ notations [0] = ":";
+ notations [1] = "~";
+ notations [2] = NULL;
+
+ fill_pathname_application_dir(application_dir, sizeof(application_dir));
+ fill_pathname_home_dir(home_dir, sizeof(home_dir));
+
+ for (i = 0; candidates[i]; i++)
+ {
+ if (!string_is_empty(candidates[i]) &&
+ string_starts_with(in_path, candidates[i]))
+ {
+ size_t src_size = strlcpy(out_path, notations[i], size);
+
+ retro_assert(src_size < size);
+
+ out_path += src_size;
+ size -= src_size;
+ in_path += strlen(candidates[i]);
+
+ if (!PATH_CHAR_IS_SLASH(*in_path))
+ {
+ strcpy_literal(out_path, PATH_DEFAULT_SLASH());
+ out_path++;
+ size--;
+ }
+
+ break; /* Don't allow more abbrevs to take place. */
+ }
+ }
+
+#endif
+
+ retro_assert(strlcpy(out_path, in_path, size) < size);
+}
+
+/* Changes the slashes to the correct kind for the os
+ * So forward slash on linux and backslash on Windows */
+void pathname_conform_slashes_to_os(char *path)
+{
+ /* Conform slashes to os standard so we get proper matching */
+ char* p;
+ for (p = path; *p; p++)
+ if (*p == '/' || *p == '\\')
+ *p = PATH_DEFAULT_SLASH_C();
+}
+
+/* Change all shashes to forward so they are more portable between windows and linux */
+void pathname_make_slashes_portable(char *path)
+{
+ /* Conform slashes to os standard so we get proper matching */
+ char* p;
+ for (p = path; *p; p++)
+ if (*p == '/' || *p == '\\')
+ *p = '/';
+}
+
+/* Get the number of slashes in a path, returns an integer */
+int get_pathname_num_slashes(const char *in_path)
+{
+ int num_slashes = 0;
+ int i = 0;
+
+ for (i = 0; i < PATH_MAX_LENGTH; i++)
+ {
+ if (PATH_CHAR_IS_SLASH(in_path[i]))
+ num_slashes++;
+ if (in_path[i] == '\0')
+ break;
+ }
+
+ return num_slashes;
+}
+
+/* Fills the supplied path with either the abbreviated path or the relative path, which ever
+ * one is has less depth / number of slashes
+ * If lengths of abbreviated and relative paths are the same the relative path will be used
+ * in_path can be an absolute, relative or abbreviated path */
+void fill_pathname_abbreviated_or_relative(char *out_path, const char *in_refpath, const char *in_path, size_t size)
+{
+ char in_path_conformed[PATH_MAX_LENGTH];
+ char in_refpath_conformed[PATH_MAX_LENGTH];
+ char expanded_path[PATH_MAX_LENGTH];
+ char absolute_path[PATH_MAX_LENGTH];
+ char relative_path[PATH_MAX_LENGTH];
+ char abbreviated_path[PATH_MAX_LENGTH];
+
+ in_path_conformed[0] = '\0';
+ in_refpath_conformed[0] = '\0';
+ expanded_path[0] = '\0';
+ absolute_path[0] = '\0';
+ relative_path[0] = '\0';
+ abbreviated_path[0] = '\0';
+
+ strcpy_literal(in_path_conformed, in_path);
+ strcpy_literal(in_refpath_conformed, in_refpath);
+
+ pathname_conform_slashes_to_os(in_path_conformed);
+ pathname_conform_slashes_to_os(in_refpath_conformed);
+
+ /* Expand paths which start with :\ to an absolute path */
+ fill_pathname_expand_special(expanded_path,
+ in_path_conformed, sizeof(expanded_path));
+
+ /* Get the absolute path if it is not already */
+ if (path_is_absolute(expanded_path))
+ strlcpy(absolute_path, expanded_path, PATH_MAX_LENGTH);
+ else
+ fill_pathname_resolve_relative(absolute_path,
+ in_refpath_conformed, in_path_conformed, PATH_MAX_LENGTH);
+
+ pathname_conform_slashes_to_os(absolute_path);
+
+ /* Get the relative path and see how many directories long it is */
+ path_relative_to(relative_path, absolute_path,
+ in_refpath_conformed, sizeof(relative_path));
+
+ /* Get the abbreviated path and see how many directories long it is */
+ fill_pathname_abbreviate_special(abbreviated_path,
+ absolute_path, sizeof(abbreviated_path));
+
+ /* Use the shortest path, preferring the relative path*/
+ if ( get_pathname_num_slashes(relative_path) <=
+ get_pathname_num_slashes(abbreviated_path))
+ retro_assert(strlcpy(out_path, relative_path, size) < size);
+ else
+ retro_assert(strlcpy(out_path, abbreviated_path, size) < size);
+}
+
+/**
+ * path_basedir:
+ * @path : path
+ *
+ * Extracts base directory by mutating path.
+ * Keeps trailing '/'.
+ **/
+void path_basedir_wrapper(char *path)
+{
+ char *last = NULL;
+ if (strlen(path) < 2)
+ return;
+
+#ifdef HAVE_COMPRESSION
+ /* We want to find the directory with the archive in basedir. */
+ last = (char*)path_get_archive_delim(path);
+ if (last)
+ *last = '\0';
+#endif
+
+ last = find_last_slash(path);
+
+ if (last)
+ last[1] = '\0';
+ else
+ strlcpy(path, "." PATH_DEFAULT_SLASH(), 3);
+}
+
+#if !defined(RARCH_CONSOLE) && defined(RARCH_INTERNAL)
+void fill_pathname_application_path(char *s, size_t len)
+{
+ size_t i;
+#ifdef __APPLE__
+ CFBundleRef bundle = CFBundleGetMainBundle();
+#endif
+#ifdef _WIN32
+ DWORD ret = 0;
+ wchar_t wstr[PATH_MAX_LENGTH] = {0};
+#endif
+#ifdef __HAIKU__
+ image_info info;
+ int32_t cookie = 0;
+#endif
+ (void)i;
+
+ if (!len)
+ return;
+
+#if defined(_WIN32)
+#ifdef LEGACY_WIN32
+ ret = GetModuleFileNameA(NULL, s, len);
+#else
+ ret = GetModuleFileNameW(NULL, wstr, ARRAY_SIZE(wstr));
+
+ if (*wstr)
+ {
+ char *str = utf16_to_utf8_string_alloc(wstr);
+
+ if (str)
+ {
+ strlcpy(s, str, len);
+ free(str);
+ }
+ }
+#endif
+ s[ret] = '\0';
+#elif defined(__APPLE__)
+ if (bundle)
+ {
+ CFURLRef bundle_url = CFBundleCopyBundleURL(bundle);
+ CFStringRef bundle_path = CFURLCopyPath(bundle_url);
+ CFStringGetCString(bundle_path, s, len, kCFStringEncodingUTF8);
+#ifdef HAVE_COCOATOUCH
+ {
+ /* This needs to be done so that the path becomes
+ * /private/var/... and this
+ * is used consistently throughout for the iOS bundle path */
+ char resolved_bundle_dir_buf[PATH_MAX_LENGTH] = {0};
+ if (realpath(s, resolved_bundle_dir_buf))
+ {
+ strlcpy(s, resolved_bundle_dir_buf, len - 1);
+ strlcat(s, "/", len);
+ }
+ }
+#endif
+
+ CFRelease(bundle_path);
+ CFRelease(bundle_url);
+#ifndef HAVE_COCOATOUCH
+ /* Not sure what this does but it breaks
+ * stuff for iOS, so skipping */
+ retro_assert(strlcat(s, "nobin", len) < len);
+#endif
+ return;
+ }
+#elif defined(__HAIKU__)
+ while (get_next_image_info(0, &cookie, &info) == B_OK)
+ {
+ if (info.type == B_APP_IMAGE)
+ {
+ strlcpy(s, info.name, len);
+ return;
+ }
+ }
+#elif defined(__QNX__)
+ char *buff = malloc(len);
+
+ if (_cmdname(buff))
+ strlcpy(s, buff, len);
+
+ free(buff);
+#else
+ {
+ pid_t pid;
+ static const char *exts[] = { "exe", "file", "path/a.out" };
+ char link_path[255];
+
+ link_path[0] = *s = '\0';
+ pid = getpid();
+
+ /* Linux, BSD and Solaris paths. Not standardized. */
+ for (i = 0; i < ARRAY_SIZE(exts); i++)
+ {
+ ssize_t ret;
+
+ snprintf(link_path, sizeof(link_path), "/proc/%u/%s",
+ (unsigned)pid, exts[i]);
+ ret = readlink(link_path, s, len - 1);
+
+ if (ret >= 0)
+ {
+ s[ret] = '\0';
+ return;
+ }
+ }
+ }
+#endif
+}
+
+void fill_pathname_application_dir(char *s, size_t len)
+{
+#ifdef __WINRT__
+ strlcpy(s, uwp_dir_install, len);
+#else
+ fill_pathname_application_path(s, len);
+ path_basedir_wrapper(s);
+#endif
+}
+
+void fill_pathname_home_dir(char *s, size_t len)
+{
+#ifdef __WINRT__
+ const char *home = uwp_dir_data;
+#else
+ const char *home = getenv("HOME");
+#endif
+ if (home)
+ strlcpy(s, home, len);
+ else
+ *s = 0;
+}
+#endif
+
+bool is_path_accessible_using_standard_io(const char *path)
+{
+#ifdef __WINRT__
+ char relative_path_abbrev[PATH_MAX_LENGTH];
+ fill_pathname_abbreviate_special(relative_path_abbrev,
+ path, sizeof(relative_path_abbrev));
+ return (strlen(relative_path_abbrev) >= 2 )
+ && ( relative_path_abbrev[0] == ':'
+ || relative_path_abbrev[0] == '~')
+ && PATH_CHAR_IS_SLASH(relative_path_abbrev[1]);
+#else
+ return true;
+#endif
+}
diff --git a/libretro-common/file/file_path_io.c b/libretro-common/file/file_path_io.c
new file mode 100644
index 0000000..63587e3
--- /dev/null
+++ b/libretro-common/file/file_path_io.c
@@ -0,0 +1,151 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (file_path_io.c).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <time.h>
+#include <errno.h>
+
+#include <sys/stat.h>
+
+#include <boolean.h>
+#include <file/file_path.h>
+#include <retro_assert.h>
+#include <compat/strl.h>
+#include <compat/posix_string.h>
+#include <retro_miscellaneous.h>
+#include <string/stdstring.h>
+#define VFS_FRONTEND
+#include <vfs/vfs_implementation.h>
+
+#ifdef _WIN32
+#include <direct.h>
+#else
+#include <unistd.h> /* stat() is defined here */
+#endif
+
+/* TODO/FIXME - globals */
+static retro_vfs_stat_t path_stat_cb = retro_vfs_stat_impl;
+static retro_vfs_mkdir_t path_mkdir_cb = retro_vfs_mkdir_impl;
+
+void path_vfs_init(const struct retro_vfs_interface_info* vfs_info)
+{
+ const struct retro_vfs_interface*
+ vfs_iface = vfs_info->iface;
+
+ path_stat_cb = retro_vfs_stat_impl;
+ path_mkdir_cb = retro_vfs_mkdir_impl;
+
+ if (vfs_info->required_interface_version < PATH_REQUIRED_VFS_VERSION || !vfs_iface)
+ return;
+
+ path_stat_cb = vfs_iface->stat;
+ path_mkdir_cb = vfs_iface->mkdir;
+}
+
+int path_stat(const char *path)
+{
+ return path_stat_cb(path, NULL);
+}
+
+/**
+ * path_is_directory:
+ * @path : path
+ *
+ * Checks if path is a directory.
+ *
+ * Returns: true (1) if path is a directory, otherwise false (0).
+ */
+bool path_is_directory(const char *path)
+{
+ return (path_stat_cb(path, NULL) & RETRO_VFS_STAT_IS_DIRECTORY) != 0;
+}
+
+bool path_is_character_special(const char *path)
+{
+ return (path_stat_cb(path, NULL) & RETRO_VFS_STAT_IS_CHARACTER_SPECIAL) != 0;
+}
+
+bool path_is_valid(const char *path)
+{
+ return (path_stat_cb(path, NULL) & RETRO_VFS_STAT_IS_VALID) != 0;
+}
+
+int32_t path_get_size(const char *path)
+{
+ int32_t filesize = 0;
+ if (path_stat_cb(path, &filesize) != 0)
+ return filesize;
+
+ return -1;
+}
+
+/**
+ * path_mkdir:
+ * @dir : directory
+ *
+ * Create directory on filesystem.
+ *
+ * Returns: true (1) if directory could be created, otherwise false (0).
+ **/
+bool path_mkdir(const char *dir)
+{
+ bool norecurse = false;
+ char *basedir = NULL;
+
+ if (!(dir && *dir))
+ return false;
+
+ /* Use heap. Real chance of stack
+ * overflow if we recurse too hard. */
+ basedir = strdup(dir);
+
+ if (!basedir)
+ return false;
+
+ path_parent_dir(basedir);
+
+ if (!*basedir || !strcmp(basedir, dir))
+ {
+ free(basedir);
+ return false;
+ }
+
+ if ( path_is_directory(basedir)
+ || path_mkdir(basedir))
+ norecurse = true;
+
+ free(basedir);
+
+ if (norecurse)
+ {
+ int ret = path_mkdir_cb(dir);
+
+ /* Don't treat this as an error. */
+ if (ret == -2 && path_is_directory(dir))
+ return true;
+ else if (ret == 0)
+ return true;
+ }
+ return false;
+}
diff --git a/libretro-common/include/boolean.h b/libretro-common/include/boolean.h
index 2c18ef7..9d0d7c1 100644
--- a/libretro-common/include/boolean.h
+++ b/libretro-common/include/boolean.h
@@ -1,4 +1,4 @@
-/* Copyright (C) 2010-2017 The RetroArch team
+/* Copyright (C) 2010-2020 The RetroArch team
*
* ---------------------------------------------------------------------------------------
* The following license statement only applies to this file (boolean.h).
@@ -25,7 +25,7 @@
#ifndef __cplusplus
-#if defined(_MSC_VER) && !defined(SN_TARGET_PS3)
+#if defined(_MSC_VER) && _MSC_VER < 1800 && !defined(SN_TARGET_PS3)
/* Hack applied for MSVC when compiling in C89 mode as it isn't C99 compliant. */
#define bool unsigned char
#define true 1
diff --git a/libretro-common/include/compat/fopen_utf8.h b/libretro-common/include/compat/fopen_utf8.h
new file mode 100644
index 0000000..97d4404
--- /dev/null
+++ b/libretro-common/include/compat/fopen_utf8.h
@@ -0,0 +1,34 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (fopen_utf8.h).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef __LIBRETRO_SDK_COMPAT_FOPEN_UTF8_H
+#define __LIBRETRO_SDK_COMPAT_FOPEN_UTF8_H
+
+#ifdef _WIN32
+/* Defined to error rather than fopen_utf8, to make it clear to everyone reading the code that not worrying about utf16 is fine */
+/* TODO: enable */
+/* #define fopen (use fopen_utf8 instead) */
+void *fopen_utf8(const char * filename, const char * mode);
+#else
+#define fopen_utf8 fopen
+#endif
+#endif
diff --git a/libretro-common/include/compat/msvc.h b/libretro-common/include/compat/msvc.h
index 5175214..a4c93a5 100644
--- a/libretro-common/include/compat/msvc.h
+++ b/libretro-common/include/compat/msvc.h
@@ -1,4 +1,4 @@
-/* Copyright (C) 2010-2017 The RetroArch team
+/* Copyright (C) 2010-2020 The RetroArch team
*
* ---------------------------------------------------------------------------------------
* The following license statement only applies to this file (msvc.h).
@@ -29,20 +29,17 @@
extern "C" {
#endif
-/* Pre-MSVC 2015 compilers don't implement snprintf in a cross-platform manner. */
+/* Pre-MSVC 2015 compilers don't implement snprintf, vsnprintf in a cross-platform manner. */
#if _MSC_VER < 1900
+ #include <stdio.h>
+ #include <stdarg.h>
#include <stdlib.h>
+
#ifndef snprintf
#define snprintf c99_snprintf_retro__
#endif
-
int c99_snprintf_retro__(char *outBuf, size_t size, const char *format, ...);
-#endif
-/* Pre-MSVC 2010 compilers don't implement vsnprintf in a cross-platform manner? Not sure about this one. */
-#if _MSC_VER < 1600
- #include <stdarg.h>
- #include <stdlib.h>
#ifndef vsnprintf
#define vsnprintf c99_vsnprintf_retro__
#endif
@@ -56,6 +53,8 @@ extern "C" {
#undef UNICODE /* Do not bother with UNICODE at this time. */
#include <direct.h>
#include <stddef.h>
+
+#define _USE_MATH_DEFINES
#include <math.h>
/* Python headers defines ssize_t and sets HAVE_SSIZE_T.
@@ -92,7 +91,7 @@ typedef int ssize_t;
#define va_copy(x, y) ((x) = (y))
#endif
-#if _MSC_VER <= 1200
+#if _MSC_VER <= 1310
#ifndef __cplusplus
/* VC6 math.h doesn't define some functions when in C mode.
* Trying to define a prototype gives "undefined reference".
@@ -106,11 +105,7 @@ typedef int ssize_t;
#define ceilf(x) ((float)ceil((double)x))
#define floorf(x) ((float)floor((double)x))
#define sqrtf(x) ((float)sqrt((double)x))
- #endif
-
- #ifndef _vscprintf
- #define _vscprintf c89_vscprintf_retro__
- int c89_vscprintf_retro__(const char *format, va_list pargs);
+ #define fabsf(x) ((float)fabs((double)(x)))
#endif
#ifndef _strtoui64
@@ -129,4 +124,3 @@ typedef int ssize_t;
#endif
#endif
-
diff --git a/libretro-common/include/compat/msvc/stdint.h b/libretro-common/include/compat/msvc/stdint.h
index c791176..7c91a68 100644
--- a/libretro-common/include/compat/msvc/stdint.h
+++ b/libretro-common/include/compat/msvc/stdint.h
@@ -67,7 +67,6 @@ extern "C" {
# endif
#endif
-
/* 7.18.1 Integer types. */
/* 7.18.1.1 Exact-width integer types. */
@@ -94,7 +93,6 @@ extern "C" {
typedef signed __int64 int64_t;
typedef unsigned __int64 uint64_t;
-
/* 7.18.1.2 Minimum-width integer types. */
typedef int8_t int_least8_t;
typedef int16_t int_least16_t;
@@ -255,4 +253,3 @@ typedef uint64_t uintmax_t;
#endif
#endif
-
diff --git a/libretro-common/include/compat/posix_string.h b/libretro-common/include/compat/posix_string.h
new file mode 100644
index 0000000..47964b2
--- /dev/null
+++ b/libretro-common/include/compat/posix_string.h
@@ -0,0 +1,60 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (posix_string.h).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef __LIBRETRO_SDK_COMPAT_POSIX_STRING_H
+#define __LIBRETRO_SDK_COMPAT_POSIX_STRING_H
+
+#include <retro_common_api.h>
+
+#ifdef _MSC_VER
+#include <compat/msvc.h>
+#endif
+
+RETRO_BEGIN_DECLS
+
+#ifdef _WIN32
+#undef strtok_r
+#define strtok_r(str, delim, saveptr) retro_strtok_r__(str, delim, saveptr)
+
+char *strtok_r(char *str, const char *delim, char **saveptr);
+#endif
+
+#ifdef _MSC_VER
+#undef strcasecmp
+#undef strdup
+#define strcasecmp(a, b) retro_strcasecmp__(a, b)
+#define strdup(orig) retro_strdup__(orig)
+int strcasecmp(const char *a, const char *b);
+char *strdup(const char *orig);
+
+/* isblank is available since MSVC 2013 */
+#if _MSC_VER < 1800
+#undef isblank
+#define isblank(c) retro_isblank__(c)
+int isblank(int c);
+#endif
+
+#endif
+
+RETRO_END_DECLS
+
+#endif
diff --git a/libretro-common/include/compat/strcasestr.h b/libretro-common/include/compat/strcasestr.h
new file mode 100644
index 0000000..227e253
--- /dev/null
+++ b/libretro-common/include/compat/strcasestr.h
@@ -0,0 +1,48 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (strcasestr.h).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef __LIBRETRO_SDK_COMPAT_STRCASESTR_H
+#define __LIBRETRO_SDK_COMPAT_STRCASESTR_H
+
+#include <string.h>
+
+#if defined(RARCH_INTERNAL) && defined(HAVE_CONFIG_H)
+#include "../../../config.h"
+#endif
+
+#ifndef HAVE_STRCASESTR
+
+#include <retro_common_api.h>
+
+RETRO_BEGIN_DECLS
+
+/* Avoid possible naming collisions during link
+ * since we prefer to use the actual name. */
+#define strcasestr(haystack, needle) strcasestr_retro__(haystack, needle)
+
+char *strcasestr(const char *haystack, const char *needle);
+
+RETRO_END_DECLS
+
+#endif
+
+#endif
diff --git a/libretro-common/include/compat/strl.h b/libretro-common/include/compat/strl.h
new file mode 100644
index 0000000..5e7a892
--- /dev/null
+++ b/libretro-common/include/compat/strl.h
@@ -0,0 +1,59 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (strl.h).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef __LIBRETRO_SDK_COMPAT_STRL_H
+#define __LIBRETRO_SDK_COMPAT_STRL_H
+
+#include <string.h>
+#include <stddef.h>
+
+#if defined(RARCH_INTERNAL) && defined(HAVE_CONFIG_H)
+#include "../../../config.h"
+#endif
+
+#include <retro_common_api.h>
+
+RETRO_BEGIN_DECLS
+
+#ifdef __MACH__
+#ifndef HAVE_STRL
+#define HAVE_STRL
+#endif
+#endif
+
+#ifndef HAVE_STRL
+/* Avoid possible naming collisions during link since
+ * we prefer to use the actual name. */
+#define strlcpy(dst, src, size) strlcpy_retro__(dst, src, size)
+
+#define strlcat(dst, src, size) strlcat_retro__(dst, src, size)
+
+size_t strlcpy(char *dest, const char *source, size_t size);
+size_t strlcat(char *dest, const char *source, size_t size);
+
+#endif
+
+char *strldup(const char *s, size_t n);
+
+RETRO_END_DECLS
+
+#endif
diff --git a/libretro-common/include/encodings/utf.h b/libretro-common/include/encodings/utf.h
new file mode 100644
index 0000000..bea4e14
--- /dev/null
+++ b/libretro-common/include/encodings/utf.h
@@ -0,0 +1,67 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (utf.h).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef _LIBRETRO_ENCODINGS_UTF_H
+#define _LIBRETRO_ENCODINGS_UTF_H
+
+#include <stdint.h>
+#include <stddef.h>
+
+#include <boolean.h>
+
+#include <retro_common_api.h>
+
+RETRO_BEGIN_DECLS
+
+enum CodePage
+{
+ CODEPAGE_LOCAL = 0, /* CP_ACP */
+ CODEPAGE_UTF8 = 65001 /* CP_UTF8 */
+};
+
+size_t utf8_conv_utf32(uint32_t *out, size_t out_chars,
+ const char *in, size_t in_size);
+
+bool utf16_conv_utf8(uint8_t *out, size_t *out_chars,
+ const uint16_t *in, size_t in_size);
+
+size_t utf8len(const char *string);
+
+size_t utf8cpy(char *d, size_t d_len, const char *s, size_t chars);
+
+const char *utf8skip(const char *str, size_t chars);
+
+uint32_t utf8_walk(const char **string);
+
+bool utf16_to_char_string(const uint16_t *in, char *s, size_t len);
+
+char* utf8_to_local_string_alloc(const char *str);
+
+char* local_to_utf8_string_alloc(const char *str);
+
+wchar_t* utf8_to_utf16_string_alloc(const char *str);
+
+char* utf16_to_utf8_string_alloc(const wchar_t *str);
+
+RETRO_END_DECLS
+
+#endif
diff --git a/libretro-common/include/file/file_path.h b/libretro-common/include/file/file_path.h
new file mode 100644
index 0000000..452763f
--- /dev/null
+++ b/libretro-common/include/file/file_path.h
@@ -0,0 +1,538 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (file_path.h).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef __LIBRETRO_SDK_FILE_PATH_H
+#define __LIBRETRO_SDK_FILE_PATH_H
+
+#include <stdio.h>
+#include <stdint.h>
+#include <stddef.h>
+#include <sys/types.h>
+
+#include <libretro.h>
+#include <retro_common_api.h>
+
+#include <boolean.h>
+
+RETRO_BEGIN_DECLS
+
+#define PATH_REQUIRED_VFS_VERSION 3
+
+void path_vfs_init(const struct retro_vfs_interface_info* vfs_info);
+
+/* Order in this enum is equivalent to negative sort order in filelist
+ * (i.e. DIRECTORY is on top of PLAIN_FILE) */
+enum
+{
+ RARCH_FILETYPE_UNSET,
+ RARCH_PLAIN_FILE,
+ RARCH_COMPRESSED_FILE_IN_ARCHIVE,
+ RARCH_COMPRESSED_ARCHIVE,
+ RARCH_DIRECTORY,
+ RARCH_FILE_UNSUPPORTED
+};
+
+/**
+ * path_is_compressed_file:
+ * @path : path
+ *
+ * Checks if path is a compressed file.
+ *
+ * Returns: true (1) if path is a compressed file, otherwise false (0).
+ **/
+bool path_is_compressed_file(const char *path);
+
+/**
+ * path_contains_compressed_file:
+ * @path : path
+ *
+ * Checks if path contains a compressed file.
+ *
+ * Currently we only check for hash symbol (#) inside the pathname.
+ * If path is ever expanded to a general URI, we should check for that here.
+ *
+ * Example: Somewhere in the path there might be a compressed file
+ * E.g.: /path/to/file.7z#mygame.img
+ *
+ * Returns: true (1) if path contains compressed file, otherwise false (0).
+ **/
+#define path_contains_compressed_file(path) (path_get_archive_delim((path)) != NULL)
+
+/**
+ * path_get_archive_delim:
+ * @path : path
+ *
+ * Gets delimiter of an archive file. Only the first '#'
+ * after a compression extension is considered.
+ *
+ * Returns: pointer to the delimiter in the path if it contains
+ * a compressed file, otherwise NULL.
+ */
+const char *path_get_archive_delim(const char *path);
+
+/**
+ * path_get_extension:
+ * @path : path
+ *
+ * Gets extension of file. Only '.'s
+ * after the last slash are considered.
+ *
+ * Returns: extension part from the path.
+ */
+const char *path_get_extension(const char *path);
+
+/**
+ * path_remove_extension:
+ * @path : path
+ *
+ * Mutates path by removing its extension. Removes all
+ * text after and including the last '.'.
+ * Only '.'s after the last slash are considered.
+ *
+ * Returns:
+ * 1) If path has an extension, returns path with the
+ * extension removed.
+ * 2) If there is no extension, returns NULL.
+ * 3) If path is empty or NULL, returns NULL
+ */
+char *path_remove_extension(char *path);
+
+/**
+ * path_basename:
+ * @path : path
+ *
+ * Get basename from @path.
+ *
+ * Returns: basename from path.
+ **/
+const char *path_basename(const char *path);
+const char *path_basename_nocompression(const char *path);
+
+/**
+ * path_basedir:
+ * @path : path
+ *
+ * Extracts base directory by mutating path.
+ * Keeps trailing '/'.
+ **/
+void path_basedir(char *path);
+
+/**
+ * path_parent_dir:
+ * @path : path
+ *
+ * Extracts parent directory by mutating path.
+ * Assumes that path is a directory. Keeps trailing '/'.
+ * If the path was already at the root directory, returns empty string
+ **/
+void path_parent_dir(char *path);
+
+/**
+ * path_resolve_realpath:
+ * @buf : input and output buffer for path
+ * @size : size of buffer
+ * @resolve_symlinks : whether to resolve symlinks or not
+ *
+ * Resolves use of ".", "..", multiple slashes etc in absolute paths.
+ *
+ * Relative paths are rebased on the current working dir.
+ *
+ * Returns: @buf if successful, NULL otherwise.
+ * Note: Not implemented on consoles
+ * Note: Symlinks are only resolved on Unix-likes
+ * Note: The current working dir might not be what you expect,
+ * e.g. on Android it is "/"
+ * Use of fill_pathname_resolve_relative() should be prefered
+ **/
+char *path_resolve_realpath(char *buf, size_t size, bool resolve_symlinks);
+
+/**
+ * path_relative_to:
+ * @out : buffer to write the relative path to
+ * @path : path to be expressed relatively
+ * @base : relative to this
+ * @size : size of output buffer
+ *
+ * Turns @path into a path relative to @base and writes it to @out.
+ *
+ * @base is assumed to be a base directory, i.e. a path ending with '/' or '\'.
+ * Both @path and @base are assumed to be absolute paths without "." or "..".
+ *
+ * E.g. path /a/b/e/f.cgp with base /a/b/c/d/ turns into ../../e/f.cgp
+ **/
+size_t path_relative_to(char *out, const char *path, const char *base, size_t size);
+
+/**
+ * path_is_absolute:
+ * @path : path
+ *
+ * Checks if @path is an absolute path or a relative path.
+ *
+ * Returns: true if path is absolute, false if path is relative.
+ **/
+bool path_is_absolute(const char *path);
+
+/**
+ * fill_pathname:
+ * @out_path : output path
+ * @in_path : input path
+ * @replace : what to replace
+ * @size : buffer size of output path
+ *
+ * FIXME: Verify
+ *
+ * Replaces filename extension with 'replace' and outputs result to out_path.
+ * The extension here is considered to be the string from the last '.'
+ * to the end.
+ *
+ * Only '.'s after the last slash are considered as extensions.
+ * If no '.' is present, in_path and replace will simply be concatenated.
+ * 'size' is buffer size of 'out_path'.
+ * E.g.: in_path = "/foo/bar/baz/boo.c", replace = ".asm" =>
+ * out_path = "/foo/bar/baz/boo.asm"
+ * E.g.: in_path = "/foo/bar/baz/boo.c", replace = "" =>
+ * out_path = "/foo/bar/baz/boo"
+ */
+void fill_pathname(char *out_path, const char *in_path,
+ const char *replace, size_t size);
+
+/**
+ * fill_dated_filename:
+ * @out_filename : output filename
+ * @ext : extension of output filename
+ * @size : buffer size of output filename
+ *
+ * Creates a 'dated' filename prefixed by 'RetroArch', and
+ * concatenates extension (@ext) to it.
+ *
+ * E.g.:
+ * out_filename = "RetroArch-{month}{day}-{Hours}{Minutes}.{@ext}"
+ **/
+size_t fill_dated_filename(char *out_filename,
+ const char *ext, size_t size);
+
+/**
+ * fill_str_dated_filename:
+ * @out_filename : output filename
+ * @in_str : input string
+ * @ext : extension of output filename
+ * @size : buffer size of output filename
+ *
+ * Creates a 'dated' filename prefixed by the string @in_str, and
+ * concatenates extension (@ext) to it.
+ *
+ * E.g.:
+ * out_filename = "RetroArch-{year}{month}{day}-{Hour}{Minute}{Second}.{@ext}"
+ **/
+void fill_str_dated_filename(char *out_filename,
+ const char *in_str, const char *ext, size_t size);
+
+/**
+ * fill_pathname_noext:
+ * @out_path : output path
+ * @in_path : input path
+ * @replace : what to replace
+ * @size : buffer size of output path
+ *
+ * Appends a filename extension 'replace' to 'in_path', and outputs
+ * result in 'out_path'.
+ *
+ * Assumes in_path has no extension. If an extension is still
+ * present in 'in_path', it will be ignored.
+ *
+ */
+size_t fill_pathname_noext(char *out_path, const char *in_path,
+ const char *replace, size_t size);
+
+/**
+ * find_last_slash:
+ * @str : input path
+ *
+ * Gets a pointer to the last slash in the input path.
+ *
+ * Returns: a pointer to the last slash in the input path.
+ **/
+char *find_last_slash(const char *str);
+
+/**
+ * fill_pathname_dir:
+ * @in_dir : input directory path
+ * @in_basename : input basename to be appended to @in_dir
+ * @replace : replacement to be appended to @in_basename
+ * @size : size of buffer
+ *
+ * Appends basename of 'in_basename', to 'in_dir', along with 'replace'.
+ * Basename of in_basename is the string after the last '/' or '\\',
+ * i.e the filename without directories.
+ *
+ * If in_basename has no '/' or '\\', the whole 'in_basename' will be used.
+ * 'size' is buffer size of 'in_dir'.
+ *
+ * E.g..: in_dir = "/tmp/some_dir", in_basename = "/some_content/foo.c",
+ * replace = ".asm" => in_dir = "/tmp/some_dir/foo.c.asm"
+ **/
+size_t fill_pathname_dir(char *in_dir, const char *in_basename,
+ const char *replace, size_t size);
+
+/**
+ * fill_pathname_base:
+ * @out : output path
+ * @in_path : input path
+ * @size : size of output path
+ *
+ * Copies basename of @in_path into @out_path.
+ **/
+size_t fill_pathname_base(char *out_path, const char *in_path, size_t size);
+
+void fill_pathname_base_noext(char *out_dir,
+ const char *in_path, size_t size);
+
+size_t fill_pathname_base_ext(char *out,
+ const char *in_path, const char *ext,
+ size_t size);
+
+/**
+ * fill_pathname_basedir:
+ * @out_dir : output directory
+ * @in_path : input path
+ * @size : size of output directory
+ *
+ * Copies base directory of @in_path into @out_path.
+ * If in_path is a path without any slashes (relative current directory),
+ * @out_path will get path "./".
+ **/
+void fill_pathname_basedir(char *out_path, const char *in_path, size_t size);
+
+void fill_pathname_basedir_noext(char *out_dir,
+ const char *in_path, size_t size);
+
+/**
+ * fill_pathname_parent_dir_name:
+ * @out_dir : output directory
+ * @in_dir : input directory
+ * @size : size of output directory
+ *
+ * Copies only the parent directory name of @in_dir into @out_dir.
+ * The two buffers must not overlap. Removes trailing '/'.
+ * Returns true on success, false if a slash was not found in the path.
+ **/
+bool fill_pathname_parent_dir_name(char *out_dir,
+ const char *in_dir, size_t size);
+
+/**
+ * fill_pathname_parent_dir:
+ * @out_dir : output directory
+ * @in_dir : input directory
+ * @size : size of output directory
+ *
+ * Copies parent directory of @in_dir into @out_dir.
+ * Assumes @in_dir is a directory. Keeps trailing '/'.
+ * If the path was already at the root directory, @out_dir will be an empty string.
+ **/
+void fill_pathname_parent_dir(char *out_dir,
+ const char *in_dir, size_t size);
+
+/**
+ * fill_pathname_resolve_relative:
+ * @out_path : output path
+ * @in_refpath : input reference path
+ * @in_path : input path
+ * @size : size of @out_path
+ *
+ * Joins basedir of @in_refpath together with @in_path.
+ * If @in_path is an absolute path, out_path = in_path.
+ * E.g.: in_refpath = "/foo/bar/baz.a", in_path = "foobar.cg",
+ * out_path = "/foo/bar/foobar.cg".
+ **/
+void fill_pathname_resolve_relative(char *out_path, const char *in_refpath,
+ const char *in_path, size_t size);
+
+/**
+ * fill_pathname_join:
+ * @out_path : output path
+ * @dir : directory
+ * @path : path
+ * @size : size of output path
+ *
+ * Joins a directory (@dir) and path (@path) together.
+ * Makes sure not to get two consecutive slashes
+ * between directory and path.
+ **/
+size_t fill_pathname_join(char *out_path, const char *dir,
+ const char *path, size_t size);
+
+size_t fill_pathname_join_special_ext(char *out_path,
+ const char *dir, const char *path,
+ const char *last, const char *ext,
+ size_t size);
+
+size_t fill_pathname_join_concat_noext(char *out_path,
+ const char *dir, const char *path,
+ const char *concat,
+ size_t size);
+
+size_t fill_pathname_join_concat(char *out_path,
+ const char *dir, const char *path,
+ const char *concat,
+ size_t size);
+
+void fill_pathname_join_noext(char *out_path,
+ const char *dir, const char *path, size_t size);
+
+/**
+ * fill_pathname_join_delim:
+ * @out_path : output path
+ * @dir : directory
+ * @path : path
+ * @delim : delimiter
+ * @size : size of output path
+ *
+ * Joins a directory (@dir) and path (@path) together
+ * using the given delimiter (@delim).
+ **/
+size_t fill_pathname_join_delim(char *out_path, const char *dir,
+ const char *path, const char delim, size_t size);
+
+size_t fill_pathname_join_delim_concat(char *out_path, const char *dir,
+ const char *path, const char delim, const char *concat,
+ size_t size);
+
+/**
+ * fill_short_pathname_representation:
+ * @out_rep : output representation
+ * @in_path : input path
+ * @size : size of output representation
+ *
+ * Generates a short representation of path. It should only
+ * be used for displaying the result; the output representation is not
+ * binding in any meaningful way (for a normal path, this is the same as basename)
+ * In case of more complex URLs, this should cut everything except for
+ * the main image file.
+ *
+ * E.g.: "/path/to/game.img" -> game.img
+ * "/path/to/myarchive.7z#folder/to/game.img" -> game.img
+ */
+size_t fill_short_pathname_representation(char* out_rep,
+ const char *in_path, size_t size);
+
+void fill_short_pathname_representation_noext(char* out_rep,
+ const char *in_path, size_t size);
+
+void fill_pathname_expand_special(char *out_path,
+ const char *in_path, size_t size);
+
+void fill_pathname_abbreviate_special(char *out_path,
+ const char *in_path, size_t size);
+
+void fill_pathname_abbreviated_or_relative(char *out_path, const char *in_refpath, const char *in_path, size_t size);
+
+void pathname_conform_slashes_to_os(char *path);
+
+void pathname_make_slashes_portable(char *path);
+
+/**
+ * path_basedir:
+ * @path : path
+ *
+ * Extracts base directory by mutating path.
+ * Keeps trailing '/'.
+ **/
+void path_basedir_wrapper(char *path);
+
+/**
+ * path_char_is_slash:
+ * @c : character
+ *
+ * Checks if character (@c) is a slash.
+ *
+ * Returns: true (1) if character is a slash, otherwise false (0).
+ */
+#ifdef _WIN32
+#define PATH_CHAR_IS_SLASH(c) (((c) == '/') || ((c) == '\\'))
+#else
+#define PATH_CHAR_IS_SLASH(c) ((c) == '/')
+#endif
+
+/**
+ * path_default_slash and path_default_slash_c:
+ *
+ * Gets the default slash separator.
+ *
+ * Returns: default slash separator.
+ */
+#ifdef _WIN32
+#define PATH_DEFAULT_SLASH() "\\"
+#define PATH_DEFAULT_SLASH_C() '\\'
+#else
+#define PATH_DEFAULT_SLASH() "/"
+#define PATH_DEFAULT_SLASH_C() '/'
+#endif
+
+/**
+ * fill_pathname_slash:
+ * @path : path
+ * @size : size of path
+ *
+ * Assumes path is a directory. Appends a slash
+ * if not already there.
+ **/
+void fill_pathname_slash(char *path, size_t size);
+
+#if !defined(RARCH_CONSOLE) && defined(RARCH_INTERNAL)
+void fill_pathname_application_path(char *buf, size_t size);
+void fill_pathname_application_dir(char *buf, size_t size);
+void fill_pathname_home_dir(char *buf, size_t size);
+#endif
+
+/**
+ * path_mkdir:
+ * @dir : directory
+ *
+ * Create directory on filesystem.
+ *
+ * Returns: true (1) if directory could be created, otherwise false (0).
+ **/
+bool path_mkdir(const char *dir);
+
+/**
+ * path_is_directory:
+ * @path : path
+ *
+ * Checks if path is a directory.
+ *
+ * Returns: true (1) if path is a directory, otherwise false (0).
+ */
+bool path_is_directory(const char *path);
+
+bool path_is_character_special(const char *path);
+
+int path_stat(const char *path);
+
+bool path_is_valid(const char *path);
+
+int32_t path_get_size(const char *path);
+
+bool is_path_accessible_using_standard_io(const char *path);
+
+RETRO_END_DECLS
+
+#endif
diff --git a/libretro-common/include/libretro.h b/libretro-common/include/libretro.h
new file mode 100644
index 0000000..d9e28bf
--- /dev/null
+++ b/libretro-common/include/libretro.h
@@ -0,0 +1,3822 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this libretro API header (libretro.h).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef LIBRETRO_H__
+#define LIBRETRO_H__
+
+#include <stdint.h>
+#include <stddef.h>
+#include <limits.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#ifndef __cplusplus
+#if defined(_MSC_VER) && _MSC_VER < 1800 && !defined(SN_TARGET_PS3)
+/* Hack applied for MSVC when compiling in C89 mode
+ * as it isn't C99-compliant. */
+#define bool unsigned char
+#define true 1
+#define false 0
+#else
+#include <stdbool.h>
+#endif
+#endif
+
+#ifndef RETRO_CALLCONV
+# if defined(__GNUC__) && defined(__i386__) && !defined(__x86_64__)
+# define RETRO_CALLCONV __attribute__((cdecl))
+# elif defined(_MSC_VER) && defined(_M_X86) && !defined(_M_X64)
+# define RETRO_CALLCONV __cdecl
+# else
+# define RETRO_CALLCONV /* all other platforms only have one calling convention each */
+# endif
+#endif
+
+#ifndef RETRO_API
+# if defined(_WIN32) || defined(__CYGWIN__) || defined(__MINGW32__)
+# ifdef RETRO_IMPORT_SYMBOLS
+# ifdef __GNUC__
+# define RETRO_API RETRO_CALLCONV __attribute__((__dllimport__))
+# else
+# define RETRO_API RETRO_CALLCONV __declspec(dllimport)
+# endif
+# else
+# ifdef __GNUC__
+# define RETRO_API RETRO_CALLCONV __attribute__((__dllexport__))
+# else
+# define RETRO_API RETRO_CALLCONV __declspec(dllexport)
+# endif
+# endif
+# else
+# if defined(__GNUC__) && __GNUC__ >= 4
+# define RETRO_API RETRO_CALLCONV __attribute__((__visibility__("default")))
+# else
+# define RETRO_API RETRO_CALLCONV
+# endif
+# endif
+#endif
+
+/* Used for checking API/ABI mismatches that can break libretro
+ * implementations.
+ * It is not incremented for compatible changes to the API.
+ */
+#define RETRO_API_VERSION 1
+
+/*
+ * Libretro's fundamental device abstractions.
+ *
+ * Libretro's input system consists of some standardized device types,
+ * such as a joypad (with/without analog), mouse, keyboard, lightgun
+ * and a pointer.
+ *
+ * The functionality of these devices are fixed, and individual cores
+ * map their own concept of a controller to libretro's abstractions.
+ * This makes it possible for frontends to map the abstract types to a
+ * real input device, and not having to worry about binding input
+ * correctly to arbitrary controller layouts.
+ */
+
+#define RETRO_DEVICE_TYPE_SHIFT 8
+#define RETRO_DEVICE_MASK ((1 << RETRO_DEVICE_TYPE_SHIFT) - 1)
+#define RETRO_DEVICE_SUBCLASS(base, id) (((id + 1) << RETRO_DEVICE_TYPE_SHIFT) | base)
+
+/* Input disabled. */
+#define RETRO_DEVICE_NONE 0
+
+/* The JOYPAD is called RetroPad. It is essentially a Super Nintendo
+ * controller, but with additional L2/R2/L3/R3 buttons, similar to a
+ * PS1 DualShock. */
+#define RETRO_DEVICE_JOYPAD 1
+
+/* The mouse is a simple mouse, similar to Super Nintendo's mouse.
+ * X and Y coordinates are reported relatively to last poll (poll callback).
+ * It is up to the libretro implementation to keep track of where the mouse
+ * pointer is supposed to be on the screen.
+ * The frontend must make sure not to interfere with its own hardware
+ * mouse pointer.
+ */
+#define RETRO_DEVICE_MOUSE 2
+
+/* KEYBOARD device lets one poll for raw key pressed.
+ * It is poll based, so input callback will return with the current
+ * pressed state.
+ * For event/text based keyboard input, see
+ * RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK.
+ */
+#define RETRO_DEVICE_KEYBOARD 3
+
+/* LIGHTGUN device is similar to Guncon-2 for PlayStation 2.
+ * It reports X/Y coordinates in screen space (similar to the pointer)
+ * in the range [-0x8000, 0x7fff] in both axes, with zero being center and
+ * -0x8000 being out of bounds.
+ * As well as reporting on/off screen state. It features a trigger,
+ * start/select buttons, auxiliary action buttons and a
+ * directional pad. A forced off-screen shot can be requested for
+ * auto-reloading function in some games.
+ */
+#define RETRO_DEVICE_LIGHTGUN 4
+
+/* The ANALOG device is an extension to JOYPAD (RetroPad).
+ * Similar to DualShock2 it adds two analog sticks and all buttons can
+ * be analog. This is treated as a separate device type as it returns
+ * axis values in the full analog range of [-0x7fff, 0x7fff],
+ * although some devices may return -0x8000.
+ * Positive X axis is right. Positive Y axis is down.
+ * Buttons are returned in the range [0, 0x7fff].
+ * Only use ANALOG type when polling for analog values.
+ */
+#define RETRO_DEVICE_ANALOG 5
+
+/* Abstracts the concept of a pointing mechanism, e.g. touch.
+ * This allows libretro to query in absolute coordinates where on the
+ * screen a mouse (or something similar) is being placed.
+ * For a touch centric device, coordinates reported are the coordinates
+ * of the press.
+ *
+ * Coordinates in X and Y are reported as:
+ * [-0x7fff, 0x7fff]: -0x7fff corresponds to the far left/top of the screen,
+ * and 0x7fff corresponds to the far right/bottom of the screen.
+ * The "screen" is here defined as area that is passed to the frontend and
+ * later displayed on the monitor.
+ *
+ * The frontend is free to scale/resize this screen as it sees fit, however,
+ * (X, Y) = (-0x7fff, -0x7fff) will correspond to the top-left pixel of the
+ * game image, etc.
+ *
+ * To check if the pointer coordinates are valid (e.g. a touch display
+ * actually being touched), PRESSED returns 1 or 0.
+ *
+ * If using a mouse on a desktop, PRESSED will usually correspond to the
+ * left mouse button, but this is a frontend decision.
+ * PRESSED will only return 1 if the pointer is inside the game screen.
+ *
+ * For multi-touch, the index variable can be used to successively query
+ * more presses.
+ * If index = 0 returns true for _PRESSED, coordinates can be extracted
+ * with _X, _Y for index = 0. One can then query _PRESSED, _X, _Y with
+ * index = 1, and so on.
+ * Eventually _PRESSED will return false for an index. No further presses
+ * are registered at this point. */
+#define RETRO_DEVICE_POINTER 6
+
+/* Buttons for the RetroPad (JOYPAD).
+ * The placement of these is equivalent to placements on the
+ * Super Nintendo controller.
+ * L2/R2/L3/R3 buttons correspond to the PS1 DualShock.
+ * Also used as id values for RETRO_DEVICE_INDEX_ANALOG_BUTTON */
+#define RETRO_DEVICE_ID_JOYPAD_B 0
+#define RETRO_DEVICE_ID_JOYPAD_Y 1
+#define RETRO_DEVICE_ID_JOYPAD_SELECT 2
+#define RETRO_DEVICE_ID_JOYPAD_START 3
+#define RETRO_DEVICE_ID_JOYPAD_UP 4
+#define RETRO_DEVICE_ID_JOYPAD_DOWN 5
+#define RETRO_DEVICE_ID_JOYPAD_LEFT 6
+#define RETRO_DEVICE_ID_JOYPAD_RIGHT 7
+#define RETRO_DEVICE_ID_JOYPAD_A 8
+#define RETRO_DEVICE_ID_JOYPAD_X 9
+#define RETRO_DEVICE_ID_JOYPAD_L 10
+#define RETRO_DEVICE_ID_JOYPAD_R 11
+#define RETRO_DEVICE_ID_JOYPAD_L2 12
+#define RETRO_DEVICE_ID_JOYPAD_R2 13
+#define RETRO_DEVICE_ID_JOYPAD_L3 14
+#define RETRO_DEVICE_ID_JOYPAD_R3 15
+
+#define RETRO_DEVICE_ID_JOYPAD_MASK 256
+
+/* Index / Id values for ANALOG device. */
+#define RETRO_DEVICE_INDEX_ANALOG_LEFT 0
+#define RETRO_DEVICE_INDEX_ANALOG_RIGHT 1
+#define RETRO_DEVICE_INDEX_ANALOG_BUTTON 2
+#define RETRO_DEVICE_ID_ANALOG_X 0
+#define RETRO_DEVICE_ID_ANALOG_Y 1
+
+/* Id values for MOUSE. */
+#define RETRO_DEVICE_ID_MOUSE_X 0
+#define RETRO_DEVICE_ID_MOUSE_Y 1
+#define RETRO_DEVICE_ID_MOUSE_LEFT 2
+#define RETRO_DEVICE_ID_MOUSE_RIGHT 3
+#define RETRO_DEVICE_ID_MOUSE_WHEELUP 4
+#define RETRO_DEVICE_ID_MOUSE_WHEELDOWN 5
+#define RETRO_DEVICE_ID_MOUSE_MIDDLE 6
+#define RETRO_DEVICE_ID_MOUSE_HORIZ_WHEELUP 7
+#define RETRO_DEVICE_ID_MOUSE_HORIZ_WHEELDOWN 8
+#define RETRO_DEVICE_ID_MOUSE_BUTTON_4 9
+#define RETRO_DEVICE_ID_MOUSE_BUTTON_5 10
+
+/* Id values for LIGHTGUN. */
+#define RETRO_DEVICE_ID_LIGHTGUN_SCREEN_X 13 /*Absolute Position*/
+#define RETRO_DEVICE_ID_LIGHTGUN_SCREEN_Y 14 /*Absolute*/
+#define RETRO_DEVICE_ID_LIGHTGUN_IS_OFFSCREEN 15 /*Status Check*/
+#define RETRO_DEVICE_ID_LIGHTGUN_TRIGGER 2
+#define RETRO_DEVICE_ID_LIGHTGUN_RELOAD 16 /*Forced off-screen shot*/
+#define RETRO_DEVICE_ID_LIGHTGUN_AUX_A 3
+#define RETRO_DEVICE_ID_LIGHTGUN_AUX_B 4
+#define RETRO_DEVICE_ID_LIGHTGUN_START 6
+#define RETRO_DEVICE_ID_LIGHTGUN_SELECT 7
+#define RETRO_DEVICE_ID_LIGHTGUN_AUX_C 8
+#define RETRO_DEVICE_ID_LIGHTGUN_DPAD_UP 9
+#define RETRO_DEVICE_ID_LIGHTGUN_DPAD_DOWN 10
+#define RETRO_DEVICE_ID_LIGHTGUN_DPAD_LEFT 11
+#define RETRO_DEVICE_ID_LIGHTGUN_DPAD_RIGHT 12
+/* deprecated */
+#define RETRO_DEVICE_ID_LIGHTGUN_X 0 /*Relative Position*/
+#define RETRO_DEVICE_ID_LIGHTGUN_Y 1 /*Relative*/
+#define RETRO_DEVICE_ID_LIGHTGUN_CURSOR 3 /*Use Aux:A*/
+#define RETRO_DEVICE_ID_LIGHTGUN_TURBO 4 /*Use Aux:B*/
+#define RETRO_DEVICE_ID_LIGHTGUN_PAUSE 5 /*Use Start*/
+
+/* Id values for POINTER. */
+#define RETRO_DEVICE_ID_POINTER_X 0
+#define RETRO_DEVICE_ID_POINTER_Y 1
+#define RETRO_DEVICE_ID_POINTER_PRESSED 2
+#define RETRO_DEVICE_ID_POINTER_COUNT 3
+
+/* Returned from retro_get_region(). */
+#define RETRO_REGION_NTSC 0
+#define RETRO_REGION_PAL 1
+
+/* Id values for LANGUAGE */
+enum retro_language
+{
+ RETRO_LANGUAGE_ENGLISH = 0,
+ RETRO_LANGUAGE_JAPANESE = 1,
+ RETRO_LANGUAGE_FRENCH = 2,
+ RETRO_LANGUAGE_SPANISH = 3,
+ RETRO_LANGUAGE_GERMAN = 4,
+ RETRO_LANGUAGE_ITALIAN = 5,
+ RETRO_LANGUAGE_DUTCH = 6,
+ RETRO_LANGUAGE_PORTUGUESE_BRAZIL = 7,
+ RETRO_LANGUAGE_PORTUGUESE_PORTUGAL = 8,
+ RETRO_LANGUAGE_RUSSIAN = 9,
+ RETRO_LANGUAGE_KOREAN = 10,
+ RETRO_LANGUAGE_CHINESE_TRADITIONAL = 11,
+ RETRO_LANGUAGE_CHINESE_SIMPLIFIED = 12,
+ RETRO_LANGUAGE_ESPERANTO = 13,
+ RETRO_LANGUAGE_POLISH = 14,
+ RETRO_LANGUAGE_VIETNAMESE = 15,
+ RETRO_LANGUAGE_ARABIC = 16,
+ RETRO_LANGUAGE_GREEK = 17,
+ RETRO_LANGUAGE_TURKISH = 18,
+ RETRO_LANGUAGE_SLOVAK = 19,
+ RETRO_LANGUAGE_PERSIAN = 20,
+ RETRO_LANGUAGE_HEBREW = 21,
+ RETRO_LANGUAGE_ASTURIAN = 22,
+ RETRO_LANGUAGE_FINNISH = 23,
+ RETRO_LANGUAGE_LAST,
+
+ /* Ensure sizeof(enum) == sizeof(int) */
+ RETRO_LANGUAGE_DUMMY = INT_MAX
+};
+
+/* Passed to retro_get_memory_data/size().
+ * If the memory type doesn't apply to the
+ * implementation NULL/0 can be returned.
+ */
+#define RETRO_MEMORY_MASK 0xff
+
+/* Regular save RAM. This RAM is usually found on a game cartridge,
+ * backed up by a battery.
+ * If save game data is too complex for a single memory buffer,
+ * the SAVE_DIRECTORY (preferably) or SYSTEM_DIRECTORY environment
+ * callback can be used. */
+#define RETRO_MEMORY_SAVE_RAM 0
+
+/* Some games have a built-in clock to keep track of time.
+ * This memory is usually just a couple of bytes to keep track of time.
+ */
+#define RETRO_MEMORY_RTC 1
+
+/* System ram lets a frontend peek into a game systems main RAM. */
+#define RETRO_MEMORY_SYSTEM_RAM 2
+
+/* Video ram lets a frontend peek into a game systems video RAM (VRAM). */
+#define RETRO_MEMORY_VIDEO_RAM 3
+
+/* Keysyms used for ID in input state callback when polling RETRO_KEYBOARD. */
+enum retro_key
+{
+ RETROK_UNKNOWN = 0,
+ RETROK_FIRST = 0,
+ RETROK_BACKSPACE = 8,
+ RETROK_TAB = 9,
+ RETROK_CLEAR = 12,
+ RETROK_RETURN = 13,
+ RETROK_PAUSE = 19,
+ RETROK_ESCAPE = 27,
+ RETROK_SPACE = 32,
+ RETROK_EXCLAIM = 33,
+ RETROK_QUOTEDBL = 34,
+ RETROK_HASH = 35,
+ RETROK_DOLLAR = 36,
+ RETROK_AMPERSAND = 38,
+ RETROK_QUOTE = 39,
+ RETROK_LEFTPAREN = 40,
+ RETROK_RIGHTPAREN = 41,
+ RETROK_ASTERISK = 42,
+ RETROK_PLUS = 43,
+ RETROK_COMMA = 44,
+ RETROK_MINUS = 45,
+ RETROK_PERIOD = 46,
+ RETROK_SLASH = 47,
+ RETROK_0 = 48,
+ RETROK_1 = 49,
+ RETROK_2 = 50,
+ RETROK_3 = 51,
+ RETROK_4 = 52,
+ RETROK_5 = 53,
+ RETROK_6 = 54,
+ RETROK_7 = 55,
+ RETROK_8 = 56,
+ RETROK_9 = 57,
+ RETROK_COLON = 58,
+ RETROK_SEMICOLON = 59,
+ RETROK_LESS = 60,
+ RETROK_EQUALS = 61,
+ RETROK_GREATER = 62,
+ RETROK_QUESTION = 63,
+ RETROK_AT = 64,
+ RETROK_LEFTBRACKET = 91,
+ RETROK_BACKSLASH = 92,
+ RETROK_RIGHTBRACKET = 93,
+ RETROK_CARET = 94,
+ RETROK_UNDERSCORE = 95,
+ RETROK_BACKQUOTE = 96,
+ RETROK_a = 97,
+ RETROK_b = 98,
+ RETROK_c = 99,
+ RETROK_d = 100,
+ RETROK_e = 101,
+ RETROK_f = 102,
+ RETROK_g = 103,
+ RETROK_h = 104,
+ RETROK_i = 105,
+ RETROK_j = 106,
+ RETROK_k = 107,
+ RETROK_l = 108,
+ RETROK_m = 109,
+ RETROK_n = 110,
+ RETROK_o = 111,
+ RETROK_p = 112,
+ RETROK_q = 113,
+ RETROK_r = 114,
+ RETROK_s = 115,
+ RETROK_t = 116,
+ RETROK_u = 117,
+ RETROK_v = 118,
+ RETROK_w = 119,
+ RETROK_x = 120,
+ RETROK_y = 121,
+ RETROK_z = 122,
+ RETROK_LEFTBRACE = 123,
+ RETROK_BAR = 124,
+ RETROK_RIGHTBRACE = 125,
+ RETROK_TILDE = 126,
+ RETROK_DELETE = 127,
+
+ RETROK_KP0 = 256,
+ RETROK_KP1 = 257,
+ RETROK_KP2 = 258,
+ RETROK_KP3 = 259,
+ RETROK_KP4 = 260,
+ RETROK_KP5 = 261,
+ RETROK_KP6 = 262,
+ RETROK_KP7 = 263,
+ RETROK_KP8 = 264,
+ RETROK_KP9 = 265,
+ RETROK_KP_PERIOD = 266,
+ RETROK_KP_DIVIDE = 267,
+ RETROK_KP_MULTIPLY = 268,
+ RETROK_KP_MINUS = 269,
+ RETROK_KP_PLUS = 270,
+ RETROK_KP_ENTER = 271,
+ RETROK_KP_EQUALS = 272,
+
+ RETROK_UP = 273,
+ RETROK_DOWN = 274,
+ RETROK_RIGHT = 275,
+ RETROK_LEFT = 276,
+ RETROK_INSERT = 277,
+ RETROK_HOME = 278,
+ RETROK_END = 279,
+ RETROK_PAGEUP = 280,
+ RETROK_PAGEDOWN = 281,
+
+ RETROK_F1 = 282,
+ RETROK_F2 = 283,
+ RETROK_F3 = 284,
+ RETROK_F4 = 285,
+ RETROK_F5 = 286,
+ RETROK_F6 = 287,
+ RETROK_F7 = 288,
+ RETROK_F8 = 289,
+ RETROK_F9 = 290,
+ RETROK_F10 = 291,
+ RETROK_F11 = 292,
+ RETROK_F12 = 293,
+ RETROK_F13 = 294,
+ RETROK_F14 = 295,
+ RETROK_F15 = 296,
+
+ RETROK_NUMLOCK = 300,
+ RETROK_CAPSLOCK = 301,
+ RETROK_SCROLLOCK = 302,
+ RETROK_RSHIFT = 303,
+ RETROK_LSHIFT = 304,
+ RETROK_RCTRL = 305,
+ RETROK_LCTRL = 306,
+ RETROK_RALT = 307,
+ RETROK_LALT = 308,
+ RETROK_RMETA = 309,
+ RETROK_LMETA = 310,
+ RETROK_LSUPER = 311,
+ RETROK_RSUPER = 312,
+ RETROK_MODE = 313,
+ RETROK_COMPOSE = 314,
+
+ RETROK_HELP = 315,
+ RETROK_PRINT = 316,
+ RETROK_SYSREQ = 317,
+ RETROK_BREAK = 318,
+ RETROK_MENU = 319,
+ RETROK_POWER = 320,
+ RETROK_EURO = 321,
+ RETROK_UNDO = 322,
+ RETROK_OEM_102 = 323,
+
+ RETROK_LAST,
+
+ RETROK_DUMMY = INT_MAX /* Ensure sizeof(enum) == sizeof(int) */
+};
+
+enum retro_mod
+{
+ RETROKMOD_NONE = 0x0000,
+
+ RETROKMOD_SHIFT = 0x01,
+ RETROKMOD_CTRL = 0x02,
+ RETROKMOD_ALT = 0x04,
+ RETROKMOD_META = 0x08,
+
+ RETROKMOD_NUMLOCK = 0x10,
+ RETROKMOD_CAPSLOCK = 0x20,
+ RETROKMOD_SCROLLOCK = 0x40,
+
+ RETROKMOD_DUMMY = INT_MAX /* Ensure sizeof(enum) == sizeof(int) */
+};
+
+/* If set, this call is not part of the public libretro API yet. It can
+ * change or be removed at any time. */
+#define RETRO_ENVIRONMENT_EXPERIMENTAL 0x10000
+/* Environment callback to be used internally in frontend. */
+#define RETRO_ENVIRONMENT_PRIVATE 0x20000
+
+/* Environment commands. */
+#define RETRO_ENVIRONMENT_SET_ROTATION 1 /* const unsigned * --
+ * Sets screen rotation of graphics.
+ * Valid values are 0, 1, 2, 3, which rotates screen by 0, 90, 180,
+ * 270 degrees counter-clockwise respectively.
+ */
+#define RETRO_ENVIRONMENT_GET_OVERSCAN 2 /* bool * --
+ * NOTE: As of 2019 this callback is considered deprecated in favor of
+ * using core options to manage overscan in a more nuanced, core-specific way.
+ *
+ * Boolean value whether or not the implementation should use overscan,
+ * or crop away overscan.
+ */
+#define RETRO_ENVIRONMENT_GET_CAN_DUPE 3 /* bool * --
+ * Boolean value whether or not frontend supports frame duping,
+ * passing NULL to video frame callback.
+ */
+
+ /* Environ 4, 5 are no longer supported (GET_VARIABLE / SET_VARIABLES),
+ * and reserved to avoid possible ABI clash.
+ */
+
+#define RETRO_ENVIRONMENT_SET_MESSAGE 6 /* const struct retro_message * --
+ * Sets a message to be displayed in implementation-specific manner
+ * for a certain amount of 'frames'.
+ * Should not be used for trivial messages, which should simply be
+ * logged via RETRO_ENVIRONMENT_GET_LOG_INTERFACE (or as a
+ * fallback, stderr).
+ */
+#define RETRO_ENVIRONMENT_SHUTDOWN 7 /* N/A (NULL) --
+ * Requests the frontend to shutdown.
+ * Should only be used if game has a specific
+ * way to shutdown the game from a menu item or similar.
+ */
+#define RETRO_ENVIRONMENT_SET_PERFORMANCE_LEVEL 8
+ /* const unsigned * --
+ * Gives a hint to the frontend how demanding this implementation
+ * is on a system. E.g. reporting a level of 2 means
+ * this implementation should run decently on all frontends
+ * of level 2 and up.
+ *
+ * It can be used by the frontend to potentially warn
+ * about too demanding implementations.
+ *
+ * The levels are "floating".
+ *
+ * This function can be called on a per-game basis,
+ * as certain games an implementation can play might be
+ * particularly demanding.
+ * If called, it should be called in retro_load_game().
+ */
+#define RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY 9
+ /* const char ** --
+ * Returns the "system" directory of the frontend.
+ * This directory can be used to store system specific
+ * content such as BIOSes, configuration data, etc.
+ * The returned value can be NULL.
+ * If so, no such directory is defined,
+ * and it's up to the implementation to find a suitable directory.
+ *
+ * NOTE: Some cores used this folder also for "save" data such as
+ * memory cards, etc, for lack of a better place to put it.
+ * This is now discouraged, and if possible, cores should try to
+ * use the new GET_SAVE_DIRECTORY.
+ */
+#define RETRO_ENVIRONMENT_SET_PIXEL_FORMAT 10
+ /* const enum retro_pixel_format * --
+ * Sets the internal pixel format used by the implementation.
+ * The default pixel format is RETRO_PIXEL_FORMAT_0RGB1555.
+ * This pixel format however, is deprecated (see enum retro_pixel_format).
+ * If the call returns false, the frontend does not support this pixel
+ * format.
+ *
+ * This function should be called inside retro_load_game() or
+ * retro_get_system_av_info().
+ */
+#define RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS 11
+ /* const struct retro_input_descriptor * --
+ * Sets an array of retro_input_descriptors.
+ * It is up to the frontend to present this in a usable way.
+ * The array is terminated by retro_input_descriptor::description
+ * being set to NULL.
+ * This function can be called at any time, but it is recommended
+ * to call it as early as possible.
+ */
+#define RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK 12
+ /* const struct retro_keyboard_callback * --
+ * Sets a callback function used to notify core about keyboard events.
+ */
+#define RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE 13
+ /* const struct retro_disk_control_callback * --
+ * Sets an interface which frontend can use to eject and insert
+ * disk images.
+ * This is used for games which consist of multiple images and
+ * must be manually swapped out by the user (e.g. PSX).
+ */
+#define RETRO_ENVIRONMENT_SET_HW_RENDER 14
+ /* struct retro_hw_render_callback * --
+ * Sets an interface to let a libretro core render with
+ * hardware acceleration.
+ * Should be called in retro_load_game().
+ * If successful, libretro cores will be able to render to a
+ * frontend-provided framebuffer.
+ * The size of this framebuffer will be at least as large as
+ * max_width/max_height provided in get_av_info().
+ * If HW rendering is used, pass only RETRO_HW_FRAME_BUFFER_VALID or
+ * NULL to retro_video_refresh_t.
+ */
+#define RETRO_ENVIRONMENT_GET_VARIABLE 15
+ /* struct retro_variable * --
+ * Interface to acquire user-defined information from environment
+ * that cannot feasibly be supported in a multi-system way.
+ * 'key' should be set to a key which has already been set by
+ * SET_VARIABLES.
+ * 'data' will be set to a value or NULL.
+ */
+#define RETRO_ENVIRONMENT_SET_VARIABLES 16
+ /* const struct retro_variable * --
+ * Allows an implementation to signal the environment
+ * which variables it might want to check for later using
+ * GET_VARIABLE.
+ * This allows the frontend to present these variables to
+ * a user dynamically.
+ * This should be called the first time as early as
+ * possible (ideally in retro_set_environment).
+ * Afterward it may be called again for the core to communicate
+ * updated options to the frontend, but the number of core
+ * options must not change from the number in the initial call.
+ *
+ * 'data' points to an array of retro_variable structs
+ * terminated by a { NULL, NULL } element.
+ * retro_variable::key should be namespaced to not collide
+ * with other implementations' keys. E.g. A core called
+ * 'foo' should use keys named as 'foo_option'.
+ * retro_variable::value should contain a human readable
+ * description of the key as well as a '|' delimited list
+ * of expected values.
+ *
+ * The number of possible options should be very limited,
+ * i.e. it should be feasible to cycle through options
+ * without a keyboard.
+ *
+ * First entry should be treated as a default.
+ *
+ * Example entry:
+ * { "foo_option", "Speed hack coprocessor X; false|true" }
+ *
+ * Text before first ';' is description. This ';' must be
+ * followed by a space, and followed by a list of possible
+ * values split up with '|'.
+ *
+ * Only strings are operated on. The possible values will
+ * generally be displayed and stored as-is by the frontend.
+ */
+#define RETRO_ENVIRONMENT_GET_VARIABLE_UPDATE 17
+ /* bool * --
+ * Result is set to true if some variables are updated by
+ * frontend since last call to RETRO_ENVIRONMENT_GET_VARIABLE.
+ * Variables should be queried with GET_VARIABLE.
+ */
+#define RETRO_ENVIRONMENT_SET_SUPPORT_NO_GAME 18
+ /* const bool * --
+ * If true, the libretro implementation supports calls to
+ * retro_load_game() with NULL as argument.
+ * Used by cores which can run without particular game data.
+ * This should be called within retro_set_environment() only.
+ */
+#define RETRO_ENVIRONMENT_GET_LIBRETRO_PATH 19
+ /* const char ** --
+ * Retrieves the absolute path from where this libretro
+ * implementation was loaded.
+ * NULL is returned if the libretro was loaded statically
+ * (i.e. linked statically to frontend), or if the path cannot be
+ * determined.
+ * Mostly useful in cooperation with SET_SUPPORT_NO_GAME as assets can
+ * be loaded without ugly hacks.
+ */
+
+ /* Environment 20 was an obsolete version of SET_AUDIO_CALLBACK.
+ * It was not used by any known core at the time,
+ * and was removed from the API. */
+#define RETRO_ENVIRONMENT_SET_FRAME_TIME_CALLBACK 21
+ /* const struct retro_frame_time_callback * --
+ * Lets the core know how much time has passed since last
+ * invocation of retro_run().
+ * The frontend can tamper with the timing to fake fast-forward,
+ * slow-motion, frame stepping, etc.
+ * In this case the delta time will use the reference value
+ * in frame_time_callback..
+ */
+#define RETRO_ENVIRONMENT_SET_AUDIO_CALLBACK 22
+ /* const struct retro_audio_callback * --
+ * Sets an interface which is used to notify a libretro core about audio
+ * being available for writing.
+ * The callback can be called from any thread, so a core using this must
+ * have a thread safe audio implementation.
+ * It is intended for games where audio and video are completely
+ * asynchronous and audio can be generated on the fly.
+ * This interface is not recommended for use with emulators which have
+ * highly synchronous audio.
+ *
+ * The callback only notifies about writability; the libretro core still
+ * has to call the normal audio callbacks
+ * to write audio. The audio callbacks must be called from within the
+ * notification callback.
+ * The amount of audio data to write is up to the implementation.
+ * Generally, the audio callback will be called continously in a loop.
+ *
+ * Due to thread safety guarantees and lack of sync between audio and
+ * video, a frontend can selectively disallow this interface based on
+ * internal configuration. A core using this interface must also
+ * implement the "normal" audio interface.
+ *
+ * A libretro core using SET_AUDIO_CALLBACK should also make use of
+ * SET_FRAME_TIME_CALLBACK.
+ */
+#define RETRO_ENVIRONMENT_GET_RUMBLE_INTERFACE 23
+ /* struct retro_rumble_interface * --
+ * Gets an interface which is used by a libretro core to set
+ * state of rumble motors in controllers.
+ * A strong and weak motor is supported, and they can be
+ * controlled indepedently.
+ * Should be called from either retro_init() or retro_load_game().
+ * Should not be called from retro_set_environment().
+ * Returns false if rumble functionality is unavailable.
+ */
+#define RETRO_ENVIRONMENT_GET_INPUT_DEVICE_CAPABILITIES 24
+ /* uint64_t * --
+ * Gets a bitmask telling which device type are expected to be
+ * handled properly in a call to retro_input_state_t.
+ * Devices which are not handled or recognized always return
+ * 0 in retro_input_state_t.
+ * Example bitmask: caps = (1 << RETRO_DEVICE_JOYPAD) | (1 << RETRO_DEVICE_ANALOG).
+ * Should only be called in retro_run().
+ */
+#define RETRO_ENVIRONMENT_GET_SENSOR_INTERFACE (25 | RETRO_ENVIRONMENT_EXPERIMENTAL)
+ /* struct retro_sensor_interface * --
+ * Gets access to the sensor interface.
+ * The purpose of this interface is to allow
+ * setting state related to sensors such as polling rate,
+ * enabling/disable it entirely, etc.
+ * Reading sensor state is done via the normal
+ * input_state_callback API.
+ */
+#define RETRO_ENVIRONMENT_GET_CAMERA_INTERFACE (26 | RETRO_ENVIRONMENT_EXPERIMENTAL)
+ /* struct retro_camera_callback * --
+ * Gets an interface to a video camera driver.
+ * A libretro core can use this interface to get access to a
+ * video camera.
+ * New video frames are delivered in a callback in same
+ * thread as retro_run().
+ *
+ * GET_CAMERA_INTERFACE should be called in retro_load_game().
+ *
+ * Depending on the camera implementation used, camera frames
+ * will be delivered as a raw framebuffer,
+ * or as an OpenGL texture directly.
+ *
+ * The core has to tell the frontend here which types of
+ * buffers can be handled properly.
+ * An OpenGL texture can only be handled when using a
+ * libretro GL core (SET_HW_RENDER).
+ * It is recommended to use a libretro GL core when
+ * using camera interface.
+ *
+ * The camera is not started automatically. The retrieved start/stop
+ * functions must be used to explicitly
+ * start and stop the camera driver.
+ */
+#define RETRO_ENVIRONMENT_GET_LOG_INTERFACE 27
+ /* struct retro_log_callback * --
+ * Gets an interface for logging. This is useful for
+ * logging in a cross-platform way
+ * as certain platforms cannot use stderr for logging.
+ * It also allows the frontend to
+ * show logging information in a more suitable way.
+ * If this interface is not used, libretro cores should
+ * log to stderr as desired.
+ */
+#define RETRO_ENVIRONMENT_GET_PERF_INTERFACE 28
+ /* struct retro_perf_callback * --
+ * Gets an interface for performance counters. This is useful
+ * for performance logging in a cross-platform way and for detecting
+ * architecture-specific features, such as SIMD support.
+ */
+#define RETRO_ENVIRONMENT_GET_LOCATION_INTERFACE 29
+ /* struct retro_location_callback * --
+ * Gets access to the location interface.
+ * The purpose of this interface is to be able to retrieve
+ * location-based information from the host device,
+ * such as current latitude / longitude.
+ */
+#define RETRO_ENVIRONMENT_GET_CONTENT_DIRECTORY 30 /* Old name, kept for compatibility. */
+#define RETRO_ENVIRONMENT_GET_CORE_ASSETS_DIRECTORY 30
+ /* const char ** --
+ * Returns the "core assets" directory of the frontend.
+ * This directory can be used to store specific assets that the
+ * core relies upon, such as art assets,
+ * input data, etc etc.
+ * The returned value can be NULL.
+ * If so, no such directory is defined,
+ * and it's up to the implementation to find a suitable directory.
+ */
+#define RETRO_ENVIRONMENT_GET_SAVE_DIRECTORY 31
+ /* const char ** --
+ * Returns the "save" directory of the frontend, unless there is no
+ * save directory available. The save directory should be used to
+ * store SRAM, memory cards, high scores, etc, if the libretro core
+ * cannot use the regular memory interface (retro_get_memory_data()).
+ *
+ * If the frontend cannot designate a save directory, it will return
+ * NULL to indicate that the core should attempt to operate without a
+ * save directory set.
+ *
+ * NOTE: early libretro cores used the system directory for save
+ * files. Cores that need to be backwards-compatible can still check
+ * GET_SYSTEM_DIRECTORY.
+ */
+#define RETRO_ENVIRONMENT_SET_SYSTEM_AV_INFO 32
+ /* const struct retro_system_av_info * --
+ * Sets a new av_info structure. This can only be called from
+ * within retro_run().
+ * This should *only* be used if the core is completely altering the
+ * internal resolutions, aspect ratios, timings, sampling rate, etc.
+ * Calling this can require a full reinitialization of video/audio
+ * drivers in the frontend,
+ *
+ * so it is important to call it very sparingly, and usually only with
+ * the users explicit consent.
+ * An eventual driver reinitialize will happen so that video and
+ * audio callbacks
+ * happening after this call within the same retro_run() call will
+ * target the newly initialized driver.
+ *
+ * This callback makes it possible to support configurable resolutions
+ * in games, which can be useful to
+ * avoid setting the "worst case" in max_width/max_height.
+ *
+ * ***HIGHLY RECOMMENDED*** Do not call this callback every time
+ * resolution changes in an emulator core if it's
+ * expected to be a temporary change, for the reasons of possible
+ * driver reinitialization.
+ * This call is not a free pass for not trying to provide
+ * correct values in retro_get_system_av_info(). If you need to change
+ * things like aspect ratio or nominal width/height,
+ * use RETRO_ENVIRONMENT_SET_GEOMETRY, which is a softer variant
+ * of SET_SYSTEM_AV_INFO.
+ *
+ * If this returns false, the frontend does not acknowledge a
+ * changed av_info struct.
+ */
+#define RETRO_ENVIRONMENT_SET_PROC_ADDRESS_CALLBACK 33
+ /* const struct retro_get_proc_address_interface * --
+ * Allows a libretro core to announce support for the
+ * get_proc_address() interface.
+ * This interface allows for a standard way to extend libretro where
+ * use of environment calls are too indirect,
+ * e.g. for cases where the frontend wants to call directly into the core.
+ *
+ * If a core wants to expose this interface, SET_PROC_ADDRESS_CALLBACK
+ * **MUST** be called from within retro_set_environment().
+ */
+#define RETRO_ENVIRONMENT_SET_SUBSYSTEM_INFO 34
+ /* const struct retro_subsystem_info * --
+ * This environment call introduces the concept of libretro "subsystems".
+ * A subsystem is a variant of a libretro core which supports
+ * different kinds of games.
+ * The purpose of this is to support e.g. emulators which might
+ * have special needs, e.g. Super Nintendo's Super GameBoy, Sufami Turbo.
+ * It can also be used to pick among subsystems in an explicit way
+ * if the libretro implementation is a multi-system emulator itself.
+ *
+ * Loading a game via a subsystem is done with retro_load_game_special(),
+ * and this environment call allows a libretro core to expose which
+ * subsystems are supported for use with retro_load_game_special().
+ * A core passes an array of retro_game_special_info which is terminated
+ * with a zeroed out retro_game_special_info struct.
+ *
+ * If a core wants to use this functionality, SET_SUBSYSTEM_INFO
+ * **MUST** be called from within retro_set_environment().
+ */
+#define RETRO_ENVIRONMENT_SET_CONTROLLER_INFO 35
+ /* const struct retro_controller_info * --
+ * This environment call lets a libretro core tell the frontend
+ * which controller subclasses are recognized in calls to
+ * retro_set_controller_port_device().
+ *
+ * Some emulators such as Super Nintendo support multiple lightgun
+ * types which must be specifically selected from. It is therefore
+ * sometimes necessary for a frontend to be able to tell the core
+ * about a special kind of input device which is not specifcally
+ * provided by the Libretro API.
+ *
+ * In order for a frontend to understand the workings of those devices,
+ * they must be defined as a specialized subclass of the generic device
+ * types already defined in the libretro API.
+ *
+ * The core must pass an array of const struct retro_controller_info which
+ * is terminated with a blanked out struct. Each element of the
+ * retro_controller_info struct corresponds to the ascending port index
+ * that is passed to retro_set_controller_port_device() when that function
+ * is called to indicate to the core that the frontend has changed the
+ * active device subclass. SEE ALSO: retro_set_controller_port_device()
+ *
+ * The ascending input port indexes provided by the core in the struct
+ * are generally presented by frontends as ascending User # or Player #,
+ * such as Player 1, Player 2, Player 3, etc. Which device subclasses are
+ * supported can vary per input port.
+ *
+ * The first inner element of each entry in the retro_controller_info array
+ * is a retro_controller_description struct that specifies the names and
+ * codes of all device subclasses that are available for the corresponding
+ * User or Player, beginning with the generic Libretro device that the
+ * subclasses are derived from. The second inner element of each entry is the
+ * total number of subclasses that are listed in the retro_controller_description.
+ *
+ * NOTE: Even if special device types are set in the libretro core,
+ * libretro should only poll input based on the base input device types.
+ */
+#define RETRO_ENVIRONMENT_SET_MEMORY_MAPS (36 | RETRO_ENVIRONMENT_EXPERIMENTAL)
+ /* const struct retro_memory_map * --
+ * This environment call lets a libretro core tell the frontend
+ * about the memory maps this core emulates.
+ * This can be used to implement, for example, cheats in a core-agnostic way.
+ *
+ * Should only be used by emulators; it doesn't make much sense for
+ * anything else.
+ * It is recommended to expose all relevant pointers through
+ * retro_get_memory_* as well.
+ *
+ * Can be called from retro_init and retro_load_game.
+ */
+#define RETRO_ENVIRONMENT_SET_GEOMETRY 37
+ /* const struct retro_game_geometry * --
+ * This environment call is similar to SET_SYSTEM_AV_INFO for changing
+ * video parameters, but provides a guarantee that drivers will not be
+ * reinitialized.
+ * This can only be called from within retro_run().
+ *
+ * The purpose of this call is to allow a core to alter nominal
+ * width/heights as well as aspect ratios on-the-fly, which can be
+ * useful for some emulators to change in run-time.
+ *
+ * max_width/max_height arguments are ignored and cannot be changed
+ * with this call as this could potentially require a reinitialization or a
+ * non-constant time operation.
+ * If max_width/max_height are to be changed, SET_SYSTEM_AV_INFO is required.
+ *
+ * A frontend must guarantee that this environment call completes in
+ * constant time.
+ */
+#define RETRO_ENVIRONMENT_GET_USERNAME 38
+ /* const char **
+ * Returns the specified username of the frontend, if specified by the user.
+ * This username can be used as a nickname for a core that has online facilities
+ * or any other mode where personalization of the user is desirable.
+ * The returned value can be NULL.
+ * If this environ callback is used by a core that requires a valid username,
+ * a default username should be specified by the core.
+ */
+#define RETRO_ENVIRONMENT_GET_LANGUAGE 39
+ /* unsigned * --
+ * Returns the specified language of the frontend, if specified by the user.
+ * It can be used by the core for localization purposes.
+ */
+#define RETRO_ENVIRONMENT_GET_CURRENT_SOFTWARE_FRAMEBUFFER (40 | RETRO_ENVIRONMENT_EXPERIMENTAL)
+ /* struct retro_framebuffer * --
+ * Returns a preallocated framebuffer which the core can use for rendering
+ * the frame into when not using SET_HW_RENDER.
+ * The framebuffer returned from this call must not be used
+ * after the current call to retro_run() returns.
+ *
+ * The goal of this call is to allow zero-copy behavior where a core
+ * can render directly into video memory, avoiding extra bandwidth cost by copying
+ * memory from core to video memory.
+ *
+ * If this call succeeds and the core renders into it,
+ * the framebuffer pointer and pitch can be passed to retro_video_refresh_t.
+ * If the buffer from GET_CURRENT_SOFTWARE_FRAMEBUFFER is to be used,
+ * the core must pass the exact
+ * same pointer as returned by GET_CURRENT_SOFTWARE_FRAMEBUFFER;
+ * i.e. passing a pointer which is offset from the
+ * buffer is undefined. The width, height and pitch parameters
+ * must also match exactly to the values obtained from GET_CURRENT_SOFTWARE_FRAMEBUFFER.
+ *
+ * It is possible for a frontend to return a different pixel format
+ * than the one used in SET_PIXEL_FORMAT. This can happen if the frontend
+ * needs to perform conversion.
+ *
+ * It is still valid for a core to render to a different buffer
+ * even if GET_CURRENT_SOFTWARE_FRAMEBUFFER succeeds.
+ *
+ * A frontend must make sure that the pointer obtained from this function is
+ * writeable (and readable).
+ */
+#define RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE (41 | RETRO_ENVIRONMENT_EXPERIMENTAL)
+ /* const struct retro_hw_render_interface ** --
+ * Returns an API specific rendering interface for accessing API specific data.
+ * Not all HW rendering APIs support or need this.
+ * The contents of the returned pointer is specific to the rendering API
+ * being used. See the various headers like libretro_vulkan.h, etc.
+ *
+ * GET_HW_RENDER_INTERFACE cannot be called before context_reset has been called.
+ * Similarly, after context_destroyed callback returns,
+ * the contents of the HW_RENDER_INTERFACE are invalidated.
+ */
+#define RETRO_ENVIRONMENT_SET_SUPPORT_ACHIEVEMENTS (42 | RETRO_ENVIRONMENT_EXPERIMENTAL)
+ /* const bool * --
+ * If true, the libretro implementation supports achievements
+ * either via memory descriptors set with RETRO_ENVIRONMENT_SET_MEMORY_MAPS
+ * or via retro_get_memory_data/retro_get_memory_size.
+ *
+ * This must be called before the first call to retro_run.
+ */
+#define RETRO_ENVIRONMENT_SET_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE (43 | RETRO_ENVIRONMENT_EXPERIMENTAL)
+ /* const struct retro_hw_render_context_negotiation_interface * --
+ * Sets an interface which lets the libretro core negotiate with frontend how a context is created.
+ * The semantics of this interface depends on which API is used in SET_HW_RENDER earlier.
+ * This interface will be used when the frontend is trying to create a HW rendering context,
+ * so it will be used after SET_HW_RENDER, but before the context_reset callback.
+ */
+#define RETRO_ENVIRONMENT_SET_SERIALIZATION_QUIRKS 44
+ /* uint64_t * --
+ * Sets quirk flags associated with serialization. The frontend will zero any flags it doesn't
+ * recognize or support. Should be set in either retro_init or retro_load_game, but not both.
+ */
+#define RETRO_ENVIRONMENT_SET_HW_SHARED_CONTEXT (44 | RETRO_ENVIRONMENT_EXPERIMENTAL)
+ /* N/A (null) * --
+ * The frontend will try to use a 'shared' hardware context (mostly applicable
+ * to OpenGL) when a hardware context is being set up.
+ *
+ * Returns true if the frontend supports shared hardware contexts and false
+ * if the frontend does not support shared hardware contexts.
+ *
+ * This will do nothing on its own until SET_HW_RENDER env callbacks are
+ * being used.
+ */
+#define RETRO_ENVIRONMENT_GET_VFS_INTERFACE (45 | RETRO_ENVIRONMENT_EXPERIMENTAL)
+ /* struct retro_vfs_interface_info * --
+ * Gets access to the VFS interface.
+ * VFS presence needs to be queried prior to load_game or any
+ * get_system/save/other_directory being called to let front end know
+ * core supports VFS before it starts handing out paths.
+ * It is recomended to do so in retro_set_environment
+ */
+#define RETRO_ENVIRONMENT_GET_LED_INTERFACE (46 | RETRO_ENVIRONMENT_EXPERIMENTAL)
+ /* struct retro_led_interface * --
+ * Gets an interface which is used by a libretro core to set
+ * state of LEDs.
+ */
+#define RETRO_ENVIRONMENT_GET_AUDIO_VIDEO_ENABLE (47 | RETRO_ENVIRONMENT_EXPERIMENTAL)
+ /* int * --
+ * Tells the core if the frontend wants audio or video.
+ * If disabled, the frontend will discard the audio or video,
+ * so the core may decide to skip generating a frame or generating audio.
+ * This is mainly used for increasing performance.
+ * Bit 0 (value 1): Enable Video
+ * Bit 1 (value 2): Enable Audio
+ * Bit 2 (value 4): Use Fast Savestates.
+ * Bit 3 (value 8): Hard Disable Audio
+ * Other bits are reserved for future use and will default to zero.
+ * If video is disabled:
+ * * The frontend wants the core to not generate any video,
+ * including presenting frames via hardware acceleration.
+ * * The frontend's video frame callback will do nothing.
+ * * After running the frame, the video output of the next frame should be
+ * no different than if video was enabled, and saving and loading state
+ * should have no issues.
+ * If audio is disabled:
+ * * The frontend wants the core to not generate any audio.
+ * * The frontend's audio callbacks will do nothing.
+ * * After running the frame, the audio output of the next frame should be
+ * no different than if audio was enabled, and saving and loading state
+ * should have no issues.
+ * Fast Savestates:
+ * * Guaranteed to be created by the same binary that will load them.
+ * * Will not be written to or read from the disk.
+ * * Suggest that the core assumes loading state will succeed.
+ * * Suggest that the core updates its memory buffers in-place if possible.
+ * * Suggest that the core skips clearing memory.
+ * * Suggest that the core skips resetting the system.
+ * * Suggest that the core may skip validation steps.
+ * Hard Disable Audio:
+ * * Used for a secondary core when running ahead.
+ * * Indicates that the frontend will never need audio from the core.
+ * * Suggests that the core may stop synthesizing audio, but this should not
+ * compromise emulation accuracy.
+ * * Audio output for the next frame does not matter, and the frontend will
+ * never need an accurate audio state in the future.
+ * * State will never be saved when using Hard Disable Audio.
+ */
+#define RETRO_ENVIRONMENT_GET_MIDI_INTERFACE (48 | RETRO_ENVIRONMENT_EXPERIMENTAL)
+ /* struct retro_midi_interface ** --
+ * Returns a MIDI interface that can be used for raw data I/O.
+ */
+
+#define RETRO_ENVIRONMENT_GET_FASTFORWARDING (49 | RETRO_ENVIRONMENT_EXPERIMENTAL)
+ /* bool * --
+ * Boolean value that indicates whether or not the frontend is in
+ * fastforwarding mode.
+ */
+
+#define RETRO_ENVIRONMENT_GET_TARGET_REFRESH_RATE (50 | RETRO_ENVIRONMENT_EXPERIMENTAL)
+ /* float * --
+ * Float value that lets us know what target refresh rate
+ * is curently in use by the frontend.
+ *
+ * The core can use the returned value to set an ideal
+ * refresh rate/framerate.
+ */
+
+#define RETRO_ENVIRONMENT_GET_INPUT_BITMASKS (51 | RETRO_ENVIRONMENT_EXPERIMENTAL)
+ /* bool * --
+ * Boolean value that indicates whether or not the frontend supports
+ * input bitmasks being returned by retro_input_state_t. The advantage
+ * of this is that retro_input_state_t has to be only called once to
+ * grab all button states instead of multiple times.
+ *
+ * If it returns true, you can pass RETRO_DEVICE_ID_JOYPAD_MASK as 'id'
+ * to retro_input_state_t (make sure 'device' is set to RETRO_DEVICE_JOYPAD).
+ * It will return a bitmask of all the digital buttons.
+ */
+
+#define RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION 52
+ /* unsigned * --
+ * Unsigned value is the API version number of the core options
+ * interface supported by the frontend. If callback return false,
+ * API version is assumed to be 0.
+ *
+ * In legacy code, core options are set by passing an array of
+ * retro_variable structs to RETRO_ENVIRONMENT_SET_VARIABLES.
+ * This may be still be done regardless of the core options
+ * interface version.
+ *
+ * If version is >= 1 however, core options may instead be set by
+ * passing an array of retro_core_option_definition structs to
+ * RETRO_ENVIRONMENT_SET_CORE_OPTIONS, or a 2D array of
+ * retro_core_option_definition structs to RETRO_ENVIRONMENT_SET_CORE_OPTIONS_INTL.
+ * This allows the core to additionally set option sublabel information
+ * and/or provide localisation support.
+ *
+ * If version is >= 2, core options may instead be set by passing
+ * a retro_core_options_v2 struct to RETRO_ENVIRONMENT_SET_CORE_OPTIONS_V2,
+ * or an array of retro_core_options_v2 structs to
+ * RETRO_ENVIRONMENT_SET_CORE_OPTIONS_V2_INTL. This allows the core
+ * to additionally set optional core option category information
+ * for frontends with core option category support.
+ */
+
+#define RETRO_ENVIRONMENT_SET_CORE_OPTIONS 53
+ /* const struct retro_core_option_definition ** --
+ * Allows an implementation to signal the environment
+ * which variables it might want to check for later using
+ * GET_VARIABLE.
+ * This allows the frontend to present these variables to
+ * a user dynamically.
+ * This should only be called if RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION
+ * returns an API version of >= 1.
+ * This should be called instead of RETRO_ENVIRONMENT_SET_VARIABLES.
+ * This should be called the first time as early as
+ * possible (ideally in retro_set_environment).
+ * Afterwards it may be called again for the core to communicate
+ * updated options to the frontend, but the number of core
+ * options must not change from the number in the initial call.
+ *
+ * 'data' points to an array of retro_core_option_definition structs
+ * terminated by a { NULL, NULL, NULL, {{0}}, NULL } element.
+ * retro_core_option_definition::key should be namespaced to not collide
+ * with other implementations' keys. e.g. A core called
+ * 'foo' should use keys named as 'foo_option'.
+ * retro_core_option_definition::desc should contain a human readable
+ * description of the key.
+ * retro_core_option_definition::info should contain any additional human
+ * readable information text that a typical user may need to
+ * understand the functionality of the option.
+ * retro_core_option_definition::values is an array of retro_core_option_value
+ * structs terminated by a { NULL, NULL } element.
+ * > retro_core_option_definition::values[index].value is an expected option
+ * value.
+ * > retro_core_option_definition::values[index].label is a human readable
+ * label used when displaying the value on screen. If NULL,
+ * the value itself is used.
+ * retro_core_option_definition::default_value is the default core option
+ * setting. It must match one of the expected option values in the
+ * retro_core_option_definition::values array. If it does not, or the
+ * default value is NULL, the first entry in the
+ * retro_core_option_definition::values array is treated as the default.
+ *
+ * The number of possible option values should be very limited,
+ * and must be less than RETRO_NUM_CORE_OPTION_VALUES_MAX.
+ * i.e. it should be feasible to cycle through options
+ * without a keyboard.
+ *
+ * Example entry:
+ * {
+ * "foo_option",
+ * "Speed hack coprocessor X",
+ * "Provides increased performance at the expense of reduced accuracy",
+ * {
+ * { "false", NULL },
+ * { "true", NULL },
+ * { "unstable", "Turbo (Unstable)" },
+ * { NULL, NULL },
+ * },
+ * "false"
+ * }
+ *
+ * Only strings are operated on. The possible values will
+ * generally be displayed and stored as-is by the frontend.
+ */
+
+#define RETRO_ENVIRONMENT_SET_CORE_OPTIONS_INTL 54
+ /* const struct retro_core_options_intl * --
+ * Allows an implementation to signal the environment
+ * which variables it might want to check for later using
+ * GET_VARIABLE.
+ * This allows the frontend to present these variables to
+ * a user dynamically.
+ * This should only be called if RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION
+ * returns an API version of >= 1.
+ * This should be called instead of RETRO_ENVIRONMENT_SET_VARIABLES.
+ * This should be called instead of RETRO_ENVIRONMENT_SET_CORE_OPTIONS.
+ * This should be called the first time as early as
+ * possible (ideally in retro_set_environment).
+ * Afterwards it may be called again for the core to communicate
+ * updated options to the frontend, but the number of core
+ * options must not change from the number in the initial call.
+ *
+ * This is fundamentally the same as RETRO_ENVIRONMENT_SET_CORE_OPTIONS,
+ * with the addition of localisation support. The description of the
+ * RETRO_ENVIRONMENT_SET_CORE_OPTIONS callback should be consulted
+ * for further details.
+ *
+ * 'data' points to a retro_core_options_intl struct.
+ *
+ * retro_core_options_intl::us is a pointer to an array of
+ * retro_core_option_definition structs defining the US English
+ * core options implementation. It must point to a valid array.
+ *
+ * retro_core_options_intl::local is a pointer to an array of
+ * retro_core_option_definition structs defining core options for
+ * the current frontend language. It may be NULL (in which case
+ * retro_core_options_intl::us is used by the frontend). Any items
+ * missing from this array will be read from retro_core_options_intl::us
+ * instead.
+ *
+ * NOTE: Default core option values are always taken from the
+ * retro_core_options_intl::us array. Any default values in
+ * retro_core_options_intl::local array will be ignored.
+ */
+
+#define RETRO_ENVIRONMENT_SET_CORE_OPTIONS_DISPLAY 55
+ /* struct retro_core_option_display * --
+ *
+ * Allows an implementation to signal the environment to show
+ * or hide a variable when displaying core options. This is
+ * considered a *suggestion*. The frontend is free to ignore
+ * this callback, and its implementation not considered mandatory.
+ *
+ * 'data' points to a retro_core_option_display struct
+ *
+ * retro_core_option_display::key is a variable identifier
+ * which has already been set by SET_VARIABLES/SET_CORE_OPTIONS.
+ *
+ * retro_core_option_display::visible is a boolean, specifying
+ * whether variable should be displayed
+ *
+ * Note that all core option variables will be set visible by
+ * default when calling SET_VARIABLES/SET_CORE_OPTIONS.
+ */
+
+#define RETRO_ENVIRONMENT_GET_PREFERRED_HW_RENDER 56
+ /* unsigned * --
+ *
+ * Allows an implementation to ask frontend preferred hardware
+ * context to use. Core should use this information to deal
+ * with what specific context to request with SET_HW_RENDER.
+ *
+ * 'data' points to an unsigned variable
+ */
+
+#define RETRO_ENVIRONMENT_GET_DISK_CONTROL_INTERFACE_VERSION 57
+ /* unsigned * --
+ * Unsigned value is the API version number of the disk control
+ * interface supported by the frontend. If callback return false,
+ * API version is assumed to be 0.
+ *
+ * In legacy code, the disk control interface is defined by passing
+ * a struct of type retro_disk_control_callback to
+ * RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE.
+ * This may be still be done regardless of the disk control
+ * interface version.
+ *
+ * If version is >= 1 however, the disk control interface may
+ * instead be defined by passing a struct of type
+ * retro_disk_control_ext_callback to
+ * RETRO_ENVIRONMENT_SET_DISK_CONTROL_EXT_INTERFACE.
+ * This allows the core to provide additional information about
+ * disk images to the frontend and/or enables extra
+ * disk control functionality by the frontend.
+ */
+
+#define RETRO_ENVIRONMENT_SET_DISK_CONTROL_EXT_INTERFACE 58
+ /* const struct retro_disk_control_ext_callback * --
+ * Sets an interface which frontend can use to eject and insert
+ * disk images, and also obtain information about individual
+ * disk image files registered by the core.
+ * This is used for games which consist of multiple images and
+ * must be manually swapped out by the user (e.g. PSX, floppy disk
+ * based systems).
+ */
+
+#define RETRO_ENVIRONMENT_GET_MESSAGE_INTERFACE_VERSION 59
+ /* unsigned * --
+ * Unsigned value is the API version number of the message
+ * interface supported by the frontend. If callback returns
+ * false, API version is assumed to be 0.
+ *
+ * In legacy code, messages may be displayed in an
+ * implementation-specific manner by passing a struct
+ * of type retro_message to RETRO_ENVIRONMENT_SET_MESSAGE.
+ * This may be still be done regardless of the message
+ * interface version.
+ *
+ * If version is >= 1 however, messages may instead be
+ * displayed by passing a struct of type retro_message_ext
+ * to RETRO_ENVIRONMENT_SET_MESSAGE_EXT. This allows the
+ * core to specify message logging level, priority and
+ * destination (OSD, logging interface or both).
+ */
+
+#define RETRO_ENVIRONMENT_SET_MESSAGE_EXT 60
+ /* const struct retro_message_ext * --
+ * Sets a message to be displayed in an implementation-specific
+ * manner for a certain amount of 'frames'. Additionally allows
+ * the core to specify message logging level, priority and
+ * destination (OSD, logging interface or both).
+ * Should not be used for trivial messages, which should simply be
+ * logged via RETRO_ENVIRONMENT_GET_LOG_INTERFACE (or as a
+ * fallback, stderr).
+ */
+
+#define RETRO_ENVIRONMENT_GET_INPUT_MAX_USERS 61
+ /* unsigned * --
+ * Unsigned value is the number of active input devices
+ * provided by the frontend. This may change between
+ * frames, but will remain constant for the duration
+ * of each frame.
+ * If callback returns true, a core need not poll any
+ * input device with an index greater than or equal to
+ * the number of active devices.
+ * If callback returns false, the number of active input
+ * devices is unknown. In this case, all input devices
+ * should be considered active.
+ */
+
+#define RETRO_ENVIRONMENT_SET_AUDIO_BUFFER_STATUS_CALLBACK 62
+ /* const struct retro_audio_buffer_status_callback * --
+ * Lets the core know the occupancy level of the frontend
+ * audio buffer. Can be used by a core to attempt frame
+ * skipping in order to avoid buffer under-runs.
+ * A core may pass NULL to disable buffer status reporting
+ * in the frontend.
+ */
+
+#define RETRO_ENVIRONMENT_SET_MINIMUM_AUDIO_LATENCY 63
+ /* const unsigned * --
+ * Sets minimum frontend audio latency in milliseconds.
+ * Resultant audio latency may be larger than set value,
+ * or smaller if a hardware limit is encountered. A frontend
+ * is expected to honour requests up to 512 ms.
+ *
+ * - If value is less than current frontend
+ * audio latency, callback has no effect
+ * - If value is zero, default frontend audio
+ * latency is set
+ *
+ * May be used by a core to increase audio latency and
+ * therefore decrease the probability of buffer under-runs
+ * (crackling) when performing 'intensive' operations.
+ * A core utilising RETRO_ENVIRONMENT_SET_AUDIO_BUFFER_STATUS_CALLBACK
+ * to implement audio-buffer-based frame skipping may achieve
+ * optimal results by setting the audio latency to a 'high'
+ * (typically 6x or 8x) integer multiple of the expected
+ * frame time.
+ *
+ * WARNING: This can only be called from within retro_run().
+ * Calling this can require a full reinitialization of audio
+ * drivers in the frontend, so it is important to call it very
+ * sparingly, and usually only with the users explicit consent.
+ * An eventual driver reinitialize will happen so that audio
+ * callbacks happening after this call within the same retro_run()
+ * call will target the newly initialized driver.
+ */
+
+#define RETRO_ENVIRONMENT_SET_FASTFORWARDING_OVERRIDE 64
+ /* const struct retro_fastforwarding_override * --
+ * Used by a libretro core to override the current
+ * fastforwarding mode of the frontend.
+ * If NULL is passed to this function, the frontend
+ * will return true if fastforwarding override
+ * functionality is supported (no change in
+ * fastforwarding state will occur in this case).
+ */
+
+#define RETRO_ENVIRONMENT_SET_CONTENT_INFO_OVERRIDE 65
+ /* const struct retro_system_content_info_override * --
+ * Allows an implementation to override 'global' content
+ * info parameters reported by retro_get_system_info().
+ * Overrides also affect subsystem content info parameters
+ * set via RETRO_ENVIRONMENT_SET_SUBSYSTEM_INFO.
+ * This function must be called inside retro_set_environment().
+ * If callback returns false, content info overrides
+ * are unsupported by the frontend, and will be ignored.
+ * If callback returns true, extended game info may be
+ * retrieved by calling RETRO_ENVIRONMENT_GET_GAME_INFO_EXT
+ * in retro_load_game() or retro_load_game_special().
+ *
+ * 'data' points to an array of retro_system_content_info_override
+ * structs terminated by a { NULL, false, false } element.
+ * If 'data' is NULL, no changes will be made to the frontend;
+ * a core may therefore pass NULL in order to test whether
+ * the RETRO_ENVIRONMENT_SET_CONTENT_INFO_OVERRIDE and
+ * RETRO_ENVIRONMENT_GET_GAME_INFO_EXT callbacks are supported
+ * by the frontend.
+ *
+ * For struct member descriptions, see the definition of
+ * struct retro_system_content_info_override.
+ *
+ * Example:
+ *
+ * - struct retro_system_info:
+ * {
+ * "My Core", // library_name
+ * "v1.0", // library_version
+ * "m3u|md|cue|iso|chd|sms|gg|sg", // valid_extensions
+ * true, // need_fullpath
+ * false // block_extract
+ * }
+ *
+ * - Array of struct retro_system_content_info_override:
+ * {
+ * {
+ * "md|sms|gg", // extensions
+ * false, // need_fullpath
+ * true // persistent_data
+ * },
+ * {
+ * "sg", // extensions
+ * false, // need_fullpath
+ * false // persistent_data
+ * },
+ * { NULL, false, false }
+ * }
+ *
+ * Result:
+ * - Files of type m3u, cue, iso, chd will not be
+ * loaded by the frontend. Frontend will pass a
+ * valid path to the core, and core will handle
+ * loading internally
+ * - Files of type md, sms, gg will be loaded by
+ * the frontend. A valid memory buffer will be
+ * passed to the core. This memory buffer will
+ * remain valid until retro_deinit() returns
+ * - Files of type sg will be loaded by the frontend.
+ * A valid memory buffer will be passed to the core.
+ * This memory buffer will remain valid until
+ * retro_load_game() (or retro_load_game_special())
+ * returns
+ *
+ * NOTE: If an extension is listed multiple times in
+ * an array of retro_system_content_info_override
+ * structs, only the first instance will be registered
+ */
+
+#define RETRO_ENVIRONMENT_GET_GAME_INFO_EXT 66
+ /* const struct retro_game_info_ext ** --
+ * Allows an implementation to fetch extended game
+ * information, providing additional content path
+ * and memory buffer status details.
+ * This function may only be called inside
+ * retro_load_game() or retro_load_game_special().
+ * If callback returns false, extended game information
+ * is unsupported by the frontend. In this case, only
+ * regular retro_game_info will be available.
+ * RETRO_ENVIRONMENT_GET_GAME_INFO_EXT is guaranteed
+ * to return true if RETRO_ENVIRONMENT_SET_CONTENT_INFO_OVERRIDE
+ * returns true.
+ *
+ * 'data' points to an array of retro_game_info_ext structs.
+ *
+ * For struct member descriptions, see the definition of
+ * struct retro_game_info_ext.
+ *
+ * - If function is called inside retro_load_game(),
+ * the retro_game_info_ext array is guaranteed to
+ * have a size of 1 - i.e. the returned pointer may
+ * be used to access directly the members of the
+ * first retro_game_info_ext struct, for example:
+ *
+ * struct retro_game_info_ext *game_info_ext;
+ * if (environ_cb(RETRO_ENVIRONMENT_GET_GAME_INFO_EXT, &game_info_ext))
+ * printf("Content Directory: %s\n", game_info_ext->dir);
+ *
+ * - If the function is called inside retro_load_game_special(),
+ * the retro_game_info_ext array is guaranteed to have a
+ * size equal to the num_info argument passed to
+ * retro_load_game_special()
+ */
+
+#define RETRO_ENVIRONMENT_SET_CORE_OPTIONS_V2 67
+ /* const struct retro_core_options_v2 * --
+ * Allows an implementation to signal the environment
+ * which variables it might want to check for later using
+ * GET_VARIABLE.
+ * This allows the frontend to present these variables to
+ * a user dynamically.
+ * This should only be called if RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION
+ * returns an API version of >= 2.
+ * This should be called instead of RETRO_ENVIRONMENT_SET_VARIABLES.
+ * This should be called instead of RETRO_ENVIRONMENT_SET_CORE_OPTIONS.
+ * This should be called the first time as early as
+ * possible (ideally in retro_set_environment).
+ * Afterwards it may be called again for the core to communicate
+ * updated options to the frontend, but the number of core
+ * options must not change from the number in the initial call.
+ * If RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION returns an API
+ * version of >= 2, this callback is guaranteed to succeed
+ * (i.e. callback return value does not indicate success)
+ * If callback returns true, frontend has core option category
+ * support.
+ * If callback returns false, frontend does not have core option
+ * category support.
+ *
+ * 'data' points to a retro_core_options_v2 struct, containing
+ * of two pointers:
+ * - retro_core_options_v2::categories is an array of
+ * retro_core_option_v2_category structs terminated by a
+ * { NULL, NULL, NULL } element. If retro_core_options_v2::categories
+ * is NULL, all core options will have no category and will be shown
+ * at the top level of the frontend core option interface. If frontend
+ * does not have core option category support, categories array will
+ * be ignored.
+ * - retro_core_options_v2::definitions is an array of
+ * retro_core_option_v2_definition structs terminated by a
+ * { NULL, NULL, NULL, NULL, NULL, NULL, {{0}}, NULL }
+ * element.
+ *
+ * >> retro_core_option_v2_category notes:
+ *
+ * - retro_core_option_v2_category::key should contain string
+ * that uniquely identifies the core option category. Valid
+ * key characters are [a-z, A-Z, 0-9, _, -]
+ * Namespace collisions with other implementations' category
+ * keys are permitted.
+ * - retro_core_option_v2_category::desc should contain a human
+ * readable description of the category key.
+ * - retro_core_option_v2_category::info should contain any
+ * additional human readable information text that a typical
+ * user may need to understand the nature of the core option
+ * category.
+ *
+ * Example entry:
+ * {
+ * "advanced_settings",
+ * "Advanced",
+ * "Options affecting low-level emulation performance and accuracy."
+ * }
+ *
+ * >> retro_core_option_v2_definition notes:
+ *
+ * - retro_core_option_v2_definition::key should be namespaced to not
+ * collide with other implementations' keys. e.g. A core called
+ * 'foo' should use keys named as 'foo_option'. Valid key characters
+ * are [a-z, A-Z, 0-9, _, -].
+ * - retro_core_option_v2_definition::desc should contain a human readable
+ * description of the key. Will be used when the frontend does not
+ * have core option category support. Examples: "Aspect Ratio" or
+ * "Video > Aspect Ratio".
+ * - retro_core_option_v2_definition::desc_categorized should contain a
+ * human readable description of the key, which will be used when
+ * frontend has core option category support. Example: "Aspect Ratio",
+ * where associated retro_core_option_v2_category::desc is "Video".
+ * If empty or NULL, the string specified by
+ * retro_core_option_v2_definition::desc will be used instead.
+ * retro_core_option_v2_definition::desc_categorized will be ignored
+ * if retro_core_option_v2_definition::category_key is empty or NULL.
+ * - retro_core_option_v2_definition::info should contain any additional
+ * human readable information text that a typical user may need to
+ * understand the functionality of the option.
+ * - retro_core_option_v2_definition::info_categorized should contain
+ * any additional human readable information text that a typical user
+ * may need to understand the functionality of the option, and will be
+ * used when frontend has core option category support. This is provided
+ * to accommodate the case where info text references an option by
+ * name/desc, and the desc/desc_categorized text for that option differ.
+ * If empty or NULL, the string specified by
+ * retro_core_option_v2_definition::info will be used instead.
+ * retro_core_option_v2_definition::info_categorized will be ignored
+ * if retro_core_option_v2_definition::category_key is empty or NULL.
+ * - retro_core_option_v2_definition::category_key should contain a
+ * category identifier (e.g. "video" or "audio") that will be
+ * assigned to the core option if frontend has core option category
+ * support. A categorized option will be shown in a subsection/
+ * submenu of the frontend core option interface. If key is empty
+ * or NULL, or if key does not match one of the
+ * retro_core_option_v2_category::key values in the associated
+ * retro_core_option_v2_category array, option will have no category
+ * and will be shown at the top level of the frontend core option
+ * interface.
+ * - retro_core_option_v2_definition::values is an array of
+ * retro_core_option_value structs terminated by a { NULL, NULL }
+ * element.
+ * --> retro_core_option_v2_definition::values[index].value is an
+ * expected option value.
+ * --> retro_core_option_v2_definition::values[index].label is a
+ * human readable label used when displaying the value on screen.
+ * If NULL, the value itself is used.
+ * - retro_core_option_v2_definition::default_value is the default
+ * core option setting. It must match one of the expected option
+ * values in the retro_core_option_v2_definition::values array. If
+ * it does not, or the default value is NULL, the first entry in the
+ * retro_core_option_v2_definition::values array is treated as the
+ * default.
+ *
+ * The number of possible option values should be very limited,
+ * and must be less than RETRO_NUM_CORE_OPTION_VALUES_MAX.
+ * i.e. it should be feasible to cycle through options
+ * without a keyboard.
+ *
+ * Example entries:
+ *
+ * - Uncategorized:
+ *
+ * {
+ * "foo_option",
+ * "Speed hack coprocessor X",
+ * NULL,
+ * "Provides increased performance at the expense of reduced accuracy.",
+ * NULL,
+ * NULL,
+ * {
+ * { "false", NULL },
+ * { "true", NULL },
+ * { "unstable", "Turbo (Unstable)" },
+ * { NULL, NULL },
+ * },
+ * "false"
+ * }
+ *
+ * - Categorized:
+ *
+ * {
+ * "foo_option",
+ * "Advanced > Speed hack coprocessor X",
+ * "Speed hack coprocessor X",
+ * "Setting 'Advanced > Speed hack coprocessor X' to 'true' or 'Turbo' provides increased performance at the expense of reduced accuracy",
+ * "Setting 'Speed hack coprocessor X' to 'true' or 'Turbo' provides increased performance at the expense of reduced accuracy",
+ * "advanced_settings",
+ * {
+ * { "false", NULL },
+ * { "true", NULL },
+ * { "unstable", "Turbo (Unstable)" },
+ * { NULL, NULL },
+ * },
+ * "false"
+ * }
+ *
+ * Only strings are operated on. The possible values will
+ * generally be displayed and stored as-is by the frontend.
+ */
+
+#define RETRO_ENVIRONMENT_SET_CORE_OPTIONS_V2_INTL 68
+ /* const struct retro_core_options_v2_intl * --
+ * Allows an implementation to signal the environment
+ * which variables it might want to check for later using
+ * GET_VARIABLE.
+ * This allows the frontend to present these variables to
+ * a user dynamically.
+ * This should only be called if RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION
+ * returns an API version of >= 2.
+ * This should be called instead of RETRO_ENVIRONMENT_SET_VARIABLES.
+ * This should be called instead of RETRO_ENVIRONMENT_SET_CORE_OPTIONS.
+ * This should be called instead of RETRO_ENVIRONMENT_SET_CORE_OPTIONS_INTL.
+ * This should be called instead of RETRO_ENVIRONMENT_SET_CORE_OPTIONS_V2.
+ * This should be called the first time as early as
+ * possible (ideally in retro_set_environment).
+ * Afterwards it may be called again for the core to communicate
+ * updated options to the frontend, but the number of core
+ * options must not change from the number in the initial call.
+ * If RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION returns an API
+ * version of >= 2, this callback is guaranteed to succeed
+ * (i.e. callback return value does not indicate success)
+ * If callback returns true, frontend has core option category
+ * support.
+ * If callback returns false, frontend does not have core option
+ * category support.
+ *
+ * This is fundamentally the same as RETRO_ENVIRONMENT_SET_CORE_OPTIONS_V2,
+ * with the addition of localisation support. The description of the
+ * RETRO_ENVIRONMENT_SET_CORE_OPTIONS_V2 callback should be consulted
+ * for further details.
+ *
+ * 'data' points to a retro_core_options_v2_intl struct.
+ *
+ * - retro_core_options_v2_intl::us is a pointer to a
+ * retro_core_options_v2 struct defining the US English
+ * core options implementation. It must point to a valid struct.
+ *
+ * - retro_core_options_v2_intl::local is a pointer to a
+ * retro_core_options_v2 struct defining core options for
+ * the current frontend language. It may be NULL (in which case
+ * retro_core_options_v2_intl::us is used by the frontend). Any items
+ * missing from this struct will be read from
+ * retro_core_options_v2_intl::us instead.
+ *
+ * NOTE: Default core option values are always taken from the
+ * retro_core_options_v2_intl::us struct. Any default values in
+ * the retro_core_options_v2_intl::local struct will be ignored.
+ */
+
+#define RETRO_ENVIRONMENT_SET_CORE_OPTIONS_UPDATE_DISPLAY_CALLBACK 69
+ /* const struct retro_core_options_update_display_callback * --
+ * Allows a frontend to signal that a core must update
+ * the visibility of any dynamically hidden core options,
+ * and enables the frontend to detect visibility changes.
+ * Used by the frontend to update the menu display status
+ * of core options without requiring a call of retro_run().
+ * Must be called in retro_set_environment().
+ */
+
+/* VFS functionality */
+
+/* File paths:
+ * File paths passed as parameters when using this API shall be well formed UNIX-style,
+ * using "/" (unquoted forward slash) as directory separator regardless of the platform's native separator.
+ * Paths shall also include at least one forward slash ("game.bin" is an invalid path, use "./game.bin" instead).
+ * Other than the directory separator, cores shall not make assumptions about path format:
+ * "C:/path/game.bin", "http://example.com/game.bin", "#game/game.bin", "./game.bin" (without quotes) are all valid paths.
+ * Cores may replace the basename or remove path components from the end, and/or add new components;
+ * however, cores shall not append "./", "../" or multiple consecutive forward slashes ("//") to paths they request to front end.
+ * The frontend is encouraged to make such paths work as well as it can, but is allowed to give up if the core alters paths too much.
+ * Frontends are encouraged, but not required, to support native file system paths (modulo replacing the directory separator, if applicable).
+ * Cores are allowed to try using them, but must remain functional if the front rejects such requests.
+ * Cores are encouraged to use the libretro-common filestream functions for file I/O,
+ * as they seamlessly integrate with VFS, deal with directory separator replacement as appropriate
+ * and provide platform-specific fallbacks in cases where front ends do not support VFS. */
+
+/* Opaque file handle
+ * Introduced in VFS API v1 */
+struct retro_vfs_file_handle;
+
+/* Opaque directory handle
+ * Introduced in VFS API v3 */
+struct retro_vfs_dir_handle;
+
+/* File open flags
+ * Introduced in VFS API v1 */
+#define RETRO_VFS_FILE_ACCESS_READ (1 << 0) /* Read only mode */
+#define RETRO_VFS_FILE_ACCESS_WRITE (1 << 1) /* Write only mode, discard contents and overwrites existing file unless RETRO_VFS_FILE_ACCESS_UPDATE is also specified */
+#define RETRO_VFS_FILE_ACCESS_READ_WRITE (RETRO_VFS_FILE_ACCESS_READ | RETRO_VFS_FILE_ACCESS_WRITE) /* Read-write mode, discard contents and overwrites existing file unless RETRO_VFS_FILE_ACCESS_UPDATE is also specified*/
+#define RETRO_VFS_FILE_ACCESS_UPDATE_EXISTING (1 << 2) /* Prevents discarding content of existing files opened for writing */
+
+/* These are only hints. The frontend may choose to ignore them. Other than RAM/CPU/etc use,
+ and how they react to unlikely external interference (for example someone else writing to that file,
+ or the file's server going down), behavior will not change. */
+#define RETRO_VFS_FILE_ACCESS_HINT_NONE (0)
+/* Indicate that the file will be accessed many times. The frontend should aggressively cache everything. */
+#define RETRO_VFS_FILE_ACCESS_HINT_FREQUENT_ACCESS (1 << 0)
+
+/* Seek positions */
+#define RETRO_VFS_SEEK_POSITION_START 0
+#define RETRO_VFS_SEEK_POSITION_CURRENT 1
+#define RETRO_VFS_SEEK_POSITION_END 2
+
+/* stat() result flags
+ * Introduced in VFS API v3 */
+#define RETRO_VFS_STAT_IS_VALID (1 << 0)
+#define RETRO_VFS_STAT_IS_DIRECTORY (1 << 1)
+#define RETRO_VFS_STAT_IS_CHARACTER_SPECIAL (1 << 2)
+
+/* Get path from opaque handle. Returns the exact same path passed to file_open when getting the handle
+ * Introduced in VFS API v1 */
+typedef const char *(RETRO_CALLCONV *retro_vfs_get_path_t)(struct retro_vfs_file_handle *stream);
+
+/* Open a file for reading or writing. If path points to a directory, this will
+ * fail. Returns the opaque file handle, or NULL for error.
+ * Introduced in VFS API v1 */
+typedef struct retro_vfs_file_handle *(RETRO_CALLCONV *retro_vfs_open_t)(const char *path, unsigned mode, unsigned hints);
+
+/* Close the file and release its resources. Must be called if open_file returns non-NULL. Returns 0 on success, -1 on failure.
+ * Whether the call succeeds ot not, the handle passed as parameter becomes invalid and should no longer be used.
+ * Introduced in VFS API v1 */
+typedef int (RETRO_CALLCONV *retro_vfs_close_t)(struct retro_vfs_file_handle *stream);
+
+/* Return the size of the file in bytes, or -1 for error.
+ * Introduced in VFS API v1 */
+typedef int64_t (RETRO_CALLCONV *retro_vfs_size_t)(struct retro_vfs_file_handle *stream);
+
+/* Truncate file to specified size. Returns 0 on success or -1 on error
+ * Introduced in VFS API v2 */
+typedef int64_t (RETRO_CALLCONV *retro_vfs_truncate_t)(struct retro_vfs_file_handle *stream, int64_t length);
+
+/* Get the current read / write position for the file. Returns -1 for error.
+ * Introduced in VFS API v1 */
+typedef int64_t (RETRO_CALLCONV *retro_vfs_tell_t)(struct retro_vfs_file_handle *stream);
+
+/* Set the current read/write position for the file. Returns the new position, -1 for error.
+ * Introduced in VFS API v1 */
+typedef int64_t (RETRO_CALLCONV *retro_vfs_seek_t)(struct retro_vfs_file_handle *stream, int64_t offset, int seek_position);
+
+/* Read data from a file. Returns the number of bytes read, or -1 for error.
+ * Introduced in VFS API v1 */
+typedef int64_t (RETRO_CALLCONV *retro_vfs_read_t)(struct retro_vfs_file_handle *stream, void *s, uint64_t len);
+
+/* Write data to a file. Returns the number of bytes written, or -1 for error.
+ * Introduced in VFS API v1 */
+typedef int64_t (RETRO_CALLCONV *retro_vfs_write_t)(struct retro_vfs_file_handle *stream, const void *s, uint64_t len);
+
+/* Flush pending writes to file, if using buffered IO. Returns 0 on sucess, or -1 on failure.
+ * Introduced in VFS API v1 */
+typedef int (RETRO_CALLCONV *retro_vfs_flush_t)(struct retro_vfs_file_handle *stream);
+
+/* Delete the specified file. Returns 0 on success, -1 on failure
+ * Introduced in VFS API v1 */
+typedef int (RETRO_CALLCONV *retro_vfs_remove_t)(const char *path);
+
+/* Rename the specified file. Returns 0 on success, -1 on failure
+ * Introduced in VFS API v1 */
+typedef int (RETRO_CALLCONV *retro_vfs_rename_t)(const char *old_path, const char *new_path);
+
+/* Stat the specified file. Retruns a bitmask of RETRO_VFS_STAT_* flags, none are set if path was not valid.
+ * Additionally stores file size in given variable, unless NULL is given.
+ * Introduced in VFS API v3 */
+typedef int (RETRO_CALLCONV *retro_vfs_stat_t)(const char *path, int32_t *size);
+
+/* Create the specified directory. Returns 0 on success, -1 on unknown failure, -2 if already exists.
+ * Introduced in VFS API v3 */
+typedef int (RETRO_CALLCONV *retro_vfs_mkdir_t)(const char *dir);
+
+/* Open the specified directory for listing. Returns the opaque dir handle, or NULL for error.
+ * Support for the include_hidden argument may vary depending on the platform.
+ * Introduced in VFS API v3 */
+typedef struct retro_vfs_dir_handle *(RETRO_CALLCONV *retro_vfs_opendir_t)(const char *dir, bool include_hidden);
+
+/* Read the directory entry at the current position, and move the read pointer to the next position.
+ * Returns true on success, false if already on the last entry.
+ * Introduced in VFS API v3 */
+typedef bool (RETRO_CALLCONV *retro_vfs_readdir_t)(struct retro_vfs_dir_handle *dirstream);
+
+/* Get the name of the last entry read. Returns a string on success, or NULL for error.
+ * The returned string pointer is valid until the next call to readdir or closedir.
+ * Introduced in VFS API v3 */
+typedef const char *(RETRO_CALLCONV *retro_vfs_dirent_get_name_t)(struct retro_vfs_dir_handle *dirstream);
+
+/* Check if the last entry read was a directory. Returns true if it was, false otherwise (or on error).
+ * Introduced in VFS API v3 */
+typedef bool (RETRO_CALLCONV *retro_vfs_dirent_is_dir_t)(struct retro_vfs_dir_handle *dirstream);
+
+/* Close the directory and release its resources. Must be called if opendir returns non-NULL. Returns 0 on success, -1 on failure.
+ * Whether the call succeeds ot not, the handle passed as parameter becomes invalid and should no longer be used.
+ * Introduced in VFS API v3 */
+typedef int (RETRO_CALLCONV *retro_vfs_closedir_t)(struct retro_vfs_dir_handle *dirstream);
+
+struct retro_vfs_interface
+{
+ /* VFS API v1 */
+ retro_vfs_get_path_t get_path;
+ retro_vfs_open_t open;
+ retro_vfs_close_t close;
+ retro_vfs_size_t size;
+ retro_vfs_tell_t tell;
+ retro_vfs_seek_t seek;
+ retro_vfs_read_t read;
+ retro_vfs_write_t write;
+ retro_vfs_flush_t flush;
+ retro_vfs_remove_t remove;
+ retro_vfs_rename_t rename;
+ /* VFS API v2 */
+ retro_vfs_truncate_t truncate;
+ /* VFS API v3 */
+ retro_vfs_stat_t stat;
+ retro_vfs_mkdir_t mkdir;
+ retro_vfs_opendir_t opendir;
+ retro_vfs_readdir_t readdir;
+ retro_vfs_dirent_get_name_t dirent_get_name;
+ retro_vfs_dirent_is_dir_t dirent_is_dir;
+ retro_vfs_closedir_t closedir;
+};
+
+struct retro_vfs_interface_info
+{
+ /* Set by core: should this be higher than the version the front end supports,
+ * front end will return false in the RETRO_ENVIRONMENT_GET_VFS_INTERFACE call
+ * Introduced in VFS API v1 */
+ uint32_t required_interface_version;
+
+ /* Frontend writes interface pointer here. The frontend also sets the actual
+ * version, must be at least required_interface_version.
+ * Introduced in VFS API v1 */
+ struct retro_vfs_interface *iface;
+};
+
+enum retro_hw_render_interface_type
+{
+ RETRO_HW_RENDER_INTERFACE_VULKAN = 0,
+ RETRO_HW_RENDER_INTERFACE_D3D9 = 1,
+ RETRO_HW_RENDER_INTERFACE_D3D10 = 2,
+ RETRO_HW_RENDER_INTERFACE_D3D11 = 3,
+ RETRO_HW_RENDER_INTERFACE_D3D12 = 4,
+ RETRO_HW_RENDER_INTERFACE_GSKIT_PS2 = 5,
+ RETRO_HW_RENDER_INTERFACE_DUMMY = INT_MAX
+};
+
+/* Base struct. All retro_hw_render_interface_* types
+ * contain at least these fields. */
+struct retro_hw_render_interface
+{
+ enum retro_hw_render_interface_type interface_type;
+ unsigned interface_version;
+};
+
+typedef void (RETRO_CALLCONV *retro_set_led_state_t)(int led, int state);
+struct retro_led_interface
+{
+ retro_set_led_state_t set_led_state;
+};
+
+/* Retrieves the current state of the MIDI input.
+ * Returns true if it's enabled, false otherwise. */
+typedef bool (RETRO_CALLCONV *retro_midi_input_enabled_t)(void);
+
+/* Retrieves the current state of the MIDI output.
+ * Returns true if it's enabled, false otherwise */
+typedef bool (RETRO_CALLCONV *retro_midi_output_enabled_t)(void);
+
+/* Reads next byte from the input stream.
+ * Returns true if byte is read, false otherwise. */
+typedef bool (RETRO_CALLCONV *retro_midi_read_t)(uint8_t *byte);
+
+/* Writes byte to the output stream.
+ * 'delta_time' is in microseconds and represent time elapsed since previous write.
+ * Returns true if byte is written, false otherwise. */
+typedef bool (RETRO_CALLCONV *retro_midi_write_t)(uint8_t byte, uint32_t delta_time);
+
+/* Flushes previously written data.
+ * Returns true if successful, false otherwise. */
+typedef bool (RETRO_CALLCONV *retro_midi_flush_t)(void);
+
+struct retro_midi_interface
+{
+ retro_midi_input_enabled_t input_enabled;
+ retro_midi_output_enabled_t output_enabled;
+ retro_midi_read_t read;
+ retro_midi_write_t write;
+ retro_midi_flush_t flush;
+};
+
+enum retro_hw_render_context_negotiation_interface_type
+{
+ RETRO_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE_VULKAN = 0,
+ RETRO_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE_DUMMY = INT_MAX
+};
+
+/* Base struct. All retro_hw_render_context_negotiation_interface_* types
+ * contain at least these fields. */
+struct retro_hw_render_context_negotiation_interface
+{
+ enum retro_hw_render_context_negotiation_interface_type interface_type;
+ unsigned interface_version;
+};
+
+/* Serialized state is incomplete in some way. Set if serialization is
+ * usable in typical end-user cases but should not be relied upon to
+ * implement frame-sensitive frontend features such as netplay or
+ * rerecording. */
+#define RETRO_SERIALIZATION_QUIRK_INCOMPLETE (1 << 0)
+/* The core must spend some time initializing before serialization is
+ * supported. retro_serialize() will initially fail; retro_unserialize()
+ * and retro_serialize_size() may or may not work correctly either. */
+#define RETRO_SERIALIZATION_QUIRK_MUST_INITIALIZE (1 << 1)
+/* Serialization size may change within a session. */
+#define RETRO_SERIALIZATION_QUIRK_CORE_VARIABLE_SIZE (1 << 2)
+/* Set by the frontend to acknowledge that it supports variable-sized
+ * states. */
+#define RETRO_SERIALIZATION_QUIRK_FRONT_VARIABLE_SIZE (1 << 3)
+/* Serialized state can only be loaded during the same session. */
+#define RETRO_SERIALIZATION_QUIRK_SINGLE_SESSION (1 << 4)
+/* Serialized state cannot be loaded on an architecture with a different
+ * endianness from the one it was saved on. */
+#define RETRO_SERIALIZATION_QUIRK_ENDIAN_DEPENDENT (1 << 5)
+/* Serialized state cannot be loaded on a different platform from the one it
+ * was saved on for reasons other than endianness, such as word size
+ * dependence */
+#define RETRO_SERIALIZATION_QUIRK_PLATFORM_DEPENDENT (1 << 6)
+
+#define RETRO_MEMDESC_CONST (1 << 0) /* The frontend will never change this memory area once retro_load_game has returned. */
+#define RETRO_MEMDESC_BIGENDIAN (1 << 1) /* The memory area contains big endian data. Default is little endian. */
+#define RETRO_MEMDESC_SYSTEM_RAM (1 << 2) /* The memory area is system RAM. This is main RAM of the gaming system. */
+#define RETRO_MEMDESC_SAVE_RAM (1 << 3) /* The memory area is save RAM. This RAM is usually found on a game cartridge, backed up by a battery. */
+#define RETRO_MEMDESC_VIDEO_RAM (1 << 4) /* The memory area is video RAM (VRAM) */
+#define RETRO_MEMDESC_ALIGN_2 (1 << 16) /* All memory access in this area is aligned to their own size, or 2, whichever is smaller. */
+#define RETRO_MEMDESC_ALIGN_4 (2 << 16)
+#define RETRO_MEMDESC_ALIGN_8 (3 << 16)
+#define RETRO_MEMDESC_MINSIZE_2 (1 << 24) /* All memory in this region is accessed at least 2 bytes at the time. */
+#define RETRO_MEMDESC_MINSIZE_4 (2 << 24)
+#define RETRO_MEMDESC_MINSIZE_8 (3 << 24)
+struct retro_memory_descriptor
+{
+ uint64_t flags;
+
+ /* Pointer to the start of the relevant ROM or RAM chip.
+ * It's strongly recommended to use 'offset' if possible, rather than
+ * doing math on the pointer.
+ *
+ * If the same byte is mapped my multiple descriptors, their descriptors
+ * must have the same pointer.
+ * If 'start' does not point to the first byte in the pointer, put the
+ * difference in 'offset' instead.
+ *
+ * May be NULL if there's nothing usable here (e.g. hardware registers and
+ * open bus). No flags should be set if the pointer is NULL.
+ * It's recommended to minimize the number of descriptors if possible,
+ * but not mandatory. */
+ void *ptr;
+ size_t offset;
+
+ /* This is the location in the emulated address space
+ * where the mapping starts. */
+ size_t start;
+
+ /* Which bits must be same as in 'start' for this mapping to apply.
+ * The first memory descriptor to claim a certain byte is the one
+ * that applies.
+ * A bit which is set in 'start' must also be set in this.
+ * Can be zero, in which case each byte is assumed mapped exactly once.
+ * In this case, 'len' must be a power of two. */
+ size_t select;
+
+ /* If this is nonzero, the set bits are assumed not connected to the
+ * memory chip's address pins. */
+ size_t disconnect;
+
+ /* This one tells the size of the current memory area.
+ * If, after start+disconnect are applied, the address is higher than
+ * this, the highest bit of the address is cleared.
+ *
+ * If the address is still too high, the next highest bit is cleared.
+ * Can be zero, in which case it's assumed to be infinite (as limited
+ * by 'select' and 'disconnect'). */
+ size_t len;
+
+ /* To go from emulated address to physical address, the following
+ * order applies:
+ * Subtract 'start', pick off 'disconnect', apply 'len', add 'offset'. */
+
+ /* The address space name must consist of only a-zA-Z0-9_-,
+ * should be as short as feasible (maximum length is 8 plus the NUL),
+ * and may not be any other address space plus one or more 0-9A-F
+ * at the end.
+ * However, multiple memory descriptors for the same address space is
+ * allowed, and the address space name can be empty. NULL is treated
+ * as empty.
+ *
+ * Address space names are case sensitive, but avoid lowercase if possible.
+ * The same pointer may exist in multiple address spaces.
+ *
+ * Examples:
+ * blank+blank - valid (multiple things may be mapped in the same namespace)
+ * 'Sp'+'Sp' - valid (multiple things may be mapped in the same namespace)
+ * 'A'+'B' - valid (neither is a prefix of each other)
+ * 'S'+blank - valid ('S' is not in 0-9A-F)
+ * 'a'+blank - valid ('a' is not in 0-9A-F)
+ * 'a'+'A' - valid (neither is a prefix of each other)
+ * 'AR'+blank - valid ('R' is not in 0-9A-F)
+ * 'ARB'+blank - valid (the B can't be part of the address either, because
+ * there is no namespace 'AR')
+ * blank+'B' - not valid, because it's ambigous which address space B1234
+ * would refer to.
+ * The length can't be used for that purpose; the frontend may want
+ * to append arbitrary data to an address, without a separator. */
+ const char *addrspace;
+
+ /* TODO: When finalizing this one, add a description field, which should be
+ * "WRAM" or something roughly equally long. */
+
+ /* TODO: When finalizing this one, replace 'select' with 'limit', which tells
+ * which bits can vary and still refer to the same address (limit = ~select).
+ * TODO: limit? range? vary? something else? */
+
+ /* TODO: When finalizing this one, if 'len' is above what 'select' (or
+ * 'limit') allows, it's bankswitched. Bankswitched data must have both 'len'
+ * and 'select' != 0, and the mappings don't tell how the system switches the
+ * banks. */
+
+ /* TODO: When finalizing this one, fix the 'len' bit removal order.
+ * For len=0x1800, pointer 0x1C00 should go to 0x1400, not 0x0C00.
+ * Algorithm: Take bits highest to lowest, but if it goes above len, clear
+ * the most recent addition and continue on the next bit.
+ * TODO: Can the above be optimized? Is "remove the lowest bit set in both
+ * pointer and 'len'" equivalent? */
+
+ /* TODO: Some emulators (MAME?) emulate big endian systems by only accessing
+ * the emulated memory in 32-bit chunks, native endian. But that's nothing
+ * compared to Darek Mihocka <http://www.emulators.com/docs/nx07_vm101.htm>
+ * (section Emulation 103 - Nearly Free Byte Reversal) - he flips the ENTIRE
+ * RAM backwards! I'll want to represent both of those, via some flags.
+ *
+ * I suspect MAME either didn't think of that idea, or don't want the #ifdef.
+ * Not sure which, nor do I really care. */
+
+ /* TODO: Some of those flags are unused and/or don't really make sense. Clean
+ * them up. */
+};
+
+/* The frontend may use the largest value of 'start'+'select' in a
+ * certain namespace to infer the size of the address space.
+ *
+ * If the address space is larger than that, a mapping with .ptr=NULL
+ * should be at the end of the array, with .select set to all ones for
+ * as long as the address space is big.
+ *
+ * Sample descriptors (minus .ptr, and RETRO_MEMFLAG_ on the flags):
+ * SNES WRAM:
+ * .start=0x7E0000, .len=0x20000
+ * (Note that this must be mapped before the ROM in most cases; some of the
+ * ROM mappers
+ * try to claim $7E0000, or at least $7E8000.)
+ * SNES SPC700 RAM:
+ * .addrspace="S", .len=0x10000
+ * SNES WRAM mirrors:
+ * .flags=MIRROR, .start=0x000000, .select=0xC0E000, .len=0x2000
+ * .flags=MIRROR, .start=0x800000, .select=0xC0E000, .len=0x2000
+ * SNES WRAM mirrors, alternate equivalent descriptor:
+ * .flags=MIRROR, .select=0x40E000, .disconnect=~0x1FFF
+ * (Various similar constructions can be created by combining parts of
+ * the above two.)
+ * SNES LoROM (512KB, mirrored a couple of times):
+ * .flags=CONST, .start=0x008000, .select=0x408000, .disconnect=0x8000, .len=512*1024
+ * .flags=CONST, .start=0x400000, .select=0x400000, .disconnect=0x8000, .len=512*1024
+ * SNES HiROM (4MB):
+ * .flags=CONST, .start=0x400000, .select=0x400000, .len=4*1024*1024
+ * .flags=CONST, .offset=0x8000, .start=0x008000, .select=0x408000, .len=4*1024*1024
+ * SNES ExHiROM (8MB):
+ * .flags=CONST, .offset=0, .start=0xC00000, .select=0xC00000, .len=4*1024*1024
+ * .flags=CONST, .offset=4*1024*1024, .start=0x400000, .select=0xC00000, .len=4*1024*1024
+ * .flags=CONST, .offset=0x8000, .start=0x808000, .select=0xC08000, .len=4*1024*1024
+ * .flags=CONST, .offset=4*1024*1024+0x8000, .start=0x008000, .select=0xC08000, .len=4*1024*1024
+ * Clarify the size of the address space:
+ * .ptr=NULL, .select=0xFFFFFF
+ * .len can be implied by .select in many of them, but was included for clarity.
+ */
+
+struct retro_memory_map
+{
+ const struct retro_memory_descriptor *descriptors;
+ unsigned num_descriptors;
+};
+
+struct retro_controller_description
+{
+ /* Human-readable description of the controller. Even if using a generic
+ * input device type, this can be set to the particular device type the
+ * core uses. */
+ const char *desc;
+
+ /* Device type passed to retro_set_controller_port_device(). If the device
+ * type is a sub-class of a generic input device type, use the
+ * RETRO_DEVICE_SUBCLASS macro to create an ID.
+ *
+ * E.g. RETRO_DEVICE_SUBCLASS(RETRO_DEVICE_JOYPAD, 1). */
+ unsigned id;
+};
+
+struct retro_controller_info
+{
+ const struct retro_controller_description *types;
+ unsigned num_types;
+};
+
+struct retro_subsystem_memory_info
+{
+ /* The extension associated with a memory type, e.g. "psram". */
+ const char *extension;
+
+ /* The memory type for retro_get_memory(). This should be at
+ * least 0x100 to avoid conflict with standardized
+ * libretro memory types. */
+ unsigned type;
+};
+
+struct retro_subsystem_rom_info
+{
+ /* Describes what the content is (SGB BIOS, GB ROM, etc). */
+ const char *desc;
+
+ /* Same definition as retro_get_system_info(). */
+ const char *valid_extensions;
+
+ /* Same definition as retro_get_system_info(). */
+ bool need_fullpath;
+
+ /* Same definition as retro_get_system_info(). */
+ bool block_extract;
+
+ /* This is set if the content is required to load a game.
+ * If this is set to false, a zeroed-out retro_game_info can be passed. */
+ bool required;
+
+ /* Content can have multiple associated persistent
+ * memory types (retro_get_memory()). */
+ const struct retro_subsystem_memory_info *memory;
+ unsigned num_memory;
+};
+
+struct retro_subsystem_info
+{
+ /* Human-readable string of the subsystem type, e.g. "Super GameBoy" */
+ const char *desc;
+
+ /* A computer friendly short string identifier for the subsystem type.
+ * This name must be [a-z].
+ * E.g. if desc is "Super GameBoy", this can be "sgb".
+ * This identifier can be used for command-line interfaces, etc.
+ */
+ const char *ident;
+
+ /* Infos for each content file. The first entry is assumed to be the
+ * "most significant" content for frontend purposes.
+ * E.g. with Super GameBoy, the first content should be the GameBoy ROM,
+ * as it is the most "significant" content to a user.
+ * If a frontend creates new file paths based on the content used
+ * (e.g. savestates), it should use the path for the first ROM to do so. */
+ const struct retro_subsystem_rom_info *roms;
+
+ /* Number of content files associated with a subsystem. */
+ unsigned num_roms;
+
+ /* The type passed to retro_load_game_special(). */
+ unsigned id;
+};
+
+typedef void (RETRO_CALLCONV *retro_proc_address_t)(void);
+
+/* libretro API extension functions:
+ * (None here so far).
+ *
+ * Get a symbol from a libretro core.
+ * Cores should only return symbols which are actual
+ * extensions to the libretro API.
+ *
+ * Frontends should not use this to obtain symbols to standard
+ * libretro entry points (static linking or dlsym).
+ *
+ * The symbol name must be equal to the function name,
+ * e.g. if void retro_foo(void); exists, the symbol must be called "retro_foo".
+ * The returned function pointer must be cast to the corresponding type.
+ */
+typedef retro_proc_address_t (RETRO_CALLCONV *retro_get_proc_address_t)(const char *sym);
+
+struct retro_get_proc_address_interface
+{
+ retro_get_proc_address_t get_proc_address;
+};
+
+enum retro_log_level
+{
+ RETRO_LOG_DEBUG = 0,
+ RETRO_LOG_INFO,
+ RETRO_LOG_WARN,
+ RETRO_LOG_ERROR,
+
+ RETRO_LOG_DUMMY = INT_MAX
+};
+
+/* Logging function. Takes log level argument as well. */
+typedef void (RETRO_CALLCONV *retro_log_printf_t)(enum retro_log_level level,
+ const char *fmt, ...);
+
+struct retro_log_callback
+{
+ retro_log_printf_t log;
+};
+
+/* Performance related functions */
+
+/* ID values for SIMD CPU features */
+#define RETRO_SIMD_SSE (1 << 0)
+#define RETRO_SIMD_SSE2 (1 << 1)
+#define RETRO_SIMD_VMX (1 << 2)
+#define RETRO_SIMD_VMX128 (1 << 3)
+#define RETRO_SIMD_AVX (1 << 4)
+#define RETRO_SIMD_NEON (1 << 5)
+#define RETRO_SIMD_SSE3 (1 << 6)
+#define RETRO_SIMD_SSSE3 (1 << 7)
+#define RETRO_SIMD_MMX (1 << 8)
+#define RETRO_SIMD_MMXEXT (1 << 9)
+#define RETRO_SIMD_SSE4 (1 << 10)
+#define RETRO_SIMD_SSE42 (1 << 11)
+#define RETRO_SIMD_AVX2 (1 << 12)
+#define RETRO_SIMD_VFPU (1 << 13)
+#define RETRO_SIMD_PS (1 << 14)
+#define RETRO_SIMD_AES (1 << 15)
+#define RETRO_SIMD_VFPV3 (1 << 16)
+#define RETRO_SIMD_VFPV4 (1 << 17)
+#define RETRO_SIMD_POPCNT (1 << 18)
+#define RETRO_SIMD_MOVBE (1 << 19)
+#define RETRO_SIMD_CMOV (1 << 20)
+#define RETRO_SIMD_ASIMD (1 << 21)
+
+typedef uint64_t retro_perf_tick_t;
+typedef int64_t retro_time_t;
+
+struct retro_perf_counter
+{
+ const char *ident;
+ retro_perf_tick_t start;
+ retro_perf_tick_t total;
+ retro_perf_tick_t call_cnt;
+
+ bool registered;
+};
+
+/* Returns current time in microseconds.
+ * Tries to use the most accurate timer available.
+ */
+typedef retro_time_t (RETRO_CALLCONV *retro_perf_get_time_usec_t)(void);
+
+/* A simple counter. Usually nanoseconds, but can also be CPU cycles.
+ * Can be used directly if desired (when creating a more sophisticated
+ * performance counter system).
+ * */
+typedef retro_perf_tick_t (RETRO_CALLCONV *retro_perf_get_counter_t)(void);
+
+/* Returns a bit-mask of detected CPU features (RETRO_SIMD_*). */
+typedef uint64_t (RETRO_CALLCONV *retro_get_cpu_features_t)(void);
+
+/* Asks frontend to log and/or display the state of performance counters.
+ * Performance counters can always be poked into manually as well.
+ */
+typedef void (RETRO_CALLCONV *retro_perf_log_t)(void);
+
+/* Register a performance counter.
+ * ident field must be set with a discrete value and other values in
+ * retro_perf_counter must be 0.
+ * Registering can be called multiple times. To avoid calling to
+ * frontend redundantly, you can check registered field first. */
+typedef void (RETRO_CALLCONV *retro_perf_register_t)(struct retro_perf_counter *counter);
+
+/* Starts a registered counter. */
+typedef void (RETRO_CALLCONV *retro_perf_start_t)(struct retro_perf_counter *counter);
+
+/* Stops a registered counter. */
+typedef void (RETRO_CALLCONV *retro_perf_stop_t)(struct retro_perf_counter *counter);
+
+/* For convenience it can be useful to wrap register, start and stop in macros.
+ * E.g.:
+ * #ifdef LOG_PERFORMANCE
+ * #define RETRO_PERFORMANCE_INIT(perf_cb, name) static struct retro_perf_counter name = {#name}; if (!name.registered) perf_cb.perf_register(&(name))
+ * #define RETRO_PERFORMANCE_START(perf_cb, name) perf_cb.perf_start(&(name))
+ * #define RETRO_PERFORMANCE_STOP(perf_cb, name) perf_cb.perf_stop(&(name))
+ * #else
+ * ... Blank macros ...
+ * #endif
+ *
+ * These can then be used mid-functions around code snippets.
+ *
+ * extern struct retro_perf_callback perf_cb; * Somewhere in the core.
+ *
+ * void do_some_heavy_work(void)
+ * {
+ * RETRO_PERFORMANCE_INIT(cb, work_1;
+ * RETRO_PERFORMANCE_START(cb, work_1);
+ * heavy_work_1();
+ * RETRO_PERFORMANCE_STOP(cb, work_1);
+ *
+ * RETRO_PERFORMANCE_INIT(cb, work_2);
+ * RETRO_PERFORMANCE_START(cb, work_2);
+ * heavy_work_2();
+ * RETRO_PERFORMANCE_STOP(cb, work_2);
+ * }
+ *
+ * void retro_deinit(void)
+ * {
+ * perf_cb.perf_log(); * Log all perf counters here for example.
+ * }
+ */
+
+struct retro_perf_callback
+{
+ retro_perf_get_time_usec_t get_time_usec;
+ retro_get_cpu_features_t get_cpu_features;
+
+ retro_perf_get_counter_t get_perf_counter;
+ retro_perf_register_t perf_register;
+ retro_perf_start_t perf_start;
+ retro_perf_stop_t perf_stop;
+ retro_perf_log_t perf_log;
+};
+
+/* FIXME: Document the sensor API and work out behavior.
+ * It will be marked as experimental until then.
+ */
+enum retro_sensor_action
+{
+ RETRO_SENSOR_ACCELEROMETER_ENABLE = 0,
+ RETRO_SENSOR_ACCELEROMETER_DISABLE,
+ RETRO_SENSOR_GYROSCOPE_ENABLE,
+ RETRO_SENSOR_GYROSCOPE_DISABLE,
+ RETRO_SENSOR_ILLUMINANCE_ENABLE,
+ RETRO_SENSOR_ILLUMINANCE_DISABLE,
+
+ RETRO_SENSOR_DUMMY = INT_MAX
+};
+
+/* Id values for SENSOR types. */
+#define RETRO_SENSOR_ACCELEROMETER_X 0
+#define RETRO_SENSOR_ACCELEROMETER_Y 1
+#define RETRO_SENSOR_ACCELEROMETER_Z 2
+#define RETRO_SENSOR_GYROSCOPE_X 3
+#define RETRO_SENSOR_GYROSCOPE_Y 4
+#define RETRO_SENSOR_GYROSCOPE_Z 5
+#define RETRO_SENSOR_ILLUMINANCE 6
+
+typedef bool (RETRO_CALLCONV *retro_set_sensor_state_t)(unsigned port,
+ enum retro_sensor_action action, unsigned rate);
+
+typedef float (RETRO_CALLCONV *retro_sensor_get_input_t)(unsigned port, unsigned id);
+
+struct retro_sensor_interface
+{
+ retro_set_sensor_state_t set_sensor_state;
+ retro_sensor_get_input_t get_sensor_input;
+};
+
+enum retro_camera_buffer
+{
+ RETRO_CAMERA_BUFFER_OPENGL_TEXTURE = 0,
+ RETRO_CAMERA_BUFFER_RAW_FRAMEBUFFER,
+
+ RETRO_CAMERA_BUFFER_DUMMY = INT_MAX
+};
+
+/* Starts the camera driver. Can only be called in retro_run(). */
+typedef bool (RETRO_CALLCONV *retro_camera_start_t)(void);
+
+/* Stops the camera driver. Can only be called in retro_run(). */
+typedef void (RETRO_CALLCONV *retro_camera_stop_t)(void);
+
+/* Callback which signals when the camera driver is initialized
+ * and/or deinitialized.
+ * retro_camera_start_t can be called in initialized callback.
+ */
+typedef void (RETRO_CALLCONV *retro_camera_lifetime_status_t)(void);
+
+/* A callback for raw framebuffer data. buffer points to an XRGB8888 buffer.
+ * Width, height and pitch are similar to retro_video_refresh_t.
+ * First pixel is top-left origin.
+ */
+typedef void (RETRO_CALLCONV *retro_camera_frame_raw_framebuffer_t)(const uint32_t *buffer,
+ unsigned width, unsigned height, size_t pitch);
+
+/* A callback for when OpenGL textures are used.
+ *
+ * texture_id is a texture owned by camera driver.
+ * Its state or content should be considered immutable, except for things like
+ * texture filtering and clamping.
+ *
+ * texture_target is the texture target for the GL texture.
+ * These can include e.g. GL_TEXTURE_2D, GL_TEXTURE_RECTANGLE, and possibly
+ * more depending on extensions.
+ *
+ * affine points to a packed 3x3 column-major matrix used to apply an affine
+ * transform to texture coordinates. (affine_matrix * vec3(coord_x, coord_y, 1.0))
+ * After transform, normalized texture coord (0, 0) should be bottom-left
+ * and (1, 1) should be top-right (or (width, height) for RECTANGLE).
+ *
+ * GL-specific typedefs are avoided here to avoid relying on gl.h in
+ * the API definition.
+ */
+typedef void (RETRO_CALLCONV *retro_camera_frame_opengl_texture_t)(unsigned texture_id,
+ unsigned texture_target, const float *affine);
+
+struct retro_camera_callback
+{
+ /* Set by libretro core.
+ * Example bitmask: caps = (1 << RETRO_CAMERA_BUFFER_OPENGL_TEXTURE) | (1 << RETRO_CAMERA_BUFFER_RAW_FRAMEBUFFER).
+ */
+ uint64_t caps;
+
+ /* Desired resolution for camera. Is only used as a hint. */
+ unsigned width;
+ unsigned height;
+
+ /* Set by frontend. */
+ retro_camera_start_t start;
+ retro_camera_stop_t stop;
+
+ /* Set by libretro core if raw framebuffer callbacks will be used. */
+ retro_camera_frame_raw_framebuffer_t frame_raw_framebuffer;
+
+ /* Set by libretro core if OpenGL texture callbacks will be used. */
+ retro_camera_frame_opengl_texture_t frame_opengl_texture;
+
+ /* Set by libretro core. Called after camera driver is initialized and
+ * ready to be started.
+ * Can be NULL, in which this callback is not called.
+ */
+ retro_camera_lifetime_status_t initialized;
+
+ /* Set by libretro core. Called right before camera driver is
+ * deinitialized.
+ * Can be NULL, in which this callback is not called.
+ */
+ retro_camera_lifetime_status_t deinitialized;
+};
+
+/* Sets the interval of time and/or distance at which to update/poll
+ * location-based data.
+ *
+ * To ensure compatibility with all location-based implementations,
+ * values for both interval_ms and interval_distance should be provided.
+ *
+ * interval_ms is the interval expressed in milliseconds.
+ * interval_distance is the distance interval expressed in meters.
+ */
+typedef void (RETRO_CALLCONV *retro_location_set_interval_t)(unsigned interval_ms,
+ unsigned interval_distance);
+
+/* Start location services. The device will start listening for changes to the
+ * current location at regular intervals (which are defined with
+ * retro_location_set_interval_t). */
+typedef bool (RETRO_CALLCONV *retro_location_start_t)(void);
+
+/* Stop location services. The device will stop listening for changes
+ * to the current location. */
+typedef void (RETRO_CALLCONV *retro_location_stop_t)(void);
+
+/* Get the position of the current location. Will set parameters to
+ * 0 if no new location update has happened since the last time. */
+typedef bool (RETRO_CALLCONV *retro_location_get_position_t)(double *lat, double *lon,
+ double *horiz_accuracy, double *vert_accuracy);
+
+/* Callback which signals when the location driver is initialized
+ * and/or deinitialized.
+ * retro_location_start_t can be called in initialized callback.
+ */
+typedef void (RETRO_CALLCONV *retro_location_lifetime_status_t)(void);
+
+struct retro_location_callback
+{
+ retro_location_start_t start;
+ retro_location_stop_t stop;
+ retro_location_get_position_t get_position;
+ retro_location_set_interval_t set_interval;
+
+ retro_location_lifetime_status_t initialized;
+ retro_location_lifetime_status_t deinitialized;
+};
+
+enum retro_rumble_effect
+{
+ RETRO_RUMBLE_STRONG = 0,
+ RETRO_RUMBLE_WEAK = 1,
+
+ RETRO_RUMBLE_DUMMY = INT_MAX
+};
+
+/* Sets rumble state for joypad plugged in port 'port'.
+ * Rumble effects are controlled independently,
+ * and setting e.g. strong rumble does not override weak rumble.
+ * Strength has a range of [0, 0xffff].
+ *
+ * Returns true if rumble state request was honored.
+ * Calling this before first retro_run() is likely to return false. */
+typedef bool (RETRO_CALLCONV *retro_set_rumble_state_t)(unsigned port,
+ enum retro_rumble_effect effect, uint16_t strength);
+
+struct retro_rumble_interface
+{
+ retro_set_rumble_state_t set_rumble_state;
+};
+
+/* Notifies libretro that audio data should be written. */
+typedef void (RETRO_CALLCONV *retro_audio_callback_t)(void);
+
+/* True: Audio driver in frontend is active, and callback is
+ * expected to be called regularily.
+ * False: Audio driver in frontend is paused or inactive.
+ * Audio callback will not be called until set_state has been
+ * called with true.
+ * Initial state is false (inactive).
+ */
+typedef void (RETRO_CALLCONV *retro_audio_set_state_callback_t)(bool enabled);
+
+struct retro_audio_callback
+{
+ retro_audio_callback_t callback;
+ retro_audio_set_state_callback_t set_state;
+};
+
+/* Notifies a libretro core of time spent since last invocation
+ * of retro_run() in microseconds.
+ *
+ * It will be called right before retro_run() every frame.
+ * The frontend can tamper with timing to support cases like
+ * fast-forward, slow-motion and framestepping.
+ *
+ * In those scenarios the reference frame time value will be used. */
+typedef int64_t retro_usec_t;
+typedef void (RETRO_CALLCONV *retro_frame_time_callback_t)(retro_usec_t usec);
+struct retro_frame_time_callback
+{
+ retro_frame_time_callback_t callback;
+ /* Represents the time of one frame. It is computed as
+ * 1000000 / fps, but the implementation will resolve the
+ * rounding to ensure that framestepping, etc is exact. */
+ retro_usec_t reference;
+};
+
+/* Notifies a libretro core of the current occupancy
+ * level of the frontend audio buffer.
+ *
+ * - active: 'true' if audio buffer is currently
+ * in use. Will be 'false' if audio is
+ * disabled in the frontend
+ *
+ * - occupancy: Given as a value in the range [0,100],
+ * corresponding to the occupancy percentage
+ * of the audio buffer
+ *
+ * - underrun_likely: 'true' if the frontend expects an
+ * audio buffer underrun during the
+ * next frame (indicates that a core
+ * should attempt frame skipping)
+ *
+ * It will be called right before retro_run() every frame. */
+typedef void (RETRO_CALLCONV *retro_audio_buffer_status_callback_t)(
+ bool active, unsigned occupancy, bool underrun_likely);
+struct retro_audio_buffer_status_callback
+{
+ retro_audio_buffer_status_callback_t callback;
+};
+
+/* Pass this to retro_video_refresh_t if rendering to hardware.
+ * Passing NULL to retro_video_refresh_t is still a frame dupe as normal.
+ * */
+#define RETRO_HW_FRAME_BUFFER_VALID ((void*)-1)
+
+/* Invalidates the current HW context.
+ * Any GL state is lost, and must not be deinitialized explicitly.
+ * If explicit deinitialization is desired by the libretro core,
+ * it should implement context_destroy callback.
+ * If called, all GPU resources must be reinitialized.
+ * Usually called when frontend reinits video driver.
+ * Also called first time video driver is initialized,
+ * allowing libretro core to initialize resources.
+ */
+typedef void (RETRO_CALLCONV *retro_hw_context_reset_t)(void);
+
+/* Gets current framebuffer which is to be rendered to.
+ * Could change every frame potentially.
+ */
+typedef uintptr_t (RETRO_CALLCONV *retro_hw_get_current_framebuffer_t)(void);
+
+/* Get a symbol from HW context. */
+typedef retro_proc_address_t (RETRO_CALLCONV *retro_hw_get_proc_address_t)(const char *sym);
+
+enum retro_hw_context_type
+{
+ RETRO_HW_CONTEXT_NONE = 0,
+ /* OpenGL 2.x. Driver can choose to use latest compatibility context. */
+ RETRO_HW_CONTEXT_OPENGL = 1,
+ /* OpenGL ES 2.0. */
+ RETRO_HW_CONTEXT_OPENGLES2 = 2,
+ /* Modern desktop core GL context. Use version_major/
+ * version_minor fields to set GL version. */
+ RETRO_HW_CONTEXT_OPENGL_CORE = 3,
+ /* OpenGL ES 3.0 */
+ RETRO_HW_CONTEXT_OPENGLES3 = 4,
+ /* OpenGL ES 3.1+. Set version_major/version_minor. For GLES2 and GLES3,
+ * use the corresponding enums directly. */
+ RETRO_HW_CONTEXT_OPENGLES_VERSION = 5,
+
+ /* Vulkan, see RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE. */
+ RETRO_HW_CONTEXT_VULKAN = 6,
+
+ /* Direct3D, set version_major to select the type of interface
+ * returned by RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE */
+ RETRO_HW_CONTEXT_DIRECT3D = 7,
+
+ RETRO_HW_CONTEXT_DUMMY = INT_MAX
+};
+
+struct retro_hw_render_callback
+{
+ /* Which API to use. Set by libretro core. */
+ enum retro_hw_context_type context_type;
+
+ /* Called when a context has been created or when it has been reset.
+ * An OpenGL context is only valid after context_reset() has been called.
+ *
+ * When context_reset is called, OpenGL resources in the libretro
+ * implementation are guaranteed to be invalid.
+ *
+ * It is possible that context_reset is called multiple times during an
+ * application lifecycle.
+ * If context_reset is called without any notification (context_destroy),
+ * the OpenGL context was lost and resources should just be recreated
+ * without any attempt to "free" old resources.
+ */
+ retro_hw_context_reset_t context_reset;
+
+ /* Set by frontend.
+ * TODO: This is rather obsolete. The frontend should not
+ * be providing preallocated framebuffers. */
+ retro_hw_get_current_framebuffer_t get_current_framebuffer;
+
+ /* Set by frontend.
+ * Can return all relevant functions, including glClear on Windows. */
+ retro_hw_get_proc_address_t get_proc_address;
+
+ /* Set if render buffers should have depth component attached.
+ * TODO: Obsolete. */
+ bool depth;
+
+ /* Set if stencil buffers should be attached.
+ * TODO: Obsolete. */
+ bool stencil;
+
+ /* If depth and stencil are true, a packed 24/8 buffer will be added.
+ * Only attaching stencil is invalid and will be ignored. */
+
+ /* Use conventional bottom-left origin convention. If false,
+ * standard libretro top-left origin semantics are used.
+ * TODO: Move to GL specific interface. */
+ bool bottom_left_origin;
+
+ /* Major version number for core GL context or GLES 3.1+. */
+ unsigned version_major;
+
+ /* Minor version number for core GL context or GLES 3.1+. */
+ unsigned version_minor;
+
+ /* If this is true, the frontend will go very far to avoid
+ * resetting context in scenarios like toggling fullscreen, etc.
+ * TODO: Obsolete? Maybe frontend should just always assume this ...
+ */
+ bool cache_context;
+
+ /* The reset callback might still be called in extreme situations
+ * such as if the context is lost beyond recovery.
+ *
+ * For optimal stability, set this to false, and allow context to be
+ * reset at any time.
+ */
+
+ /* A callback to be called before the context is destroyed in a
+ * controlled way by the frontend. */
+ retro_hw_context_reset_t context_destroy;
+
+ /* OpenGL resources can be deinitialized cleanly at this step.
+ * context_destroy can be set to NULL, in which resources will
+ * just be destroyed without any notification.
+ *
+ * Even when context_destroy is non-NULL, it is possible that
+ * context_reset is called without any destroy notification.
+ * This happens if context is lost by external factors (such as
+ * notified by GL_ARB_robustness).
+ *
+ * In this case, the context is assumed to be already dead,
+ * and the libretro implementation must not try to free any OpenGL
+ * resources in the subsequent context_reset.
+ */
+
+ /* Creates a debug context. */
+ bool debug_context;
+};
+
+/* Callback type passed in RETRO_ENVIRONMENT_SET_KEYBOARD_CALLBACK.
+ * Called by the frontend in response to keyboard events.
+ * down is set if the key is being pressed, or false if it is being released.
+ * keycode is the RETROK value of the char.
+ * character is the text character of the pressed key. (UTF-32).
+ * key_modifiers is a set of RETROKMOD values or'ed together.
+ *
+ * The pressed/keycode state can be indepedent of the character.
+ * It is also possible that multiple characters are generated from a
+ * single keypress.
+ * Keycode events should be treated separately from character events.
+ * However, when possible, the frontend should try to synchronize these.
+ * If only a character is posted, keycode should be RETROK_UNKNOWN.
+ *
+ * Similarily if only a keycode event is generated with no corresponding
+ * character, character should be 0.
+ */
+typedef void (RETRO_CALLCONV *retro_keyboard_event_t)(bool down, unsigned keycode,
+ uint32_t character, uint16_t key_modifiers);
+
+struct retro_keyboard_callback
+{
+ retro_keyboard_event_t callback;
+};
+
+/* Callbacks for RETRO_ENVIRONMENT_SET_DISK_CONTROL_INTERFACE &
+ * RETRO_ENVIRONMENT_SET_DISK_CONTROL_EXT_INTERFACE.
+ * Should be set for implementations which can swap out multiple disk
+ * images in runtime.
+ *
+ * If the implementation can do this automatically, it should strive to do so.
+ * However, there are cases where the user must manually do so.
+ *
+ * Overview: To swap a disk image, eject the disk image with
+ * set_eject_state(true).
+ * Set the disk index with set_image_index(index). Insert the disk again
+ * with set_eject_state(false).
+ */
+
+/* If ejected is true, "ejects" the virtual disk tray.
+ * When ejected, the disk image index can be set.
+ */
+typedef bool (RETRO_CALLCONV *retro_set_eject_state_t)(bool ejected);
+
+/* Gets current eject state. The initial state is 'not ejected'. */
+typedef bool (RETRO_CALLCONV *retro_get_eject_state_t)(void);
+
+/* Gets current disk index. First disk is index 0.
+ * If return value is >= get_num_images(), no disk is currently inserted.
+ */
+typedef unsigned (RETRO_CALLCONV *retro_get_image_index_t)(void);
+
+/* Sets image index. Can only be called when disk is ejected.
+ * The implementation supports setting "no disk" by using an
+ * index >= get_num_images().
+ */
+typedef bool (RETRO_CALLCONV *retro_set_image_index_t)(unsigned index);
+
+/* Gets total number of images which are available to use. */
+typedef unsigned (RETRO_CALLCONV *retro_get_num_images_t)(void);
+
+struct retro_game_info;
+
+/* Replaces the disk image associated with index.
+ * Arguments to pass in info have same requirements as retro_load_game().
+ * Virtual disk tray must be ejected when calling this.
+ *
+ * Replacing a disk image with info = NULL will remove the disk image
+ * from the internal list.
+ * As a result, calls to get_image_index() can change.
+ *
+ * E.g. replace_image_index(1, NULL), and previous get_image_index()
+ * returned 4 before.
+ * Index 1 will be removed, and the new index is 3.
+ */
+typedef bool (RETRO_CALLCONV *retro_replace_image_index_t)(unsigned index,
+ const struct retro_game_info *info);
+
+/* Adds a new valid index (get_num_images()) to the internal disk list.
+ * This will increment subsequent return values from get_num_images() by 1.
+ * This image index cannot be used until a disk image has been set
+ * with replace_image_index. */
+typedef bool (RETRO_CALLCONV *retro_add_image_index_t)(void);
+
+/* Sets initial image to insert in drive when calling
+ * core_load_game().
+ * Since we cannot pass the initial index when loading
+ * content (this would require a major API change), this
+ * is set by the frontend *before* calling the core's
+ * retro_load_game()/retro_load_game_special() implementation.
+ * A core should therefore cache the index/path values and handle
+ * them inside retro_load_game()/retro_load_game_special().
+ * - If 'index' is invalid (index >= get_num_images()), the
+ * core should ignore the set value and instead use 0
+ * - 'path' is used purely for error checking - i.e. when
+ * content is loaded, the core should verify that the
+ * disk specified by 'index' has the specified file path.
+ * This is to guard against auto selecting the wrong image
+ * if (for example) the user should modify an existing M3U
+ * playlist. We have to let the core handle this because
+ * set_initial_image() must be called before loading content,
+ * i.e. the frontend cannot access image paths in advance
+ * and thus cannot perform the error check itself.
+ * If set path and content path do not match, the core should
+ * ignore the set 'index' value and instead use 0
+ * Returns 'false' if index or 'path' are invalid, or core
+ * does not support this functionality
+ */
+typedef bool (RETRO_CALLCONV *retro_set_initial_image_t)(unsigned index, const char *path);
+
+/* Fetches the path of the specified disk image file.
+ * Returns 'false' if index is invalid (index >= get_num_images())
+ * or path is otherwise unavailable.
+ */
+typedef bool (RETRO_CALLCONV *retro_get_image_path_t)(unsigned index, char *path, size_t len);
+
+/* Fetches a core-provided 'label' for the specified disk
+ * image file. In the simplest case this may be a file name
+ * (without extension), but for cores with more complex
+ * content requirements information may be provided to
+ * facilitate user disk swapping - for example, a core
+ * running floppy-disk-based content may uniquely label
+ * save disks, data disks, level disks, etc. with names
+ * corresponding to in-game disk change prompts (so the
+ * frontend can provide better user guidance than a 'dumb'
+ * disk index value).
+ * Returns 'false' if index is invalid (index >= get_num_images())
+ * or label is otherwise unavailable.
+ */
+typedef bool (RETRO_CALLCONV *retro_get_image_label_t)(unsigned index, char *label, size_t len);
+
+struct retro_disk_control_callback
+{
+ retro_set_eject_state_t set_eject_state;
+ retro_get_eject_state_t get_eject_state;
+
+ retro_get_image_index_t get_image_index;
+ retro_set_image_index_t set_image_index;
+ retro_get_num_images_t get_num_images;
+
+ retro_replace_image_index_t replace_image_index;
+ retro_add_image_index_t add_image_index;
+};
+
+struct retro_disk_control_ext_callback
+{
+ retro_set_eject_state_t set_eject_state;
+ retro_get_eject_state_t get_eject_state;
+
+ retro_get_image_index_t get_image_index;
+ retro_set_image_index_t set_image_index;
+ retro_get_num_images_t get_num_images;
+
+ retro_replace_image_index_t replace_image_index;
+ retro_add_image_index_t add_image_index;
+
+ /* NOTE: Frontend will only attempt to record/restore
+ * last used disk index if both set_initial_image()
+ * and get_image_path() are implemented */
+ retro_set_initial_image_t set_initial_image; /* Optional - may be NULL */
+
+ retro_get_image_path_t get_image_path; /* Optional - may be NULL */
+ retro_get_image_label_t get_image_label; /* Optional - may be NULL */
+};
+
+enum retro_pixel_format
+{
+ /* 0RGB1555, native endian.
+ * 0 bit must be set to 0.
+ * This pixel format is default for compatibility concerns only.
+ * If a 15/16-bit pixel format is desired, consider using RGB565. */
+ RETRO_PIXEL_FORMAT_0RGB1555 = 0,
+
+ /* XRGB8888, native endian.
+ * X bits are ignored. */
+ RETRO_PIXEL_FORMAT_XRGB8888 = 1,
+
+ /* RGB565, native endian.
+ * This pixel format is the recommended format to use if a 15/16-bit
+ * format is desired as it is the pixel format that is typically
+ * available on a wide range of low-power devices.
+ *
+ * It is also natively supported in APIs like OpenGL ES. */
+ RETRO_PIXEL_FORMAT_RGB565 = 2,
+
+ /* Ensure sizeof() == sizeof(int). */
+ RETRO_PIXEL_FORMAT_UNKNOWN = INT_MAX
+};
+
+struct retro_message
+{
+ const char *msg; /* Message to be displayed. */
+ unsigned frames; /* Duration in frames of message. */
+};
+
+enum retro_message_target
+{
+ RETRO_MESSAGE_TARGET_ALL = 0,
+ RETRO_MESSAGE_TARGET_OSD,
+ RETRO_MESSAGE_TARGET_LOG
+};
+
+enum retro_message_type
+{
+ RETRO_MESSAGE_TYPE_NOTIFICATION = 0,
+ RETRO_MESSAGE_TYPE_NOTIFICATION_ALT,
+ RETRO_MESSAGE_TYPE_STATUS,
+ RETRO_MESSAGE_TYPE_PROGRESS
+};
+
+struct retro_message_ext
+{
+ /* Message string to be displayed/logged */
+ const char *msg;
+ /* Duration (in ms) of message when targeting the OSD */
+ unsigned duration;
+ /* Message priority when targeting the OSD
+ * > When multiple concurrent messages are sent to
+ * the frontend and the frontend does not have the
+ * capacity to display them all, messages with the
+ * *highest* priority value should be shown
+ * > There is no upper limit to a message priority
+ * value (within the bounds of the unsigned data type)
+ * > In the reference frontend (RetroArch), the same
+ * priority values are used for frontend-generated
+ * notifications, which are typically assigned values
+ * between 0 and 3 depending upon importance */
+ unsigned priority;
+ /* Message logging level (info, warn, error, etc.) */
+ enum retro_log_level level;
+ /* Message destination: OSD, logging interface or both */
+ enum retro_message_target target;
+ /* Message 'type' when targeting the OSD
+ * > RETRO_MESSAGE_TYPE_NOTIFICATION: Specifies that a
+ * message should be handled in identical fashion to
+ * a standard frontend-generated notification
+ * > RETRO_MESSAGE_TYPE_NOTIFICATION_ALT: Specifies that
+ * message is a notification that requires user attention
+ * or action, but that it should be displayed in a manner
+ * that differs from standard frontend-generated notifications.
+ * This would typically correspond to messages that should be
+ * displayed immediately (independently from any internal
+ * frontend message queue), and/or which should be visually
+ * distinguishable from frontend-generated notifications.
+ * For example, a core may wish to inform the user of
+ * information related to a disk-change event. It is
+ * expected that the frontend itself may provide a
+ * notification in this case; if the core sends a
+ * message of type RETRO_MESSAGE_TYPE_NOTIFICATION, an
+ * uncomfortable 'double-notification' may occur. A message
+ * of RETRO_MESSAGE_TYPE_NOTIFICATION_ALT should therefore
+ * be presented such that visual conflict with regular
+ * notifications does not occur
+ * > RETRO_MESSAGE_TYPE_STATUS: Indicates that message
+ * is not a standard notification. This typically
+ * corresponds to 'status' indicators, such as a core's
+ * internal FPS, which are intended to be displayed
+ * either permanently while a core is running, or in
+ * a manner that does not suggest user attention or action
+ * is required. 'Status' type messages should therefore be
+ * displayed in a different on-screen location and in a manner
+ * easily distinguishable from both standard frontend-generated
+ * notifications and messages of type RETRO_MESSAGE_TYPE_NOTIFICATION_ALT
+ * > RETRO_MESSAGE_TYPE_PROGRESS: Indicates that message reports
+ * the progress of an internal core task. For example, in cases
+ * where a core itself handles the loading of content from a file,
+ * this may correspond to the percentage of the file that has been
+ * read. Alternatively, an audio/video playback core may use a
+ * message of type RETRO_MESSAGE_TYPE_PROGRESS to display the current
+ * playback position as a percentage of the runtime. 'Progress' type
+ * messages should therefore be displayed as a literal progress bar,
+ * where:
+ * - 'retro_message_ext.msg' is the progress bar title/label
+ * - 'retro_message_ext.progress' determines the length of
+ * the progress bar
+ * NOTE: Message type is a *hint*, and may be ignored
+ * by the frontend. If a frontend lacks support for
+ * displaying messages via alternate means than standard
+ * frontend-generated notifications, it will treat *all*
+ * messages as having the type RETRO_MESSAGE_TYPE_NOTIFICATION */
+ enum retro_message_type type;
+ /* Task progress when targeting the OSD and message is
+ * of type RETRO_MESSAGE_TYPE_PROGRESS
+ * > -1: Unmetered/indeterminate
+ * > 0-100: Current progress percentage
+ * NOTE: Since message type is a hint, a frontend may ignore
+ * progress values. Where relevant, a core should therefore
+ * include progress percentage within the message string,
+ * such that the message intent remains clear when displayed
+ * as a standard frontend-generated notification */
+ int8_t progress;
+};
+
+/* Describes how the libretro implementation maps a libretro input bind
+ * to its internal input system through a human readable string.
+ * This string can be used to better let a user configure input. */
+struct retro_input_descriptor
+{
+ /* Associates given parameters with a description. */
+ unsigned port;
+ unsigned device;
+ unsigned index;
+ unsigned id;
+
+ /* Human readable description for parameters.
+ * The pointer must remain valid until
+ * retro_unload_game() is called. */
+ const char *description;
+};
+
+struct retro_system_info
+{
+ /* All pointers are owned by libretro implementation, and pointers must
+ * remain valid until it is unloaded. */
+
+ const char *library_name; /* Descriptive name of library. Should not
+ * contain any version numbers, etc. */
+ const char *library_version; /* Descriptive version of core. */
+
+ const char *valid_extensions; /* A string listing probably content
+ * extensions the core will be able to
+ * load, separated with pipe.
+ * I.e. "bin|rom|iso".
+ * Typically used for a GUI to filter
+ * out extensions. */
+
+ /* Libretro cores that need to have direct access to their content
+ * files, including cores which use the path of the content files to
+ * determine the paths of other files, should set need_fullpath to true.
+ *
+ * Cores should strive for setting need_fullpath to false,
+ * as it allows the frontend to perform patching, etc.
+ *
+ * If need_fullpath is true and retro_load_game() is called:
+ * - retro_game_info::path is guaranteed to have a valid path
+ * - retro_game_info::data and retro_game_info::size are invalid
+ *
+ * If need_fullpath is false and retro_load_game() is called:
+ * - retro_game_info::path may be NULL
+ * - retro_game_info::data and retro_game_info::size are guaranteed
+ * to be valid
+ *
+ * See also:
+ * - RETRO_ENVIRONMENT_GET_SYSTEM_DIRECTORY
+ * - RETRO_ENVIRONMENT_GET_SAVE_DIRECTORY
+ */
+ bool need_fullpath;
+
+ /* If true, the frontend is not allowed to extract any archives before
+ * loading the real content.
+ * Necessary for certain libretro implementations that load games
+ * from zipped archives. */
+ bool block_extract;
+};
+
+/* Defines overrides which modify frontend handling of
+ * specific content file types.
+ * An array of retro_system_content_info_override is
+ * passed to RETRO_ENVIRONMENT_SET_CONTENT_INFO_OVERRIDE
+ * NOTE: In the following descriptions, references to
+ * retro_load_game() may be replaced with
+ * retro_load_game_special() */
+struct retro_system_content_info_override
+{
+ /* A list of file extensions for which the override
+ * should apply, delimited by a 'pipe' character
+ * (e.g. "md|sms|gg")
+ * Permitted file extensions are limited to those
+ * included in retro_system_info::valid_extensions
+ * and/or retro_subsystem_rom_info::valid_extensions */
+ const char *extensions;
+
+ /* Overrides the need_fullpath value set in
+ * retro_system_info and/or retro_subsystem_rom_info.
+ * To reiterate:
+ *
+ * If need_fullpath is true and retro_load_game() is called:
+ * - retro_game_info::path is guaranteed to contain a valid
+ * path to an existent file
+ * - retro_game_info::data and retro_game_info::size are invalid
+ *
+ * If need_fullpath is false and retro_load_game() is called:
+ * - retro_game_info::path may be NULL
+ * - retro_game_info::data and retro_game_info::size are guaranteed
+ * to be valid
+ *
+ * In addition:
+ *
+ * If need_fullpath is true and retro_load_game() is called:
+ * - retro_game_info_ext::full_path is guaranteed to contain a valid
+ * path to an existent file
+ * - retro_game_info_ext::archive_path may be NULL
+ * - retro_game_info_ext::archive_file may be NULL
+ * - retro_game_info_ext::dir is guaranteed to contain a valid path
+ * to the directory in which the content file exists
+ * - retro_game_info_ext::name is guaranteed to contain the
+ * basename of the content file, without extension
+ * - retro_game_info_ext::ext is guaranteed to contain the
+ * extension of the content file in lower case format
+ * - retro_game_info_ext::data and retro_game_info_ext::size
+ * are invalid
+ *
+ * If need_fullpath is false and retro_load_game() is called:
+ * - If retro_game_info_ext::file_in_archive is false:
+ * - retro_game_info_ext::full_path is guaranteed to contain
+ * a valid path to an existent file
+ * - retro_game_info_ext::archive_path may be NULL
+ * - retro_game_info_ext::archive_file may be NULL
+ * - retro_game_info_ext::dir is guaranteed to contain a
+ * valid path to the directory in which the content file exists
+ * - retro_game_info_ext::name is guaranteed to contain the
+ * basename of the content file, without extension
+ * - retro_game_info_ext::ext is guaranteed to contain the
+ * extension of the content file in lower case format
+ * - If retro_game_info_ext::file_in_archive is true:
+ * - retro_game_info_ext::full_path may be NULL
+ * - retro_game_info_ext::archive_path is guaranteed to
+ * contain a valid path to an existent compressed file
+ * inside which the content file is located
+ * - retro_game_info_ext::archive_file is guaranteed to
+ * contain a valid path to an existent content file
+ * inside the compressed file referred to by
+ * retro_game_info_ext::archive_path
+ * e.g. for a compressed file '/path/to/foo.zip'
+ * containing 'bar.sfc'
+ * > retro_game_info_ext::archive_path will be '/path/to/foo.zip'
+ * > retro_game_info_ext::archive_file will be 'bar.sfc'
+ * - retro_game_info_ext::dir is guaranteed to contain a
+ * valid path to the directory in which the compressed file
+ * (containing the content file) exists
+ * - retro_game_info_ext::name is guaranteed to contain
+ * EITHER
+ * 1) the basename of the compressed file (containing
+ * the content file), without extension
+ * OR
+ * 2) the basename of the content file inside the
+ * compressed file, without extension
+ * In either case, a core should consider 'name' to
+ * be the canonical name/ID of the the content file
+ * - retro_game_info_ext::ext is guaranteed to contain the
+ * extension of the content file inside the compressed file,
+ * in lower case format
+ * - retro_game_info_ext::data and retro_game_info_ext::size are
+ * guaranteed to be valid */
+ bool need_fullpath;
+
+ /* If need_fullpath is false, specifies whether the content
+ * data buffer available in retro_load_game() is 'persistent'
+ *
+ * If persistent_data is false and retro_load_game() is called:
+ * - retro_game_info::data and retro_game_info::size
+ * are valid only until retro_load_game() returns
+ * - retro_game_info_ext::data and retro_game_info_ext::size
+ * are valid only until retro_load_game() returns
+ *
+ * If persistent_data is true and retro_load_game() is called:
+ * - retro_game_info::data and retro_game_info::size
+ * are valid until retro_deinit() returns
+ * - retro_game_info_ext::data and retro_game_info_ext::size
+ * are valid until retro_deinit() returns */
+ bool persistent_data;
+};
+
+/* Similar to retro_game_info, but provides extended
+ * information about the source content file and
+ * game memory buffer status.
+ * And array of retro_game_info_ext is returned by
+ * RETRO_ENVIRONMENT_GET_GAME_INFO_EXT
+ * NOTE: In the following descriptions, references to
+ * retro_load_game() may be replaced with
+ * retro_load_game_special() */
+struct retro_game_info_ext
+{
+ /* - If file_in_archive is false, contains a valid
+ * path to an existent content file (UTF-8 encoded)
+ * - If file_in_archive is true, may be NULL */
+ const char *full_path;
+
+ /* - If file_in_archive is false, may be NULL
+ * - If file_in_archive is true, contains a valid path
+ * to an existent compressed file inside which the
+ * content file is located (UTF-8 encoded) */
+ const char *archive_path;
+
+ /* - If file_in_archive is false, may be NULL
+ * - If file_in_archive is true, contain a valid path
+ * to an existent content file inside the compressed
+ * file referred to by archive_path (UTF-8 encoded)
+ * e.g. for a compressed file '/path/to/foo.zip'
+ * containing 'bar.sfc'
+ * > archive_path will be '/path/to/foo.zip'
+ * > archive_file will be 'bar.sfc' */
+ const char *archive_file;
+
+ /* - If file_in_archive is false, contains a valid path
+ * to the directory in which the content file exists
+ * (UTF-8 encoded)
+ * - If file_in_archive is true, contains a valid path
+ * to the directory in which the compressed file
+ * (containing the content file) exists (UTF-8 encoded) */
+ const char *dir;
+
+ /* Contains the canonical name/ID of the content file
+ * (UTF-8 encoded). Intended for use when identifying
+ * 'complementary' content named after the loaded file -
+ * i.e. companion data of a different format (a CD image
+ * required by a ROM), texture packs, internally handled
+ * save files, etc.
+ * - If file_in_archive is false, contains the basename
+ * of the content file, without extension
+ * - If file_in_archive is true, then string is
+ * implementation specific. A frontend may choose to
+ * set a name value of:
+ * EITHER
+ * 1) the basename of the compressed file (containing
+ * the content file), without extension
+ * OR
+ * 2) the basename of the content file inside the
+ * compressed file, without extension
+ * RetroArch sets the 'name' value according to (1).
+ * A frontend that supports routine loading of
+ * content from archives containing multiple unrelated
+ * content files may set the 'name' value according
+ * to (2). */
+ const char *name;
+
+ /* - If file_in_archive is false, contains the extension
+ * of the content file in lower case format
+ * - If file_in_archive is true, contains the extension
+ * of the content file inside the compressed file,
+ * in lower case format */
+ const char *ext;
+
+ /* String of implementation specific meta-data. */
+ const char *meta;
+
+ /* Memory buffer of loaded game content. Will be NULL:
+ * IF
+ * - retro_system_info::need_fullpath is true and
+ * retro_system_content_info_override::need_fullpath
+ * is unset
+ * OR
+ * - retro_system_content_info_override::need_fullpath
+ * is true */
+ const void *data;
+
+ /* Size of game content memory buffer, in bytes */
+ size_t size;
+
+ /* True if loaded content file is inside a compressed
+ * archive */
+ bool file_in_archive;
+
+ /* - If data is NULL, value is unset/ignored
+ * - If data is non-NULL:
+ * - If persistent_data is false, data and size are
+ * valid only until retro_load_game() returns
+ * - If persistent_data is true, data and size are
+ * are valid until retro_deinit() returns */
+ bool persistent_data;
+};
+
+struct retro_game_geometry
+{
+ unsigned base_width; /* Nominal video width of game. */
+ unsigned base_height; /* Nominal video height of game. */
+ unsigned max_width; /* Maximum possible width of game. */
+ unsigned max_height; /* Maximum possible height of game. */
+
+ float aspect_ratio; /* Nominal aspect ratio of game. If
+ * aspect_ratio is <= 0.0, an aspect ratio
+ * of base_width / base_height is assumed.
+ * A frontend could override this setting,
+ * if desired. */
+};
+
+struct retro_system_timing
+{
+ double fps; /* FPS of video content. */
+ double sample_rate; /* Sampling rate of audio. */
+};
+
+struct retro_system_av_info
+{
+ struct retro_game_geometry geometry;
+ struct retro_system_timing timing;
+};
+
+struct retro_variable
+{
+ /* Variable to query in RETRO_ENVIRONMENT_GET_VARIABLE.
+ * If NULL, obtains the complete environment string if more
+ * complex parsing is necessary.
+ * The environment string is formatted as key-value pairs
+ * delimited by semicolons as so:
+ * "key1=value1;key2=value2;..."
+ */
+ const char *key;
+
+ /* Value to be obtained. If key does not exist, it is set to NULL. */
+ const char *value;
+};
+
+struct retro_core_option_display
+{
+ /* Variable to configure in RETRO_ENVIRONMENT_SET_CORE_OPTIONS_DISPLAY */
+ const char *key;
+
+ /* Specifies whether variable should be displayed
+ * when presenting core options to the user */
+ bool visible;
+};
+
+/* Maximum number of values permitted for a core option
+ * > Note: We have to set a maximum value due the limitations
+ * of the C language - i.e. it is not possible to create an
+ * array of structs each containing a variable sized array,
+ * so the retro_core_option_definition values array must
+ * have a fixed size. The size limit of 128 is a balancing
+ * act - it needs to be large enough to support all 'sane'
+ * core options, but setting it too large may impact low memory
+ * platforms. In practise, if a core option has more than
+ * 128 values then the implementation is likely flawed.
+ * To quote the above API reference:
+ * "The number of possible options should be very limited
+ * i.e. it should be feasible to cycle through options
+ * without a keyboard."
+ */
+#define RETRO_NUM_CORE_OPTION_VALUES_MAX 128
+
+struct retro_core_option_value
+{
+ /* Expected option value */
+ const char *value;
+
+ /* Human-readable value label. If NULL, value itself
+ * will be displayed by the frontend */
+ const char *label;
+};
+
+struct retro_core_option_definition
+{
+ /* Variable to query in RETRO_ENVIRONMENT_GET_VARIABLE. */
+ const char *key;
+
+ /* Human-readable core option description (used as menu label) */
+ const char *desc;
+
+ /* Human-readable core option information (used as menu sublabel) */
+ const char *info;
+
+ /* Array of retro_core_option_value structs, terminated by NULL */
+ struct retro_core_option_value values[RETRO_NUM_CORE_OPTION_VALUES_MAX];
+
+ /* Default core option value. Must match one of the values
+ * in the retro_core_option_value array, otherwise will be
+ * ignored */
+ const char *default_value;
+};
+
+struct retro_core_options_intl
+{
+ /* Pointer to an array of retro_core_option_definition structs
+ * - US English implementation
+ * - Must point to a valid array */
+ struct retro_core_option_definition *us;
+
+ /* Pointer to an array of retro_core_option_definition structs
+ * - Implementation for current frontend language
+ * - May be NULL */
+ struct retro_core_option_definition *local;
+};
+
+struct retro_core_option_v2_category
+{
+ /* Variable uniquely identifying the
+ * option category. Valid key characters
+ * are [a-z, A-Z, 0-9, _, -] */
+ const char *key;
+
+ /* Human-readable category description
+ * > Used as category menu label when
+ * frontend has core option category
+ * support */
+ const char *desc;
+
+ /* Human-readable category information
+ * > Used as category menu sublabel when
+ * frontend has core option category
+ * support
+ * > Optional (may be NULL or an empty
+ * string) */
+ const char *info;
+};
+
+struct retro_core_option_v2_definition
+{
+ /* Variable to query in RETRO_ENVIRONMENT_GET_VARIABLE.
+ * Valid key characters are [a-z, A-Z, 0-9, _, -] */
+ const char *key;
+
+ /* Human-readable core option description
+ * > Used as menu label when frontend does
+ * not have core option category support
+ * e.g. "Video > Aspect Ratio" */
+ const char *desc;
+
+ /* Human-readable core option description
+ * > Used as menu label when frontend has
+ * core option category support
+ * e.g. "Aspect Ratio", where associated
+ * retro_core_option_v2_category::desc
+ * is "Video"
+ * > If empty or NULL, the string specified by
+ * desc will be used as the menu label
+ * > Will be ignored (and may be set to NULL)
+ * if category_key is empty or NULL */
+ const char *desc_categorized;
+
+ /* Human-readable core option information
+ * > Used as menu sublabel */
+ const char *info;
+
+ /* Human-readable core option information
+ * > Used as menu sublabel when frontend
+ * has core option category support
+ * (e.g. may be required when info text
+ * references an option by name/desc,
+ * and the desc/desc_categorized text
+ * for that option differ)
+ * > If empty or NULL, the string specified by
+ * info will be used as the menu sublabel
+ * > Will be ignored (and may be set to NULL)
+ * if category_key is empty or NULL */
+ const char *info_categorized;
+
+ /* Variable specifying category (e.g. "video",
+ * "audio") that will be assigned to the option
+ * if frontend has core option category support.
+ * > Categorized options will be displayed in a
+ * subsection/submenu of the frontend core
+ * option interface
+ * > Specified string must match one of the
+ * retro_core_option_v2_category::key values
+ * in the associated retro_core_option_v2_category
+ * array; If no match is not found, specified
+ * string will be considered as NULL
+ * > If specified string is empty or NULL, option will
+ * have no category and will be shown at the top
+ * level of the frontend core option interface */
+ const char *category_key;
+
+ /* Array of retro_core_option_value structs, terminated by NULL */
+ struct retro_core_option_value values[RETRO_NUM_CORE_OPTION_VALUES_MAX];
+
+ /* Default core option value. Must match one of the values
+ * in the retro_core_option_value array, otherwise will be
+ * ignored */
+ const char *default_value;
+};
+
+struct retro_core_options_v2
+{
+ /* Array of retro_core_option_v2_category structs,
+ * terminated by NULL
+ * > If NULL, all entries in definitions array
+ * will have no category and will be shown at
+ * the top level of the frontend core option
+ * interface
+ * > Will be ignored if frontend does not have
+ * core option category support */
+ struct retro_core_option_v2_category *categories;
+
+ /* Array of retro_core_option_v2_definition structs,
+ * terminated by NULL */
+ struct retro_core_option_v2_definition *definitions;
+};
+
+struct retro_core_options_v2_intl
+{
+ /* Pointer to a retro_core_options_v2 struct
+ * > US English implementation
+ * > Must point to a valid struct */
+ struct retro_core_options_v2 *us;
+
+ /* Pointer to a retro_core_options_v2 struct
+ * - Implementation for current frontend language
+ * - May be NULL */
+ struct retro_core_options_v2 *local;
+};
+
+/* Used by the frontend to monitor changes in core option
+ * visibility. May be called each time any core option
+ * value is set via the frontend.
+ * - On each invocation, the core must update the visibility
+ * of any dynamically hidden options using the
+ * RETRO_ENVIRONMENT_SET_CORE_OPTIONS_DISPLAY environment
+ * callback.
+ * - On the first invocation, returns 'true' if the visibility
+ * of any core option has changed since the last call of
+ * retro_load_game() or retro_load_game_special().
+ * - On each subsequent invocation, returns 'true' if the
+ * visibility of any core option has changed since the last
+ * time the function was called. */
+typedef bool (RETRO_CALLCONV *retro_core_options_update_display_callback_t)(void);
+struct retro_core_options_update_display_callback
+{
+ retro_core_options_update_display_callback_t callback;
+};
+
+struct retro_game_info
+{
+ const char *path; /* Path to game, UTF-8 encoded.
+ * Sometimes used as a reference for building other paths.
+ * May be NULL if game was loaded from stdin or similar,
+ * but in this case some cores will be unable to load `data`.
+ * So, it is preferable to fabricate something here instead
+ * of passing NULL, which will help more cores to succeed.
+ * retro_system_info::need_fullpath requires
+ * that this path is valid. */
+ const void *data; /* Memory buffer of loaded game. Will be NULL
+ * if need_fullpath was set. */
+ size_t size; /* Size of memory buffer. */
+ const char *meta; /* String of implementation specific meta-data. */
+};
+
+#define RETRO_MEMORY_ACCESS_WRITE (1 << 0)
+ /* The core will write to the buffer provided by retro_framebuffer::data. */
+#define RETRO_MEMORY_ACCESS_READ (1 << 1)
+ /* The core will read from retro_framebuffer::data. */
+#define RETRO_MEMORY_TYPE_CACHED (1 << 0)
+ /* The memory in data is cached.
+ * If not cached, random writes and/or reading from the buffer is expected to be very slow. */
+struct retro_framebuffer
+{
+ void *data; /* The framebuffer which the core can render into.
+ Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER.
+ The initial contents of data are unspecified. */
+ unsigned width; /* The framebuffer width used by the core. Set by core. */
+ unsigned height; /* The framebuffer height used by the core. Set by core. */
+ size_t pitch; /* The number of bytes between the beginning of a scanline,
+ and beginning of the next scanline.
+ Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER. */
+ enum retro_pixel_format format; /* The pixel format the core must use to render into data.
+ This format could differ from the format used in
+ SET_PIXEL_FORMAT.
+ Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER. */
+
+ unsigned access_flags; /* How the core will access the memory in the framebuffer.
+ RETRO_MEMORY_ACCESS_* flags.
+ Set by core. */
+ unsigned memory_flags; /* Flags telling core how the memory has been mapped.
+ RETRO_MEMORY_TYPE_* flags.
+ Set by frontend in GET_CURRENT_SOFTWARE_FRAMEBUFFER. */
+};
+
+/* Used by a libretro core to override the current
+ * fastforwarding mode of the frontend */
+struct retro_fastforwarding_override
+{
+ /* Specifies the runtime speed multiplier that
+ * will be applied when 'fastforward' is true.
+ * For example, a value of 5.0 when running 60 FPS
+ * content will cap the fast-forward rate at 300 FPS.
+ * Note that the target multiplier may not be achieved
+ * if the host hardware has insufficient processing
+ * power.
+ * Setting a value of 0.0 (or greater than 0.0 but
+ * less than 1.0) will result in an uncapped
+ * fast-forward rate (limited only by hardware
+ * capacity).
+ * If the value is negative, it will be ignored
+ * (i.e. the frontend will use a runtime speed
+ * multiplier of its own choosing) */
+ float ratio;
+
+ /* If true, fastforwarding mode will be enabled.
+ * If false, fastforwarding mode will be disabled. */
+ bool fastforward;
+
+ /* If true, and if supported by the frontend, an
+ * on-screen notification will be displayed while
+ * 'fastforward' is true.
+ * If false, and if supported by the frontend, any
+ * on-screen fast-forward notifications will be
+ * suppressed */
+ bool notification;
+
+ /* If true, the core will have sole control over
+ * when fastforwarding mode is enabled/disabled;
+ * the frontend will not be able to change the
+ * state set by 'fastforward' until either
+ * 'inhibit_toggle' is set to false, or the core
+ * is unloaded */
+ bool inhibit_toggle;
+};
+
+/* Callbacks */
+
+/* Environment callback. Gives implementations a way of performing
+ * uncommon tasks. Extensible. */
+typedef bool (RETRO_CALLCONV *retro_environment_t)(unsigned cmd, void *data);
+
+/* Render a frame. Pixel format is 15-bit 0RGB1555 native endian
+ * unless changed (see RETRO_ENVIRONMENT_SET_PIXEL_FORMAT).
+ *
+ * Width and height specify dimensions of buffer.
+ * Pitch specifices length in bytes between two lines in buffer.
+ *
+ * For performance reasons, it is highly recommended to have a frame
+ * that is packed in memory, i.e. pitch == width * byte_per_pixel.
+ * Certain graphic APIs, such as OpenGL ES, do not like textures
+ * that are not packed in memory.
+ */
+typedef void (RETRO_CALLCONV *retro_video_refresh_t)(const void *data, unsigned width,
+ unsigned height, size_t pitch);
+
+/* Renders a single audio frame. Should only be used if implementation
+ * generates a single sample at a time.
+ * Format is signed 16-bit native endian.
+ */
+typedef void (RETRO_CALLCONV *retro_audio_sample_t)(int16_t left, int16_t right);
+
+/* Renders multiple audio frames in one go.
+ *
+ * One frame is defined as a sample of left and right channels, interleaved.
+ * I.e. int16_t buf[4] = { l, r, l, r }; would be 2 frames.
+ * Only one of the audio callbacks must ever be used.
+ */
+typedef size_t (RETRO_CALLCONV *retro_audio_sample_batch_t)(const int16_t *data,
+ size_t frames);
+
+/* Polls input. */
+typedef void (RETRO_CALLCONV *retro_input_poll_t)(void);
+
+/* Queries for input for player 'port'. device will be masked with
+ * RETRO_DEVICE_MASK.
+ *
+ * Specialization of devices such as RETRO_DEVICE_JOYPAD_MULTITAP that
+ * have been set with retro_set_controller_port_device()
+ * will still use the higher level RETRO_DEVICE_JOYPAD to request input.
+ */
+typedef int16_t (RETRO_CALLCONV *retro_input_state_t)(unsigned port, unsigned device,
+ unsigned index, unsigned id);
+
+/* Sets callbacks. retro_set_environment() is guaranteed to be called
+ * before retro_init().
+ *
+ * The rest of the set_* functions are guaranteed to have been called
+ * before the first call to retro_run() is made. */
+RETRO_API void retro_set_environment(retro_environment_t);
+RETRO_API void retro_set_video_refresh(retro_video_refresh_t);
+RETRO_API void retro_set_audio_sample(retro_audio_sample_t);
+RETRO_API void retro_set_audio_sample_batch(retro_audio_sample_batch_t);
+RETRO_API void retro_set_input_poll(retro_input_poll_t);
+RETRO_API void retro_set_input_state(retro_input_state_t);
+
+/* Library global initialization/deinitialization. */
+RETRO_API void retro_init(void);
+RETRO_API void retro_deinit(void);
+
+/* Must return RETRO_API_VERSION. Used to validate ABI compatibility
+ * when the API is revised. */
+RETRO_API unsigned retro_api_version(void);
+
+/* Gets statically known system info. Pointers provided in *info
+ * must be statically allocated.
+ * Can be called at any time, even before retro_init(). */
+RETRO_API void retro_get_system_info(struct retro_system_info *info);
+
+/* Gets information about system audio/video timings and geometry.
+ * Can be called only after retro_load_game() has successfully completed.
+ * NOTE: The implementation of this function might not initialize every
+ * variable if needed.
+ * E.g. geom.aspect_ratio might not be initialized if core doesn't
+ * desire a particular aspect ratio. */
+RETRO_API void retro_get_system_av_info(struct retro_system_av_info *info);
+
+/* Sets device to be used for player 'port'.
+ * By default, RETRO_DEVICE_JOYPAD is assumed to be plugged into all
+ * available ports.
+ * Setting a particular device type is not a guarantee that libretro cores
+ * will only poll input based on that particular device type. It is only a
+ * hint to the libretro core when a core cannot automatically detect the
+ * appropriate input device type on its own. It is also relevant when a
+ * core can change its behavior depending on device type.
+ *
+ * As part of the core's implementation of retro_set_controller_port_device,
+ * the core should call RETRO_ENVIRONMENT_SET_INPUT_DESCRIPTORS to notify the
+ * frontend if the descriptions for any controls have changed as a
+ * result of changing the device type.
+ */
+RETRO_API void retro_set_controller_port_device(unsigned port, unsigned device);
+
+/* Resets the current game. */
+RETRO_API void retro_reset(void);
+
+/* Runs the game for one video frame.
+ * During retro_run(), input_poll callback must be called at least once.
+ *
+ * If a frame is not rendered for reasons where a game "dropped" a frame,
+ * this still counts as a frame, and retro_run() should explicitly dupe
+ * a frame if GET_CAN_DUPE returns true.
+ * In this case, the video callback can take a NULL argument for data.
+ */
+RETRO_API void retro_run(void);
+
+/* Returns the amount of data the implementation requires to serialize
+ * internal state (save states).
+ * Between calls to retro_load_game() and retro_unload_game(), the
+ * returned size is never allowed to be larger than a previous returned
+ * value, to ensure that the frontend can allocate a save state buffer once.
+ */
+RETRO_API size_t retro_serialize_size(void);
+
+/* Serializes internal state. If failed, or size is lower than
+ * retro_serialize_size(), it should return false, true otherwise. */
+RETRO_API bool retro_serialize(void *data, size_t size);
+RETRO_API bool retro_unserialize(const void *data, size_t size);
+
+RETRO_API void retro_cheat_reset(void);
+RETRO_API void retro_cheat_set(unsigned index, bool enabled, const char *code);
+
+/* Loads a game.
+ * Return true to indicate successful loading and false to indicate load failure.
+ */
+RETRO_API bool retro_load_game(const struct retro_game_info *game);
+
+/* Loads a "special" kind of game. Should not be used,
+ * except in extreme cases. */
+RETRO_API bool retro_load_game_special(
+ unsigned game_type,
+ const struct retro_game_info *info, size_t num_info
+);
+
+/* Unloads the currently loaded game. Called before retro_deinit(void). */
+RETRO_API void retro_unload_game(void);
+
+/* Gets region of game. */
+RETRO_API unsigned retro_get_region(void);
+
+/* Gets region of memory. */
+RETRO_API void *retro_get_memory_data(unsigned id);
+RETRO_API size_t retro_get_memory_size(unsigned id);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
diff --git a/libretro-common/include/retro_assert.h b/libretro-common/include/retro_assert.h
new file mode 100644
index 0000000..79dbb32
--- /dev/null
+++ b/libretro-common/include/retro_assert.h
@@ -0,0 +1,35 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (retro_assert.h).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef __RETRO_ASSERT_H
+#define __RETRO_ASSERT_H
+
+#include <assert.h>
+
+#ifdef RARCH_INTERNAL
+#include <stdio.h>
+#define retro_assert(cond) ((void)( (cond) || (printf("Assertion failed at %s:%d.\n", __FILE__, __LINE__), abort(), 0) ))
+#else
+#define retro_assert(cond) assert(cond)
+#endif
+
+#endif
diff --git a/libretro-common/include/retro_common_api.h b/libretro-common/include/retro_common_api.h
new file mode 100644
index 0000000..0f68b7d
--- /dev/null
+++ b/libretro-common/include/retro_common_api.h
@@ -0,0 +1,119 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (retro_common_api.h).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef _LIBRETRO_COMMON_RETRO_COMMON_API_H
+#define _LIBRETRO_COMMON_RETRO_COMMON_API_H
+
+/*
+This file is designed to normalize the libretro-common compiling environment
+for public API headers. This should be leaner than a normal compiling environment,
+since it gets #included into other project's sources.
+*/
+
+/* ------------------------------------ */
+
+/*
+Ordinarily we want to put #ifdef __cplusplus extern "C" in C library
+headers to enable them to get used by c++ sources.
+However, we want to support building this library as C++ as well, so a
+special technique is called for.
+*/
+
+#define RETRO_BEGIN_DECLS
+#define RETRO_END_DECLS
+
+#ifdef __cplusplus
+
+#ifdef CXX_BUILD
+/* build wants everything to be built as c++, so no extern "C" */
+#else
+#undef RETRO_BEGIN_DECLS
+#undef RETRO_END_DECLS
+#define RETRO_BEGIN_DECLS extern "C" {
+#define RETRO_END_DECLS }
+#endif
+
+#else
+
+/* header is included by a C source file, so no extern "C" */
+
+#endif
+
+/*
+IMO, this non-standard ssize_t should not be used.
+However, it's a good example of how to handle something like this.
+*/
+#ifdef _MSC_VER
+#ifndef HAVE_SSIZE_T
+#define HAVE_SSIZE_T
+#if defined(_WIN64)
+typedef __int64 ssize_t;
+#elif defined(_WIN32)
+typedef int ssize_t;
+#endif
+#endif
+#elif defined(__MACH__)
+#include <sys/types.h>
+#endif
+
+#ifdef _MSC_VER
+#if _MSC_VER >= 1800
+#include <inttypes.h>
+#else
+#ifndef PRId64
+#define PRId64 "I64d"
+#define PRIu64 "I64u"
+#define PRIuPTR "Iu"
+#endif
+#endif
+#else
+/* C++11 says this one isn't needed, but apparently (some versions of) mingw require it anyways */
+/* https://stackoverflow.com/questions/8132399/how-to-printf-uint64-t-fails-with-spurious-trailing-in-format */
+/* https://github.com/libretro/RetroArch/issues/6009 */
+#ifndef __STDC_FORMAT_MACROS
+#define __STDC_FORMAT_MACROS 1
+#endif
+#include <inttypes.h>
+#endif
+#ifndef PRId64
+#error "inttypes.h is being screwy"
+#endif
+#define STRING_REP_INT64 "%" PRId64
+#define STRING_REP_UINT64 "%" PRIu64
+#define STRING_REP_USIZE "%" PRIuPTR
+
+/*
+I would like to see retro_inline.h moved in here; possibly boolean too.
+
+rationale: these are used in public APIs, and it is easier to find problems
+and write code that works the first time portably when theyre included uniformly
+than to do the analysis from scratch each time you think you need it, for each feature.
+
+Moreover it helps force you to make hard decisions: if you EVER bring in boolean.h,
+then you should pay the price everywhere, so you can see how much grief it will cause.
+
+Of course, another school of thought is that you should do as little damage as possible
+in as few places as possible...
+*/
+
+/* _LIBRETRO_COMMON_RETRO_COMMON_API_H */
+#endif
diff --git a/libretro-common/include/retro_environment.h b/libretro-common/include/retro_environment.h
new file mode 100644
index 0000000..1389eb5
--- /dev/null
+++ b/libretro-common/include/retro_environment.h
@@ -0,0 +1,114 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (retro_environment.h).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef __LIBRETRO_SDK_ENVIRONMENT_H
+#define __LIBRETRO_SDK_ENVIRONMENT_H
+
+/*
+This file is designed to create a normalized environment for compiling
+libretro-common's private implementations, or any other sources which might
+enjoy use of it's environment (RetroArch for instance).
+This should be an elaborately crafted environment so that sources don't
+need to be full of platform-specific workarounds.
+*/
+
+#if defined (__cplusplus)
+#if 0
+printf("This is C++, version %d.\n", __cplusplus);
+#endif
+/* The expected values would be
+ * 199711L, for ISO/IEC 14882:1998 or 14882:2003
+ */
+
+#elif defined(__STDC__)
+/* This is standard C. */
+
+#if (__STDC__ == 1)
+/* The implementation is ISO-conforming. */
+#define __STDC_ISO__
+#else
+/* The implementation is not ISO-conforming. */
+#endif
+
+#if defined(__STDC_VERSION__)
+#if (__STDC_VERSION__ >= 201112L)
+/* This is C11. */
+#define __STDC_C11__
+#elif (__STDC_VERSION__ >= 199901L)
+/* This is C99. */
+#define __STDC_C99__
+#elif (__STDC_VERSION__ >= 199409L)
+/* This is C89 with amendment 1. */
+#define __STDC_C89__
+#define __STDC_C89_AMENDMENT_1__
+#else
+/* This is C89 without amendment 1. */
+#define __STDC_C89__
+#endif
+#else /* !defined(__STDC_VERSION__) */
+/* This is C89. __STDC_VERSION__ is not defined. */
+#define __STDC_C89__
+#endif
+
+#else /* !defined(__STDC__) */
+/* This is not standard C. __STDC__ is not defined. */
+#endif
+
+#if defined(WIN32) || defined(_WIN32) || defined(__CYGWIN__) || defined(__MINGW32__)
+/* Try to find out if we're compiling for WinRT or non-WinRT */
+#if defined(_MSC_VER) && defined(__has_include)
+#if __has_include(<winapifamily.h>)
+#define HAVE_WINAPIFAMILY_H 1
+#else
+#define HAVE_WINAPIFAMILY_H 0
+#endif
+
+/* If _USING_V110_SDK71_ is defined it means we are using the Windows XP toolset. */
+#elif defined(_MSC_VER) && (_MSC_VER >= 1700 && !_USING_V110_SDK71_) /* _MSC_VER == 1700 for Visual Studio 2012 */
+#define HAVE_WINAPIFAMILY_H 1
+#else
+#define HAVE_WINAPIFAMILY_H 0
+#endif
+
+#if HAVE_WINAPIFAMILY_H
+#include <winapifamily.h>
+#define WINAPI_FAMILY_WINRT (!WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) && WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP))
+#else
+#define WINAPI_FAMILY_WINRT 0
+#endif /* HAVE_WINAPIFAMILY_H */
+
+#if WINAPI_FAMILY_WINRT
+#undef __WINRT__
+#define __WINRT__ 1
+#endif
+
+/* MSVC obviously has to have some non-standard constants... */
+#if _M_IX86_FP == 1
+#define __SSE__ 1
+#elif _M_IX86_FP == 2 || (defined(_M_AMD64) || defined(_M_X64))
+#define __SSE__ 1
+#define __SSE2__ 1
+#endif
+
+#endif
+
+#endif
diff --git a/libretro-common/include/retro_inline.h b/libretro-common/include/retro_inline.h
index e4a21f6..b27d6dd 100644
--- a/libretro-common/include/retro_inline.h
+++ b/libretro-common/include/retro_inline.h
@@ -1,4 +1,4 @@
-/* Copyright (C) 2010-2018 The RetroArch team
+/* Copyright (C) 2010-2020 The RetroArch team
*
* ---------------------------------------------------------------------------------------
* The following license statement only applies to this file (retro_inline.h).
diff --git a/libretro-common/include/retro_miscellaneous.h b/libretro-common/include/retro_miscellaneous.h
index 02aa521..f0dfb5c 100644
--- a/libretro-common/include/retro_miscellaneous.h
+++ b/libretro-common/include/retro_miscellaneous.h
@@ -1,4 +1,4 @@
-/* Copyright (C) 2010-2017 The RetroArch team
+/* Copyright (C) 2010-2020 The RetroArch team
*
* ---------------------------------------------------------------------------------------
* The following license statement only applies to this file (retro_miscellaneous.h).
@@ -23,17 +23,24 @@
#ifndef __RARCH_MISCELLANEOUS_H
#define __RARCH_MISCELLANEOUS_H
+#define RARCH_MAX_SUBSYSTEMS 10
+#define RARCH_MAX_SUBSYSTEM_ROMS 10
+
#include <stdint.h>
#include <boolean.h>
#include <retro_inline.h>
-#if defined(_WIN32) && !defined(_XBOX)
+#if defined(_WIN32)
+
+#if defined(_XBOX)
+#include <Xtl.h>
+#else
#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#endif
#include <windows.h>
-#elif defined(_WIN32) && defined(_XBOX)
-#include <Xtl.h>
+#endif
+
#endif
#include <limits.h>
@@ -68,7 +75,7 @@ static INLINE bool bits_any_set(uint32_t* ptr, uint32_t count)
}
#ifndef PATH_MAX_LENGTH
-#if defined(_XBOX1) || defined(_3DS) || defined(PSP) || defined(GEKKO)|| defined(WIIU)
+#if defined(_XBOX1) || defined(_3DS) || defined(PSP) || defined(PS2) || defined(GEKKO)|| defined(WIIU) || defined(ORBIS) || defined(__PSL1GHT__) || defined(__PS3__)
#define PATH_MAX_LENGTH 512
#else
#define PATH_MAX_LENGTH 4096
@@ -97,8 +104,8 @@ static INLINE bool bits_any_set(uint32_t* ptr, uint32_t count)
#define BIT16_GET(a, bit) (((a) >> ((bit) & 15)) & 1)
#define BIT16_CLEAR_ALL(a) ((a) = 0)
-#define BIT32_SET(a, bit) ((a) |= (1 << ((bit) & 31)))
-#define BIT32_CLEAR(a, bit) ((a) &= ~(1 << ((bit) & 31)))
+#define BIT32_SET(a, bit) ((a) |= (UINT32_C(1) << ((bit) & 31)))
+#define BIT32_CLEAR(a, bit) ((a) &= ~(UINT32_C(1) << ((bit) & 31)))
#define BIT32_GET(a, bit) (((a) >> ((bit) & 31)) & 1)
#define BIT32_CLEAR_ALL(a) ((a) = 0)
@@ -107,8 +114,8 @@ static INLINE bool bits_any_set(uint32_t* ptr, uint32_t count)
#define BIT64_GET(a, bit) (((a) >> ((bit) & 63)) & 1)
#define BIT64_CLEAR_ALL(a) ((a) = 0)
-#define BIT128_SET(a, bit) ((a).data[(bit) >> 5] |= (1 << ((bit) & 31)))
-#define BIT128_CLEAR(a, bit) ((a).data[(bit) >> 5] &= ~(1 << ((bit) & 31)))
+#define BIT128_SET(a, bit) ((a).data[(bit) >> 5] |= (UINT32_C(1) << ((bit) & 31)))
+#define BIT128_CLEAR(a, bit) ((a).data[(bit) >> 5] &= ~(UINT32_C(1) << ((bit) & 31)))
#define BIT128_GET(a, bit) (((a).data[(bit) >> 5] >> ((bit) & 31)) & 1)
#define BIT128_CLEAR_ALL(a) memset(&(a), 0, sizeof(a))
@@ -127,6 +134,16 @@ static INLINE bool bits_any_set(uint32_t* ptr, uint32_t count)
#define BIT256_GET_PTR(a, bit) BIT256_GET(*a, bit)
#define BIT256_CLEAR_ALL_PTR(a) BIT256_CLEAR_ALL(*a)
+#define BIT512_SET(a, bit) BIT256_SET(a, bit)
+#define BIT512_CLEAR(a, bit) BIT256_CLEAR(a, bit)
+#define BIT512_GET(a, bit) BIT256_GET(a, bit)
+#define BIT512_CLEAR_ALL(a) BIT256_CLEAR_ALL(a)
+
+#define BIT512_SET_PTR(a, bit) BIT512_SET(*a, bit)
+#define BIT512_CLEAR_PTR(a, bit) BIT512_CLEAR(*a, bit)
+#define BIT512_GET_PTR(a, bit) BIT512_GET(*a, bit)
+#define BIT512_CLEAR_ALL_PTR(a) BIT512_CLEAR_ALL(*a)
+
#define BITS_COPY16_PTR(a,bits) \
{ \
BIT128_CLEAR_ALL_PTR(a); \
@@ -139,6 +156,13 @@ static INLINE bool bits_any_set(uint32_t* ptr, uint32_t count)
BITS_GET_ELEM_PTR(a, 0) = (bits); \
}
+#define BITS_COPY64_PTR(a,bits) \
+{ \
+ BIT128_CLEAR_ALL_PTR(a); \
+ BITS_GET_ELEM_PTR(a, 0) = (bits); \
+ BITS_GET_ELEM_PTR(a, 1) = (bits >> 32); \
+}
+
/* Helper macros and struct to keep track of many booleans. */
/* This struct has 256 bits. */
typedef struct
@@ -146,4 +170,34 @@ typedef struct
uint32_t data[8];
} retro_bits_t;
+/* This struct has 512 bits. */
+typedef struct
+{
+ uint32_t data[16];
+} retro_bits_512_t;
+
+#ifdef _WIN32
+# ifdef _WIN64
+# define PRI_SIZET PRIu64
+# else
+# if _MSC_VER == 1800
+# define PRI_SIZET PRIu32
+# else
+# define PRI_SIZET "u"
+# endif
+# endif
+#elif defined(PS2)
+# define PRI_SIZET "u"
+#else
+# if (SIZE_MAX == 0xFFFF)
+# define PRI_SIZET "hu"
+# elif (SIZE_MAX == 0xFFFFFFFF)
+# define PRI_SIZET "u"
+# elif (SIZE_MAX == 0xFFFFFFFFFFFFFFFF)
+# define PRI_SIZET "lu"
+# else
+# error PRI_SIZET: unknown SIZE_MAX
+# endif
+#endif
+
#endif
diff --git a/libretro-common/include/streams/file_stream.h b/libretro-common/include/streams/file_stream.h
new file mode 100644
index 0000000..ab198b2
--- /dev/null
+++ b/libretro-common/include/streams/file_stream.h
@@ -0,0 +1,115 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (file_stream.h).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef __LIBRETRO_SDK_FILE_STREAM_H
+#define __LIBRETRO_SDK_FILE_STREAM_H
+
+#include <stdio.h>
+#include <stdint.h>
+#include <stdlib.h>
+#include <stddef.h>
+
+#include <sys/types.h>
+
+#include <libretro.h>
+#include <retro_common_api.h>
+#include <retro_inline.h>
+#include <boolean.h>
+
+#include <stdarg.h>
+#include <vfs/vfs_implementation.h>
+
+#define FILESTREAM_REQUIRED_VFS_VERSION 2
+
+RETRO_BEGIN_DECLS
+
+typedef struct RFILE RFILE;
+
+#define FILESTREAM_REQUIRED_VFS_VERSION 2
+
+void filestream_vfs_init(const struct retro_vfs_interface_info* vfs_info);
+
+int64_t filestream_get_size(RFILE *stream);
+
+int64_t filestream_truncate(RFILE *stream, int64_t length);
+
+/**
+ * filestream_open:
+ * @path : path to file
+ * @mode : file mode to use when opening (read/write)
+ * @bufsize : optional buffer size (-1 or 0 to use default)
+ *
+ * Opens a file for reading or writing, depending on the requested mode.
+ * Returns a pointer to an RFILE if opened successfully, otherwise NULL.
+ **/
+RFILE* filestream_open(const char *path, unsigned mode, unsigned hints);
+
+int64_t filestream_seek(RFILE *stream, int64_t offset, int seek_position);
+
+int64_t filestream_read(RFILE *stream, void *data, int64_t len);
+
+int64_t filestream_write(RFILE *stream, const void *data, int64_t len);
+
+int64_t filestream_tell(RFILE *stream);
+
+void filestream_rewind(RFILE *stream);
+
+int filestream_close(RFILE *stream);
+
+int64_t filestream_read_file(const char *path, void **buf, int64_t *len);
+
+char* filestream_gets(RFILE *stream, char *s, size_t len);
+
+int filestream_getc(RFILE *stream);
+
+int filestream_scanf(RFILE *stream, const char* format, ...);
+
+int filestream_eof(RFILE *stream);
+
+bool filestream_write_file(const char *path, const void *data, int64_t size);
+
+int filestream_putc(RFILE *stream, int c);
+
+int filestream_vprintf(RFILE *stream, const char* format, va_list args);
+
+int filestream_printf(RFILE *stream, const char* format, ...);
+
+int filestream_error(RFILE *stream);
+
+int filestream_flush(RFILE *stream);
+
+int filestream_delete(const char *path);
+
+int filestream_rename(const char *old_path, const char *new_path);
+
+const char* filestream_get_path(RFILE *stream);
+
+bool filestream_exists(const char *path);
+
+/* Returned pointer must be freed by the caller. */
+char* filestream_getline(RFILE *stream);
+
+libretro_vfs_implementation_file* filestream_get_vfs_handle(RFILE *stream);
+
+RETRO_END_DECLS
+
+#endif
diff --git a/libretro-common/include/string/stdstring.h b/libretro-common/include/string/stdstring.h
new file mode 100644
index 0000000..e7087d6
--- /dev/null
+++ b/libretro-common/include/string/stdstring.h
@@ -0,0 +1,250 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (stdstring.h).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef __LIBRETRO_SDK_STDSTRING_H
+#define __LIBRETRO_SDK_STDSTRING_H
+
+#include <stdlib.h>
+#include <stddef.h>
+#include <ctype.h>
+#include <string.h>
+#include <boolean.h>
+
+#include <retro_common_api.h>
+#include <retro_inline.h>
+#include <compat/strl.h>
+
+RETRO_BEGIN_DECLS
+
+#define STRLEN_CONST(x) ((sizeof((x))-1))
+
+#define strcpy_literal(a, b) strcpy(a, b)
+
+#define string_is_not_equal(a, b) !string_is_equal((a), (b))
+
+#define string_is_not_equal_fast(a, b, size) (memcmp(a, b, size) != 0)
+#define string_is_equal_fast(a, b, size) (memcmp(a, b, size) == 0)
+
+#define TOLOWER(c) ((c) | (lr_char_props[(unsigned char)(c)] & 0x20))
+#define TOUPPER(c) ((c) & ~(lr_char_props[(unsigned char)(c)] & 0x20))
+
+/* C standard says \f \v are space, but this one disagrees */
+#define ISSPACE(c) (lr_char_props[(unsigned char)(c)] & 0x80)
+
+#define ISDIGIT(c) (lr_char_props[(unsigned char)(c)] & 0x40)
+#define ISALPHA(c) (lr_char_props[(unsigned char)(c)] & 0x20)
+#define ISLOWER(c) (lr_char_props[(unsigned char)(c)] & 0x04)
+#define ISUPPER(c) (lr_char_props[(unsigned char)(c)] & 0x02)
+#define ISALNUM(c) (lr_char_props[(unsigned char)(c)] & 0x60)
+#define ISUALPHA(c) (lr_char_props[(unsigned char)(c)] & 0x28)
+#define ISUALNUM(c) (lr_char_props[(unsigned char)(c)] & 0x68)
+#define IS_XDIGIT(c) (lr_char_props[(unsigned char)(c)] & 0x01)
+
+/* Deprecated alias, all callers should use string_is_equal_case_insensitive instead */
+#define string_is_equal_noncase string_is_equal_case_insensitive
+
+static INLINE bool string_is_empty(const char *data)
+{
+ return !data || (*data == '\0');
+}
+
+static INLINE bool string_is_equal(const char *a, const char *b)
+{
+ return (a && b) ? !strcmp(a, b) : false;
+}
+
+static INLINE bool string_starts_with_size(const char *str, const char *prefix,
+ size_t size)
+{
+ return (str && prefix) ? !strncmp(prefix, str, size) : false;
+}
+
+static INLINE bool string_starts_with(const char *str, const char *prefix)
+{
+ return (str && prefix) ? !strncmp(prefix, str, strlen(prefix)) : false;
+}
+
+static INLINE bool string_ends_with_size(const char *str, const char *suffix,
+ size_t str_len, size_t suffix_len)
+{
+ return (str_len < suffix_len) ? false :
+ !memcmp(suffix, str + (str_len - suffix_len), suffix_len);
+}
+
+static INLINE bool string_ends_with(const char *str, const char *suffix)
+{
+ if (!str || !suffix)
+ return false;
+ return string_ends_with_size(str, suffix, strlen(str), strlen(suffix));
+}
+
+/* Returns the length of 'str' (c.f. strlen()), but only
+ * checks the first 'size' characters
+ * - If 'str' is NULL, returns 0
+ * - If 'str' is not NULL and no '\0' character is found
+ * in the first 'size' characters, returns 'size' */
+static INLINE size_t strlen_size(const char *str, size_t size)
+{
+ size_t i = 0;
+ if (str)
+ while (i < size && str[i]) i++;
+ return i;
+}
+
+
+static INLINE bool string_is_equal_case_insensitive(const char *a,
+ const char *b)
+{
+ int result = 0;
+ const unsigned char *p1 = (const unsigned char*)a;
+ const unsigned char *p2 = (const unsigned char*)b;
+
+ if (!a || !b)
+ return false;
+ if (p1 == p2)
+ return true;
+
+ while ((result = tolower (*p1) - tolower (*p2++)) == 0)
+ if (*p1++ == '\0')
+ break;
+
+ return (result == 0);
+}
+
+char *string_to_upper(char *s);
+
+char *string_to_lower(char *s);
+
+char *string_ucwords(char *s);
+
+char *string_replace_substring(const char *in, const char *pattern,
+ const char *by);
+
+/* Remove leading whitespaces */
+char *string_trim_whitespace_left(char *const s);
+
+/* Remove trailing whitespaces */
+char *string_trim_whitespace_right(char *const s);
+
+/* Remove leading and trailing whitespaces */
+char *string_trim_whitespace(char *const s);
+
+/*
+ * Wraps string specified by 'src' to destination buffer
+ * specified by 'dst' and 'dst_size'.
+ * This function assumes that all glyphs in the string
+ * have an on-screen pixel width similar to that of
+ * regular Latin characters - i.e. it will not wrap
+ * correctly any text containing so-called 'wide' Unicode
+ * characters (e.g. CJK languages, emojis, etc.).
+ *
+ * @param dst pointer to destination buffer.
+ * @param dst_size size of destination buffer.
+ * @param src pointer to input string.
+ * @param line_width max number of characters per line.
+ * @param wideglyph_width not used, but is necessary to keep
+ * compatibility with word_wrap_wideglyph().
+ * @param max_lines max lines of destination string.
+ * 0 means no limit.
+ */
+void word_wrap(char *dst, size_t dst_size, const char *src,
+ int line_width, int wideglyph_width, unsigned max_lines);
+
+/*
+ * Wraps string specified by 'src' to destination buffer
+ * specified by 'dst' and 'dst_size'.
+ * This function assumes that all glyphs in the string
+ * are:
+ * - EITHER 'non-wide' Unicode glyphs, with an on-screen
+ * pixel width similar to that of regular Latin characters
+ * - OR 'wide' Unicode glyphs (e.g. CJK languages, emojis, etc.)
+ * with an on-screen pixel width defined by 'wideglyph_width'
+ * Note that wrapping may occur in inappropriate locations
+ * if 'src' string contains 'wide' Unicode characters whose
+ * on-screen pixel width deviates greatly from the set
+ * 'wideglyph_width' value.
+ *
+ * @param dst pointer to destination buffer.
+ * @param dst_size size of destination buffer.
+ * @param src pointer to input string.
+ * @param line_width max number of characters per line.
+ * @param wideglyph_width effective width of 'wide' Unicode glyphs.
+ * the value here is normalised relative to the
+ * typical on-screen pixel width of a regular
+ * Latin character:
+ * - a regular Latin character is defined to
+ * have an effective width of 100
+ * - wideglyph_width = 100 * (wide_character_pixel_width / latin_character_pixel_width)
+ * - e.g. if 'wide' Unicode characters in 'src'
+ * have an on-screen pixel width twice that of
+ * regular Latin characters, wideglyph_width
+ * would be 200
+ * @param max_lines max lines of destination string.
+ * 0 means no limit.
+ */
+void word_wrap_wideglyph(char *dst, size_t dst_size, const char *src,
+ int line_width, int wideglyph_width, unsigned max_lines);
+
+/* Splits string into tokens seperated by 'delim'
+ * > Returned token string must be free()'d
+ * > Returns NULL if token is not found
+ * > After each call, 'str' is set to the position after the
+ * last found token
+ * > Tokens *include* empty strings
+ * Usage example:
+ * char *str = "1,2,3,4,5,6,7,,,10,";
+ * char **str_ptr = &str;
+ * char *token = NULL;
+ * while ((token = string_tokenize(str_ptr, ",")))
+ * {
+ * printf("%s\n", token);
+ * free(token);
+ * token = NULL;
+ * }
+ */
+char* string_tokenize(char **str, const char *delim);
+
+/* Removes every instance of character 'c' from 'str' */
+void string_remove_all_chars(char *str, char c);
+
+/* Replaces every instance of character 'find' in 'str'
+ * with character 'replace' */
+void string_replace_all_chars(char *str, char find, char replace);
+
+/* Converts string to unsigned integer.
+ * Returns 0 if string is invalid */
+unsigned string_to_unsigned(const char *str);
+
+/* Converts hexadecimal string to unsigned integer.
+ * Handles optional leading '0x'.
+ * Returns 0 if string is invalid */
+unsigned string_hex_to_unsigned(const char *str);
+
+char *string_init(const char *src);
+
+void string_set(char **string, const char *src);
+
+extern const unsigned char lr_char_props[256];
+
+RETRO_END_DECLS
+
+#endif
diff --git a/libretro-common/include/time/rtime.h b/libretro-common/include/time/rtime.h
new file mode 100644
index 0000000..7629c1e
--- /dev/null
+++ b/libretro-common/include/time/rtime.h
@@ -0,0 +1,48 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (rtime.h).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifndef __LIBRETRO_SDK_RTIME_H__
+#define __LIBRETRO_SDK_RTIME_H__
+
+#include <retro_common_api.h>
+
+#include <stdint.h>
+#include <stddef.h>
+#include <time.h>
+
+RETRO_BEGIN_DECLS
+
+/* TODO/FIXME: Move all generic time handling functions
+ * to this file */
+
+/* Must be called before using rtime_localtime() */
+void rtime_init(void);
+
+/* Must be called upon program termination */
+void rtime_deinit(void);
+
+/* Thread-safe wrapper for localtime() */
+struct tm *rtime_localtime(const time_t *timep, struct tm *result);
+
+RETRO_END_DECLS
+
+#endif
diff --git a/libretro-common/include/vfs/vfs.h b/libretro-common/include/vfs/vfs.h
new file mode 100644
index 0000000..5366f33
--- /dev/null
+++ b/libretro-common/include/vfs/vfs.h
@@ -0,0 +1,111 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+*
+* ---------------------------------------------------------------------------------------
+* The following license statement only applies to this file (vfs_implementation.h).
+* ---------------------------------------------------------------------------------------
+*
+* Permission is hereby granted, free of charge,
+* to any person obtaining a copy of this software and associated documentation files (the "Software"),
+* to deal in the Software without restriction, including without limitation the rights to
+* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+* and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+
+#ifndef __LIBRETRO_SDK_VFS_H
+#define __LIBRETRO_SDK_VFS_H
+
+#include <retro_common_api.h>
+#include <boolean.h>
+
+#ifdef RARCH_INTERNAL
+#ifndef VFS_FRONTEND
+#define VFS_FRONTEND
+#endif
+#endif
+
+RETRO_BEGIN_DECLS
+
+#ifdef _WIN32
+typedef void* HANDLE;
+#endif
+
+#ifdef HAVE_CDROM
+typedef struct
+{
+ int64_t byte_pos;
+ char *cue_buf;
+ size_t cue_len;
+ unsigned cur_lba;
+ unsigned last_frame_lba;
+ unsigned char cur_min;
+ unsigned char cur_sec;
+ unsigned char cur_frame;
+ unsigned char cur_track;
+ unsigned char last_frame[2352];
+ char drive;
+ bool last_frame_valid;
+} vfs_cdrom_t;
+#endif
+
+enum vfs_scheme
+{
+ VFS_SCHEME_NONE = 0,
+ VFS_SCHEME_CDROM
+};
+
+#ifndef __WINRT__
+#ifdef VFS_FRONTEND
+struct retro_vfs_file_handle
+#else
+struct libretro_vfs_implementation_file
+#endif
+{
+#ifdef HAVE_CDROM
+ vfs_cdrom_t cdrom; /* int64_t alignment */
+#endif
+ int64_t size;
+ uint64_t mappos;
+ uint64_t mapsize;
+ FILE *fp;
+#ifdef _WIN32
+ HANDLE fh;
+#endif
+ char *buf;
+ char* orig_path;
+ uint8_t *mapped;
+ int fd;
+ unsigned hints;
+ enum vfs_scheme scheme;
+};
+#endif
+
+/* Replace the following symbol with something appropriate
+ * to signify the file is being compiled for a front end instead of a core.
+ * This allows the same code to act as reference implementation
+ * for VFS and as fallbacks for when the front end does not provide VFS functionality.
+ */
+
+#ifdef VFS_FRONTEND
+typedef struct retro_vfs_file_handle libretro_vfs_implementation_file;
+#else
+typedef struct libretro_vfs_implementation_file libretro_vfs_implementation_file;
+#endif
+
+#ifdef VFS_FRONTEND
+typedef struct retro_vfs_dir_handle libretro_vfs_implementation_dir;
+#else
+typedef struct libretro_vfs_implementation_dir libretro_vfs_implementation_dir;
+#endif
+
+RETRO_END_DECLS
+
+#endif
diff --git a/libretro-common/include/vfs/vfs_implementation.h b/libretro-common/include/vfs/vfs_implementation.h
new file mode 100644
index 0000000..c7d6bb0
--- /dev/null
+++ b/libretro-common/include/vfs/vfs_implementation.h
@@ -0,0 +1,76 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+*
+* ---------------------------------------------------------------------------------------
+* The following license statement only applies to this file (vfs_implementation.h).
+* ---------------------------------------------------------------------------------------
+*
+* Permission is hereby granted, free of charge,
+* to any person obtaining a copy of this software and associated documentation files (the "Software"),
+* to deal in the Software without restriction, including without limitation the rights to
+* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+* and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+
+#ifndef __LIBRETRO_SDK_VFS_IMPLEMENTATION_H
+#define __LIBRETRO_SDK_VFS_IMPLEMENTATION_H
+
+#include <stdio.h>
+#include <stdint.h>
+#include <libretro.h>
+#include <retro_environment.h>
+#include <vfs/vfs.h>
+
+RETRO_BEGIN_DECLS
+
+libretro_vfs_implementation_file *retro_vfs_file_open_impl(const char *path, unsigned mode, unsigned hints);
+
+int retro_vfs_file_close_impl(libretro_vfs_implementation_file *stream);
+
+int retro_vfs_file_error_impl(libretro_vfs_implementation_file *stream);
+
+int64_t retro_vfs_file_size_impl(libretro_vfs_implementation_file *stream);
+
+int64_t retro_vfs_file_truncate_impl(libretro_vfs_implementation_file *stream, int64_t length);
+
+int64_t retro_vfs_file_tell_impl(libretro_vfs_implementation_file *stream);
+
+int64_t retro_vfs_file_seek_impl(libretro_vfs_implementation_file *stream, int64_t offset, int seek_position);
+
+int64_t retro_vfs_file_read_impl(libretro_vfs_implementation_file *stream, void *s, uint64_t len);
+
+int64_t retro_vfs_file_write_impl(libretro_vfs_implementation_file *stream, const void *s, uint64_t len);
+
+int retro_vfs_file_flush_impl(libretro_vfs_implementation_file *stream);
+
+int retro_vfs_file_remove_impl(const char *path);
+
+int retro_vfs_file_rename_impl(const char *old_path, const char *new_path);
+
+const char *retro_vfs_file_get_path_impl(libretro_vfs_implementation_file *stream);
+
+int retro_vfs_stat_impl(const char *path, int32_t *size);
+
+int retro_vfs_mkdir_impl(const char *dir);
+
+libretro_vfs_implementation_dir *retro_vfs_opendir_impl(const char *dir, bool include_hidden);
+
+bool retro_vfs_readdir_impl(libretro_vfs_implementation_dir *dirstream);
+
+const char *retro_vfs_dirent_get_name_impl(libretro_vfs_implementation_dir *dirstream);
+
+bool retro_vfs_dirent_is_dir_impl(libretro_vfs_implementation_dir *dirstream);
+
+int retro_vfs_closedir_impl(libretro_vfs_implementation_dir *dirstream);
+
+RETRO_END_DECLS
+
+#endif
diff --git a/libretro-common/streams/file_stream.c b/libretro-common/streams/file_stream.c
new file mode 100644
index 0000000..c434237
--- /dev/null
+++ b/libretro-common/streams/file_stream.c
@@ -0,0 +1,663 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (file_stream.c).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <stdarg.h>
+#include <ctype.h>
+#include <errno.h>
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#ifdef _MSC_VER
+#include <compat/msvc.h>
+#endif
+
+#include <string/stdstring.h>
+#include <streams/file_stream.h>
+#define VFS_FRONTEND
+#include <vfs/vfs_implementation.h>
+
+#define VFS_ERROR_RETURN_VALUE -1
+
+struct RFILE
+{
+ struct retro_vfs_file_handle *hfile;
+ bool error_flag;
+ bool eof_flag;
+};
+
+static retro_vfs_get_path_t filestream_get_path_cb = NULL;
+static retro_vfs_open_t filestream_open_cb = NULL;
+static retro_vfs_close_t filestream_close_cb = NULL;
+static retro_vfs_size_t filestream_size_cb = NULL;
+static retro_vfs_truncate_t filestream_truncate_cb = NULL;
+static retro_vfs_tell_t filestream_tell_cb = NULL;
+static retro_vfs_seek_t filestream_seek_cb = NULL;
+static retro_vfs_read_t filestream_read_cb = NULL;
+static retro_vfs_write_t filestream_write_cb = NULL;
+static retro_vfs_flush_t filestream_flush_cb = NULL;
+static retro_vfs_remove_t filestream_remove_cb = NULL;
+static retro_vfs_rename_t filestream_rename_cb = NULL;
+
+/* VFS Initialization */
+
+void filestream_vfs_init(const struct retro_vfs_interface_info* vfs_info)
+{
+ const struct retro_vfs_interface *
+ vfs_iface = vfs_info->iface;
+
+ filestream_get_path_cb = NULL;
+ filestream_open_cb = NULL;
+ filestream_close_cb = NULL;
+ filestream_tell_cb = NULL;
+ filestream_size_cb = NULL;
+ filestream_truncate_cb = NULL;
+ filestream_seek_cb = NULL;
+ filestream_read_cb = NULL;
+ filestream_write_cb = NULL;
+ filestream_flush_cb = NULL;
+ filestream_remove_cb = NULL;
+ filestream_rename_cb = NULL;
+
+ if (
+ (vfs_info->required_interface_version <
+ FILESTREAM_REQUIRED_VFS_VERSION)
+ || !vfs_iface)
+ return;
+
+ filestream_get_path_cb = vfs_iface->get_path;
+ filestream_open_cb = vfs_iface->open;
+ filestream_close_cb = vfs_iface->close;
+ filestream_size_cb = vfs_iface->size;
+ filestream_truncate_cb = vfs_iface->truncate;
+ filestream_tell_cb = vfs_iface->tell;
+ filestream_seek_cb = vfs_iface->seek;
+ filestream_read_cb = vfs_iface->read;
+ filestream_write_cb = vfs_iface->write;
+ filestream_flush_cb = vfs_iface->flush;
+ filestream_remove_cb = vfs_iface->remove;
+ filestream_rename_cb = vfs_iface->rename;
+}
+
+/* Callback wrappers */
+bool filestream_exists(const char *path)
+{
+ RFILE *dummy = NULL;
+
+ if (!path || !*path)
+ return false;
+
+ dummy = filestream_open(
+ path,
+ RETRO_VFS_FILE_ACCESS_READ,
+ RETRO_VFS_FILE_ACCESS_HINT_NONE);
+
+ if (!dummy)
+ return false;
+
+ if (filestream_close(dummy) != 0)
+ if (dummy)
+ free(dummy);
+
+ dummy = NULL;
+ return true;
+}
+
+int64_t filestream_get_size(RFILE *stream)
+{
+ int64_t output;
+
+ if (filestream_size_cb)
+ output = filestream_size_cb(stream->hfile);
+ else
+ output = retro_vfs_file_size_impl(
+ (libretro_vfs_implementation_file*)stream->hfile);
+
+ if (output == VFS_ERROR_RETURN_VALUE)
+ stream->error_flag = true;
+
+ return output;
+}
+
+int64_t filestream_truncate(RFILE *stream, int64_t length)
+{
+ int64_t output;
+
+ if (filestream_truncate_cb)
+ output = filestream_truncate_cb(stream->hfile, length);
+ else
+ output = retro_vfs_file_truncate_impl(
+ (libretro_vfs_implementation_file*)stream->hfile, length);
+
+ if (output == VFS_ERROR_RETURN_VALUE)
+ stream->error_flag = true;
+
+ return output;
+}
+
+/**
+ * filestream_open:
+ * @path : path to file
+ * @mode : file mode to use when opening (read/write)
+ * @hints :
+ *
+ * Opens a file for reading or writing, depending on the requested mode.
+ * Returns a pointer to an RFILE if opened successfully, otherwise NULL.
+ **/
+RFILE* filestream_open(const char *path, unsigned mode, unsigned hints)
+{
+ struct retro_vfs_file_handle *fp = NULL;
+ RFILE* output = NULL;
+
+ if (filestream_open_cb)
+ fp = (struct retro_vfs_file_handle*)
+ filestream_open_cb(path, mode, hints);
+ else
+ fp = (struct retro_vfs_file_handle*)
+ retro_vfs_file_open_impl(path, mode, hints);
+
+ if (!fp)
+ return NULL;
+
+ output = (RFILE*)malloc(sizeof(RFILE));
+ output->error_flag = false;
+ output->eof_flag = false;
+ output->hfile = fp;
+ return output;
+}
+
+char* filestream_gets(RFILE *stream, char *s, size_t len)
+{
+ int c = 0;
+ char *p = s;
+ if (!stream)
+ return NULL;
+
+ /* get max bytes or up to a newline */
+
+ for (len--; len > 0; len--)
+ {
+ if ((c = filestream_getc(stream)) == EOF)
+ break;
+ *p++ = c;
+ if (c == '\n')
+ break;
+ }
+ *p = 0;
+
+ if (p == s && c == EOF)
+ return NULL;
+ return (s);
+}
+
+int filestream_getc(RFILE *stream)
+{
+ char c = 0;
+ if (stream && filestream_read(stream, &c, 1) == 1)
+ return (int)(unsigned char)c;
+ return EOF;
+}
+
+int filestream_scanf(RFILE *stream, const char* format, ...)
+{
+ char buf[4096];
+ char subfmt[64];
+ va_list args;
+ const char * bufiter = buf;
+ int ret = 0;
+ int64_t startpos = filestream_tell(stream);
+ int64_t maxlen = filestream_read(stream, buf, sizeof(buf)-1);
+
+ if (maxlen <= 0)
+ return EOF;
+
+ buf[maxlen] = '\0';
+
+ va_start(args, format);
+
+ while (*format)
+ {
+ if (*format == '%')
+ {
+ int sublen;
+ char* subfmtiter = subfmt;
+ bool asterisk = false;
+
+ *subfmtiter++ = *format++; /* '%' */
+
+ /* %[*][width][length]specifier */
+
+ if (*format == '*')
+ {
+ asterisk = true;
+ *subfmtiter++ = *format++;
+ }
+
+ while (ISDIGIT((unsigned char)*format))
+ *subfmtiter++ = *format++; /* width */
+
+ /* length */
+ if (*format == 'h' || *format == 'l')
+ {
+ if (format[1] == format[0])
+ *subfmtiter++ = *format++;
+ *subfmtiter++ = *format++;
+ }
+ else if (
+ *format == 'j' ||
+ *format == 'z' ||
+ *format == 't' ||
+ *format == 'L')
+ {
+ *subfmtiter++ = *format++;
+ }
+
+ /* specifier - always a single character (except ]) */
+ if (*format == '[')
+ {
+ while (*format != ']')
+ *subfmtiter++ = *format++;
+ *subfmtiter++ = *format++;
+ }
+ else
+ *subfmtiter++ = *format++;
+
+ *subfmtiter++ = '%';
+ *subfmtiter++ = 'n';
+ *subfmtiter++ = '\0';
+
+ if (sizeof(void*) != sizeof(long*))
+ abort(); /* all pointers must have the same size */
+
+ if (asterisk)
+ {
+ int v = sscanf(bufiter, subfmt, &sublen);
+ if (v == EOF)
+ return EOF;
+ if (v != 0)
+ break;
+ }
+ else
+ {
+ int v = sscanf(bufiter, subfmt, va_arg(args, void*), &sublen);
+ if (v == EOF)
+ return EOF;
+ if (v != 1)
+ break;
+ }
+
+ ret++;
+ bufiter += sublen;
+ }
+ else if (isspace((unsigned char)*format))
+ {
+ while (isspace((unsigned char)*bufiter))
+ bufiter++;
+ format++;
+ }
+ else
+ {
+ if (*bufiter != *format)
+ break;
+ bufiter++;
+ format++;
+ }
+ }
+
+ va_end(args);
+ filestream_seek(stream, startpos+(bufiter-buf),
+ RETRO_VFS_SEEK_POSITION_START);
+
+ return ret;
+}
+
+int64_t filestream_seek(RFILE *stream, int64_t offset, int seek_position)
+{
+ int64_t output;
+
+ if (filestream_seek_cb)
+ output = filestream_seek_cb(stream->hfile, offset, seek_position);
+ else
+ output = retro_vfs_file_seek_impl(
+ (libretro_vfs_implementation_file*)stream->hfile,
+ offset, seek_position);
+
+ if (output == VFS_ERROR_RETURN_VALUE)
+ stream->error_flag = true;
+
+ stream->eof_flag = false;
+
+ return output;
+}
+
+int filestream_eof(RFILE *stream)
+{
+ return stream->eof_flag;
+}
+
+int64_t filestream_tell(RFILE *stream)
+{
+ int64_t output;
+
+ if (filestream_size_cb)
+ output = filestream_tell_cb(stream->hfile);
+ else
+ output = retro_vfs_file_tell_impl(
+ (libretro_vfs_implementation_file*)stream->hfile);
+
+ if (output == VFS_ERROR_RETURN_VALUE)
+ stream->error_flag = true;
+
+ return output;
+}
+
+void filestream_rewind(RFILE *stream)
+{
+ if (!stream)
+ return;
+ filestream_seek(stream, 0L, RETRO_VFS_SEEK_POSITION_START);
+ stream->error_flag = false;
+ stream->eof_flag = false;
+}
+
+int64_t filestream_read(RFILE *stream, void *s, int64_t len)
+{
+ int64_t output;
+
+ if (filestream_read_cb)
+ output = filestream_read_cb(stream->hfile, s, len);
+ else
+ output = retro_vfs_file_read_impl(
+ (libretro_vfs_implementation_file*)stream->hfile, s, len);
+
+ if (output == VFS_ERROR_RETURN_VALUE)
+ stream->error_flag = true;
+ if (output < len)
+ stream->eof_flag = true;
+
+ return output;
+}
+
+int filestream_flush(RFILE *stream)
+{
+ int output;
+
+ if (filestream_flush_cb)
+ output = filestream_flush_cb(stream->hfile);
+ else
+ output = retro_vfs_file_flush_impl(
+ (libretro_vfs_implementation_file*)stream->hfile);
+
+ if (output == VFS_ERROR_RETURN_VALUE)
+ stream->error_flag = true;
+
+ return output;
+}
+
+int filestream_delete(const char *path)
+{
+ if (filestream_remove_cb)
+ return filestream_remove_cb(path);
+
+ return retro_vfs_file_remove_impl(path);
+}
+
+int filestream_rename(const char *old_path, const char *new_path)
+{
+ if (filestream_rename_cb)
+ return filestream_rename_cb(old_path, new_path);
+
+ return retro_vfs_file_rename_impl(old_path, new_path);
+}
+
+const char* filestream_get_path(RFILE *stream)
+{
+ if (filestream_get_path_cb)
+ return filestream_get_path_cb(stream->hfile);
+
+ return retro_vfs_file_get_path_impl(
+ (libretro_vfs_implementation_file*)stream->hfile);
+}
+
+int64_t filestream_write(RFILE *stream, const void *s, int64_t len)
+{
+ int64_t output;
+
+ if (filestream_write_cb)
+ output = filestream_write_cb(stream->hfile, s, len);
+ else
+ output = retro_vfs_file_write_impl(
+ (libretro_vfs_implementation_file*)stream->hfile, s, len);
+
+ if (output == VFS_ERROR_RETURN_VALUE)
+ stream->error_flag = true;
+
+ return output;
+}
+
+int filestream_putc(RFILE *stream, int c)
+{
+ char c_char = (char)c;
+ if (!stream)
+ return EOF;
+ return filestream_write(stream, &c_char, 1) == 1
+ ? (int)(unsigned char)c
+ : EOF;
+}
+
+int filestream_vprintf(RFILE *stream, const char* format, va_list args)
+{
+ static char buffer[8 * 1024];
+ int64_t num_chars = vsnprintf(buffer, sizeof(buffer),
+ format, args);
+
+ if (num_chars < 0)
+ return -1;
+ else if (num_chars == 0)
+ return 0;
+
+ return (int)filestream_write(stream, buffer, num_chars);
+}
+
+int filestream_printf(RFILE *stream, const char* format, ...)
+{
+ va_list vl;
+ int result;
+ va_start(vl, format);
+ result = filestream_vprintf(stream, format, vl);
+ va_end(vl);
+ return result;
+}
+
+int filestream_error(RFILE *stream)
+{
+ if (stream && stream->error_flag)
+ return 1;
+ return 0;
+}
+
+int filestream_close(RFILE *stream)
+{
+ int output;
+ struct retro_vfs_file_handle* fp = stream->hfile;
+
+ if (filestream_close_cb)
+ output = filestream_close_cb(fp);
+ else
+ output = retro_vfs_file_close_impl(
+ (libretro_vfs_implementation_file*)fp);
+
+ if (output == 0)
+ free(stream);
+
+ return output;
+}
+
+/**
+ * filestream_read_file:
+ * @path : path to file.
+ * @buf : buffer to allocate and read the contents of the
+ * file into. Needs to be freed manually.
+ * @len : optional output integer containing bytes read.
+ *
+ * Read the contents of a file into @buf.
+ *
+ * Returns: non zero on success.
+ */
+int64_t filestream_read_file(const char *path, void **buf, int64_t *len)
+{
+ int64_t ret = 0;
+ int64_t content_buf_size = 0;
+ void *content_buf = NULL;
+ RFILE *file = filestream_open(path,
+ RETRO_VFS_FILE_ACCESS_READ,
+ RETRO_VFS_FILE_ACCESS_HINT_NONE);
+
+ if (!file)
+ {
+ *buf = NULL;
+ return 0;
+ }
+
+ content_buf_size = filestream_get_size(file);
+
+ if (content_buf_size < 0)
+ goto error;
+
+ content_buf = malloc((size_t)(content_buf_size + 1));
+
+ if (!content_buf)
+ goto error;
+ if ((int64_t)(uint64_t)(content_buf_size + 1) != (content_buf_size + 1))
+ goto error;
+
+ ret = filestream_read(file, content_buf, (int64_t)content_buf_size);
+ if (ret < 0)
+ goto error;
+
+ if (filestream_close(file) != 0)
+ if (file)
+ free(file);
+
+ *buf = content_buf;
+
+ /* Allow for easy reading of strings to be safe.
+ * Will only work with sane character formatting (Unix). */
+ ((char*)content_buf)[ret] = '\0';
+
+ if (len)
+ *len = ret;
+
+ return 1;
+
+error:
+ if (file)
+ if (filestream_close(file) != 0)
+ free(file);
+ if (content_buf)
+ free(content_buf);
+ if (len)
+ *len = -1;
+ *buf = NULL;
+ return 0;
+}
+
+/**
+ * filestream_write_file:
+ * @path : path to file.
+ * @data : contents to write to the file.
+ * @size : size of the contents.
+ *
+ * Writes data to a file.
+ *
+ * Returns: true (1) on success, false (0) otherwise.
+ */
+bool filestream_write_file(const char *path, const void *data, int64_t size)
+{
+ int64_t ret = 0;
+ RFILE *file = filestream_open(path,
+ RETRO_VFS_FILE_ACCESS_WRITE,
+ RETRO_VFS_FILE_ACCESS_HINT_NONE);
+ if (!file)
+ return false;
+
+ ret = filestream_write(file, data, size);
+ if (filestream_close(file) != 0)
+ if (file)
+ free(file);
+
+ if (ret != size)
+ return false;
+
+ return true;
+}
+
+/* Returned pointer must be freed by the caller. */
+char* filestream_getline(RFILE *stream)
+{
+ char *newline_tmp = NULL;
+ size_t cur_size = 8;
+ size_t idx = 0;
+ int in = 0;
+ char *newline = (char*)malloc(9);
+
+ if (!stream || !newline)
+ {
+ if (newline)
+ free(newline);
+ return NULL;
+ }
+
+ in = filestream_getc(stream);
+
+ while (in != EOF && in != '\n')
+ {
+ if (idx == cur_size)
+ {
+ cur_size *= 2;
+ newline_tmp = (char*)realloc(newline, cur_size + 1);
+
+ if (!newline_tmp)
+ {
+ free(newline);
+ return NULL;
+ }
+
+ newline = newline_tmp;
+ }
+
+ newline[idx++] = in;
+ in = filestream_getc(stream);
+ }
+
+ newline[idx] = '\0';
+ return newline;
+}
+
+libretro_vfs_implementation_file* filestream_get_vfs_handle(RFILE *stream)
+{
+ return (libretro_vfs_implementation_file*)stream->hfile;
+}
diff --git a/libretro-common/streams/file_stream_transforms.c b/libretro-common/streams/file_stream_transforms.c
new file mode 100644
index 0000000..099b27b
--- /dev/null
+++ b/libretro-common/streams/file_stream_transforms.c
@@ -0,0 +1,159 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+*
+* ---------------------------------------------------------------------------------------
+* The following license statement only applies to this file (file_stream_transforms.c).
+* ---------------------------------------------------------------------------------------
+*
+* Permission is hereby granted, free of charge,
+* to any person obtaining a copy of this software and associated documentation files (the "Software"),
+* to deal in the Software without restriction, including without limitation the rights to
+* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+* and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+
+#include <string.h>
+#include <stdarg.h>
+
+#include <libretro.h>
+#include <streams/file_stream.h>
+
+RFILE* rfopen(const char *path, const char *mode)
+{
+ RFILE *output = NULL;
+ unsigned int retro_mode = RETRO_VFS_FILE_ACCESS_READ;
+ bool position_to_end = false;
+
+ if (strstr(mode, "r"))
+ {
+ retro_mode = RETRO_VFS_FILE_ACCESS_READ;
+ if (strstr(mode, "+"))
+ {
+ retro_mode = RETRO_VFS_FILE_ACCESS_READ_WRITE |
+ RETRO_VFS_FILE_ACCESS_UPDATE_EXISTING;
+ }
+ }
+ else if (strstr(mode, "w"))
+ {
+ retro_mode = RETRO_VFS_FILE_ACCESS_WRITE;
+ if (strstr(mode, "+"))
+ retro_mode = RETRO_VFS_FILE_ACCESS_READ_WRITE;
+ }
+ else if (strstr(mode, "a"))
+ {
+ retro_mode = RETRO_VFS_FILE_ACCESS_WRITE |
+ RETRO_VFS_FILE_ACCESS_UPDATE_EXISTING;
+ position_to_end = true;
+ if (strstr(mode, "+"))
+ {
+ retro_mode = RETRO_VFS_FILE_ACCESS_READ_WRITE |
+ RETRO_VFS_FILE_ACCESS_UPDATE_EXISTING;
+ }
+ }
+
+ output = filestream_open(path, retro_mode,
+ RETRO_VFS_FILE_ACCESS_HINT_NONE);
+ if (output && position_to_end)
+ filestream_seek(output, 0, RETRO_VFS_SEEK_POSITION_END);
+
+ return output;
+}
+
+int rfclose(RFILE* stream)
+{
+ return filestream_close(stream);
+}
+
+int64_t rftell(RFILE* stream)
+{
+ return filestream_tell(stream);
+}
+
+int64_t rfseek(RFILE* stream, int64_t offset, int origin)
+{
+ int seek_position = -1;
+ switch (origin)
+ {
+ case SEEK_SET:
+ seek_position = RETRO_VFS_SEEK_POSITION_START;
+ break;
+ case SEEK_CUR:
+ seek_position = RETRO_VFS_SEEK_POSITION_CURRENT;
+ break;
+ case SEEK_END:
+ seek_position = RETRO_VFS_SEEK_POSITION_END;
+ break;
+ }
+
+ return filestream_seek(stream, offset, seek_position);
+}
+
+int64_t rfread(void* buffer,
+ size_t elem_size, size_t elem_count, RFILE* stream)
+{
+ return (filestream_read(stream, buffer, elem_size * elem_count) / elem_size);
+}
+
+char *rfgets(char *buffer, int maxCount, RFILE* stream)
+{
+ return filestream_gets(stream, buffer, maxCount);
+}
+
+int rfgetc(RFILE* stream)
+{
+ return filestream_getc(stream);
+}
+
+int64_t rfwrite(void const* buffer,
+ size_t elem_size, size_t elem_count, RFILE* stream)
+{
+ return filestream_write(stream, buffer, elem_size * elem_count);
+}
+
+int rfputc(int character, RFILE * stream)
+{
+ return filestream_putc(stream, character);
+}
+
+int64_t rfflush(RFILE * stream)
+{
+ return filestream_flush(stream);
+}
+
+int rfprintf(RFILE * stream, const char * format, ...)
+{
+ int result;
+ va_list vl;
+ va_start(vl, format);
+ result = filestream_vprintf(stream, format, vl);
+ va_end(vl);
+ return result;
+}
+
+int rferror(RFILE* stream)
+{
+ return filestream_error(stream);
+}
+
+int rfeof(RFILE* stream)
+{
+ return filestream_eof(stream);
+}
+
+int rfscanf(RFILE * stream, const char * format, ...)
+{
+ int result;
+ va_list vl;
+ va_start(vl, format);
+ result = filestream_scanf(stream, format, vl);
+ va_end(vl);
+ return result;
+}
diff --git a/libretro-common/string/stdstring.c b/libretro-common/string/stdstring.c
new file mode 100644
index 0000000..d637988
--- /dev/null
+++ b/libretro-common/string/stdstring.c
@@ -0,0 +1,536 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (stdstring.c).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include <stdint.h>
+#include <ctype.h>
+#include <string.h>
+
+#include <string/stdstring.h>
+#include <encodings/utf.h>
+
+const uint8_t lr_char_props[256] = {
+ /*x0 x1 x2 x3 x4 x5 x6 x7 x8 x9 xA xB xC xD xE xF */
+ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x80,0x80,0x00,0x00,0x80,0x00,0x00, /* 0x */
+ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, /* 1x */
+ 0x80,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, /* 2x !"#$%&'()*+,-./ */
+ 0x41,0x41,0x41,0x41,0x41,0x41,0x41,0x41,0x41,0x41,0x00,0x00,0x00,0x00,0x00,0x00, /* 3x 0123456789:;<=>? */
+ 0x00,0x23,0x23,0x23,0x23,0x23,0x23,0x22,0x22,0x22,0x22,0x22,0x22,0x22,0x22,0x22, /* 4x @ABCDEFGHIJKLMNO */
+ 0x22,0x22,0x22,0x22,0x22,0x22,0x22,0x22,0x22,0x22,0x22,0x00,0x00,0x00,0x00,0x08, /* 5x PQRSTUVWXYZ[\]^_ */
+ 0x00,0x25,0x25,0x25,0x25,0x25,0x25,0x24,0x24,0x24,0x24,0x24,0x24,0x24,0x24,0x24, /* 6x `abcdefghijklmno */
+ 0x24,0x24,0x24,0x24,0x24,0x24,0x24,0x24,0x24,0x24,0x24,0x00,0x00,0x00,0x00,0x00, /* 7x pqrstuvwxyz{|}~ */
+ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, /* 8x */
+ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, /* 9x */
+ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, /* Ax */
+ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, /* Bx */
+ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, /* Cx */
+ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, /* Dx */
+ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, /* Ex */
+ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00, /* Fx */
+};
+
+char *string_init(const char *src)
+{
+ return src ? strdup(src) : NULL;
+}
+
+void string_set(char **string, const char *src)
+{
+ free(*string);
+ *string = string_init(src);
+}
+
+
+char *string_to_upper(char *s)
+{
+ char *cs = (char *)s;
+ for ( ; *cs != '\0'; cs++)
+ *cs = toupper((unsigned char)*cs);
+ return s;
+}
+
+char *string_to_lower(char *s)
+{
+ char *cs = (char *)s;
+ for ( ; *cs != '\0'; cs++)
+ *cs = tolower((unsigned char)*cs);
+ return s;
+}
+
+char *string_ucwords(char *s)
+{
+ char *cs = (char *)s;
+ for ( ; *cs != '\0'; cs++)
+ {
+ if (*cs == ' ')
+ *(cs+1) = toupper((unsigned char)*(cs+1));
+ }
+
+ s[0] = toupper((unsigned char)s[0]);
+ return s;
+}
+
+char *string_replace_substring(const char *in,
+ const char *pattern, const char *replacement)
+{
+ size_t numhits, pattern_len, replacement_len, outlen;
+ const char *inat = NULL;
+ const char *inprev = NULL;
+ char *out = NULL;
+ char *outat = NULL;
+
+ /* if either pattern or replacement is NULL,
+ * duplicate in and let caller handle it. */
+ if (!pattern || !replacement)
+ return strdup(in);
+
+ pattern_len = strlen(pattern);
+ replacement_len = strlen(replacement);
+ numhits = 0;
+ inat = in;
+
+ while ((inat = strstr(inat, pattern)))
+ {
+ inat += pattern_len;
+ numhits++;
+ }
+
+ outlen = strlen(in) - pattern_len*numhits + replacement_len*numhits;
+ out = (char *)malloc(outlen+1);
+
+ if (!out)
+ return NULL;
+
+ outat = out;
+ inat = in;
+ inprev = in;
+
+ while ((inat = strstr(inat, pattern)))
+ {
+ memcpy(outat, inprev, inat-inprev);
+ outat += inat-inprev;
+ memcpy(outat, replacement, replacement_len);
+ outat += replacement_len;
+ inat += pattern_len;
+ inprev = inat;
+ }
+ strcpy(outat, inprev);
+
+ return out;
+}
+
+/* Remove leading whitespaces */
+char *string_trim_whitespace_left(char *const s)
+{
+ if (s && *s)
+ {
+ size_t len = strlen(s);
+ char *current = s;
+
+ while (*current && ISSPACE((unsigned char)*current))
+ {
+ ++current;
+ --len;
+ }
+
+ if (s != current)
+ memmove(s, current, len + 1);
+ }
+
+ return s;
+}
+
+/* Remove trailing whitespaces */
+char *string_trim_whitespace_right(char *const s)
+{
+ if (s && *s)
+ {
+ size_t len = strlen(s);
+ char *current = s + len - 1;
+
+ while (current != s && ISSPACE((unsigned char)*current))
+ {
+ --current;
+ --len;
+ }
+
+ current[ISSPACE((unsigned char)*current) ? 0 : 1] = '\0';
+ }
+
+ return s;
+}
+
+/* Remove leading and trailing whitespaces */
+char *string_trim_whitespace(char *const s)
+{
+ string_trim_whitespace_right(s); /* order matters */
+ string_trim_whitespace_left(s);
+
+ return s;
+}
+
+void word_wrap(char *dst, size_t dst_size, const char *src, int line_width, int wideglyph_width, unsigned max_lines)
+{
+ char *lastspace = NULL;
+ unsigned counter = 0;
+ unsigned lines = 1;
+ size_t src_len = strlen(src);
+ const char *src_end = src + src_len;
+
+ /* Prevent buffer overflow */
+ if (dst_size < src_len + 1)
+ return;
+
+ /* Early return if src string length is less
+ * than line width */
+ if (src_len < line_width)
+ {
+ strcpy(dst, src);
+ return;
+ }
+
+ while (*src != '\0')
+ {
+ unsigned char_len;
+
+ char_len = (unsigned)(utf8skip(src, 1) - src);
+ counter++;
+
+ if (*src == ' ')
+ lastspace = dst; /* Remember the location of the whitespace */
+ else if (*src == '\n')
+ {
+ /* If newlines embedded in the input,
+ * reset the index */
+ lines++;
+ counter = 0;
+
+ /* Early return if remaining src string
+ * length is less than line width */
+ if (src_end - src <= line_width)
+ {
+ strcpy(dst, src);
+ return;
+ }
+ }
+
+ while (char_len--)
+ *dst++ = *src++;
+
+ if (counter >= (unsigned)line_width)
+ {
+ counter = 0;
+
+ if (lastspace && (max_lines == 0 || lines < max_lines))
+ {
+ /* Replace nearest (previous) whitespace
+ * with newline character */
+ *lastspace = '\n';
+ lines++;
+
+ src -= dst - lastspace - 1;
+ dst = lastspace + 1;
+ lastspace = NULL;
+
+ /* Early return if remaining src string
+ * length is less than line width */
+ if (src_end - src < line_width)
+ {
+ strcpy(dst, src);
+ return;
+ }
+ }
+ }
+ }
+
+ *dst = '\0';
+}
+
+void word_wrap_wideglyph(char *dst, size_t dst_size, const char *src, int line_width, int wideglyph_width, unsigned max_lines)
+{
+ char *lastspace = NULL;
+ char *lastwideglyph = NULL;
+ const char *src_end = src + strlen(src);
+ unsigned lines = 1;
+ /* 'line_width' means max numbers of characters per line,
+ * but this metric is only meaningful when dealing with
+ * 'regular' glyphs that have an on-screen pixel width
+ * similar to that of regular Latin characters.
+ * When handing so-called 'wide' Unicode glyphs, it is
+ * necessary to consider the actual on-screen pixel width
+ * of each character.
+ * In order to do this, we create a distinction between
+ * regular Latin 'non-wide' glyphs and 'wide' glyphs, and
+ * normalise all values relative to the on-screen pixel
+ * width of regular Latin characters:
+ * - Regular 'non-wide' glyphs have a normalised width of 100
+ * - 'line_width' is therefore normalised to 100 * (width_in_characters)
+ * - 'wide' glyphs have a normalised width of
+ * 100 * (wide_character_pixel_width / latin_character_pixel_width)
+ * - When a character is detected, the position in the current
+ * line is incremented by the regular normalised width of 100
+ * - If that character is then determined to be a 'wide'
+ * glyph, the position in the current line is further incremented
+ * by the difference between the normalised 'wide' and 'non-wide'
+ * width values */
+ unsigned counter_normalized = 0;
+ int line_width_normalized = line_width * 100;
+ int additional_counter_normalized = wideglyph_width - 100;
+
+ /* Early return if src string length is less
+ * than line width */
+ if (src_end - src < line_width)
+ {
+ strlcpy(dst, src, dst_size);
+ return;
+ }
+
+ while (*src != '\0')
+ {
+ unsigned char_len;
+
+ char_len = (unsigned)(utf8skip(src, 1) - src);
+ counter_normalized += 100;
+
+ /* Prevent buffer overflow */
+ if (char_len >= dst_size)
+ break;
+
+ if (*src == ' ')
+ lastspace = dst; /* Remember the location of the whitespace */
+ else if (*src == '\n')
+ {
+ /* If newlines embedded in the input,
+ * reset the index */
+ lines++;
+ counter_normalized = 0;
+
+ /* Early return if remaining src string
+ * length is less than line width */
+ if (src_end - src <= line_width)
+ {
+ strlcpy(dst, src, dst_size);
+ return;
+ }
+ }
+ else if (char_len >= 3)
+ {
+ /* Remember the location of the first byte
+ * whose length as UTF-8 >= 3*/
+ lastwideglyph = dst;
+ counter_normalized += additional_counter_normalized;
+ }
+
+ dst_size -= char_len;
+ while (char_len--)
+ *dst++ = *src++;
+
+ if (counter_normalized >= (unsigned)line_width_normalized)
+ {
+ counter_normalized = 0;
+
+ if (max_lines != 0 && lines >= max_lines)
+ continue;
+ else if (lastwideglyph && (!lastspace || lastwideglyph > lastspace))
+ {
+ /* Insert newline character */
+ *lastwideglyph = '\n';
+ lines++;
+ src -= dst - lastwideglyph;
+ dst = lastwideglyph + 1;
+ lastwideglyph = NULL;
+
+ /* Early return if remaining src string
+ * length is less than line width */
+ if (src_end - src <= line_width)
+ {
+ strlcpy(dst, src, dst_size);
+ return;
+ }
+ }
+ else if (lastspace)
+ {
+ /* Replace nearest (previous) whitespace
+ * with newline character */
+ *lastspace = '\n';
+ lines++;
+ src -= dst - lastspace - 1;
+ dst = lastspace + 1;
+ lastspace = NULL;
+
+ /* Early return if remaining src string
+ * length is less than line width */
+ if (src_end - src < line_width)
+ {
+ strlcpy(dst, src, dst_size);
+ return;
+ }
+ }
+ }
+ }
+
+ *dst = '\0';
+}
+
+/* Splits string into tokens seperated by 'delim'
+ * > Returned token string must be free()'d
+ * > Returns NULL if token is not found
+ * > After each call, 'str' is set to the position after the
+ * last found token
+ * > Tokens *include* empty strings
+ * Usage example:
+ * char *str = "1,2,3,4,5,6,7,,,10,";
+ * char **str_ptr = &str;
+ * char *token = NULL;
+ * while ((token = string_tokenize(str_ptr, ",")))
+ * {
+ * printf("%s\n", token);
+ * free(token);
+ * token = NULL;
+ * }
+ */
+char* string_tokenize(char **str, const char *delim)
+{
+ /* Taken from https://codereview.stackexchange.com/questions/216956/strtok-function-thread-safe-supports-empty-tokens-doesnt-change-string# */
+ char *str_ptr = NULL;
+ char *delim_ptr = NULL;
+ char *token = NULL;
+ size_t token_len = 0;
+
+ /* Sanity checks */
+ if (!str || string_is_empty(delim))
+ return NULL;
+
+ str_ptr = *str;
+
+ /* Note: we don't check string_is_empty() here,
+ * empty strings are valid */
+ if (!str_ptr)
+ return NULL;
+
+ /* Search for delimiter */
+ delim_ptr = strstr(str_ptr, delim);
+
+ if (delim_ptr)
+ token_len = delim_ptr - str_ptr;
+ else
+ token_len = strlen(str_ptr);
+
+ /* Allocate token string */
+ token = (char *)malloc((token_len + 1) * sizeof(char));
+
+ if (!token)
+ return NULL;
+
+ /* Copy token */
+ strlcpy(token, str_ptr, (token_len + 1) * sizeof(char));
+ token[token_len] = '\0';
+
+ /* Update input string pointer */
+ *str = delim_ptr ? delim_ptr + strlen(delim) : NULL;
+
+ return token;
+}
+
+/* Removes every instance of character 'c' from 'str' */
+void string_remove_all_chars(char *str, char c)
+{
+ char *read_ptr = NULL;
+ char *write_ptr = NULL;
+
+ if (string_is_empty(str))
+ return;
+
+ read_ptr = str;
+ write_ptr = str;
+
+ while (*read_ptr != '\0')
+ {
+ *write_ptr = *read_ptr++;
+ write_ptr += (*write_ptr != c) ? 1 : 0;
+ }
+
+ *write_ptr = '\0';
+}
+
+/* Replaces every instance of character 'find' in 'str'
+ * with character 'replace' */
+void string_replace_all_chars(char *str, char find, char replace)
+{
+ char *str_ptr = str;
+
+ if (string_is_empty(str))
+ return;
+
+ while ((str_ptr = strchr(str_ptr, find)))
+ *str_ptr++ = replace;
+}
+
+/* Converts string to unsigned integer.
+ * Returns 0 if string is invalid */
+unsigned string_to_unsigned(const char *str)
+{
+ const char *ptr = NULL;
+
+ if (string_is_empty(str))
+ return 0;
+
+ for (ptr = str; *ptr != '\0'; ptr++)
+ {
+ if (!ISDIGIT((unsigned char)*ptr))
+ return 0;
+ }
+
+ return (unsigned)strtoul(str, NULL, 10);
+}
+
+/* Converts hexadecimal string to unsigned integer.
+ * Handles optional leading '0x'.
+ * Returns 0 if string is invalid */
+unsigned string_hex_to_unsigned(const char *str)
+{
+ const char *hex_str = str;
+ const char *ptr = NULL;
+ size_t len;
+
+ if (string_is_empty(str))
+ return 0;
+
+ /* Remove leading '0x', if required */
+ len = strlen(str);
+
+ if (len >= 2)
+ if ((str[0] == '0') &&
+ ((str[1] == 'x') || (str[1] == 'X')))
+ hex_str = str + 2;
+
+ if (string_is_empty(hex_str))
+ return 0;
+
+ /* Check for valid characters */
+ for (ptr = hex_str; *ptr != '\0'; ptr++)
+ {
+ if (!isxdigit((unsigned char)*ptr))
+ return 0;
+ }
+
+ return (unsigned)strtoul(hex_str, NULL, 16);
+}
diff --git a/libretro-common/time/rtime.c b/libretro-common/time/rtime.c
new file mode 100644
index 0000000..d66c228
--- /dev/null
+++ b/libretro-common/time/rtime.c
@@ -0,0 +1,81 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+ *
+ * ---------------------------------------------------------------------------------------
+ * The following license statement only applies to this file (rtime.c).
+ * ---------------------------------------------------------------------------------------
+ *
+ * Permission is hereby granted, free of charge,
+ * to any person obtaining a copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+ * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#ifdef HAVE_THREADS
+#include <rthreads/rthreads.h>
+#include <retro_assert.h>
+#include <stdlib.h>
+#endif
+
+#include <string.h>
+#include <time/rtime.h>
+
+#ifdef HAVE_THREADS
+/* TODO/FIXME - global */
+slock_t *rtime_localtime_lock = NULL;
+#endif
+
+/* Must be called before using rtime_localtime() */
+void rtime_init(void)
+{
+ rtime_deinit();
+#ifdef HAVE_THREADS
+ if (!rtime_localtime_lock)
+ rtime_localtime_lock = slock_new();
+
+ retro_assert(rtime_localtime_lock);
+#endif
+}
+
+/* Must be called upon program termination */
+void rtime_deinit(void)
+{
+#ifdef HAVE_THREADS
+ if (rtime_localtime_lock)
+ {
+ slock_free(rtime_localtime_lock);
+ rtime_localtime_lock = NULL;
+ }
+#endif
+}
+
+/* Thread-safe wrapper for localtime() */
+struct tm *rtime_localtime(const time_t *timep, struct tm *result)
+{
+ struct tm *time_info = NULL;
+
+ /* Lock mutex */
+#ifdef HAVE_THREADS
+ slock_lock(rtime_localtime_lock);
+#endif
+
+ time_info = localtime(timep);
+ if (time_info)
+ memcpy(result, time_info, sizeof(struct tm));
+
+ /* Unlock mutex */
+#ifdef HAVE_THREADS
+ slock_unlock(rtime_localtime_lock);
+#endif
+
+ return result;
+}
diff --git a/libretro-common/vfs/vfs_implementation.c b/libretro-common/vfs/vfs_implementation.c
new file mode 100644
index 0000000..7a24a95
--- /dev/null
+++ b/libretro-common/vfs/vfs_implementation.c
@@ -0,0 +1,1335 @@
+/* Copyright (C) 2010-2020 The RetroArch team
+*
+* ---------------------------------------------------------------------------------------
+* The following license statement only applies to this file (vfs_implementation.c).
+* ---------------------------------------------------------------------------------------
+*
+* Permission is hereby granted, free of charge,
+* to any person obtaining a copy of this software and associated documentation files (the "Software"),
+* to deal in the Software without restriction, including without limitation the rights to
+* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
+* and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+*
+* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <errno.h>
+#include <sys/types.h>
+
+#include <string/stdstring.h>
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#if defined(_WIN32)
+# ifdef _MSC_VER
+# define setmode _setmode
+# endif
+#include <sys/stat.h>
+# ifdef _XBOX
+# include <xtl.h>
+# define INVALID_FILE_ATTRIBUTES -1
+# else
+
+# include <fcntl.h>
+# include <direct.h>
+# include <windows.h>
+# endif
+# include <io.h>
+#else
+# if defined(PSP)
+# include <pspiofilemgr.h>
+# endif
+# include <sys/types.h>
+# include <sys/stat.h>
+# if !defined(VITA)
+# include <dirent.h>
+# endif
+# include <unistd.h>
+# if defined(ORBIS)
+# include <sys/fcntl.h>
+# include <sys/dirent.h>
+# include <orbisFile.h>
+# endif
+# if defined(WIIU)
+# include <malloc.h>
+# endif
+#endif
+
+#include <fcntl.h>
+
+/* TODO: Some things are duplicated but I'm really afraid of breaking other platforms by touching this */
+#if defined(VITA)
+# include <psp2/io/fcntl.h>
+# include <psp2/io/dirent.h>
+# include <psp2/io/stat.h>
+#elif defined(ORBIS)
+# include <orbisFile.h>
+# include <ps4link.h>
+# include <sys/dirent.h>
+# include <sys/fcntl.h>
+#elif !defined(_WIN32)
+# if defined(PSP)
+# include <pspiofilemgr.h>
+# endif
+# include <sys/types.h>
+# include <sys/stat.h>
+# include <dirent.h>
+# include <unistd.h>
+#endif
+
+#if defined(__QNX__) || defined(PSP)
+#include <unistd.h> /* stat() is defined here */
+#endif
+
+#ifdef __APPLE__
+#include <CoreFoundation/CoreFoundation.h>
+#endif
+#ifdef __HAIKU__
+#include <kernel/image.h>
+#endif
+#ifndef __MACH__
+#include <compat/strl.h>
+#include <compat/posix_string.h>
+#endif
+#include <compat/strcasestr.h>
+#include <retro_miscellaneous.h>
+#include <encodings/utf.h>
+
+#if defined(_WIN32)
+#ifndef _XBOX
+#if defined(_MSC_VER) && _MSC_VER <= 1200
+#define INVALID_FILE_ATTRIBUTES ((DWORD)-1)
+#endif
+#endif
+#elif defined(VITA)
+#define SCE_ERROR_ERRNO_EEXIST 0x80010011
+#include <psp2/io/fcntl.h>
+#include <psp2/io/dirent.h>
+#include <psp2/io/stat.h>
+#else
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <unistd.h>
+#endif
+
+#if defined(ORBIS)
+#include <orbisFile.h>
+#include <sys/fcntl.h>
+#include <sys/dirent.h>
+#endif
+#if defined(PSP)
+#include <pspkernel.h>
+#endif
+
+#if defined(__PS3__) || defined(__PSL1GHT__)
+#include <defines/ps3_defines.h>
+#if defined(__PSL1GHT__)
+#include <lv2/sysfs.h>
+#endif
+#endif
+
+#if defined(VITA)
+#define FIO_S_ISDIR SCE_S_ISDIR
+#endif
+
+#if defined(__QNX__) || defined(PSP)
+#include <unistd.h> /* stat() is defined here */
+#endif
+
+/* Assume W-functions do not work below Win2K and Xbox platforms */
+#if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0500 || defined(_XBOX)
+
+#ifndef LEGACY_WIN32
+#define LEGACY_WIN32
+#endif
+
+#endif
+
+#if defined(_WIN32)
+#if defined(_MSC_VER) && _MSC_VER >= 1400
+#define ATLEAST_VC2005
+#endif
+#endif
+
+#include <vfs/vfs_implementation.h>
+#include <libretro.h>
+#if defined(HAVE_MMAP)
+#include <memmap.h>
+#endif
+#include <encodings/utf.h>
+#include <compat/fopen_utf8.h>
+#include <file/file_path.h>
+
+#ifdef HAVE_CDROM
+#include <vfs/vfs_implementation_cdrom.h>
+#endif
+
+#if (defined(_POSIX_C_SOURCE) && (_POSIX_C_SOURCE - 0) >= 200112) || (defined(__POSIX_VISIBLE) && __POSIX_VISIBLE >= 200112) || (defined(_POSIX_VERSION) && _POSIX_VERSION >= 200112) || __USE_LARGEFILE || (defined(_FILE_OFFSET_BITS) && _FILE_OFFSET_BITS == 64)
+#ifndef HAVE_64BIT_OFFSETS
+#define HAVE_64BIT_OFFSETS
+#endif
+#endif
+
+#define RFILE_HINT_UNBUFFERED (1 << 8)
+
+int64_t retro_vfs_file_seek_internal(
+ libretro_vfs_implementation_file *stream,
+ int64_t offset, int whence)
+{
+ if (!stream)
+ return -1;
+
+ if ((stream->hints & RFILE_HINT_UNBUFFERED) == 0)
+ {
+#ifdef HAVE_CDROM
+ if (stream->scheme == VFS_SCHEME_CDROM)
+ return retro_vfs_file_seek_cdrom(stream, offset, whence);
+#endif
+#ifdef ATLEAST_VC2005
+ /* VC2005 and up have a special 64-bit fseek */
+ return _fseeki64(stream->fp, offset, whence);
+#elif defined(ORBIS)
+ {
+ int ret = orbisLseek(stream->fd, offset, whence);
+ if (ret < 0)
+ return -1;
+ return 0;
+ }
+#elif defined(HAVE_64BIT_OFFSETS)
+ return fseeko(stream->fp, (off_t)offset, whence);
+#else
+ return fseek(stream->fp, (long)offset, whence);
+#endif
+ }
+#ifdef HAVE_MMAP
+ /* Need to check stream->mapped because this function is
+ * called in filestream_open() */
+ if (stream->mapped && stream->hints &
+ RETRO_VFS_FILE_ACCESS_HINT_FREQUENT_ACCESS)
+ {
+ /* fseek() returns error on under/overflow but
+ * allows cursor > EOF for
+ read-only file descriptors. */
+ switch (whence)
+ {
+ case SEEK_SET:
+ if (offset < 0)
+ return -1;
+
+ stream->mappos = offset;
+ break;
+
+ case SEEK_CUR:
+ if ( (offset < 0 && stream->mappos + offset > stream->mappos) ||
+ (offset > 0 && stream->mappos + offset < stream->mappos))
+ return -1;
+
+ stream->mappos += offset;
+ break;
+
+ case SEEK_END:
+ if (stream->mapsize + offset < stream->mapsize)
+ return -1;
+
+ stream->mappos = stream->mapsize + offset;
+ break;
+ }
+ return stream->mappos;
+ }
+#endif
+
+ if (lseek(stream->fd, (off_t)offset, whence) < 0)
+ return -1;
+
+ return 0;
+}
+
+/**
+ * retro_vfs_file_open_impl:
+ * @path : path to file
+ * @mode : file mode to use when opening (read/write)
+ * @hints :
+ *
+ * Opens a file for reading or writing, depending on the requested mode.
+ * Returns a pointer to an RFILE if opened successfully, otherwise NULL.
+ **/
+
+libretro_vfs_implementation_file *retro_vfs_file_open_impl(
+ const char *path, unsigned mode, unsigned hints)
+{
+#if defined(VFS_FRONTEND) || defined(HAVE_CDROM)
+ int path_len = (int)strlen(path);
+#endif
+#ifdef VFS_FRONTEND
+ const char *dumb_prefix = "vfsonly://";
+ size_t dumb_prefix_siz = STRLEN_CONST("vfsonly://");
+ int dumb_prefix_len = (int)dumb_prefix_siz;
+#endif
+#ifdef HAVE_CDROM
+ const char *cdrom_prefix = "cdrom://";
+ size_t cdrom_prefix_siz = STRLEN_CONST("cdrom://");
+ int cdrom_prefix_len = (int)cdrom_prefix_siz;
+#endif
+ int flags = 0;
+ const char *mode_str = NULL;
+ libretro_vfs_implementation_file *stream =
+ (libretro_vfs_implementation_file*)
+ malloc(sizeof(*stream));
+
+ if (!stream)
+ return NULL;
+
+ stream->fd = 0;
+ stream->hints = hints;
+ stream->size = 0;
+ stream->buf = NULL;
+ stream->fp = NULL;
+#ifdef _WIN32
+ stream->fh = 0;
+#endif
+ stream->orig_path = NULL;
+ stream->mappos = 0;
+ stream->mapsize = 0;
+ stream->mapped = NULL;
+ stream->scheme = VFS_SCHEME_NONE;
+
+#ifdef VFS_FRONTEND
+ if (path_len >= dumb_prefix_len)
+ if (!memcmp(path, dumb_prefix, dumb_prefix_len))
+ path += dumb_prefix_siz;
+#endif
+
+#ifdef HAVE_CDROM
+ stream->cdrom.cue_buf = NULL;
+ stream->cdrom.cue_len = 0;
+ stream->cdrom.byte_pos = 0;
+ stream->cdrom.drive = 0;
+ stream->cdrom.cur_min = 0;
+ stream->cdrom.cur_sec = 0;
+ stream->cdrom.cur_frame = 0;
+ stream->cdrom.cur_track = 0;
+ stream->cdrom.cur_lba = 0;
+ stream->cdrom.last_frame_lba = 0;
+ stream->cdrom.last_frame[0] = '\0';
+ stream->cdrom.last_frame_valid = false;
+
+ if (path_len > cdrom_prefix_len)
+ {
+ if (!memcmp(path, cdrom_prefix, cdrom_prefix_len))
+ {
+ path += cdrom_prefix_siz;
+ stream->scheme = VFS_SCHEME_CDROM;
+ }
+ }
+#endif
+
+ stream->orig_path = strdup(path);
+
+#ifdef HAVE_MMAP
+ if (stream->hints & RETRO_VFS_FILE_ACCESS_HINT_FREQUENT_ACCESS && mode == RETRO_VFS_FILE_ACCESS_READ)
+ stream->hints |= RFILE_HINT_UNBUFFERED;
+ else
+#endif
+ stream->hints &= ~RETRO_VFS_FILE_ACCESS_HINT_FREQUENT_ACCESS;
+
+ switch (mode)
+ {
+ case RETRO_VFS_FILE_ACCESS_READ:
+ mode_str = "rb";
+
+ flags = O_RDONLY;
+#ifdef _WIN32
+ flags |= O_BINARY;
+#endif
+ break;
+
+ case RETRO_VFS_FILE_ACCESS_WRITE:
+ mode_str = "wb";
+
+ flags = O_WRONLY | O_CREAT | O_TRUNC;
+#if !defined(ORBIS)
+#if !defined(_WIN32)
+ flags |= S_IRUSR | S_IWUSR;
+#else
+ flags |= O_BINARY;
+#endif
+#endif
+ break;
+
+ case RETRO_VFS_FILE_ACCESS_READ_WRITE:
+ mode_str = "w+b";
+ flags = O_RDWR | O_CREAT | O_TRUNC;
+#if !defined(ORBIS)
+#if !defined(_WIN32)
+ flags |= S_IRUSR | S_IWUSR;
+#else
+ flags |= O_BINARY;
+#endif
+#endif
+ break;
+
+ case RETRO_VFS_FILE_ACCESS_WRITE | RETRO_VFS_FILE_ACCESS_UPDATE_EXISTING:
+ case RETRO_VFS_FILE_ACCESS_READ_WRITE | RETRO_VFS_FILE_ACCESS_UPDATE_EXISTING:
+ mode_str = "r+b";
+
+ flags = O_RDWR;
+#if !defined(ORBIS)
+#if !defined(_WIN32)
+ flags |= S_IRUSR | S_IWUSR;
+#else
+ flags |= O_BINARY;
+#endif
+#endif
+ break;
+
+ default:
+ goto error;
+ }
+
+ if ((stream->hints & RFILE_HINT_UNBUFFERED) == 0)
+ {
+#ifdef ORBIS
+ int fd = orbisOpen(path, flags, 0644);
+ if (fd < 0)
+ {
+ stream->fd = -1;
+ goto error;
+ }
+ stream->fd = fd;
+#else
+ FILE *fp;
+#ifdef HAVE_CDROM
+ if (stream->scheme == VFS_SCHEME_CDROM)
+ {
+ retro_vfs_file_open_cdrom(stream, path, mode, hints);
+#if defined(_WIN32) && !defined(_XBOX)
+ if (!stream->fh)
+ goto error;
+#else
+ if (!stream->fp)
+ goto error;
+#endif
+ }
+ else
+#endif
+ {
+ fp = (FILE*)fopen_utf8(path, mode_str);
+
+ if (!fp)
+ goto error;
+
+ stream->fp = fp;
+ }
+ /* Regarding setvbuf:
+ *
+ * https://www.freebsd.org/cgi/man.cgi?query=setvbuf&apropos=0&sektion=0&manpath=FreeBSD+11.1-RELEASE&arch=default&format=html
+ *
+ * If the size argument is not zero but buf is NULL,
+ * a buffer of the given size will be allocated immediately, and
+ * released on close. This is an extension to ANSI C.
+ *
+ * Since C89 does not support specifying a NULL buffer
+ * with a non-zero size, we create and track our own buffer for it.
+ */
+ /* TODO: this is only useful for a few platforms,
+ * find which and add ifdef */
+#if defined(_3DS)
+ if (stream->scheme != VFS_SCHEME_CDROM)
+ {
+ stream->buf = (char*)calloc(1, 0x10000);
+ if (stream->fp)
+ setvbuf(stream->fp, stream->buf, _IOFBF, 0x10000);
+ }
+#elif defined(WIIU)
+ if (stream->scheme != VFS_SCHEME_CDROM)
+ {
+ const int bufsize = 128*1024;
+ stream->buf = (char*)memalign(0x40, bufsize);
+ if (stream->fp)
+ setvbuf(stream->fp, stream->buf, _IOFBF, bufsize);
+ }
+#elif !defined(PSP)
+ if (stream->scheme != VFS_SCHEME_CDROM)
+ {
+ stream->buf = (char*)calloc(1, 0x4000);
+ if (stream->fp)
+ setvbuf(stream->fp, stream->buf, _IOFBF, 0x4000);
+ }
+#endif
+#endif
+ }
+ else
+ {
+#if defined(_WIN32) && !defined(_XBOX)
+#if defined(LEGACY_WIN32)
+ char *path_local = utf8_to_local_string_alloc(path);
+ stream->fd = open(path_local, flags, 0);
+ if (path_local)
+ free(path_local);
+#else
+ wchar_t * path_wide = utf8_to_utf16_string_alloc(path);
+ stream->fd = _wopen(path_wide, flags, 0);
+ if (path_wide)
+ free(path_wide);
+#endif
+#else
+ stream->fd = open(path, flags, 0);
+#endif
+
+ if (stream->fd == -1)
+ goto error;
+
+#ifdef HAVE_MMAP
+ if (stream->hints & RETRO_VFS_FILE_ACCESS_HINT_FREQUENT_ACCESS)
+ {
+ stream->mappos = 0;
+ stream->mapped = NULL;
+ stream->mapsize = retro_vfs_file_seek_internal(stream, 0, SEEK_END);
+
+ if (stream->mapsize == (uint64_t)-1)
+ goto error;
+
+ retro_vfs_file_seek_internal(stream, 0, SEEK_SET);
+
+ stream->mapped = (uint8_t*)mmap((void*)0,
+ stream->mapsize, PROT_READ, MAP_SHARED, stream->fd, 0);
+
+ if (stream->mapped == MAP_FAILED)
+ stream->hints &= ~RETRO_VFS_FILE_ACCESS_HINT_FREQUENT_ACCESS;
+ }
+#endif
+ }
+#ifdef ORBIS
+ stream->size = orbisLseek(stream->fd, 0, SEEK_END);
+ orbisLseek(stream->fd, 0, SEEK_SET);
+#else
+#ifdef HAVE_CDROM
+ if (stream->scheme == VFS_SCHEME_CDROM)
+ {
+ retro_vfs_file_seek_cdrom(stream, 0, SEEK_SET);
+ retro_vfs_file_seek_cdrom(stream, 0, SEEK_END);
+
+ stream->size = retro_vfs_file_tell_impl(stream);
+
+ retro_vfs_file_seek_cdrom(stream, 0, SEEK_SET);
+ }
+ else
+#endif
+ {
+ retro_vfs_file_seek_internal(stream, 0, SEEK_SET);
+ retro_vfs_file_seek_internal(stream, 0, SEEK_END);
+
+ stream->size = retro_vfs_file_tell_impl(stream);
+
+ retro_vfs_file_seek_internal(stream, 0, SEEK_SET);
+ }
+#endif
+ return stream;
+
+error:
+ retro_vfs_file_close_impl(stream);
+ return NULL;
+}
+
+int retro_vfs_file_close_impl(libretro_vfs_implementation_file *stream)
+{
+ if (!stream)
+ return -1;
+
+#ifdef HAVE_CDROM
+ if (stream->scheme == VFS_SCHEME_CDROM)
+ {
+ retro_vfs_file_close_cdrom(stream);
+ goto end;
+ }
+#endif
+
+ if ((stream->hints & RFILE_HINT_UNBUFFERED) == 0)
+ {
+ if (stream->fp)
+ fclose(stream->fp);
+ }
+ else
+ {
+#ifdef HAVE_MMAP
+ if (stream->hints & RETRO_VFS_FILE_ACCESS_HINT_FREQUENT_ACCESS)
+ munmap(stream->mapped, stream->mapsize);
+#endif
+ }
+
+ if (stream->fd > 0)
+ {
+#ifdef ORBIS
+ orbisClose(stream->fd);
+ stream->fd = -1;
+#else
+ close(stream->fd);
+#endif
+ }
+#ifdef HAVE_CDROM
+end:
+ if (stream->cdrom.cue_buf)
+ free(stream->cdrom.cue_buf);
+#endif
+ if (stream->buf)
+ free(stream->buf);
+
+ if (stream->orig_path)
+ free(stream->orig_path);
+
+ free(stream);
+
+ return 0;
+}
+
+int retro_vfs_file_error_impl(libretro_vfs_implementation_file *stream)
+{
+#ifdef HAVE_CDROM
+ if (stream->scheme == VFS_SCHEME_CDROM)
+ return retro_vfs_file_error_cdrom(stream);
+#endif
+#ifdef ORBIS
+ /* TODO/FIXME - implement this? */
+ return 0;
+#else
+ return ferror(stream->fp);
+#endif
+}
+
+int64_t retro_vfs_file_size_impl(libretro_vfs_implementation_file *stream)
+{
+ if (stream)
+ return stream->size;
+ return 0;
+}
+
+int64_t retro_vfs_file_truncate_impl(libretro_vfs_implementation_file *stream, int64_t length)
+{
+ if (!stream)
+ return -1;
+
+#ifdef _WIN32
+ if (_chsize(_fileno(stream->fp), length) != 0)
+ return -1;
+#elif !defined(VITA) && !defined(PSP) && !defined(PS2) && !defined(ORBIS) && (!defined(SWITCH) || defined(HAVE_LIBNX))
+ if (ftruncate(fileno(stream->fp), (off_t)length) != 0)
+ return -1;
+#endif
+
+ return 0;
+}
+
+int64_t retro_vfs_file_tell_impl(libretro_vfs_implementation_file *stream)
+{
+ if (!stream)
+ return -1;
+
+ if ((stream->hints & RFILE_HINT_UNBUFFERED) == 0)
+ {
+#ifdef HAVE_CDROM
+ if (stream->scheme == VFS_SCHEME_CDROM)
+ return retro_vfs_file_tell_cdrom(stream);
+#endif
+#ifdef ORBIS
+ {
+ int64_t ret = orbisLseek(stream->fd, 0, SEEK_CUR);
+ if (ret < 0)
+ return -1;
+ return ret;
+ }
+#else
+#ifdef ATLEAST_VC2005
+ /* VC2005 and up have a special 64-bit ftell */
+ return _ftelli64(stream->fp);
+#elif defined(HAVE_64BIT_OFFSETS)
+ return ftello(stream->fp);
+#else
+ return ftell(stream->fp);
+#endif
+#endif
+ }
+#ifdef HAVE_MMAP
+ /* Need to check stream->mapped because this function
+ * is called in filestream_open() */
+ if (stream->mapped && stream->hints &
+ RETRO_VFS_FILE_ACCESS_HINT_FREQUENT_ACCESS)
+ return stream->mappos;
+#endif
+ if (lseek(stream->fd, 0, SEEK_CUR) < 0)
+ return -1;
+
+ return 0;
+}
+
+int64_t retro_vfs_file_seek_impl(libretro_vfs_implementation_file *stream,
+ int64_t offset, int seek_position)
+{
+ int whence = -1;
+ switch (seek_position)
+ {
+ case RETRO_VFS_SEEK_POSITION_START:
+ whence = SEEK_SET;
+ break;
+ case RETRO_VFS_SEEK_POSITION_CURRENT:
+ whence = SEEK_CUR;
+ break;
+ case RETRO_VFS_SEEK_POSITION_END:
+ whence = SEEK_END;
+ break;
+ }
+
+ return retro_vfs_file_seek_internal(stream, offset, whence);
+}
+
+int64_t retro_vfs_file_read_impl(libretro_vfs_implementation_file *stream,
+ void *s, uint64_t len)
+{
+ if (!stream || !s)
+ return -1;
+
+ if ((stream->hints & RFILE_HINT_UNBUFFERED) == 0)
+ {
+#ifdef HAVE_CDROM
+ if (stream->scheme == VFS_SCHEME_CDROM)
+ return retro_vfs_file_read_cdrom(stream, s, len);
+#endif
+#ifdef ORBIS
+ if (orbisRead(stream->fd, s, (size_t)len) < 0)
+ return -1;
+ return 0;
+#else
+ return fread(s, 1, (size_t)len, stream->fp);
+#endif
+ }
+#ifdef HAVE_MMAP
+ if (stream->hints & RETRO_VFS_FILE_ACCESS_HINT_FREQUENT_ACCESS)
+ {
+ if (stream->mappos > stream->mapsize)
+ return -1;
+
+ if (stream->mappos + len > stream->mapsize)
+ len = stream->mapsize - stream->mappos;
+
+ memcpy(s, &stream->mapped[stream->mappos], len);
+ stream->mappos += len;
+
+ return len;
+ }
+#endif
+
+ return read(stream->fd, s, (size_t)len);
+}
+
+int64_t retro_vfs_file_write_impl(libretro_vfs_implementation_file *stream, const void *s, uint64_t len)
+{
+ if (!stream)
+ return -1;
+
+ if ((stream->hints & RFILE_HINT_UNBUFFERED) == 0)
+ {
+#ifdef ORBIS
+ if (orbisWrite(stream->fd, s, (size_t)len) < 0)
+ return -1;
+ return 0;
+#else
+ return fwrite(s, 1, (size_t)len, stream->fp);
+#endif
+ }
+
+#ifdef HAVE_MMAP
+ if (stream->hints & RETRO_VFS_FILE_ACCESS_HINT_FREQUENT_ACCESS)
+ return -1;
+#endif
+ return write(stream->fd, s, (size_t)len);
+}
+
+int retro_vfs_file_flush_impl(libretro_vfs_implementation_file *stream)
+{
+ if (!stream)
+ return -1;
+#ifdef ORBIS
+ return 0;
+#else
+ return fflush(stream->fp) == 0 ? 0 : -1;
+#endif
+}
+
+int retro_vfs_file_remove_impl(const char *path)
+{
+#if defined(_WIN32) && !defined(_XBOX)
+ /* Win32 (no Xbox) */
+
+#if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0500
+ char *path_local = NULL;
+#else
+ wchar_t *path_wide = NULL;
+#endif
+ if (!path || !*path)
+ return -1;
+#if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0500
+ path_local = utf8_to_local_string_alloc(path);
+
+ if (path_local)
+ {
+ int ret = remove(path_local);
+ free(path_local);
+
+ if (ret == 0)
+ return 0;
+ }
+#else
+ path_wide = utf8_to_utf16_string_alloc(path);
+
+ if (path_wide)
+ {
+ int ret = _wremove(path_wide);
+ free(path_wide);
+
+ if (ret == 0)
+ return 0;
+ }
+#endif
+ return -1;
+#elif defined(ORBIS)
+ /* Orbis
+ * TODO/FIXME - stub for now */
+ return 0;
+#else
+ if (remove(path) == 0)
+ return 0;
+ return -1;
+#endif
+}
+
+int retro_vfs_file_rename_impl(const char *old_path, const char *new_path)
+{
+#if defined(_WIN32) && !defined(_XBOX)
+ /* Win32 (no Xbox) */
+ int ret = -1;
+#if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0500
+ char *old_path_local = NULL;
+#else
+ wchar_t *old_path_wide = NULL;
+#endif
+
+ if (!old_path || !*old_path || !new_path || !*new_path)
+ return -1;
+
+#if defined(_WIN32_WINNT) && _WIN32_WINNT < 0x0500
+ old_path_local = utf8_to_local_string_alloc(old_path);
+
+ if (old_path_local)
+ {
+ char *new_path_local = utf8_to_local_string_alloc(new_path);
+
+ if (new_path_local)
+ {
+ if (rename(old_path_local, new_path_local) == 0)
+ ret = 0;
+ free(new_path_local);
+ }
+
+ free(old_path_local);
+ }
+#else
+ old_path_wide = utf8_to_utf16_string_alloc(old_path);
+
+ if (old_path_wide)
+ {
+ wchar_t *new_path_wide = utf8_to_utf16_string_alloc(new_path);
+
+ if (new_path_wide)
+ {
+ if (_wrename(old_path_wide, new_path_wide) == 0)
+ ret = 0;
+ free(new_path_wide);
+ }
+
+ free(old_path_wide);
+ }
+#endif
+ return ret;
+
+#elif defined(ORBIS)
+ /* Orbis */
+ /* TODO/FIXME - Stub for now */
+ if (!old_path || !*old_path || !new_path || !*new_path)
+ return -1;
+ return 0;
+
+#else
+ /* Every other platform */
+ if (!old_path || !*old_path || !new_path || !*new_path)
+ return -1;
+ return rename(old_path, new_path) == 0 ? 0 : -1;
+#endif
+}
+
+const char *retro_vfs_file_get_path_impl(
+ libretro_vfs_implementation_file *stream)
+{
+ /* should never happen, do something noisy so caller can be fixed */
+ if (!stream)
+ abort();
+ return stream->orig_path;
+}
+
+int retro_vfs_stat_impl(const char *path, int32_t *size)
+{
+ bool is_dir = false;
+ bool is_character_special = false;
+#if defined(VITA) || defined(PSP)
+ /* Vita / PSP */
+ SceIoStat buf;
+ int dir_ret;
+ char *tmp = NULL;
+ size_t len = 0;
+
+ if (!path || !*path)
+ return 0;
+
+ tmp = strdup(path);
+ len = strlen(tmp);
+ if (tmp[len-1] == '/')
+ tmp[len-1] = '\0';
+
+ dir_ret = sceIoGetstat(tmp, &buf);
+ free(tmp);
+ if (dir_ret < 0)
+ return 0;
+
+ if (size)
+ *size = (int32_t)buf.st_size;
+
+ is_dir = FIO_S_ISDIR(buf.st_mode);
+#elif defined(ORBIS)
+ /* Orbis */
+ int dir_ret = 0;
+
+ if (!path || !*path)
+ return 0;
+
+ if (size)
+ *size = (int32_t)buf.st_size;
+
+ dir_ret = orbisDopen(path);
+ is_dir = dir_ret > 0;
+ orbisDclose(dir_ret);
+
+ is_character_special = S_ISCHR(buf.st_mode);
+#elif defined(__PSL1GHT__) || defined(__PS3__)
+ /* Lowlevel Lv2 */
+ sysFSStat buf;
+
+ if (!path || !*path)
+ return 0;
+ if (sysFsStat(path, &buf) < 0)
+ return 0;
+
+ if (size)
+ *size = (int32_t)buf.st_size;
+
+ is_dir = ((buf.st_mode & S_IFMT) == S_IFDIR);
+#elif defined(_WIN32)
+ /* Windows */
+ DWORD file_info;
+ struct _stat buf;
+#if defined(LEGACY_WIN32)
+ char *path_local = NULL;
+#else
+ wchar_t *path_wide = NULL;
+#endif
+
+ if (!path || !*path)
+ return 0;
+
+#if defined(LEGACY_WIN32)
+ path_local = utf8_to_local_string_alloc(path);
+ file_info = GetFileAttributes(path_local);
+
+ if (!string_is_empty(path_local))
+ _stat(path_local, &buf);
+
+ if (path_local)
+ free(path_local);
+#else
+ path_wide = utf8_to_utf16_string_alloc(path);
+ file_info = GetFileAttributesW(path_wide);
+
+ _wstat(path_wide, &buf);
+
+ if (path_wide)
+ free(path_wide);
+#endif
+
+ if (file_info == INVALID_FILE_ATTRIBUTES)
+ return 0;
+
+ if (size)
+ *size = (int32_t)buf.st_size;
+
+ is_dir = (file_info & FILE_ATTRIBUTE_DIRECTORY);
+
+#elif defined(GEKKO)
+ /* On GEKKO platforms, paths cannot have
+ * trailing slashes - we must therefore
+ * remove them */
+ char *path_buf = NULL;
+ int stat_ret = -1;
+ struct stat stat_buf;
+ size_t len;
+
+ if (string_is_empty(path))
+ return 0;
+
+ path_buf = strdup(path);
+ if (!path_buf)
+ return 0;
+
+ len = strlen(path_buf);
+ if (len > 0)
+ if (path_buf[len - 1] == '/')
+ path_buf[len - 1] = '\0';
+
+ stat_ret = stat(path_buf, &stat_buf);
+ free(path_buf);
+
+ if (stat_ret < 0)
+ return 0;
+
+ if (size)
+ *size = (int32_t)stat_buf.st_size;
+
+ is_dir = S_ISDIR(stat_buf.st_mode);
+ is_character_special = S_ISCHR(stat_buf.st_mode);
+
+#else
+ /* Every other platform */
+ struct stat buf;
+
+ if (!path || !*path)
+ return 0;
+ if (stat(path, &buf) < 0)
+ return 0;
+
+ if (size)
+ *size = (int32_t)buf.st_size;
+
+ is_dir = S_ISDIR(buf.st_mode);
+ is_character_special = S_ISCHR(buf.st_mode);
+#endif
+ return RETRO_VFS_STAT_IS_VALID | (is_dir ? RETRO_VFS_STAT_IS_DIRECTORY : 0) | (is_character_special ? RETRO_VFS_STAT_IS_CHARACTER_SPECIAL : 0);
+}
+
+#if defined(VITA)
+#define path_mkdir_error(ret) (((ret) == SCE_ERROR_ERRNO_EEXIST))
+#elif defined(PSP) || defined(PS2) || defined(_3DS) || defined(WIIU) || defined(SWITCH) || defined(ORBIS)
+#define path_mkdir_error(ret) ((ret) == -1)
+#else
+#define path_mkdir_error(ret) ((ret) < 0 && errno == EEXIST)
+#endif
+
+int retro_vfs_mkdir_impl(const char *dir)
+{
+#if defined(_WIN32)
+#ifdef LEGACY_WIN32
+ int ret = _mkdir(dir);
+#else
+ wchar_t *dir_w = utf8_to_utf16_string_alloc(dir);
+ int ret = -1;
+
+ if (dir_w)
+ {
+ ret = _wmkdir(dir_w);
+ free(dir_w);
+ }
+#endif
+#elif defined(IOS)
+ int ret = mkdir(dir, 0755);
+#elif defined(VITA) || defined(PSP)
+ int ret = sceIoMkdir(dir, 0777);
+#elif defined(ORBIS)
+ int ret = orbisMkdir(dir, 0755);
+#elif defined(__QNX__)
+ int ret = mkdir(dir, 0777);
+#elif defined(GEKKO)
+ /* On GEKKO platforms, mkdir() fails if
+ * the path has a trailing slash. We must
+ * therefore remove it. */
+ int ret = -1;
+ if (!string_is_empty(dir))
+ {
+ char *dir_buf = strdup(dir);
+
+ if (dir_buf)
+ {
+ size_t len = strlen(dir_buf);
+
+ if (len > 0)
+ if (dir_buf[len - 1] == '/')
+ dir_buf[len - 1] = '\0';
+
+ ret = mkdir(dir_buf, 0750);
+
+ free(dir_buf);
+ }
+ }
+#else
+ int ret = mkdir(dir, 0750);
+#endif
+
+ if (path_mkdir_error(ret))
+ return -2;
+ return ret < 0 ? -1 : 0;
+}
+
+#ifdef VFS_FRONTEND
+struct retro_vfs_dir_handle
+#else
+struct libretro_vfs_implementation_dir
+#endif
+{
+ char* orig_path;
+#if defined(_WIN32)
+#if defined(LEGACY_WIN32)
+ WIN32_FIND_DATA entry;
+#else
+ WIN32_FIND_DATAW entry;
+#endif
+ HANDLE directory;
+ bool next;
+ char path[PATH_MAX_LENGTH];
+#elif defined(VITA) || defined(PSP)
+ SceUID directory;
+ SceIoDirent entry;
+#elif defined(__PSL1GHT__) || defined(__PS3__)
+ int error;
+ int directory;
+ sysFSDirent entry;
+#elif defined(ORBIS)
+ int directory;
+ struct dirent entry;
+#else
+ DIR *directory;
+ const struct dirent *entry;
+#endif
+};
+
+static bool dirent_check_error(libretro_vfs_implementation_dir *rdir)
+{
+#if defined(_WIN32)
+ return (rdir->directory == INVALID_HANDLE_VALUE);
+#elif defined(VITA) || defined(PSP) || defined(ORBIS)
+ return (rdir->directory < 0);
+#elif defined(__PSL1GHT__) || defined(__PS3__)
+ return (rdir->error != FS_SUCCEEDED);
+#else
+ return !(rdir->directory);
+#endif
+}
+
+libretro_vfs_implementation_dir *retro_vfs_opendir_impl(
+ const char *name, bool include_hidden)
+{
+#if defined(_WIN32)
+ unsigned path_len;
+ char path_buf[1024];
+ size_t copied = 0;
+#if defined(LEGACY_WIN32)
+ char *path_local = NULL;
+#else
+ wchar_t *path_wide = NULL;
+#endif
+#endif
+ libretro_vfs_implementation_dir *rdir;
+
+ /*Reject null or empty string paths*/
+ if (!name || (*name == 0))
+ return NULL;
+
+ /*Allocate RDIR struct. Tidied later with retro_closedir*/
+ rdir = (libretro_vfs_implementation_dir*)calloc(1, sizeof(*rdir));
+ if (!rdir)
+ return NULL;
+
+ rdir->orig_path = strdup(name);
+
+#if defined(_WIN32)
+ path_buf[0] = '\0';
+ path_len = strlen(name);
+
+ copied = strlcpy(path_buf, name, sizeof(path_buf));
+
+ /* Non-NT platforms don't like extra slashes in the path */
+ if (name[path_len - 1] != '\\')
+ path_buf[copied++] = '\\';
+
+ path_buf[copied] = '*';
+ path_buf[copied+1] = '\0';
+
+#if defined(LEGACY_WIN32)
+ path_local = utf8_to_local_string_alloc(path_buf);
+ rdir->directory = FindFirstFile(path_local, &rdir->entry);
+
+ if (path_local)
+ free(path_local);
+#else
+ path_wide = utf8_to_utf16_string_alloc(path_buf);
+ rdir->directory = FindFirstFileW(path_wide, &rdir->entry);
+
+ if (path_wide)
+ free(path_wide);
+#endif
+
+#elif defined(VITA) || defined(PSP)
+ rdir->directory = sceIoDopen(name);
+#elif defined(_3DS)
+ rdir->directory = !string_is_empty(name) ? opendir(name) : NULL;
+ rdir->entry = NULL;
+#elif defined(__PSL1GHT__) || defined(__PS3__)
+ rdir->error = sysFsOpendir(name, &rdir->directory);
+#elif defined(ORBIS)
+ rdir->directory = orbisDopen(name);
+#else
+ rdir->directory = opendir(name);
+ rdir->entry = NULL;
+#endif
+
+#ifdef _WIN32
+ if (include_hidden)
+ rdir->entry.dwFileAttributes |= FILE_ATTRIBUTE_HIDDEN;
+ else
+ rdir->entry.dwFileAttributes &= ~FILE_ATTRIBUTE_HIDDEN;
+#endif
+
+ if (rdir->directory && !dirent_check_error(rdir))
+ return rdir;
+
+ retro_vfs_closedir_impl(rdir);
+ return NULL;
+}
+
+bool retro_vfs_readdir_impl(libretro_vfs_implementation_dir *rdir)
+{
+#if defined(_WIN32)
+ if (rdir->next)
+#if defined(LEGACY_WIN32)
+ return (FindNextFile(rdir->directory, &rdir->entry) != 0);
+#else
+ return (FindNextFileW(rdir->directory, &rdir->entry) != 0);
+#endif
+
+ rdir->next = true;
+ return (rdir->directory != INVALID_HANDLE_VALUE);
+#elif defined(VITA) || defined(PSP)
+ return (sceIoDread(rdir->directory, &rdir->entry) > 0);
+#elif defined(__PSL1GHT__) || defined(__PS3__)
+ uint64_t nread;
+ rdir->error = sysFsReaddir(rdir->directory, &rdir->entry, &nread);
+ return (nread != 0);
+#elif defined(ORBIS)
+ return (orbisDread(rdir->directory, &rdir->entry) > 0);
+#else
+ return ((rdir->entry = readdir(rdir->directory)) != NULL);
+#endif
+}
+
+const char *retro_vfs_dirent_get_name_impl(libretro_vfs_implementation_dir *rdir)
+{
+#if defined(_WIN32)
+#if defined(LEGACY_WIN32)
+ char *name = local_to_utf8_string_alloc(rdir->entry.cFileName);
+#else
+ char *name = utf16_to_utf8_string_alloc(rdir->entry.cFileName);
+#endif
+ memset(rdir->entry.cFileName, 0, sizeof(rdir->entry.cFileName));
+ strlcpy((char*)rdir->entry.cFileName, name, sizeof(rdir->entry.cFileName));
+ if (name)
+ free(name);
+ return (char*)rdir->entry.cFileName;
+#elif defined(VITA) || defined(PSP) || defined(ORBIS) || defined(__PSL1GHT__) || defined(__PS3__)
+ return rdir->entry.d_name;
+#else
+ if (!rdir || !rdir->entry)
+ return NULL;
+ return rdir->entry->d_name;
+#endif
+}
+
+bool retro_vfs_dirent_is_dir_impl(libretro_vfs_implementation_dir *rdir)
+{
+#if defined(_WIN32)
+ const WIN32_FIND_DATA *entry = (const WIN32_FIND_DATA*)&rdir->entry;
+ return entry->dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY;
+#elif defined(PSP) || defined(VITA)
+ const SceIoDirent *entry = (const SceIoDirent*)&rdir->entry;
+#if defined(PSP)
+ return (entry->d_stat.st_attr & FIO_SO_IFDIR) == FIO_SO_IFDIR;
+#elif defined(VITA)
+ return SCE_S_ISDIR(entry->d_stat.st_mode);
+#endif
+#elif defined(__PSL1GHT__) || defined(__PS3__)
+ sysFSDirent *entry = (sysFSDirent*)&rdir->entry;
+ return (entry->d_type == FS_TYPE_DIR);
+#elif defined(ORBIS)
+ const struct dirent *entry = &rdir->entry;
+ if (entry->d_type == DT_DIR)
+ return true;
+ if (!(entry->d_type == DT_UNKNOWN || entry->d_type == DT_LNK))
+ return false;
+#else
+ struct stat buf;
+ char path[PATH_MAX_LENGTH];
+#if defined(DT_DIR)
+ const struct dirent *entry = (const struct dirent*)rdir->entry;
+ if (entry->d_type == DT_DIR)
+ return true;
+ /* This can happen on certain file systems. */
+ if (!(entry->d_type == DT_UNKNOWN || entry->d_type == DT_LNK))
+ return false;
+#endif
+ /* dirent struct doesn't have d_type, do it the slow way ... */
+ path[0] = '\0';
+ fill_pathname_join(path, rdir->orig_path, retro_vfs_dirent_get_name_impl(rdir), sizeof(path));
+ if (stat(path, &buf) < 0)
+ return false;
+ return S_ISDIR(buf.st_mode);
+#endif
+}
+
+int retro_vfs_closedir_impl(libretro_vfs_implementation_dir *rdir)
+{
+ if (!rdir)
+ return -1;
+
+#if defined(_WIN32)
+ if (rdir->directory != INVALID_HANDLE_VALUE)
+ FindClose(rdir->directory);
+#elif defined(VITA) || defined(PSP)
+ sceIoDclose(rdir->directory);
+#elif defined(__PSL1GHT__) || defined(__PS3__)
+ rdir->error = sysFsClosedir(rdir->directory);
+#elif defined(ORBIS)
+ orbisDclose(rdir->directory);
+#else
+ if (rdir->directory)
+ closedir(rdir->directory);
+#endif
+
+ if (rdir->orig_path)
+ free(rdir->orig_path);
+ free(rdir);
+ return 0;
+}