Struct SampleFormat 

pub struct SampleFormat(/* private fields */);

Audio sample format identifier.

Implementations

impl SampleFormat

pub const NONE: Self

Sentinel for “no format” / unset (AV_SAMPLE_FMT_NONE, -1).

pub const U8: Self

Unsigned 8-bit, packed.

pub const S16: Self

Signed 16-bit, packed.

pub const S32: Self

Signed 32-bit, packed.

pub const S64: Self

Signed 64-bit, packed.

pub const FLT: Self

32-bit float, packed.

pub const DBL: Self

64-bit double, packed.

pub const U8P: Self

Unsigned 8-bit, planar.

pub const S16P: Self

Signed 16-bit, planar.

pub const S32P: Self

Signed 32-bit, planar.

pub const S64P: Self

Signed 64-bit, planar.

pub const FLTP: Self

32-bit float, planar.

pub const DBLP: Self

64-bit double, planar.

pub const fn from_raw(raw: i32) -> Self

Constructs a SampleFormat from the raw integer FFmpeg uses for AVCodecContext::sample_fmt / AVFrame::format (audio).

pub const fn raw(self) -> i32

Returns the underlying integer.

pub const fn is_planar(self) -> bool

Returns true if this is a planar (one buffer per channel) format.

pub const fn is_packed(self) -> bool

Returns true if this is a packed (interleaved) format.

pub const fn bytes_per_sample(self) -> Option<u32>

Bytes per sample for known formats. None for Self::NONE or values outside the closed set this newtype enumerates.

pub const fn to_ffmpeg(self) -> Option<Sample>

The ffmpeg_next::format::Sample this identifier names, or None for Self::NONE and for any integer outside the closed set above.

The inverse of Self::from_raw, and the direction that has to exist for this newtype to be usable as input to FFmpeg’s safe API — swr_alloc_set_opts2 and AVFrame allocation both take the format, and a raw integer read out of a container cannot be cast back into the bindgen enum to get there. Matching against compile-time constants is the way across, exactly as crate::boundary::from_av_pixel_format comes the other way.

pub fn from_ffmpeg(value: Sample) -> Self

The identifier for an ffmpeg_next::format::Sample — the safe direction, since Sample is ffmpeg-next’s own Rust enum and converting it to AVSampleFormat constructs the bindgen enum from a known constant rather than from foreign memory.

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 Copy for SampleFormat

impl Debug for SampleFormat

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

Formats the value using the given formatter.

impl Eq for SampleFormat

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

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SampleFormat