Sound utility methods. More...

Public Member Functions
	SoundUtility ()

Static Public Member Functions
static int	calculateDataLength (int duration, int clockRate, int channelCount)
	Calculates the number of bytes in a given audio chunk given its duration (ms), clock rate, and channel count. More...

static int	calculateDataLength (int duration, fm.liveswitch.AudioConfig config)
	Calculates the number of bytes in a given audio chunk given its duration (ms), clock rate, and channel count. More...

static int	calculateDataLengthFloat (int duration, int clockRate, int channelCount)
	Calculates the number of bytes in a given audio chunk given its duration (ms), clock rate, and channel count. More...

static int	calculateDataLengthFloat (int duration, fm.liveswitch.AudioConfig config)
	Calculates the number of bytes in a given audio chunk given its duration (ms), clock rate, and channel count. More...

static int	calculateDataLengthFloatPrecise (double duration, int clockRate, int channelCount)
	Calculates the number of bytes in a given audio chunk given its duration (ms), clock rate, and channel count. More...

static int	calculateDataLengthFloatPrecise (double duration, fm.liveswitch.AudioConfig config)
	Calculates the number of bytes in a given audio chunk given its duration (ms), clock rate, and channel count. More...

static int	calculateDataLengthFromTimestampDelta (int timestampDelta, int channelCount)
	Calculates a data length in bytes given a timestamp delta and channel count. More...

static int	calculateDataLengthFromTimestampDelta (int timestampDelta, int channelCount, int bytesPerSample)
	Calculates a data length in bytes given a timestamp delta, channel count, and number of bytes per sample. More...

static int	calculateDataLengthPrecise (double duration, int clockRate, int channelCount)
	Calculates the number of bytes in a given audio chunk given its duration (ms), clock rate, and channel count. More...

static int	calculateDataLengthPrecise (double duration, fm.liveswitch.AudioConfig config)
	Calculates the number of bytes in a given audio chunk given its duration (ms), clock rate, and channel count. More...

static int	calculateDuration (int dataLength, int clockRate, int channelCount)
	Calculates the duration of an audio chunk given its data length (the number of bytes), clock rate, and channel count. More...

static int	calculateDuration (int dataLength, fm.liveswitch.AudioConfig config)
	Calculates the duration of an audio chunk given its data length (the number of bytes), clock rate, and channel count. More...

static int	calculateDurationFloat (int dataLength, int clockRate, int channelCount)
	Calculates the duration of an audio chunk given its data length (the number of bytes), clock rate, and channel count. More...

static int	calculateDurationFloat (int dataLength, fm.liveswitch.AudioConfig config)
	Calculates the duration of an audio chunk given its data length (the number of bytes), clock rate, and channel count. More...

static int	calculateDurationFromSystemTimestampDelta (int systemTimestampDelta)
	Calculates a duration in milliseconds given a system timestamp delta in ticks. More...

static int	calculateDurationFromTimestampDelta (int timestampDelta, int clockRate)
	Calculates a duration in milliseconds given a timestamp delta and its clock rate. More...

static int	calculateOutputLengthForChannelCount (int inputLength, int inputChannelCount, int outputChannelCount)
	Calculates the length of an output data buffer after conversion from an input to an output channel count. More...

static int	calculateSystemTimestampDeltaFromDuration (int duration)
	Calculates a system timestamp delta in ticks given a duration in milliseconds. More...

static long	calculateSystemTimestampDeltaFromTimestampDelta (long timestampDelta, int clockRate)
	Calculates a system timestamp delta given a timestamp delta and its clock rate. More...

static int	calculateTimestampDeltaFromDataLength (int dataLength, int channelCount)
	Calculates a timestamp delta given a data length and channel count. More...

static int	calculateTimestampDeltaFromDataLength (int dataLength, int channelCount, int bytesPerSample)
	Calculates a timestamp delta given a data length in bytes, channel count, and number of bytes per sample. More...

static int	calculateTimestampDeltaFromDuration (int duration, int clockRate)
	Calculates a timestamp delta given its clock rate and a duration in milliseconds. More...

static long	calculateTimestampDeltaFromSystemTimestampDelta (long systemTimestampDelta, int clockRate)
	Calculates a timestamp delta given its clock rate and a system timestamp delta. More...

static fm.liveswitch.DataBuffer	convertChannelCount (fm.liveswitch.DataBuffer input, int inputChannelCount, fm.liveswitch.DataBuffer output, int outputChannelCount)
	Converts a data buffer to a new channel count. More...

static float	floatFromShort (short value)
	Converts a short value to a floating-point value. More...

static fm.liveswitch.DataBuffer	monoToStereo (fm.liveswitch.DataBuffer mono, fm.liveswitch.DataBuffer stereo)
	Converts each sample into two identical samples. More...

static short	readPcmShort (byte[] input, int index)
	Reads a PCM short value from a byte array. More...

static short	shortFromFloat (float value)
	Converts a floating-point value to a short value. More...

static fm.liveswitch.DataBuffer	stereoToMono (fm.liveswitch.DataBuffer stereo, fm.liveswitch.DataBuffer mono)
	Converts each pair of samples into one mixed sample. More...

static void	writePcmShort (short input, byte[] output, int index)
	Writes a PCM short value to a byte array. More...

Detailed Description

Sound utility methods.

Constructor & Destructor Documentation

◆ SoundUtility()

fm.liveswitch.SoundUtility.SoundUtility ( )

Member Function Documentation

◆ calculateDataLength() [1/2]

static int fm.liveswitch.SoundUtility.calculateDataLength	(	int	duration,
		fm.liveswitch.AudioConfig	config
	)

static

Calculates the number of bytes in a given audio chunk given its duration (ms), clock rate, and channel count.

Parameters

duration	The duration in ms.
config	The configuration.

◆ calculateDataLength() [2/2]

static int fm.liveswitch.SoundUtility.calculateDataLength	(	int	duration,
		int	clockRate,
		int	channelCount
	)

static

Calculates the number of bytes in a given audio chunk given its duration (ms), clock rate, and channel count.

Parameters

duration	The duration in ms.
clockRate	The clock rate.
channelCount	The channel count.

◆ calculateDataLengthFloat() [1/2]

static int fm.liveswitch.SoundUtility.calculateDataLengthFloat	(	int	duration,
		fm.liveswitch.AudioConfig	config
	)

static

Calculates the number of bytes in a given audio chunk given its duration (ms), clock rate, and channel count.

Parameters

duration	The duration in ms.
config	The configuration.

◆ calculateDataLengthFloat() [2/2]

static int fm.liveswitch.SoundUtility.calculateDataLengthFloat	(	int	duration,
		int	clockRate,
		int	channelCount
	)

static

Calculates the number of bytes in a given audio chunk given its duration (ms), clock rate, and channel count.

Parameters

duration	The duration in ms.
clockRate	The clock rate.
channelCount	The channel count.

◆ calculateDataLengthFloatPrecise() [1/2]

static int fm.liveswitch.SoundUtility.calculateDataLengthFloatPrecise	(	double	duration,
		fm.liveswitch.AudioConfig	config
	)

static

Calculates the number of bytes in a given audio chunk given its duration (ms), clock rate, and channel count.

Parameters

duration	The duration in ms.
config	The configuration.

◆ calculateDataLengthFloatPrecise() [2/2]

static int fm.liveswitch.SoundUtility.calculateDataLengthFloatPrecise	(	double	duration,
		int	clockRate,
		int	channelCount
	)

static

Calculates the number of bytes in a given audio chunk given its duration (ms), clock rate, and channel count.

Parameters

duration	The duration in ms.
clockRate	The clock rate.
channelCount	The channel count.

◆ calculateDataLengthFromTimestampDelta() [1/2]

static int fm.liveswitch.SoundUtility.calculateDataLengthFromTimestampDelta	(	int	timestampDelta,
		int	channelCount
	)

static

Calculates a data length in bytes given a timestamp delta and channel count.

Parameters

timestampDelta	The timestamp delta.
channelCount	The channel count.

◆ calculateDataLengthFromTimestampDelta() [2/2]

static int fm.liveswitch.SoundUtility.calculateDataLengthFromTimestampDelta	(	int	timestampDelta,
		int	channelCount,
		int	bytesPerSample
	)

static

Calculates a data length in bytes given a timestamp delta, channel count, and number of bytes per sample.

Parameters

timestampDelta	The timestamp delta.
channelCount	The channel count.
bytesPerSample	The number of bytes per sample.

◆ calculateDataLengthPrecise() [1/2]

static int fm.liveswitch.SoundUtility.calculateDataLengthPrecise	(	double	duration,
		fm.liveswitch.AudioConfig	config
	)

static

Calculates the number of bytes in a given audio chunk given its duration (ms), clock rate, and channel count.

Parameters

duration	The duration in ms.
config	The configuration.

◆ calculateDataLengthPrecise() [2/2]

static int fm.liveswitch.SoundUtility.calculateDataLengthPrecise	(	double	duration,
		int	clockRate,
		int	channelCount
	)

static

Calculates the number of bytes in a given audio chunk given its duration (ms), clock rate, and channel count.

Parameters

duration	The duration in ms.
clockRate	The clock rate.
channelCount	The channel count.

◆ calculateDuration() [1/2]

static int fm.liveswitch.SoundUtility.calculateDuration	(	int	dataLength,
		fm.liveswitch.AudioConfig	config
	)

static

Calculates the duration of an audio chunk given its data length (the number of bytes), clock rate, and channel count.

Parameters

dataLength	The length of the audio chunk.
config	The configuration.

◆ calculateDuration() [2/2]

static int fm.liveswitch.SoundUtility.calculateDuration	(	int	dataLength,
		int	clockRate,
		int	channelCount
	)

static

Calculates the duration of an audio chunk given its data length (the number of bytes), clock rate, and channel count.

Parameters

dataLength	The length of the audio chunk.
clockRate	The clock rate.
channelCount	The channel count.

◆ calculateDurationFloat() [1/2]

static int fm.liveswitch.SoundUtility.calculateDurationFloat	(	int	dataLength,
		fm.liveswitch.AudioConfig	config
	)

static

Calculates the duration of an audio chunk given its data length (the number of bytes), clock rate, and channel count.

Parameters

dataLength	The length of the audio chunk.
config	The configuration.

◆ calculateDurationFloat() [2/2]

static int fm.liveswitch.SoundUtility.calculateDurationFloat	(	int	dataLength,
		int	clockRate,
		int	channelCount
	)

static

Calculates the duration of an audio chunk given its data length (the number of bytes), clock rate, and channel count.

Parameters

dataLength	The length of the audio chunk.
clockRate	The clock rate.
channelCount	The channel count.

◆ calculateDurationFromSystemTimestampDelta()

static int fm.liveswitch.SoundUtility.calculateDurationFromSystemTimestampDelta ( int systemTimestampDelta )

static

Calculates a duration in milliseconds given a system timestamp delta in ticks.

Parameters

systemTimestampDelta The system timestamp delta.

◆ calculateDurationFromTimestampDelta()

static int fm.liveswitch.SoundUtility.calculateDurationFromTimestampDelta	(	int	timestampDelta,
		int	clockRate
	)

static

Calculates a duration in milliseconds given a timestamp delta and its clock rate.

Parameters

timestampDelta	The timestamp delta.
clockRate	The clock rate.

◆ calculateOutputLengthForChannelCount()

static int fm.liveswitch.SoundUtility.calculateOutputLengthForChannelCount	(	int	inputLength,
		int	inputChannelCount,
		int	outputChannelCount
	)

static

Calculates the length of an output data buffer after conversion from an input to an output channel count.

Parameters

inputLength	The input data buffer length.
inputChannelCount	The input channel count.
outputChannelCount	The output channel count.

◆ calculateSystemTimestampDeltaFromDuration()

static int fm.liveswitch.SoundUtility.calculateSystemTimestampDeltaFromDuration ( int duration )

static

Calculates a system timestamp delta in ticks given a duration in milliseconds.

Parameters

duration The duration in milliseconds.

◆ calculateSystemTimestampDeltaFromTimestampDelta()

static long fm.liveswitch.SoundUtility.calculateSystemTimestampDeltaFromTimestampDelta	(	long	timestampDelta,
		int	clockRate
	)

static

Calculates a system timestamp delta given a timestamp delta and its clock rate.

Parameters

timestampDelta	The timestamp delta.
clockRate	The clock rate.

◆ calculateTimestampDeltaFromDataLength() [1/2]

static int fm.liveswitch.SoundUtility.calculateTimestampDeltaFromDataLength	(	int	dataLength,
		int	channelCount
	)

static

Calculates a timestamp delta given a data length and channel count.

Parameters

dataLength	The data length in bytes.
channelCount	The channel count.

◆ calculateTimestampDeltaFromDataLength() [2/2]

static int fm.liveswitch.SoundUtility.calculateTimestampDeltaFromDataLength	(	int	dataLength,
		int	channelCount,
		int	bytesPerSample
	)

static

Calculates a timestamp delta given a data length in bytes, channel count, and number of bytes per sample.

Parameters

dataLength	The data length in bytes.
channelCount	The channel count.
bytesPerSample	The number of bytes per sample.

◆ calculateTimestampDeltaFromDuration()

static int fm.liveswitch.SoundUtility.calculateTimestampDeltaFromDuration	(	int	duration,
		int	clockRate
	)

static

Calculates a timestamp delta given its clock rate and a duration in milliseconds.

Parameters

duration	The duration in milliseconds.
clockRate	The clock rate.

◆ calculateTimestampDeltaFromSystemTimestampDelta()

static long fm.liveswitch.SoundUtility.calculateTimestampDeltaFromSystemTimestampDelta	(	long	systemTimestampDelta,
		int	clockRate
	)

static

Calculates a timestamp delta given its clock rate and a system timestamp delta.

Parameters

systemTimestampDelta	The system timestamp delta.
clockRate	The clock rate.

◆ convertChannelCount()

static fm.liveswitch.DataBuffer fm.liveswitch.SoundUtility.convertChannelCount	(	fm.liveswitch.DataBuffer	input,
		int	inputChannelCount,
		fm.liveswitch.DataBuffer	output,
		int	outputChannelCount
	)

static

Converts a data buffer to a new channel count.

The input data buffer length must be a multiple of the input frame size. If the input channel count is greater than the output channel count, the input channel count must divide evenly into the output channel count, and vice versa if the output channel count is greater than the input channel count.

Parameters

input	The input data buffer.
inputChannelCount	The input channel count.
output	The output data buffer.
outputChannelCount	The output channel count.

◆ floatFromShort()

static float fm.liveswitch.SoundUtility.floatFromShort ( short value )

static

Converts a short value to a floating-point value.

Parameters

value The short value.

Returns: The floating-point value.

◆ monoToStereo()

static fm.liveswitch.DataBuffer fm.liveswitch.SoundUtility.monoToStereo	(	fm.liveswitch.DataBuffer	mono,
		fm.liveswitch.DataBuffer	stereo
	)

static

Converts each sample into two identical samples.

Returns: A new fm.liveswitch.DataBufferPooled or
null

.

◆ readPcmShort()

static short fm.liveswitch.SoundUtility.readPcmShort	(	byte[]	input,
		int	index
	)

static

Reads a PCM short value from a byte array.

Parameters

input	The source byte array.
index	The source index in the byte array.

Returns: Short value. This is an int for performance reasons but can be safely cast to a short as needed.

◆ shortFromFloat()

static short fm.liveswitch.SoundUtility.shortFromFloat ( float value )

static

Converts a floating-point value to a short value.

Parameters

value The floating-point value.

Returns: The short value.

◆ stereoToMono()

static fm.liveswitch.DataBuffer fm.liveswitch.SoundUtility.stereoToMono	(	fm.liveswitch.DataBuffer	stereo,
		fm.liveswitch.DataBuffer	mono
	)

static

Converts each pair of samples into one mixed sample.

Returns: A new fm.liveswitch.DataBufferPooled or
null

.

◆ writePcmShort()

static void fm.liveswitch.SoundUtility.writePcmShort	(	short	input,
		byte[]	output,
		int	index
	)

static

Writes a PCM short value to a byte array.

Parameters

input	The short value to write.
output	The target byte array.
index	The target index in the byte array.

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SoundUtility()

Member Function Documentation

◆ calculateDataLength() [1/2]

◆ calculateDataLength() [2/2]

◆ calculateDataLengthFloat() [1/2]

◆ calculateDataLengthFloat() [2/2]

◆ calculateDataLengthFloatPrecise() [1/2]

◆ calculateDataLengthFloatPrecise() [2/2]

◆ calculateDataLengthFromTimestampDelta() [1/2]

◆ calculateDataLengthFromTimestampDelta() [2/2]

◆ calculateDataLengthPrecise() [1/2]

◆ calculateDataLengthPrecise() [2/2]

◆ calculateDuration() [1/2]

◆ calculateDuration() [2/2]

◆ calculateDurationFloat() [1/2]

◆ calculateDurationFloat() [2/2]

◆ calculateDurationFromSystemTimestampDelta()

◆ calculateDurationFromTimestampDelta()

◆ calculateOutputLengthForChannelCount()

◆ calculateSystemTimestampDeltaFromDuration()

◆ calculateSystemTimestampDeltaFromTimestampDelta()

◆ calculateTimestampDeltaFromDataLength() [1/2]

◆ calculateTimestampDeltaFromDataLength() [2/2]

◆ calculateTimestampDeltaFromDuration()

◆ calculateTimestampDeltaFromSystemTimestampDelta()

◆ convertChannelCount()

◆ floatFromShort()

◆ monoToStereo()

◆ readPcmShort()

◆ shortFromFloat()

◆ stereoToMono()

◆ writePcmShort()