avi_surface.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 TITANIC_AVI_SURFACE_H
#define TITANIC_AVI_SURFACE_H

#include "common/stream.h"
#include "video/avi_decoder.h"
#include "graphics/managed_surface.h"
#include "titanic/core/resource_key.h"
#include "titanic/support/movie_range_info.h"

namespace Titanic {

class CSoundManager;
class CVideoSurface;

enum MovieFlag {
    MOVIE_REPEAT = 1,               // Repeat movie
    MOVIE_STOP_PREVIOUS = 2,        // Stop any prior movie playing on the object
    MOVIE_NOTIFY_OBJECT = 4,        // Notify the object when the movie finishes
    MOVIE_REVERSE = 8,              // Play the movie in reverse
    MOVIE_WAIT_FOR_FINISH = 0x10    // Let finish before playing next movie for object
};

class y222 : virtual public Common::SeekableReadStream {
private:
    File *_innerStream;
public:
    y222();
    ~y222() override;

    uint32 read(void *dataPtr, uint32 dataSize) override;
    bool eos() const override { return _innerStream->eos(); }
    int64 pos() const override { return _innerStream->pos(); }
    int64 size() const override { return _innerStream->size(); }
    bool seek(int64 offset, int whence = SEEK_SET) override {
        return _innerStream->seek(offset, whence);
    }
    bool skip(uint32 offset) override {
        return _innerStream->skip(offset);
    }
    char *readLine(char *s, size_t bufSize, bool handleCR = true) override {
        return _innerStream->readLine(s, bufSize, handleCR);
    }
    Common::String readLine(bool handleCR = true) override {
        return _innerStream->readLine(handleCR);
    }
};


class AVIDecoder : public Video::AVIDecoder {
public:
    AVIDecoder() {}
    AVIDecoder(const Common::Rational &frameRateOverride) :
        Video::AVIDecoder(frameRateOverride) {}

    uint videoTrackCount() const { return _videoTracks.size(); }

    Video::AVIDecoder::AVIVideoTrack &getVideoTrack(uint idx);

    AVIVideoTrack *getTransparencyTrack() {
        return static_cast<AVIVideoTrack *>(_transparencyTrack.track);
    }
};

class AVISurface {
private:
    AVIDecoder *_decoder;
    CVideoSurface *_videoSurface;
    CMovieRangeInfoList _movieRangeInfo;
    int _streamCount;
    Graphics::ManagedSurface *_movieFrameSurface[2];
    bool _framePixels;
    double _frameRate;
    int _currentFrame, _priorFrame;
    uint32 _priorFrameTime;
    Common::String _movieName;
private:
    bool renderFrame();

    void setupDecompressor();

    void copyMovieFrame(const Graphics::Surface &src, Graphics::ManagedSurface &dest);
protected:
    bool startAtFrame(int frameNumber);

    virtual void seekToFrame(uint frameNumber);
public:
    CSoundManager *_soundManager;
    bool _hasAudio;
public:
    AVISurface(const CResourceKey &key);
    virtual ~AVISurface();

    virtual bool play(uint flags, CGameObject *obj);

    virtual bool play(int startFrame, int endFrame, uint flags, CGameObject *obj);

    virtual bool play(int startFrame, int endFrame, int initialFrame, uint flags, CGameObject *obj);

    virtual void stop();

    virtual void pause();

    virtual void resume();

    virtual bool isPlaying() const {
        return _decoder->isPlaying();
    }

    virtual void setPlaying(bool playingFlag) {
        _decoder->pauseVideo(!playingFlag);
    }

    virtual bool handleEvents(CMovieEventList &events);

    void setVideoSurface(CVideoSurface *surface);

    uint getWidth() const;

    uint getHeight() const;

    void setFrame(int frameNumber);

    int getFrame() const { return _priorFrame; }

    bool addEvent(int *frameNumber, CGameObject *obj);

    void setFrameRate(double rate);

    Graphics::ManagedSurface *getSecondarySurface();

    const CMovieRangeInfoList *getMovieRangeInfo() const {
        return &_movieRangeInfo;
    }

    Graphics::ManagedSurface *duplicateTransparency() const;

    bool isNextFrame();

    bool playCutscene(const Rect &r, uint startFrame, uint endFrame);

    uint getBitDepth() const;

    bool isReversed() const { return _frameRate < 0.0; }
};

} // End of namespace Titanic

#endif /* TITANIC_AVI_SURFACE_H */