loic/chip-8
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Cleaning repository

Browse source
This commit is contained in:
Loïc Guégan 2023-12-26 17:51:39 +01:00
parent 24aadae14d
commit 5eadac7291
30 changed files with 380 additions and 142 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/Makefile
View file

@ -1,20 +0,0 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

27
docs/conf.py
View file

@ -1,27 +0,0 @@
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'Chip-8'
copyright = '2023, Loïc Guégan'
author = 'Loïc Guégan'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = []
templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']

20
docs/index.rst
View file

@ -1,20 +0,0 @@
.. Chip-8 documentation master file, created by
sphinx-quickstart on Sun Dec 24 17:49:23 2023.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Chip-8's documentation!
==================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

35
docs/make.bat
View file

@ -1,35 +0,0 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.https://www.sphinx-doc.org/
exit /b 1
)
if "%1" == "" goto help
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd

0
roms/README.md → res/roms/README.md
View file

0
roms/games/paddles.ch8 → res/roms/games/paddles.ch8
View file

0
roms/games/pong_1player.ch8 → res/roms/games/pong_1player.ch8
View file

0
roms/chip8-test-suite/1-chip8-logo.ch8 → res/roms/tests/chip8-test-suite/1-chip8-logo.ch8
View file

0
roms/chip8-test-suite/2-ibm-logo.ch8 → res/roms/tests/chip8-test-suite/2-ibm-logo.ch8
View file

0
roms/chip8-test-suite/3-corax+.ch8 → res/roms/tests/chip8-test-suite/3-corax+.ch8
View file

0
roms/chip8-test-suite/4-flags.ch8 → res/roms/tests/chip8-test-suite/4-flags.ch8
View file

0
roms/chip8-test-suite/5-quirks.ch8 → res/roms/tests/chip8-test-suite/5-quirks.ch8
View file

0
roms/chip8-test-suite/6-keypad.ch8 → res/roms/tests/chip8-test-suite/6-keypad.ch8
View file

0
roms/chip8-test-suite/7-beep.ch8 → res/roms/tests/chip8-test-suite/7-beep.ch8
View file

0
roms/chip8-test-suite/8-scrolling.ch8 → res/roms/tests/chip8-test-suite/8-scrolling.ch8
View file

0
roms/chiptest.ch8 → res/roms/tests/chiptest.ch8
View file

0
roms/ibm.ch8 → res/roms/tests/ibm.ch8
View file

0
src/beep2.mp3 → res/speaker/beep.mp3
View file

194
src/beep.h Normal file
View file

@ -0,0 +1,194 @@
const unsigned char beep[] = {
0xff, 0xfb, 0x90, 0xc4, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x58, 0x69, 0x6e,
0x67, 0x00, 0x00, 0x00, 0x0f, 0x00, 0x00, 0x00, 0x04, 0x00, 0x00, 0x08,
0xf7, 0x00, 0x71, 0x71, 0x71, 0x71, 0x71, 0x71, 0x71, 0x71, 0x71, 0x71,
0x71, 0x71, 0x71, 0x71, 0x71, 0x71, 0x71, 0x71, 0x71, 0x71, 0x71, 0x71,
0x71, 0x71, 0x9c, 0x9c, 0x9c, 0x9c, 0x9c, 0x9c, 0x9c, 0x9c, 0x9c, 0x9c,
0x9c, 0x9c, 0x9c, 0x9c, 0x9c, 0x9c, 0x9c, 0x9c, 0x9c, 0x9c, 0x9c, 0x9c,
0x9c, 0x9c, 0x9c, 0xf1, 0xf1, 0xf1, 0xf1, 0xf1, 0xf1, 0xf1, 0xf1, 0xf1,
0xf1, 0xf1, 0xf1, 0xf1, 0xf1, 0xf1, 0xf1, 0xf1, 0xf1, 0xf1, 0xf1, 0xf1,
0xf1, 0xf1, 0xf1, 0xf1, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
0xff, 0xff, 0xff, 0xff, 0xff, 0x00, 0x00, 0x00, 0x50, 0x4c, 0x41, 0x4d,
0x45, 0x33, 0x2e, 0x31, 0x30, 0x30, 0x04, 0xb9, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x15, 0x20, 0x24, 0x06, 0x7f, 0x41, 0x00, 0x01,
0xe0, 0x00, 0x00, 0x08, 0xf7, 0x9f, 0xa0, 0x67, 0x7d, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xfb, 0xd0,
0xc4, 0x00, 0x00, 0x07, 0x40, 0x03, 0x83, 0xb4, 0x10, 0x00, 0x24, 0x44,
0xbc, 0xee, 0xff, 0x35, 0xa2, 0x40, 0x24, 0x83, 0xba, 0x3a, 0x38, 0xdc,
0x72, 0x5c, 0x30, 0x7d, 0xe2, 0x00, 0xc1, 0x70, 0xf9, 0x48, 0x38, 0x18,
0x47, 0x07, 0xc1, 0xfe, 0xa0, 0x40, 0xe7, 0x94, 0x0c, 0x7c, 0x3f, 0xe0,
0x83, 0xbc, 0xa1, 0xce, 0x5c, 0x1f, 0x0f, 0xf5, 0x02, 0x0e, 0xf1, 0x20,
0x63, 0xfe, 0x50, 0x10, 0x77, 0x89, 0x03, 0x1c, 0x1f, 0x07, 0xfc, 0x40,
0x08, 0x7c, 0xa7, 0x97, 0x00, 0x22, 0x46, 0x51, 0x64, 0x6d, 0x11, 0x33,
0x46, 0xbb, 0x95, 0x88, 0xa0, 0x30, 0x10, 0x09, 0x55, 0x84, 0x71, 0xb3,
0x2a, 0xc8, 0xe1, 0x54, 0xe1, 0x86, 0x2b, 0x2d, 0x0e, 0x4f, 0x1e, 0x22,
0x5f, 0x32, 0x91, 0x63, 0x95, 0xed, 0x15, 0x49, 0xb9, 0xe5, 0x85, 0x27,
0x30, 0x2a, 0xb9, 0x3a, 0xc0, 0xe0, 0xd3, 0x84, 0x74, 0xc0, 0x96, 0x8f,
0x16, 0x02, 0xb2, 0xa9, 0xe2, 0x00, 0x69, 0x71, 0xc6, 0xea, 0xab, 0x21,
0xe8, 0x80, 0xe8, 0xe4, 0x6d, 0xb8, 0xf7, 0x0a, 0x90, 0x0e, 0x5f, 0x29,
0x90, 0xba, 0x45, 0x08, 0xdc, 0xd6, 0xbe, 0x48, 0x3c, 0xce, 0x01, 0x8c,
0xa8, 0x63, 0x2d, 0x24, 0x5e, 0x62, 0xc2, 0xb7, 0x7e, 0x4b, 0x89, 0x01,
0x8f, 0x23, 0xad, 0x48, 0xd1, 0x5f, 0x6d, 0x54, 0x6e, 0xd2, 0xe7, 0x44,
0x68, 0x05, 0x49, 0x74, 0x35, 0x25, 0x82, 0x0a, 0x02, 0xf6, 0x85, 0xe9,
0x80, 0x67, 0x69, 0xe3, 0xad, 0x37, 0x93, 0x0c, 0xde, 0x83, 0x18, 0x25,
0xd7, 0xde, 0x99, 0xb5, 0xc9, 0x45, 0xe6, 0xda, 0x96, 0x57, 0x1d, 0x95,
0x7e, 0x12, 0xa9, 0x4d, 0x9c, 0xea, 0xe2, 0xd4, 0x35, 0x35, 0xd7, 0xce,
0x82, 0x86, 0x3b, 0x5a, 0x6f, 0x2b, 0x75, 0x65, 0x99, 0x61, 0x72, 0x1d,
0xfc, 0x28, 0x6b, 0x7e, 0xb2, 0x99, 0xc7, 0x38, 0x3f, 0x19, 0x8c, 0xe1,
0x39, 0x50, 0x65, 0x0f, 0x65, 0x37, 0x49, 0x8f, 0xe5, 0x2f, 0xcb, 0x58,
0xce, 0xf6, 0xbe, 0x31, 0x9e, 0xd4, 0xdc, 0xd7, 0x35, 0xd9, 0x9c, 0x6d,
0xf2, 0x67, 0xb3, 0x30, 0xf6, 0x33, 0x19, 0xc3, 0x39, 0x4c, 0x65, 0x0d,
0x4f, 0x67, 0x3b, 0x24, 0xe5, 0x6b, 0x3f, 0x87, 0x69, 0xb0, 0xa9, 0xda,
0x5b, 0x35, 0xfe, 0xef, 0x70, 0xe4, 0xd7, 0x30, 0xce, 0xae, 0x39, 0xe1,
0x33, 0xdc, 0x3f, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xfe, 0x63, 0x71,
0xdc, 0xb0, 0x9e, 0x92, 0x51, 0xf6, 0x76, 0x38, 0x53, 0xfa, 0x95, 0x1e,
0xe7, 0x2a, 0xea, 0x24, 0xb9, 0xb2, 0x07, 0x2f, 0x6d, 0xa4, 0x00, 0x20,
0x00, 0x11, 0x68, 0x06, 0x45, 0x1a, 0x21, 0x50, 0x62, 0xe7, 0x0b, 0x5c,
0xb9, 0x5f, 0xc6, 0x86, 0xf7, 0xbd, 0x14, 0x3f, 0x8c, 0x12, 0x2d, 0xf9,
0x91, 0xe7, 0x25, 0xea, 0x9c, 0x0f, 0x21, 0x71, 0x1f, 0x4d, 0x49, 0xa5,
0xe6, 0x36, 0xad, 0x11, 0x05, 0x03, 0x28, 0x96, 0x48, 0xd4, 0xc4, 0xd2,
0x63, 0x45, 0xc7, 0xe0, 0x12, 0x84, 0xb2, 0x6f, 0x3f, 0x26, 0x24, 0xb2,
0xf1, 0x78, 0x14, 0xb1, 0xe2, 0x5c, 0x5a, 0x8b, 0xb2, 0xe1, 0xb1, 0x91,
0x89, 0x74, 0x13, 0x91, 0xb8, 0xee, 0xba, 0x9b, 0x51, 0x15, 0xed, 0x42,
0xb7, 0xb4, 0x98, 0xf7, 0xbd, 0x6d, 0xd3, 0x2c, 0xaa, 0xad, 0xeb, 0x9c,
0x28, 0xde, 0xbd, 0xab, 0x9d, 0x49, 0xf5, 0x6b, 0xdd, 0x22, 0xfd, 0x7b,
0xd0, 0xab, 0x29, 0xd5, 0xb5, 0x3f, 0x35, 0xfd, 0x5e, 0x73, 0x6b, 0x57,
0xe6, 0x1b, 0xd9, 0xbb, 0x4d, 0x6f, 0xd1, 0x5e, 0xe0, 0x8d, 0x45, 0x29,
0xc1, 0xf9, 0x6c, 0x60, 0x00, 0xdd, 0x0f, 0x63, 0x64, 0xe2, 0x1d, 0x3e,
0x83, 0x0e, 0x12, 0xfb, 0xae, 0x80, 0xf6, 0x8e, 0xba, 0xd7, 0x5b, 0xde,
0xba, 0x65, 0xff, 0x51, 0x61, 0x01, 0x1b, 0x19, 0x97, 0xdc, 0xa4, 0x3b,
0x0b, 0xe4, 0x02, 0xa4, 0x05, 0x08, 0x19, 0x6c, 0x31, 0x98, 0xeb, 0x2b,
0x8f, 0xb2, 0xa2, 0x04, 0xeb, 0xac, 0x98, 0x1c, 0xc0, 0x1a, 0xd5, 0xa9,
0x17, 0x2a, 0xc8, 0xc9, 0xd2, 0xb8, 0xcd, 0x83, 0x53, 0x2f, 0x97, 0xcd,
0xcc, 0xcc, 0x26, 0xc7, 0x8e, 0x94, 0x08, 0xa0, 0x2c, 0x23, 0xbc, 0xcb,
0x2d, 0xc9, 0x4a, 0x8f, 0xa8, 0x1a, 0x91, 0x82, 0x27, 0xe7, 0x2b, 0x3c,
0xa2, 0x99, 0x4c, 0x52, 0x83, 0x4d, 0x4b, 0x73, 0x79, 0xdd, 0xd4, 0x35,
0x90, 0x9e, 0xa3, 0x59, 0xea, 0x29, 0x94, 0xc9, 0x0a, 0x34, 0xd9, 0x69,
0x54, 0xe4, 0xa1, 0x56, 0xd5, 0xd4, 0x6f, 0x45, 0x32, 0xc9, 0x20, 0xca,
0x52, 0x9a, 0x6d, 0x53, 0x99, 0x91, 0x2a, 0x1b, 0xd3, 0xd9, 0x64, 0xc3,
0x29, 0x94, 0xf3, 0x56, 0xbb, 0x93, 0xd5, 0xef, 0x5b, 0x5a, 0x67, 0xeb,
0xb3, 0xd4, 0xb3, 0x66, 0xed, 0x39, 0xaf, 0xa6, 0x87, 0xfa, 0xf9, 0x3a,
0x00, 0x00, 0x00, 0x83, 0x35, 0x26, 0x00, 0x05, 0x01, 0xf2, 0x20, 0x88,
0x00, 0x00, 0x00, 0x03, 0x45, 0x81, 0xe7, 0xe4, 0x55, 0xe9, 0xa1, 0x10,
0xb2, 0x14, 0x31, 0xcd, 0x14, 0xd3, 0xc4, 0x87, 0xed, 0xd9, 0x30, 0x71,
0x38, 0x31, 0x8a, 0x54, 0x60, 0x0f, 0x80, 0xe0, 0xe3, 0x0c, 0xae, 0x1e,
0xda, 0x6b, 0x61, 0x1c, 0xcd, 0x24, 0xe3, 0x56, 0x80, 0xa2, 0x77, 0x6b,
0x14, 0x01, 0x47, 0x88, 0x40, 0x46, 0x99, 0x9a, 0xf8, 0x5c, 0x74, 0x20,
0xc9, 0xb9, 0xdf, 0x24, 0x1e, 0x12, 0x03, 0x8f, 0x43, 0xa4, 0xa0, 0x43,
0xc7, 0xf2, 0xf6, 0xf9, 0x5d, 0x8b, 0x3d, 0x32, 0x64, 0x4f, 0x0a, 0x0b,
0x89, 0x55, 0x17, 0xfd, 0x61, 0xd6, 0x21, 0x87, 0x0b, 0x1a, 0x18, 0x52,
0xa8, 0xa5, 0x40, 0xb0, 0x38, 0xea, 0x91, 0x95, 0x0a, 0x33, 0xca, 0xaf,
0x42, 0x71, 0xe7, 0x5d, 0xba, 0x43, 0x4c, 0xac, 0x58, 0x9a, 0x24, 0xfe,
0xba, 0x4b, 0x0e, 0x42, 0x22, 0x30, 0x0c, 0xfe, 0x2b, 0x72, 0x09, 0xdd,
0xda, 0xf7, 0x60, 0xb6, 0xa7, 0x5f, 0x11, 0xa1, 0x3b, 0x77, 0x1b, 0x32,
0x75, 0x4a, 0xdc, 0x20, 0xe0, 0xa9, 0x88, 0xb2, 0x6f, 0x0f, 0x04, 0x5c,
0x70, 0xe6, 0x25, 0x78, 0xff, 0xfb, 0x70, 0xc4, 0xf1, 0x00, 0x11, 0x35,
0x91, 0x7b, 0xfd, 0x86, 0x80, 0x22, 0xaf, 0xb4, 0x2e, 0xbe, 0xb1, 0x20,
0x04, 0x57, 0xc1, 0xe5, 0xaf, 0x56, 0x9d, 0xaf, 0x89, 0x05, 0x44, 0xa3,
0x31, 0x64, 0x07, 0xc8, 0xe0, 0x08, 0xab, 0x92, 0x80, 0x08, 0x83, 0x46,
0x86, 0xd7, 0x94, 0x5e, 0x24, 0xe1, 0x4b, 0xf7, 0x73, 0x08, 0xcd, 0x25,
0x0f, 0xc2, 0x2b, 0xed, 0x5b, 0xa5, 0xee, 0x13, 0xce, 0x97, 0x51, 0x29,
0x4c, 0x5d, 0x41, 0xe5, 0xd0, 0x52, 0x5c, 0xe5, 0x0f, 0xd1, 0x26, 0xa4,
0x34, 0xf4, 0x5b, 0x56, 0xc8, 0x7d, 0xb2, 0x4f, 0xcc, 0xf2, 0xb5, 0x69,
0x0f, 0x2b, 0xda, 0x94, 0x6e, 0x9a, 0xfc, 0xa7, 0x09, 0xd5, 0x82, 0x9f,
0x72, 0x9d, 0x75, 0x45, 0x84, 0xcb, 0xbe, 0xad, 0xf8, 0xb8, 0x5c, 0x51,
0x68, 0xbb, 0xfc, 0xaa, 0xba, 0x9e, 0xe2, 0xcd, 0x8d, 0x45, 0x23, 0x4b,
0x92, 0x56, 0xf0, 0x3b, 0xcb, 0x6e, 0xd6, 0xaf, 0xd2, 0x7d, 0xfb, 0x51,
0xee, 0xd3, 0x5a, 0xb3, 0x97, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff,
0xfc, 0x35, 0x07, 0xb9, 0xf6, 0x29, 0xa4, 0x6a, 0x2f, 0x6d, 0xb1, 0x4f,
0x2a, 0x95, 0x8b, 0x5f, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x12,
0x91, 0x2c, 0x58, 0xb4, 0xb6, 0x44, 0xce, 0x1f, 0x97, 0x62, 0x16, 0xaa,
0xf8, 0xc4, 0x0a, 0x00, 0xa0, 0x2a, 0x01, 0x5c, 0x11, 0x41, 0x5c, 0x2e,
0x0e, 0x88, 0x83, 0x01, 0x80, 0x80, 0x60, 0xa6, 0x00, 0x20, 0x2c, 0x67,
0x7a, 0xd8, 0xc6, 0xb6, 0xe4, 0x11, 0xfe, 0x60, 0x32, 0x02, 0x11, 0x23,
0x22, 0xe3, 0x39, 0x31, 0x75, 0x19, 0xef, 0xf3, 0x04, 0xf0, 0x52, 0x30,
0x5d, 0x09, 0x23, 0x1b, 0x62, 0xd1, 0x30, 0xdf, 0x49, 0xcf, 0xf0, 0x40,
0x0e, 0x93, 0x06, 0x47, 0xa5, 0x86, 0x95, 0x93, 0x9f, 0xe9, 0x8d, 0x32,
0xca, 0x4c, 0x22, 0x1d, 0xcc, 0x45, 0x13, 0x0c, 0x58, 0x21, 0x7f, 0xfd,
0x96, 0x29, 0x8b, 0x70, 0x5d, 0x46, 0x70, 0xcf, 0x06, 0x55, 0xa8, 0x46,
0x7e, 0x86, 0xc6, 0x26, 0x0c, 0x3f, 0xff, 0xff, 0x8a, 0x33, 0x29, 0x8b,
0xc8, 0x63, 0x48, 0xfc, 0x63, 0x01, 0x4e, 0x64, 0xbb, 0x84, 0x64, 0xaa,
0x1c, 0x0a, 0x5a, 0xff, 0xff, 0xff, 0xfb, 0xb0, 0xc4, 0xe8, 0x00, 0x2a,
0xaa, 0x23, 0x69, 0xf9, 0xbd, 0x82, 0x44, 0xfc, 0x3d, 0x6d, 0xff, 0x3d,
0xd1, 0x40, 0xfe, 0x35, 0x11, 0x67, 0x31, 0x48, 0x66, 0x5a, 0x61, 0xc0,
0x36, 0x60, 0xb8, 0x18, 0x61, 0xe0, 0x8a, 0x62, 0xe9, 0xf4, 0x62, 0x39,
0x24, 0x1c, 0x6d, 0x7f, 0xff, 0xff, 0xbe, 0xbd, 0x86, 0x62, 0x14, 0xb9,
0x66, 0x60, 0x60, 0x2e, 0xc2, 0xcc, 0x0e, 0x01, 0x4c, 0x15, 0x12, 0x8c,
0x11, 0x0c, 0x05, 0x83, 0x33, 0x03, 0x81, 0x1f, 0xff, 0xff, 0xff, 0xbb,
0x0c, 0xd8, 0xab, 0x4a, 0xec, 0xf6, 0x53, 0x2d, 0x5e, 0x2a, 0xc2, 0x15,
0x02, 0x10, 0x9c, 0x9e, 0x40, 0x40, 0x24, 0x28, 0x02, 0xa9, 0x05, 0x06,
0xff, 0xff, 0xff, 0xff, 0xfa, 0xd3, 0xd3, 0x39, 0x7e, 0x5a, 0xce, 0x23,
0xda, 0x55, 0x56, 0x63, 0xe0, 0xc0, 0x0c, 0x2c, 0x00, 0xad, 0x47, 0xb9,
0xb9, 0x3c, 0xe1, 0x40, 0x04, 0x18, 0x02, 0xa9, 0x87, 0xff, 0xff, 0xff,
0xff, 0xff, 0xd5, 0xad, 0x6a, 0x67, 0x2c, 0xb2, 0xad, 0x4d, 0xdf, 0xd7,
0x6b, 0x5a, 0x4f, 0x7b, 0x34, 0x61, 0x60, 0x04, 0x28, 0x01, 0xac, 0x22,
0xf3, 0xad, 0x5d, 0xac, 0xa3, 0xcb, 0x3c, 0x4a, 0x57, 0xd6, 0x43, 0xff,
0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xfb, 0xfc, 0xbb, 0x97, 0x75, 0xbd,
0x65, 0xff, 0xaf, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x88, 0xae,
0x56, 0xe4, 0x28, 0x03, 0xb2, 0x14, 0xad, 0x10, 0x80, 0x4f, 0x13, 0x12,
0x6e, 0xb0, 0xf3, 0x29, 0x19, 0x00, 0x2a, 0x4c, 0x41, 0x4d, 0x45, 0x33,
0x2e, 0x31, 0x30, 0x30, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xff, 0xfb, 0x10, 0xc4, 0xcc,
0x03, 0xc0, 0x00, 0x01, 0xa4, 0x1c, 0x00, 0x00, 0x20, 0x00, 0x00, 0x34,
0x80, 0x00, 0x00, 0x04, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa, 0xaa,
0xaa, 0xaa, 0xaa,
};

BIN
src/beep.mp3
View file

Binary file not shown.

8
src/keypad.c
View file

@ -1,5 +1,6 @@
#include "keypad.h" #include "keypad.h"
/// @brief Define you keymaps here
int map[]={ int map[]={
KEY_X, // 0 KEY_X, // 0
KEY_ONE, // 1 KEY_ONE, // 1
@ -19,6 +20,12 @@ int map[]={
KEY_V // F KEY_V // F
}; };
/**
* @brief Get hex from keycode (used only in this file)
*
* @param keycode
* @return int
*/
int KeypadGetKey(int keycode){ int KeypadGetKey(int keycode){
for(int i=0;i<16;i++){ for(int i=0;i<16;i++){
if(map[i]==keycode) if(map[i]==keycode)
@ -27,7 +34,6 @@ int KeypadGetKey(int keycode){
return -1; return -1;
} }
int KeypadGetPressed(){ int KeypadGetPressed(){
for(int i=0;i<16;i++){ for(int i=0;i<16;i++){
if(IsKeyDown(map[i])) if(IsKeyDown(map[i]))

5
src/keypad.h
View file

@ -2,5 +2,10 @@
#include "raylib.h" #include "raylib.h"
/**
* @brief Return the hex code of the key currently pressed and -1 ortherwise
*
* @return int
*/
int KeypadGetPressed(); int KeypadGetPressed();

19
src/main.c
View file

@ -5,17 +5,20 @@
#include <stdio.h> #include <stdio.h>
//#define ROM "../roms/chip8-test-suite/5-quirks.ch8"
//#define ROM "../roms/chip8-test-suite/8-scrolling.ch8"
#define ROM "../roms/games/pong_1player.ch8"
//#define ROM "../roms/ibm.ch8"
int main(int argc, char *argv[]) int main(int argc, char *argv[])
{ {
// Parse argument
if(argc != 2){
printf("Usage: %s [rom]\n",argv[0]);
return 1;
} else if(!FileExists(argv[1])){
printf("ROM not found: %s\n",argv[1]);
return 1;
}
// Initialize // Initialize
MemInit(); MemInit();
MemLoadROM(ROM); MemLoadROM(argv[1]);
ScreenInit(1000,500); ScreenInit(1000,500);
VCPUInit(); VCPUInit();
SpeakerInit(); SpeakerInit();
@ -24,12 +27,8 @@ int main(int argc, char *argv[])
SetTargetFPS(VCPU_FREQ*100); SetTargetFPS(VCPU_FREQ*100);
// Emulator main loop // Emulator main loop
int i=0;
while (!WindowShouldClose()){ while (!WindowShouldClose()){
VCPUTick(); VCPUTick();
if(i%600 == 0)
printf("tick\n");
i++;
} }
// Finish // Finish

46
src/mem.h
View file

@ -3,10 +3,56 @@
#define ADDR_ROM 0x200 #define ADDR_ROM 0x200
#define ADDR_FONT 0x50 #define ADDR_FONT 0x50
/**
* @brief Must be called first!
*
*/
void MemInit(); void MemInit();
/**
* @brief Set value of a memory region
*
* @param addr
* @param value
* @param size
*/
void MemSet(int addr, unsigned char value, int size); void MemSet(int addr, unsigned char value, int size);
/**
* @brief Store date in memory
*
* @param data
* @param size
* @param addr
*/
void MemStore(unsigned char *data, int size, int addr); void MemStore(unsigned char *data, int size, int addr);
/**
* @brief Load data from memory
*
* @param data
* @param size
* @param addr
*/
void MemLoad(unsigned char *data, int size, int addr); void MemLoad(unsigned char *data, int size, int addr);
/**
* @brief Load ROM into memory (be careful, file MUST exists)
*
* @param path
*/
void MemLoadROM(char *path); void MemLoadROM(char *path);
/**
* @brief Dump the entire memory
*
*/
void MemDump(); void MemDump();
/**
* @brief Dump a memory region
*
* @param addr
* @param size
*/
void MemDumpRange(int addr, int size); void MemDumpRange(int addr, int size);

10
src/screen.c
View file

@ -14,7 +14,7 @@ void ScreenInit(int width, int height){
ScreenClear(); ScreenClear();
SetTraceLogLevel(LOG_ERROR); // Disable anoying raylib logs SetTraceLogLevel(LOG_ERROR); // Disable anoying raylib logs
InitWindow(width, height, "Chip-8 Emulator"); InitWindow(width, height, "Chip-8 Emulator by Loïc Guégan");
} }
void ScreenClear() { void ScreenClear() {
@ -26,7 +26,6 @@ void ScreenClear() {
void ScreenUpdate(){ void ScreenUpdate(){
BeginDrawing(); BeginDrawing();
ClearBackground(RAYWHITE); ClearBackground(RAYWHITE);
// DrawText("Congrats! You created your first window!", 190, 200, 20, LIGHTGRAY);
for(int x=0;x<64;x++){ for(int x=0;x<64;x++){
for(int y=0;y<32;y++){ for(int y=0;y<32;y++){
if(Screen.pixels[x+y*64] == 0) if(Screen.pixels[x+y*64] == 0)
@ -56,13 +55,6 @@ char ScreenPixelApply(int x, int y, unsigned char state){
return flag; return flag;
} }
void ScreenPixelFlip(int x, int y){
if(Screen.pixels[x+y*64]==0)
Screen.pixels[x+y*64]=1;
else
Screen.pixels[x+y*64]=0;
}
void ScreenWH(int *width, int *height){ void ScreenWH(int *width, int *height){
*width=64; *width=64;
*height=32; *height=32;

40
src/screen.h
View file

@ -3,7 +3,7 @@
#include "raylib.h" #include "raylib.h"
#define MODE_CHIP8 0 // Chip-8 64x32 #define MODE_CHIP8 0 // Chip-8 64x32
#define MODE_SCHIP 1 // Super-Chip 128x64 #define MODE_SCHIP 1 // Super-Chip 128x64 (not supported yet)
typedef struct SCREEN_DATA { typedef struct SCREEN_DATA {
int width, height; int width, height;
@ -13,10 +13,46 @@ typedef struct SCREEN_DATA {
char pixels[64*32]; char pixels[64*32];
} SCREEN_DATA; } SCREEN_DATA;
/**
* @brief Must be called first!
*
* @param width
* @param height
*/
void ScreenInit(int width, int height); void ScreenInit(int width, int height);
/**
* @brief Clear the entire simulated screen
*
*/
void ScreenClear(); void ScreenClear();
/**
* @brief Set the pixel's state of the simulated screen (follow the chip-8 specification)
*
* @param x
* @param y
* @param state
* @return char 1 if pixel was already on and 0 otherwise
*/
char ScreenPixelApply(int x, int y, unsigned char state); char ScreenPixelApply(int x, int y, unsigned char state);
void ScreenPixelFlip(int x, int y);
/**
* @brief Get simulated screen dimensions
*
* @param width
* @param height
*/
void ScreenWH(int *width, int *height); void ScreenWH(int *width, int *height);
/**
* @brief Draw simulated screen instantly
*
*/
void ScreenUpdate(); void ScreenUpdate();
/**
* @brief Close screen (must be called before quit)
*
*/
void ScreenClose(); void ScreenClose();

10
src/speaker.c
View file

@ -1,17 +1,19 @@
#include "speaker.h" #include "speaker.h"
#include "beep.h"
Sound s; Sound s;
void SpeakerInit(){ void SpeakerInit(){
InitAudioDevice(); // Initialize audio device InitAudioDevice(); // Initialize audio device
s=LoadSound(SPEAKER_AUDIO_FILE); Wave w=LoadWaveFromMemory(".mp3", beep, sizeof(beep));
s=LoadSoundFromWave(w);
} }
void SpeakerOn(){ void SpeakerPlay(){
PlaySound(s); PlaySound(s);
} }
void SpeakerOff(){ void SpeakerStop(){
StopSound(s); StopSound(s);
} }

23
src/speaker.h
View file

@ -2,7 +2,26 @@
#define SPEAKER_AUDIO_FILE "beep2.mp3" #define SPEAKER_AUDIO_FILE "beep2.mp3"
/**
* @brief Must be called first
*
*/
void SpeakerInit(); void SpeakerInit();
void SpeakerOn();
void SpeakerOff(); /**
* @brief Play beep one time
*
*/
void SpeakerPlay();
/**
* @brief Stop beep (interrupt it)
*
*/
void SpeakerStop();
/**
* @brief Must be called before exiting the application
*
*/
void SpeakerFinish(); void SpeakerFinish();

2
src/vcpu.c
View file

@ -322,7 +322,7 @@ void VCPUTick(){
// Play sound // Play sound
if(State.ST>0) if(State.ST>0)
SpeakerOn(); SpeakerPlay();
// Refresh screen // Refresh screen
if(State.screen_ticks>=(1.0*VCPU_FREQ/SCREEN_FREQ)){ if(State.screen_ticks>=(1.0*VCPU_FREQ/SCREEN_FREQ)){

63
src/vcpu.h
View file

@ -5,28 +5,31 @@
#define SCREEN_FREQ 60 #define SCREEN_FREQ 60
#define REG_FLAG 0xF #define REG_FLAG 0xF
/**
* @brief Store the entire VCPU state
*
*/
typedef struct VCPU_State { typedef struct VCPU_State {
// Program Counter (16 bits but only 12 bits used (4096 memory addresses)) /// @brief Program Counter (16 bits but only 12 bits used (4096 memory addresses))
unsigned short PC; unsigned short PC;
// Index register (16 bits but only 12 bits used (4096 memory addresses)) /// @brief Index register (16 bits but only 12 bits used (4096 memory addresses))
unsigned short I; unsigned short I;
// Stack register (16 bits) /// @brief Stack register (16 bits)
unsigned short S; unsigned short S;
unsigned short stack[100]; // Emulated stack unsigned short stack[100]; // Emulated stack
// General purpose registers (8 bits each) /// @brief General purpose registers (8 bits each)
// Note last one often used as a flag register unsigned char V[16]; // Note last one often used as a flag register
unsigned char V[16];
// Delay timer (8 bits) /// @brief Delay timer (8 bits)
unsigned char DT; unsigned char DT;
// Sound timer (8 bits) /// @brief Sound timer (8 bits)
unsigned char ST; unsigned char ST;
// Intruction (opcode + decoded fields) /// @brief Intruction (opcode + decoded fields)
unsigned short opcode; unsigned short opcode;
unsigned char X; unsigned char X;
unsigned char Y; unsigned char Y;
@ -34,20 +37,58 @@ typedef struct VCPU_State {
unsigned char NN; unsigned char NN;
unsigned short NNN; unsigned short NNN;
// Keypressed /// @brief Keypressed
int keypressed; // Not 0 if a key was pressed int keypressed; // Not 0 if a key was pressed
unsigned char key; unsigned char key;
// Count VCPU ticks /// @brief Count VCPU ticks
int dt_ticks; int dt_ticks;
int st_ticks; int st_ticks;
int screen_ticks; int screen_ticks;
} VCPU_State; } VCPU_State;
/**
* @brief Must be called first!
*
*/
void VCPUInit(); void VCPUInit();
/**
* @brief Fetch instruction from memory
*
*/
void VCPUFetch(); void VCPUFetch();
/**
* @brief Decode instruction from the last fetch
*
*/
void VCPUDecode(); void VCPUDecode();
/**
* @brief Execute decode instruction
*
*/
void VCPUExecute(); void VCPUExecute();
/**
* @brief Fetch, decode and execute an instruction
*
*/
void VCPUTick(); void VCPUTick();
/**
* @brief Simple (a bit) binary to BCD convertion
*
* @param x
* @param u
* @param t
* @param h
*/
void VCPUDoubleDabble(unsigned char x, unsigned char *u, unsigned char *t, unsigned char *h); void VCPUDoubleDabble(unsigned char x, unsigned char *u, unsigned char *t, unsigned char *h);
/**
* @brief Dump VCPU state
*
*/
void VCPUDump(); void VCPUDump();