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