opusic-c 1.5.5

High level bindings to libopus
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

# opusic-c

[![Rust](https://github.com/DoumanAsh/opusic-c/actions/workflows/rust.yml/badge.svg)](https://github.com/DoumanAsh/opusic-c/actions/workflows/rust.yml)
[![Crates.io](https://img.shields.io/crates/v/opusic-c.svg)](https://crates.io/crates/opusic-c)
[![Documentation](https://docs.rs/opusic-c/badge.svg)](https://docs.rs/crate/opusic-c/)

High level bindings to [libopus](https://github.com/xiph/opus)

Target version [1.5.2](https://github.com/xiph/opus/releases/tag/v1.5.2)

## Allocator

This library uses Rust's allocator whenever possible

## Features

- `bundled` - Enables use of bundled OPUS code to build static library. Enabled by default. Refer to [opusic-sys](https://github.com/DoumanAsh/opusic-sys) for details
- `dred` - Enables experimental DRED decoder. Disabled by default.
- `osce` - Enables OSCE. Disabled by default.
- `no-hardening` - disable run-time checks that are cheap and safe for use in production. Disabled by default.
- `no-stack-protector` = disable stack protection. Disabled by default.
- `no-fortify-source` - disable protection against buffer overflows. Disabled by default.
- `no-simd` - disable SIMD optimizations

## Setup

If the `OPUS_LIB_DIR` environment variable is set, it will be searched for the opus library.
Otherwise, a static library will be built automatically.

## Android build

When building for android, library requires presence of env variable `ANDROID_NDK_HOME` in order to supply
cmake with toolchain file and correct target arch.

## Requirements

- `cmake`

### Optional

- `ninja` - When present, build script defaults to use corresponding CMake's generator