ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge
Inheritance diagram for Grim::NullPlayer:
Collaboration diagram for Grim::NullPlayer:

List of all members.

Public Member Functions

 NullPlayer (const char *codecID)
 ~NullPlayer ()
bool play (const Common::String &filename, bool looping, int x, int y, bool start=true, bool showSubtitles=false) override
 Loads a file for playing, and starts playing it.
bool loadFile (const Common::String &filename) override
 Loads a file for playback, any additional setup is not done here, but in the play-function.
void stop () override
void pause (bool p) override
void saveState (SaveGame *state)
 Saves the state of the video to a savegame.
void restoreState (SaveGame *state)

Private Member Functions

void handleFrame () override
 Frame-handling function.
bool prepareFrame () override
 Handles basic stuff per frame, like copying the latest frame to _externalBuffer, and updating the frame-counters.
void init () override
 Initialization of buffers This function is called by the default-implementation of play, and is expected to get the necessary datastructures set up for playback, as well as initializing the callback.
void deinit () override
 Closes any file/codec-handles, and resets the movie-state to a blank MoviePlayer.

Static Private Member Functions

static void timerCallback (void *ptr)

Detailed Description

Definition at line 240 of file grim/movie/movie.cpp.


Constructor & Destructor Documentation

Grim::NullPlayer::NullPlayer ( const char *  codecID  )  [inline]

Definition at line 242 of file grim/movie/movie.cpp.

Grim::NullPlayer::~NullPlayer (  )  [inline]

Definition at line 246 of file grim/movie/movie.cpp.


Member Function Documentation

void Grim::NullPlayer::deinit (  )  [inline, override, private, virtual]

Closes any file/codec-handles, and resets the movie-state to a blank MoviePlayer.

See also:
init

Reimplemented from Grim::MoviePlayer.

Definition at line 258 of file grim/movie/movie.cpp.

void Grim::NullPlayer::handleFrame (  )  [inline, override, private, virtual]

Frame-handling function.

Perform any codec-specific per-frame operations before the decoder decodes the next frame.

See also:
prepareFrame
clearUpdateNeeded
isUpdateNeeded

Reimplemented from Grim::MoviePlayer.

Definition at line 255 of file grim/movie/movie.cpp.

void Grim::NullPlayer::init (  )  [inline, override, private, virtual]

Initialization of buffers This function is called by the default-implementation of play, and is expected to get the necessary datastructures set up for playback, as well as initializing the callback.

See also:
deinit

Reimplemented from Grim::MoviePlayer.

Definition at line 257 of file grim/movie/movie.cpp.

bool Grim::NullPlayer::loadFile ( const Common::String filename  )  [inline, override, virtual]

Loads a file for playback, any additional setup is not done here, but in the play-function.

This function is supposed to handle any specifics w.r.t. files vs containers (i.e. load from LAB vs load from file).

See also:
play
Parameters:
filename The filename to be handled.

Reimplemented from Grim::MoviePlayer.

Definition at line 248 of file grim/movie/movie.cpp.

void Grim::NullPlayer::pause ( bool  p  )  [inline, override, virtual]

Reimplemented from Grim::MoviePlayer.

Definition at line 250 of file grim/movie/movie.cpp.

bool Grim::NullPlayer::play ( const Common::String filename,
bool  looping,
int  x,
int  y,
bool  start = true,
bool  showSubtitles = false 
) [inline, override, virtual]

Loads a file for playing, and starts playing it.

the default implementation calls init()/deinit() to handle any necessary setup.

Parameters:
filename the file to open
looping true if we want the video to loop, false otherwise
x the x-coordinate for the draw-position
y the y-coordinate for the draw-position
See also:
init
stop

Reimplemented from Grim::MoviePlayer.

Definition at line 247 of file grim/movie/movie.cpp.

bool Grim::NullPlayer::prepareFrame (  )  [inline, override, private, virtual]

Handles basic stuff per frame, like copying the latest frame to _externalBuffer, and updating the frame-counters.

Returns:
false if a frame wasnt drawn to _externalBuffer, true otherwise.
See also:
handleFrame

Reimplemented from Grim::MoviePlayer.

Definition at line 256 of file grim/movie/movie.cpp.

void Grim::NullPlayer::restoreState ( SaveGame state  )  [inline]

Reimplemented from Grim::MoviePlayer.

Definition at line 252 of file grim/movie/movie.cpp.

void Grim::NullPlayer::saveState ( SaveGame state  )  [inline]

Saves the state of the video to a savegame.

Parameters:
state The state to save to

Reimplemented from Grim::MoviePlayer.

Definition at line 251 of file grim/movie/movie.cpp.

void Grim::NullPlayer::stop (  )  [inline, override, virtual]

Reimplemented from Grim::MoviePlayer.

Definition at line 249 of file grim/movie/movie.cpp.

static void Grim::NullPlayer::timerCallback ( void *  ptr  )  [inline, static, private]

Reimplemented from Grim::MoviePlayer.

Definition at line 254 of file grim/movie/movie.cpp.


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


Generated on Sat May 18 2019 05:06:28 for ResidualVM by doxygen 1.7.1
curved edge   curved edge