flacx 0.9.0

High-performance WAV/FLAC conversion library in Rust.
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

# flacx

`flacx` is the reusable Rust library in this workspace.
It provides encode, decode, and recompress workflows for supported PCM
containers and FLAC.

> `flacx` is still experimental, so APIs and format support may change.

## Quick start

Add the crate to your project:

```bash
cargo add flacx
```

The default feature set enables WAV, AIFF, and CAF support. If you want to
select features yourself, start with:

```toml
[dependencies]
flacx = { version = "0.9.0", default-features = false, features = ["wav", "progress"] }
```

For one-shot file workflows, use the built-in helpers:

```rust
use flacx::builtin::{decode_file, encode_file, recompress_file};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let encoded = encode_file("input.wav", "output.flac")?;
    let decoded = decode_file("output.flac", "roundtrip.wav")?;
    let recompressed = recompress_file("output.flac", "output.recompressed.flac")?;

    println!("encoded {} samples", encoded.total_samples);
    println!("decoded {} frames", decoded.frame_count);
    println!("recompressed {} samples", recompressed.total_samples);
    Ok(())
}
```

For finer control, use the explicit config and reader types such as
`EncoderConfig`, `DecodeConfig`, `RecompressConfig`, `WavReader`, and
`FlacReader`.

## Feature flags

- `wav` — WAV, RF64, and Wave64 support
- `aiff` — AIFF and AIFC support
- `caf` — CAF support
- `progress` — progress snapshots and callbacks

## Reference

For the full API, examples, and module documentation, see the rustdoc on
<https://docs.rs/flacx> or run `cargo doc -p flacx --open`.