docs.rs failed to build snes-apu-0.1.8
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

Visit the last successful build: snes-apu-0.1.12

snes-apu

A Super Nintendo audio unit emulator.

Description

This is a highly-accurate emulator for the audio portion of the Super Nintendo.

Note: Due to current limitations in the emu project on which this depends, this will only build on osx. Other platforms will be supported promptly.

Included is an example that can play SPC files:

cargo run --release --example spc_player -- test/ferris-nu.spc test/smashit.spc

The audio unit is made up of a few major parts:

A CPU (SPC700 core), which is 100% cycle-accurate
A DSP, which is accurate to the nearest audio sample
64kb RAM
3 timers
And some extra glue here and there to tie it all together :)

Originally written in C++, this emulator serves as a pilot for porting all of my emulator infrastructure to Rust, and it's been a rather successful project thus far.

Shortcomings

While the emulation itself is highly-accurate (no known bugs minus some things that aren't implemented fully, such as DSP register reads and startup state), and the vast majority of the code can be considered idiomatic Rust code (to the best of my knowledge), there are some small remaining "cosmetic issues" that need to be addressed.

Namely, some unsafe code is used in a few places for internal mutability without runtime checks. Proper wrapping number types are also not currently used, so the emu can only run properly if built in the release config. Both of these issues will be addressed soon.

Additional issues can be found in the issue tracker on Github.

Extras

Included in the test directory are a couple of test SPC files:

ferris-nu.spc - soundtrack for "nu" by elix
smashit.spc - soundtrack for "Smash It" by elix

Attribution

Much of the core SMP code was baked from byuu's higan source code: http://byuu.org/emulation/higan/

Likewise, some of the DSP code (envelopes in particular) was deep-fried from blargg's snes_spc code: http://blargg.8bitalley.com/libs/audio.html#snes_spc

Without their awesome work, this project wouldn't exist!

License