ComplexAudioBuffer (Jipes 0.9.17 API)

java.lang.Object
- com.tagtraum.jipes.audio.ComplexAudioBuffer

All Implemented Interfaces:

AudioBuffer, Cloneable
```
public class ComplexAudioBuffer
extends Object
implements AudioBuffer, Cloneable
```
Buffer that holds complex, time domain audio data and some meta information in the form of an AudioFormat instance.

Author:

Hendrik Schreiber

See Also:

SignalPullProcessor, SignalProcessor, RealAudioBuffer

Constructor Summary

Constructors
Constructor and Description
`ComplexAudioBuffer(ComplexAudioBuffer buffer)` Copy constructor that creates a deep copy of the data, but a shallow (reference) copy of the format.
`ComplexAudioBuffer(int frameNumber, float[] realData, float[] imaginaryData, AudioFormat audioFormat)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()` Creates an exact copy of this buffer.
`protected float[]`	`computeMagnitudes(int length, float[] powers)`
`protected float[]`	`computePowers(int length)`
`ComplexAudioBuffer`	`derive(float[] real, float[] imaginary)` Creates a copy of this buffer, but replaces its values with the given real and imaginary data.
`boolean`	`equals(Object o)`
`AudioFormat`	`getAudioFormat()` Describes the audio data contained in this buffer.
`float[]`	`getData()` This is the same as `getMagnitudes()`.
`int`	`getFrameNumber()` Number of the first frame at the beginning of this buffer.
`float[]`	`getImaginaryData()` Imaginary part of this buffer's data.
`float[]`	`getMagnitudes()` Magnitudes for this buffer - since this is a real-only buffer, this is equivalent to `abs(getRealData())`.
`int`	`getNumberOfSamples()` Returns the number of samples this buffer was built from.
`float[]`	`getPowers()` Powers for this buffer - since this a real-only buffer, this is equivalent to `square(getRealData())`.
`float[]`	`getRealData()` Real part of this buffer's data.
`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.
`int`	`hashCode()`
`void`	`reuse(int frameNumber, float[] realData, float[] imaginaryData, AudioFormat audioFormat)` Refills this buffer with new data.
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ComplexAudioBuffer
```
public ComplexAudioBuffer(int frameNumber,
                          float[] realData,
                          float[] imaginaryData,
                          AudioFormat audioFormat)
```
  - ComplexAudioBuffer
```
public ComplexAudioBuffer(ComplexAudioBuffer buffer)
```
    Copy constructor that creates a deep copy of the data, but a shallow (reference) copy of the format.
    
    Parameters:
    
    buffer - buffer to copy
- Method Detail
  - reuse
```
public void reuse(int frameNumber,
                  float[] realData,
                  float[] imaginaryData,
                  AudioFormat audioFormat)
```
    Refills this buffer with new data. This allows some object reuse. Use with care!
    
    Parameters:
    
    frameNumber - frameNumber
    
    realData - realData
    
    imaginaryData - imaginaryData
    
    audioFormat - audioFormat
  - getTimestamp
```
public long getTimestamp()
```
    Description copied from interface: AudioBuffer
    
    Time from the beginning of the track to the beginning of this buffer in ms. For more accurate timestamps, use AudioBuffer.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.
    
    Specified by:
    
    getTimestamp in interface AudioBuffer
    
    Returns:
    
    time in ms or -1, if it cannot be determined
    
    See Also:
    
    AudioBuffer.getFrameNumber(), AudioBuffer.getTimestamp(java.util.concurrent.TimeUnit)
  - getTimestamp
```
public long getTimestamp(TimeUnit timeUnit)
```
    Description copied from interface: AudioBuffer
    
    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.
    
    Specified by:
    
    getTimestamp in interface AudioBuffer
    
    Parameters:
    
    timeUnit - time unit
    
    Returns:
    
    time in the given unit or -1, if it cannot be determined
    
    See Also:
    
    AudioBuffer.getTimestamp()
  - getFrameNumber
```
public int getFrameNumber()
```
    Description copied from interface: AudioBuffer
    
    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 AudioBuffer.getTimestamp(), this method may not be the most accurate, if you didn't start reading at the beginning of the file.
    
    Specified by:
    
    getFrameNumber in interface AudioBuffer
    
    Returns:
    
    frame number
    
    See Also:
    
    AudioBuffer.getTimestamp(), AudioFormat
  - getAudioFormat
```
public AudioFormat getAudioFormat()
```
    Description copied from interface: AudioBuffer
    
    Describes the audio data contained in this buffer.
    
    Specified by:
    
    getAudioFormat in interface AudioBuffer
    
    Returns:
    
    audio format
  - getData
```
public float[] getData()
```
    This is the same as getMagnitudes().
    
    Specified by:
    
    getData in interface AudioBuffer
    
    Returns:
    
    magnitudes
    
    See Also:
    
    AbstractAudioSpectrum.getData()
  - getRealData
```
public float[] getRealData()
```
    Real part of this buffer's data. Typically, time domain, real-only data.
    
    Specified by:
    
    getRealData in interface AudioBuffer
    
    Returns:
    
    real part
  - getImaginaryData
```
public float[] getImaginaryData()
```
    Imaginary part of this buffer's data.
    
    Specified by:
    
    getImaginaryData in interface AudioBuffer
    
    Returns:
    
    imaginary part
  - getPowers
```
public float[] getPowers()
```
    Powers for this buffer - since this a real-only buffer, this is equivalent to square(getRealData()).
    
    Specified by:
    
    getPowers in interface AudioBuffer
    
    Returns:
    
    squares of all real values
    
    See Also:
    
    AudioBuffer.getMagnitudes()
  - getMagnitudes
```
public float[] getMagnitudes()
```
    Magnitudes for this buffer - since this is a real-only buffer, this is equivalent to abs(getRealData()).
    
    Specified by:
    
    getMagnitudes in interface AudioBuffer
    
    Returns:
    
    absolute data values
    
    See Also:
    
    AudioBuffer.getPowers()
  - getNumberOfSamples
```
public int getNumberOfSamples()
```
    Description copied from interface: AudioBuffer
    
    Returns the number of samples this buffer was built from.
    
    Specified by:
    
    getNumberOfSamples in interface AudioBuffer
    
    Returns:
    
    number of samples
  - computePowers
```
protected float[] computePowers(int length)
```
  - computeMagnitudes
```
protected float[] computeMagnitudes(int length,
                                    float[] powers)
```
  - derive
```
public ComplexAudioBuffer derive(float[] real,
                                 float[] imaginary)
```
    Description copied from interface: AudioBuffer
    
    Creates a copy of this buffer, but replaces its values with the given real and imaginary data. The original buffer remains unchanged.
    
    Specified by:
    
    derive in interface AudioBuffer
    
    Parameters:
    
    real - real data
    
    imaginary - imaginary data
    
    Returns:
    
    derived copy
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Description copied from interface: AudioBuffer
    
    Creates an exact copy of this buffer. All AudioBuffers must be cloneable.
    
    Specified by:
    
    clone in interface AudioBuffer
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    clone
    
    Throws:
    
    CloneNotSupportedException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ComplexAudioBuffer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ComplexAudioBuffer

ComplexAudioBuffer

Method Detail

reuse

getTimestamp

getTimestamp

getFrameNumber

getAudioFormat

getData

getRealData

getImaginaryData

getPowers

getMagnitudes

getNumberOfSamples

computePowers

computeMagnitudes

derive

equals

hashCode

clone

toString