Struct ConstantMask 

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

A hint that indicates which channels of an audio port are constant.

Channels are defined as constant when all of their samples have the exact same value. This however doesn’t mean they are silent: the value could be different from 0.

This type is internally by a 64-bit bitmask, as per the CLAP specification, hence its name. This also means a constant mask can only hold constant hints for up to 64 channels: information about any extra channels is lost, and this implementation considers those channels to never be constant.

Example

use clack_common::process::ConstantMask;

let mut constant_mask = ConstantMask::from_bits(0b101);

assert!(constant_mask.is_channel_constant(0));
assert!(!constant_mask.is_channel_constant(1));
assert!(constant_mask.is_channel_constant(2));

constant_mask.set_channel_constant(1, true);
assert!(constant_mask.is_channel_constant(1));
assert_eq!(0b111, constant_mask.to_bits());

Implementations

impl ConstantMask

pub const CAPACITY: u8 = 64

The capacity, in bits, of a ConstantMask.

This is how many channels can be represented in a ConstantMask.

pub const FULLY_CONSTANT: ConstantMask

A ConstantMask that represents all 64 possible channels as being fully constant. This constant mask has all its bits set to 1.

pub const FULLY_DYNAMIC: ConstantMask

A ConstantMask that represents all 64 possible channels as being fully dynamic. This constant mask has all its bits set to 0.

pub const fn from_bits(bits: u64) -> ConstantMask

Creates a new constant mask from its inner bitmask representation.

pub const fn to_bits(&self) -> u64

Gets the constant mask’s inner bitmask representation.

pub const fn iter(&self) -> ConstantMaskIter

Returns an iterator over the constant status of each channel in this constant mask.

Example

use clack_common::process::ConstantMask;

let mut iter = ConstantMask::from_bits(0b101).iter();

assert_eq!(Some(true), iter.next());
assert_eq!(Some(false), iter.next());
assert_eq!(Some(true), iter.next());
assert_eq!(Some(false), iter.next());
assert_eq!(Some(false), iter.next());

pub const fn is_channel_constant(&self, channel_index: u64) -> bool

Returns true if the channel at the given index is constant, false otherwise.

This function will always return false when given any index over 63.

pub const fn set_channel_constant(&mut self, channel_index: u64, value: bool)

Sets whether the channel at the given index is constant.

This function does nothing when given any index over 63.

Trait Implementations

impl BitAnd for ConstantMask

type Output = ConstantMask

The resulting type after applying the & operator.

fn bitand(self, rhs: ConstantMask) -> <ConstantMask as BitAnd>::Output

Performs the & operation.

impl BitAndAssign for ConstantMask

fn bitand_assign(&mut self, rhs: ConstantMask)

Performs the &= operation.

impl BitOr for ConstantMask

type Output = ConstantMask

The resulting type after applying the | operator.

fn bitor(self, rhs: ConstantMask) -> <ConstantMask as BitOr>::Output

Performs the | operation.

impl BitOrAssign for ConstantMask

fn bitor_assign(&mut self, rhs: ConstantMask)

Performs the |= operation.

impl BitXor for ConstantMask

type Output = ConstantMask

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: ConstantMask) -> <ConstantMask as BitXor>::Output

Performs the ^ operation.

impl BitXorAssign for ConstantMask

fn bitxor_assign(&mut self, rhs: ConstantMask)

Performs the ^= operation.

impl Clone for ConstantMask

fn clone(&self) -> ConstantMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ConstantMask

impl Debug for ConstantMask

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

Formats the value using the given formatter.

impl Default for ConstantMask

fn default() -> ConstantMask

Returns an empty constant mask, i.e. one where every channel is considered dynamic.

impl Eq for ConstantMask

impl IntoIterator for ConstantMask

type Item = bool

The type of the elements being iterated over.

type IntoIter = ConstantMaskIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> <ConstantMask as IntoIterator>::IntoIter

Creates an iterator from a value.

impl IntoIterator for &ConstantMask

type Item = bool

The type of the elements being iterated over.

type IntoIter = ConstantMaskIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&ConstantMask as IntoIterator>::IntoIter

Creates an iterator from a value.

impl IntoIterator for &mut ConstantMask

type Item = bool

The type of the elements being iterated over.

type IntoIter = ConstantMaskIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&mut ConstantMask as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq for ConstantMask

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ConstantMask