flic_decoder.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 VIDEO_FLICDECODER_H
#define VIDEO_FLICDECODER_H

#include "video/video_decoder.h"
#include "common/list.h"
#include "common/rect.h"
#include "graphics/palette.h"

namespace Common {
class SeekableReadStream;
}

namespace Graphics {
struct PixelFormat;
struct Surface;
}

namespace Video {

class FlicDecoder : public VideoDecoder {
public:
    FlicDecoder();
    virtual ~FlicDecoder();

    virtual bool loadStream(Common::SeekableReadStream *stream);

    const Common::List<Common::Rect> *getDirtyRects() const;
    void clearDirtyRects();
    void copyDirtyRectsToBuffer(uint8 *dst, uint pitch);

protected:
    class FlicVideoTrack : public VideoTrack {
    public:
        FlicVideoTrack(Common::SeekableReadStream *stream, uint16 frameCount, uint16 width, uint16 height, bool skipHeader = false);
        ~FlicVideoTrack();

        virtual void readHeader();

        bool endOfTrack() const override;
        virtual bool isRewindable() const override{ return true; }
        virtual bool rewind() override;

        uint16 getWidth() const override;
        uint16 getHeight() const override;
        Graphics::PixelFormat getPixelFormat() const override;
        int getCurFrame() const override { return _curFrame; }
        int getCurFrameDelay() const override { return _frameDelay; }
        int getFrameCount() const override { return _frameCount; }
        uint32 getNextFrameStartTime() const override { return _nextFrameStartTime; }
        virtual const Graphics::Surface *decodeNextFrame() override;
        virtual void handleFrame();
        const byte *getPalette() const override{ _dirtyPalette = false; return _palette.data(); }
        bool hasDirtyPalette() const override { return _dirtyPalette; }

        const Common::List<Common::Rect> *getDirtyRects() const { return &_dirtyRects; }
        void clearDirtyRects() { _dirtyRects.clear(); }
        void copyDirtyRectsToBuffer(uint8 *dst, uint pitch);

    protected:
        Common::SeekableReadStream *_fileStream;
        Graphics::Surface *_surface;

        int _curFrame;
        bool _atRingFrame;

        uint32 _offsetFrame1;
        uint32 _offsetFrame2;
        Graphics::Palette _palette;
        mutable bool _dirtyPalette;

        uint32 _frameCount;
        uint32 _frameDelay, _startFrameDelay;
        uint32 _nextFrameStartTime;

        Common::List<Common::Rect> _dirtyRects;

        void copyFrame(uint8 *data);
        void decodeByteRun(uint8 *data);
        void decodeDeltaFLC(uint8 *data);
        void unpackPalette(uint8 *mem);
    };
};

} // End of namespace Video

#endif