# lewton
Vorbis decoder written in pure Rust.
[Documentation](https://docs.rs/crate/lewton/0.1.0)
[crates.io](https://crates.io/crates/lewton)
If you want to know how to use this crate, look at the examples folder,
or read the docs of the `inside_ogg` module.
Some parts were created with help from the public domain
[stb_vorbis](http://nothings.org/stb_vorbis/) decoder implementation.
It contains no unsafe code per default.
However, in order to meet this goal, it uses a separate crate just for two one liner functions.
If you can't live with this nodejs-ism, but can live with `unsafe` "tainting" the codebase, you can disable the `ieee754` feature.
## About the history of this crate
I've started started to work on this crate in December 2015.
The goal was to learn more about Rust and audio processing,
while also delivering something useful to the Rust ecosystem.
I've tried not to look into the libvorbis implementation,
as then I'd have to first abide the BSD license, and second
as I didn't want this crate to become "just" a translation
from C to Rust. Instead I wanted this crate to base on the
spec only, so that I'd learn more about how vorbis worked.
The only time I did look into the libvorbis implementation
was to look up the implementation of a function needed by
the ogg crate (the CRC function), which is why that crate
is BSD licensed, and attributes the authors.
This crate however contains no code, translated or
otherwise, from the libvorbis implementation.
After some time I realized that without any help of a working
implementation progress would become too slow.
Therefore, I've continued to work with the public domain
`stb_vorbis` implementation and used some of its
code (most prominently for the imdct algorithm) to
translate it to rust. I've also used it for debugging by
comparing its outputs with mine.
Most of this crate however was created by reading the spec
only.
## License
Licensed under Apache 2 or MIT (at your option). For details, see the [LICENSE](LICENSE) file.