Feat/doom (#101)

* wip doom

* wip

* add doom which compiles

* fleshing out

* wip audio video

* working gfx display

* fix inputs

* wip moving doom over to shared memory

* wip moving more into shared memory

* add boxart

* add doom ultimate boxart

* update to latest tool

* continue moving doom to shared memory

* move more into shared memory

* wip

* reduce sd card overhead and allow palette access.

* abort if error

* WIP shared memory actually working again

* fix sizeof issue

* more WIP and working shared memory

* increase shared memory again

* enable doom

* moving more and more into shared memory

* move lcd struct and bgdup into shared memory for gbc

* fix gbc

* update to better work across multiple emulators

* fix ppu issue with palette

* ensure doom cart frees memory

* bump shared memory back to 150k for Genesis emulator

* 145k for shared memory

* wip using pool allocator for better memory performance accross emulators without having to (re-)allocate the romdata which can fail. update to use menu mutex and to make images spans instead of vectors for better memory performance

* update log

* update readme

* update espp

* ignore prboom in sa

* fix audio memset issue

* fix sound emulation in doom; update to pause sound when doom is paused; update to have menu / game perform better (doom) by adding appropriate sleeps in the main loop and audio task; update pool to be able to query if pointer is in pool or not

* better reliability and working save/load game in box-emu menu

* update readme and improve sound a little; also make it so the game saves/loads while still in menu

Author: finger563

.github/workflows/static_analysis.yml

@@ -29,4 +29,4 @@ jobs:
         esp_idf_version: release/v5.4
 
         # (Optional) cppcheck args
-        cppcheck_args: -i$GITHUB_WORKSPACE/components/gbc/gnuboy -i$GITHUB_WORKSPACE/components/nes/nofrendo -i$GITHUB_WORKSPACE/components/msx/fmsx -i$GITHUB_WORKSPACE/components/sms/smsplus  -i$GITHUB_WORKSPACE/components/genesis/gwenesis -i$GITHUB_WORKSPACE/components/gui/generated -i$GITHUB_WORKSPACE/components/menu/generated -i$GITHUB_WORKSPACE/components/jpegdec --check-level=exhaustive --force --enable=all --inline-suppr --inconclusive --platform=mips32 --std=c++17 --suppressions-list=$GITHUB_WORKSPACE/suppressions.txt
+        cppcheck_args: -i$GITHUB_WORKSPACE/components/gbc/gnuboy -i$GITHUB_WORKSPACE/components/nes/nofrendo -i$GITHUB_WORKSPACE/components/msx/fmsx -i$GITHUB_WORKSPACE/components/doom/prboom -i$GITHUB_WORKSPACE/components/sms/smsplus  -i$GITHUB_WORKSPACE/components/genesis/gwenesis -i$GITHUB_WORKSPACE/components/gui/generated -i$GITHUB_WORKSPACE/components/menu/generated -i$GITHUB_WORKSPACE/components/jpegdec --check-level=exhaustive --force --enable=all --inline-suppr --inconclusive --platform=mips32 --std=c++17 --suppressions-list=$GITHUB_WORKSPACE/suppressions.txt

CMakeLists.txt

@@ -21,17 +21,17 @@ set(GBC_COMPONENTS "gbc")
 ### SMS ###
 set(SMS_COMPONENTS "sms")
 
-### SNES ###
-# set(SNES_COMPONENTS "snes")
-
 ### MSX ###
 set(MSX_COMPONENTS "msx")
 
 ### GENESIS ###
 set(GENESIS_COMPONENTS "genesis")
 
 ### DOOM ###
-# set(DOOM_COMPONENTS "doom")
+set(DOOM_COMPONENTS "doom")
+
+### SNES ###
+# set(SNES_COMPONENTS "snes")
 
 add_compile_definitions(BOARD_HAS_PSRAM)
 

README.md

@@ -7,6 +7,32 @@
     </tr>
 </table>
 
+![image](https://github.com/user-attachments/assets/209ed9aa-22f0-4ee0-9868-65abb1b64bbc)
+
+https://github.com/user-attachments/assets/2d3da6ea-2e80-42c3-bbd6-5a2c59601201
+
+<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
+**Table of Contents**
+
+- [esp-box-emu](#esp-box-emu)
+  - [Overview](#overview)
+  - [Images and Videos](#images-and-videos)
+  - [Parts](#parts)
+  - [Features](#features)
+  - [Cloning](#cloning)
+  - [Build and Flash](#build-and-flash)
+  - [Rom Setup and Configuration (uSD Card)](#rom-setup-and-configuration-usd-card)
+    - [ROM Images](#rom-images)
+    - [Metadata.csv format](#metadatacsv-format)
+  - [References and Inspiration:](#references-and-inspiration)
+    - [Other NES Emulators](#other-nes-emulators)
+    - [Other Genesis Emulators](#other-genesis-emulators)
+    - [Useful Background / Information](#useful-background--information)
+
+<!-- markdown-toc end -->
+
+## Overview
+
 The ESP-BOX-EMU is a gameboy-inspired add-on for the ESP32-S3-BOX and
 ESP32-S3-BOX-3 which provides:
 - Game Controller (gamepad input with a/b/x/y, start/select, d-pad)
@@ -30,16 +56,27 @@ ESP32-S3-BOX-3 which provides:
     - Unlocked mode (fastest execution), toggled with the X button
   - Genesis emulator (gwenesis) - full speed / buttery smooth when muted; unmuted it runs a little slower but has nice sound
     - Regular Controls (D-Pad/A/B/C/Start/Select) (note: A is mapped to B, B is mapped to A, and C is mapped to Y)
+  - Doom engine (prboom) - full speed with audio and control inputs. A is fire/enter, B is strafe/backspace, X is use, Y is weapontoggle, START is escape, and SELECT is map.
   - LVGL main menu with rom select (including boxart display) and settings page
     (all generated from Squareline Studio)
   - LVGL emulation paused menu with save slot select, save slot image display,
     and configuration (sound, brightness, display, etc.). (all generated from
     Squareline Studio)
 
+## Images and Videos
+
+![image](https://github.com/user-attachments/assets/d867d5fa-4c22-42e3-b04f-1edd5288c5d2)
+![image](https://github.com/user-attachments/assets/ad892905-37d4-4e16-8d5f-a7ff8d2a2c52)
+![image](https://github.com/user-attachments/assets/b141daab-2cda-481c-98c2-980b012f177e)
+
+![image](https://github.com/user-attachments/assets/d23659b6-10d4-4375-8017-675e156a1a4b)
+
 https://github.com/esp-cpp/esp-box-emu/assets/213467/3b77f6bd-4c42-417a-9eb7-a648f31b4008
 
 https://github.com/esp-cpp/esp-box-emu/assets/213467/a3d18d03-c6a1-4911-89d1-e18119e8cc03
 
+## Parts
+
 This project is designed to be in the same form factor as the Gameboy Color and
 to reuse the same button plastics and membranes for a good play feel.
 
@@ -84,8 +121,9 @@ This project has the following features (still WIP):
    - [x] Sega Master System (SMS) / GameGear (GG) emulator
    - [x] MSX emulator
    - [x] Sega Mega Drive / Genesis emulator
+   - [x] Doom
+   - [ ] Dark Forces (WIP)
    - [ ] SNES emulator (WIP)
-   - [ ] Doom (WIP)
  - [x] uSD card (FAT) filesystem over SPI
  - [x] TinyUSB MSC device for optionally exposing the uSD to the attached USB host
  - [x] Memory mapping of selected rom data from storage into raw data partition

boxart/doom_2_boxart.jpg

@@ -1,2 +1,2 @@
 #!/bin/bash
-find . -maxdepth 1 -iname "*.jpg" | xargs -L1 -I{} convert -resize 100x "{}" ../"{}"
+find . -maxdepth 1 -iname "*.jpg" | xargs -L1 -I{} magick -quiet "{}" -resize 100x ../"{}"