HPS Decode

A Rust library for decoding Super Smash Bros. Melee music files.

Quick Start

Here is a quick example of how to play a stereo .hps file using rodio 0.17:

```rust use hps_decode::{Hps, PcmIterator}; use rodio::Source; use std::error::Error;

fn main() -> Result<(), Box> { // Decode an .hps file into PCM samples for playback let hps: Hps = std::fs::read("./respect-your-elders.hps")?.try_into()?; let pcm: PcmIterator = hps.into();

// Play the song with the rodio library
let (_stream, stream_handle) = rodio::OutputStream::try_default()?;
let source = MySource(pcm);
stream_handle.play_raw(source.convert_samples())?;

// Rodio plays sound in a separate audio thread,
// so we need to keep the main thread alive while it's playing.
std::thread::sleep(std::time::Duration::from_secs(120));

Ok(())

}

// This wrapper allows us to implement rodio::Source struct MySource(PcmIterator);

impl Iterator for MySource { type Item = i16; fn next(&mut self) -> Option { self.0.next() } }

impl rodio::Source for MySource { fn currentframelen(&self) -> Option { None } fn channels(&self) -> u16 { self.0.channelcount as u16 } fn samplerate(&self) -> u32 { self.0.samplerate } fn totalduration(&self) -> Option { None } } ```

Documentation

Check out docs.rs for more details about the library.

.HPS File Layout

For general purpose, language agnostic information about the .hps file format, see here.