creak 0.3.0

# Creak


[![Crates.io](https://img.shields.io/crates/v/creak)](https://crates.io/crates/creak)

A barebones, opinionated Rust crate for decoding audio files into raw 32-bit float samples.

## Supported formats


|Format |Feature flag |Backend                                     |Status|
|-------|-------------|--------------------------------------------|:----:|
|WAV    |`wav`        |[hound](https://crates.io/crates/hound)     |✅
|Vorbis |`vorbis`     |[lewton](https://crates.io/crates/lewton)   |✅
|MP3    |`mp3`        |[minimp3](https://crates.io/crates/minimp3) |✅
|FLAC   |`flac`       |[claxon](https://crates.io/crates/claxon)   |✅
|Raw    |N/A          |built-in                                    |✅

(✅ = Implemented; 🛠 = WIP)

### Building Creak with partial format support


Creak compiles with support for all formats by default, but this may not be desirable to everyone. To enable support for only specific formats, you'll need to manually specify the desired feature flags in your `Cargo.toml` like this:

```toml
[dependencies]

# Only include support for WAV and Vorbis

creak = { version = "*", default-features = false, features = ["wav", "vorbis"] }
```

## Example


```rust
// Simple program that reads an audio file and dumps its samples in 32-bit float to stdout

use std::{env, io, io::Write};
use creak;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Get a file name from the cmdline args
    let file_name = match env::args().nth(1) {
        Some(arg) => arg,
        None => {
            eprintln!("No audio file specified!");
            return Ok(())
        }
    };

    // Open an audio file of any supported format with one function call
    let decoder = creak::Decoder::open(&file_name)?;

    // Print basic audio info to stderr
    let info = decoder.info();
    eprintln!("Format: {}; Channels: {}; Sample Rate: {}Hz", 
        info.format(), 
        info.channels(), 
        info.sample_rate()
    );

    let mut stdout = io::stdout();
    let mut num_samples: usize = 0;

    // Dump all samples to stdout
    for sample in decoder.into_samples()? {
        stdout.write(&sample?.to_le_bytes())?;
        num_samples += 1;
    }

    eprintln!("{} samples(s) read.", num_samples);
    Ok(())
}
```

## Limitations


Creak only outputs `f32` samples (because they're good). If you don't want `f32` samples, I'm afraid this isn't the crate for you!

Creak cannot handle certain types of audio data, namely:

* MP3 files with variable sample rate or channel count will cause an error while decoding.
* WAV files with "exotic" sample formats are not supported. I don't know who is using 64-bit float samples, but they're too powerful for poor Creak. Have mercy.

## [Changelog](./CHANGELOG.md)


## License


Licensed under either of

* Apache License, Version 2.0
   ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
* MIT license
   ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)

at your option.

## Contribution


Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.