Enum ChannelLayout 

#[non_exhaustive]
pub enum ChannelLayout {
    Mono,
    Stereo,
    Surround51,
    Custom {
        weights: &'static [f64],
    },
}

Channel layout defining the set of channels to measure and their BS.1770-5 per-channel weighting coefficients G_i.

See ITU-R BS.1770-5 Annex 1 Table 3.

Variants (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.

Mono

Mono (centre channel): 1 channel, G = 1.0.

Stereo

Stereo (left, right): 2 channels, G_L = 1.0, G_R = 1.0.

Surround51

5.1 surround (L, R, C, LFE, Ls, Rs): 6 channels, LFE excluded. G_L=1.0, G_R=1.0, G_C=1.0, G_Ls=1.41, G_Rs=1.41, G_LFE=0.0.

Custom

Custom channel count with explicit per-channel weights. weights[i] is G_i for channel i.

Fields

weights: &'static [f64]

Per-channel weighting coefficients (length = channel count).

Implementations

impl ChannelLayout

pub fn channel_count(&self) -> usize

Number of audio channels (including LFE if present).

pub fn weight(&self, index: usize) -> f64

BS.1770-5 weighting coefficient G_i for channel index.

Returns 0.0 for LFE channels (excluded from measurement).

pub fn name(&self) -> &'static str

Display name for this layout.

Trait Implementations

impl Clone for ChannelLayout

fn clone(&self) -> ChannelLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ChannelLayout

impl Debug for ChannelLayout

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

Formats the value using the given formatter.

impl Display for ChannelLayout

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

Formats the value using the given formatter.

impl PartialEq for ChannelLayout

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ChannelLayout