Merge pull request #102 from Provenance-Emu/libretro/fix/save-file-paths

Fix save file paths: use libretro SRAM interface

Author: JoeMatt

.github/workflows/regression-test.yml

@@ -77,6 +77,9 @@ jobs:
         chmod +x "${MINIRETRO_BIN}"
         ./test/regression_test.sh ./${{ matrix.config.core }}
 
+    - name: Run SRAM interface tests
+      run: ./test/sram_test.sh ./${{ matrix.config.core }}
+
     - name: Upload diff artifacts
       if: failure()
       uses: actions/upload-artifact@v4

.github/workflows/release.yml

@@ -0,0 +1,100 @@
+name: Release
+
+on:
+  push:
+    tags: [ 'v*' ]
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        config:
+          - platform: linux-x86_64
+            artifact: virtualjaguar_libretro.so
+            os: ubuntu-latest
+            cc: gcc
+            cxx: g++
+
+          - platform: linux-aarch64
+            artifact: virtualjaguar_libretro.so
+            os: ubuntu-24.04-arm
+            cc: gcc
+            cxx: g++
+
+          - platform: macos-arm64
+            artifact: virtualjaguar_libretro.dylib
+            os: macos-latest
+            cc: clang
+            cxx: clang++
+
+          - platform: windows-x86_64
+            artifact: virtualjaguar_libretro.dll
+            os: windows-latest
+            cc: gcc
+            cxx: g++
+            shell: 'msys2 {0}'
+
+    name: build-${{ matrix.config.platform }}
+    runs-on: ${{ matrix.config.os }}
+
+    defaults:
+      run:
+        shell: ${{ matrix.config.shell || 'bash' }}
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up MSYS2
+      if: runner.os == 'Windows'
+      uses: msys2/setup-msys2@v2
+      with:
+        msystem: MINGW64
+        update: false
+        install: >-
+          mingw-w64-x86_64-gcc
+          make
+
+    - name: Build
+      run: make -j4 CC=${{ matrix.config.cc }} CXX=${{ matrix.config.cxx }}
+
+    - name: Package
+      run: |
+        mkdir -p dist
+        cp ${{ matrix.config.artifact }} dist/virtualjaguar_libretro-${{ matrix.config.platform }}${SUFFIX}
+      env:
+        SUFFIX: ${{ matrix.config.platform == 'windows-x86_64' && '.dll' || (matrix.config.platform == 'macos-arm64' && '.dylib' || '.so') }}
+
+    - name: Upload artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: virtualjaguar_libretro-${{ matrix.config.platform }}
+        path: dist/
+        if-no-files-found: error
+
+  release:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Download all artifacts
+      uses: actions/download-artifact@v4
+      with:
+        path: artifacts/
+
+    - name: Create release
+      env:
+        GH_TOKEN: ${{ github.token }}
+      run: |
+        TAG="${GITHUB_REF_NAME}"
+        # Collect all built binaries
+        find artifacts/ -type f | sort
+
+        gh release create "${TAG}" \
+          --title "${TAG}" \
+          --generate-notes \
+          artifacts/virtualjaguar_libretro-*/*

libretro.c

@@ -30,7 +30,22 @@ uint32_t *videoBuffer        = NULL;
 int game_width               = 0;
 int game_height              = 0;
 
-extern uint16_t eeprom_ram[];
+extern uint16_t eeprom_ram[64];
+extern uint8_t mtMem[0x20000];
+extern uint32_t jaguarMainROMCRC32;
+extern void (*eeprom_dirty_cb)(void);
+
+/* Save buffer for RETRO_MEMORY_SAVE_RAM.
+ * Regular carts: 128 bytes (64 x 16-bit EEPROM words, big-endian packed).
+ * Memory Track cart (CRC 0xFDF37F47): mtMem is used directly (128K).
+ *
+ * The save buffer is kept in sync on every EEPROM write via eeprom_dirty_cb,
+ * so frontends that cache the pointer always see current data. */
+#define EEPROM_SAVE_SIZE 128  /* 64 x 16-bit words, big-endian */
+#define MT_SAVE_SIZE     0x20000  /* 128K Memory Track */
+static uint8_t eeprom_save_buf[EEPROM_SAVE_SIZE];
+static void eeprom_pack_save_buf(void);
+static void eeprom_unpack_save_buf(void);
 
 static retro_video_refresh_t video_cb;
 static retro_input_poll_t input_poll_cb;
@@ -39,6 +54,7 @@ static retro_environment_t environ_cb;
 retro_audio_sample_batch_t audio_batch_cb;
 
 static bool libretro_supports_bitmasks = false;
+static bool save_data_needs_unpack = false;
 
 void retro_set_video_refresh(retro_video_refresh_t cb) { video_cb = cb; }
 void retro_set_audio_sample(retro_audio_sample_t cb) { (void)cb; }
@@ -719,26 +735,6 @@ static void update_input(void)
    }
 }
 
-static void extract_basename(char *buf, const char *path, size_t size)
-{
-   char       *ext  = NULL;
-   const char *base = strrchr(path, '/');
-   if (!base)
-      base = strrchr(path, '\\');
-   if (!base)
-      base = path;
-
-   if (*base == '\\' || *base == '/')
-      base++;
-
-   strncpy(buf, base, size - 1);
-   buf[size - 1] = '\0';
-
-   ext = strrchr(buf, '.');
-   if (ext)
-      *ext = '\0';
-}
-
 /************************************
  * libretro implementation
  ************************************/
@@ -897,9 +893,7 @@ void retro_cheat_set(unsigned index, bool enabled, const char *code)
 
 bool retro_load_game(const struct retro_game_info *info)
 {
-   char slash;
    unsigned i;
-   const char *save_dir = NULL;
    enum retro_pixel_format fmt = RETRO_PIXEL_FORMAT_XRGB8888;
 
    struct retro_input_descriptor desc[] = {
@@ -981,31 +975,8 @@ bool retro_load_game(const struct retro_game_info *info)
 
    check_variables();
 
-   // Get eeprom path info
-   // > Handle Windows nonsense...
-#if defined(_WIN32)
-   slash = '\\';
-#else
-   slash = '/';
-#endif
-   // > Get save path
-   vjs.EEPROMPath[0] = '\0';
-   if (environ_cb(RETRO_ENVIRONMENT_GET_SAVE_DIRECTORY, &save_dir) && save_dir)
-   {
-      if (strlen(save_dir) > 0)
-      {
-         sprintf(vjs.EEPROMPath, "%s%c", save_dir, slash);
-      }
-   }
-   // > Get ROM name
-   if (info->path != NULL)
-   {
-      extract_basename(vjs.romName, info->path, sizeof(vjs.romName));
-   }
-   else
-   {
-      vjs.romName[0] = '\0';
-   }
+   /* Register EEPROM dirty callback so the save buffer stays in sync */
+   eeprom_dirty_cb = eeprom_pack_save_buf;
 
    JaguarInit();                                             // set up hardware
    memcpy(jagMemSpace + 0xE00000,
@@ -1023,6 +994,11 @@ bool retro_load_game(const struct retro_game_info *info)
    JaguarLoadFile((uint8_t*)info->data, info->size);
    JaguarReset();
 
+   /* The frontend will load .srm data into our save buffer (returned by
+    * retro_get_memory_data) after this function returns but before the
+    * first retro_run(). We unpack it on the first frame. */
+   save_data_needs_unpack = true;
+
    return true;
 }
 
@@ -1055,22 +1031,55 @@ unsigned retro_api_version(void)
    return RETRO_API_VERSION;
 }
 
+/* Pack eeprom_ram[] into the save buffer (big-endian byte order).
+ * Called on every EEPROM write via eeprom_dirty_cb so the buffer
+ * is always up-to-date for frontends that cache the pointer. */
+static void eeprom_pack_save_buf(void)
+{
+   unsigned i;
+   for (i = 0; i < 64; i++)
+   {
+      eeprom_save_buf[(i * 2) + 0] = eeprom_ram[i] >> 8;
+      eeprom_save_buf[(i * 2) + 1] = eeprom_ram[i] & 0xFF;
+   }
+}
+
+/* Unpack the save buffer back into eeprom_ram[].
+ * Called once after the frontend loads .srm data. */
+static void eeprom_unpack_save_buf(void)
+{
+   unsigned i;
+   for (i = 0; i < 64; i++)
+      eeprom_ram[i] = ((uint16_t)eeprom_save_buf[(i * 2) + 0] << 8)
+                    | eeprom_save_buf[(i * 2) + 1];
+}
+
 void *retro_get_memory_data(unsigned type)
 {
-   if(type == RETRO_MEMORY_SYSTEM_RAM)
+   if (type == RETRO_MEMORY_SYSTEM_RAM)
       return jaguarMainRAM;
-   else if (type == RETRO_MEMORY_SAVE_RAM)
-      return eeprom_ram;
-   else return NULL;
+   if (type == RETRO_MEMORY_SAVE_RAM)
+   {
+      /* Memory Track cart uses 128K NVRAM directly */
+      if (jaguarMainROMCRC32 == 0xFDF37F47)
+         return mtMem;
+      /* Regular carts: return the pre-packed save buffer */
+      return eeprom_save_buf;
+   }
+   return NULL;
 }
 
 size_t retro_get_memory_size(unsigned type)
 {
-   if(type == RETRO_MEMORY_SYSTEM_RAM)
+   if (type == RETRO_MEMORY_SYSTEM_RAM)
       return 0x200000;
-   else if (type == RETRO_MEMORY_SAVE_RAM)
-      return 128;
-   else return 0;
+   if (type == RETRO_MEMORY_SAVE_RAM)
+   {
+      if (jaguarMainROMCRC32 == 0xFDF37F47)
+         return MT_SAVE_SIZE;
+      return EEPROM_SAVE_SIZE;
+   }
+   return 0;
 }
 
 void retro_init(void)
@@ -1097,6 +1106,16 @@ void retro_run(void)
 {
    bool updated = false;
 
+   /* On the first frame, unpack save data that the frontend loaded
+    * into our RETRO_MEMORY_SAVE_RAM buffer after retro_load_game(). */
+   if (save_data_needs_unpack)
+   {
+      save_data_needs_unpack = false;
+      if (jaguarMainROMCRC32 != 0xFDF37F47)
+         eeprom_unpack_save_buf();
+      /* Memory Track: mtMem was written directly, no unpack needed. */
+   }
+
    if (environ_cb(RETRO_ENVIRONMENT_GET_VARIABLE_UPDATE, &updated) && updated)
       check_variables();