SampleBuffer16Bit (OpenIMAJ master project 1.3.10 API)

java.lang.Object
- org.openimaj.audio.samples.SampleBuffer16Bit

All Implemented Interfaces:

Iterable<Float>, Iterator<Float>, SampleBuffer
```
public class SampleBuffer16Bit
extends Object
implements SampleBuffer, Iterator<Float>
```
A SampleBuffer for 16-bit sample chunks.

Author:

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

Created:

23rd November 2011

Constructor Summary

Constructors
Constructor and Description
`SampleBuffer16Bit(AudioFormat af, int nSamples)` Create a new 16-bit sample buffer using the given sample format at the given size.
`SampleBuffer16Bit(SampleChunk samples, AudioFormat af)` Create a new 16-bit sample buffer using the given samples and the given audio format.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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()` Return a sample chunk that contains the data from this sample buffer.
`SampleChunk`	`getSampleChunk(int channel)` Return a sample chunk that contains the data from a specific channel in this sample buffer.
`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()`
`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.
`void`	`setStartTimecode(AudioTimecode timecode)` Set the timecode for this buffer.
`int`	`size()` Returns the size of this buffer.

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
  - SampleBuffer16Bit
```
public SampleBuffer16Bit(SampleChunk samples,
                         AudioFormat af)
```
    Create a new 16-bit sample buffer using the given samples and the given audio format.
    
    Parameters:
    
    samples - The samples to buffer.
    
    af - The audio format.
  - SampleBuffer16Bit
```
public SampleBuffer16Bit(AudioFormat af,
                         int nSamples)
```
    Create a new 16-bit sample buffer using the given sample format at the given size. It does not scale for the number of channels in the audio format, so you must pre-multiply the number of samples by the number of channels if you are only counting samples per channel.
    
    Parameters:
    
    af - The audio format of the samples
    
    nSamples - The number of samples
- Method Detail
  - getSampleChunk
```
public SampleChunk getSampleChunk()
```
    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)
```
    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. Note that because we cannot use native methods for copying parts of an array, we must use Java methods so this will be considerably slower than getSampleChunk().
    
    Specified by:
    
    getSampleChunk in interface SampleBuffer
    
    Parameters:
    
    channel - The channel
    
    Returns:
    
    A SampleChunk containing data in this buffer.
    
    See Also:
    
    SampleBuffer.getSampleChunk(int)
  - 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)
  - 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)
  - 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)
  - 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()
  - iterator
```
public Iterator<Float> iterator()
```
    Specified by:
    
    iterator in interface Iterable<Float>
    
    See Also:
    
    Iterable.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()
```
    Description copied from interface: SampleBuffer
    
    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.
  - setStartTimecode
```
public void setStartTimecode(AudioTimecode timecode)
```
    Set the timecode for this buffer.
    
    Parameters:
    
    timecode - The timecode

Class SampleBuffer16Bit

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.Iterator

Constructor Detail

SampleBuffer16Bit

SampleBuffer16Bit

Method Detail

getSampleChunk

getSampleChunk

get

getUnscaled

set

size

getFormat

setFormat

asDoubleArray

asDoubleChannelArray

asFloatArray

asFloatChannelArray

iterator

hasNext

next

remove

getStartTimecode

setStartTimecode