flacenc 0.5.1

Pure rust library for embedding FLAC encoder in your application.
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

// Copyright 2023-2024 Google LLC
// Copyright 2025- flacenc-rs developers
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#![allow(dead_code)]

// mimic clippy. This file acts as a part of the crate when checked by clippy.
// but it is outside of the crate when it is actually used by doctests.
#[cfg(clippy)]
use crate as flacenc;

use flacenc::component::Frame;
use flacenc::component::FrameHeader;
use flacenc::component::Stream;
use flacenc::config;
use flacenc::error::Verify;
use flacenc::source::MemSource;

/// Makes a `Stream` for doctest.
pub fn make_example_stream(
    signal_len: usize,
    block_size: usize,
    channels: usize,
    sample_rate: usize,
) -> Stream {
    let signal = vec![0i32; signal_len * channels];
    let bits_per_sample = 16;
    let source = MemSource::from_samples(&signal, channels, bits_per_sample, sample_rate);
    flacenc::encode_with_fixed_block_size(
        &config::Encoder::default()
            .into_verified()
            .expect("config value error"),
        source,
        block_size,
    )
    .expect("encoder error")
}

/// Makes a `Frame` for doctest.
pub fn make_example_frame(
    signal_len: usize,
    block_size: usize,
    channels: usize,
    sample_rate: usize,
) -> Frame {
    make_example_stream(signal_len, block_size, channels, sample_rate)
        .frame(0)
        .unwrap()
        .clone()
}

/// Makes a `Frame` for doctest.
pub fn make_example_frame_header(
    signal_len: usize,
    block_size: usize,
    channels: usize,
    sample_rate: usize,
) -> FrameHeader {
    make_example_frame(signal_len, block_size, channels, sample_rate)
        .header()
        .clone()
}