lifning
/
claxon
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Describe what Claxon is in the readme 

Not why it exists. That is not useful to people looking for a FLAC
decoder. Move that motivation into the docs subdirectory instead.
This commit is contained in:
Ruud van Asseldonk 2017-09-09 11:26:16 +02:00
parent 0ae390ebd5
commit 0cb4ae1649
2 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/background.md Normal file
View File

@ -0,0 +1,9 @@
# Background
Many media players crash on corrupted input (not FLAC in particular). This is
bad, the decoder should signal an error on invalid input, it should not crash.
I suspect that this is partly due to the fact that most decoders are written in
C. I thought I'd try and write a decoder in a safe language: Rust. Video codecs
can be quite complex, and nowadays CPU decoding is not all that common any more.
Therefore, I decided to first try and write a decoder for an audio codec that I
love and use on a daily basis: FLAC.

10
readme.md
View File

@ -7,13 +7,9 @@ A FLAC decoding library in Rust.
[![Crates.io version][crate-img]][crate]
[![Documentation][docs-img]][docs]
Many media players crash on corrupted input (not FLAC in particular). This is
bad, the decoder should signal an error on invalid input, it should not crash.
I suspect that this is partly due to the fact that most decoders are written in
C. I thought I'd try and write a decoder in a safe language: Rust. Video codecs
can be quite complex, and nowadays CPU decoding is not all that common any more.
Therefore, I decided to first try and write a decoder for an audio codec that I
love and use on a daily basis: FLAC.
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
-------