Crate flac_bound

FLAC encoding via libFLAC FFI

Building

There are two supported libFLAC back-ends:

• flac-sys, under the "flac" feature, the default, and
• libflac-sys, under the "libflac" feature group.

flac-sys tries to link to a libFLAC already present on your system, but it doesn’t do a very good job, and might need some help by copying /usr/lib/x86_64-linux-gnu/libFLAC.so (Debian), $MSYSROOT\mingw64\lib\libflac.dll.a (msys2), or equivalent to target/{debug,release}/deps as libflac.so/libflac.dll.a/&c. (note the lowercase).

libflac-sys tries to build libFLAC; this is a problem because it (a) doesn’t work all that well (at all) under GNU/NT, and (b) requires the host system to have both CMake and a C toolchain funxional.

The "libflac-noogg" feature will build libFLAC without OGG support.

The "libflac-nobuild" feature will still use libflac-sys but instruct it to link to the system libFLAC.

Downstreams are encouraged to expose these features to the user.

Examples

let mut outf = File::create("ЦшЦ.flac").unwrap();
let mut outw = WriteWrapper(&mut outf);
let mut enc = FlacEncoder::new().unwrap().compression_level(8).init_write(&mut outw).unwrap();

// The following two calls are equivalent for a two-channel encoder
enc.process(&[&[0xA1], &[0xF3]]).unwrap();
enc.process_interleaved(&[0xA1, 0xF3], 1).unwrap();

// If you don't care about errors that may arise when writing the final frames,
// you can just drop the encoder; or you can inspect them:
match enc.finish() {
    Ok(mut conf) => {
        // Encoding succeeded, a new encoder can be initialised in the same place and memory
        enc = conf.compression_level(0).channels(1).init_stdout_ogg().unwrap();
        // &c.
    }
    Err(enc) => {
        eprintln!("Encoding failed: {:?}", enc.state());
    }
};

Special thanks

To all who support further development on Patreon, in particular:

• ThePhD
• Embark Studios
• Jasper Bekkers

Structs

FlacEncoder

The stream encoder can encode to native FLAC, and optionally Ogg FLAC (check FLAC_API_SUPPORTS_OGG_FLAC) streams and files.

FlacEncoderConfig

Wrapper around a FLAC encoder for configuring the output settings.

WriteWrapper

This wrapper is necessary due to fat pointers.

Enums

FlacEncoderInitError

Possible erroneous return values for the FlacEncoderConfig::init_*() functions.

FlacEncoderState

State values for a FlacEncoder.