Fl_Anim_GIF.H

//
// Copyright 2016-2019 Christian Grabner <wcout@gmx.net>
//
// Fl_Anim_GIF widget - FLTK animated GIF widget.
//
// Fl_Anim_GIF 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 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_H
#define Fl_Anim_GIF_H

class Fl_Image;
class RGB_Image;
struct GIF_WHDR;

#include <FL/Fl_Box.H>

class Fl_Anim_GIF : public Fl_Box {
  typedef Fl_Box Inherited;

  class FrameInfo;

public:
  Fl_Anim_GIF(int x_, int y_, int w_, int h_, const char *name_ = 0,
              bool start_ = true, bool optimize_mem_ = false, int debug_ = 0);
  Fl_Anim_GIF(int x_, int y_, const char *name_ = 0,
              bool start_ = true, bool optimize_mem_ = false, int debug_ = 0);
  ~Fl_Anim_GIF();
  void autoresize(bool autoresize);
  bool autoresize() const { return _autoresize; }
  int canvas_w() const;
  int canvas_h() const;
  virtual void color_average(Fl_Color c_, float i_);
  Fl_Anim_GIF *copy();
  virtual Fl_Anim_GIF *copy(int W_, int H_);
  int debug() const;
  virtual void desaturate();
  double delay(int frame_) const;
  void delay(int frame_, double delay_);
  int frame_x(int frame_) const;
  int frame_y(int frame_) const;
  int frame_w(int frame_) const;
  int frame_h(int frame_) const;
  int frames() const;
  void frame(int frame_);
  int frame() const;
  Fl_Image *image() const;
  Fl_Image *image(int frame_) const;
  Fl_Anim_GIF& resize(int W_, int H_);
  Fl_Anim_GIF& resize(double scale_);
  bool load(const char *name_);
  static bool loop;
  static double min_delay;
  const char *name() const;
  bool playing() const { return _valid && !_stopped; }
  void speed(double speed_);
  double speed() const;
  bool start();
  bool stop();
  void uncache(bool uncache_);
  bool uncache() const;
  bool valid() const;
public:
  virtual void draw();
  virtual void resize(int x_, int y_, int w_, int h_);
protected:
  bool next_frame();
  void clear_frames();
  void set_frame(int frame_);
private:
  static void cb_animate(void *d_);
  static void cb_gl_frame(void *ctx_, GIF_WHDR *whdr_);
  static void cb_gl_extension(void *ctx_, GIF_WHDR *whdr_);
  void scale_frame(int frame_ = -1);
private:
  Fl_Anim_GIF();
  void onFrameLoaded(GIF_WHDR &whdr_);
  void onExtensionLoaded(GIF_WHDR &whdr_);
  void _init(const char*name_, bool start_, bool optimize_mem_, int debug_);
private:
  char *_name;
  bool _valid;
  bool _uncache;
  bool _stopped;
  int _frame; // current frame
  double _speed;
  bool _autoresize;
  FrameInfo *_fi;
};

#endif // Fl_Anim_GIF_H