Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
AudioInputStream
org.xiph.speex.spi.FilteredAudioInputStream
public abstract class FilteredAudioInputStream
extends AudioInputStream
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.
Field Summary | |
static int |
|
protected byte[] |
|
protected int |
|
protected InputStream |
|
protected int |
|
protected int |
|
protected int |
|
protected byte[] |
|
protected int |
|
protected int |
|
private byte[] |
|
Constructor Summary | |
| |
| |
|
Method Summary | |
int |
|
protected void |
|
void |
|
protected void |
|
protected void |
|
void |
|
boolean |
|
int |
|
int |
|
void |
|
long |
|
public static final int DEFAULT_BUFFER_SIZE
The default size of the buffer.
- Field Value:
- 2048
protected byte[] buf
The internal buffer array where the data is stored. When necessary, it may be replaced by another array of a different size.
protected int count
The index one greater than the index of the last valid byte in the buffer. This value is always in the range 0 throughbuf.length
; elementsbuf[0]
throughbuf[count-1]
contain buffered input data obtained and filtered from the underlying inputstream.
protected InputStream in
The underlying inputStream.
protected int marklimit
The maximum read ahead allowed after a call to themark
method before subsequent calls to thereset
method fail. Whenever the difference betweenpos
andmarkpos
exceedsmarklimit
, then the mark may be dropped by settingmarkpos
to -1.
protected int markpos
The value of thepos
field at the time the lastmark
method was called. This value is always in the range -1 throughpos
. If there is no marked position in the inputstream, this field is -1. If there is a marked position in the inputstream, thenbuf[markpos]
is the first byte to be supplied as input after areset
operation. Ifmarkpos
is not -1, then all bytes from positionsbuf[markpos]
throughbuf[pos-1]
must remain in the buffer array (though they may be moved to another place in the buffer array, with suitable adjustments to the values ofcount
,pos
, andmarkpos
); they may not be discarded unless and until the difference betweenpos
andmarkpos
exceedsmarklimit
.
protected int pos
The current position in the buffer. This is the index of the next character to be read from thebuf
array. This value is always in the range 0 throughcount
. If it is less thancount
, thenbuf[pos]
is the next byte to be supplied as input. If it is equal tocount
, then the nextread
orskip
operation will require more bytes to be read and filtered from the underlying inputstream.
- See Also:
buf
protected byte[] prebuf
The internal buffer array where the unfiltered data is temporarily stored.
protected int precount
The index one greater than the index of the last valid byte in the unfiltered data buffer. This value is always in the range 0 throughprebuf.length
; elementsprebuf[0]
throughprebuf[count-1]
contain buffered input data obtained from the underlying input stream.
protected int prepos
The current position in the unfiltered data buffer. This is the index of the next character to be read from theprebuf
array. This value is always in the range 0 throughprecount
. If it is less thanprecount
, thenprebuf[pos]
is the next byte to be supplied as input. If it is equal toprecount
, then the nextread
orskip
operation will require more bytes to be read from the contained inputstream.
- See Also:
prebuf
private final byte[] single
Array of size 1, used by the read method to read just 1 byte.
public FilteredAudioInputStream(InputStream in, AudioFormat format, long length)
Creates aFilteredAudioInputStream
and saves its argument, the input streamin
, for later use. An internal buffer array is created and stored inbuf
.
- 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.
public FilteredAudioInputStream(InputStream in, AudioFormat format, long length, int size)
Creates aFilteredAudioInputStream
with the specified buffer size, and saves its argument, the inputstreamin
for later use. An internal buffer array of lengthsize
is created and stored inbuf
.
- 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.
public FilteredAudioInputStream(InputStream in, AudioFormat format, long length, int size, int presize)
Creates aFilteredAudioInputStream
with the specified buffer size, and saves its argument, the inputstreamin
for later use. An internal buffer array of lengthsize
is created and stored inbuf
.
- 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.
public int available() throws IOException
Returns the number of bytes that can be read from this inputstream without blocking. Theavailable
method ofFilteredAudioInputStream
returns the sum of the the number of bytes remaining to be read in the buffer (count - pos
). The result of calling theavailable
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).
- Returns:
- the number of bytes that can be read from this inputstream without blocking.
- See Also:
in
protected void checkIfStillOpen() throws IOException
Check to make sure that this stream has not been closed
public void close() throws IOException
Closes this input stream and releases any system resources associated with the stream.
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.
protected void makeSpace()
Free up some space in the buffers.
public void mark(int readlimit)
See the general contract of themark
method ofInputStream
.
- Parameters:
readlimit
- the maximum limit of bytes that can be read before the mark position becomes invalid.
- See Also:
reset()
public boolean markSupported()
Tests if this input stream supports themark
andreset
methods. ThemarkSupported
method ofFilteredAudioInputStream
returnstrue
.
- Returns:
- a
boolean
indicating if this stream type supports themark
andreset
methods.
public int read() throws IOException
See the general contract of theread
method ofInputStream
.
- Returns:
- the next byte of data, or
-1
if the end of the stream is reached.
- See Also:
in
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 correspondingmethod of the
read
class. As an additional convenience, it attempts to read as many bytes as possible by repeatedly invoking the
InputStream
read
method of the underlying stream. This iteratedread
continues until one of the following conditions becomes true:If the first
- 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.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.
- 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.
public void reset() throws IOException
See the general contract of thereset
method ofInputStream
. Ifmarkpos
is -1 (no mark has been set or the mark has been invalidated), anIOException
is thrown. Otherwise,pos
is set equal tomarkpos
.
- See Also:
mark(int)
public long skip(long n) throws IOException
See the general contract of theskip
method ofInputStream
.
- Parameters:
n
- the number of bytes to be skipped.
- Returns:
- the actual number of bytes skipped.