n65 0.5.0 → 1.0.0

data/examples/music_driver.asm

@@ -1,202 +0,0 @@
-;------------------------------------------------------------------------------
-;  An NES music engine that understands the binary stream outputted from my
-;  MIDI converter :)
-;;;;
-;  Create an iNES header
-.ines {"prog": 1, "char": 0, "mapper": 0, "mirror": 0}
-
-
-;;;;
-;  Include all the symbols in the nes library
-.inc <nes.sym>
-
-
-;;;;
-;  Let's put a data structure to control the sound engine in the zero page
-.org $0000
-.scope sound_engine
-  ;  Where we are reading from ROM
-  .space stream_read_ptr_lo 1
-  .space stream_read_ptr_hi 1
-
-  ;  Where we are writing in the APU
-  .space stream_write_ptr_lo 1
-  .space stream_write_ptr_hi 1
-  .space delta 1
-.
-
-
-;;;;
-;  Open the prog section bank 0
-.segment prog 0
-
-
-;;;;
-;  Setup the interrupt vectors
-.org $FFFA
-.dw vblank
-.dw main
-.dw irq
-
-
-;;;;
-;  Here is our code entry point, which we'll call main.
-.org $C000
-.scope main
-  ;  Disable interrupts and decimal flag
-  sei
-  cld
-
-  ;  Wait for 2 vblanks
-  wait_vb1:
-    lda nes.ppu.status
-    bpl wait_vb1
-  wait_vb2:
-    lda nes.ppu.status
-    bpl wait_vb2
-
-  ;  Now we want to initialize the hardware to a known state
-  lda #%00
-  ldx #$00
-  clear_segments:
-    sta $0, x
-    sta $100, x
-    sta $200, x
-    sta $300, x
-    sta $400, x
-    sta $500, x
-    sta $600, x
-    sta $700, x
-    inx
-    bne clear_segments
-
-  ;  Reset the stack pointer
-  ldx #$FF
-  txs
-
-  ;  Disable all graphics and vblank nmi
-  lda #$00
-  sta nes.ppu.control
-  sta nes.ppu.mask
-
-  jsr init_sound
-
-  ;  Resume interrupts and NMI and loop here forever
-  lda #%10000000
-  sta nes.ppu.control
-  cli
-  forever:
-    jmp forever
-.
-
-
-;;;;
-;  Initialize the APU to enable Pulse1
-.scope init_sound
-  lda #$00
-  ldy #$00
-  clear_apu:
-    sta nes.apu, y
-    iny
-    cpy #$10
-    bne clear_apu
-
-  lda #>music_buffer
-  ldx #<music_buffer
-  sta sound_engine.stream_read_ptr_hi
-  stx sound_engine.stream_read_ptr_lo
-
-  lda #$40
-  ldx #$00
-  sta sound_engine.stream_write_ptr_hi
-  stx sound_engine.stream_write_ptr_lo
-
-  lda #$01
-  sta sound_engine.delta
-
-  lda #$01
-  sta nes.apu.channel_enable
-  rts
-.
-
-
-;;;;
-;  VBlank reads our music buffer
-.scope vblank
-  ;  Backup our registers
-  pha
-  txa
-  pha
-  tya
-  pha
-
-  jsr sound_engine_driver
-
-  ;  Restore the registers
-  pla
-  tay
-  pla
-  tax
-  pla
-  rti
-.
-
-;;;;
-;  Sound driver that updates the APU registers
-;  via a stream of APU write commands
-.scope sound_engine_driver
-  dec sound_engine.delta
-  bne done
-
-  read_event:
-    ;  Load the new delta from the stream
-    ldy #$00
-    lda (sound_engine.stream_read_ptr_lo), Y
-    sta sound_engine.delta
-
-    ;  Read pulse1 control register value
-    ldy #$01
-    lda (sound_engine.stream_read_ptr_lo), Y
-    sta nes.apu.pulse1.control
-
-    ;  Read the value for pulse1.ft
-    ldy #$02
-    lda (sound_engine.stream_read_ptr_lo), Y
-    sta nes.apu.pulse1.ft
-
-
-    ;  Read the value for pulse1.ct
-    ldy #$03
-    lda (sound_engine.stream_read_ptr_lo), Y
-    sta nes.apu.pulse1.ct
-
-    ;  Advance the 16-bit stream pointer by number of bytes read
-    lda sound_engine.stream_read_ptr_lo
-    clc
-    adc #$04
-    sta sound_engine.stream_read_ptr_lo
-    bcc done
-    inc sound_engine.stream_read_ptr_hi
-
-    ;  If the very next event is 0 delta away, do it now too
-    ;  Read the value for pulse1.ct
-    ldy #$04
-    lda (sound_engine.stream_read_ptr_lo), Y
-    beq read_event
-
-  done:
-  rts
-.
-
-
-;;;;
-;  IRQ Does nothing
-.scope irq
-  rti
-.
-
-;;;;
-;  Include the music buffer stream
-.org $D000
-music_buffer:
-.incbin "data.mus"

data/test/test_memory_space.rb

@@ -1,82 +0,0 @@
-gem 'minitest'
-require 'minitest/autorun'
-require 'minitest/unit'
-
-require_relative '../lib/n65/memory_space.rb'
-
-
-class TestMemorySpace < MiniTest::Test
-  include N65
-
-  def _test_create_prog_rom
-    ##  First just try to read alll of it
-    space = MemorySpace.create_prog_rom
-    contents = space.read(0x8000, 0x4000)
-    assert_equal(contents.size, 0x4000)
-    assert(contents.all?{|byte| byte.zero?})
-
-    ##  It is mirrored so this should also work
-    space = MemorySpace.create_prog_rom
-    contents = space.read(0xC000, 0x4000)
-    assert_equal(contents.size, 0x4000)
-    assert(contents.all?{|byte| byte.zero?})
-  end
-
-
-  def _test_writing
-    ##  Write some bytes into prog 2 area
-    space = MemorySpace.create_prog_rom
-    space.write(0xC000, "hi there".bytes)
-
-    ##  Read them back..
-    contents = space.read(0xC000, 8)
-    assert_equal('hi there', contents.pack('C*'))
-
-    ##  Should be mirrored in prog 1
-    contents = space.read(0x8000, 8)
-    assert_equal('hi there', contents.pack('C*'))
-  end
-
-
-  def _test_reading_out_of_bounds
-    space = MemorySpace.create_prog_rom
-    assert_raises(MemorySpace::AccessOutsideProgRom) do 
-      space.read(0x200, 10)
-    end
-
-    ##  But that is valid char rom area, so no explody
-    space = MemorySpace.create_char_rom
-    space.read(0x200, 10)
-
-    ##  But something like this should explode
-    space = MemorySpace.create_char_rom
-    assert_raises(MemorySpace::AccessOutsideCharRom) do 
-      space.read(0x8001, 10)
-    end
-  end
-
-
-  ####
-  ##  There seem to be problems writing bytes right to
-  ##  the end of the memory map, specifically where the
-  ##  vector table is in prog rom, so let's test that.
-  def test_writing_to_end
-    space = MemorySpace.create_prog_rom
-    bytes = [0xDE, 0xAD]
-
-    ##  Write the NMI address to FFFA
-    space.write(0xFFFA, bytes)
-   
-    ##  Write the entry point to FFFC
-    space.write(0xFFFC, bytes)
-
-    ##  Write the irq to FFFE, and this fails, saying
-    ##  I'm trying to write to $10000 for some reason.
-    space.write(0xFFFE, bytes)
-
-    ##  Write to the very first
-    space.write(0x8000, bytes)
-  end
-
-end
-

data/test/test_symbol_table.rb

@@ -1,238 +0,0 @@
-gem 'minitest'
-require 'minitest/autorun'
-require 'minitest/unit'
-
-require_relative '../lib/n65/symbol_table.rb'
-require_relative '../lib/n65.rb'
-
-
-class TestSymbolTable < MiniTest::Test
-  include N65
-
-  ####
-  ##  Test that we can make simple global symbols
-  def test_define_global_symbols
-    st = SymbolTable.new
-    st.define_symbol('dog', 'woof')
-    assert_equal('woof', st.resolve_symbol('dog'))
-  end
-
-
-  ####
-  ##  Test entering into a sub scope, and setting and retrieving values
-  def test_enter_scope
-    st = SymbolTable.new
-    st.enter_scope('animals')
-    st.define_symbol('dog', 'woof')
-    assert_equal('woof', st.resolve_symbol('dog'))
-  end
-
-
-  ####
-  ##  Access something from an outer scope without dot syntax
-  def test_outer_scope
-    st = SymbolTable.new
-    st.enter_scope('outer')
-    st.define_symbol('dog', 'woof')
-    st.enter_scope('inner')
-    st.define_symbol('pig', 'oink')
-    assert_equal('woof', st.resolve_symbol('dog'))
-  end
-
-
-  ####
-  ##  Access something from an outer scope without dot syntax
-  def test_shadow
-    st = SymbolTable.new
-    st.enter_scope('outer')
-    st.define_symbol('dog', 'woof')
-    st.enter_scope('inner')
-    st.define_symbol('dog', 'bark')
-    assert_equal('bark', st.resolve_symbol('dog'))
-    assert_equal('woof', st.resolve_symbol('outer.dog'))
-    st.exit_scope
-    st.exit_scope
-    assert_equal('bark', st.resolve_symbol('outer.inner.dog'))
-  end
-
-
-  ####
-  ##  Test exiting a sub scope, and seeing that the variable is unavailable by simple name
-  def test_exit_scope
-    st = SymbolTable.new
-    st.enter_scope('animals')
-    st.define_symbol('dog', 'woof')
-    assert_equal('woof', st.resolve_symbol('dog'))
-
-    st.exit_scope
-
-    assert_raises(SymbolTable::UndefinedSymbol) do 
-      assert_equal('woof', st.resolve_symbol('dog'))
-    end
-  end
-
-
-  ####
-  ##  Test exiting a sub scope, and being able to access a symbol through a full path
-  def test_exit_scope
-    st = SymbolTable.new
-    st.enter_scope('animals')
-    st.define_symbol('dog', 'woof')
-    assert_equal('woof', st.resolve_symbol('dog'))
-
-    st.exit_scope
-
-    assert_equal('woof', st.resolve_symbol('animals.dog'))
-  end
-
-
-  ####
-  ##  Have two symbols that are the same but are in different scopes
-  def test_two_scopes_same_symbol
-    st = SymbolTable.new
-    st.define_symbol('dog', 'woof')
-    assert_equal('woof', st.resolve_symbol('dog'))
-
-    st.enter_scope('animals')
-
-    st.define_symbol('dog', 'woofwoof')
-    assert_equal('woofwoof', st.resolve_symbol('dog'))
-
-    st.exit_scope
-
-    assert_equal('woof', st.resolve_symbol('dog'))
-    assert_equal('woofwoof', st.resolve_symbol('animals.dog'))
-  end
-
-
-  ####
-  ##  How do you get stuff out of the global scope when you are in 
-  ##  a sub scope?
-  def test_access_global_scope
-    st = SymbolTable.new
-    st.define_symbol('dog', 'woof')
-    assert_equal('woof', st.resolve_symbol('dog'))
-
-    st.enter_scope('animals')
-    st.define_symbol('pig', 'oink')
-    assert_equal('oink', st.resolve_symbol('pig'))
-
-    ##  Ok, now I want to access global.dog basically from the previous scope
-    assert_equal('woof', st.resolve_symbol('global.dog'))
-  end
-
-
-  ####
-  ##  Now I want to just test making an anonymous scope
-  def test_anonymous_scope
-    st = SymbolTable.new
-    st.define_symbol('dog', 'woof')
-    assert_equal('woof', st.resolve_symbol('dog'))
-
-    st.enter_scope
-    st.define_symbol('pig', 'oink')
-    assert_equal('oink', st.resolve_symbol('pig'))
-
-    ##  Ok, now I want to access global.dog basically from the previous scope
-    assert_equal('woof', st.resolve_symbol('global.dog'))
-
-    ##  Now exit the anonymous scope and get dog
-    st.exit_scope
-    assert_equal('woof', st.resolve_symbol('global.dog'))
-    assert_equal('woof', st.resolve_symbol('dog'))
-  end
-
-
-  ####
-  ##  Now I want to test that I cannot exist the outer-most 
-  ##  global scope by mistake
-  def test_cant_exit_global
-    st = SymbolTable.new
-    assert_raises(SymbolTable::CantExitScope) do 
-      st.exit_scope
-    end
-  end
-
-
-  ####
-  ##  I would like the name of the scope to take on the 
-  ##  value of the program counter at that location.
-  def test_scope_as_symbol
-    program = <<-ASM
-      .ines {"prog": 1, "char": 0, "mapper": 0, "mirror": 0}
-      .org $8000
-      .segment prog 0
-      .scope main
-        sei
-        cld
-        lda \#$00
-        jmp main
-      .
-      jmp main
-      jmp global.main
-    ASM
-
-    ####  There really should be an evaluate string method
-    assembler = Assembler.new
-    program.split(/\n/).each do |line|
-      assembler.assemble_one_line(line)
-    end
-    assembler.fulfill_promises
-    assert_equal(0x8000, assembler.symbol_table.resolve_symbol('global.main'))
-  end
-
-
-  ####
-  ##  Fix a bug where we can't see a forward declared symbol in a scope
-  def test_foward_declaration_in_scope
-    program = <<-ASM
-    ;;;;
-    ;  Create an iNES header
-    .ines {"prog": 1, "char": 0, "mapper": 0, "mirror": 0}
-
-    ;;;;
-    ;  Try to expose a problem we have with scopes
-    ;  We don't seem to be able to branch to a forward
-    ;  declared symbol within a scope
-    .org $8000
-    .scope main
-      sei
-      cld
-      lda #\$00
-      bne forward_symbol
-      nop
-      nop
-      nop
-      forward_symbol:
-      rts
-    .
-    ASM
-
-    ####  There really should be an evaluate string method
-    assembler = Assembler.new
-    program.split(/\n/).each do |line|
-      assembler.assemble_one_line(line)
-    end
-    puts YAML.dump(assembler.symbol_table)
-    assembler.fulfill_promises
-
-    ####  The forward symbol should have been resolved to +3, and the ROM should look like this:
-    correct_rom = [0x4e, 0x45, 0x53, 0x1a, 0x1, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
-                   0x78,        # SEI
-                   0xd8,        # CLD
-                   0xa9, 0x0,   # LDA immediate 0
-                   0xd0, 0x3,   # BNE +3
-                   0xea,        # NOP
-                   0xea,        # NOP
-                   0xea,        # NOP
-                   0x60         # RTS forward_symbol
-    ]
-
-    ####  Grab the first 26 bytes of the rom and make sure they assemble to the above
-    emitted_rom = assembler.emit_binary_rom.bytes[0...26]
-    assert_equal(correct_rom, emitted_rom)
-    ####  Yup it is fixed now.
-  end
-
-end
-

data/utils/midi/Makefile

@@ -1,3 +0,0 @@
-
-build: convert
-	clang++ source/*.cpp -I include -o convert

data/utils/midi/include/event.h

@@ -1,93 +0,0 @@
-#ifndef MIDI_EVENT_H
-#define MIDI_EVENT_H
-
-#include <stdio.h>
-#include <stdlib.h>
-#include "helpers.h"
-
-namespace Midi {
-
-enum MidiMessageType {Midi = 0, MidiNoteOff = 0x8, MidiNoteOn, MidiPolyAftertouch, 
-                      MidiControlChange, MidiProgramChange,    MidiChannelAftertouch, 
-                      MidiPitchWheel,    MidiMetaEvent = 0xFF, MidiSysex1 = 0xF0, MidiSysex2 = 0xF7};
-
-
-enum MidiMetaType {MetaSequenceNumber = 0x0, MetaTextEvent = 0x1,      MetaCopyright = 0x2,
-                   MetaTrackName  = 0x3,     MetaInstrumentName = 0x4, MetaLyricText = 0x5,
-                   MetaMarkerText = 0x6,     MetaCuePoint = 0x7,       MetaChannelPrefixAssignment = 0x20,
-                   MetaEndOfTrack = 0x2F,    MetaTempoSetting = 0x51,  MetaSMPTEOffset = 0x54,
-                   MetaTimeSignature = 0x58, MetaKeySignature = 0x59,  MetaSequenceSpecific = 0x7F};
-
-/***
- *   Spec:
- *   MidiTrackEvent = <delta_time (Variable)> + <MidiEvent> | <MetaEvent> | <SysexEvent>
- *   MidiEvent = <MidiMessageType (4 bits)>  + <channel (4 bits)> + <parameter1 (1 byte)> <parameter2 (1 byte)>
- *   MetaEvent = 0xFF + <MidiMetaType> + <size (Variable)> + <data>
- *   SysexEvent = 0xF0 + <data> + 0xF7  -or- 
- *   SysexEvent = 0xF7 + <data> 0xF7
- ***/
-
-class Event {
-    private:
-    unsigned int  m_delta;
-    unsigned int  m_size;
-    unsigned int  m_data_size;
-    unsigned char m_status;
-    unsigned char m_meta_type;
-    unsigned char m_parameter1;
-    unsigned char m_parameter2;
-    void *m_data;
-
-    public:
-    Event();
-    Event(int delta, int status, int parameter1, int parameter2);
-    void init_midi(int delta, int status, int parameter1, int parameter2);
-    void init_from_file(FILE *fp, unsigned char last_status);
-    ~Event();
-
-    //  Some easy inline functions
-    static bool is_status_byte(unsigned char byte) { return ((byte & 0x80) >> 7) == 1; } 
-    unsigned int delta() const { return m_delta; }
-    unsigned char status() const { return m_status; }
-    unsigned int bytes_read() const { return m_size; }
-    unsigned char parameter1() const { return m_parameter1; }
-    unsigned char parameter2() const { return m_parameter2; }
-    int message_type() const { return (m_status &0xF0) >> 4; }
-    int channel() const { return (m_status &0xF); }
-    void *sysex_data() const { return m_data; }
-
-
-    void print_yaml(){
-      printf("      - :delta: 0x%X\n", m_delta);
-      printf("        :status: 0x%X\n", m_status);
-
-      switch(m_status){ 
-        case 0xFF: 
-          printf("        :meta_type: 0x%X\n", m_meta_type);
-          printf("        :meta_data_size: 0x%X\n", m_data_size);
-          break;
-        case 0xF0: 
-        case 0xF7: 
-          printf("        :sysex_data_size: %d\n", m_data_size);
-          break;
-        default: 
-          printf("        :parameter1: 0x%X\n", m_parameter1);
-          printf("        :parameter2: 0x%X\n", m_parameter2);
-      }
-      /*  Printing out the actual data as a string confuses the YAML parser
-       *  So let's just not do that.
-      if(m_data){
-        printf("        :data: \"");
-
-        for(int i = 0; i < m_data_size; i++){ 
-          printf("%c", ((unsigned char*)m_data)[i]); 
-        } 
-        printf("\"\n");
-      }
-      */
-    }
-};
-
-}
-
-#endif

data/utils/midi/include/file.h

@@ -1,57 +0,0 @@
-#ifndef MIDI_FILE_H
-#define MIDI_FILE_H
-
-#include <vector>
-#include "track.h"
-
-namespace Midi {
-
-/***
- *   Spec:
- *   MidiFile = <midi_header_t> + <MidiTrack> [+ <MidiTrack> ...]
- *
- *   midi_header_t = "MThd" + <size (4 bytes)> + <format (2 bytes)> + <track_count (2 bytes)> + <ticks_per_quarter_note (2 bytes)>
- *
- ***/
-
-typedef struct midi_header_t {
-    char cookie[4];
-    unsigned int  size;
-    unsigned short format;
-    unsigned short track_count;
-    unsigned short ticks_per_quarter_note;
-} __attribute__((packed)) midi_header_t;
-
-
-class File {
-    private:
-    midi_header_t m_header;
-
-    public:
-    File(void);
-    ~File(void);
-    std::vector<Track *> m_tracks;
-    void init_from_file(const char *filename);
-
-    void print_yaml(){
-      printf("---\n");
-      printf(":midi_file:\n");
-      printf("  :header: Mthd\n");
-      printf("  :size: %u\n", m_header.size);
-      printf("  :format: %u\n", m_header.format);
-      printf("  :track_count: %u\n", m_header.track_count);
-      printf("  :ticks_per_quarter_note: %u\n", m_header.ticks_per_quarter_note);
-      printf("  :tracks:\n");
-
-      for(int i = 0; i < m_tracks.size(); i++){
-        if(i == 0){
-          m_tracks[i]->print_yaml(); 
-        }else{
-          m_tracks[i]->print_yaml(); 
-        }
-      }
-    }
-};
-
-}
-#endif

data/utils/midi/include/helpers.h

@@ -1,14 +0,0 @@
-#ifndef MIDI_HELPERS_H
-#define MIDI_HELPERS_H
-
-#include <stdio.h>
-#include <stdlib.h>
-
-namespace Midi {
-
-unsigned int read_variable_length(FILE *fp, unsigned int *value_size);
-short swap_endian_16(short big_endian);
-int swap_endian_32(int big_endian);
-
-}
-#endif