Enum SampleFormat

#[non_exhaustive]
pub enum SampleFormat {
    I8,
    I16,
    I24,
    I32,
    I64,
    U8,
    U16,
    U32,
    U64,
    F32,
    F64,
}

Format that each sample has. Usually, this corresponds to the sampling depth of the audio source. For example, 16 bit quantized samples can be encoded in i16 or u16. Note that the sampling depth is not directly visible for formats where is_float is true.

Also note that the backend must support the encoding of the quantized samples in the given format, as there is no generic transformation from one format into the other done inside the frontend-library code. You can query the supported formats by using supported_input_configs.

A good rule of thumb is to use SampleFormat::I16 as this covers typical music (WAV, MP3) as well as typical audio input devices on most platforms,

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

I8

i8 with a valid range of i8::MIN..=i8::MAX with 0 being the origin.

I16

i16 with a valid range of i16::MIN..=i16::MAX with 0 being the origin.

I24

I24 with a valid range of ‘-(1 << 23)..(1 << 23)’ with 0 being the origin

I32

i32 with a valid range of i32::MIN..=i32::MAX with 0 being the origin.

I64

i64 with a valid range of i64::MIN..=i64::MAX with 0 being the origin.

U8

u8 with a valid range of u8::MIN..=u8::MAX with 1 << 7 == 128 being the origin.

U16

u16 with a valid range of u16::MIN..=u16::MAX with 1 << 15 == 32768 being the origin.

U32

U24 with a valid range of ‘0..16777216’ with 1 << 23 == 8388608 being the origin u32 with a valid range of u32::MIN..=u32::MAX with 1 << 31 being the origin.

U64

U48 with a valid range of ‘0..(1 << 48)’ with 1 << 47 being the origin u64 with a valid range of u64::MIN..=u64::MAX with 1 << 63 being the origin.

F32

f32 with a valid range of -1.0..1.0 with 0.0 being the origin.

F64

f64 with a valid range of -1.0..1.0 with 0.0 being the origin.

Implementations

impl SampleFormat

pub fn sample_size(&self) -> usize

Returns the size in bytes of a sample of this format. This corresponds to the internal size of the rust primitives that are used to represent this sample format (e.g., i24 has size of i32).

pub fn is_int(&self) -> bool

pub fn is_uint(&self) -> bool

pub fn is_float(&self) -> bool

Trait Implementations

impl Clone for SampleFormat

fn clone(&self) -> SampleFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SampleFormat

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

Formats the value using the given formatter.

impl Display for SampleFormat

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

Formats the value using the given formatter.

impl Hash for SampleFormat

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SampleFormat

fn cmp(&self, other: &SampleFormat) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SampleFormat

fn eq(&self, other: &SampleFormat) -> 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 PartialOrd for SampleFormat

fn partial_cmp(&self, other: &SampleFormat) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for SampleFormat

impl Eq for SampleFormat

impl StructuralPartialEq for SampleFormat