Struct ChannelLayout

pub struct ChannelLayout<'a>(/* private fields */);

Implementations

impl<'a> ChannelLayout<'a>

pub fn unspecified(channels: u32) -> Self

Get a new channel layout with an unspecified channel ordering.

pub fn custom(channels: Vec<ChannelCustom>) -> Self

pub fn default_for_channels(channels: u32) -> Self

Get the default channel layout for a given number of channels.

If no default layout exists for the given number of channels, an unspecified layout will be returned.

pub fn standard_layouts() -> ChannelLayoutIter

Get an iterator over all standard channel layouts.

pub fn from_mask(layout_mask: ChannelLayoutMask) -> Option<Self>

Initialize a native channel layout from a bitmask indicating which channels are present.

This will return None for invalid bitmask values.

pub fn from_string<S: AsRef<str>>(description: S) -> Option<Self>

Initialize a channel layout from a given string description.

This can be

• the formal channel layout name (as returned by description),
• one or more channel names concatenated with “+”, each optionally containing a custom name after an “@”, e.g. “FL@Left+FR@Right+LFE”,
• a decimal or hexadecimal value of a native channel layout (e.g. “4” or “0x4”),
• the number of channels with the default layout (e.g. “4c”),
• the number of unordered channels (e.g. “4C” or “4 channels”) or
• the ambisonic order followed by optional non-diegetic channels (e.g. “ambisonic 2+stereo”)

pub fn order(&self) -> ChannelOrder

The ChannelOrder used in this layout.

pub fn channels(&self) -> u32

The number of channels in this layout.

pub fn mask(&self) -> Option<ChannelLayoutMask>

If order is Native: A ChannelLayoutMask containing the channels of this layout.

If order is Ambisonic: A ChannelLayoutMask containing the non-diegetic channels of this layout.

Otherwise: None.

pub fn map(&self) -> Option<&[ChannelCustom]>

Returns the custom channel map for this layout.

None if order is not Custom.

pub fn into_owned(self) -> AVChannelLayout

Extracts the owned AVChannelLayout.

Clones it if not already owned.

pub fn as_ptr(&self) -> *const AVChannelLayout

Exposes a pointer to the contained AVChannelLayout for FFI purposes.

This is guaranteed to be a non-null pointer.

pub fn description(&self) -> String

Get a human-readable String describing the channel layout properties.

The returned string will be in the same format that is accepted by from_string, allowing to rebuild the same channel layout (excluding opaque pointers).

pub fn channel_from_index(&self, idx: u32) -> Channel

Get the channel with the given index in a channel layout.

Returns Channel::None when the index is invalid or the channel order is unspecified.

pub fn index_from_channel(&self, channel: Channel) -> Option<u32>

Get the index of a given channel in a channel layout.

pub fn index_from_string<S: AsRef<str>>(&self, name: S) -> Option<u32>

Get the index in a channel layout of a channel described by the given string.

Returns the first match. Accepts channel names in the same format as from_string.

pub fn channel_from_string<S: AsRef<str>>(&self, name: S) -> Channel

Get a channel described by the given string.

Accepts channel names in the same format as from_string.

Returns Channel::None when the string is invalid or the channel order is unspecified.

pub fn subset(&self, mask: ChannelLayoutMask) -> ChannelLayoutMask

Find out what channels from a given set are present in this layout, without regard for their positions.

pub fn is_valid(&self) -> bool

Check whether this layout is valid (i.e. can describe audio data).

impl<'a> ChannelLayout<'a>

pub const MONO: ChannelLayout<'static>

pub const STEREO: ChannelLayout<'static>

pub const _2POINT1: ChannelLayout<'static>

pub const _2_1: ChannelLayout<'static>

pub const SURROUND: ChannelLayout<'static>

pub const _3POINT1: ChannelLayout<'static>

pub const _4POINT0: ChannelLayout<'static>

pub const _4POINT1: ChannelLayout<'static>

pub const _2_2: ChannelLayout<'static>

pub const QUAD: ChannelLayout<'static>

pub const _5POINT0: ChannelLayout<'static>

pub const _5POINT1: ChannelLayout<'static>

pub const _5POINT0_BACK: ChannelLayout<'static>

pub const _5POINT1_BACK: ChannelLayout<'static>

pub const _6POINT0: ChannelLayout<'static>

pub const _6POINT0_FRONT: ChannelLayout<'static>

pub const _3POINT1POINT2: ChannelLayout<'static>

pub const HEXAGONAL: ChannelLayout<'static>

pub const _6POINT1: ChannelLayout<'static>

pub const _6POINT1_BACK: ChannelLayout<'static>

pub const _6POINT1_FRONT: ChannelLayout<'static>

pub const _7POINT0: ChannelLayout<'static>

pub const _7POINT0_FRONT: ChannelLayout<'static>

pub const _7POINT1: ChannelLayout<'static>

pub const _7POINT1_WIDE: ChannelLayout<'static>

pub const _7POINT1_WIDE_BACK: ChannelLayout<'static>

pub const _5POINT1POINT2_BACK: ChannelLayout<'static>

pub const OCTAGONAL: ChannelLayout<'static>

pub const CUBE: ChannelLayout<'static>

pub const _5POINT1POINT4_BACK: ChannelLayout<'static>

pub const _7POINT1POINT2: ChannelLayout<'static>

pub const _7POINT1POINT4_BACK: ChannelLayout<'static>

pub const HEXADECAGONAL: ChannelLayout<'static>

pub const STEREO_DOWNMIX: ChannelLayout<'static>

pub const _22POINT2: ChannelLayout<'static>

Trait Implementations

impl<'a> Borrow<AVChannelLayout> for ChannelLayout<'a>

fn borrow(&self) -> &AVChannelLayout

Immutably borrows from an owned value.

impl<'a> Clone for ChannelLayout<'a>

fn clone(&self) -> ChannelLayout<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ChannelLayout<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a AVChannelLayout> for ChannelLayout<'a>

fn from(value: &'a AVChannelLayout) -> Self

Converts to this type from the input type.

impl<'a> From<AVChannelLayout> for ChannelLayout<'a>

fn from(value: AVChannelLayout) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for ChannelLayout<'a>

fn eq(&self, other: &ChannelLayout<'a>) -> 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<'a> StructuralPartialEq for ChannelLayout<'a>