io.github.privacystreams.audio

Class AudioOperators

java.lang.Object

io.github.privacystreams.audio.AudioOperators

@PSOperatorWrapper
public class AudioOperators
extends java.lang.Object

A helper class to access audio-related operators

Constructor Summary

Constructors

Constructor and Description
AudioOperators()

Method Summary

Modifier and Type	Method and Description
static Function<Item,java.lang.Double>	calcLoudness(java.lang.String audioDataField) Calculate the average (RMS) loudness of the audio specified by an AudioData field.
static Function<Item,java.lang.Double>	convertAmplitudeToLoudness(java.lang.String amplitudeField) Calculate loudness (in decibels) based on an amplitude value.
static Function<Item,java.util.List<java.lang.Integer>>	getAmplitudeSamples(java.lang.String audioDataField) Get the amplitude samples of the audio specified by an AudioData field.
static Function<Item,java.lang.String>	getFilepath(java.lang.String audioDataField) Get the file path of the audio specified by an AudioData field.
static Function<Item,java.lang.Integer>	getMaxAmplitude(java.lang.String audioDataField) Get the max amplitude of the audio specified by an AudioData field.
static Function<Item,java.lang.Boolean>	hasHumanVoice(java.lang.String audioDataField) Detect human voice from the audio.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AudioOperators

public AudioOperators()

Method Detail

calcLoudness

public static Function<Item,java.lang.Double> calcLoudness(java.lang.String audioDataField)

Calculate the average (RMS) loudness of the audio specified by an AudioData field. The loudness is an double number indicating the sound pressure level in dB.

Parameters:

audioDataField - the name of the AudioData field.

Returns:

the function.

getMaxAmplitude

public static Function<Item,java.lang.Integer> getMaxAmplitude(java.lang.String audioDataField)

Get the max amplitude of the audio specified by an AudioData field. The amplitude is an Integer from 0 to 32767.

Parameters:

audioDataField - the name of the AudioData field.

Returns:

the function.

getAmplitudeSamples

public static Function<Item,java.util.List<java.lang.Integer>> getAmplitudeSamples(java.lang.String audioDataField)

Get the amplitude samples of the audio specified by an AudioData field. Each amplitude sample is an Integer from 0 to 32767. The amplitude sampling rate can be configured at `Globals.AudioConfig.amplitudeSamplingRate`;

Parameters:

audioDataField - the name of the AudioData field.

Returns:

the function.

convertAmplitudeToLoudness

public static Function<Item,java.lang.Double> convertAmplitudeToLoudness(java.lang.String amplitudeField)

Calculate loudness (in decibels) based on an amplitude value. The amplitude should be a number from 0 to 32767.

Parameters:

amplitudeField - the name of the amplitude field.

Returns:

the function.

getFilepath

public static Function<Item,java.lang.String> getFilepath(java.lang.String audioDataField)

Get the file path of the audio specified by an AudioData field. The path might point to a temporary audio file if it is not from storage. To permanently save the file, you need to copy the file to another file path.

Parameters:

audioDataField - the name of AudioData field

Returns:

the function

hasHumanVoice

public static Function<Item,java.lang.Boolean> hasHumanVoice(java.lang.String audioDataField)

Detect human voice from the audio. Return true if there is human voice.

Parameters:

audioDataField - the name of AudioData field

Returns:

the function