pregob.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_PREGOB_H
#define GOB_PREGOB_PREGOB_H

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

#include "gob/util.h"
#include "gob/aniobject.h"

#include "gob/pregob/txtfile.h"

namespace Gob {

class GobEngine;
class ANIFile;
class Surface;
class SoundDesc;

class GCTFile;

class PreGob {
public:
    PreGob(GobEngine *vm);
    virtual ~PreGob();

    virtual void run() = 0;

    struct AnimProperties {
        uint16 animation;
        uint16 frame;

        ANIObject::Mode mode;

        bool visible;
        bool paused;

        bool hasPosition;
        int16 x;
        int16 y;
    };

protected:
    typedef Common::Array<ANIObject *> ANIList;

    static const char  kLanguageSuffixShort[5];
    static const char *kLanguageSuffixLong [5];


    GobEngine *_vm;


    // -- Graphics --

    void initScreen();

    void fadeOut(); 
    void fadeIn();  

    void clearScreen();

    void setPalette(const byte *palette, uint16 size); 

    void addCursor();
    void removeCursor();

    void setCursor(Surface &sprite, int16 hotspotX, int16 hotspotY);
    void setCursor(Surface &sprite, int16 left, int16 top, int16 right, int16 bottom,
                   int16 hotspotX, int16 hotspotY);

    void showCursor();
    void hideCursor();

    bool isCursorVisible() const;

    void clearAnim(ANIObject &anim);
    void drawAnim(ANIObject &anim);
    void redrawAnim(ANIObject &anim);

    void clearAnim(const ANIList &anims);
    void drawAnim(const ANIList &anims);
    void redrawAnim(const ANIList &anims);

    void loadAnims(ANIList &anims, ANIFile &ani, uint count, const AnimProperties *props) const;
    void freeAnims(ANIList &anims) const;

    void setAnim(ANIObject &anim, const AnimProperties &props) const;

    void endFrame(bool doInput);


    // -- Sound --

    void loadSounds(const char * const *sounds, uint soundCount);
    void freeSounds();

    void playSound(uint sound, int16 frequency = 0, int16 repCount = 0);
    void stopSound();

    void playSoundFile(const Common::String &file, int16 frequency = 0, int16 repCount = 0, bool interruptible = true);

    void beep(int16 frequency, int32 length);


    // -- Input --

    int16 checkInput(int16 &mouseX, int16 &mouseY, MouseButtons &mouseButtons);
    int16 waitInput (int16 &mouseX, int16 &mouseY, MouseButtons &mouseButtons);
    int16 waitInput();
    bool  hasInput();


    // -- TXT helpers --

    Common::String getLocFile(const Common::String &file) const;
    TXTFile *loadTXT(const Common::String &txtFile, TXTFile::Format format) const;

    virtual void fixTXTStrings(TXTFile &txt) const;


    // -- GCT helpers --

    GCTFile *loadGCT(const Common::String &gctFile) const;


private:
    bool _fadedOut;

    Common::Array<SoundDesc> _sounds;


    bool loadSound(SoundDesc &sound, const Common::String &file) const;
};

} // End of namespace Gob

#endif // GOB_PREGOB_PREGOB_H