ddf.minim

Class MultiChannelBuffer

java.lang.Object

ddf.minim.MultiChannelBuffer

public class MultiChannelBuffer
extends java.lang.Object

MultiChannelBuffer represents a chunk of multichannel (or mono) audio data. It is primarily used internally when passing buffers of audio around, but you will need to create one to use things like the loadFileIntoBuffer method of Minim and the setSample method of Sampler. When thinking about a buffer of audio we usually consider how many sample frames long that buffer is. This is not the same as the actual number of values stored in the buffer. Mono, or single channel audio, contains one sample per sample frame, but stereo is two, quadraphonic is four, and so forth. The buffer size of a MultiChannelBuffer is how many sample frames it stores, so when retrieving and setting values it is required to indicate which channel should be operated upon.

Author:

Damien Di Fede

Constructor Summary

Constructors

Constructor and Description
MultiChannelBuffer(int bufferSize, int numChannels) Construct a MultiChannelBuffer, providing a size and number of channels.

Method Summary

Modifier and Type	Method and Description
int	getBufferSize() Returns the length of this buffer in samples.
float[]	getChannel(int channelNumber) Returns the requested channel as a float array.
int	getChannelCount() Returns the number of channels in this buffer.
float	getSample(int channelNumber, float sampleIndex) Returns the interpolated value of a sample in the given channel, at the given offset from the beginning of the buffer, For instance, getSample( 0, 30.5f ) will return an interpolated sample value in channel 0 that is between the value at 30 and the value at 31.
float	getSample(int channelNumber, int sampleIndex) Returns the value of a sample in the given channel, at the given offset from the beginning of the buffer.
void	set(MultiChannelBuffer otherBuffer) Copy the data in the provided MultiChannelBuffer to this MultiChannelBuffer.
void	setBufferSize(int bufferSize) Set the length of this buffer in sample frames.
void	setChannel(int channelNumber, float[] samples) Sets all of the values in a particular channel using the values of the provided float array.
void	setChannelCount(int numChannels) Set the number of channels this buffer contains.
void	setSample(int channelNumber, int sampleIndex, float value) Sets the value of a sample in the given channel at the given offset from the beginning of the buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiChannelBuffer

public MultiChannelBuffer(int bufferSize,
                          int numChannels)

Construct a MultiChannelBuffer, providing a size and number of channels.

Parameters:

bufferSize - int: The length of the buffer in sample frames.

numChannels - int: The number of channels the buffer should contain.

Method Detail

set

public void set(MultiChannelBuffer otherBuffer)

Copy the data in the provided MultiChannelBuffer to this MultiChannelBuffer. Doing so will change both the buffer size and channel count of this MultiChannelBuffer to be the same as the copied buffer.

Parameters:

otherBuffer - the MultiChannelBuffer to copy

getBufferSize

public int getBufferSize()

Returns the length of this buffer in samples.

Returns:

the length of this buffer in samples

getChannelCount

public int getChannelCount()

Returns the number of channels in this buffer.

Returns:

the number of channels in this buffer

getSample

public float getSample(int channelNumber,
                       int sampleIndex)

Returns the value of a sample in the given channel, at the given offset from the beginning of the buffer. When sampleIndex is a float, this returns an interpolated sample value. For instance, getSample( 0, 30.5f ) will return an interpolated sample value in channel 0 that is between the value at 30 and the value at 31.

Parameters:

channelNumber - int: the channel to get the sample value from

sampleIndex - int: the offset from the beginning of the buffer, in samples.

Returns:

float: the value of the sample

getSample

public float getSample(int channelNumber,
                       float sampleIndex)

Returns the interpolated value of a sample in the given channel, at the given offset from the beginning of the buffer, For instance, getSample( 0, 30.5f ) will return an interpolated sample value in channel 0 that is between the value at 30 and the value at 31.

Parameters:

channelNumber - int: the channel to get the sample value from

sampleIndex - float: the offset from the beginning of the buffer, in samples.

Returns:

float: the value of the sample

setSample

public void setSample(int channelNumber,
                      int sampleIndex,
                      float value)

Sets the value of a sample in the given channel at the given offset from the beginning of the buffer.

Parameters:

channelNumber - int: the channel of the buffer

sampleIndex - int: the sample offset from the beginning of the buffer

value - float: the sample value to set

getChannel

public float[] getChannel(int channelNumber)

Returns the requested channel as a float array. You should not necessarily assume that the modifying the returned array will modify the values in this buffer.

Parameters:

channelNumber - int: the channel to return

Returns:

float[]: the channel represented as a float array

setChannel

public void setChannel(int channelNumber,
                       float[] samples)

Sets all of the values in a particular channel using the values of the provided float array. The array should be at least as long as the current buffer size of this buffer and this will only copy as many samples as fit into its current buffer size.

Parameters:

channelNumber - int: the channel to set

samples - float[]: the array of values to copy into the channel

setChannelCount

public void setChannelCount(int numChannels)

Set the number of channels this buffer contains. Doing this will retain any existing channels under the new channel count.

Parameters:

numChannels - int: the number of channels this buffer should contain

setBufferSize

public void setBufferSize(int bufferSize)

Set the length of this buffer in sample frames. Doing this will retain all of the sample data that can fit into the new buffer size.

Parameters:

bufferSize - int: the new length of this buffer in sample frames