anifile.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/>.
 *
 *
 * This file is dual-licensed.
 * In addition to the GPLv3 license mentioned above, this code is also
 * licensed under LGPL 2.1. See LICENSES/COPYING.LGPL file for the
 * full text of the license.
 *
 */

#ifndef GOB_ANIFILE_H
#define GOB_ANIFILE_H

#include "common/system.h"
#include "common/str.h"
#include "common/array.h"
#include "common/list.h"

namespace Common {
    class SeekableReadStreamEndian;
}

namespace Gob {

class GobEngine;
class Surface;
class CMPFile;

class ANIFile {
public:
    struct FrameArea {
        int16 left;
        int16 top;
        int16 right;
        int16 bottom;
    };

    struct Animation {
        Common::String name; 

        uint16 frameCount; 

        int16 x;     
        int16 y;     
        bool transp; 

        int16 deltaX; 
        int16 deltaY; 

        Common::Array<FrameArea> frameAreas;

        uint16 width;  
        uint16 height; 
    };


    ANIFile(GobEngine *vm, const Common::String &fileName,
            uint16 width = 320, uint8 bpp = 1);
    ~ANIFile();

    uint16 getAnimationCount() const;

    void getMaxSize(uint16 &width, uint16 &height) const;

    const Animation &getAnimationInfo(uint16 animation) const;

    void draw(Surface &dest, uint16 animation, uint16 frame, int16 x, int16 y) const;

    void recolor(uint8 from, uint8 to);

private:
    typedef Common::Array<CMPFile *> LayerArray;
    typedef Common::Array<Animation> AnimationArray;

    struct AnimationChunk {
        int16 x; 
        int16 y; 

        uint16 layer; 
        uint16 part;  
    };

    typedef Common::List<AnimationChunk> ChunkList;
    typedef Common::Array<ChunkList>     FrameArray;
    typedef Common::Array<FrameArray>    AnimationFrameArray;


    GobEngine *_vm;

    uint16 _width; 
    uint8  _bpp;   

    byte _hasPadding;

    LayerArray          _layers;     
    AnimationArray      _animations; 
    AnimationFrameArray _frames;     

    uint16 _maxWidth;
    uint16 _maxHeight;


    // Loading helpers

    void load(Common::SeekableReadStreamEndian &ani, const Common::String &fileName);

    CMPFile *loadLayer(Common::SeekableReadStreamEndian &ani);

    void loadAnimation(Animation &animation, FrameArray &frames,
                       Common::SeekableReadStreamEndian &ani);
    void loadFrames(FrameArray &frames, Common::SeekableReadStreamEndian &ani);

    // Drawing helpers

    bool getCoordinates(uint16 layer, uint16 part,
                        uint16 &left, uint16 &top, uint16 &right, uint16 &bottom) const;

    void drawLayer(Surface &dest, uint16 layer, uint16 part,
                  int16 x, int16 y, int32 transp) const;
};

} // End of namespace Gob

#endif // GOB_ANIFILE_H