animation.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 VOYEUR_ANIMATION_H
#define VOYEUR_ANIMATION_H

#include "video/video_decoder.h"
#include "audio/audiostream.h"
#include "audio/mixer.h"
#include "common/array.h"
#include "common/list.h"
#include "common/rect.h"
#include "common/stream.h"
#include "voyeur/files.h"

namespace Audio {
class Timestamp;
}

namespace Voyeur {

class VoyeurEngine;

class RL2Decoder : public Video::VideoDecoder {
private:
    class RL2FileHeader {
    public:
        RL2FileHeader();
        ~RL2FileHeader();

        int _channels;
        int _colorCount;
        int _numFrames;
        int _rate;
        int _soundRate;
        int _videoBase;
        int *_frameSoundSizes;

        uint32 _backSize;
        uint32 _signature;
        uint32 *_frameOffsets;

        byte _palette[768];

        void load(Common::SeekableReadStream *stream);
        Common::Rational getFrameRate() const;
        bool isValid() const;

    private:
        uint32 _form;      // Unused variable
        uint32 _dataSize;  // Unused variable
        int _method;       // Unused variable
        int _defSoundSize;
    };

    class SoundFrame {
    public:
        int _offset;
        int _size;

        SoundFrame(int  offset, int size);
    };

    class RL2AudioTrack : public AudioTrack {
    private:
        const RL2FileHeader &_header;
        Audio::QueuingAudioStream *_audStream;
    protected:
        Audio::AudioStream *getAudioStream() const override;
    public:
        RL2AudioTrack(const RL2FileHeader &header, Common::SeekableReadStream *stream,
            Audio::Mixer::SoundType soundType);
        ~RL2AudioTrack() override;

        int numQueuedStreams() const { return _audStream->numQueuedStreams(); }
        bool isSeekable() const override { return true; }
        bool seek(const Audio::Timestamp &time) override { return true; }

        void queueSound(Common::SeekableReadStream *stream, int size);
    };

    class RL2VideoTrack : public FixedRateVideoTrack {
    public:
        RL2VideoTrack(const RL2FileHeader &header, RL2AudioTrack *audioTrack,
            Common::SeekableReadStream *stream);
        ~RL2VideoTrack() override;

        uint16 getWidth() const override;
        uint16 getHeight() const override;
        Graphics::Surface *getSurface() { return _surface; }
        Graphics::Surface *getBackSurface();
        Graphics::PixelFormat getPixelFormat() const override;
        int getCurFrame() const override { return _curFrame; }
        int getFrameCount() const override { return _header._numFrames; }
        const Graphics::Surface *decodeNextFrame() override;
        const byte *getPalette() const override { _dirtyPalette = false; return _header._palette; }
        int getPaletteCount() const { return _header._colorCount; }
        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);

        Common::Rational getFrameRate() const override { return _header.getFrameRate(); }
        bool isSeekable() const override { return true; }
        bool seek(const Audio::Timestamp &time) override;
    private:
        Common::SeekableReadStream *_fileStream;
        const RL2FileHeader &_header;
        Graphics::Surface *_surface;
        Graphics::Surface *_backSurface;
        bool _hasBackFrame;

        mutable bool _dirtyPalette;

        bool _initialFrame;
        int _curFrame;
        uint32 _videoBase;
        uint32 *_frameOffsets;

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

        void copyFrame(uint8 *data);
        void rl2DecodeFrameWithTransparency(int screenOffset);
        void rl2DecodeFrameWithoutTransparency(int screenOffset = -1);
        void initBackSurface();
    };

private:
    RL2AudioTrack *_audioTrack;
    RL2VideoTrack *_videoTrack;
    Common::SeekableReadStream *_fileStream;
    RL2FileHeader _header;
    int _paletteStart;
    Common::Array<SoundFrame> _soundFrames;
    int _soundFrameNumber;
    const Common::List<Common::Rect> *getDirtyRects() const;

    void clearDirtyRects();
    void copyDirtyRectsToBuffer(uint8 *dst, uint pitch);
    int getPaletteStart() const { return _paletteStart; }
    const RL2FileHeader &getHeader() { return _header; }
    void readNextPacket() override;
    bool seekIntern(const Audio::Timestamp &time) override;

public:
    RL2Decoder();
    ~RL2Decoder() override;

    void close() override;

    bool loadStream(Common::SeekableReadStream *stream) override;
    bool loadRL2File(const Common::Path &file, bool palFlag);
    bool loadVideo(int videoId);
    int getPaletteCount() const { return _header._colorCount; }

    void play(VoyeurEngine *vm, int resourceOffset = 0, byte *frames = nullptr, byte *imgPos = nullptr);
    RL2VideoTrack *getRL2VideoTrack() { return _videoTrack; }
    RL2AudioTrack *getRL2AudioTrack() { return _audioTrack; }
};

} // End of namespace Voyeur

#endif /* VOYEUR_ANIMATION_H */