1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/readme.txt	Fri Oct 21 05:53:11 2011 -0700
     1.3 @@ -0,0 +1,86 @@
     1.4 +snes_spc 0.9.0: SNES SPC-700 APU Emulator
     1.5 +-----------------------------------------
     1.6 +This library includes a full SPC emulator and an S-DSP emulator that can
     1.7 +be used on its own. Two S-DSP emulators are available: a highly accurate
     1.8 +one for use in a SNES emulator, and a 3x faster one for use in an SPC
     1.9 +music player or a resource-limited SNES emulator.
    1.10 +
    1.11 +* Can be used from C and C++ code
    1.12 +* Full SPC-700 APU emulator with cycle accuracy in most cases
    1.13 +* Loads, plays, and saves SPC music files
    1.14 +* Can save and load exact full emulator state
    1.15 +* DSP voice muting, surround sound disable, and song tempo adjustment
    1.16 +* Uses 7% CPU average on 400 MHz Mac to play an SPC using fast DSP
    1.17 +
    1.18 +The accurate DSP emulator is based on past research by others and
    1.19 +hundreds of hours of recent research by me. It passes over a hundred
    1.20 +strenuous timing and behavior validation tests that were also run on the
    1.21 +SNES. As far as I know, it's the first DSP emulator with cycle accuracy,
    1.22 +properly emulating every DSP register and memory access at the exact SPC
    1.23 +cycle it occurs at, whereas previous DSP emulators emulated these only
    1.24 +to the nearest sample (which occurs every 32 clocks).
    1.25 +
    1.26 +Author : Shay Green <gblargg@gmail.com>
    1.27 +Website: http://www.slack.net/~ant/
    1.28 +Forum  : http://groups.google.com/group/blargg-sound-libs
    1.29 +License: GNU Lesser General Public License (LGPL)
    1.30 +
    1.31 +
    1.32 +Getting Started
    1.33 +---------------
    1.34 +Build a program consisting of demo/play_spc.c, demo/demo_util.c,
    1.35 +demo/wave_writer.c, and all source files in snes_spc/. Put an SPC music
    1.36 +file in the same directory and name it "test.spc". Running the program
    1.37 +should generate the recording "out.wav".
    1.38 +
    1.39 +Read snes_spc.txt for more information. Post to the discussion forum for
    1.40 +assistance.
    1.41 +
    1.42 +
    1.43 +Files
    1.44 +-----
    1.45 +snes_spc.txt            Documentation
    1.46 +changes.txt             Change log
    1.47 +license.txt             GNU LGPL license
    1.48 +
    1.49 +demo/
    1.50 +  play_spc.c            Records SPC file to wave sound file
    1.51 +  benchmark.c           Finds how fast emulator runs on your computer
    1.52 +  trim_spc.c            Trims silence off beginning of an SPC file
    1.53 +  save_state.c          Saves/loads exact emulator state to/from file
    1.54 +  comm.c                Communicates with SPC how SNES would
    1.55 +  demo_util.h           General utility functions used by demos
    1.56 +  demo_util.c
    1.57 +  wave_writer.h         WAVE sound file writer used for demo output
    1.58 +  wave_writer.c
    1.59 +
    1.60 +fast_dsp/               Optional standalone fast DSP emulator
    1.61 +  SPC_DSP.h             To use with full SPC emulator, move into
    1.62 +  SPC_DSP.cpp           snes_spc/ and replace original files
    1.63 +
    1.64 +snes_spc/               Library sources
    1.65 +  blargg_config.h       Configuration (modify as necessary)
    1.66 +  
    1.67 +  spc.h                 C interface to SPC emulator and sound filter
    1.68 +  spc.cpp
    1.69 +  
    1.70 +  SPC_Filter.h          Optional filter to make sound more authentic
    1.71 +  SPC_Filter.cpp
    1.72 +  
    1.73 +  SNES_SPC.h            Full SPC emulator
    1.74 +  SNES_SPC.cpp
    1.75 +  SNES_SPC_misc.cpp
    1.76 +  SNES_SPC_state.cpp
    1.77 +  SPC_CPU.h
    1.78 +  
    1.79 +  dsp.h                 C interface to DSP emulator
    1.80 +  dsp.cpp
    1.81 +  
    1.82 +  SPC_DSP.h             Standalone accurate DSP emulator
    1.83 +  SPC_DSP.cpp
    1.84 +  blargg_common.h
    1.85 +  blargg_endian.h
    1.86 +  blargg_source.h
    1.87 +
    1.88 +-- 
    1.89 +Shay Green <gblargg@gmail.com>