Titanic::y222 Class Reference

#include <avi_surface.h>

Inheritance diagram for Titanic::y222:

Public Member Functions
uint32	read (void *dataPtr, uint32 dataSize) override
bool	eos () const override
int64	pos () const override
int64	size () const override
bool	seek (int64 offset, int whence=SEEK_SET) override
bool	skip (uint32 offset) override
char *	readLine (char *s, size_t bufSize, bool handleCR=true) override
Common::String	readLine (bool handleCR=true) override
Public Member Functions inherited from Common::SeekableReadStream
void	hexdump (int len, int bytesPerLine=16, int startOffset=0)
Public Member Functions inherited from Common::ReadStream
byte	readByte ()
FORCEINLINE int8	readSByte ()
uint16	readUint16LE ()
uint32	readUint32LE ()
uint64	readUint64LE ()
uint16	readUint16BE ()
uint32	readUint32BE ()
uint64	readUint64BE ()
FORCEINLINE int16	readSint16LE ()
FORCEINLINE int32	readSint32LE ()
FORCEINLINE int64	readSint64LE ()
FORCEINLINE int16	readSint16BE ()
FORCEINLINE int32	readSint32BE ()
FORCEINLINE int64	readSint64BE ()
FORCEINLINE float	readFloatLE ()
FORCEINLINE float	readFloatBE ()
FORCEINLINE double	readDoubleLE ()
FORCEINLINE double	readDoubleBE ()
template<class TDataFormat , class... T>
bool	readMultiple (const TDataFormat &dataFormat, T &...values)
template<class... T>
bool	readMultipleEndian (bool isLittle, T &...values)
template<class... T>
bool	readMultipleLE (T &...values)
template<class... T>
bool	readMultipleBE (T &...values)
SeekableReadStream *	readStream (uint32 dataSize)
String	readString (char terminator=0, size_t len=String::npos)
Common::String	readPascalString (bool transformCR=true)
Public Member Functions inherited from Common::Stream
virtual bool	err () const
virtual void	clearErr ()

Detailed Description

This implements a special read stream for the y222.avi video that fixes that totalFrames field of the header from it's incorrect value of 1 to a correct 1085.

Member Function Documentation

read()

uint32 Titanic::y222::read ( void *  dataPtr, uint32  dataSize  )

overridevirtual

Read data from the stream.

Subclasses must implement this method. All other read methods are implemented using it.

Note

The semantics of any implementation of this method is supposed to match that of ISO C fread(), in particular where it concerns setting error and end of file/stream flags.

Parameters

dataPtr	Pointer to a buffer into which the data is read.
dataSize	Number of bytes to be read.

Returns

The number of bytes that were actually read.

Implements Common::ReadStream.

eos()

bool Titanic::y222::eos ( ) const

inlineoverridevirtual

Return true if a read failed because the stream end has been reached.

This flag is cleared by clearErr(). For a SeekableReadStream, the flag is also cleared by a successful seek.

Note

The semantics of any implementation of this method is supposed to match that of ISO C feof(). In particular, in a stream with N bytes, reading exactly N bytes from the start should not set eos; only reading beyond the available data should set it.

Implements Common::ReadStream.

pos()

int64 Titanic::y222::pos ( ) const

inlineoverridevirtual

Obtain the current value of the stream position indicator.

Returns

The current position indicator, or -1 if an error occurred.

Implements Common::SeekableReadStream.

size()

int64 Titanic::y222::size ( ) const

inlineoverridevirtual

Obtain the total size of the stream, measured in bytes. If this value is unknown or cannot be computed, -1 is returned.

Returns

The size of the stream, or -1 if an error occurred.

Implements Common::SeekableReadStream.

seek()

bool Titanic::y222::seek ( int64  offset, int  whence = SEEK_SET  )

inlineoverridevirtual

Set the stream position indicator for the stream.

The new position, measured in bytes, is obtained by adding offset bytes to the position specified by whence. If whence is set to SEEK_SET, SEEK_CUR, or SEEK_END, the offset is relative to the start of the file, the current position indicator, or end-of-stream, respectively. A successful call to the seek() method clears the end-of-stream indicator for the stream.

Note

The semantics of any implementation of this method is supposed to match that of ISO C fseek().

Parameters

offset	Relative offset in bytes.
whence	Seek reference: SEEK_SET, SEEK_CUR, or SEEK_END.

Returns

True on success, false in case of a failure.

Implements Common::SeekableReadStream.

skip()

bool Titanic::y222::skip ( uint32  offset )

inlineoverridevirtual

Skip the given number of bytes in the stream.

This is equivalent to calling:

seek(offset, SEEK_CUR)

to add the given number of bytes to the current position indicator of the stream.

Returns

True on success, false in case of a failure.

Reimplemented from Common::SeekableReadStream.

readLine() [1/2]

char* Titanic::y222::readLine ( char *  s, size_t  bufSize, bool  handleCR = true  )

inlineoverridevirtual

Read at most one less than the number of characters specified by bufSize from the stream and store them in the string buffer.

Reading stops when the end of a line is reached (CR, CR/LF, or LF), and at end-of-stream or error. The newline, if any, is retained (CR and CR/LF are translated to LF = 0xA = '\n'). If any characters are read and there is no error, a \0 character is appended to end the string.

Upon successful completion, return a pointer to the string. If end-of-stream occurs before any characters are read, returns NULL and the buffer contents remain unchanged. If an error occurs, returns NULL and the buffer contents are indeterminate. This method does not distinguish between end-of-stream and error; callers must use err() or eos() to determine which occurred.

Note

This method is closely modeled after the standard fgets() function from stdio.h.

Parameters

s	The buffer to store into.
bufSize	Size of the buffer.
handleCR	If set (default), then CR and CR/LF are handled, as well as LF.

Returns

Pointer to the read string, or NULL if an error occurred.

Reimplemented from Common::SeekableReadStream.

readLine() [2/2]

Common::String Titanic::y222::readLine ( bool  handleCR = true )

inlineoverridevirtual

Read a full line and returns it as a Common::String.

Reading stops when the end of a line is reached (CR, CR/LF, or LF), and at end-of-stream or error.

Upon successful completion, return a string with the content of the line, without the end of a line marker. This method does not indicate whether an error occurred. Callers must use err() or eos() to determine whether an exception occurred.

Parameters

handleCR

If set (default), then CR and CR/LF are handled, as well as LF.

Reimplemented from Common::SeekableReadStream.

---

The documentation for this class was generated from the following file:

• engines/titanic/support/avi_surface.h