Enum SampleFrequencyIndex

#[repr(u8)]
pub enum SampleFrequencyIndex {
    Freq96000 = 0,
    Freq88200 = 1,
    Freq64000 = 2,
    Freq48000 = 3,
    Freq44100 = 4,
    Freq32000 = 5,
    Freq24000 = 6,
    Freq22050 = 7,
    Freq16000 = 8,
    Freq12000 = 9,
    Freq11025 = 10,
    Freq8000 = 11,
    Freq7350 = 12,
    FreqReserved = 13,
    FreqReserved2 = 14,
    FreqEscape = 15,
}

Sampling Frequency Index

The purpose of the FrequencyIndex is to encode commonly used frequencies in 4 bits to save space. These are the set of commonly used frequencies defined in the specification.

ISO/IEC 14496-3:2019(E) - 1.6.2.4 (Table 1.22)

Variants

Freq96000 = 0

96000 Hz

Freq88200 = 1

88200 Hz

Freq64000 = 2

64000 Hz

Freq48000 = 3

48000 Hz

Freq44100 = 4

44100 Hz

Freq32000 = 5

32000 Hz

Freq24000 = 6

24000 Hz

Freq22050 = 7

22050 Hz

Freq16000 = 8

16000 Hz

Freq12000 = 9

12000 Hz

Freq11025 = 10

11025 Hz

Freq8000 = 11

8000 Hz

Freq7350 = 12

7350 Hz

FreqReserved = 13

Reserved

FreqReserved2 = 14

Reserved

FreqEscape = 15

Escape (Meaning the frequency is not in the table, and we need to read an additional 24 bits to get the frequency)

Implementations

impl SampleFrequencyIndex

pub const fn to_freq(&self) -> Option<u32>

Convert the SampleFrequencyIndex to the actual frequency in Hz

Trait Implementations

impl Clone for SampleFrequencyIndex

fn clone(&self) -> SampleFrequencyIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SampleFrequencyIndex

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

Formats the value using the given formatter.

impl FromPrimitive for SampleFrequencyIndex

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl Ord for SampleFrequencyIndex

fn cmp(&self, other: &SampleFrequencyIndex) -> 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 SampleFrequencyIndex

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

fn partial_cmp(&self, other: &SampleFrequencyIndex) -> 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 SampleFrequencyIndex

impl Eq for SampleFrequencyIndex

impl StructuralPartialEq for SampleFrequencyIndex