Skip to main content

AudioCodec

Enum AudioCodec 

Source
#[non_exhaustive]
pub enum AudioCodec { Aac, Mp3, Opus, Flac, Pcm, Vorbis, Ac3, Eac3, Dts, Alac, Unknown, }
Expand description

Audio codec identifier.

This enum represents common audio codecs used in media files. It covers the most widely used codecs while remaining extensible via the Unknown variant.

§Common Usage

  • AAC: Most common for streaming and mobile
  • MP3: Legacy but still widely supported
  • Opus: Excellent quality at low bitrates, used for voice communication
  • FLAC: Lossless compression
  • PCM: Uncompressed audio

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Aac

AAC (Advanced Audio Coding) - most common lossy codec

§

Mp3

MP3 (MPEG-1 Audio Layer 3) - legacy lossy codec

§

Opus

Opus - modern lossy codec, excellent at low bitrates

§

Flac

FLAC (Free Lossless Audio Codec) - lossless compression

§

Pcm

PCM (Pulse Code Modulation) - uncompressed audio

§

Vorbis

Vorbis - open lossy codec, used in Ogg containers

§

Ac3

AC3 (Dolby Digital) - surround sound codec

§

Eac3

EAC3 (Dolby Digital Plus) - enhanced AC3

§

Dts

DTS (Digital Theater Systems) - surround sound codec

§

Alac

ALAC (Apple Lossless Audio Codec)

§

Unknown

Unknown or unsupported codec

Implementations§

Source§

impl AudioCodec

Source

pub const fn name(&self) -> &'static str

Returns the codec name as a human-readable string.

§Examples
use ff_format::codec::AudioCodec;

assert_eq!(AudioCodec::Aac.name(), "aac");
assert_eq!(AudioCodec::Flac.name(), "flac");
Source

pub const fn display_name(&self) -> &'static str

Returns the human-readable display name for the codec.

§Examples
use ff_format::codec::AudioCodec;

assert_eq!(AudioCodec::Aac.display_name(), "AAC");
assert_eq!(AudioCodec::Flac.display_name(), "FLAC");
Source

pub const fn is_lossy(&self) -> bool

Returns true if this is a lossy codec.

Lossy codecs discard some audio data for smaller file sizes.

§Examples
use ff_format::codec::AudioCodec;

assert!(AudioCodec::Aac.is_lossy());
assert!(AudioCodec::Mp3.is_lossy());
assert!(!AudioCodec::Flac.is_lossy());
Source

pub const fn is_lossless(&self) -> bool

Returns true if this is a lossless codec.

Lossless codecs preserve all audio data.

§Examples
use ff_format::codec::AudioCodec;

assert!(AudioCodec::Flac.is_lossless());
assert!(AudioCodec::Pcm.is_lossless());
assert!(AudioCodec::Alac.is_lossless());
assert!(!AudioCodec::Aac.is_lossless());
Source

pub const fn is_surround(&self) -> bool

Returns true if this is a surround sound codec.

§Examples
use ff_format::codec::AudioCodec;

assert!(AudioCodec::Ac3.is_surround());
assert!(AudioCodec::Dts.is_surround());
assert!(!AudioCodec::Aac.is_surround());
Source

pub const fn is_unknown(&self) -> bool

Returns true if the codec is unknown.

§Examples
use ff_format::codec::AudioCodec;

assert!(AudioCodec::Unknown.is_unknown());
assert!(!AudioCodec::Aac.is_unknown());

Trait Implementations§

Source§

impl Clone for AudioCodec

Source§

fn clone(&self) -> AudioCodec

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AudioCodec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AudioCodec

Source§

fn default() -> AudioCodec

Returns the “default value” for a type. Read more
Source§

impl Display for AudioCodec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for AudioCodec

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for AudioCodec

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for AudioCodec

Source§

impl Eq for AudioCodec

Source§

impl StructuralPartialEq for AudioCodec

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.