Merge pull request #34 from fhoedemakers/pico_hdmi

Refactor audio handling, fix save state regression, and update changelog

Author: fhoedemakers

CHANGELOG.md

@@ -1,19 +1,93 @@
 # CHANGELOG
 
+> **HSTX replaces PicoDVI** on more boards, **HSTX now has picture and sound over HDMI**, in-game game reset, automatic headphone detection on Fruit Jam, and a save-state crash fix.
+
 # General Info
 
+
 [Binaries for each configuration and PCB design are at the end of this page](#downloads___).
 
 
 [See setup section in in Pico-infoNesPlus readme how to install and wire up](https://github.com/fhoedemakers/pico-infonesPlus#pico-setup)
 
-# v0.24 Release Notes
+# v0.25 Release notes
+
+This release replaces PicoDVI with HSTX on more boards, HSTX now also carries audio over HDMI,
+adds smoother on-screen motion, a few new in-game conveniences, and a
+handful of fixes that make the emulator more reliable in everyday use.
+
+A huge thank you to [@fliperama86](https://github.com/fliperama86) for the
+excellent [pico_hdmi](https://github.com/fliperama86/pico_hdmi) driver that
+made the new HDMI output possible, and for all the help along the way.
+
+## What's new
+
+### Video and sound over a single HDMI cable
+
+On the technical side, several RP2350 board configurations have switched
+from the **PicoDVI** software-driven video output to **HSTX**, the
+RP2350's dedicated High-Speed Serial Transmit hardware (GPIO 12 – 19).
+HSTX has been used for video on some boards before, but in this release
+it also carries **audio embedded in the HDMI stream** for the first
+time — that's the new capability HSTX gains here. (PicoDVI has always
+been able to embed audio; HSTX is just catching up on that front while
+offloading the work from the CPU to dedicated hardware.)
+
+In practice, on these boards picture and sound now travel together over a
+single HDMI cable — no separate audio jack needed:
+
+- Adafruit Fruit Jam
+- Murmulator M2
+
+These RP2350 boards have also been switched from PicoDVI to HSTX. They
+keep using a separate audio output for now, but picture quality should
+look the same and the change frees up CPU cycles for future improvements:
+
+- [Breadboard build](https://github.com/fhoedemakers/pico-infonesPlus?tab=readme-ov-file#raspberry-pi-pico-or-pico-2-setup-with-adafruit-hardware-and-breadboard)
+- [PCB build](https://github.com/fhoedemakers/pico-infonesPlus?tab=readme-ov-file#pcb-with-raspberry-pi-pico-or-pico-2)
+- [Adafruit Metro RP2350](https://github.com/fhoedemakers/pico-infonesPlus?tab=readme-ov-file#adafruit-metro-rp2350)
+
+All other boards continue to use PicoDVI and work as before.
+
+### Smoother gameplay
+
+Frame timing now follows the display's own refresh signal, which removes
+small stutters and gives the picture a more consistent, smooth feel.
+
+### New options and conveniences
+
+- **Reset the running game** from the in-game menu — no need to power-cycle
+  the device to restart.
+- **Enter flashing mode from the settings menu**, so you can update the
+  firmware without having to unplug the device and hold the BOOTSEL button.
+- **Scanline effect for HDMI boards** — turn on the classic CRT scanline
+  look from the settings menu when running on an HDMI-capable board.
+
+### Adafruit Fruit Jam
+
+- **Automatic headphone detection.** Plug headphones in and the built-in
+  speaker mutes itself; unplug them and the speaker comes back. The old
+  manual mute setting and pushbutton-1 mute shortcut have been removed —
+  they are no longer needed.
 
 ## Fixes
 
-- Emulator buffers are now allocated dynmically. 
-- Pimoroni Pico DV Demo base: Settings are accessible from within the menu again.
-- ENding a game will now go back to the menu instead of rebooting the board.
+- **Save states work again.** A bug introduced in v0.24 could crash the
+  emulator when loading a saved game. This is now fixed. Note: save state
+  files created by earlier v0.25 development builds are not compatible
+  with this fix and will need to be re-created.
+- **Picture-loss recovery.** On the new HSTX output when set to
+  video-only (DVI) mode, the monitor could occasionally lose the picture.
+  The emulator now detects this and automatically restores the signal
+  without needing a restart. (Not observed in full HDMI mode, but the
+  same safety net is enabled there too just in case.)
+- **Screen cropping fix.** A small visual glitch where part of the game
+  picture was being cut off incorrectly has been corrected.
+
+## Credits
+
+Updated to acknowledge new contributors — see the splash screen on
+startup.
 
 # previous changes
 

CMakeLists.txt

@@ -14,14 +14,14 @@ message("* Current build type is : ${CMAKE_BUILD_TYPE}")
 
 
 if (NOT HW_CONFIG)
-    set(HW_CONFIG 1 CACHE STRING "Select the hardware configuration for your board")       
+    set(HW_CONFIG 8 CACHE STRING "Select the hardware configuration for your board")       
 endif()
 if (NOT USE_HSTX)
     set(USE_HSTX 1 CACHE STRING "Use HSTX for display output when possible")
 endif()
 include("pico_shared/BoardConfigs.cmake")
 if (NOT PICO_BOARD )
-    set(PICO_BOARD pico CACHE STRING "Board type")
+    set(PICO_BOARD pico2 CACHE STRING "Board type")
     message("PICO_BOARD not set, using default: ${PICO_BOARD}")
 endif()
 add_definitions( -DNDEBUG )
@@ -100,6 +100,8 @@ target_compile_definitions(${projectname} PUBLIC
     GPIOHSTXINVERTED=${GPIOHSTXINVERTED} # Set to 1 if HSTX pins are inverted: D- = D+ -1
     ENABLE_VU_METER=${ENABLE_VU_METER} # Enable VU meter (fruitjam NeoPixel leds)
     WIIPAD_DELAYED_START=${WIIPAD_DELAYED_START}
+    #HSTX_DEBUG=1
+    ENABLEDVI=1
     #PICO_DEBUG_MALLOC=1
 )
 if(NOT PICO_PLATFORM STREQUAL "rp2040")

HISTORY.md

@@ -1,5 +1,13 @@
 # History of changes
 
+# v0.24 Release Notes
+
+## Fixes
+
+- Emulator buffers are now allocated dynmically. 
+- Pimoroni Pico DV Demo base: Settings are accessible from within the menu again.
+- Ending a game will now go back to the menu instead of rebooting the board.
+
 # v0.23 Release Notes
 
 - Implemented savestates [#140](https://github.com/fhoedemakers/pico-infonesPlus/issues/140)

README.md

@@ -9,6 +9,10 @@ You can organize the roms in directories. A menu is displayed on which you can s
 
 Supports two controllers for two player Master System games. [See "about two player games" below for specifics and limitations](#about-two-player-games) 
 
+Save and load state possible.
+
+Battery backed saves stored on SD for games that support this. 
+
 See the [releases](https://github.com/fhoedemakers/pico-smsplus/releases/latest) page for the supported RP2040/RP2350 boards.
 
 ***
@@ -77,6 +81,8 @@ These boards already contain an RP2040 cpu, a separate Raspberry Pi Pico is not
 - [Pimoroni Pico Plus 2](https://shop.pimoroni.com/products/pimoroni-pico-plus-2?variant=42092668289107)
   Use the breadboard config or Pimoroni Pico DV Demo base. This board does not fit the PCB because of the SP/CE connector on back of the board.
   The PSRAM on the board is used in stead of flash to load the roms from SD.
+- [Waveshare RP2350-PiZero](https://www.waveshare.com/rp2350-pizero.htm)
+
 
 ## Waveshare RP2040 & RP2350 Zero
 

main.cpp

@@ -58,22 +58,25 @@ static uint32_t CPUFreqKHz = EMULATOR_CLOCKFREQ_KHZ;
 // Order must match enum in menu_options.h
 const int8_t g_settings_visibility_sms[MOPT_COUNT] = {
     0,                               // Exit Game, or back to menu. Always visible when in-game.
+    0,                               // Reset Game. Always visible when in-game.
     0,                               // Save / Restore State
     !HSTX,                           // Screen Mode (only when not HSTX)
     HSTX,                            // Scanlines toggle (only when HSTX)
     1,                               // FPS Overlay
     0,                               // Audio Enable
     0,                               // Frame Skip
-    (EXT_AUDIO_IS_ENABLED && !HSTX), // External Audio
+    (HSTX && ENABLEDVI),             // Display Mode HDMI or DVI
+    (EXT_AUDIO_IS_ENABLED),          // External Audio
     1,                               // Font Color
     1,                               // Font Back Color
     ENABLE_VU_METER,                 // VU Meter
-    (HW_CONFIG == 8),                // Fruit Jam Internal Speaker
+    //(HW_CONFIG == 8),              // Fruit Jam Internal Speaker
     (HW_CONFIG == 8),                // Fruit Jam Volume Control
     0,                               // DMG Palette (SMS/Game Gear emulator does not use GameBoy palettes)
     0,                               // Border Mode (Super Gameboy style borders not applicable for SMS/Game Gear)
     0,                               // Rapid Fire on A
     0,                               // Rapid Fire on B
+    1                                // Enter bootsel mode
 };
 const uint8_t g_available_screen_modes_sms[] = {
 #if PICO_RP2350
@@ -99,7 +102,8 @@ const uint8_t g_available_screen_modes_sms[] = {
 #define FPSSTART (((MARGINTOP + 7) / 8) * 8)
 #define FPSEND ((FPSSTART) + 8)
 
-bool reset = false;
+static bool reset = false;
+static bool resetGame = false;
 
 #if WII_PIN_SDA >= 0 and WII_PIN_SCL >= 0
 // Cached Wii pad state updated once per frame in ProcessAfterFrameIsRendered()
@@ -289,7 +293,22 @@ static void inline processaudioPerFrameDVI()
         written += n;
     }
 }
-#endif // !HSTX
+#else // !HSTX
+static void inline processaudioPerFrameHSTX() {
+     for (int i = 0; i < snd.bufsize; i++)
+    {
+        short l = snd.buffer[0][i];
+        short r = snd.buffer[1][i];
+        hstx_push_audio_sample(l >> 2, r >> 2);
+#if ENABLE_VU_METER
+        if (settings.flags.enableVUMeter)
+        {
+            addSampleToVUMeter(l);
+        }
+#endif
+    }
+}
+#endif
 static void inline processaudioPerFrameI2S()
 {
     for (int i = 0; i < snd.bufsize; i++)
@@ -479,7 +498,7 @@ extern "C" void in_ram(sms_render_line)(int line, const uint8_t *buffer)
         sbuffer = currentLineBuf + 32 + (IS_GG ? 48 : 0);
         if (buffer)
         {
-            for (int i = screenCropX + (IS_GG ? 0 : 8); i < BMP_WIDTH - screenCropX; i++)
+            for (int i = screenCropX ; i < BMP_WIDTH - screenCropX; i++)
             {
                 sbuffer[i - screenCropX] = palette444[(buffer[i + BMP_X_OFFSET]) & 31];
             }
@@ -508,7 +527,7 @@ extern "C" void in_ram(sms_render_line)(int line, const uint8_t *buffer)
     sbuffer = currentLineBuf + 32 + (IS_GG ? 48 : 0);
     if (buffer)
     {
-        for (int i = screenCropX + (IS_GG ? 0 : 8); i < BMP_WIDTH - screenCropX; i++)
+        for (int i = screenCropX ; i < BMP_WIDTH - screenCropX; i++)
         {
             sbuffer[i - screenCropX] = palette444[(buffer[i + BMP_X_OFFSET]) & 31];
         }
@@ -709,7 +728,9 @@ void loadoverlay()
 
 static inline int ProcessAfterFrameIsRendered()
 {
+    Frens::pollHeadPhoneJack();
     Frens::PaceFrames60fps(false);
+    //Frens::waitForVSync();
 #if NES_PIN_CLK != -1
     nespad_read_start();
 #endif
@@ -767,6 +788,10 @@ static inline int ProcessAfterFrameIsRendered()
             loadSaveStateMenu = true;
             quickSaveAction = SaveStateTypes::NONE;
         }
+        if ( rval == 5)
+        {
+            reset = resetGame = true;
+        }
         loadoverlay();
     }
     if (loadSaveStateMenu)
@@ -1055,22 +1080,20 @@ void in_ram(process)(void)
     {
         processinput(&pdwPad1, &pdwPad2, &pdwSystem, false, nullptr);
         sms_frame(0);
-#if !HSTX
 #if EXT_AUDIO_IS_ENABLED
-        if (settings.flags.useExtAudio == 1)
+        if (settings.flags.useExtAudio == 1 || Frens::isHeadPhoneJackConnected())
         {
             processaudioPerFrameI2S();
-        }
-        else
+        } else
+#endif
         {
+#if !HSTX
             processaudioPerFrameDVI();
-        }
 #else
-        processaudioPerFrameDVI();
-#endif
-#else
-        processaudioPerFrameI2S();
-#endif // !HSTX
+       
+            processaudioPerFrameHSTX();
+#endif 
+        }
         ProcessAfterFrameIsRendered();
     }
 }
@@ -1106,6 +1129,8 @@ int main()
     isFatalError = !Frens::initAll(selectedRom, CPUFreqKHz, MARGINTOP, MARGINBOTTOM, AUDIOBUFFERSIZE, false, true);
 #if !HSTX
     scaleMode8_7_ = Frens::applyScreenMode(settings.screenMode);
+#else
+    hstx_setScanLines(settings.flags.scanlineOn);
 #endif
     bool showSplash = true;
     g_settings_visibility = g_settings_visibility_sms;
@@ -1123,7 +1148,7 @@ int main()
         reset = false;
         fileSize = 0;
         isGameGear = false;
-        EXT_AUDIO_MUTE_INTERNAL_SPEAKER(settings.flags.fruitJamEnableInternalSpeaker == 0);
+        //EXT_AUDIO_MUTE_INTERNAL_SPEAKER(settings.flags.fruitJamEnableInternalSpeaker == 0);
         if (Frens::isPsramEnabled())
         {
             // Detect rom type from memory
@@ -1184,17 +1209,20 @@ int main()
         {
             printf("No auto-save configured for this ROM.\n");
         }
-        loadoverlay();
-        load_rom(ROM_FILE_ADDR, fileSize, isGameGear);
-        // Initialize all systems and power on
-        system_init(SMS_AUD_RATE);
-        // load state if any
-        // system_load_state();
-
-        system_reset();
-        printf("Starting game\n");
-        process();
-        system_shutdown();
+        do {
+            reset = resetGame = false;
+            loadoverlay();
+            load_rom(ROM_FILE_ADDR, fileSize, isGameGear); 
+            // Initialize all systems and power on
+            system_init(SMS_AUD_RATE);
+            // load state if any
+            // system_load_state();
+            system_reset();
+            printf("Starting game\n");
+            Frens::PaceFrames60fps(true); 
+            process();
+            system_shutdown();
+        } while (resetGame);
         selectedRom[0] = 0;
         showSplash = false;
 #if ENABLE_VU_METER

pico_shared

@@ -95,7 +95,6 @@ typedef struct
 
 //     return 1;
 // }
-void *frens_f_malloc(size_t size);
 int load_rom(uintptr_t addr,   int size, bool isGameGear)
 {
     uint8_t *start = (uint8_t *)addr;
@@ -106,8 +105,6 @@ int load_rom(uintptr_t addr,   int size, bool isGameGear)
     }
     sms.use_fm = 0;
     sms.country = TYPE_OVERSEAS;
-    sms.ram = (uint8 *)frens_f_malloc(RAMSIZEBYTES);    
-    sms.sram = (uint8 *)frens_f_malloc(SRAMSIZEBYTES);
     sms.dummy = smsBufferLine;
     bitmap.data = smsBufferLine;
     bitmap.width = BMP_WIDTH;

smsplus/loadrom.c

@@ -29,7 +29,9 @@ extern "C" {
 #define strcasecmp stricmp
 #endif
 #endif
-
+#if PICO_RP2350
+#define in_ram
+#endif
 #ifndef in_ram
 #ifdef PICO_BOARD
 #include <pico.h>