feat: pause emu when UI reads emu state

src/core/emu.zig

@@ -4,7 +4,7 @@ const config = @import("../config.zig");
 
 const Scheduler = @import("scheduler.zig").Scheduler;
 const Arm7tdmi = @import("cpu.zig").Arm7tdmi;
-const FpsTracker = @import("../util.zig").FpsTracker;
+const Tracker = @import("../util.zig").FpsTracker;
 
 const Timer = std.time.Timer;
 const Atomic = std.atomic.Atomic;
@@ -35,18 +35,18 @@ const RunKind = enum {
     LimitedFPS,
 };
 
-pub fn run(quit: *Atomic(bool), scheduler: *Scheduler, cpu: *Arm7tdmi, tracker: *FpsTracker) void {
+pub fn run(quit: *Atomic(bool), pause: *Atomic(bool), cpu: *Arm7tdmi, scheduler: *Scheduler, tracker: *Tracker) void {
     const audio_sync = config.config().guest.audio_sync and !config.config().host.mute;
     if (audio_sync) log.info("Audio sync enabled", .{});
 
     if (config.config().guest.video_sync) {
-        inner(.LimitedFPS, audio_sync, quit, scheduler, cpu, tracker);
+        inner(.LimitedFPS, audio_sync, quit, pause, cpu, scheduler, tracker);
     } else {
-        inner(.UnlimitedFPS, audio_sync, quit, scheduler, cpu, tracker);
+        inner(.UnlimitedFPS, audio_sync, quit, pause, cpu, scheduler, tracker);
     }
 }
 
-fn inner(comptime kind: RunKind, audio_sync: bool, quit: *Atomic(bool), scheduler: *Scheduler, cpu: *Arm7tdmi, tracker: ?*FpsTracker) void {
+fn inner(comptime kind: RunKind, audio_sync: bool, quit: *Atomic(bool), pause: *Atomic(bool), cpu: *Arm7tdmi, scheduler: *Scheduler, tracker: ?*Tracker) void {
     if (kind == .UnlimitedFPS or kind == .LimitedFPS) {
         std.debug.assert(tracker != null);
         log.info("FPS tracking enabled", .{});
@@ -57,6 +57,8 @@ fn inner(comptime kind: RunKind, audio_sync: bool, quit: *Atomic(bool), schedule
             log.info("Emulation w/out video sync", .{});
 
             while (!quit.load(.Monotonic)) {
+                if (pause.load(.Monotonic)) continue;
+
                 runFrame(scheduler, cpu);
                 audioSync(audio_sync, cpu.bus.apu.stream, &cpu.bus.apu.is_buffer_full);
 
@@ -69,6 +71,8 @@ fn inner(comptime kind: RunKind, audio_sync: bool, quit: *Atomic(bool), schedule
             var wake_time: u64 = frame_period;
 
             while (!quit.load(.Monotonic)) {
+                if (pause.load(.Monotonic)) continue;
+
                 runFrame(scheduler, cpu);
                 const new_wake_time = videoSync(&timer, wake_time);
 

src/platform.zig

@@ -378,16 +378,17 @@ pub const Gui = struct {
         const fbo_id = try Self.genFrameBufObject(out_tex);
         defer gl.deleteFramebuffers(1, &fbo_id);
 
-        var quit = std.atomic.Atomic(bool).init(false);
         var tracker = FpsTracker.init();
+        var quit = std.atomic.Atomic(bool).init(false);
+        var pause = std.atomic.Atomic(bool).init(false);
 
-        const thread = try std.Thread.spawn(.{}, emu.run, .{ &quit, scheduler, cpu, &tracker });
+        const thread = try std.Thread.spawn(.{}, emu.run, .{ &quit, &pause, cpu, scheduler, &tracker });
         defer thread.join();
-
-        var title_buf: [0x100]u8 = undefined;
+        defer quit.store(true, .Monotonic); // Terminate Emulator Thread
 
         emu_loop: while (true) {
             var event: SDL.SDL_Event = undefined;
+
             while (SDL.SDL_PollEvent(&event) != 0) {
                 _ = zgui.backend.processEvent(&event);
 
@@ -428,12 +429,6 @@ pub const Gui = struct {
                             SDL.SDLK_s => keyinput.shoulder_r.set(),
                             SDL.SDLK_RETURN => keyinput.start.set(),
                             SDL.SDLK_RSHIFT => keyinput.select.set(),
-                            SDL.SDLK_i => {
-                                comptime std.debug.assert(sample_format == SDL.AUDIO_U16);
-                                log.err("Sample Count: {}", .{@intCast(u32, SDL.SDL_AudioStreamAvailable(cpu.bus.apu.stream)) / (2 * @sizeOf(u16))});
-                            },
-                            // SDL.SDLK_j => log.err("Scheduler Capacity: {} | Scheduler Event Count: {}", .{ scheduler.queue.capacity(), scheduler.queue.count() }),
-                            SDL.SDLK_k => {},
                             else => {},
                         }
 
@@ -443,6 +438,14 @@ pub const Gui = struct {
                 }
             }
 
+            // We Access non-atomic parts of the Emulator here
+            {
+                pause.store(true, .Monotonic);
+                defer pause.store(false, .Monotonic);
+
+                self.state.fps_hist.push(tracker.value()) catch {};
+
+                // Draw GBA Screen to Texture
                 {
                     gl.bindFramebuffer(gl.FRAMEBUFFER, fbo_id);
                     defer gl.bindFramebuffer(gl.FRAMEBUFFER, 0);
@@ -452,7 +455,7 @@ pub const Gui = struct {
                     self.drawGbaTexture(obj_ids, emu_tex, buf);
                 }
 
-            // Background
+                // Background Colour
                 const size = zgui.io.getDisplaySize();
                 gl.viewport(0, 0, @floatToInt(c_int, size[0]), @floatToInt(c_int, size[1]));
                 gl.clearColor(0, 0, 0, 1.0);
@@ -461,17 +464,10 @@ pub const Gui = struct {
                 zgui.backend.newFrame(width, height);
                 self.draw(out_tex, cpu);
                 zgui.backend.draw();
-
-            SDL.SDL_GL_SwapWindow(self.window);
-
-            const emu_fps = tracker.value();
-            self.state.fps_hist.push(emu_fps) catch {};
-
-            const dyn_title = std.fmt.bufPrintZ(&title_buf, "ZBA | {s} [Emu: {}fps] ", .{ self.title, emu_fps }) catch unreachable;
-            SDL.SDL_SetWindowTitle(self.window, dyn_title.ptr);
             }
 
-        quit.store(true, .Monotonic); // Terminate Emulator Thread
+            SDL.SDL_GL_SwapWindow(self.window);
+        }
     }
 
     fn glGetProcAddress(ctx: SDL.SDL_GLContext, proc: [:0]const u8) ?*anyopaque {