xoreos  0.0.5
Public Member Functions | List of all members
Video::VideoDecoder::VideoTrack Class Referenceabstract

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

#include <decoder.h>

Inheritance diagram for Video::VideoDecoder::VideoTrack:
Inheritance graph
[legend]
Collaboration diagram for Video::VideoDecoder::VideoTrack:
Collaboration graph
[legend]

Public Member Functions

 VideoTrack ()
 
virtual ~VideoTrack ()
 
TrackType getTrackType () const
 Get the type of track. More...
 
virtual bool endOfTrack () const
 Return if the track has finished. More...
 
virtual uint32 getWidth () const =0
 Get the width of this track. More...
 
virtual uint32 getHeight () const =0
 Get the height of this track. More...
 
virtual int getCurFrame () const =0
 Get the current frame of this track. More...
 
virtual int getFrameCount () const
 Get the frame count of this track. More...
 
virtual Common::Timestamp getNextFrameStartTime () const =0
 Get the start time of the next frame since the start of the video. More...
 
virtual Common::Timestamp getFrameTime (uint frame) const
 Get the time the given frame should be shown. More...
 
- Public Member Functions inherited from Video::VideoDecoder::Track
 Track ()
 
virtual ~Track ()
 
void pause (bool shouldPause)
 Set the pause status of the track. More...
 
bool isPaused () const
 Return if the track is paused. More...
 
virtual Common::Timestamp getDuration () const
 Get the duration of the track. More...
 

Additional Inherited Members

- Public Types inherited from Video::VideoDecoder::Track
enum  TrackType { kTrackTypeNone, kTrackTypeAudio, kTrackTypeVideo }
 The types of tracks this class can be. More...
 
- Protected Member Functions inherited from Video::VideoDecoder::Track
virtual void pauseIntern (bool shouldPause)
 Function called by pause() for subclasses to implement. More...
 

Detailed Description

An abstract representation of a video track.

Definition at line 226 of file decoder.h.

Constructor & Destructor Documentation

◆ VideoTrack()

Video::VideoDecoder::VideoTrack::VideoTrack ( )
inline

Definition at line 228 of file decoder.h.

◆ ~VideoTrack()

virtual Video::VideoDecoder::VideoTrack::~VideoTrack ( )
inlinevirtual

Definition at line 229 of file decoder.h.

Member Function Documentation

◆ endOfTrack()

bool Video::VideoDecoder::VideoTrack::endOfTrack ( ) const
virtual

Return if the track has finished.

Implements Video::VideoDecoder::Track.

Reimplemented in Video::XboxMediaVideo::XMVVideoTrack.

Definition at line 528 of file decoder.cpp.

◆ getCurFrame()

virtual int Video::VideoDecoder::VideoTrack::getCurFrame ( ) const
pure virtual

◆ getFrameCount()

virtual int Video::VideoDecoder::VideoTrack::getFrameCount ( ) const
inlinevirtual

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::QuickTimeDecoder::VideoTrackHandler, and Video::Fader::FaderVideoTrack.

Definition at line 256 of file decoder.h.

◆ getFrameTime()

Common::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 532 of file decoder.cpp.

References Common::Timestamp::addFrames().

Here is the call graph for this function:

◆ getHeight()

virtual uint32 Video::VideoDecoder::VideoTrack::getHeight ( ) const
pure virtual

◆ getNextFrameStartTime()

virtual Common::Timestamp Video::VideoDecoder::VideoTrack::getNextFrameStartTime ( ) const
pure virtual

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

Implemented in Video::VideoDecoder::FixedRateVideoTrack, Video::QuickTimeDecoder::VideoTrackHandler, and Video::XboxMediaVideo::XMVVideoTrack.

◆ getTrackType()

TrackType Video::VideoDecoder::VideoTrack::getTrackType ( ) const
inlinevirtual

Get the type of track.

This must not return kTrackTypeNone.

Implements Video::VideoDecoder::Track.

Definition at line 231 of file decoder.h.

References Video::VideoDecoder::Track::kTrackTypeVideo.

◆ getWidth()

virtual uint32 Video::VideoDecoder::VideoTrack::getWidth ( ) const
pure virtual

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