Fl_Anim_GIF_Image.H

//
// Copyright 2016-2019 Christian Grabner <wcout@gmx.net>
//
// Fl_Anim_GIF_Image class - FLTK animated GIF extension.
//
// Fl_Anim_GIF_Image 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.
//
// Fl_Anim_GIF_Image 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:
// http://www.gnu.org/licenses/.
//
#ifndef Fl_Anim_Gif_Image_H
#define Fl_Anim_Gif_Image_H

class Fl_Image;
class Fl_Widget;

#include <FL/Fl_GIF_Image.H>

class FL_EXPORT Fl_Anim_GIF_Image : public Fl_GIF_Image {
  typedef Fl_GIF_Image Inherited;
public:

  class FrameInfo; // internal helper class

  enum Flags {
    Start = 1,
    DontResizeCanvas = 2,
    DontSetAsImage = 4,
    OptimizeMemory = 8,
    Log = 64,
    Debug = 128
  };
  Fl_Anim_GIF_Image(const char *name_, Fl_Widget *canvas_ = 0, unsigned short flags_ = 0);
  Fl_Anim_GIF_Image();
  virtual ~Fl_Anim_GIF_Image();
  void canvas(Fl_Widget *canvas_, unsigned short flags_ = 0);
  Fl_Widget *canvas() const;
  int canvas_w() const;
  int canvas_h() const;
  virtual void color_average(Fl_Color c_, float i_);
  virtual Fl_Image *copy(int W_, int H_);
  int debug() const;
  virtual void desaturate();
  virtual void draw(int x_, int y_, int w_, int h_, int cx_ = 0, int cy_ = 0);
  double delay(int frame_) const;
  void delay(int frame_, double delay_);
  int frames() const;
  void frame(int frame_);
  int frame() const;
  Fl_Image *image() const;
  Fl_Image *image(int frame_) const;
  bool is_animated() const;
  int frame_count(const char *name_);
  void frame_uncache(bool uncache_);
  bool frame_uncache() const;
  bool load(const char *name_);
  static bool loop;
  static double min_delay;
  const char *name() const;
  bool start();
  bool stop();
  Fl_Anim_GIF_Image& resize(int W_, int H_);
  Fl_Anim_GIF_Image& resize(double scale_);
  void speed(double speed_);
  double speed() const;
  virtual void uncache();
  bool valid() const;
  int frame_x(int frame_) const;
  int frame_y(int frame_) const;
  int frame_w(int frame_) const;
  int frame_h(int frame_) const;
protected:
  bool next_frame();
  void clear_frames();
  void set_frame(int frame_);
private:
  static void cb_animate(void *d_);
  void scale_frame();
private:
  char *_name;
  unsigned short _flags;
  Fl_Widget *_canvas;
  bool _uncache;
  bool _valid;
  int _frame; // current frame
  double _speed;
  FrameInfo *_fi;
};

#endif // Fl_Anim_Gif_Image_H