Struct miniaudio::ChannelConverter

#[repr(transparent)]pub struct ChannelConverter(_);

channel conversion is used for channel rearrangement and conversion from one channel count to another. The ChannelConverter API is used for channel conversion.

In addition to converting from one channel count to another the channel converter can also be used to rearrange channels. When initializing the channel converter, you can optionally pass in channel maps for both the input and output frames. If the channel counts are the same, each channel map contains teh same channel positions with the exception that they're in a different order, a simple shuffling of the channels will be performed. If, however, there is not a 1:1 mapping of channel positions, or the channel counts differ, the input channels will be mixed based on a mixing mode which is specified when initializing the ChannelConverterConfig object.

When converting from mono to multi-channel, the mono channel is simply copied to each output channel. When going the other way around, the audio of each output channel is simply averaged and copied to the mono channel.

In more complicated cases blending is used. ChannelMixMode::Simple mode will drop excess channels and silence extra channels. For example, convertion from 4 to 2 channels, the 3rd and 4th channels will be dropped, whereas converting from 2 to 4 channels will put silence into the 3rd and 4th channels.

ChannelModeMode::Rectangle mode uses spacial locality based on a rectangle to compute a simple distribution between input and output. Imaging sitting in the middle of a root, with speakers on the walls representing channel positions. Channel::FrontLeft position can be thought of as being in the corder of the front and left walls.

Finally, ChannelMixMode::CustomWeights mode can be used to use custom user-defined weights.

Implementations

impl ChannelConverter

pub fn new(config: &ChannelConverterConfig) -> Result<ChannelConverter, Error>

pub fn format(&self) -> Format

pub fn channels_in(&self) -> u32

pub fn channels_out(&self) -> u32

pub fn channel_map_in(&self) -> &[Channel]

pub fn channel_map_out(&self) -> &[Channel]

pub fn mixing_mode(&self) -> ChannelMixMode

pub fn is_passthrough(&self) -> bool

pub fn is_simple_shuffle(&self) -> bool

pub fn is_simple_mono_expansion(&self) -> bool

pub fn is_stereo_to_mono(&self) -> bool

pub fn shuffle_table(&self) -> &[u8; 32]

pub fn process_pcm_frames(
    &mut self,
    output: &mut FramesMut,
    input: &Frames
) -> Result<(), Error>

Trait Implementations

impl Clone for ChannelConverter

fn clone(&self) -> ChannelConverter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for ChannelConverter

fn drop(&mut self)

Executes the destructor for this type.