Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ruuda/claxon

A FLAC decoder in Rust
https://github.com/ruuda/claxon

Last synced: 3 months ago
JSON representation

A FLAC decoder in Rust

Lists

README 

        
Claxon

======



A FLAC decoding library in Rust.



[![Build Status][ci-img]][ci]

[![Crates.io version][crate-img]][crate]

[![Changelog][changelog-img]][changelog]

[![Documentation][docs-img]][docs]



Claxon is a FLAC decoder written in pure Rust. It has been fuzzed and verified

against the reference decoder for correctness. Its performance is similar to the

reference decoder.



Example

-------

The following example computes the root mean square (RMS) of a FLAC file:



```rust

let mut reader = claxon::FlacReader::open("testsamples/pop.flac").unwrap();

let mut sqr_sum = 0.0;

let mut count = 0;

for sample in reader.samples() {

    let s = sample.unwrap() as f64;

    sqr_sum += s * s;

    count += 1;

}

println!("RMS is {}", (sqr_sum / count as f64).sqrt());

```



More examples can be found in the examples directory. For a simple example

of decoding a FLAC file to wav with Claxon and [Hound][hound], see

[decode_simple.rs](examples/decode_simple.rs). A more efficient way

of decoding requires dealing with a few details of the FLAC format.

See [decode.rs](examples/decode.rs) for an example.



Performance

-----------

These are the times to decode 5 real-world FLAC files to wav, average and

standard deviation of 11 runs, normalized to version 1.3.2 of the [reference

implementation][ref-flac]. Measurements were done on a Skylake i7. Claxon was

compiled with Rust 1.26.0.



| Decoder | Time / reference |

| ------- | ---------------- |

| Claxon  | 1.10 ± 0.01      |

| libflac | 1.00 ± 0.01      |



Note that for decent performance, Claxon should be compiled with

`-C codegen-units=1` on Rust ≥ 1.24.0. Not passing this `RUSTFLAG` can

cause as much as a 45% increase in running time.



Contributing

------------

Contributions in the form of bug reports, feature requests, or pull requests are

welcome. See [contributing.md](contributing.md).



License

-------

Claxon is licensed under the [Apache 2.0][apache2] license. It may be used in

free software as well as closed-source applications, both for commercial and

non-commercial use under the conditions given in the license. If you want to

use Claxon in your GPLv2-licensed software, you can add an [exception][except]

to your copyright notice. Please do not open an issue if you disagree with the

choice of license.



[ci-img]:        https://travis-ci.org/ruuda/claxon.svg?branch=master

[ci]:            https://travis-ci.org/ruuda/claxon

[crate-img]:     https://img.shields.io/crates/v/claxon.svg

[crate]:         https://crates.io/crates/claxon

[changelog-img]: https://img.shields.io/badge/changelog-online-blue.svg

[changelog]:     https://github.com/ruuda/claxon/blob/master/changelog.md#changelog

[docs-img]:      https://img.shields.io/badge/docs-online-blue.svg

[docs]:          https://docs.rs/claxon

[hound]:         https://github.com/ruuda/hound

[ref-flac]:      https://git.xiph.org/?p=flac.git

[apache2]:       https://www.apache.org/licenses/LICENSE-2.0

[except]:        https://www.gnu.org/licenses/gpl-faq.html#GPLIncompatibleLibs