Skip to content

Commit

Permalink
Update readme and Cargo.toml for publication.
Browse files Browse the repository at this point in the history
  • Loading branch information
icefoxen committed Oct 8, 2018
1 parent 97c718c commit 7db3bc3
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
5 changes: 4 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ readme = "README.md"

keywords = []
categories = []
exclude = [
"vectors",
]


[badges]
Expand All @@ -19,4 +22,4 @@ maintenance = { status = "experimental" }
structopt = "0.2"

[dev-dependencies]
minimp3 = "0.3"
minimp3 = "0.3"
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
# rinimp3

An attempt to make a port of [lieff's minimp3](https://github.com/lieff/minimp3) to Rust. The goal is basically to make the minimp3-rs crate, bindings to the C library, unnecessary.

There is a write-up of the translation process [here](https://wiki.alopex.li/PortingCToRust).

First step is to just duplicate it as closely as possible, including passing its tests and fuzzing. Next step would be to smooth its API out and make it more Rusty; https://github.com/germangb/minimp3-rs might be useful for inspiration.

Differences:
Current status: about 90% translated, but there's still some panics lurking in the test cases. I need to find a nice few days and just finish it off.

Differences from `minimp3`:

* i16 output only
* No SIMD
* No conditional compilation -- basically should operate as if the following flags are defined:
* `#define MINIMP3_NO_SIMD`
* `#define MINIMP3_NONSTANDARD_BUT_LOGICAL`???
* `#define MINIMP3_NONSTANDARD_BUT_LOGICAL`???

0 comments on commit 7db3bc3

Please sign in to comment.