Struct PerceptualAnalysisResult 

pub struct PerceptualAnalysisResult {
    pub coefficients: NonEmptyVec<f32>,
    pub bin_energies: NonEmptyVec<f32>,
    pub band_metrics: BandMetrics,
    pub n_coefficients: NonZeroUsize,
    pub n_frames: NonZeroUsize,
    pub original_length: usize,
    pub sample_rate: NonZeroU32,
    pub mdct_params: MdctParams,
}

Output of the psychoacoustic analysis pipeline.

Purpose

Bundles everything a downstream codec or bit-allocator needs: the raw spectral coefficients to quantize, the per-bin energies used to build the masking model, the per-band metrics summarising audibility and allowed noise, and enough metadata to reconstruct the signal via reconstruct_signal.

Fields

• coefficients – Flattened MDCT coefficients stored in row-major (C) order with shape (n_coefficients, n_frames). Index as k * n_frames + f for bin k, frame f. These are the values a codec would quantize.
• bin_energies – Average power per MDCT bin across all analysed frames.
• band_metrics – One BandMetric per band.
• n_coefficients – Number of MDCT bins per frame (window_size / 2).
• n_frames – Number of analysis frames.
• original_length – Original signal length in samples, needed for accurate IMDCT.
• sample_rate – Sample rate of the analysed signal.
• mdct_params – The MDCT parameters used for analysis; required by reconstruct_signal.

Fields

coefficients: NonEmptyVec<f32>

Flattened MDCT coefficients, shape (n_coefficients, n_frames), row-major.

bin_energies: NonEmptyVec<f32>

Average power per MDCT bin (linear scale) across all frames.

band_metrics: BandMetrics

Per-band psychoacoustic metrics.

n_coefficients: NonZeroUsize

Number of MDCT coefficients (bins) per frame.

n_frames: NonZeroUsize

Number of MDCT frames.

original_length: usize

Original signal length in samples.

sample_rate: NonZeroU32

Sample rate of the analysed signal.

mdct_params: MdctParams

MDCT parameters used during analysis (needed for reconstruction).

Implementations

impl PerceptualAnalysisResult

pub fn new( coefficients: NonEmptyVec<f32>, bin_energies: NonEmptyVec<f32>, band_metrics: BandMetrics, n_coefficients: NonZeroUsize, n_frames: NonZeroUsize, original_length: usize, sample_rate: NonZeroU32, mdct_params: MdctParams, ) -> Self

Creates a PerceptualAnalysisResult from pre-computed fields.

Trait Implementations

impl Clone for PerceptualAnalysisResult

fn clone(&self) -> PerceptualAnalysisResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PerceptualAnalysisResult

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

Formats the value using the given formatter.