Struct FrameHeader 

pub struct FrameHeader {
    pub blocking_strategy: bool,
    pub block_size: BlockSize<u16>,
    pub sample_rate: SampleRate<u32>,
    pub channel_assignment: ChannelAssignment,
    pub bits_per_sample: BitsPerSample,
    pub frame_number: FrameNumber,
}

A FLAC frame header

Bits	Field
15	sync code (0b111111111111100)
1	blocking_strategy
4	block_size
4	sample_rate
4	channel_assignment
3	bits_per_sample
1	padding (0)
8-56	frame_number
(8 or 16)	uncommon block size
(8 or 16)	uncommon sample rate
8	CRC-8 of header data

Example

use flac_codec::stream::{
    FrameHeader, BlockSize, SampleRate, ChannelAssignment,
    Independent, BitsPerSample, FrameNumber,
};

let mut data: &[u8] = &[
    0b11111111, 0b1111100_0,  // sync code + blocking
    0b0110_1001,              // block size + sample rate
    0b0000_100_0,             // channels + bps + pad
    0x00,                     // frame number
    0x13,                     // uncommon block size (+1)
    0x64,                     // CRC-8
];

assert_eq!(
    FrameHeader::read_subset(&mut data).unwrap(),
    FrameHeader {
        blocking_strategy: false,
        block_size: BlockSize::Uncommon8(20),
        sample_rate: SampleRate::Hz44100,
        channel_assignment: ChannelAssignment::Independent(
            Independent::Mono
        ),
        bits_per_sample: BitsPerSample::Bps16,
        frame_number: FrameNumber(0),
    },
);

Fields

blocking_strategy: bool

The blocking strategy bit

block_size: BlockSize<u16>

The block size, in samples

sample_rate: SampleRate<u32>

The sample rate, in Hz

channel_assignment: ChannelAssignment

How the channels are assigned

bits_per_sample: BitsPerSample

The number if bits per output sample

frame_number: FrameNumber

The frame’s number in the stream

Implementations

impl FrameHeader

pub fn read<R: Read>( reader: &mut R, streaminfo: &Streaminfo, ) -> Result<Self, Error>

Reads new header from the given reader

pub fn read_subset<R: Read>(reader: &mut R) -> Result<Self, Error>

Reads new header from the given reader

pub fn write<W: Write>( &self, writer: &mut W, streaminfo: &Streaminfo, ) -> Result<(), Error>

Builds header to the given writer

pub fn write_subset<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Builds header to the given writer

Trait Implementations

impl Debug for FrameHeader

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromBitStream for FrameHeader

type Error = Error

Error generated during parsing, such as io::Error

fn from_reader<R: BitRead + ?Sized>(r: &mut R) -> Result<Self, Self::Error>

Parse Self from reader

impl FromBitStreamWith<'_> for FrameHeader

type Error = Error

Error generated during parsing, such as io::Error

type Context = Streaminfo

Some context to use when parsing

fn from_reader<R: BitRead + ?Sized>( r: &mut R, streaminfo: &Streaminfo, ) -> Result<Self, Self::Error>

Parse Self from reader with the given context

impl PartialEq for FrameHeader

fn eq(&self, other: &FrameHeader) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToBitStream for FrameHeader

type Error = Error

Error generated during building, such as io::Error

fn to_writer<W: BitWrite + ?Sized>(&self, w: &mut W) -> Result<(), Self::Error>

Generate self to writer

fn bits<C>(&self) -> Result<C, Self::Error>

where C: Counter, Self: Sized,

Returns length of self in bits, if possible

fn bits_len<C, E>(&self) -> Result<C, Self::Error>

where C: Counter, E: Endianness, Self: Sized,

👎Deprecated since 4.0.0: use of bits() is preferred

Returns total length of self, if possible

impl ToBitStreamWith<'_> for FrameHeader

type Error = Error

Error generated during building, such as io::Error

type Context = Streaminfo

Some context to use when writing

fn to_writer<W: BitWrite + ?Sized>( &self, w: &mut W, _streaminfo: &Streaminfo, ) -> Result<(), Self::Error>

Generate self to writer

fn bits<C>(&self, context: &Self::Context) -> Result<C, Self::Error>

where C: Counter, Self: Sized,

Returns length of self in bits, if possible

fn bits_len<C, E>(&self, context: &Self::Context) -> Result<C, Self::Error>

where C: Counter, E: Endianness, Self: Sized,

👎Deprecated since 4.0.0: use of len() is preferred

Returns total length of self, if possible

impl Eq for FrameHeader

impl StructuralPartialEq for FrameHeader