org.kc7bfi.jflac.sound.spi
Class RingedAudioInputStream

java.lang.Object
  java.io.InputStream
      javax.sound.sampled.AudioInputStream
          org.kc7bfi.jflac.sound.spi.RingedAudioInputStream

All Implemented Interfaces:

Closeable

Direct Known Subclasses:

Flac2PcmAudioInputStream

public abstract class RingedAudioInputStream
extends AudioInputStream

A FilteredAudioInputStream is an AudioInputStream with buffers to facilitate transcoding the audio. A first byte array can buffer the data from the underlying inputstream until sufficient data for transcoding is present. A second byte array can hold the transcoded audio data, ready to be read out by the stream user.

Version:

$Revision: 1.5 $

Author:

Marc Gimpel, Wimba S.A. (marc@wimba.com), Florian Bomers

Field Summary

protected RingBuffer	buffer The current position in the unfiltered data buffer.
static int	DEFAULT_BUFFER_SIZE The default size of the buffer.
protected InputStream	in The underlying inputStream.

Fields inherited from class javax.sound.sampled.AudioInputStream

format, frameLength, framePos, frameSize

Constructor Summary

RingedAudioInputStream(InputStream in, AudioFormat format, long length)
Creates a RingedAudioInputStream and saves its argument, the input stream in, for later use.

RingedAudioInputStream(InputStream in, AudioFormat format, long length, int size)
Creates a RingedAudioInputStream with the specified buffer size, and saves its argument, the inputstream in for later use.

RingedAudioInputStream(InputStream in, AudioFormat format, long length, int size, int presize)
Creates a RingedAudioInputStream with the specified buffer size, and saves its argument, the inputstream in for later use.

Method Summary

int	available() Returns the number of bytes that can be read from this inputstream without blocking.
void	close() Closes this input stream and releases any system resources associated with the stream.
protected void	fill() Fills the buffer with more data, taking into account shuffling and other tricks for dealing with marks.
void	mark(int readlimit) See the general contract of the mark method of InputStream.
boolean	markSupported() Tests if this input stream supports the mark and reset methods.
int	read() See the general contract of the read method of InputStream.
int	read(byte[] b, int off, int len) Reads bytes from this byte-input stream into the specified byte array, starting at the given offset.
void	reset() See the general contract of the reset method of InputStream.
long	skip(long n) See the general contract of the skip method of InputStream.

Methods inherited from class javax.sound.sampled.AudioInputStream

getFormat, getFrameLength, read

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

The default size of the buffer.

See Also:

Constant Field Values

in

protected InputStream in

The underlying inputStream.

buffer

protected RingBuffer buffer

The current position in the unfiltered data buffer. This is the index of the next character to be read from the prebuf array.

This value is always in the range 0 through precount. If it is less than precount, then prebuf[pos] is the next byte to be supplied as input. If it is equal to precount, then the next read or skip operation will require more bytes to be read from the contained inputstream.

See Also:

#prebuf

Constructor Detail

RingedAudioInputStream

public RingedAudioInputStream(InputStream in,
                              AudioFormat format,
                              long length)

Creates a RingedAudioInputStream and saves its argument, the input stream in, for later use. An internal buffer array is created and stored in buf.

Parameters:

in - the underlying input stream.

format - the format of this stream's audio data.

length - the length in sample frames of the data in this stream.

RingedAudioInputStream

public RingedAudioInputStream(InputStream in,
                              AudioFormat format,
                              long length,
                              int size)

Creates a RingedAudioInputStream with the specified buffer size, and saves its argument, the inputstream in for later use. An internal buffer array of length size is created and stored in buf.

Parameters:

in - the underlying input stream.

format - the format of this stream's audio data.

length - the length in sample frames of the data in this stream.

size - the buffer sizes.

RingedAudioInputStream

public RingedAudioInputStream(InputStream in,
                              AudioFormat format,
                              long length,
                              int size,
                              int presize)

Creates a RingedAudioInputStream with the specified buffer size, and saves its argument, the inputstream in for later use. An internal buffer array of length size is created and stored in buf.

Parameters:

in - the underlying input stream.

format - the format of this stream's audio data.

length - the length in sample frames of the data in this stream.

size - the buffer size.

presize - the prebuffer size.

Method Detail

fill

protected void fill()
             throws IOException

Fills the buffer with more data, taking into account shuffling and other tricks for dealing with marks. Assumes that it is being called by a synchronized method. This method also assumes that all data has already been read in, hence pos > count.

Throws:

IOException

read

public int read()
         throws IOException

See the general contract of the read method of InputStream.

Overrides:

read in class AudioInputStream

Returns:

the next byte of data, or -1 if the end of the stream is reached.

Throws:

IOException - if an I/O error occurs.

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Reads bytes from this byte-input stream into the specified byte array, starting at the given offset.

This method implements the general contract of the corresponding read method of the InputStream class. As an additional convenience, it attempts to read as many bytes as possible by repeatedly invoking the read method of the underlying stream. This iterated read continues until one of the following conditions becomes true:

• The specified number of bytes have been read,
• The read method of the underlying stream returns -1, indicating end-of-file, or
• The available method of the underlying stream returns zero, indicating that further input requests would block.

If the first read on the underlying stream returns -1 to indicate end-of-file then this method returns -1. Otherwise this method returns the number of bytes actually read.

Subclasses of this class are encouraged, but not required, to attempt to read as many bytes as possible in the same fashion.

Overrides:

read in class AudioInputStream

Parameters:

b - destination buffer.

off - offset at which to start storing bytes.

len - maximum number of bytes to read.

Returns:

the number of bytes read, or -1 if the end of the stream has been reached.

Throws:

IOException - if an I/O error occurs.

skip

public long skip(long n)
          throws IOException

See the general contract of the skip method of InputStream.

Overrides:

skip in class AudioInputStream

Parameters:

n - the number of bytes to be skipped.

Returns:

the actual number of bytes skipped.

Throws:

IOException - if an I/O error occurs.

available

public int available()
              throws IOException

Returns the number of bytes that can be read from this inputstream without blocking.

The available method of FilteredAudioInputStream returns the sum of the the number of bytes remaining to be read in the buffer (count - pos). The result of calling the available method of the underlying inputstream is not used, as this data will have to be filtered, and thus may not be the same size after processing (although subclasses that do the filtering should override this method and use the amount of data available in the underlying inputstream).

Overrides:

available in class AudioInputStream

Returns:

the number of bytes that can be read from this inputstream without blocking.

Throws:

IOException - if an I/O error occurs.

mark

public void mark(int readlimit)

See the general contract of the mark method of InputStream.

Overrides:

mark in class AudioInputStream

Parameters:

readlimit - the maximum limit of bytes that can be read before the mark position becomes invalid.

See Also:

reset()

reset

public void reset()
           throws IOException

See the general contract of the reset method of InputStream.

If markpos is -1 (no mark has been set or the mark has been invalidated), an IOException is thrown. Otherwise, pos is set equal to markpos.

Overrides:

reset in class AudioInputStream

Throws:

IOException - if this stream has not been marked or if the mark has been invalidated.

See Also:

mark(int)

markSupported

public boolean markSupported()

Tests if this input stream supports the mark and reset methods. The markSupported method of FilteredAudioInputStream returns true.

Overrides:

markSupported in class AudioInputStream

Returns:

a boolean indicating if this stream type supports the mark and reset methods.

See Also:

mark(int), reset()

close

public void close()
           throws IOException

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

Specified by:

close in interface Closeable

Overrides:

close in class AudioInputStream

Throws:

IOException - if an I/O error occurs.