voicesdk::SNRComputer Class Reference

Class (interface) for calculating input voice signal signal-to-noise ratio (SNR) More...

#include <voicesdk/media/signal.h>

Public Types
using	Ptr = std::shared_ptr< SNRComputer >

Public Member Functions
virtual float	compute (const uint8_t *bytes, size_t bytesNum, size_t sampleRate) const =0
	Computes SNR for PCM16 audio bytes. More...
virtual float	compute (const int16_t *pcm16Samples, size_t samplesNum, size_t sampleRate) const =0
	Computes SNR for PCM16 audio samples. More...
virtual float	compute (const float *floatSamples, size_t samplesNum, size_t sampleRate) const =0
	Computes SNR for float (in [-1; 1] range) audio samples. More...
virtual float	compute (const std::string &audioFile) const =0
	Computes SNR for audio file. More...
virtual	~SNRComputer ()=default

Static Public Member Functions
static SNRComputer::Ptr	create (const std::string &initPath)
	Factory method for creating SNRComputer instance. More...

Detailed Description

Class (interface) for calculating input voice signal signal-to-noise ratio (SNR)

Member Typedef Documentation

Ptr

using voicesdk::SNRComputer::Ptr = std::shared_ptr<SNRComputer>

Constructor & Destructor Documentation

~SNRComputer()

virtual voicesdk::SNRComputer::~SNRComputer ( )

virtualdefault

Member Function Documentation

compute() [1/4]

virtual float voicesdk::SNRComputer::compute ( const uint8_t *  bytes, size_t  bytesNum, size_t  sampleRate  ) const

pure virtual

Computes SNR for PCM16 audio bytes.

Parameters

bytes	pointer to array with samples
bytesNum	size of array with samples
sampleRate	audio samples sampling rate

Returns

signal-to-noise ratio (SNR) in dB

Exceptions

std::runtime_error	if runtime error occurred
voicesdk::LicenseException	if license error occurred

compute() [2/4]

virtual float voicesdk::SNRComputer::compute ( const int16_t *  pcm16Samples, size_t  samplesNum, size_t  sampleRate  ) const

pure virtual

Computes SNR for PCM16 audio samples.

Parameters

pcm16Samples	pointer to array with samples
samplesNum	size of array with samples
sampleRate	audio samples sampling rate

Returns

signal-to-noise ratio (SNR) in dB

Exceptions

std::runtime_error	if runtime error occurred
voicesdk::LicenseException	if license error occurred

compute() [3/4]

virtual float voicesdk::SNRComputer::compute ( const float *  floatSamples, size_t  samplesNum, size_t  sampleRate  ) const

pure virtual

Computes SNR for float (in [-1; 1] range) audio samples.

Parameters

floatSamples	pointer to array with samples
samplesNum	size of array with samples
sampleRate	audio samples sampling rate

Returns

signal-to-noise ratio (SNR) in dB

Exceptions

std::runtime_error	if runtime error occurred
voicesdk::LicenseException	if license error occurred

compute() [4/4]

virtual float voicesdk::SNRComputer::compute ( const std::string &  audioFile ) const

pure virtual

Computes SNR for audio file.

Parameters

audioFile

path to audio file

Returns

signal-to-noise ratio (SNR) in dB

Exceptions

std::runtime_error	if runtime error occurred
voicesdk::LicenseException	if license error occurred

create()

static SNRComputer::Ptr voicesdk::SNRComputer::create ( const std::string &  initPath )

static

Factory method for creating SNRComputer instance.

Parameters

initPath

path to the init data folder

Returns

Smart pointer to SNRComputer instance

Exceptions

std::runtime_error	if runtime error occurred
voicesdk::LicenseException	if license error occurred