Merge pull request #167 from dbalsom/0.4.0/audio_latency

0.4.0/audio latency

Author: dbalsom

.gitignore

@@ -99,3 +99,54 @@ icon.png
 /test-gen/
 
 
+/exo_demo/configs/keyboard_layouts/keyboard_IT.toml
+/exo_demo/configs/keyboard_layouts/keyboard_UK.toml
+/exo_demo/configs/keyboard_layouts/keyboard_US.toml
+/exo_demo/configs/machines/acid88.toml
+/exo_demo/configs/machines/compaq_portable.toml
+/exo_demo/configs/machines/config_overlays.toml
+/exo_demo/configs/machines/generic_xt.toml
+/exo_demo/configs/machines/ibm5150.toml
+/exo_demo/configs/machines/ibm5160.toml
+/exo_demo/configs/machines/ibm_pcjr.toml
+/exo_demo/configs/machines/readme.md
+/exo_demo/configs/machines/s100.toml
+/exo_demo/configs/machines/tandy1000.toml
+/exo_demo/media/floppies/Demos/8088MPH (Compo version).img
+/exo_demo/media/floppies/Demos/8088MPH (Final Version).img
+/exo_demo/media/floppies/Demos/Area 5150 (Compo Version).img
+/exo_demo/media/floppies/Demos/AUTOEXEC.BAT
+/exo_demo/media/floppies/Demos/CGADEMO (Codemasters).img
+/exo_demo/media/roms/GLaBIOS/parking/GLABIOS_0.2.6_8EC.ROM
+/exo_demo/media/roms/GLaBIOS/parking/GLABIOS_0.2.6_8P.ROM
+/exo_demo/media/roms/GLaBIOS/parking/GLABIOS_0.2.6_8PC.ROM
+/exo_demo/media/roms/GLaBIOS/parking/GLABIOS_0.2.6_8T.ROM
+/exo_demo/media/roms/GLaBIOS/parking/GLABIOS_0.2.6_8TC.ROM
+/exo_demo/media/roms/GLaBIOS/parking/GLABIOS_0.2.6_8X.ROM
+/exo_demo/media/roms/GLaBIOS/parking/GLABIOS_0.2.6_8XC.ROM
+/exo_demo/media/roms/GLaBIOS/GLABIOS_0.2.5_8PC.ROM
+/exo_demo/media/roms/GLaBIOS/GLABIOS_0.2.5_8TC_PEN.ROM
+/exo_demo/media/roms/GLaBIOS/GLABIOS_0.2.5_8XC.ROM
+/exo_demo/media/roms/GLaBIOS/GLABIOS_0.2.6_8P.ROM
+/exo_demo/media/roms/GLaBIOS/GLABIOS_0.2.6_8PC.ROM
+/exo_demo/media/roms/GLaBIOS/GLABIOS_0.2.6_8T.ROM
+/exo_demo/media/roms/GLaBIOS/GLABIOS_0.2.6_8TC.ROM
+/exo_demo/media/roms/GLaBIOS/GLABIOS_0.2.6_8X.ROM
+/exo_demo/media/roms/GLaBIOS/GLABIOS_0.2.6_8XC.ROM
+/exo_demo/media/roms/romdef.toml
+/exo_demo/media/roms/romdef_ast.toml
+/exo_demo/media/roms/romdef_compaq.toml
+/exo_demo/media/roms/romdef_glabios.toml
+/exo_demo/media/roms/romdef_ibm.toml
+/exo_demo/media/roms/romdef_ibm_pcjr.toml
+/exo_demo/media/roms/romdef_megabios.toml
+/exo_demo/media/roms/romdef_s100.toml
+/exo_demo/media/roms/romdef_tandy.toml
+/exo_demo/8088mph.toml
+/exo_demo/area5150.toml
+/exo_demo/cgademo.toml
+/exo_demo/exo_demo.7z
+/exo_demo/run Area5150.bat
+/exo_demo/run cgademo.bat
+/exo_demo/run 8088mph.bat
+/util/mquit/mquit.com

Cargo.lock

@@ -50,7 +50,7 @@ with both demos.
 
 Currently, MartyPC can emulate an original IBM 5150 PC, 5160 XT, or a generic XT clone machine.
 
-Preliminary support for the IBM PCJr and Tandy 1000 is present as of 0.2.1. These machines may be buggy and unstable.
+Preliminary support for the IBM PCjr and Tandy 1000 is present as of 0.2.1. These machines may be buggy and unstable.
 
 ### Device Support
 MartyPC emulates the following devices:
@@ -59,31 +59,37 @@ MartyPC emulates the following devices:
     * **Intel 8088** - A cycle-accurate implementation of the Intel 8088 including the asynchronous BIU, processor instruction queue and prefetch logic. Tested for correctness and cycle-accuracy against hardware.
     * **NEC V20** - A preliminary implementation of the NEC V20 CPU. Cycle-based, but not fully cycle-accurate or as performant as the real thing, as timings have not been adjusted from the 8088 that was used as a base. All native-mode V20 instructions are implemented and tested for correctness against hardware.
 
-* ### Video Cards:
+* ### System Hardware:
+  * **8255 PPI** - Low level keyboard emulation is supported via the PPI and keyboard shift register. Supports the 'turbo bit' found in TurboXT clones.
+  * **8259 PIC** - Mostly complete, but still missing advanced features such as priority rotation and nested modes.
+  * **8253 PIT** - Highly accurate, supporting PCM audio.
+  * **8237 DMAC** - Mostly implemented, but DMA transfers are currently "faked". DRAM refresh DMA is simulated using a scheduling system.
+  * **8250 UART** - Supports serial passthrough or mouse emulation.
+  * **Game Port** - Supports two analog joysticks with two buttons each.
+  * **Parallel Port** - Enough of a basic parallel port is emulated to be detected, but is not really functional for any purpose yet.
+
+* ### Video Devices:
     * **CGA** - A dynamic, cycle-or-character clocked implementation of the IBM CGA including the Motorola MC6845 CRTC controller allows MartyPC to run demanding PC demos like 8088MPH and Area5150. MartyPC takes a unique approach to PC video card emulation by simulating the entire display field - including overscan. Composite output and monitor simulation is supported, via reenigne's excellent composite conversion code (also used by DOSBox and 86Box) 
     * **TGA** - A character-clocked implementation of the PCJr and Tandy Graphics Video Gate Array. Work in progress.
     * **MDA** - A character-clocked implementation of the IBM MDA card built on the Motorola MC6845 CRTC controller. An MDA adapter can be installed alongside a CGA or EGA card for multi-monitor operation.
     * **Hercules** - The MDA device optionally supports emulation of the Hercules Graphics Adapter.
     * **EGA** - A character-clocked implementation of the IBM EGA builds on the techniques used developing the CGA. It is structured to replicate the logical functions of each of the LSI chips on the original hardware. It supports redefinable fonts, vsync interrupts and per-scanline pel-panning for smooth scrolling.  
+    * **VGA** - IBM VGA card emulation is in development, but graphics modes such as Mode 13h and Mode X are working.
+
+* ### Sound Devices: 
+    * **PC Speaker** - Not really its own sound device, the PC speaker is driven by MartyPC's timer chip emulation. It can produce reasonable quality PWM audio in demos such as 8088MPH, Area5150, and Magic Mushroom.
+    * **Adlib** - The original Adlib Music Synthesizer is emulated, with OPL2 emulation provided by nuked-opl3, via my [opl3-rs](https://github.com/dbalsom/opl3-rs) bidings. This is a bit CPU heavy, so you'll need a fast computer. 
 
 * ### Storage Devices:
     * **µPD765 FDC** - Currently robust enough to support both DOS and Minix operating systems. MartyPC uses my disk 
                        image library, [fluxfox](https://github.com/dbalsom/fluxfox/), which allows it to support a wide variety of PC disk image formats.
                        MartyPC's FDC emulation is still not as accurate as I'd like it to be, but it can support a number
                        of copy-protected titles, given a disk image of the appropriate format.
-    * **IBM/Xebec 20MB HDC** - Emulated with basic VHD support. MartyPC currently supports a single disk geometry of 20MB.
-    * **PCJr Cartridges** - PCJr cartridge ROMs are supported, in JrRipCart (.JRC) format
+    * **IBM/Xebec 20MB HDC** - Emulated with basic VHD support. MartyPC currently supports a single disk geometry of 20MB when using this controller.
+    * **XTIDE** - Emulation of an XTIDE Rev 2 board allows MartyPC to support a wide range of hard disk formats. This emulation is still in early stages, and may be a bit rough around the edges. Not all ATA commands are implemented.
+    * **PCjr Cartridges** - PCjr cartridge ROMs are supported, in JrRipCart (.JRC) format
 
-* ### System Hardware:
-    * **8255 PPI** - Low level keyboard emulation is supported via the PPI and keyboard shift register. Supports the 'turbo bit' found in TurboXT clones.
-    * **8259 PIC** - Mostly complete, but still missing advanced features such as priority rotation and nested modes.
-    * **8253 PIT** - Highly accurate, supporting PCM audio.
-    * **8237 DMAC** - Mostly implemented, but DMA transfers are currently "faked". DRAM refresh DMA is simulated using a scheduling system.
-    * **8250 UART** - Supports serial passthrough or mouse emulation. Still a bit incomplete (fails tests in CheckIt)
-    * **Game Port** - Supports two analog joysticks with two buttons each.
-    * **PC Speaker** - Although sometimes a little glitchy, it can produce reasonable PCM audio in demos such as 8088MPH, Area5150, and Magic Mushroom.
-
-* ### Add-on Cards:
+* ### Memory Expansion Devices:
     * **LoTech 2MB EMS Card** - 2MB of EMS memory is made available via the [LoTech EMS board](https://www.lo-tech.co.uk/wiki/Lo-tech_2MB_EMS_Board).  
 
 * ### Input Devices:

README.md

@@ -58,7 +58,7 @@ use crate::event_loop::web_keyboard::handle_web_key_event;
 
 use crossbeam_channel::{Receiver, Sender};
 
-use egui::{Context, RawInput, Sense, ViewportId};
+use egui::{Context, RawInput, Sense, ViewportCommand, ViewportId};
 
 use crate::emulator_builder::builder::EmuBuilderError;
 #[cfg(target_arch = "wasm32")]
@@ -80,6 +80,7 @@ pub struct MartyApp {
     current_size: egui::Vec2,
     last_size: egui::Vec2,
     focused: bool,
+    hide_menu: bool,
     #[serde(skip)]
     gui: GuiRenderContext,
     #[serde(skip)]
@@ -107,6 +108,7 @@ impl Default for MartyApp {
         let (sender, receiver) = crossbeam_channel::bounded(1);
 
         Self {
+            hide_menu: false,
             current_size: egui::Vec2::ZERO,
             last_size: egui::Vec2::INFINITY,
             focused: false,
@@ -136,7 +138,7 @@ impl MartyApp {
     /// We split app initialization into two parts, since we can't make the callback eframe passes
     /// the creation context to async. So we first create the app, then let eframe call `init` with
     /// the partially initialized app - it should have the emulator built by then.
-    pub async fn new(_native_options: &mut MartyAppNewOptions) -> Self {
+    pub async fn new(native_options: &mut MartyAppNewOptions) -> Self {
         // Build the emulator.
         let mut emu_builder = EmulatorBuilder::default();
         let emu_result;
@@ -226,8 +228,8 @@ impl MartyApp {
                     }
                     EmuBuilderError::BadMachineConfig(e) =>{
                         format!("MartyPC encountered an error reading its Machine Configuration files!\n\
-                        At least one machine configuration TOML file in /configs/machines appears to be invalid or corrupt.\n\n\
-                        The error reported was:\n{e}")
+                        The specified machine configuration could not be found:\n\n\
+                        '{e}'")
                     }
                     EmuBuilderError::IOError(e) => e.to_string(),
                     EmuBuilderError::Other(e) => e.to_string(),
@@ -253,6 +255,14 @@ impl MartyApp {
         let mut timestep_manager = TimestepManager::new();
         timestep_manager.set_cpu_mhz(emu.machine.get_cpu_mhz());
 
+        // Set eframe's NativeOptions for fullscreen if specified by config
+        if let Some(window) = emu.config.emulator.window.get_mut(0) {
+            if window.fullscreen {
+                native_options.viewport.inner_size = None;
+                native_options.viewport.fullscreen = Some(true);
+            }
+        }
+
         MartyApp {
             emu: Some(emu),
             tm: timestep_manager,
@@ -275,11 +285,19 @@ impl MartyApp {
 
         let mut emu = self.emu.take().expect("Emulator should have been Some, but was None");
 
+        // Apply fullscreen configuration now (doesn't seem to work applying to NativeOptions in new())
+
+        if let Some(window) = emu.config.emulator.window.get_mut(0) {
+            let _ = &cc
+                .egui_ctx
+                .send_viewport_cmd(ViewportCommand::Fullscreen(window.fullscreen));
+        }
+
         // Get a list of video devices from machine.
         let cardlist = emu.machine.bus().enumerate_videocards();
 
         // Find the maximum refresh rate of all video cards
-        let mut highest_rate = 50;
+        let mut highest_rate = 50.0;
         for card in cardlist.iter() {
             let rate = emu.machine.bus().video(&card).unwrap().get_refresh_rate();
             if rate > highest_rate {
@@ -290,12 +308,20 @@ impl MartyApp {
         self.tm.set_emu_update_rate(highest_rate);
         self.tm.set_emu_render_rate(highest_rate);
 
+        self.hide_menu = if emu.config.emulator.demo_mode {
+            true
+        }
+        else {
+            emu.config.gui.disabled
+        };
+
+        // TODO: Re-implement this stuff?
         // Create GUI parameters for the Display Manager.
         let gui_options = DmGuiOptions {
             enabled: !emu.config.gui.disabled,
             theme: emu.config.gui.theme,
             menu_theme: emu.config.gui.menu_theme,
-            menubar_h: EGUI_MENU_BAR_HEIGHT, // TODO: Dynamically measure the height of the egui menu bar somehow
+            menubar_h: EGUI_MENU_BAR_HEIGHT, // ignored on eframe
             zoom: emu.config.gui.zoom.unwrap_or(1.0),
             debug_drawing: false,
         };
@@ -420,6 +446,12 @@ impl MartyApp {
             }
         });
 
+        // Initialize sound info
+        // -- Update sound sources
+        if let Some(si) = emu.si.as_ref() {
+            emu.gui.init_sound_info(si.info());
+        }
+
         // Insert floppies specified in config.
         match emu.insert_floppies(emu.sender.clone()) {
             Ok(_) => {
@@ -530,6 +562,7 @@ impl eframe::App for MartyApp {
                     handle_window_event(
                         emu,
                         self.dm.as_mut().unwrap(),
+                        ctx.clone(),
                         &mut self.tm,
                         event.0,
                         event.1,
@@ -557,7 +590,7 @@ impl eframe::App for MartyApp {
             let dm = self.dm.as_mut().unwrap();
             // Process timestep.
             process_update(emu, dm, &mut self.tm);
-            handle_thread_event(emu);
+            handle_thread_event(emu, ctx);
 
             let fill_color = dm
                 .main_display_target()
@@ -569,9 +602,11 @@ impl eframe::App for MartyApp {
                 .and_then(|c| Some(MartyColor::from_u24(c).to_color32()));
 
             let show_bezel = emu.gui.primary_video_has_bezel();
+
             // Draw the emulator GUI.
             self.gui.show(
                 &mut emu.gui,
+                !self.hide_menu,
                 fill_color,
                 |ctx| {
                     if let Some(DisplayTargetType::GuiWidget) = dm.display_type(DtHandle::MAIN) {