com.github.hoary.javaav

Class RingBuffer

java.lang.Object

com.github.hoary.javaav.RingBuffer

public class RingBuffer
extends Object

Constructor Summary

Constructors

Constructor and Description
RingBuffer(int planes) Creates a RingBuffer with a default buffer size of 1024 bytes.
RingBuffer(int capacity, int planes) Creates a RingBuffer with the specified buffer size.

Method Summary

Methods

Modifier and Type	Method and Description
int	available() Return the readable amount of bytes in buffer.
void	clear() Resets the read and write pointers.
int	read(int plane, byte[] data) Read as much data as possible from this buffer.
int	read(int plane, byte[] data, int offset, int length) Read as much data as possible from this buffer.
int	write(int plane, byte[] data) Write as much data as possible to this buffer.
int	write(int plane, byte[] data, int offset, int length) Write as much data as possible to this buffer.
int	write(int plane, ByteBuffer buffer) Write as much data as possible to this buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

RingBuffer

public RingBuffer(int planes)

Creates a RingBuffer with a default buffer size of 1024 bytes.

RingBuffer

public RingBuffer(int capacity,
          int planes)

Creates a RingBuffer with the specified buffer size.

Parameters:

capacity - buffer size in bytes

Method Detail

clear

public void clear()

Resets the read and write pointers. The internal buffer remains unaffected.

available

public int available()

Return the readable amount of bytes in buffer. Note: It is not necessarily valid when data is written to the buffer or read from the buffer. Another thread might have filled the buffer or emptied it in the mean time.

Returns:

currently available bytes to read

write

public int write(int plane,
        ByteBuffer buffer)

Write as much data as possible to this buffer.

Parameters:

plane - the audio channel.

buffer - data to be written.

Returns:

amount of data actually written

write

public int write(int plane,
        byte[] data)

Write as much data as possible to this buffer.

Parameters:

plane - the audio channel.

data - data to be written.

Returns:

amount of data actually written

write

public int write(int plane,
        byte[] data,
        int offset,
        int length)

Write as much data as possible to this buffer.

Parameters:

plane - the audio channel.

data - array holding data to be written

offset - offset of data in array

length - amount of data to write, starting from off.

Returns:

amount of data actually written

read

public int read(int plane,
       byte[] data)
         throws IOException

Read as much data as possible from this buffer.

Parameters:

plane - the audio channel.

data - where to store the data.

Returns:

number of bytes read.

Throws:

IOException - if data array could not be filled.

read

public int read(int plane,
       byte[] data,
       int offset,
       int length)
         throws IOException

Read as much data as possible from this buffer.

Parameters:

plane - the audio channel.

data - where to store the read data.

offset - offset of data in array.

length - amount of data to read.

Returns:

Amount of data read.

Throws:

IOException