net.idrnd.voicesdk.media

Class QualityCheckEngine

java.lang.Object

net.idrnd.voicesdk.common.VoiceSdkNativePeer

net.idrnd.voicesdk.media.QualityCheckEngine

All Implemented Interfaces:

java.lang.AutoCloseable

public class QualityCheckEngine
extends VoiceSdkNativePeer

Performs audio quality check.

This class serves as gateway to native Voice SDK implementation and allocates resources on native heap. To release the allocated memory, AutoCloseable.close() method should be invoked when the instance is no longer needed.

Any method that delegates to native call may throw VoiceSdkEngineException

Field Summary

Fields inherited from class net.idrnd.voicesdk.common.VoiceSdkNativePeer

nativeId

Constructor Summary

Constructors

Constructor and Description
QualityCheckEngine(java.lang.String initPath) Initializes the instance.

Method Summary

Modifier and Type	Method and Description
QualityCheckEngineResult	checkQuality(byte[] buffer, int sampleRate, QualityCheckMetricsThresholds thresholds) Checks whether audio buffer is suitable from the quality perspective, from the given PCM16 audio bytes.
QualityCheckEngineResult	checkQuality(float[] buffer, int sampleRate, QualityCheckMetricsThresholds thresholds) Checks whether audio buffer is suitable from the quality perspective, from the given float audio samples.
QualityCheckEngineResult	checkQuality(short[] buffer, int sampleRate, QualityCheckMetricsThresholds thresholds) Checks whether audio buffer is suitable from the quality perspective, rom the given PCM16 audio samples.
QualityCheckEngineResult	checkQuality(java.lang.String audioPath, QualityCheckMetricsThresholds thresholds) Checks whether audio file is suitable from the quality perspective, from the given audio file.
protected QualityCheckEngineResult	checkQuality1(java.lang.String audioPath, QualityCheckMetricsThresholds thresholds)
protected QualityCheckEngineResult	checkQuality2(float[] buffer, int sampleRate, QualityCheckMetricsThresholds thresholds)
protected QualityCheckEngineResult	checkQuality3(short[] buffer, int sampleRate, QualityCheckMetricsThresholds thresholds)
protected QualityCheckEngineResult	checkQuality4(byte[] buffer, int sampleRate, QualityCheckMetricsThresholds thresholds)
QualityCheckMetricsThresholds	getRecommendedThresholds(QualityCheckScenario scenario) Gets recommended quality checking thresholds for the specified scenario
protected static long	init(java.lang.String initPath)
protected void	release() This method should release resources on native layer (indirectly using nativeId)

Methods inherited from class net.idrnd.voicesdk.common.VoiceSdkNativePeer

close, equals, finalize, hashCode

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QualityCheckEngine

public QualityCheckEngine(java.lang.String initPath)

Initializes the instance.

Parameters:

initPath - exactly the same as for QualityCheckEngine

Throws:

VoiceSdkEngineException - wraps native exceptions

Method Detail

getRecommendedThresholds

public QualityCheckMetricsThresholds getRecommendedThresholds(QualityCheckScenario scenario)

Gets recommended quality checking thresholds for the specified scenario

Parameters:

scenario - scenario for which recommended thresholds will be returned

Returns:

QualityCheckMetricsThresholds

Throws:

VoiceSdkEngineException - wraps native exceptions

checkQuality

public QualityCheckEngineResult checkQuality(java.lang.String audioPath,
                                             QualityCheckMetricsThresholds thresholds)

Checks whether audio file is suitable from the quality perspective, from the given audio file.

Parameters:

audioPath - path to audio file

thresholds - quality checking thresholds that will be applied to the output quality check metrics

Returns:

QualityCheckEngineResult

Throws:

VoiceSdkEngineException - wraps native exceptions

checkQuality

public QualityCheckEngineResult checkQuality(byte[] buffer,
                                             int sampleRate,
                                             QualityCheckMetricsThresholds thresholds)

Checks whether audio buffer is suitable from the quality perspective, from the given PCM16 audio bytes.

Parameters:

buffer - input array of byte samples

sampleRate - sample frequency, Hz

thresholds - quality checking thresholds that will be applied to the output quality check metrics

Returns:

QualityCheckEngineResult

Throws:

VoiceSdkEngineException - wraps native exceptions

checkQuality

public QualityCheckEngineResult checkQuality(short[] buffer,
                                             int sampleRate,
                                             QualityCheckMetricsThresholds thresholds)

Checks whether audio buffer is suitable from the quality perspective, rom the given PCM16 audio samples.

Parameters:

buffer - input array of PCM16 samples

sampleRate - sample frequency, Hz

thresholds - quality checking thresholds that will be applied to the output quality check metrics

Returns:

QualityCheckEngineResult

Throws:

VoiceSdkEngineException - wraps native exceptions

checkQuality

public QualityCheckEngineResult checkQuality(float[] buffer,
                                             int sampleRate,
                                             QualityCheckMetricsThresholds thresholds)

Checks whether audio buffer is suitable from the quality perspective, from the given float audio samples.

Parameters:

buffer - input array of float samples, values are limited by range [-1; 1]

sampleRate - sample frequency, Hz

thresholds - quality checking thresholds that will be applied to the output quality check metrics

Returns:

QualityCheckEngineResult

Throws:

VoiceSdkEngineException - wraps native exceptions

init

protected static long init(java.lang.String initPath)

checkQuality1

protected QualityCheckEngineResult checkQuality1(java.lang.String audioPath,
                                                 QualityCheckMetricsThresholds thresholds)

checkQuality2

protected QualityCheckEngineResult checkQuality2(float[] buffer,
                                                 int sampleRate,
                                                 QualityCheckMetricsThresholds thresholds)

checkQuality3

protected QualityCheckEngineResult checkQuality3(short[] buffer,
                                                 int sampleRate,
                                                 QualityCheckMetricsThresholds thresholds)

checkQuality4

protected QualityCheckEngineResult checkQuality4(byte[] buffer,
                                                 int sampleRate,
                                                 QualityCheckMetricsThresholds thresholds)

release

protected void release()

Description copied from class: VoiceSdkNativePeer

This method should release resources on native layer (indirectly using nativeId)

Specified by:

release in class VoiceSdkNativePeer