ScummVM API documentation
Video::VideoDecoder::FixedRateVideoTrack Class Referenceabstract

#include <video_decoder.h>

Inheritance diagram for Video::VideoDecoder::FixedRateVideoTrack:
Video::VideoDecoder::VideoTrack Video::VideoDecoder::Track Video::AVIDecoder::AVIVideoTrack

Public Member Functions

uint32 getNextFrameStartTime () const
 
virtual Audio::Timestamp getDuration () const
 
Audio::Timestamp getFrameTime (uint frame) const
 
uint getFrameAtTime (const Audio::Timestamp &time) const
 
- Public Member Functions inherited from Video::VideoDecoder::VideoTrack
TrackType getTrackType () const
 
virtual bool endOfTrack () const
 
virtual uint16 getWidth () const =0
 
virtual uint16 getHeight () const =0
 
virtual Graphics::PixelFormat getPixelFormat () const =0
 
virtual bool setOutputPixelFormat (const Graphics::PixelFormat &format)
 
virtual int getCurFrame () const =0
 
virtual int getFrameCount () const
 
virtual const Graphics::SurfacedecodeNextFrame ()=0
 
virtual const byte * getPalette () const
 
virtual bool hasDirtyPalette () 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 bool isRewindable () const
 
virtual bool rewind ()
 
virtual bool isSeekable () const
 
virtual bool seek (const Audio::Timestamp &time)
 
void pause (bool shouldPause)
 
bool isPaused () const
 

Protected Member Functions

virtual Common::Rational getFrameRate () const =0
 
- Protected Member Functions inherited from Video::VideoDecoder::Track
virtual void pauseIntern (bool shouldPause)
 

Additional Inherited Members

- Public Types inherited from Video::VideoDecoder::Track
enum  TrackType { kTrackTypeNone, kTrackTypeVideo, kTrackTypeAudio }
 

Detailed Description

A VideoTrack that is played at a constant rate.

If the frame count is unknown, you must override endOfTrack().

Member Function Documentation

◆ getNextFrameStartTime()

uint32 Video::VideoDecoder::FixedRateVideoTrack::getNextFrameStartTime ( ) const
virtual

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

Implements Video::VideoDecoder::VideoTrack.

◆ getDuration()

virtual Audio::Timestamp Video::VideoDecoder::FixedRateVideoTrack::getDuration ( ) const
virtual

Get the duration of the track (starting from this track's start time).

By default, this returns 0 for unknown.

Reimplemented from Video::VideoDecoder::Track.

◆ getFrameTime()

Audio::Timestamp Video::VideoDecoder::FixedRateVideoTrack::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 from Video::VideoDecoder::VideoTrack.

◆ getFrameAtTime()

uint Video::VideoDecoder::FixedRateVideoTrack::getFrameAtTime ( const Audio::Timestamp time) const

Get the frame that should be displaying at the given time. This is helpful for someone implementing seek().

◆ getFrameRate()

virtual Common::Rational Video::VideoDecoder::FixedRateVideoTrack::getFrameRate ( ) const
protectedpure virtual

Get the rate at which this track is played.

Implemented in Video::AVIDecoder::AVIVideoTrack.


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