Struct PcmPacket 

pub struct PcmPacket { /* private fields */ }

A block of interleaved PCM audio samples.

Carries channels interleaved channels of frames frames each in a single sample format. The total sample count always equals channels * frames. Equality compares f32 samples bitwise so packets with NaN payloads still round-trip consistently.

Implementations

impl PcmPacket

pub fn i16( channels: usize, frames: usize, samples_i16: Vec<i16>, ) -> Result<Self>

Builds an PcmSampleFormat::I16 packet from interleaved samples.

Returns an error when channels is zero or samples_i16.len() does not equal channels * frames.

Examples

use sim_lib_stream_core::{PcmPacket, PcmSampleFormat};

// Two channels, two frames -> four interleaved samples.
let packet = PcmPacket::i16(2, 2, vec![0, 1, 2, 3]).unwrap();
assert_eq!(packet.channels(), 2);
assert_eq!(packet.frames(), 2);
assert_eq!(packet.sample_format(), PcmSampleFormat::I16);
assert_eq!(packet.samples_i16(), &[0, 1, 2, 3]);

pub fn f32( channels: usize, frames: usize, samples_f32: Vec<f32>, ) -> Result<Self>

Builds an PcmSampleFormat::F32 packet from interleaved samples.

Returns an error when channels is zero, the sample length does not equal channels * frames, or any sample is not finite.

pub fn channels(&self) -> usize

Returns the number of interleaved channels.

pub fn frames(&self) -> usize

Returns the number of frames per channel.

pub fn sample_format(&self) -> PcmSampleFormat

Returns the sample format of the stored samples.

pub fn samples_i16(&self) -> &[i16]

Returns the interleaved i16 samples.

Panics

Panics if the packet holds f32 samples; check sample_format first.

pub fn samples_f32(&self) -> &[f32]

Returns the interleaved f32 samples.

Panics

Panics if the packet holds i16 samples; check sample_format first.

pub fn to_expr(&self) -> Expr

Encodes the packet as a stream/packet/pcm Expr map.

Trait Implementations

impl Clone for PcmPacket

fn clone(&self) -> PcmPacket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PcmPacket

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

Formats the value using the given formatter.

impl Eq for PcmPacket

impl PartialEq for PcmPacket

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

Tests for self and other values to be equal, and is used by ==.

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

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