ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

Video::VideoDecoder::VideoTrack Class Reference

An abstract representation of a video track. More...

#include <video_decoder.h>

Inheritance diagram for Video::VideoDecoder::VideoTrack:
Collaboration diagram for Video::VideoDecoder::VideoTrack:

List of all members.

Public Member Functions

 VideoTrack ()
virtual ~VideoTrack ()
TrackType getTrackType () const
 Get the type of track.
virtual bool endOfTrack () const
 Return if the track has finished.
virtual uint16 getWidth () const =0
 Get the width of this track.
virtual uint16 getHeight () const =0
 Get the height of this track.
virtual Graphics::PixelFormat getPixelFormat () const =0
 Get the pixel format of this track.
virtual int getCurFrame () const =0
 Get the current frame of this track.
virtual int getFrameCount () const
 Get the frame count of this track.
virtual uint32 getNextFrameStartTime () const =0
 Get the start time of the next frame in milliseconds since the start of the video.
virtual const Graphics::SurfacedecodeNextFrame ()=0
 Decode the next frame.
virtual const bytegetPalette () const
 Get the palette currently in use by this track.
virtual bool hasDirtyPalette () const
 Does the palette currently in use by this track need to be updated?
virtual Audio::Timestamp getFrameTime (uint frame) const
 Get the time the given frame should be shown.
virtual bool setReverse (bool reverse)
 Set the video track to play in reverse or forward.
virtual bool isReversed () const
 Is the video track set to play in reverse?
virtual bool canDither () const
 Can the video track dither?
virtual void setDither (const byte *palette)
 Activate dithering mode with a palette.

Detailed Description

An abstract representation of a video track.

Definition at line 556 of file video_decoder.h.


Constructor & Destructor Documentation

Video::VideoDecoder::VideoTrack::VideoTrack (  )  [inline]

Definition at line 558 of file video_decoder.h.

virtual Video::VideoDecoder::VideoTrack::~VideoTrack (  )  [inline, virtual]

Definition at line 559 of file video_decoder.h.


Member Function Documentation

virtual bool Video::VideoDecoder::VideoTrack::canDither (  )  const [inline, virtual]

Can the video track dither?

Reimplemented in Video::AVIDecoder::AVIVideoTrack.

Definition at line 642 of file video_decoder.h.

virtual const Graphics::Surface* Video::VideoDecoder::VideoTrack::decodeNextFrame (  )  [pure virtual]
bool Video::VideoDecoder::VideoTrack::endOfTrack (  )  const [virtual]
virtual int Video::VideoDecoder::VideoTrack::getCurFrame (  )  const [pure virtual]
virtual int Video::VideoDecoder::VideoTrack::getFrameCount (  )  const [inline, virtual]

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 in Video::AVIDecoder::AVIVideoTrack, Video::FlicDecoder::FlicVideoTrack, and Video::PSXStreamDecoder::PSXVideoTrack.

Definition at line 593 of file video_decoder.h.

Audio::Timestamp Video::VideoDecoder::VideoTrack::getFrameTime ( uint  frame  )  const [virtual]

Get the time the given frame should be shown.

By default, this returns a negative (invalid) value. This function should only be used by VideoDecoder::seekToFrame().

Reimplemented in Video::VideoDecoder::FixedRateVideoTrack.

Definition at line 551 of file video_decoder.cpp.

virtual uint16 Video::VideoDecoder::VideoTrack::getHeight (  )  const [pure virtual]
virtual uint32 Video::VideoDecoder::VideoTrack::getNextFrameStartTime (  )  const [pure virtual]

Get the start time of the next frame in milliseconds since the start of the video.

Implemented in Video::FlicDecoder::FlicVideoTrack, Video::PSXStreamDecoder::PSXVideoTrack, Video::TheoraDecoder::TheoraVideoTrack, and Video::VideoDecoder::FixedRateVideoTrack.

virtual const byte* Video::VideoDecoder::VideoTrack::getPalette (  )  const [inline, virtual]

Get the palette currently in use by this track.

Reimplemented in Video::AVIDecoder::AVIVideoTrack, and Video::FlicDecoder::FlicVideoTrack.

Definition at line 609 of file video_decoder.h.

virtual Graphics::PixelFormat Video::VideoDecoder::VideoTrack::getPixelFormat (  )  const [pure virtual]
TrackType Video::VideoDecoder::VideoTrack::getTrackType (  )  const [inline, virtual]

Get the type of track.

Implements Video::VideoDecoder::Track.

Definition at line 561 of file video_decoder.h.

virtual uint16 Video::VideoDecoder::VideoTrack::getWidth (  )  const [pure virtual]
virtual bool Video::VideoDecoder::VideoTrack::hasDirtyPalette (  )  const [inline, virtual]

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

Reimplemented in Video::AVIDecoder::AVIVideoTrack, and Video::FlicDecoder::FlicVideoTrack.

Definition at line 614 of file video_decoder.h.

virtual bool Video::VideoDecoder::VideoTrack::isReversed (  )  const [inline, virtual]

Is the video track set to play in reverse?

Reimplemented in Video::AVIDecoder::AVIVideoTrack.

Definition at line 637 of file video_decoder.h.

virtual void Video::VideoDecoder::VideoTrack::setDither ( const byte palette  )  [inline, virtual]

Activate dithering mode with a palette.

Reimplemented in Video::AVIDecoder::AVIVideoTrack.

Definition at line 647 of file video_decoder.h.

virtual bool Video::VideoDecoder::VideoTrack::setReverse ( bool  reverse  )  [inline, virtual]

Set the video track to play in reverse or forward.

By default, a VideoTrack must decode forward.

Parameters:
reverse true for reverse, false for forward
Returns:
true for success, false for failure

Reimplemented in Video::AVIDecoder::AVIVideoTrack.

Definition at line 632 of file video_decoder.h.


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


Generated on Sat Sep 14 2019 05:05:22 for ResidualVM by doxygen 1.7.1
curved edge   curved edge