Skip to main content

segmental_snr

Function segmental_snr 

Source
pub fn segmental_snr(
    reference: &[f32],
    degraded: &[f32],
    frame_len: usize,
) -> Result<f32, AudioError>
Expand description

Segmental SNR in dB between reference and degraded.

  • reference: the clean/reference signal.
  • degraded: the processed/degraded signal, aligned sample-for-sample with reference. Must be the same length.
  • frame_len: samples per frame (e.g. 256). Must be non-zero.

The error signal is degraded - reference. For each full frame the SNR is 10 * log10(ref_energy / err_energy), clamped to [MIN_FRAME_SNR_DB, MAX_FRAME_SNR_DB]; a frame whose error energy is zero (identical) clamps to MAX_FRAME_SNR_DB. The returned value is the mean over all full frames. A trailing partial frame shorter than frame_len is ignored.

Returns AudioError::InvalidParameter if frame_len is 0 or the lengths differ, and AudioError::MalformedAudio if there is not even one full frame.