AVChannel

Enum AVChannel 

Source
#[non_exhaustive]
#[repr(i32)]
pub enum AVChannel {
Show 35 variants AV_CHAN_NONE = -1, AV_CHAN_FRONT_LEFT = 0, AV_CHAN_FRONT_RIGHT = 1, AV_CHAN_FRONT_CENTER = 2, AV_CHAN_LOW_FREQUENCY = 3, AV_CHAN_BACK_LEFT = 4, AV_CHAN_BACK_RIGHT = 5, AV_CHAN_FRONT_LEFT_OF_CENTER = 6, AV_CHAN_FRONT_RIGHT_OF_CENTER = 7, AV_CHAN_BACK_CENTER = 8, AV_CHAN_SIDE_LEFT = 9, AV_CHAN_SIDE_RIGHT = 10, AV_CHAN_TOP_CENTER = 11, AV_CHAN_TOP_FRONT_LEFT = 12, AV_CHAN_TOP_FRONT_CENTER = 13, AV_CHAN_TOP_FRONT_RIGHT = 14, AV_CHAN_TOP_BACK_LEFT = 15, AV_CHAN_TOP_BACK_CENTER = 16, AV_CHAN_TOP_BACK_RIGHT = 17, AV_CHAN_STEREO_LEFT = 29, AV_CHAN_STEREO_RIGHT = 30, AV_CHAN_WIDE_LEFT = 31, AV_CHAN_WIDE_RIGHT = 32, AV_CHAN_SURROUND_DIRECT_LEFT = 33, AV_CHAN_SURROUND_DIRECT_RIGHT = 34, AV_CHAN_LOW_FREQUENCY_2 = 35, AV_CHAN_TOP_SIDE_LEFT = 36, AV_CHAN_TOP_SIDE_RIGHT = 37, AV_CHAN_BOTTOM_FRONT_CENTER = 38, AV_CHAN_BOTTOM_FRONT_LEFT = 39, AV_CHAN_BOTTOM_FRONT_RIGHT = 40, AV_CHAN_UNUSED = 512, AV_CHAN_UNKNOWN = 768, AV_CHAN_AMBISONIC_BASE = 1_024, AV_CHAN_AMBISONIC_END = 2_047,
}
Expand description

@defgroup lavu_audio_channels Audio channels @ingroup lavu_audio

Audio channel layout utility functions

@{

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.
§

AV_CHAN_NONE = -1

§

AV_CHAN_FRONT_LEFT = 0

§

AV_CHAN_FRONT_RIGHT = 1

§

AV_CHAN_FRONT_CENTER = 2

§

AV_CHAN_LOW_FREQUENCY = 3

§

AV_CHAN_BACK_LEFT = 4

§

AV_CHAN_BACK_RIGHT = 5

§

AV_CHAN_FRONT_LEFT_OF_CENTER = 6

§

AV_CHAN_FRONT_RIGHT_OF_CENTER = 7

§

AV_CHAN_BACK_CENTER = 8

§

AV_CHAN_SIDE_LEFT = 9

§

AV_CHAN_SIDE_RIGHT = 10

§

AV_CHAN_TOP_CENTER = 11

§

AV_CHAN_TOP_FRONT_LEFT = 12

§

AV_CHAN_TOP_FRONT_CENTER = 13

§

AV_CHAN_TOP_FRONT_RIGHT = 14

§

AV_CHAN_TOP_BACK_LEFT = 15

§

AV_CHAN_TOP_BACK_CENTER = 16

§

AV_CHAN_TOP_BACK_RIGHT = 17

§

AV_CHAN_STEREO_LEFT = 29

Stereo downmix.

§

AV_CHAN_STEREO_RIGHT = 30

See above.

§

AV_CHAN_WIDE_LEFT = 31

See above.

§

AV_CHAN_WIDE_RIGHT = 32

See above.

§

AV_CHAN_SURROUND_DIRECT_LEFT = 33

See above.

§

AV_CHAN_SURROUND_DIRECT_RIGHT = 34

See above.

§

AV_CHAN_LOW_FREQUENCY_2 = 35

See above.

§

AV_CHAN_TOP_SIDE_LEFT = 36

See above.

§

AV_CHAN_TOP_SIDE_RIGHT = 37

See above.

§

AV_CHAN_BOTTOM_FRONT_CENTER = 38

See above.

§

AV_CHAN_BOTTOM_FRONT_LEFT = 39

See above.

§

AV_CHAN_BOTTOM_FRONT_RIGHT = 40

See above.

§

AV_CHAN_UNUSED = 512

Channel is empty can be safely skipped.

§

AV_CHAN_UNKNOWN = 768

Channel contains data, but its position is unknown.

§

AV_CHAN_AMBISONIC_BASE = 1_024

Range of channels between AV_CHAN_AMBISONIC_BASE and AV_CHAN_AMBISONIC_END represent Ambisonic components using the ACN system.

Given a channel id <i> between AV_CHAN_AMBISONIC_BASE and AV_CHAN_AMBISONIC_END (inclusive), the ACN index of the channel <n> is <n> = <i> - AV_CHAN_AMBISONIC_BASE.

@note these values are only used for AV_CHANNEL_ORDER_CUSTOM channel orderings, the AV_CHANNEL_ORDER_AMBISONIC ordering orders the channels implicitly by their position in the stream.

§

AV_CHAN_AMBISONIC_END = 2_047

Range of channels between AV_CHAN_AMBISONIC_BASE and AV_CHAN_AMBISONIC_END represent Ambisonic components using the ACN system.

Given a channel id <i> between AV_CHAN_AMBISONIC_BASE and AV_CHAN_AMBISONIC_END (inclusive), the ACN index of the channel <n> is <n> = <i> - AV_CHAN_AMBISONIC_BASE.

@note these values are only used for AV_CHANNEL_ORDER_CUSTOM channel orderings, the AV_CHANNEL_ORDER_AMBISONIC ordering orders the channels implicitly by their position in the stream.

Trait Implementations§

Source§

impl Clone for AVChannel

Source§

fn clone(&self) -> AVChannel

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 AVChannel

Source§

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

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

impl Hash for AVChannel

Source§

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

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 AVChannel

Source§

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

Source§

impl Eq for AVChannel

Source§

impl StructuralPartialEq for AVChannel

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, 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.