Class SegmentedImageInputStream
- java.lang.Object
-
- javax.imageio.stream.ImageInputStreamImpl
-
- com.github.jaiimageio.stream.SegmentedImageInputStream
-
- All Implemented Interfaces:
java.io.Closeable
,java.io.DataInput
,java.lang.AutoCloseable
,javax.imageio.stream.ImageInputStream
public class SegmentedImageInputStream extends javax.imageio.stream.ImageInputStreamImpl
ASegmentedImageInputStream
provides a view of a subset of anotherImageInputStream
consiting of a series of segments with given starting positions in the source stream and lengths. The resulting stream behaves like an ordinaryImageInputStream
.For example, given a
ImageInputStream
containing data in a format consisting of a number of sub-streams stored in non-contiguous sectors indexed by a directory, it is possible to construct a set ofSegmentedImageInputStream
s, one for each sub-stream, that each provide a view of the sectors comprising a particular stream by providing the positions and lengths of the stream's sectors as indicated by the directory. The complex multi-stream structure of the original stream may be ignored by users of theSegmentedImageInputStream
, who see a separateImageInputStream
for each sub-stream and do not need to understand the directory structure at all.For further efficiency, a directory structure such as in the example described above need not be fully parsed in order to build a
SegmentedImageInputStream
. Instead, theStreamSegmentMapper
interface allows the association between a desired region of the output and an input segment to be provided dynamically. This mapping might be computed by reading from a directory in piecemeal fashion in order to avoid consuming memory resources.
-
-
Field Summary
Fields Modifier and Type Field Description private StreamSegmentMapper
mapper
private javax.imageio.stream.ImageInputStream
stream
private StreamSegment
streamSegment
-
Constructor Summary
Constructors Constructor Description SegmentedImageInputStream(javax.imageio.stream.ImageInputStream stream, long[] segmentPositions, int[] segmentLengths)
Constructs aSegmentedImageInputStream
given aImageInputStream
as input and a list of the starting positions and lengths of the segments of the source stream.SegmentedImageInputStream(javax.imageio.stream.ImageInputStream stream, long[] segmentPositions, int segmentLength, int totalLength)
Constructs aSegmentedImageInputStream
given aImageInputStream
as input, a list of the starting positions of the segments of the source stream, the common length of each segment, and the total length of the segments.SegmentedImageInputStream(javax.imageio.stream.ImageInputStream stream, StreamSegmentMapper mapper)
Constructs aSegmentedImageInputStream
given aImageInputStream
as input and an instance ofStreamSegmentMapper
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description long
length()
int
read()
Reads the next byte of data from the input stream.int
read(byte[] b, int off, int len)
Reads up tolen
bytes of data from the input stream into an array of bytes.-
Methods inherited from class javax.imageio.stream.ImageInputStreamImpl
checkClosed, close, finalize, flush, flushBefore, getBitOffset, getByteOrder, getFlushedPosition, getStreamPosition, isCached, isCachedFile, isCachedMemory, mark, read, readBit, readBits, readBoolean, readByte, readBytes, readChar, readDouble, readFloat, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedShort, readUTF, reset, seek, setBitOffset, setByteOrder, skipBytes, skipBytes
-
-
-
-
Field Detail
-
stream
private javax.imageio.stream.ImageInputStream stream
-
mapper
private StreamSegmentMapper mapper
-
streamSegment
private StreamSegment streamSegment
-
-
Constructor Detail
-
SegmentedImageInputStream
public SegmentedImageInputStream(javax.imageio.stream.ImageInputStream stream, StreamSegmentMapper mapper)
Constructs aSegmentedImageInputStream
given aImageInputStream
as input and an instance ofStreamSegmentMapper
.- Parameters:
stream
- A sourceImageInputStream
mapper
- An instance of theStreamSegmentMapper
interface.
-
SegmentedImageInputStream
public SegmentedImageInputStream(javax.imageio.stream.ImageInputStream stream, long[] segmentPositions, int[] segmentLengths)
Constructs aSegmentedImageInputStream
given aImageInputStream
as input and a list of the starting positions and lengths of the segments of the source stream.- Parameters:
stream
- A sourceImageInputStream
segmentPositions
- An array oflong
s giving the starting positions of the segments in the source stream.segmentLengths
- An array ofint
s giving the lengths of segments in the source stream.
-
SegmentedImageInputStream
public SegmentedImageInputStream(javax.imageio.stream.ImageInputStream stream, long[] segmentPositions, int segmentLength, int totalLength)
Constructs aSegmentedImageInputStream
given aImageInputStream
as input, a list of the starting positions of the segments of the source stream, the common length of each segment, and the total length of the segments.This constructor is useful for selecting substreams of sector-oriented file formats in which each segment of the substream (except possibly the final segment) occupies a fixed-length sector.
- Parameters:
stream
- A sourceImageInputStream
segmentPositions
- An array oflong
s giving the starting positions of the segments in the source stream.segmentLength
- The common length of each segment.totalLength
- The total length of the source segments.
-
-
Method Detail
-
read
public int read() throws java.io.IOException
Reads the next byte of data from the input stream. The value byte is returned as anint
in the range0
to255
. If no byte is available because the end of the stream has been reached, the value-1
is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.- Specified by:
read
in interfacejavax.imageio.stream.ImageInputStream
- Specified by:
read
in classjavax.imageio.stream.ImageInputStreamImpl
- Returns:
- the next byte of data, or
-1
if the end of the stream is reached. - Throws:
java.io.IOException
- if an I/O error occurs.
-
read
public int read(byte[] b, int off, int len) throws java.io.IOException
Reads up tolen
bytes of data from the input stream into an array of bytes. An attempt is made to read as many aslen
bytes, but a smaller number may be read, possibly zero. The number of bytes actually read is returned as an integer.This method blocks until input data is available, end of stream is detected, or an exception is thrown.
If
b
isnull
, aNullPointerException
is thrown.If
off
is negative, orlen
is negative, oroff+len
is greater than the length of the arrayb
, then anIndexOutOfBoundsException
is thrown.If
len
is zero, then no bytes are read and0
is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of stream, the value-1
is returned; otherwise, at least one byte is read and stored intob
.The first byte read is stored into element
b[off]
, the next one intob[off+1]
, and so on. The number of bytes read is, at most, equal tolen
. Let k be the number of bytes actually read; these bytes will be stored in elementsb[off]
throughb[off+
k-1]
, leaving elementsb[off+
k]
throughb[off+len-1]
unaffected.In every case, elements
b[0]
throughb[off]
and elementsb[off+len]
throughb[b.length-1]
are unaffected.If the first byte cannot be read for any reason other than end of stream, then an
IOException
is thrown. In particular, anIOException
is thrown if the input stream has been closed.- Specified by:
read
in interfacejavax.imageio.stream.ImageInputStream
- Specified by:
read
in classjavax.imageio.stream.ImageInputStreamImpl
- Parameters:
b
- the buffer into which the data is read.off
- the start offset in arrayb
at which the data is written.len
- the maximum number of bytes to read.- Returns:
- the total number of bytes read into the buffer, or
-1
if there is no more data because the end of the stream has been reached. - Throws:
java.io.IOException
- if an I/O error occurs.
-
length
public long length()
- Specified by:
length
in interfacejavax.imageio.stream.ImageInputStream
- Overrides:
length
in classjavax.imageio.stream.ImageInputStreamImpl
-
-