Overall improvements

See the changelog

Author: allkern

.gitignore

@@ -10,6 +10,7 @@
 # Precompiled Headers
 *.gch
 *.pch
+precomp/
 
 # Compiled Dynamic libraries
 *.so
@@ -34,11 +35,6 @@
 # Ignore compiled executable
 geebly
 
-# Ignore external libraries
-src/lgw/
-src/imgui/
-src/sfml/
-
 # Ignore test suites
 tests/
 tearoom/
@@ -49,6 +45,7 @@ res/
 
 # Ignore debug build scripts
 build-win-debug.bat
+build-win-debug.ps1
 
 # Ignore all BIOSes/ROMs
 *.gb
@@ -67,3 +64,18 @@ build-win-debug.bat
 # Settings files
 *.json
 build-win-debug.ps1
+build-win-debug.bat
+
+# Temporarily ignore the Linux Makefile
+Makefile
+
+# Etc
+*.sna
+*.asm
+src/memory_editor.h
+src/devices/ppu/naive_ppu.h
+imgui.ini
+.vscode/
+build-win.bat
+.vscode/settings.json
+src/devices/ppu/naive_ppu.hpp

.vscode/settings.json

@@ -0,0 +1,40 @@
+## Geebly 0.8.0-dev Changelog
+Ok, I just finished polishing some details over this last version of Geebly, its been a while since the last release!
+
+I do plan on using this version as an absolute baseline for a functioning emulator, as I've implemented almost all the details I've refrained from working on since development started, and as such, I'm really happy with the state of the emulator right now, code and functionality wise.
+
+Everything is looking clearer, the PPU has been rewritten from scratch (literally!), the SPU is now properly implemented, etc.
+
+Below is a (non-exhaustive) list of important changes:
+
+### Changes
+#### CPU
+ - Bit operations (and other instructions that used `bus::ref`) now properly cause side effects on MMIO
+
+#### PPU
+The PPU has been rewritten from scratch. Now it runs on a much more accurate FIFO-based sub-scanline renderer, compared to the more naive scanline only renderer that was in place before.
+
+ - Sub-scanline renderer implemented
+ - Greatly improved timings
+ - Implemented sprite/background/window priorities (also for CGB mode)
+ - Fixed DMA-related issues (see DMA for more info)
+
+#### SPU/APU
+I've ditched the initial SPU implementation that relied on `SDL_QueueAudio`. The SPU now outputs samples at the Game Boy's real sample rate (2 MHz) and resamples them on-demand (`audio_update_cb`).
+
+ - Ditched `SDL_QueueAudio`, SPU is now callback based, this allowed the fixes below:
+ - Fixed "race conditions" between channels where one channel would empty the buffer for a new sound to play, while another channel might have been pushing samples to the buffer, resulting in the second channel's audio being cut prematurely
+ - The wave channel's pitch will no longer drift
+ - Correctly implemented SPU control registers
+ - Implemented stereo audio + stereo/mono setting
+ - Implemented a master volume setting
+
+#### DMA/HDMA (CGB DMA)
+ - Fixed an issue where WRAM addresses wouldn't have been correctly translated (CGB mode)
+ - `ff55` will always be set to `ff`, this fixes HDMA-related wait loop hanging. Its a hotfix though, I plan on correctly implementing HDMA so it isn't the same as GDMA
+
+#### Codebase
+There have been a lot of improvements to the codebase overall, this looks insignificant to the outside world, but a cleaner, simpler and more concise codebase directly impacts the performance of a project as a whole
+
+### To-do
+I plan on completely rewriting the debugger from the ground up, its already possible to see some advancements on the debug.hpp file. There are many more things to work on, but for now this is the one I'm going to be focusing on! Check the sources for more "To-do"s.

CHANGELOG

@@ -1,28 +1,33 @@
 <p align="center">
-  <img src="https://user-images.githubusercontent.com/15825466/97769482-3c496d00-1b0a-11eb-8930-72a60e210d15.png">
+  <img width="75%" height="75%" src="https://user-images.githubusercontent.com/15825466/117024784-b1bc1300-acd0-11eb-9656-c4f6e1cc391c.png" alt="Geebly">
 </p>
 
+<div align="center">
+  
+#### A Game Boy/Color (DMG/GBC) emulator written in C++
+
 ![workflow badge](https://github.com/Lycoder/Geebly/actions/workflows/windows-workflow.yml/badge.svg)
 ![workflow badge](https://github.com/Lycoder/Geebly/actions/workflows/ubuntu-workflow.yml/badge.svg)
-# Geebly
-A Gameboy/Color emulator written in C++, currently under development.
-<p align="center">
-  <img src="https://user-images.githubusercontent.com/15825466/105384568-258a5200-5bf1-11eb-949c-8c274d88229e.gif" alt="Running Super Mario Bros. Deluxe (GBC)")
-</p>
+
+![Geebly running Dangan GB](https://user-images.githubusercontent.com/15825466/117328287-dac3db80-ae69-11eb-9ef2-1e9ebf8e199e.gif)![Geebly running the Gejmbåj demo](https://user-images.githubusercontent.com/15825466/117328294-dd263580-ae69-11eb-87a2-942136e2e204.gif)![Geebly running Super Mario Bros. Deluxe](https://user-images.githubusercontent.com/15825466/117328291-dbf50880-ae69-11eb-9e9f-6388101d57ce.gif)![Geebly running Donkey Kong Country](https://user-images.githubusercontent.com/15825466/117328298-ddbecc00-ae69-11eb-8976-ec459c9ea3bb.gif)
+
+</div>
 
 ## Usage
 ### Linux
 `geebly <settings> <file>`
 
-### Windows (Powershell)
-`./geebly <settings> <file>`
+### Windows
+`./geebly <settings> <file>` or `geebly <settings> <file>`
 
 ### Settings
 There are different settings for every part of the emulation engine, Boot ROM/BIOS related settings are prefixed with a `B`, general emulation settings are prefixed with a `E`, etc. Common settings' shorthands usually are just one letter long though.
 
 Here's all the settings currently present in the CLI:
 |Setting|Shorthand|Description|Default|
 |--|--|--|--|
+|`--master-volume`|`-v`|Set the master volume (`float` or `int`) <ul><li>`0.0` = Silence</li><li>`1.0` = Max</li><li>`> 1.0` = Clipping</li></ul>|`1.0`
+|`--mono`|`-m`|Disable stereo sound|No
 |`--debug`|`-d`|Enable the Geebly Debugger|Disabled
 |`--boot`|`-b`|Specify a boot ROM|`"dmg_boot.bin"`
 |`--scale`|`-s`|Set the display scale|1
@@ -32,52 +37,9 @@ Here's all the settings currently present in the CLI:
 |`--cgb-mode`|`-Ecgb`|Switches to CGB (Game Boy Color) mode|Disabled
 |`--enable-joyp-irq-delay/--disable-joyp-irq-delay`|`-Ejoyp-irq-delay/-Eno-joyp-irq-delay`|Enable/disable JOYP IRQ delay|Enabled
 
-## Current state
-### Game Boy Color Emulation
-Out of nowhere, there's now Game Boy Color emulation! This mostly comprises additional PPU registers and logic, and the CPU's double speed mode, that doesn't really affect the emulated CPU itself, but more the way devices do timing-based stuff based off the CPU clock.
-
-#### Implemented (or mostly implemented) CGB-specific registers:
-- `KEY1`
-- `SVBK`
-- `VBK`
-- `BCPS/BGPI`
-- `BCPD/BGPD`
-
-### CPU
-The CPU is fully implemented.
-
-Almost all IRQs are supported, with the exception of `SC` (no Serial support yet), plus `STAT` might be broken, but testing points to it being close to perfectly emulated.
-
-### Mapper/cartridge type support
-Most common mappers are fully implemented, that is:
-- `ROM only` 
-- `MBC1`
-- `MBC2`
-- `MBC3`
-- `MBC5`
-
-All of them with full ROM/SRAM banking support!
-
-RTC and Rumble functions are not supported.
-
-### Graphics (PPU/GPU)
-Color is supported! in CGB mode, there's two switchable VRAM banks, but the second one should contain a Background Tile Attribute Map that enables selecting CGB palettes in a per-tile basis, among other things like X/Y flipping tiles, etc.
-
-All three layers are implemented, with full scrolling support for both background and window.
-
-The OAM DMA controller is also implemented, it will log warnings when invalid transfers are attempted. The HDMA/GDMA CGB controllers are not yet supported, but short-term planned.
-
-### Sound (SPU/APU)
-Sound emulation is finally supported, but only on Windows, as I don't really have a separate Linux machine to test things on, I'm relying in WSL2 only, which doesn't really have good sound support, I could maybe mess around with `pulseaudio`, but it didn't seem like a straightforward process to me, so that's why I decided to not support sound emulation on Linux for now.
-
-Its not an accurate emulation, nor all features are supported, only channels 1, 2 and 4 are supported, that's the two square channels and a noise channel.
-
-Both square channels support volume envelope, trigger, sound length, but not sweep.
-
-The noise channel's sound is completely off, the documented frequency calculation formula gave out really high frequencies that were inaudible, and so I had to workaround scaling them so something could be heard, this resulted in a high pitched sound being audible alongside the noise, which is undesirable, but at least we get to hear noise stabs or percussion-like sounds.
-
-### Timers
-`DIV` and `TIMA` (`TAC` and `TMA` aswell) are accurately emulated.
+## Tests
+ - `cpu_instrs.gb` passes all tests
+ - `dmg-acid2.gb` passes both DMG and CGB tests
 
-### Blargg's tests
-`cpu_instrs.gb` passes all 11 tests!
+## Building
+So many things have changed in this last version that the build process is just not the same anymore, I'll fix that in upcoming commits

Makefile

@@ -1,13 +1,16 @@
 $SDL2_INCLUDE_DIR = $args[0]
 $SDL2_LIB_DIR = $args[1]
 $LGW_INCLUDE_DIR = $args[2]
+$IMGUI_SDL_DIR = $args[3]
+$IMGUI_DIR = $args[4]
+$IMPLOT_DIR = $args[5]
 $VERSION_TAG = git describe --always --tags --abbrev=0
 $COMMIT_HASH = git rev-parse --short HEAD
 
 md -Force -Path build > $null
 
-c++ -c src/geebly.cpp -o build/geebly.o -I"`"$($SDL2_INCLUDE_DIR)`"" -I"`"$($LGW_INCLUDE_DIR)`"" -std=c++2a -m64 -Ofast -Wno-format -Wno-narrowing -D GEEBLY_VERSION_TAG=$VERSION_TAG -D GEEBLY_COMMIT_HASH=$COMMIT_HASH
+c++ -c src/geebly.cpp -o build/geebly.o -I"`"$($SDL2_INCLUDE_DIR)`"" -I"`"$($LGW_INCLUDE_DIR)`"" -I"`"$($IMGUI_DIR)`"" -I"`"$($IMGUI_SDL_DIR)`"" -I"`"$($IMPLOT_DIR)`"" -std=c++2a -m64 -mbmi2 -Ofast -Wno-format -Wno-narrowing -D GEEBLY_VERSION_TAG=$VERSION_TAG -D GEEBLY_COMMIT_HASH=$COMMIT_HASH -Wunused
 
-c++ build/geebly.o -o build/geebly.exe -L"`"$($SDL2_LIB_DIR)`"" -m64 -lmingw32 -lSDL2main -lSDL2
+c++ precomp/implot.o precomp/implot_items.o precomp/implot_demo.o precomp/imgui.o precomp/imgui_demo.o precomp/imgui_draw.o precomp/imgui_tables.o precomp/imgui_widgets.o precomp/imgui_sdl.o build/geebly.o -o build/geebly.exe -L"`"$($SDL2_LIB_DIR)`"" -limm32 -m64 -lSDL2main -lSDL2
 
-del "build\geebly.o"
+del "build\geebly.o"

README.md

@@ -5,11 +5,8 @@
 #include "devices/cart.hpp"
 #include "devices/wram.hpp"
 #include "devices/hram.hpp"
-
-
 #include "devices/ppu/ppu.hpp"
-
-
+#include "devices/joypad.hpp"
 #include "devices/ic.hpp"
 #include "devices/dma/dma.hpp"
 #include "devices/dma/hdma.hpp"
@@ -18,21 +15,21 @@
 
 // Sound emulation is not yet supported on Linux platforms
 #ifdef _WIN32
-#ifndef GEEBLY_NO_SOUND
 #include "devices/spu/spu.hpp"
 #endif
-#endif
 
 // Clean this whole file up
-
 #define MMIO_DISABLE_BOOTROM 0xff50
 
 namespace gameboy {
     namespace bus {
         bool bootrom_enabled = true;
+
         u8 ro_sink = 0;
 
         void init() {
+            bootrom_enabled = true;
+
             if (settings::skip_bootrom) {
                 bootrom_enabled = false;
             }
@@ -63,10 +60,12 @@ namespace gameboy {
             // Handle an OAM read
             if (addr >= OAM_BEGIN && addr <= OAM_END) { return ppu::read(addr, size); }
 
-            if (addr == MMIO_JOYP) { return ppu::read(addr, size); }
+            if (addr == MMIO_JOYP) { return joypad::read(); }
 
             if (addr >= TIMER_BEGIN && addr <= TIMER_END) { return timer::read(addr, size); }
 
+            if (addr >= SPU_BEGIN && addr <= SPU_END) { return spu::read(addr, size); }
+
             if (addr == MMIO_DMA_TRANSFER) { return dma::read(addr, size); }
             if (addr >= HDMA_BEGIN && addr <= HDMA_END) { return hdma::read(addr, size); }
             if (addr == MMIO_KEY1) { return clock::read(addr, size); }
@@ -134,8 +133,12 @@ namespace gameboy {
             // Handle an OAM read
             if (addr >= OAM_BEGIN && addr <= OAM_END) { ppu::write(addr, value, size); return; }
 
+#ifdef GEEBLY_OLD_PPU
             if (addr == MMIO_JOYP) { ppu::write(addr, value, size); return; }
-            
+#else
+            if (addr == MMIO_JOYP) { joypad::write(value); return; }
+#endif
+
             if (addr >= TIMER_BEGIN && addr <= TIMER_END) { timer::write(addr, value, size); return; }
 
 #ifdef _WIN32