aubio_lib/lib.rs
1/*!
2# Bundled aubio library
3
4This crate provides bundled [aubio](https://github.com/aubio/aubio) C library
5for using with [__aubio-rs__](https://crates.io/crates/aubio-rs) crate in case
6when system-installed library is not available.
7
8## Usage
9
10You can simply add this as dependency to your manifest:
11
12```toml
13[dependencies]
14aubio-rs = "^0.1"
15
16# Use bundled library to avoid unresolved links
17aubio-lib = "^0.1"
18```
19
20Next you should say compiler that you want to use that crate:
21
22```rust
23// Either in traditional manner
24extern crate aubio_lib;
25
26// Or in Rust2018 manner
27use aubio_lib as _;
28```
29
30## Features
31
32The following features can be used to customize library configuration:
33
34- _shared_ Force bundle shared (or dynamic) library instead of static
35- _with-fftw3_ Enables __fftw3__ support
36- _nolink-fftw3_ Disable __fftw3__ link
37- _shared-fftw3_ Force shared __fftw3__ link
38
39 */