org.openimaj.audio.samples

Class FloatSampleBuffer

java.lang.Object

org.openimaj.audio.samples.FloatSampleBuffer

All Implemented Interfaces:

Iterable<Float>, Iterator<Float>, SampleBuffer

public class FloatSampleBuffer
extends Object
implements SampleBuffer, Iterator<Float>

An implementation of a sample buffer that maintains the floating point precision values. Note that this buffer has no timecode associated with it and that SampleChunks cannot be retrieved from it.

Version:

$Author$, $Revision$, $Date$

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

27 Jul 2012

Constructor Summary

Constructors

Constructor and Description
FloatSampleBuffer(double[] samples, AudioFormat af)
FloatSampleBuffer(float[] samples, AudioFormat af)

Method Summary

Modifier and Type	Method and Description
FloatSampleBuffer	add(double scalar) Add the scalar to all the samples
double[]	asDoubleArray() Returns the normalised (0..1) sample buffer data as a double array.
double[][]	asDoubleChannelArray() Returns the samples in their channels as normalise (0..1) sample buffer data.
float[]	asFloatArray() Returns the normalised (0..1) sample buffer data as a float array.
float[][]	asFloatChannelArray() Returns the samples in their channels as normalise (0..1) sample buffer data.
float	get(int index) Get the sample at the given index.
AudioFormat	getFormat() Returns the audio format for this set of samples.
SampleChunk	getSampleChunk() Returns NULL.
SampleChunk	getSampleChunk(int channel) Returns NULL.
AudioTimecode	getStartTimecode() Returns the timecode of the start of this sample buffer.
float	getUnscaled(int index) Returns the sample value at the given index without scaling - that is, at it's original sample value.
boolean	hasNext()
Iterator<Float>	iterator()
FloatSampleBuffer	multiply(double scalar) Multipy the samples by the given scalar
Float	next()
void	remove()
void	set(int index, float sample) Set the sample value at the given index.
void	setFormat(AudioFormat af) Reset the audio format for the samples in this buffer.
int	size() Returns the size of this buffer.
gnu.trove.iterator.TFloatIterator	tf_iterator() Returns a trove float iterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

FloatSampleBuffer

public FloatSampleBuffer(float[] samples,
                         AudioFormat af)

Parameters:

samples - The samples to use

af - The audio format of the samples

FloatSampleBuffer

public FloatSampleBuffer(double[] samples,
                         AudioFormat af)

Parameters:

samples - The samples to use

af - The audio format

Method Detail

get

public float get(int index)

Get the sample at the given index. The sample will be a float and have a value between Integer.MAX_VALUE and Integer.MIN_VALUE. That sample will be signed.

Specified by:

get in interface SampleBuffer

Parameters:

index - The index of the sample to retrieve

Returns:

The sample value as an float

See Also:

SampleBuffer.get(int)

set

public void set(int index,
                float sample)

Set the sample value at the given index. The sample value should be scaled between Integer.MAX_VALUE and Integer.MIN_VALUE (i.e. it should be signed).

Specified by:

set in interface SampleBuffer

Parameters:

index - The index of the sample to set.

sample - The sample value to set.

See Also:

SampleBuffer.set(int, float)

size

public int size()

Returns the size of this buffer. Divide by the number of channels to get the number of samples per channel.

Specified by:

size in interface SampleBuffer

Returns:

the size of this buffer.

See Also:

SampleBuffer.size()

getFormat

public AudioFormat getFormat()

Returns the audio format for this set of samples.

Specified by:

getFormat in interface SampleBuffer

Returns:

The AudioFormat for this set of samples.

See Also:

SampleBuffer.getFormat()

setFormat

public void setFormat(AudioFormat af)

Reset the audio format for the samples in this buffer.

Specified by:

setFormat in interface SampleBuffer

Parameters:

af - The AudioFormat

See Also:

SampleBuffer.setFormat(org.openimaj.audio.AudioFormat)

getSampleChunk

public SampleChunk getSampleChunk()

Returns NULL. If you need a sample chunk from this sample buffer, then you must instantiate the appropriate sample chunk first and fill it. It cannot be done from this class because this class no longer knows how many bits you would like the sample chunk to be created as. Return a sample chunk that contains the data from this sample buffer. Note that any timestamps will be unset in the new sample chunk.

Specified by:

getSampleChunk in interface SampleBuffer

Returns:

A SampleChunk containing data in this buffer.

See Also:

SampleBuffer.getSampleChunk()

getSampleChunk

public SampleChunk getSampleChunk(int channel)

Returns NULL. If you need a sample chunk from this sample buffer, then you must instantiate the appropriate sample chunk first and fill it. It cannot be done from this class because this class no longer knows how many bits you would like the sample chunk to be created as. Return a sample chunk that contains the data from a specific channel in this sample buffer. The channel is numbered from 0 (so mono audio streams will only have 1 channel accessed with getSampleChunk(0)). Note that any timestamps will be unset in the new sample chunk.

Specified by:

getSampleChunk in interface SampleBuffer

Parameters:

channel - The channel

Returns:

A SampleChunk containing data in this buffer.

See Also:

SampleBuffer.getSampleChunk(int)

asDoubleArray

public double[] asDoubleArray()

Returns the normalised (0..1) sample buffer data as a double array.

Specified by:

asDoubleArray in interface SampleBuffer

Returns:

A double array containing the normalised samples

See Also:

SampleBuffer.asDoubleArray()

asDoubleChannelArray

public double[][] asDoubleChannelArray()

Returns the samples in their channels as normalise (0..1) sample buffer data.

Specified by:

asDoubleChannelArray in interface SampleBuffer

Returns:

The array where the first dimension is the channels.

See Also:

SampleBuffer.asDoubleChannelArray()

asFloatArray

public float[] asFloatArray()

Returns the normalised (0..1) sample buffer data as a float array.

Specified by:

asFloatArray in interface SampleBuffer

Returns:

A double array containing the normalised samples

See Also:

SampleBuffer.asDoubleArray()

asFloatChannelArray

public float[][] asFloatChannelArray()

Returns the samples in their channels as normalise (0..1) sample buffer data.

Specified by:

asFloatChannelArray in interface SampleBuffer

Returns:

The array where the first dimension is the channels.

See Also:

SampleBuffer.asDoubleChannelArray()

getUnscaled

public float getUnscaled(int index)

Returns the sample value at the given index without scaling - that is, at it's original sample value. This can be useful for debugging, or if the sample buffer is being used for non-audio applications.

Specified by:

getUnscaled in interface SampleBuffer

Parameters:

index - The index to retrieve

Returns:

The value unscaled

See Also:

SampleBuffer.getUnscaled(int)

multiply

public FloatSampleBuffer multiply(double scalar)

Multipy the samples by the given scalar

Parameters:

scalar - The scalar

Returns:

this object

add

public FloatSampleBuffer add(double scalar)

Add the scalar to all the samples

Parameters:

scalar - The scalar

Returns:

this object

iterator

public Iterator<Float> iterator()

Specified by:

iterator in interface Iterable<Float>

See Also:

Iterable.iterator()

tf_iterator

public gnu.trove.iterator.TFloatIterator tf_iterator()

Returns a trove float iterator

Returns:

a trove float iterator

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Float>

See Also:

Iterator.hasNext()

next

public Float next()

Specified by:

next in interface Iterator<Float>

See Also:

Iterator.next()

remove

public void remove()

Specified by:

remove in interface Iterator<Float>

See Also:

Iterator.remove()

getStartTimecode

public AudioTimecode getStartTimecode()

Returns the timecode of the start of this sample buffer. May return null if the timecode is unknown or has no meaning in this context.

Specified by:

getStartTimecode in interface SampleBuffer

Returns:

The timecode a the start of this buffer.

See Also:

SampleBuffer.getStartTimecode()