com.smartdevicelink.managers.audio

Class SampleBuffer

java.lang.Object

com.smartdevicelink.managers.audio.SampleBuffer

public class SampleBuffer
extends Object

Wraps a buffer of raw audio samples depending on the sample type (8 bit, 16 bit) Unifies samples into double.

Method Summary

Modifier and Type	Method and Description
static SampleBuffer	allocate(int capacity, int sampleType, ByteOrder byteOrder, long presentationTimeUs) Allocates a new sample buffer.
static SampleBuffer	allocate(int capacity, int sampleType, int channelCount, ByteOrder byteOrder, long presentationTimeUs) Allocates a new sample buffer.
int	capacity() Returns the capacity of the buffer per channel.
double	get() Returns the sample of the current position and then increments the position.
double	get(int index) Returns the sample from the given index in the buffer.
ByteBuffer	getByteBuffer() Returns the raw byte buffer managed by this sample buffer.
byte[]	getBytes() Returns a copy of the bytes from position 0 to the current limit.
long	getPresentationTimeUs() The presentation time of this sample buffer.
int	limit() Returns the number of samples in the buffer per channel.
void	limit(int newLimit) Sets the number of samples in the buffer to the new limit.
int	position() Returns the current position in the buffer per channel.
void	position(int newPosition) Sets the position of the sample buffer to the new index.
void	put(double sample) Puts a sample to the current position and increments the position.
void	put(int index, double sample) Puts a sample to the given index in the buffer.
static SampleBuffer	wrap(ByteBuffer buffer, int sampleType, int channelCount, long presentationTimeUs) Wraps a raw byte buffer to a new sample buffer.
static SampleBuffer	wrap(ByteBuffer buffer, int sampleType, long presentationTimeUs) Wraps a raw (mono) byte buffer to a new sample buffer.

Methods inherited from class java.lang.Object

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

Method Detail

wrap

public static SampleBuffer wrap(ByteBuffer buffer,
                                int sampleType,
                                long presentationTimeUs)

Wraps a raw (mono) byte buffer to a new sample buffer.

Parameters:

buffer - The raw buffer to be wrapped.

sampleType - The sample type of the samples in the raw buffer.

presentationTimeUs - The presentation time of the buffer.

Returns:

A new sample buffer wrapping the specified raw buffer.

wrap

public static SampleBuffer wrap(ByteBuffer buffer,
                                int sampleType,
                                int channelCount,
                                long presentationTimeUs)

Wraps a raw byte buffer to a new sample buffer.

Parameters:

buffer - The raw buffer to be wrapped.

sampleType - The sample type of the samples in the raw buffer.

channelCount - The number of channels (1 = mono, 2 = stereo).

presentationTimeUs - The presentation time of the buffer.

Returns:

A new sample buffer wrapping the specified raw buffer.

allocate

public static SampleBuffer allocate(int capacity,
                                    int sampleType,
                                    ByteOrder byteOrder,
                                    long presentationTimeUs)

Allocates a new sample buffer.

Parameters:

capacity - The specified sample capacity of the sample buffer.

sampleType - The sample type of the samples the buffer should store.

byteOrder - The byte order for the samples (little or big endian).

presentationTimeUs - The presentation time for the buffer.

Returns:

A new and empty sample buffer.

allocate

public static SampleBuffer allocate(int capacity,
                                    int sampleType,
                                    int channelCount,
                                    ByteOrder byteOrder,
                                    long presentationTimeUs)

Allocates a new sample buffer.

Parameters:

capacity - The specified sample capacity of the sample buffer.

sampleType - The sample type of the samples the buffer should store.

channelCount - The number of channels (1 = mono, 2 = stereo).

byteOrder - The byte order for the samples (little or big endian).

presentationTimeUs - The presentation time for the buffer.

Returns:

A new and empty sample buffer.

capacity

public int capacity()

Returns the capacity of the buffer per channel.

limit

public int limit()

Returns the number of samples in the buffer per channel.

limit

public void limit(int newLimit)

Sets the number of samples in the buffer to the new limit.

Parameters:

newLimit - The new limit of the sample buffer.

position

public int position()

Returns the current position in the buffer per channel.

Returns:

The position of the sample buffer.

position

public void position(int newPosition)

Sets the position of the sample buffer to the new index.

Parameters:

newPosition - The new position of the sample buffer.

get

public double get()

Returns the sample of the current position and then increments the position. The sample returned is a mixed sample getting all samples from each channel.

Returns:

The mixed sample.

get

public double get(int index)

Returns the sample from the given index in the buffer. If the buffer's channel count is > 1 the sample returned is a mixed sample getting all samples from each channel.

Parameters:

index - The index of the sample requested.

Returns:

The sample requested.

put

public void put(double sample)

Puts a sample to the current position and increments the position.

Parameters:

sample - The sample to put into the buffer.

put

public void put(int index,
                double sample)

Puts a sample to the given index in the buffer. If the buffer's channel count is > 1 the sample will be stored in each channel at the given index.

Parameters:

index - The index to put the sample.

sample - The sample to store in the buffer.

getByteBuffer

public ByteBuffer getByteBuffer()

Returns the raw byte buffer managed by this sample buffer.

Returns:

The raw byte buffer managed by this sample buffer.

getBytes

public byte[] getBytes()

Returns a copy of the bytes from position 0 to the current limit.

Returns:

A copy of the bytes.

getPresentationTimeUs

public long getPresentationTimeUs()

The presentation time of this sample buffer.

Returns:

The presentation time of this sample buffer.