____                _       __
    / __ )____  _____   | |     / /___ ___________
   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  )
 /_____/\____/____/     |__/|__/\__,_/_/  /____/

       A futuristic real-time strategy game.
          This file is part of Bos Wars.

(C) Copyright 2001-2007 by the Bos Wars and Stratagus Project. Distributed under the "GNU General Public License"

---

video.h

Go to the documentation of this file.

//     ____                _       __               
//    / __ )____  _____   | |     / /___ ___________
//   / __  / __ \/ ___/   | | /| / / __ `/ ___/ ___/
//  / /_/ / /_/ (__  )    | |/ |/ / /_/ / /  (__  ) 
// /_____/\____/____/     |__/|__/\__,_/_/  /____/  
//                                              
//       A futuristic real-time strategy game.
//          This file is part of Bos Wars.
//
//
//      (c) Copyright 1999-2007 by Lutz Sammer, Nehal Mistry, and Jimmy Salmon
//
//      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; only version 2 of the License.
//
//      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, write to the Free Software
//      Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
//      02111-1307, USA.

#ifndef __VIDEO_H__
#define __VIDEO_H__


#include "SDL.h"
#include "SDL_opengl.h"
#include "guichan/image.h"

class CFont;

extern bool UseOpenGL;


class CGraphic : public gcn::Image {
protected:
    CGraphic() : Surface(NULL), SurfaceFlip(NULL),
        Width(0), Height(0), NumFrames(1), GraphicWidth(0), GraphicHeight(0),
        Refs(1), Resized(false),
        TextureWidth(0.f), TextureHeight(0.f), Textures(NULL), NumTextures(0)
    {
    }
    ~CGraphic() {}

public:
    // Draw
    void DrawClip(int x, int y) const;
    void DrawSub(int gx, int gy, int w, int h, int x, int y) const;
    void DrawSubClip(int gx, int gy, int w, int h, int x, int y) const;
    void DrawSubTrans(int gx, int gy, int w, int h, int x, int y,
        unsigned char alpha) const;
    void DrawSubClipTrans(int gx, int gy, int w, int h, int x, int y,
        unsigned char alpha) const;

    // Draw frame
    void DrawFrame(unsigned frame, int x, int y) const;
    void DoDrawFrameClip(GLuint *textures, unsigned frame, int x, int y) const;
    void DrawFrameClip(unsigned frame, int x, int y) const;
    void DrawFrameTrans(unsigned frame, int x, int y, int alpha) const;
    void DrawFrameClipTrans(unsigned frame, int x, int y, int alpha) const;

    // Draw frame flipped horizontally
    void DrawFrameX(unsigned frame, int x, int y) const;
    void DoDrawFrameClipX(GLuint *textures, unsigned frame, int x, int y) const;
    void DrawFrameClipX(unsigned frame, int x, int y) const;
    void DrawFrameTransX(unsigned frame, int x, int y, int alpha) const;
    void DrawFrameClipTransX(unsigned frame, int x, int y, int alpha) const;


    static CGraphic *New(const std::string &file, int w = 0, int h = 0);
    static CGraphic *ForceNew(const std::string &file, int w = 0, int h = 0);

    CGraphic *Clone() const;

    static void Free(CGraphic *g);

    void Load();
    void Flip();
    void UseDisplayFormat();
    void Resize(int w, int h);
    bool TransparentPixel(int x, int y);
    void MakeShadow();

    inline bool IsLoaded() const { return Surface != NULL; }

    //guichan
    virtual void *_getData() const { return Surface; }
    virtual int getWidth() const { return Width; }
    virtual int getHeight() const { return Height; }

    std::string File;          
    std::string HashFile;      
    SDL_Surface *Surface;      
    SDL_Surface *SurfaceFlip;  
    int Width;                 
    int Height;                
    int NumFrames;             
    int GraphicWidth;          
    int GraphicHeight;         
    int Refs;                  
    bool Resized;              
    GLfloat TextureWidth;      
    GLfloat TextureHeight;     
    GLuint *Textures;          
    int NumTextures;           

    friend void MakeFontColorTextures(CFont *font);
    friend void CleanFonts(void);
    friend void ReloadFonts(void);
};

class CPlayerColorGraphic : public CGraphic
{
protected:
    CPlayerColorGraphic() {
        memset(PlayerColorTextures, 0, sizeof(PlayerColorTextures));
    }

public:
    void DrawPlayerColorFrameClipX(int player, unsigned frame, int x, int y);
    void DrawPlayerColorFrameClip(int player, unsigned frame, int x, int y);

    static CPlayerColorGraphic *New(const std::string &file, int w = 0, int h = 0);
    static CPlayerColorGraphic *ForceNew(const std::string &file, int w = 0, int h = 0);

    GLuint *PlayerColorTextures[PlayerMax];
};

class CColor {
public:
    CColor(unsigned char r = 0, unsigned char g = 0, unsigned char b = 0,
        unsigned char a = 0) : R(r), G(g), B(b), A(a) {}

    operator SDL_Color() const {
        SDL_Color c = { R, G, B, A };
        return c;
    };

    unsigned char R;       
    unsigned char G;       
    unsigned char B;       
    unsigned char A;       
};

class CUnitColors {
public:
    CUnitColors() : Colors(NULL) {}

    SDL_Color *Colors;
};

typedef struct _event_callback_ {

    void (*ButtonPressed)(unsigned buttons);
    void (*ButtonReleased)(unsigned buttons);
    void (*MouseMoved)(int x, int y);
    void (*MouseExit)(void);

    void (*KeyPressed)(unsigned keycode, unsigned keychar);
    void (*KeyReleased)(unsigned keycode, unsigned keychar);
    void (*KeyRepeated)(unsigned keycode, unsigned keychar);

    void (*NetworkEvent)(void);

} EventCallback;

#if SDL_BYTEORDER == SDL_LIL_ENDIAN
#define RSHIFT  0
#define GSHIFT  8
#define BSHIFT  16
#define ASHIFT  24
#define RMASK   0x000000ff
#define GMASK   0x0000ff00
#define BMASK   0x00ff0000
#define AMASK   0xff000000
#else
#define RSHIFT  24
#define GSHIFT  16
#define BSHIFT  8
#define ASHIFT  0
#define RMASK   0xff000000
#define GMASK   0x00ff0000
#define BMASK   0x0000ff00
#define AMASK   0x000000ff
#endif


class CVideo
{
public:
    CVideo() : Width(0), Height(0), Depth(0), FullScreen(false) {}

    void LockScreen();
    void UnlockScreen();

    void ClearScreen();
    bool ResizeScreen(int x, int y);

    void DrawPixelClip(Uint32 color, int x, int y);
    void DrawTransPixelClip(Uint32 color, int x, int y, unsigned char alpha);

    void DrawVLine(Uint32 color, int x, int y, int height);
    void DrawTransVLine(Uint32 color, int x, int y, int height, unsigned char alpha);
    void DrawVLineClip(Uint32 color, int x, int y, int height);
    void DrawTransVLineClip(Uint32 color, int x, int y, int height, unsigned char alpha);

    void DrawHLine(Uint32 color, int x, int y, int width);
    void DrawTransHLine(Uint32 color, int x, int y, int width, unsigned char alpha);
    void DrawHLineClip(Uint32 color, int x, int y, int width);
    void DrawTransHLineClip(Uint32 color, int x, int y, int width, unsigned char alpha);

    void DrawLine(Uint32 color, int sx, int sy, int dx, int dy);
    void DrawTransLine(Uint32 color, int sx, int sy, int dx, int dy, unsigned char alpha);
    void DrawLineClip(Uint32 color, int sx, int sy, int dx, int dy);
    void DrawTransLineClip(Uint32 color, int sx, int sy, int dx, int dy, unsigned char alpha);

    void DrawRectangle(Uint32 color, int x, int y, int w, int h);
    void DrawTransRectangle(Uint32 color, int x, int y, int w, int h, unsigned char alpha);
    void DrawRectangleClip(Uint32 color, int x, int y, int w, int h);
    void DrawTransRectangleClip(Uint32 color, int x, int y, int w, int h, unsigned char alpha);

    void FillRectangle(Uint32 color, int x, int y, int w, int h);
    void FillTransRectangle(Uint32 color, int x, int y, int w, int h, unsigned char alpha);
    void FillRectangleClip(Uint32 color, int x, int y, int w, int h);
    void FillTransRectangleClip(Uint32 color, int x, int y, int w, int h, unsigned char alpha);

    void DrawCircle(Uint32 color, int x, int y, int r);
    void DrawTransCircle(Uint32 color, int x, int y, int r, unsigned char alpha);
    void DrawCircleClip(Uint32 color, int x, int y, int r);
    void DrawTransCircleClip(Uint32 color, int x, int y, int r, unsigned char alpha);

    void FillCircle(Uint32 color, int x, int y, int radius);
    void FillTransCircle(Uint32 color, int x, int y, int radius, unsigned char alpha);
    void FillCircleClip(Uint32 color, int x, int y, int radius);
    void FillTransCircleClip(Uint32 color, int x, int y, int radius, unsigned char alpha);

    inline Uint32 MapRGB(SDL_PixelFormat *f, Uint8 r, Uint8 g, Uint8 b) {
        if (!UseOpenGL) {
            return SDL_MapRGB(f, r, g, b);
        } else {
            return MapRGBA(f, r, g, b, 0xFF);
        }
    }
    inline Uint32 MapRGBA(SDL_PixelFormat *f, Uint8 r, Uint8 g, Uint8 b, Uint8 a) {
        if (!UseOpenGL) {
            return SDL_MapRGBA(f, r, g, b, a);
        } else {
            return ((r << RSHIFT) | (g << GSHIFT) | (b << BSHIFT) | (a << ASHIFT));
        }
    }
    inline void GetRGB(Uint32 c, SDL_PixelFormat *f, Uint8 *r, Uint8 *g, Uint8 *b) {
        if (!UseOpenGL) {
            SDL_GetRGB(c, f, r, g, b);
        } else {
            *r = (c >> RSHIFT) & 0xff;
            *g = (c >> GSHIFT) & 0xff;
            *b = (c >> BSHIFT) & 0xff;
        }
    }
    inline void GetRGBA(Uint32 c, SDL_PixelFormat *f, Uint8 *r, Uint8 *g, Uint8 *b, Uint8 *a) {
        if (!UseOpenGL) {
            SDL_GetRGBA(c, f, r, g, b, a);
        } else {
            *r = (c >> RSHIFT) & 0xff;
            *g = (c >> GSHIFT) & 0xff;
            *b = (c >> BSHIFT) & 0xff;
            *a = (c >> ASHIFT) & 0xff;
        }
    }

    int Width;
    int Height;
    int Depth;
    bool FullScreen;
};

extern CVideo Video;

extern int VideoSyncSpeed;

extern int SkipFrames;

extern char VideoForceFullScreen;

extern unsigned long NextFrameTicks;

extern unsigned long FrameCounter;

extern int SlowFrameCounter;

extern void SetPlayersPalette(void);

extern SDL_Surface *TheScreen;

extern GLint GLMaxTextureSize;
extern bool GLTextureCompressionSupported;
extern bool UseGLTextureCompression;

extern void InitVideo(void);

extern int VideoValidResolution(int w, int h);

extern int LoadGraphicPNG(CGraphic *g);

extern void MakeTexture(CGraphic *graphic);
extern void MakePlayerColorTexture(CPlayerColorGraphic *graphic, int player);

extern void FreeOpenGLGraphics();
extern void ReloadGraphics();
extern void ReloadOpenGL();

extern void SetVideoSync(void);

extern void InitLineDraw(void);

extern void Invalidate(void);

extern void InvalidateArea(int x, int y, int w, int h);

extern void SetClipping(int left, int top, int right, int bottom);

extern void RealizeVideoMemory(void);

extern void SaveScreenshotPNG(const std::string &name);

extern void SetCallbacks(const EventCallback *callbacks);
extern const EventCallback *GetCallbacks();

extern void WaitEventsOneFrame();

extern void ToggleFullScreen(void);

extern void PushClipping(void);

extern void PopClipping(void);

extern unsigned long GetTicks(void);

extern const char *SdlKey2Str(int key);

extern bool SdlGetGrabMouse(void);
extern void ToggleGrabMouse(int mode);

extern EventCallback GameCallbacks;   
extern EventCallback EditorCallbacks; 

extern Uint32 ColorBlack;
extern Uint32 ColorDarkGreen;
extern Uint32 ColorBlue;
extern Uint32 ColorOrange;
extern Uint32 ColorWhite;
extern Uint32 ColorGray;
extern Uint32 ColorRed;
extern Uint32 ColorGreen;
extern Uint32 ColorYellow;

void DrawTexture(const CGraphic *g, GLuint *textures, int sx, int sy,
    int ex, int ey, int x, int y, int flip);

#ifdef DEBUG
extern void FreeGraphics();
#endif

// ARB_texture_compression
extern PFNGLCOMPRESSEDTEXIMAGE3DARBPROC    glCompressedTexImage3DARB;
extern PFNGLCOMPRESSEDTEXIMAGE2DARBPROC    glCompressedTexImage2DARB;
extern PFNGLCOMPRESSEDTEXIMAGE1DARBPROC    glCompressedTexImage1DARB;
extern PFNGLCOMPRESSEDTEXSUBIMAGE3DARBPROC glCompressedTexSubImage3DARB;
extern PFNGLCOMPRESSEDTEXSUBIMAGE2DARBPROC glCompressedTexSubImage2DARB;
extern PFNGLCOMPRESSEDTEXSUBIMAGE1DARBPROC glCompressedTexSubImage1DARB;
extern PFNGLGETCOMPRESSEDTEXIMAGEARBPROC   glGetCompressedTexImageARB;


#endif // !__VIDEO_H__

---