 |
Om
1.0.0
A universal framework for multimedia simulation
|
A class that decodes a read-only stream of compressed data. More...
#include <omCompressedInputStream.h>
Public Member Functions | |
| CompressedInputStream (DataInputStream *newInputStream) | |
| Create a new compressed input stream that uses the specified data input stream as its destination. More... | |
| ~CompressedInputStream () | |
| Destroy an input stream and free all of its resources (close it). More... | |
| Bool | start () |
| Start uncompressing input data. More... | |
| Bool | stop () |
| Stop uncompressing input data and finish the compression stream. More... | |
| virtual Size | readData (UByte *data, Size number) |
| Read the specified number of bytes of data from the buffer to the stream. More... | |
| virtual Bool | canSeek () const |
| Return whether or not this type of stream allows seeking. More... | |
| virtual Bool | canSeek (Int64 relativeOffset) const |
| Return whether or not this stream can seek by the specified amount in bytes. More... | |
| virtual Int64 | seek (Int64 relativeOffset) |
| Move the current position in the stream by the specified relative signed offset in bytes. More... | |
| virtual LargeSize | getBytesRemaining () const |
| Return the number of bytes remaining in the stream. More... | |
| virtual LargeIndex | getPosition () const |
| Return the absolute position in bytes in the uncompressed stream of data. More... | |
| LargeIndex | getCompressedPosition () const |
| Return the current position in the compressed input data stream. More... | |
 Public Member Functions inherited from om::io::DataInputStream | |
| virtual | ~DataInputStream () |
| Destroy an input stream and free all of it's resources (close it). More... | |
| Size | readData (data::DataBuffer &buffer, Size numBytes) |
| Read the specified number of bytes from the stream and place them in the specified data buffer. More... | |
| data::Data | readAllData () |
| Read as many bytes from the stream as possible and return them in a Data object. More... | |
| Size | readAllData (data::DataBuffer &buffer) |
| Read as many bytes from the stream as possible and place them in the specified data buffer. More... | |
| Bool | hasBytesRemaining () const |
| Return whether or not there are bytes remaining in the stream. More... | |
A class that decodes a read-only stream of compressed data.
| om::compression::CompressedInputStream::CompressedInputStream | ( | DataInputStream * | newInputStream | ) |
Create a new compressed input stream that uses the specified data input stream as its destination.
The default compression settings are used.
| om::compression::CompressedInputStream::~CompressedInputStream | ( | ) |
Destroy an input stream and free all of its resources (close it).
| Bool om::compression::CompressedInputStream::start | ( | ) |
Start uncompressing input data.
| Bool om::compression::CompressedInputStream::stop | ( | ) |
Stop uncompressing input data and finish the compression stream.
Read the specified number of bytes of data from the buffer to the stream.
Implements om::io::DataInputStream.
|
virtual |
Return whether or not this type of stream allows seeking.
Implements om::io::DataInputStream.
Return whether or not this stream can seek by the specified amount in bytes.
Only forward (positive) seeking is supported when the stream is reading compressed data.
Implements om::io::DataInputStream.
Move the current position in the stream by the specified relative signed offset in bytes.
Only forward (positive) seeking is supported when the stream is reading compressed data.
Implements om::io::DataInputStream.
|
virtual |
Return the number of bytes remaining in the stream.
The value returned must only be a lower bound on the number of bytes remaining in the stream. If there are bytes remaining, it must return at least 1.
Implements om::io::DataInputStream.
|
virtual |
Return the absolute position in bytes in the uncompressed stream of data.
Implements om::io::DataInputStream.
| LargeIndex om::compression::CompressedInputStream::getCompressedPosition | ( | ) | const |
Return the current position in the compressed input data stream.
1.8.11
