ScummVM API documentation
Grim::SmushDecoder::SmushVideoTrack Class Reference
Inheritance diagram for Grim::SmushDecoder::SmushVideoTrack:
Video::VideoDecoder::FixedRateVideoTrack Video::VideoDecoder::VideoTrack Video::VideoDecoder::Track

Public Member Functions

 SmushVideoTrack (int width, int height, int fps, int numFrames, bool is16Bit)
 
uint16 getWidth () const override
 
uint16 getHeight () const override
 
Graphics::PixelFormat getPixelFormat () const override
 
int getCurFrame () const override
 
void setCurFrame (int frame)
 
int getFrameCount () const override
 
Common::Rational getFrameRate () const override
 
void setMsPerFrame (int ms)
 
void finishFrame ()
 
bool isSeekable () const override
 
bool seek (const Audio::Timestamp &time) override
 
void setFrameStart (int frame)
 
void handleBlocky16 (Common::SeekableReadStream *stream, uint32 size)
 
void handleFrameObject (Common::SeekableReadStream *stream, uint32 size)
 
void handleDeltaPalette (Common::SeekableReadStream *stream, int32 size)
 
void init ()
 
Graphics::Surface * decodeNextFrame () override
 
const byte * getPalette () const override
 
bool hasDirtyPalette () const override
 
byte * getPal ()
 
- Public Member Functions inherited from Video::VideoDecoder::FixedRateVideoTrack
uint32 getNextFrameStartTime () const override
 
Audio::Timestamp getDuration () const override
 
Audio::Timestamp getFrameTime (uint frame) const override
 
uint getFrameAtTime (const Audio::Timestamp &time) const
 
- Public Member Functions inherited from Video::VideoDecoder::VideoTrack
TrackType getTrackType () const override
 
bool endOfTrack () const override
 
virtual uint16 getWidth () const =0
 
virtual uint16 getHeight () const =0
 
virtual Graphics::PixelFormat getPixelFormat () const =0
 
virtual bool setOutputPixelFormat (const Graphics::PixelFormat &format)
 
virtual void setCodecAccuracy (Image::CodecAccuracy accuracy)
 
virtual int getCurFrame () const =0
 
virtual int getCurFrameDelay () const
 
virtual int getFrameCount () const
 
virtual uint32 getNextFrameStartTime () const =0
 
virtual const Graphics::Surface * decodeNextFrame ()=0
 
virtual const byte * getPalette () const
 
virtual bool hasDirtyPalette () const
 
virtual Audio::Timestamp getFrameTime (uint frame) const
 
virtual bool setReverse (bool reverse)
 
virtual bool isReversed () const
 
virtual bool canDither () const
 
virtual void setDither (const byte *palette)
 
- Public Member Functions inherited from Video::VideoDecoder::Track
virtual TrackType getTrackType () const =0
 
virtual bool endOfTrack () const =0
 
virtual bool isRewindable () const
 
virtual bool rewind ()
 
virtual bool isSeekable () const
 
virtual bool seek (const Audio::Timestamp &time)
 
void pause (bool shouldPause)
 
bool isPaused () const
 
virtual Audio::Timestamp getDuration () const
 

Public Attributes

int _x
 
int _y
 

Additional Inherited Members

- Public Types inherited from Video::VideoDecoder::Track
enum  TrackType { kTrackTypeNone , kTrackTypeVideo , kTrackTypeAudio }
 
virtual Common::Rational getFrameRate () const =0
 
- Protected Member Functions inherited from Video::VideoDecoder::Track
virtual void pauseIntern (bool shouldPause)
 

Member Function Documentation

◆ getWidth()

uint16 Grim::SmushDecoder::SmushVideoTrack::getWidth ( ) const
inlineoverridevirtual

Get the width of this track

Implements Video::VideoDecoder::VideoTrack.

◆ getHeight()

uint16 Grim::SmushDecoder::SmushVideoTrack::getHeight ( ) const
inlineoverridevirtual

Get the height of this track

Implements Video::VideoDecoder::VideoTrack.

◆ getPixelFormat()

Graphics::PixelFormat Grim::SmushDecoder::SmushVideoTrack::getPixelFormat ( ) const
inlineoverridevirtual

Get the pixel format of this track

Implements Video::VideoDecoder::VideoTrack.

◆ getCurFrame()

int Grim::SmushDecoder::SmushVideoTrack::getCurFrame ( ) const
inlineoverridevirtual

Get the current frame of this track

See also
VideoDecoder::getCurFrame()

Implements Video::VideoDecoder::VideoTrack.

◆ getFrameCount()

int Grim::SmushDecoder::SmushVideoTrack::getFrameCount ( ) const
inlineoverridevirtual

Get the frame count of this track

Note
If the frame count is unknown, return 0 (which is also the default implementation of the function). However, one must also implement endOfTrack() in that case.

Reimplemented from Video::VideoDecoder::VideoTrack.

◆ getFrameRate()

Common::Rational Grim::SmushDecoder::SmushVideoTrack::getFrameRate ( ) const
inlineoverridevirtual

Get the rate at which this track is played.

Implements Video::VideoDecoder::FixedRateVideoTrack.

◆ isSeekable()

bool Grim::SmushDecoder::SmushVideoTrack::isSeekable ( ) const
inlineoverridevirtual

Return if the track is seekable.

Reimplemented from Video::VideoDecoder::Track.

◆ seek()

bool Grim::SmushDecoder::SmushVideoTrack::seek ( const Audio::Timestamp &  time)
inlineoverridevirtual

Seek to the given time.

Parameters
timeThe time to seek to, from the beginning of the video.
Returns
true on success, false otherwise.

Reimplemented from Video::VideoDecoder::Track.

◆ decodeNextFrame()

Graphics::Surface * Grim::SmushDecoder::SmushVideoTrack::decodeNextFrame ( )
overridevirtual

Decode the next frame

Implements Video::VideoDecoder::VideoTrack.

◆ getPalette()

const byte * Grim::SmushDecoder::SmushVideoTrack::getPalette ( ) const
inlineoverridevirtual

Get the palette currently in use by this track

Reimplemented from Video::VideoDecoder::VideoTrack.

◆ hasDirtyPalette()

bool Grim::SmushDecoder::SmushVideoTrack::hasDirtyPalette ( ) const
inlineoverridevirtual

Does the palette currently in use by this track need to be updated?

Reimplemented from Video::VideoDecoder::VideoTrack.


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