audiopus_sys 0.1.1

FFI-Binding to Opus, dynamically or statically linked for Windows and UNIX.
Documentation

ci-badge docs-badge rust 1.33+ badge crates.io version

About

audiopus_sys is an FFI-Rust-binding to Opus version 1.3.

Orginally, this sys-crate was made to empower the serenity-crate to build audio features on Windows, Linux, and Mac.

Everyone is welcome to contribute, check out the CONTRIBUTING.md for further guidance.

Building

Requirements

UNIX/GNU/MSYS2

You will need gcc, libclang, make, automake, autoconf, and libtool. Note that automake uses autoconf as dependency already. If you have pkg-config, audiopus_sys will try finding Opus with pkg-config.

MSVC

Currently audiopus_sys links to a prebuilt Opus hence should just work. It supports x86 and x64 as dynamic or static build.

Linking

audiopus_sys links to Opus 1.3 and supports Windows, Linux, and MacOS By default, we statically link to Windows, MacOS, and if you use the musl-environment. We will link dynamically for Linux except when using mentioned musl.

This can be altered by compiling with the static or dynamic feature having effects respective to their names. If both features are enabled, we will pick your system's default.

Environment variables named LIBOPUS_STATIC or OPUS_STATIC will take precedence over features thus overriding the behaviour. The value of these environment variables have no influence of the result: If one of them is set, statically linking will be picked.

Pre-installed Opus

If you have Opus pre-installed, you can set LIBOPUS_LIB_DIR or OPUS_LIB_DIR to point to the directory in which your Opus lies. Be aware that using an Opus other than version 1.3 may not work.

Installation

Add this to your Cargo.toml:

[dependencies]
audiopus_sys = "0.1.1"