video_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_VIDEO_SURFACE_H
#define TITANIC_VIDEO_SURFACE_H

#include "common/scummsys.h"
#include "common/array.h"
#include "graphics/managed_surface.h"
#include "titanic/support/font.h"
#include "titanic/support/direct_draw.h"
#include "titanic/support/movie.h"
#include "titanic/support/movie_range_info.h"
#include "titanic/support/rect.h"
#include "titanic/support/transparency_surface.h"
#include "titanic/core/list.h"
#include "titanic/core/resource_key.h"

namespace Titanic {

class CScreenManager;
class CJPEGDecode;
class CTargaDecode;

class CVideoSurface : public ListItem {
    friend class CJPEGDecode;
    friend class CTargaDecode;
private:
    static byte _palette1[32][32];
    static byte _palette2[32][32];

    static void setupPalette(byte palette[32][32], byte val);
public:
    static void setup() {
        setupPalette(_palette1, 0xff);
    }
private:
    void clipBounds(Rect &srcRect, Rect &destRect, CVideoSurface *srcSurface,
        const Rect *subRect = nullptr, const Point *destPos = nullptr);

    void blitRect(const Rect &srcRect, const Rect &destRect, CVideoSurface *src);

    void flippedBlitRect(const Rect &srcRect, const Rect &destRect, CVideoSurface *src);

    void transBlitRect(const Rect &srcRect, const Rect &destRect, CVideoSurface *src, bool flipFlag);
protected:
    static int _videoSurfaceCounter;
protected:
    CScreenManager *_screenManager;
    Graphics::ManagedSurface *_rawSurface;
    bool _pendingLoad;
    Graphics::ManagedSurface *_transparencySurface;
    DisposeAfterUse::Flag _freeTransparencySurface;
    int _videoSurfaceNum;
    bool _hasFrame;
    int _lockCount;
public:
    CMovie *_movie;
    DirectDrawSurface *_ddSurface;
    bool _fastBlitFlag;
    bool _flipVertically;
    CResourceKey _resourceKey;
    TransparencyMode _transparencyMode;
public:
    CVideoSurface(CScreenManager *screenManager);
    ~CVideoSurface() override;

    void setSurface(CScreenManager *screenManager, DirectDrawSurface *surface);

    void load(SimpleFile *file) override {
        ListItem::load(file);
    }

    virtual void loadResource(const CResourceKey &key) = 0;

    virtual void loadTarga(const CResourceKey &key) = 0;

    virtual void loadJPEG(const CResourceKey &key) = 0;

    virtual void loadTarga(const CString &name) = 0;

    virtual void loadMovie(const CResourceKey &key, bool destroyFlag = false) = 0;

    virtual bool lock() = 0;

    virtual void unlock() = 0;

    virtual bool hasSurface() = 0;

    virtual int getWidth() = 0;

    virtual int getHeight() = 0;

    virtual int getPitch() = 0;

    virtual int getBpp() = 0;

    virtual void recreate(int width, int height, int bpp = 16) = 0;

    virtual void resize(int width, int height, int bpp = 16) = 0;

    virtual void detachSurface() = 0;

    virtual int getPixelDepth() = 0;

    virtual uint16 getPixel(const Common::Point &pt) = 0;


    virtual void setPixel(const Point &pt, uint pixel) = 0;

    virtual void shiftColors() = 0;

    virtual void clear() = 0;

    virtual void playMovie(uint flags, CGameObject *obj) = 0;

    virtual void playMovie(uint startFrame, uint endFrame, uint flags, CGameObject *obj) = 0;

    virtual void playMovie(uint startFrame, uint endFrame, uint initialFrame, uint flags, CGameObject *obj) = 0;

    virtual void stopMovie() = 0;

    virtual void setMovieFrame(uint frameNumber) = 0;

    virtual void addMovieEvent(int eventId, CGameObject *obj) = 0;

    virtual void setMovieFrameRate(double rate) = 0;

    virtual const CMovieRangeInfoList *getMovieRangeInfo() const = 0;

    virtual void flipVertically(bool needsLock = true) = 0;

    virtual bool loadIfReady() = 0;

    virtual bool load() = 0;

    virtual void transPixelate() = 0;

    virtual bool hasFrame();

    virtual Graphics::ManagedSurface *dupMovieTransparency() const = 0;

    virtual int freeSurface() { return 0; }

    virtual uint16 *getBasePtr(int x, int y) = 0;

    void blitFrom(const Point &destPos, CVideoSurface *src, const Rect *srcRect = nullptr);

    void blitFrom(const Point &destPos, const Graphics::Surface *src);

    void setTransparencySurface(Graphics::ManagedSurface *surface) { _transparencySurface = surface; }

    const Graphics::Surface *getTransparencySurface() const {
        return _transparencySurface ? &_transparencySurface->rawSurface() : nullptr;
    }

    uint16 *getPixels() { return (uint16 *)_rawSurface->getPixels(); }

    Graphics::ManagedSurface *getRawSurface() { return _rawSurface; }

    uint getTransparencyColor();

    void copyPixel(uint16 *destP, const uint16 *srcP, byte alpha,
        const Graphics::PixelFormat &srcFormat, bool isAlpha);
};

class OSVideoSurface : public CVideoSurface {
    friend class OSMovie;
public:
    OSVideoSurface(CScreenManager *screenManager, DirectDrawSurface *surface);
    OSVideoSurface(CScreenManager *screenManager, const CResourceKey &key, bool flag = false);
    ~OSVideoSurface() override;

    void loadResource(const CResourceKey &key) override;

    void loadTarga(const CResourceKey &key) override;

    void loadJPEG(const CResourceKey &key) override;

    void loadTarga(const CString &name) override;

    void loadMovie(const CResourceKey &key, bool destroyFlag = false) override;

    bool lock() override;

    void unlock() override;

    bool hasSurface() override;

    int getWidth() override;

    int getHeight() override;

    int getPitch() override;

    int getBpp() override;

    void recreate(int width, int height, int bpp = 16) override;

    void resize(int width, int height, int bpp = 16) override;

    void detachSurface() override;

    int getPixelDepth() override;

    uint16 getPixel(const Point &pt) override;

    void setPixel(const Point &pt, uint pixel) override;

    void shiftColors() override;

    void clear() override;

    void playMovie(uint flags, CGameObject *obj) override;

    void playMovie(uint startFrame, uint endFrame, uint flags, CGameObject *obj) override;

    void playMovie(uint startFrame, uint endFrame, uint initialFrame, uint flags, CGameObject *obj) override;

    void stopMovie() override;

    void setMovieFrame(uint frameNumber) override;

    void addMovieEvent(int frameNumber, CGameObject *obj) override;

    void setMovieFrameRate(double rate) override;

    const CMovieRangeInfoList *getMovieRangeInfo() const override;

    void flipVertically(bool needsLock = true) override;

    bool loadIfReady() override;

    bool load() override;

    void transPixelate() override;

    Graphics::ManagedSurface *dupMovieTransparency() const override;

    int freeSurface() override;

    uint16 *getBasePtr(int x, int y) override;
};

} // End of namespace Titanic

#endif /* TITANIC_VIDEO_SURFACE_H */