Struct FlacStreamReader

pub struct FlacStreamReader<R> { /* private fields */ }

A FLAC reader which operates on streamed input

Streamed FLAC files are simply a collection of raw FLAC frames with no accompanying metadata, like might be delivered over a multicast stream.

Because this reader needs to scan the stream for valid frame sync codes before playback, it requires std::io::BufRead instead of std::io::Read.

Example

use flac_codec::{
    decode::{FlacStreamReader, FrameBuf},
    encode::{FlacStreamWriter, Options},
};
use std::io::{Cursor, Seek};
use std::num::NonZero;
use bitstream_io::SignedBitCount;

let mut flac = Cursor::new(vec![]);

let samples = (0..100).collect::<Vec<i32>>();

let mut w = FlacStreamWriter::new(&mut flac, Options::default());

// write a single FLAC frame with some samples
w.write(
    44100,  // sample rate
    1,      // channels
    16,     // bits-per-sample
    &samples,
).unwrap();

flac.rewind().unwrap();

let mut r = FlacStreamReader::new(&mut flac);

// read a single FLAC frame with some samples
assert_eq!(
    r.read().unwrap(),
    FrameBuf {
        samples: &samples,
        sample_rate: 44100,
        channels: 1,
        bits_per_sample: 16,
    },
);

Implementations

impl<R: BufRead> FlacStreamReader<R>

pub fn new(reader: R) -> Self

Opens new FLAC stream reader which wraps the given reader

pub fn read(&mut self) -> Result<FrameBuf<'_>, Error>

Returns the next decoded FLAC frame and its parameters

Errors

Returns an I/O error from the stream or if any other error occurs when reading the file.