4 releases (breaking)
|0.5.0||Aug 6, 2023|
|0.4.0||Jul 29, 2023|
|0.3.0||Apr 14, 2023|
|0.2.0||Feb 8, 2023|
#98 in Audio
1,752 downloads per month
Used in 2 crates
Rust bindings for the best-in-breed C libraries of the Vorbis audio codec and Ogg container encapsulation.
vorbis_rs package in this repository provides updated, well-documented and
ergonomic bindings for a modified version of the latest reference Vorbis
encoder, available here, with
the aoTuV and
patchsets applied to it. These patches are considered to implement significant
encoding quality and performance improvements by the community.
ogg_next_sys packages provide
automatically-generated low-level bindings used by
The minimum supported Rust version (MSRV) for every package in this repository is 1.60. Bumping this version is not considered a breaking change for semantic versioning purposes. We will try to do it only when we estimate that such a bump would not cause widespread inconvenience or breakage.
The Rust ecosystem already has bindings for these libraries (see
vorbis), but the quality and maintenance
status of the available crates is problematic in an entangled way that does not
seem reasonable to fix via PRs or patching:
- The high-level
vorbiscrate was not updated in 6 years, has arguably low code quality (lots of
panic!with messages containing e-mail addresses, etc.), and depends on an old version of
vorbis-sys. In turn
vorbis-sysdepends on an old version of the
libvorbisC library with known security vulnerabilities. It also lacks APIs to do some operations needed by sensible audio processing applications that are offered by the C libraries.
vorbis-sysonly contains bindings for
libvorbis, but updated bindings for
vorbisfileare necessary to do meaningful Vorbis stream operations in a sane way. These are not available either.
- There are several random crates in crates.io depending on several of these unsatisfactory binding projects, and it seems unlikely that their maintainers will promptly accept breaking changes on them, generating ecosystem fragmentation.
- Like most software libraries, frameworks and even Linux distributions, the existing crates seem to be oblivious to the existence of the aoTuV and Lancer patchsets, even though they are meant to be drop-in replacements. Thus, users may reasonably expect any patches to be mentioned, which is a good reason to do a different set of binding crates anyway.
Given these issues and the need for a better solution for Ogg Vorbis audio processing applications in Rust, it was decided to spend development effort on making new bindings: it was estimated that the upfront cost of fixing the technical debt of the ecosystem was higher than starting bindings from scratch and periodically updating the library bindings from upstream. Rewriting the patched Vorbis encoder in Rust was deemed unfeasible.
The bindings in this repository are licensed under the BSD 3-Clause "New" or
"Revised" License (
LICENSE or https://opensource.org/licenses/BSD-3-Clause),
which is the same permissive license used by the upstream projects.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in vorbis_rs by you shall be licensed as above, without any additional terms or conditions.
This repository started as an ad-hoc solution to address the needs of a Rust application, but it has grown into a project of its own - PRs are welcome!
Cloning & updating
The C libraries sources are managed with submodules, so updating the binding crates with the latest upstream changes should be easy:
- Update the submodules.
- Run the
generate-bindings.shscript on a Unix-like system (Linux, macOS, BSD) with
rust-bindgen, or build the project with
cargo build --features build-time-bindgen. This will regenerate the low-level FFI bindings according to the latest source code.
cargo test. This will execute some basic sanity checks, including encoding and decoding example files, to check that the bindings still work.
- Review the changes and/or fix failing tests until there is reasonable confidence that the upgrade was completed successfully.
- Commit the changes.
When cloning the repository, remember to also check out the submodules with the
vendor code. You can do this by running
git submodule update --init --recursive.
We welcome friendly talk about the project, including questions, congratulations, and suggestions. Head to the GitHub Discussions page to interact with fellow users, contributors and developers.
Thanks goes to these wonderful people (emoji key):
💻 📖 💡 🚧 📆
This project follows the all-contributors specification. Contributions of any kind welcome!