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 struct wxRGB;
  23 struct GifHashTableType;
  24 class WXDLLIMPEXP_FWD_CORE wxImageArray; // anidecod.h
  25
  26 class WXDLLIMPEXP_CORE wxGIFHandler : public wxImageHandler
  27 {
  28 public:
  29     inline wxGIFHandler()
  30     {
  31         m_name = wxT("GIF file");
  32         m_extension = wxT("gif");
  33         m_type = wxBITMAP_TYPE_GIF;
  34         m_mime = wxT("image/gif");
  35         m_hashTable = NULL;
  36     }
  37
  38 #if wxUSE_STREAMS
  39     virtual bool LoadFile(wxImage *image, wxInputStream& stream,
  40                           bool verbose = true, int index = -1);
  41     virtual bool SaveFile(wxImage *image, wxOutputStream& stream,
  42                           bool verbose=true);
  43
  44     // Save animated gif
  45     bool SaveAnimation(const wxImageArray& images, wxOutputStream *stream,
  46         bool verbose = true, int delayMilliSecs = 1000,
  47         const wxString& comment = wxEmptyString);
  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, const wxString& comment = wxEmptyString);
  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 public:
  86     static wxString ms_comment;
  87 private:
  88     DECLARE_DYNAMIC_CLASS(wxGIFHandler)
  89 };
  90
  91 #endif // wxUSE_GIF
  92
  93 #endif // _WX_IMAGGIF_H_
  94