Add BGMap, OAM table, Tiles table for debugger

Signed-off-by: sukhman-sukh <[email protected]>

.vscode/settings.json

@@ -11,6 +11,13 @@
         "functional": "cpp",
         "tuple": "cpp",
         "type_traits": "cpp",
-        "utility": "cpp"
+        "utility": "cpp",
+        "any": "cpp",
+        "mutex": "cpp",
+        "new": "cpp",
+        "streambuf": "cpp",
+        "typeinfo": "cpp",
+        "variant": "cpp",
+        "*.inc": "cpp"
     }
 }

src/cpu.cpp

@@ -7883,7 +7883,24 @@ void CPU::updateTimers(int cycles)
 
 // print elements of calleraddresses stack
 void CPU::printStack() {
+	int count = 0;
 	printf("Printing Stack....");
-	for(Word i = reg_SP.dat ; i <= 0xCFFF ; i++)
-		printf("Address at stack_pointer %hu is %hu \n", i, (*mMap)[i]);
+	for(Word i = reg_SP.dat ; i <= 0xFFFE ; i++)
+	{	printf("Address at stack_pointer %hu is %hu \n", i, (*mMap)[i]);
+		count++;
+		if(count == 100){
+			char choice;
+			printf("Hit q to show next 100 addresses and x to exit\n");
+			scanf("%c", &choice);
+			printf("%c",choice);
+			if(choice == 'q'){
+				count = 0;
+				continue;
+			}
+			else {
+				printf("Exiting Stack\n");
+				break;
+			}
+		}
+	}
 }

src/gameBoy.cpp

@@ -171,6 +171,7 @@ void GBE::debug_int()
 	printf("\nEntered debug mode\n");
 	bool shouldAdv = false;
 	bool infoMode;
+	bool debuggerMode = false;
 	while (!shouldAdv)
 	{
 		while (SDL_PollEvent(event))
@@ -188,16 +189,54 @@ void GBE::debug_int()
 					printf("pressed d\n");
 					shouldAdv = true;
 					break;
+				// Left control to open Debugger window
+				// b for bgMap
+				// t to show current tiles on screen 
+				// s to show sprites on screen
+				case SDLK_LCTRL:
+					gbe_graphics->debuggerInit();
+					debuggerMode = true;
+					while (debuggerMode)
+					{
+						while (SDL_PollEvent(event))
+						{	
+							if (event->key.type == SDL_KEYUP)
+							{	
+								switch (event->key.keysym.sym)
+								{
+								case SDLK_b:
+									gbe_graphics->listBgMap();
+									break;
+								case SDLK_s:
+									gbe_graphics->listSprites();
+									break;
+								case SDLK_t:
+									gbe_graphics->listTiles();
+									break;	
+								case SDLK_ESCAPE:
+									gbe_graphics->close(true);
+									debuggerMode = false;
+									break;	
+								default:
+									break;
+								}
+							}
+						}
+					}
+					break;	
 				case SDLK_i:
 					printf("Info Mode:- \n");
 					infoMode = true;
 					shouldAdv = true;
 					// Press r to print all registers
-					// enter a for rax
-					// enter d for rdx
-					// enter c for rcx
-					// enter b for rbx
+					// enter a for A
+					// enter d for D
+					// enter c for C
+					// enter b for B
 					// enter e for E
+					// enter h for H
+					// enter l for L
+					// press left ctrl to open V-Ram debugger window
 					// enter p to print the stack
 					// enter e to exit info mode
 					while (infoMode)
@@ -243,7 +282,7 @@ void GBE::debug_int()
 									break;		
 								case SDLK_x:
 									infoMode = false;
-									break;
+									break;	
 								default:
 									break;
 								}
@@ -311,6 +350,7 @@ bool GBE::pollEvents()
 				debug_mode = !debug_mode;
 				break;
 			case SDLK_ESCAPE:
+				gbe_graphics->close(false);
 				exit(0);
 			default:
 				break;

src/gameBoy.h

@@ -15,7 +15,7 @@ class GBE
 	// Pulled from https://gbdev.io/pandocs/Specifications.html
 	// We might use an enum for the colors
 	// Will upgrade it later for RGB colors of GBC and GBA
-	// Using Byte for now
+	// Using Byte gbe_graphicsfor now
 
 	bool debug_mode;
 	Byte screenData[160][144];

src/graphics.cpp

@@ -10,7 +10,7 @@ PPU::PPU()
 	isEnabled = false;
 	showBGWin = false;
 	showWindow = false;
-	//renderWindow = false;
+	// renderWindow = false;
 	mMap = nullptr;
 	bgTileDataAddr = 0x0000;
 	bgTileMapAddr = 0x0000;
@@ -21,13 +21,19 @@ PPU::PPU()
 	currentLine = 0x00;
 	hiddenWindowLineCounter = 0x00;
 	ppuMode = 0x02;
+	// Initialize debugger members
+	debugWindow = nullptr;
+	debugRenderer = nullptr;
+	debugTexture = nullptr;
 
 	ppuMode = 0;
 	currentClock = modeClocks[ppuMode];
 	scanlineRendered = false;
 	frameRendered = false;
 
 	// Fill renderArray initially with white (lightest color in palette)
+	std::fill(renderSprites, renderSprites + (160 * 144), bg_colors[0]);
+	std::fill(renderTiles, renderTiles + (160 * 144), bg_colors[0]);
 	std::fill(renderArray, renderArray + (160 * 144), bg_colors[0]);
 }
 
@@ -96,11 +102,105 @@ bool PPU::init()
 	return true;
 }
 
+bool PPU::debuggerInit()
+{
+	// Initialize SDL
+	if (SDL_Init(SDL_INIT_VIDEO) < 0)
+	{
+		printf("SDL could not initialize! SDL_Error: %s\n", SDL_GetError());
+		return false;
+	}
+
+	// Set hint to use hardware acceleration
+	if (!SDL_SetHint(SDL_HINT_RENDER_SCALE_QUALITY, "1"))
+	{
+		printf("Hardware Acceleration not enabled! SDL_Error: %s\n", SDL_GetError());
+		return false;
+	}
+
+	// Set hint for VSync
+	if (!SDL_SetHint(SDL_HINT_RENDER_VSYNC, "1"))
+	{
+		printf("VSync not enabled! SDL_Error: %s\n", SDL_GetError());
+		return false;
+	}
+
+	// Create window and renderer
+	if (!(debugWindow = SDL_CreateWindow("GameBoy Debugger", 0, 0, SCREEN_WIDTH * 2, SCREEN_HEIGHT * 2, SDL_WINDOW_SHOWN)))
+	{
+		printf("Debugger Window could not be created! SDL_Error: %s\n", SDL_GetError());
+		return false;
+	}
+
+	if (!(debugRenderer = SDL_CreateRenderer(debugWindow, -1, SDL_RENDERER_ACCELERATED | SDL_RENDERER_PRESENTVSYNC)))
+	{
+		printf("Renderer could not be created! SDL_Error: %s\n", SDL_GetError());
+		return false;
+	}
+	// Create a placeholder debugTexture
+	// 512x512 to have 4 copies of tilemap
+	debugTexture = SDL_CreateTexture(debugRenderer, SDL_PIXELFORMAT_RGBA8888, SDL_TEXTUREACCESS_STATIC, 160, 144);
+
+	listTiles();
+	// Render the debugTexture
+	SDL_UpdateTexture(debugTexture, NULL, renderTiles, 160 * 4);
+	SDL_RenderClear(debugRenderer);
+	SDL_RenderCopy(debugRenderer, debugTexture, NULL, NULL);
+	SDL_RenderPresent(debugRenderer);
+	return true;
+}
+
+void PPU::listBgMap()
+{
+	SDL_UpdateTexture(debugTexture, NULL, renderBGMap, 160 * 4);
+	SDL_RenderClear(debugRenderer);
+	SDL_RenderCopy(debugRenderer, debugTexture, NULL, NULL);
+	SDL_RenderPresent(debugRenderer);
+}
+
+void PPU::listSprites()
+{
+	if (!scanlineRendered)
+	{
+		renderScanline(mMap->getRegLY());
+		scanlineRendered = true;
+	}
+	SDL_UpdateTexture(debugTexture, NULL, renderSprites, 160 * 4);
+	SDL_RenderClear(debugRenderer);
+	SDL_RenderCopy(debugRenderer, debugTexture, NULL, NULL);
+	SDL_RenderPresent(debugRenderer);
+}
+
+// We are reading values from 0x8000 to 0x8fff
+// Outer loop increments for every new tile to be rendered
+// Middle loop increments for every line of tile
+// Inner loop increments for every pixel of line of tile.
+// We are printing 14 tiles in a row with gap of 2 between each tile { (tileNumber % 14) * 10) + j + 8) }
+void PPU::listTiles()
+{
+	int tileNumber = 0;
+	Byte pixel_col;
+	for (Word tileAddr = 0x8000; tileAddr < 0x8FFF; tileAddr += 0x10)
+	{
+		if ((*mMap)[tileAddr] == 0)
+			continue;
+		for (int i = 0; i < 8; i++)
+		{
+			for (int j = 0; j < 8; j++)
+			{
+				pixel_col = ((*mMap)[(tileAddr + 0x2 * (Word)i)] >> (7 - j) & 0x1) + (((*mMap)[(tileAddr + 0x2 * (Word)i) + 1] >> (7 - j) & 0x1) * 2);
+				renderTiles[((static_cast<int>(tileNumber / 14) * 10) + i) * 160 + (((tileNumber % 14) * 10) + j + 8)] = bg_colors[(bgPalette >> (pixel_col * 2)) & 0x3];
+			}
+		}
+		tileNumber += 1;
+	}
+}
+
 void PPU::renderScanline(Byte line)
 {
 	// Evaluate LCDC register
 	Byte LCDC = mMap->getRegLCDC();
-
+	int spriteCount = 0;
 	isEnabled = (LCDC & 0x80);
 	showBGWin = (LCDC & 0x1);
 	showWindow = (LCDC & 0x20);
@@ -169,9 +269,17 @@ void PPU::renderScanline(Byte line)
 		}
 
 		if (showBGWin)
+		{
 			renderArray[(line * 160) + j] = bg_colors[(bgPalette >> (bg_pixel_col * 2)) & 0x3];
+			renderSprites[(line * 160) + j] = bg_colors[0];
+			renderBGMap[(line * 160) + j] = bg_colors[(bgPalette >> (bg_pixel_col * 2)) & 0x3];
+		}
 		else
+		{
 			renderArray[(line * 160) + j] = bg_colors[0];
+			renderSprites[(line * 160) + j] = bg_colors[0];
+			renderBGMap[(line * 160) + j] = bg_colors[0];
+		}
 
 		// Window rendering
 		if (showBGWin && showWindow && ((win_y <= line) && (win_y < 144)) && (win_x < 160) && (hiddenWindowLineCounter < 144) && (j >= win_x))
@@ -199,6 +307,7 @@ void PPU::renderScanline(Byte line)
 	// Sprite rendering
 	if (showSprites)
 	{
+
 		sprites.clear();
 		for (Word i = 0xFE00; i < 0xFEA0; i += 4)
 		{
@@ -218,10 +327,12 @@ void PPU::renderScanline(Byte line)
 		}
 
 		if (sprites.size())
-			std::sort(sprites.begin(), sprites.end(), [](Sprite& a, Sprite& b) { return (((a.x == b.x) && (a.address > b.address)) || (a.x > b.x)); });
-
+			std::sort(sprites.begin(), sprites.end(), [](Sprite& a, Sprite& b)
+			    { return (((a.x == b.x) && (a.address > b.address)) || (a.x > b.x)); });
+		spriteCount = 0;
 		for (auto it = sprites.begin(); it != sprites.end(); ++it)
 		{
+
 			sprite_palette = (it->flags & 0x10) ? objPalette1 : objPalette0;
 			for (int i = 0; i < 8; i++)
 			{
@@ -248,9 +359,15 @@ void PPU::renderScanline(Byte line)
 				if (sprite_pixel_col != 0)
 				{
 					if (((it->x + i - 8) < 160) && (!(it->flags & 0x80) || (renderArray[(line * 160) + (it->x + i - 8)] == bg_colors[0])))
+					{
 						renderArray[(line * 160) + (it->x + i - 8)] = bg_colors[(sprite_palette >> (sprite_pixel_col * 2)) & 0x3];
+						renderSprites[(line * 160) + ((spriteCount * 10) + i + 8)] = bg_colors[(sprite_palette >> (sprite_pixel_col * 2)) & 0x3];
+						// renderSprites[((120+(static_cast<int>(spriteCount/20)*2)) * 160) + ((spriteCount%20)*2 + i - 8)] = bg_colors[(sprite_palette >> (sprite_pixel_col * 2)) & 0x3];
+						// renderSprites[(80+((static_cast<int>(spriteCount/20))) * 160) + (it->x + i - 8)] = bg_colors[(sprite_palette >> (sprite_pixel_col * 2)) & 0x3];
+					}
 				}
 			}
+			spriteCount++;
 		}
 	}
 }
@@ -392,17 +509,41 @@ void PPU::executePPU(int cycles)
 	}
 }
 
-void PPU::close()
+// void PPU::debuggerRender()
+// {
+// 	if (!scanlineRendered)
+// 	{
+// 		renderScanline(mMap->getRegLY());
+// 		scanlineRendered = true;
+// 	}
+// }
+//  if debug == true; it will vanish "Gameboy Debugger" screen.
+//  if debug == false; it will vanish "Gameboy Emulator" screen.
+void PPU::close(bool debug)
 {
-	// Destroy texture
-	SDL_DestroyTexture(texture);
+	if (debug)
+	{
+		// Destroy texture
+		SDL_DestroyTexture(debugTexture);
+
+		// Destroy renderer
+		SDL_DestroyRenderer(debugRenderer);
 
-	// Destroy renderer
-	SDL_DestroyRenderer(renderer);
+		// Destroy window
+		SDL_DestroyWindow(debugWindow);
+	}
+	else
+	{
+		// Destroy texture
+		SDL_DestroyTexture(texture);
 
-	// Destroy window
-	SDL_DestroyWindow(window);
+		// Destroy renderer
+		SDL_DestroyRenderer(renderer);
 
-	// Quit SDL subsystems
-	SDL_Quit();
+		// Destroy window
+		SDL_DestroyWindow(window);
+
+		// Quit SDL subsystems
+		SDL_Quit();
+	}
 }