Skip to content

karnwatcharasupat/spauq

Repository files navigation

SPAUQ: Spatial Audio Quality Evaluation

codecov CircleCI CodeFactor arXiv Documentation Status

SPAUQ is an Implementation of

K. N. Watcharasupat and A. Lerch, ``Quantifying Spatial Audio Quality Impairment'', submitted to ICASSP 2024.

The supplementary derivation is available both on arXiv and here.

Installation

pip install git+https://github.com/karnwatcharasupat/spauq.git@main

CLI Usage

Evaluating one test file against one reference file

spauq-eval-file --reference_path="path/to/ref.wav" \
  --estimate_path="path/to/est.wav"

Evaluating multiple test files against one reference file

spauq-eval-dir --reference_path="path/to/ref.wav" \
  --estimate_dir="path/to/many/estimates \
  --estimate_ext=".wav"

Programmatic usage

from spauq.core.metrics import spauq_eval
import soundfile as sf

reference, fs = sf.read("path/to/ref.wav")
estimate, fse = sf.read("path/to/est.wav")

assert fs == fse

eval_output = spauq_eval(
    reference=reference,
    estimate=estimate,
    fs=fs
)

signal_to_spatial_distortion_ratio = eval_output["SSR"]
signal_to_residual_distortion_ratio = eval_output["SRR"]

About

SPAUQ: Spatial Audio Quality Evaluation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published