Implementation of a new terminal frontend (#179)

* working term implementation

* Update README.md

Author: FRoith

Cargo.lock

@@ -1,32 +1,33 @@
-[workspace]
-members = [
-    "core",
-    "arm7tdmi",
-    "utils",
-    "platform/rustboyadvance-sdl2",
-    "platform/rustboyadvance-libretro",
-    # "platform/rustboyadvance-minifb", - DEPRECATED
-    "platform/rustboyadvance-wasm",
-    "platform/rustboyadvance-jni",
-    "fps_bench"
-]
-
-default-members = ["platform/rustboyadvance-sdl2"]
-
-
-[profile.dev]
-opt-level = 2
-debug = true
-
-[profile.release]
-debug = false
-
-[profile.release-dev]
-inherits = "release"
-opt-level = 3
-debug = true
-debug-assertions = false
-
-[profile.release-lto]
-inherits = "release"
-lto = true
+[workspace]
+members = [
+    "core",
+    "arm7tdmi",
+    "utils",
+    "platform/rustboyadvance-sdl2",
+    "platform/rustboyadvance-libretro",
+    # "platform/rustboyadvance-minifb", - DEPRECATED
+    "platform/rustboyadvance-wasm",
+    "platform/rustboyadvance-jni",
+    "platform/rustboyadvance-term",
+    "fps_bench"
+]
+
+default-members = ["platform/rustboyadvance-sdl2"]
+
+
+[profile.dev]
+opt-level = 2
+debug = true
+
+[profile.release]
+debug = false
+
+[profile.release-dev]
+inherits = "release"
+opt-level = 3
+debug = true
+debug-assertions = false
+
+[profile.release-lto]
+inherits = "release"
+lto = true

Cargo.toml

@@ -20,6 +20,7 @@ WebAssembly Demo: https://michelhe.github.io/rustboyadvance-ng/ ![Deploy](https:
     * `platform/rustbodyadvance-sdl2` - Desktop application built with sdl2
     * `platform/rustbodyadvance-minifb` - Desktop application built with minifb, *not maintained*.
     * `platform/rustbodyadvance-jni` - Java JNI binidngs for the emulator.
+    * `platform/rustbodyadvance-term` - A full in-terminal frontend implemented via crossterm and viuer by @FRoith.
     * `platform/android` - A PoC Android application.
 
 # Progress

README.md

@@ -0,0 +1,26 @@
+[package]
+name = "rustboyadvance-term"
+version = "0.1.0"
+authors = ["Felix Roithmayr <[email protected]>"]
+edition = "2018"
+
+[dependencies]
+rustboyadvance-core = { path = "../../core/", features = ["elf_support"] }
+rustboyadvance-utils = { path = "../../utils/" }
+structopt = "0.3"
+bit = "^0.1"
+tinyaudio = "1.1.0"
+tokio = { version = "1.44.2", features = ["full"] }
+crossterm = { version = "0.29.0", features = ["event-stream"] }
+image = "0.25.6"
+futures = "0.3.31"
+color-eyre = "0.6.4"
+viuer = "0.9.1"
+
+[target.'cfg(windows)'.build-dependencies]
+winres = "0.1"
+
+# [features]
+# default = ["gdb"]
+# debugger = ["rustboyadvance-core/debugger"]
+# gdb = ["rustboyadvance-core/gdb"]

platform/rustboyadvance-term/Cargo.toml

@@ -0,0 +1,32 @@
+use rustboyadvance_core::prelude::SimpleAudioInterface;
+
+use tinyaudio::prelude::*;
+
+pub fn create_audio_player() -> (Box<SimpleAudioInterface>, OutputDevice) {
+    let desired_spec = OutputDeviceParameters {
+        sample_rate: 44_100,
+        channels_count: 2, // stereo
+        channel_sample_count: 44_100 / 30,
+    };
+
+    let freq = desired_spec.sample_rate as i32;
+    let ringbuf_size = desired_spec.channel_sample_count * 2;
+
+    let (audio_device, mut consumer) =
+        SimpleAudioInterface::create_channel(freq, Some(ringbuf_size));
+
+    let r = run_output_device(desired_spec, move |data| {
+        'outer: for samples in data.chunks_mut(desired_spec.channels_count) {
+            for sample in samples {
+                if let Some(v) = consumer.pop() {
+                    *sample = v as f32 / i16::MAX as f32;
+                } else {
+                    break 'outer;
+                }
+            }
+        }
+    })
+    .unwrap();
+
+    (audio_device, r)
+}

platform/rustboyadvance-term/src/audio.rs

@@ -0,0 +1,52 @@
+name: rba-term
+author: Felix Roithmayr <[email protected]>
+about: RustBoyAdvance port with terminal frontend
+args:
+    - bios:
+        help: Sets the bios file to use
+        short: b
+        required: false
+        default_value: gba_bios.bin
+    - game_rom:
+        long: game-rom
+        takes_value: true
+        help: Sets the game-rom file to use
+        required: false
+        index: 1
+    - save_type:
+        short: s
+        help: Override save type, useful for troublemaking games that fool the auto detection
+        required: false
+        default_value: autodetect
+        possible_values:
+            - sram
+            - flash128k
+            - flash64k
+            - eeprom
+            - autodetect
+    - rtc:
+        long: rtc
+        help: Force cartridge to have RTC
+        required: false
+    - skip_bios:
+        long: skip-bios
+        help: Skip running bios and start from the ROM instead
+    - debug:
+        long: debug
+        help: Use the custom debugger
+    - silent:
+        long: silent
+        help: Do not output sound
+    - with_gdbserver:
+        long: with-gdbserver
+        help: Start with experimental gdbserver
+        conflicts_with:
+            - debug
+    - script_file:
+        long: script-file
+        short: f
+        takes_value: true
+        help: Text file with debugger commands to run
+        required: false
+        requires:
+            debug

platform/rustboyadvance-term/src/cli.yml

@@ -0,0 +1,33 @@
+use crossterm::event::KeyCode;
+use rustboyadvance_core::keypad as gba_keypad;
+
+use bit;
+use bit::BitIndex;
+
+pub fn on_keyboard_key_down(key_state: &mut u16, scancode: KeyCode) {
+    if let Some(key) = scancode_to_keypad(scancode) {
+        key_state.set_bit(key as usize, false);
+    }
+}
+
+pub fn on_keyboard_key_up(key_state: &mut u16, scancode: KeyCode) {
+    if let Some(key) = scancode_to_keypad(scancode) {
+        key_state.set_bit(key as usize, true);
+    }
+}
+
+fn scancode_to_keypad(scancode: KeyCode) -> Option<gba_keypad::Keys> {
+    match scancode {
+        KeyCode::Up => Some(gba_keypad::Keys::Up),
+        KeyCode::Down => Some(gba_keypad::Keys::Down),
+        KeyCode::Left => Some(gba_keypad::Keys::Left),
+        KeyCode::Right => Some(gba_keypad::Keys::Right),
+        KeyCode::Char('z') => Some(gba_keypad::Keys::ButtonB),
+        KeyCode::Char('x') => Some(gba_keypad::Keys::ButtonA),
+        KeyCode::Enter => Some(gba_keypad::Keys::Start),
+        KeyCode::Backspace => Some(gba_keypad::Keys::Select),
+        KeyCode::Char('a') => Some(gba_keypad::Keys::ButtonL),
+        KeyCode::Char('s') => Some(gba_keypad::Keys::ButtonR),
+        _ => None,
+    }
+}