movie.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef GRIM_MOVIE_PLAYER_H
#define GRIM_MOVIE_PLAYER_H

#include "common/mutex.h"
#include "common/system.h"

#include "video/video_decoder.h"

namespace Grim {

class SaveGame;

class MoviePlayer {
protected:
    Common::String _fname;
    Common::Mutex _frameMutex;
    Video::VideoDecoder *_videoDecoder;     //< Initialize this to your needed subclass of VideoDecoder in the constructor
    const Graphics::Surface *_internalSurface;
    Graphics::Surface *_externalSurface;
    const byte *_internalPalette;
    byte *_externalPalette;
    int32 _frame;
    bool _updateNeeded;
    bool _showSubtitles;
    float _movieTime;
    int _channels;
    int _freq;
    bool _videoFinished;
    bool _videoPause;
    bool _videoLooping;
    bool _timerStarted;
    int _x, _y;

public:
    MoviePlayer();
    virtual ~MoviePlayer();

    virtual bool play(const Common::String &filename, bool looping, int x, int y, bool start = true, bool showSubtitles = false);
    virtual void stop();
    virtual void pause(bool p);
    virtual bool isPlaying() { return !_videoFinished; }
    virtual bool isUpdateNeeded() { return _updateNeeded; }
    virtual Graphics::Surface *getDstSurface();
    virtual const byte *getDstPalette();
    virtual int getX() { return _x; }
    virtual int getY() { return _y; }
    virtual int getFrame() { return _frame; }
    virtual void clearUpdateNeeded() { _updateNeeded = false; }
    virtual int32 getMovieTime() { return (int32)_movieTime; }

    /* Draw the subtitles, guarded by _drawMutex */
    void drawMovieSubtitle();

    void saveState(SaveGame *state);
    void restoreState(SaveGame *state);

protected:
    static void timerCallback(void *ptr);
    virtual bool prepareFrame();

    virtual void handleFrame() {};

    virtual void postHandleFrame() {};

    virtual void init();

    virtual void deinit();

    virtual bool loadFile(const Common::String &filename);

    virtual void save(SaveGame *state) {}

    virtual void restore(SaveGame *state) {}
};

// Factory-like functions:

MoviePlayer *CreateMpegPlayer();
MoviePlayer *CreateSmushPlayer(bool demo);
MoviePlayer *CreateBinkPlayer(bool demo);
MoviePlayer *CreateQuickTimePlayer();
extern MoviePlayer *g_movie;

} // end of namespace Grim

#endif