Struct lofty::properties::ChannelMask

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

Channel mask

A mask of (at least) 18 bits, one for each channel.

• Standard speaker channels: https://en.wikipedia.org/wiki/Surround_sound#Channel_notation
• CAF channel bitmap: https://developer.apple.com/library/archive/documentation/MusicAudio/Reference/CAFSpec/CAF_spec/CAF_spec.html#//apple_ref/doc/uid/TP40001862-CH210-BCGBHHHI
• WAV default channel ordering: https://learn.microsoft.com/en-us/previous-versions/windows/hardware/design/dn653308(v=vs.85)
• FFmpeg: https://ffmpeg.org/doxygen/trunk/group__channel__masks.html

Implementations

impl ChannelMask

pub const FRONT_LEFT: Self = _

pub const FRONT_RIGHT: Self = _

pub const FRONT_CENTER: Self = _

pub const LOW_FREQUENCY: Self = _

pub const BACK_LEFT: Self = _

pub const BACK_RIGHT: Self = _

pub const FRONT_LEFT_OF_CENTER: Self = _

pub const FRONT_RIGHT_OF_CENTER: Self = _

pub const BACK_CENTER: Self = _

pub const SIDE_LEFT: Self = _

pub const SIDE_RIGHT: Self = _

pub const TOP_CENTER: Self = _

pub const TOP_FRONT_LEFT: Self = _

pub const TOP_FRONT_CENTER: Self = _

pub const TOP_FRONT_RIGHT: Self = _

pub const TOP_BACK_LEFT: Self = _

pub const TOP_BACK_CENTER: Self = _

pub const TOP_BACK_RIGHT: Self = _

impl ChannelMask

pub const fn mono() -> Self

A single front center channel

pub const fn stereo() -> Self

Front left+right channels

pub const fn linear_surround() -> Self

Front left+right+center channels

pub const fn bits(self) -> u32

The bit mask

pub const fn from_opus_channels(channels: u8) -> Option<Self>

Create a channel mask from the number of channels in an Opus file

See https://datatracker.ietf.org/doc/html/rfc7845#section-5.1.1.2 for the mapping.

pub const fn from_mp4_channels(channels: u8) -> Option<Self>

Create a channel mask from the number of channels in an MP4 file

See https://wiki.multimedia.cx/index.php/MPEG-4_Audio#Channel_Configurations for the mapping.

Trait Implementations

impl BitAnd for ChannelMask

type Output = ChannelMask

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self

Performs the & operation.

impl BitOr for ChannelMask

type Output = ChannelMask

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl Clone for ChannelMask

fn clone(&self) -> ChannelMask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelMask

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

Formats the value using the given formatter.

impl Default for ChannelMask

fn default() -> ChannelMask

Returns the “default value” for a type.

impl PartialEq for ChannelMask

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ChannelMask

impl Eq for ChannelMask

impl StructuralPartialEq for ChannelMask