com.tagtraum.jipes.audio

Interface AudioBuffer

All Known Subinterfaces:

AudioMatrix, AudioSpectrum

All Known Implementing Classes:

AbstractAudioSpectrum, ComplexAudioBuffer, InstantaneousFrequencySpectrum, LinearFrequencySpectrum, LogFrequencySpectrum, MelSpectrum, MultiBandSpectrum, RealAudioBuffer, RealAudioMatrix

public interface AudioBuffer

Read-only buffer that holds (audio) data and some meta information in the form of an AudioFormat instance. The data might be in the form of complex numbers and/or magnitudes.

Note that even though you could, you must never change any of the float arrays contained in this buffer. If you need to change one, copy/clone it first. This contract is not enforced programmatically, but relies on the user adhering to it.

Author:

Hendrik Schreiber

See Also:

SignalPullProcessor, SignalProcessor

Method Summary

Modifier and Type	Method and Description
Object	clone() Creates an exact copy of this buffer.
AudioBuffer	derive(float[] real, float[] imaginary) Creates a copy of this buffer, but replaces its values with the given real and imaginary data.
AudioFormat	getAudioFormat() Describes the audio data contained in this buffer.
float[]	getData() Returns a real representation of the data held by this buffer.
int	getFrameNumber() Number of the first frame at the beginning of this buffer.
float[]	getImaginaryData() Imaginary part of the data contained in this buffer.
float[]	getMagnitudes() Magnitudes (square root of the powers).
int	getNumberOfSamples() Returns the number of samples this buffer was built from.
float[]	getPowers() Powers (sum of the squares of the real and imaginary part).
float[]	getRealData() Real part of the data contained in this buffer.
long	getTimestamp() Time from the beginning of the track to the beginning of this buffer in ms.
long	getTimestamp(TimeUnit timeUnit) Time from the beginning of the track to the beginning of this buffer in the requested unit.

Method Detail

getTimestamp

long getTimestamp()

Time from the beginning of the track to the beginning of this buffer in ms. For more accurate timestamps, use getTimestamp(java.util.concurrent.TimeUnit) with a finer unit.

If we didn't start reading at the beginning of the file (i.e. timestamp == 0), the offset may not be 100% precise.

Returns:

time in ms or -1, if it cannot be determined

See Also:

getFrameNumber(), getTimestamp(java.util.concurrent.TimeUnit)

getTimestamp

long getTimestamp(TimeUnit timeUnit)

Time from the beginning of the track to the beginning of this buffer in the requested unit. If we didn't start reading at the beginning of the file (i.e. timestamp == 0), the offset may not be 100% precise.

Parameters:

timeUnit - time unit

Returns:

time in the given unit or -1, if it cannot be determined

See Also:

getTimestamp()

getFrameNumber

int getFrameNumber()

Number of the first frame at the beginning of this buffer. In this context a frame consists of one or more samples, depending on the number of channels. E.g. one stereo frame contains two samples.

Just like getTimestamp(), this method may not be the most accurate, if you didn't start reading at the beginning of the file.

Returns:

frame number

See Also:

getTimestamp(), AudioFormat

getAudioFormat

AudioFormat getAudioFormat()

Describes the audio data contained in this buffer.

Returns:

audio format

getData

float[] getData()

Returns a real representation of the data held by this buffer. Note that this is not necessarily the same as samples. In fact this could be anything, e.g. magnitudes. More info might be found in getAudioFormat().

This array is meant for reading only. Do not manipulate it!

Returns:

audio data

See Also:

AbstractAudioSpectrum.getData()

getRealData

float[] getRealData()

Real part of the data contained in this buffer. If the imaginary part is always zero, this returns the same as getData()

This array is meant for reading only. Do not manipulate it!

Returns:

real part

getImaginaryData

float[] getImaginaryData()

Imaginary part of the data contained in this buffer.

This array is meant for reading only. Do not manipulate it!

Returns:

imaginary part

getPowers

float[] getPowers()

Powers (sum of the squares of the real and imaginary part).

This array is meant for reading only. Do not manipulate it!

Returns:

array

See Also:

getMagnitudes()

getMagnitudes

float[] getMagnitudes()

Magnitudes (square root of the powers).

This array is meant for reading only. Do not manipulate it!

Returns:

array

See Also:

getPowers()

getNumberOfSamples

int getNumberOfSamples()

Returns the number of samples this buffer was built from.

Returns:

number of samples

derive

AudioBuffer derive(float[] real,
                   float[] imaginary)

Creates a copy of this buffer, but replaces its values with the given real and imaginary data. The original buffer remains unchanged.

Parameters:

real - real data

imaginary - imaginary data

Returns:

derived copy

clone

Object clone()
      throws CloneNotSupportedException

Creates an exact copy of this buffer. All AudioBuffers must be cloneable.

Returns:

clone

Throws:

CloneNotSupportedException