org.zoolu.sound

Class BufferedAudioInputStream

java.lang.Object

java.io.InputStream

javax.sound.sampled.AudioInputStream

org.zoolu.sound.BufferedAudioInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public abstract class BufferedAudioInputStream
extends javax.sound.sampled.AudioInputStream

Abstract buffered AudioInputStream. Allows the standard reading from an AudioInputStream that actually requires (or prefers) buffered reading access.

A class that extends BufferedAudioInputStream must implements the abstract methods innerRead(byte[]) and innerAvailable().

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG Debug mode
protected java.io.InputStream	input_stream Input stream

Fields inherited from class javax.sound.sampled.AudioInputStream

format, frameLength, framePos, frameSize

Constructor Summary

Constructors

Constructor and Description
BufferedAudioInputStream(javax.sound.sampled.AudioInputStream input_stream, javax.sound.sampled.AudioFormat source_format, int buffer_size) Creates a new BufferedAudioInputStream.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close() Closes this input stream and releases any system resources associated with the stream.
protected abstract int	innerAvailable() Gets the number of bytes that are currently available in the inner input stream for reading.
protected abstract int	innerRead(byte[] buffer) Reads a block of bytes from the inner input stream.
void	mark(int readlimit) Marks the current position in this input stream.
boolean	markSupported() Tests if this input stream supports the mark and reset methods.
protected void	printOut(java.lang.String str) Prints debugging information.
int	read() Reads the next byte of data from the input stream.
int	read(byte[] buf) Reads some number of bytes from the input stream and stores them into the buffer array b.
int	read(byte[] buf, int off, int len) Reads up to len bytes of data from the input stream into an array of bytes.
void	reset() Repositions this stream to the position at the time the mark method was last called on this input stream.
long	skip(long n) Skips over and discards n bytes of data from this input stream.

Methods inherited from class javax.sound.sampled.AudioInputStream

getFormat, getFrameLength

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static boolean DEBUG

Debug mode

input_stream

protected java.io.InputStream input_stream

Input stream

Constructor Detail

BufferedAudioInputStream

public BufferedAudioInputStream(javax.sound.sampled.AudioInputStream input_stream,
                                javax.sound.sampled.AudioFormat source_format,
                                int buffer_size)

Creates a new BufferedAudioInputStream.

Method Detail

innerRead

protected abstract int innerRead(byte[] buffer)

Reads a block of bytes from the inner input stream.

Parameters:

buffer - the buffer where the the bytes are read to

Returns:

the number of bytes that have been read

innerAvailable

protected abstract int innerAvailable()
                               throws java.io.IOException

Gets the number of bytes that are currently available in the inner input stream for reading.

Returns:

the number of bytes that can be still read from the inner input stream

Throws:

java.io.IOException

available

public int available()
              throws java.io.IOException

Overrides:

available in class javax.sound.sampled.AudioInputStream

Returns:

the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream.

Throws:

java.io.IOException

read

public int read()

Reads the next byte of data from the input stream.

Overrides:

read in class javax.sound.sampled.AudioInputStream

Returns:

the next byte, or -1 if no byte is read

read

public int read(byte[] buf)
         throws java.io.IOException

Reads some number of bytes from the input stream and stores them into the buffer array b.

Overrides:

read in class javax.sound.sampled.AudioInputStream

Parameters:

buf - the buffer where the the bytes are read to

Returns:

the number of bytes that have been read

Throws:

java.io.IOException

read

public int read(byte[] buf,
                int off,
                int len)
         throws java.io.IOException

Reads up to len bytes of data from the input stream into an array of bytes.

Overrides:

read in class javax.sound.sampled.AudioInputStream

Parameters:

buf - the buffer where the the bytes are read to

off - the offset within the buffer

len - the availble size within the buffer (from the offset)

Returns:

the number of bytes that have been read

Throws:

java.io.IOException

skip

public long skip(long n)

Skips over and discards n bytes of data from this input stream.

Overrides:

skip in class javax.sound.sampled.AudioInputStream

Parameters:

n - the number of bytes to be skipped

close

public void close()
           throws java.io.IOException

Closes this input stream and releases any system resources associated with the stream.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class javax.sound.sampled.AudioInputStream

Throws:

java.io.IOException

markSupported

public boolean markSupported()

Tests if this input stream supports the mark and reset methods.

Overrides:

markSupported in class javax.sound.sampled.AudioInputStream

Returns:

true if this input stream supports the mark and reset methods (false if not)

mark

public void mark(int readlimit)

Marks the current position in this input stream.

Overrides:

mark in class javax.sound.sampled.AudioInputStream

reset

public void reset()

Repositions this stream to the position at the time the mark method was last called on this input stream.

Overrides:

reset in class javax.sound.sampled.AudioInputStream

printOut

protected void printOut(java.lang.String str)

Prints debugging information.