Struct AVChannelOrder

#[repr(transparent)]
pub struct AVChannelOrder(pub u32);

Audio channel ordering schemes used in FFmpeg’s AVChannelOrder.

This enum defines how channels are arranged in an audio stream, determining their order and mapping.

See the official FFmpeg documentation: https://ffmpeg.org/doxygen/trunk/channel__layout_8h.html

Tuple Fields

0: u32

Implementations

impl AVChannelOrder

pub const Unspecified: Self

Only the channel count is specified, without any further information about the channel order.

• Used for: Unspecified channel layouts.
• Equivalent to: AV_CHANNEL_ORDER_UNSPEC

pub const Native: Self

Channels are in the native order defined in AVChannel (up to 63 channels).

• Used for: Standard layouts where channels are ordered as per the AVChannel enum.
• Equivalent to: AV_CHANNEL_ORDER_NATIVE

pub const Custom: Self

The channel order does not correspond to any predefined order and is stored as an explicit map.

• Used for:
  • Layouts with 64 or more channels.
  • Layouts with empty/skipped (AV_CHAN_UNUSED) channels at arbitrary positions.
• Example: Custom surround sound layouts.
• Equivalent to: AV_CHANNEL_ORDER_CUSTOM

pub const Ambisonic: Self

Ambisonic channel order, where each channel represents a spherical harmonic expansion component.

Channel arrangement (ACN - Ambisonic Channel Number):

• Channel index n is mapped to spherical harmonic degree l and order m:
  • l = floor(sqrt(n))
  • m = n - l * (l + 1)
• Conversely, given degree l and order m, the channel index is:
  • n = l * (l + 1) + m

Normalization: SN3D (Schmidt Semi-Normalization) as defined in AmbiX format §2.1.

• Used for: Ambisonic (3D spatial audio) representations.
• Equivalent to: AV_CHANNEL_ORDER_AMBISONIC

pub const Nb: Self

Number of channel orders (internal use only).

• DO NOT USE in applications.
• Equivalent to: FF_CHANNEL_ORDER_NB

Trait Implementations

impl Clone for AVChannelOrder

fn clone(&self) -> AVChannelOrder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AVChannelOrder

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

Formats the value using the given formatter.

impl From<AVChannelOrder> for i32

fn from(value: AVChannelOrder) -> Self

Converts to this type from the input type.

impl From<AVChannelOrder> for u32

fn from(value: AVChannelOrder) -> Self

Converts to this type from the input type.

impl From<i32> for AVChannelOrder

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<u32> for AVChannelOrder

fn from(value: u32) -> Self

Converts to this type from the input type.

impl Hash for AVChannelOrder

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 AVChannelOrder

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

fn eq(&self, other: &u32) -> 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 PartialEq for AVChannelOrder

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

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

impl Eq for AVChannelOrder

impl StructuralPartialEq for AVChannelOrder