Struct av_data::audiosample::Soniton

pub struct Soniton {
    pub bits: u8,
    pub be: bool,
    pub packed: bool,
    pub planar: bool,
    pub float: bool,
    pub signed: bool,
}

Parameters describing the representation of an audio sample

Fields

bits: u8

Number of bits in each sample.

be: bool

True if the sample data is in big endian layout, false if little endian.

packed: bool

For data which isn't a multiple of 8 bits this is true if there is no padding between samples, false if the data is padded.

planar: bool

If true data is stored in a planar layout with channels occurring in sequence i.e. C1 C1 C1... C2 C2 C2 . If false data is interleaved i.e. C1 C2 C1 C2.

float: bool

True if the sample data is a floating point data type, false otherwise.

signed: bool

True if the sample data is signed, false otherwise.

Methods

impl Soniton

pub fn new(
    bits: u8,
    be: bool,
    packed: bool,
    planar: bool,
    float: bool,
    signed: bool
) -> Self

Creates a new representation of a sample with the provided parameters

pub fn get_audio_size(self, length: usize, alignment: usize) -> usize

For a stream of the given length and alignment return the size of the buffer containing the data

Trait Implementations

impl Clone for Soniton

fn clone(&self) -> Soniton

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Soniton

impl Debug for Soniton

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

Formats the value using the given formatter.

impl Display for Soniton

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

Formats the value using the given formatter.

impl PartialEq<Soniton> for Soniton

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Soniton