flacx 0.5.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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

# flacx

High-performance WAV/FLAC conversion for Rust.

`flacx` is the publishable library crate in the workspace. It provides the
shared encode/decode pipeline used by both Rust callers and the sibling CLI
crate.

## Add to your project

```toml
[dependencies]
flacx = "0.5.0"
```

## Quick start

```rust
use flacx::{Encoder, EncoderConfig, level::Level};

let config = EncoderConfig::builder()
    .level(Level::Level8)
    .threads(4)
    .build();

Encoder::new(config)
    .encode_file("input.wav", "output.flac")
    .unwrap();
```

```rust
use flacx::Decoder;

Decoder::default()
    .decode_file("input.flac", "output.wav")
    .unwrap();
```

## Primary API surface

- `EncoderBuilder`
- `EncoderConfig`
- `Encoder`
- `EncodeSummary`
- `encode_file`
- `encode_bytes`
- `DecodeBuilder`
- `DecodeConfig`
- `Decoder`
- `DecodeSummary`
- `decode_file`
- `decode_bytes`

## Optional progress feature

Progress support is behind the optional `progress` Cargo feature and is
disabled by default.

```toml
[dependencies]
flacx = { version = "0.5.0", features = ["progress"] }
```

When enabled, the additional progress-specific API surface includes:

- `EncodeProgress`
- `DecodeProgress`
- `ProgressSnapshot`
- `Encoder::encode_with_progress`
- `Encoder::encode_file_with_progress`
- `Decoder::decode_with_progress`
- `Decoder::decode_file_with_progress`

## Current scope

- WAV-to-FLAC encoding
- FLAC-to-WAV decoding
- seekable input/output API
- current supported narrow encode/decode subset

## Out of scope

- metadata editing
- non-seekable output
- broader transcoding beyond WAV <-> FLAC
- broader format support beyond the current engine envelope

## Workspace note

The CLI lives in a separate workspace crate, `flacx-cli`, and is not bundled
into the publishable library package.

## Progress note

`Encoder` can optionally report real encode progress while keeping the
existing fast encode path intact. The sibling CLI crate explicitly enables this
feature and uses that signal to render a TTY-only progress bar by default.

## Stability note

The package layout and documentation may change independently from the encode
engine. This crate documents the current workspace behavior without relying on
internal milestone labels.