include/wx/imaggif.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/imaggif.h
   3 // Purpose:     wxImage GIF handler
   4 // Author:      Vaclav Slavik, Guillermo Rodriguez Garcia, Gershon Elber, Troels K
   5 // RCS-ID:      $Id$
   6 // Copyright:   (c) 1999-2011 Vaclav Slavik, Guillermo Rodriguez Garcia, Gershon Elber, Troels K
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_IMAGGIF_H_
  11 #define _WX_IMAGGIF_H_
  12
  13 #include "wx/image.h"
  14
  15
  16 //-----------------------------------------------------------------------------
  17 // wxGIFHandler
  18 //-----------------------------------------------------------------------------
  19
  20 #if wxUSE_GIF
  21
  22 #define wxIMAGE_OPTION_GIF_COMMENT wxT("GifComment")
  23
  24 struct wxRGB;
  25 struct GifHashTableType;
  26 class WXDLLIMPEXP_FWD_CORE wxImageArray; // anidecod.h
  27
  28 class WXDLLIMPEXP_CORE wxGIFHandler : public wxImageHandler
  29 {
  30 public:
  31     inline wxGIFHandler()
  32     {
  33         m_name = wxT("GIF file");
  34         m_extension = wxT("gif");
  35         m_type = wxBITMAP_TYPE_GIF;
  36         m_mime = wxT("image/gif");
  37         m_hashTable = NULL;
  38     }
  39
  40 #if wxUSE_STREAMS
  41     virtual bool LoadFile(wxImage *image, wxInputStream& stream,
  42                           bool verbose = true, int index = -1);
  43     virtual bool SaveFile(wxImage *image, wxOutputStream& stream,
  44                           bool verbose=true);
  45
  46     // Save animated gif
  47     bool SaveAnimation(const wxImageArray& images, wxOutputStream *stream,
  48         bool verbose = true, int delayMilliSecs = 1000);
  49
  50 protected:
  51     virtual int DoGetImageCount(wxInputStream& stream);
  52     virtual bool DoCanRead(wxInputStream& stream);
  53
  54     bool DoSaveFile(const wxImage&, wxOutputStream *, bool verbose,
  55         bool first, int delayMilliSecs, bool loop,
  56         const wxRGB *pal, int palCount,
  57         int mask_index);
  58 #endif // wxUSE_STREAMS
  59 protected:
  60
  61     // Declarations for saving
  62
  63     unsigned long m_crntShiftDWord;   /* For bytes decomposition into codes. */
  64     int m_pixelCount;
  65     struct GifHashTableType *m_hashTable;
  66     wxInt16
  67       m_EOFCode,     /* The EOF LZ code. */
  68       m_clearCode,   /* The CLEAR LZ code. */
  69       m_runningCode, /* The next code algorithm can generate. */
  70       m_runningBits, /* The number of bits required to represent RunningCode. */
  71       m_maxCode1,    /* 1 bigger than max. possible code, in RunningBits bits. */
  72       m_crntCode,    /* Current algorithm code. */
  73       m_crntShiftState;    /* Number of bits in CrntShiftDWord. */
  74     wxUint8 m_LZBuf[256];   /* Compressed input is buffered here. */
  75
  76     bool InitHashTable();
  77     void ClearHashTable();
  78     void InsertHashTable(unsigned long key, int code);
  79     int  ExistsHashTable(unsigned long key);
  80
  81 #if wxUSE_STREAMS
  82     bool CompressOutput(wxOutputStream *, int code);
  83     bool SetupCompress(wxOutputStream *, int bpp);
  84     bool CompressLine(wxOutputStream *, const wxUint8 *line, int lineLen);
  85 #endif
  86
  87 private:
  88     DECLARE_DYNAMIC_CLASS(wxGIFHandler)
  89 };
  90
  91 #endif // wxUSE_GIF
  92
  93 #endif // _WX_IMAGGIF_H_
  94