Enum CodecId 

#[non_exhaustive]
pub enum CodecId {
    None,
    H264,
    Hevc,
    Opus,
    Avif,
    Png,
    Jpeg,
    Gif,
    Webp,
    Pcm,
    Vorbis,
    Flac,
    Jxl,
    Aac,
    Vp9,
    Av2,
    Mp3,
    RawVideo,
    Subrip,
    WebVtt,
}

Identifier for a specific codec (the what, independent of any particular encoder/decoder implementation).

Marked #[non_exhaustive]: we add codecs over time, and external matchers must handle the open-ended set.

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.

None

Sentinel for “no/unknown codec”.

H264

H.264 / AVC video.

Hevc

H.265 / HEVC video. Decode only.

Opus

Opus audio.

Avif

AVIF still image (an AV1 intra frame in a HEIF box).

Png

PNG still image (DEFLATE-compressed RGB/RGBA).

Jpeg

JPEG still image (a.k.a. MJPEG).

Gif

GIF image (first frame; palette-based).

Webp

WebP image (VP8 / VP8L).

Pcm

Linear PCM audio (uncompressed; layout in the stream’s sample format).

Vorbis

Vorbis audio (Ogg Vorbis).

Flac

FLAC lossless audio.

Jxl

JPEG XL image.

Aac

AAC audio (Advanced Audio Coding).

Vp9

VP9 video.

Av2

AV2 video (AOMedia’s successor to AV1). Decode only.

Mp3

MP3 audio (MPEG-1/2 Audio Layer III).

RawVideo

Raw uncompressed video (planar/packed pixels; layout in the stream’s pixel format). The video analog of CodecId::Pcm.

Subrip

SubRip subtitle (.srt): plain-text cues with HH:MM:SS,mmm timing.

WebVtt

WebVTT subtitle (.vtt): plain-text cues with HH:MM:SS.mmm timing.

Implementations

impl CodecId

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

Short canonical name, matching the token used on the ffmpeg command line (-c:v h264, -c:a opus, …).

pub fn media_type(self) -> MediaType

The media category this codec produces.

pub fn sample_format_from_name(name: &str) -> Option<SampleFormat>

The sample format a codec NAME pins, when the name carries one.

CodecId is deliberately format-agnostic — pcm_s16le and pcm_f32le are both CodecId::Pcm — but for raw PCM the name IS the format, and dropping it means -c:a pcm_s16le silently writes whatever the decoder happened to emit. Compressed codecs return None: their sample format is an internal detail, not something the CLI name selects.

pub fn from_name(name: &str) -> Option<CodecId>

Look up a codec id from its canonical CLI name.

Trait Implementations

impl Clone for CodecId

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CodecId

impl Debug for CodecId

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

Formats the value using the given formatter.

impl Default for CodecId

fn default() -> Self

Returns the “default value” for a type.

impl Display for CodecId

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

Formats the value using the given formatter.

impl Eq for CodecId

impl Hash for CodecId

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 PartialEq for CodecId

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CodecId