seqfile.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_PREGOB_SEQFILE_H
#define GOB_PREGOB_SEQFILE_H

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

#include "gob/util.h"

namespace Common {
    class String;
    class SeekableReadStream;
}

namespace Gob {

class GobEngine;

class DECFile;
class ANIFile;
class ANIObject;

class SEQFile {
public:
    SEQFile(GobEngine *vm, const Common::String &fileName);
    virtual ~SEQFile();

    void play(bool abortable = true, uint16 endFrame = 0xFFFF, uint16 frameRate = 0);


protected:
    GobEngine *_vm;


    uint16 getFrame() const;

    void seekFrame(uint16 frame);

    uint addLoop(uint16 startFrame, uint16 endFrame, uint16 loopCount);

    void skipLoop(uint loopID);

    void delLoop(uint loopID);

    void abortPlay();

    virtual void handleFrameEvent();
    virtual void handleInput(int16 key, int16 mouseX, int16 mouseY, MouseButtons mouseButtons);


private:
    static const uint kObjectCount = 4;

    struct BackgroundKey {
        uint16 frame; 

        const DECFile *background; 
    };

    struct AnimationKey {
        uint object; 

        uint16 frame; 

        const ANIFile *ani; 

        uint16 animation; 

        int16 x; 
        int16 y; 

        int16 order; 
    };

    struct Object {
        ANIObject *object; 

        int16 order; 
    };

    struct Loop {
        uint16 startFrame;
        uint16 endFrame;

        uint16 loopCount;
        uint16 currentLoop;

        bool empty;
    };

    typedef Common::Array<DECFile *> Backgrounds;
    typedef Common::Array<ANIFile *> Animations;

    typedef Common::Array<BackgroundKey> BackgroundKeys;
    typedef Common::Array<AnimationKey>  AnimationKeys;

    typedef Common::List<Object> Objects;

    typedef Common::Array<Loop> Loops;


    uint16 _frame;     
    bool   _abortPlay; 

    uint16 _frameRate;

    Backgrounds _backgrounds; 
    Animations  _animations;  

    BackgroundKeys _bgKeys;   
    AnimationKeys  _animKeys; 

    Object _objects[kObjectCount]; 

    Loops _loops;

    bool _abortable;


    // -- Loading helpers --

    void load(Common::SeekableReadStream &seq);

    const ANIFile *findANI(uint16 index, uint16 &animation);

    // -- Playback helpers --

    void playFrame();

    Objects getOrderedObjects();

    void clearAnims(); 
    void drawAnims();  

    void cleanLoops();
};

} // End of namespace Gob

#endif // GOB_PREGOB_SEQFILE_H