How to install the visqol crate // Lib.rs

Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install visqol

It will make the visqol command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall visqol uninstalls.

Back to the crate overview.

Readme

Visqol 3.1 CLI tool

Implementation of the Visqol v3.1 algorithm for speech quality evaluation in Rust
Builds a command line executable which produces Visqol scores, with a more ergonomic command line interface compared to the C++ implementation.
Also check out the library for using visqol within your Rust project!

Installation

Assuming you have the cargo package manager installed, type cargo install visqol to install the binary.

Usage

visqol --help or simply visqol will show you all the flags you can set when invoking the binary. Note that the CLI tool has 2 subcommands:

wideband: for speech signals, sample rate 16 kHz
fullband: for music signals, sample rate 48 kHz

All command line flags pertaining only the individual modes will have to be specified after the subcommand. Flags like --reference_file will have to be specified before the subcommand as they are mandatory regardless of which mode the algorithm runs in.

Example

visqol \ # command
--reference_file visqol-rs/test_data/clean_speech/CA01_01.wav \ # reference file
--degraded_file visqol-rs/test_data/clean_speech/degraded_signal.wav \ # degraded file
wideband \ # mode: wideband|fullband
--use_unscaled_speech_mos_mapping # flag for wideband mode only
`