image_defs.h

Go to the documentation of this file.

/* This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.

   This library 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
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef _GAN_IMAGE_DEFS_H
#define _GAN_IMAGE_DEFS_H

#include <stdlib.h>
#include <gandalf/image/pixel.h>
#include <gandalf/common/misc_defs.h>

#ifdef __cplusplus
extern "C" {
#endif


typedef struct Gan_Image
{
   Gan_ImageFormat format;

   Gan_Type type;

   unsigned long height, width;

   unsigned long stride;

   unsigned char *pix_data_ptr;

   size_t pix_data_size;

   Gan_Bool pix_data_alloc;

   union
   {
      union
      {
         unsigned char  **uc;
         short          **s;
         unsigned short **us;
         int            **i;
         unsigned int   **ui;
         float          **f;
         double         **d;
         Gan_BitWord    **b;
         void          ***p;
         Gan_YXPixel_ui10 **ui10;
         Gan_YXPixel_ui12 **ui12;
      } gl;

      union
      {
         Gan_GLAPixel_uc **uc;
         Gan_GLAPixel_s  **s;
         Gan_GLAPixel_us **us;
         Gan_GLAPixel_i  **i;
         Gan_GLAPixel_ui **ui;
         Gan_GLAPixel_f  **f;
         Gan_GLAPixel_d  **d;
      } gla;

      union
      {
         Gan_RGBPixel_uc **uc;
         Gan_RGBPixel_s  **s;
         Gan_RGBPixel_us **us;
         Gan_RGBPixel_i  **i;
         Gan_RGBPixel_ui **ui;
         Gan_RGBPixel_f  **f;
         Gan_RGBPixel_d  **d;
      } rgb;

      union
      {
         Gan_RGBAPixel_uc **uc;
         Gan_RGBAPixel_s  **s;
         Gan_RGBAPixel_us **us;
         Gan_RGBAPixel_i  **i;
         Gan_RGBAPixel_ui **ui;
         Gan_RGBAPixel_f  **f;
         Gan_RGBAPixel_d  **d;
         Gan_RGBAPixel_ui12 **ui12;
      } rgba;

      union
      {
         Gan_Vector2_f **f;
         Gan_Vector2   **d;
         Gan_Vector2_s **s;
         Gan_Vector2_i **i;
      } vfield2D;

      union
      {
         Gan_Vector3_f **f;
         Gan_Vector3   **d;
         Gan_Vector3_s **s;
         Gan_Vector3_i **i;
      } vfield3D;

      union
      {
         Gan_RGBXPixel_ui8   **ui8;
         Gan_RGBXPixel_ui10 **ui10;
      } rgbx;

      union
      {
         Gan_RGBASPixel_ui10 **ui10;
      } rgbas;

      union
      {
         Gan_YUVX444Pixel_ui8 **ui8;
      } yuvx444;

      union
      {
         Gan_YUVA444Pixel_ui8 **ui8;
      } yuva444;

      union
      {
         Gan_YUV422Pixel_ui8 **ui8; /* needs special treatment when iterating */
      } yuv422;
   } row_data;

   void *row_data_ptr;

   size_t row_data_size;

   Gan_BitArray *ba;

   Gan_Bool ba_alloc;

   int offset_x, offset_y;

   Gan_Bool row_data_alloc;

   Gan_Bool struct_alloc;

   void (*data_free_func) (void *);

   void (*free_func) ( struct Gan_Image *img );

#ifndef NDEBUG   

   union
   {
      union
      {
         Gan_Bool (*uc) ( struct Gan_Image *, unsigned row, unsigned col, unsigned char pix );
         Gan_Bool (*s)  ( struct Gan_Image *, unsigned row, unsigned col, short pix );
         Gan_Bool (*us) ( struct Gan_Image *, unsigned row, unsigned col, unsigned short pix );
         Gan_Bool (*i)  ( struct Gan_Image *, unsigned row, unsigned col, int pix );
         Gan_Bool (*ui) ( struct Gan_Image *, unsigned row, unsigned col, unsigned int pix );
         Gan_Bool (*f)  ( struct Gan_Image *, unsigned row, unsigned col, float pix );
         Gan_Bool (*d)  ( struct Gan_Image *, unsigned row, unsigned col, double pix );
         Gan_Bool (*b)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_Bool pix );
         Gan_Bool (*p)  ( struct Gan_Image *, unsigned row, unsigned col, void *pix );
         Gan_Bool (*ui10)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_YXPixel_ui10  *pix );
         Gan_Bool (*ui12)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_YXPixel_ui12  *pix );
      } gl;

      union
      {
         Gan_Bool (*uc) ( struct Gan_Image *, unsigned row, unsigned col, Gan_GLAPixel_uc *pix );
         Gan_Bool (*s)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_GLAPixel_s *pix );
         Gan_Bool (*us) ( struct Gan_Image *, unsigned row, unsigned col, Gan_GLAPixel_us *pix );
         Gan_Bool (*i)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_GLAPixel_i *pix );
         Gan_Bool (*ui) ( struct Gan_Image *, unsigned row, unsigned col, Gan_GLAPixel_ui *pix );
         Gan_Bool (*f)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_GLAPixel_f *pix );
         Gan_Bool (*d)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_GLAPixel_d *pix );
      } gla;

      union
      {
         Gan_Bool (*uc) ( struct Gan_Image *, unsigned row, unsigned col, Gan_RGBPixel_uc *pix );
         Gan_Bool (*s)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_RGBPixel_s *pix );
         Gan_Bool (*us) ( struct Gan_Image *, unsigned row, unsigned col, Gan_RGBPixel_us *pix );
         Gan_Bool (*i)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_RGBPixel_i *pix );
         Gan_Bool (*ui) ( struct Gan_Image *, unsigned row, unsigned col, Gan_RGBPixel_ui *pix );
         Gan_Bool (*d)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_RGBPixel_d *pix );
         Gan_Bool (*f)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_RGBPixel_f *pix );
      } rgb;

      union
      {
         Gan_Bool (*uc) ( struct Gan_Image *, unsigned row, unsigned col, Gan_RGBAPixel_uc *pix );
         Gan_Bool (*s)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_RGBAPixel_s *pix );
         Gan_Bool (*us) ( struct Gan_Image *, unsigned row, unsigned col, Gan_RGBAPixel_us *pix );
         Gan_Bool (*i)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_RGBAPixel_i *pix );
         Gan_Bool (*ui) ( struct Gan_Image *, unsigned row, unsigned col, Gan_RGBAPixel_ui *pix );
         Gan_Bool (*d)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_RGBAPixel_d *pix );
         Gan_Bool (*f)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_RGBAPixel_f *pix );
         Gan_Bool (*ui12) ( struct Gan_Image *, unsigned row, unsigned col, Gan_RGBAPixel_ui12  *pix );
      } rgba;

      union
      {
         Gan_Bool (*f) ( struct Gan_Image *, unsigned row, unsigned col, Gan_Vector2_f *pix );
         Gan_Bool (*d) ( struct Gan_Image *, unsigned row, unsigned col, Gan_Vector2 *pix );
         Gan_Bool (*s) ( struct Gan_Image *, unsigned row, unsigned col, Gan_Vector2_s *pix );
         Gan_Bool (*i) ( struct Gan_Image *, unsigned row, unsigned col, Gan_Vector2_i *pix );
      } vfield2D;

      union
      {
         Gan_Bool (*f) ( struct Gan_Image *, unsigned row, unsigned col, Gan_Vector3_f *pix );
         Gan_Bool (*d) ( struct Gan_Image *, unsigned row, unsigned col, Gan_Vector3 *pix );
         Gan_Bool (*s) ( struct Gan_Image *, unsigned row, unsigned col, Gan_Vector3_s *pix );
         Gan_Bool (*i) ( struct Gan_Image *, unsigned row, unsigned col, Gan_Vector3_i *pix );
      } vfield3D;

      union
      {
         Gan_Bool (*ui8)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_RGBXPixel_ui8  *pix );
         Gan_Bool (*ui10) ( struct Gan_Image *, unsigned row, unsigned col, Gan_RGBXPixel_ui10 *pix );
      } rgbx;

      union
      {
         Gan_Bool (*ui10)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_RGBASPixel_ui10  *pix );
      } rgbas;

      union
      {
         Gan_Bool (*ui8)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_YUVX444Pixel_ui8  *pix );
      } yuvx444;

      union
      {
         Gan_Bool (*ui8)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_YUVA444Pixel_ui8  *pix );
      } yuva444;

      union
      {
         Gan_Bool (*ui8)  ( struct Gan_Image *, unsigned row, unsigned col, Gan_YUV422Pixel_ui8  *pix );
      } yuv422;
   } set_pix;

   union
   {
      union
      {
         unsigned char  (*uc) (const struct Gan_Image *, unsigned row, unsigned col);
         short          (*s)  (const struct Gan_Image *, unsigned row, unsigned col);
         unsigned short (*us) (const struct Gan_Image *, unsigned row, unsigned col);
         int            (*i)  (const struct Gan_Image *, unsigned row, unsigned col);
         unsigned int   (*ui) (const struct Gan_Image *, unsigned row, unsigned col);
         float          (*f)  (const struct Gan_Image *, unsigned row, unsigned col);
         double         (*d)  (const struct Gan_Image *, unsigned row, unsigned col);
         Gan_Bool       (*b)  (const struct Gan_Image *, unsigned row, unsigned col);
         void *         (*p)  (const struct Gan_Image *, unsigned row, unsigned col);
         Gan_YXPixel_ui10 (*ui10)  ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_YXPixel_ui12 (*ui12)  ( const struct Gan_Image *, unsigned row, unsigned col );
      } gl;

      union
      {
         Gan_GLAPixel_uc (*uc) ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_GLAPixel_s  (*s)  ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_GLAPixel_us (*us) ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_GLAPixel_i  (*i)  ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_GLAPixel_ui (*ui) ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_GLAPixel_f  (*f)  ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_GLAPixel_d  (*d)  ( const struct Gan_Image *, unsigned row, unsigned col );
      } gla;

      union
      {
         Gan_RGBPixel_uc (*uc) ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_RGBPixel_s  (*s)  ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_RGBPixel_us (*us) ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_RGBPixel_i  (*i)  ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_RGBPixel_ui (*ui) ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_RGBPixel_f  (*f)  ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_RGBPixel_d  (*d)  ( const struct Gan_Image *, unsigned row, unsigned col );
      } rgb;

      union
      {
         Gan_RGBAPixel_uc (*uc) ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_RGBAPixel_s  (*s)  ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_RGBAPixel_us (*us) ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_RGBAPixel_i  (*i)  ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_RGBAPixel_ui (*ui) ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_RGBAPixel_f  (*f)  ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_RGBAPixel_d  (*d)  ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_RGBAPixel_ui12 (*ui12)  ( const struct Gan_Image *, unsigned row, unsigned col );
      } rgba;

      union
      {
         Gan_Vector2_f (*f) ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_Vector2   (*d) ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_Vector2_s (*s) ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_Vector2_i (*i) ( const struct Gan_Image *, unsigned row, unsigned col );
      } vfield2D;

      union
      {
         Gan_Vector3_f (*f) ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_Vector3   (*d) ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_Vector3_s (*s) ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_Vector3_i (*i) ( const struct Gan_Image *, unsigned row, unsigned col );
      } vfield3D;

      union
      {
         Gan_RGBXPixel_ui8   (*ui8)  ( const struct Gan_Image *, unsigned row, unsigned col );
         Gan_RGBXPixel_ui10 (*ui10) ( const struct Gan_Image *, unsigned row, unsigned col );
      } rgbx;

      union
      {
         Gan_RGBASPixel_ui10 (*ui10)  ( const struct Gan_Image *, unsigned row, unsigned col );
      } rgbas;

      union
      {
         Gan_YUVX444Pixel_ui8 (*ui8)  ( const struct Gan_Image *, unsigned row, unsigned col );
      } yuvx444;

      union
      {
         Gan_YUVA444Pixel_ui8 (*ui8)  ( const struct Gan_Image *, unsigned row, unsigned col );
      } yuva444;

      union
      {
         Gan_YUV422Pixel_ui8 (*ui8)  ( const struct Gan_Image *, unsigned row, unsigned col );
      } yuv422;
   } get_pix;

#endif /* #ifndef NDEBUG */

   union
   {
      union
      {
         Gan_Bool (*uc) ( struct Gan_Image *, unsigned  char pix );
         Gan_Bool (*s)  ( struct Gan_Image *,          short pix );
         Gan_Bool (*us) ( struct Gan_Image *, unsigned short pix );
         Gan_Bool (*i)  ( struct Gan_Image *,            int pix );
         Gan_Bool (*ui) ( struct Gan_Image *, unsigned   int pix );
         Gan_Bool (*f)  ( struct Gan_Image *,          float pix );
         Gan_Bool (*d)  ( struct Gan_Image *,         double pix );
         Gan_Bool (*b)  ( struct Gan_Image *,       Gan_Bool pix );
         Gan_Bool (*p)  ( struct Gan_Image *,         void * pix );
         Gan_Bool (*ui10)  ( struct Gan_Image *, Gan_YXPixel_ui10  *pix );
         Gan_Bool (*ui12)  ( struct Gan_Image *, Gan_YXPixel_ui12  *pix );
      } gl;

      union
      {
         Gan_Bool (*uc) ( struct Gan_Image *, Gan_GLAPixel_uc *pix );
         Gan_Bool (*s)  ( struct Gan_Image *, Gan_GLAPixel_s  *pix );
         Gan_Bool (*us) ( struct Gan_Image *, Gan_GLAPixel_us *pix );
         Gan_Bool (*i)  ( struct Gan_Image *, Gan_GLAPixel_i  *pix );
         Gan_Bool (*ui) ( struct Gan_Image *, Gan_GLAPixel_ui *pix );
         Gan_Bool (*f)  ( struct Gan_Image *, Gan_GLAPixel_f  *pix );
         Gan_Bool (*d)  ( struct Gan_Image *, Gan_GLAPixel_d  *pix );
      } gla;

      union
      {
         Gan_Bool (*uc) ( struct Gan_Image *, Gan_RGBPixel_uc *pix );
         Gan_Bool (*s)  ( struct Gan_Image *, Gan_RGBPixel_s  *pix );
         Gan_Bool (*us) ( struct Gan_Image *, Gan_RGBPixel_us *pix );
         Gan_Bool (*i)  ( struct Gan_Image *, Gan_RGBPixel_i  *pix );
         Gan_Bool (*ui) ( struct Gan_Image *, Gan_RGBPixel_ui *pix );
         Gan_Bool (*f)  ( struct Gan_Image *, Gan_RGBPixel_f  *pix );
         Gan_Bool (*d)  ( struct Gan_Image *, Gan_RGBPixel_d  *pix );
      } rgb;

      union
      {
         Gan_Bool (*uc) ( struct Gan_Image *, Gan_RGBAPixel_uc *pix );
         Gan_Bool (*s)  ( struct Gan_Image *, Gan_RGBAPixel_s  *pix );
         Gan_Bool (*us) ( struct Gan_Image *, Gan_RGBAPixel_us *pix );
         Gan_Bool (*i)  ( struct Gan_Image *, Gan_RGBAPixel_i  *pix );
         Gan_Bool (*ui) ( struct Gan_Image *, Gan_RGBAPixel_ui *pix );
         Gan_Bool (*f)  ( struct Gan_Image *, Gan_RGBAPixel_f  *pix );
         Gan_Bool (*d)  ( struct Gan_Image *, Gan_RGBAPixel_d  *pix );
         Gan_Bool (*ui12) ( struct Gan_Image *, Gan_RGBAPixel_ui12 *pix );
      } rgba;

      union
      {
         Gan_Bool (*f) ( struct Gan_Image *, Gan_Vector2_f *pix );
         Gan_Bool (*d) ( struct Gan_Image *, Gan_Vector2   *pix );
         Gan_Bool (*s) ( struct Gan_Image *, Gan_Vector2_s *pix );
         Gan_Bool (*i) ( struct Gan_Image *, Gan_Vector2_i *pix );
      } vfield2D;

      union
      {
         Gan_Bool (*f) ( struct Gan_Image *, Gan_Vector3_f *pix );
         Gan_Bool (*d) ( struct Gan_Image *, Gan_Vector3   *pix );
         Gan_Bool (*s) ( struct Gan_Image *, Gan_Vector3_s *pix );
         Gan_Bool (*i) ( struct Gan_Image *, Gan_Vector3_i *pix );
      } vfield3D;

      union
      {
         Gan_Bool (*ui8)  ( struct Gan_Image *, Gan_RGBXPixel_ui8   *pix );
         Gan_Bool (*ui10) ( struct Gan_Image *, Gan_RGBXPixel_ui10 *pix );
      } rgbx;

      union
      {
         Gan_Bool (*ui10)  ( struct Gan_Image *, Gan_RGBASPixel_ui10  *pix );
      } rgbas;

      union
      {
         Gan_Bool (*ui8)  ( struct Gan_Image *, Gan_YUVX444Pixel_ui8  *pix );
      } yuvx444;

      union
      {
         Gan_Bool (*ui8)  ( struct Gan_Image *, Gan_YUVA444Pixel_ui8  *pix );
      } yuva444;

      union
      {
         Gan_Bool (*ui8)  ( struct Gan_Image *, Gan_YUV422Pixel_ui8  *pix );
      } yuv422;
   } fill_const;

   struct Gan_Image * (*copy) ( const struct Gan_Image *, struct Gan_Image * );
} Gan_Image;

#define GAN_IMAGE_STRUCT_DEFINED

typedef struct Gan_ImageWindow
{
   int c0, r0;

   int width, height;
} Gan_ImageWindow;

 Gan_Image *gan_image_alloc ( Gan_ImageFormat format, Gan_Type type,
                                         unsigned long height, unsigned long width );

 Gan_Image *gan_image_form ( Gan_Image *img,
                                        Gan_ImageFormat format, Gan_Type type,
                                        unsigned long height, unsigned long width );

 Gan_Image *gan_image_alloc_data ( Gan_ImageFormat format, Gan_Type type,
                                              unsigned long height, unsigned long width,
                                              void *pix_data, size_t pix_data_size,
                                              void *row_data, size_t row_data_size );

 Gan_Image *gan_image_form_data ( Gan_Image *img,
                                             Gan_ImageFormat format, Gan_Type type,
                                             unsigned long height, unsigned long width,
                                             void *pix_data, size_t pix_data_size,
                                             void *row_data, size_t row_data_size );

 void gan_image_free ( Gan_Image *img );

 Gan_Image *gan_image_copy_q ( const Gan_Image *img_s, Gan_Image *img_d );

 Gan_Image *gan_image_copy_s ( const Gan_Image *img );

 Gan_Image *gan_image_set_format_type_dims ( Gan_Image *img,
                                                        Gan_ImageFormat format,
                                                        Gan_Type type,
                                                        unsigned long height,
                                                        unsigned long width );

 Gan_Image *gan_image_set_format_type ( Gan_Image *img,
                                                   Gan_ImageFormat format,
                                                   Gan_Type type );

 Gan_Image *gan_image_set_type ( Gan_Image *img, Gan_Type type );

 Gan_Image *gan_image_set_dims ( Gan_Image *img, unsigned long height, unsigned long width );

 Gan_Bool gan_image_test_format ( const Gan_Image *img, Gan_ImageFormat format );

 Gan_Bool gan_image_test_type ( const Gan_Image *img, Gan_Type type );

 Gan_Bool gan_image_test_dims ( const Gan_Image *img1, const Gan_Image *img2 );

 Gan_Bool gan_image_fill_zero_window ( Gan_Image *img,
                                                  unsigned r0,     unsigned c0,
                                                  unsigned height, unsigned width );

 Gan_Bool gan_image_fill_zero_mask ( Gan_Image *img, Gan_Image *mask );

 Gan_Image *gan_image_form_gen ( Gan_Image *img,
                                            Gan_ImageFormat format, Gan_Type type,
                                            unsigned long height, unsigned long width,
                                            unsigned long stride, Gan_Bool alloc_pix_data,
                                            void *pix_data, size_t pix_data_size,
                                            void *row_data, size_t row_data_size );
 Gan_Bool gan_image_set_data_free_func ( Gan_Image *img,
                                                    void (*data_free_func)(void *) );

 size_t gan_image_pixel_size ( Gan_ImageFormat format, Gan_Type type );
 size_t gan_image_min_stride ( Gan_ImageFormat format, Gan_Type type,
                                          unsigned long width, size_t alignment );

 Gan_Bool gan_image_fill_const ( Gan_Image *img, Gan_Pixel *pixel );
 Gan_Bool gan_image_fill_zero ( Gan_Image *img );
 Gan_Bool gan_image_fill_const_window ( Gan_Image *img,
                                                   unsigned r0,     unsigned c0,
                                                   unsigned height, unsigned width,
                                                   Gan_Pixel *pixel );
 Gan_Bool gan_image_fill_const_mask ( Gan_Image *img, Gan_Image *mask, Gan_Pixel *pixel );
 Gan_Bool gan_merge_field_into_image(const Gan_Image *field, Gan_Bool flip, Gan_Bool upper, Gan_Bool whole_image, Gan_Image *image);

 Gan_Pixel gan_image_get_pix ( const Gan_Image *img, unsigned row, unsigned col );
 void     *gan_image_get_pixptr ( const Gan_Image *img, unsigned row, unsigned col );
 Gan_Bool gan_image_get_pix_zero ( const Gan_Image *img, unsigned row, unsigned col );
 Gan_Bool gan_image_set_pix ( Gan_Image *img, unsigned row, unsigned col, Gan_Pixel *pix );
 Gan_Bool gan_image_set_pix_zero ( Gan_Image *img, unsigned row, unsigned col );

 Gan_Bool gan_image_get_active_subwindow ( const Gan_Image *image, Gan_ImageWindow *subwin );

 void            gan_image_intersect_subwindows_q ( const Gan_ImageWindow *window1, const Gan_ImageWindow *window2,
                                                               Gan_ImageWindow *resultwindow );
 Gan_ImageWindow gan_image_intersect_subwindows_s ( const Gan_ImageWindow *window1, const Gan_ImageWindow *window2 );
 void            gan_image_intersect_subwindows_i ( Gan_ImageWindow *sourcedestwindow, const Gan_ImageWindow *window );
 void            gan_image_fit_subwindow ( Gan_ImageWindow *subwin, const Gan_Image *image );

 Gan_Bool gan_image_mask_window ( Gan_Image *image,
                                             unsigned r0,     unsigned c0,
                                             unsigned height, unsigned width );
 Gan_Bool gan_image_clear_window ( Gan_Image *image,
                                              unsigned r0,     unsigned c0,
                                              unsigned height, unsigned width );

 Gan_Bool gan_image_get_minimum_pixel ( Gan_Image *image, Gan_Image *mask, Gan_Pixel *minpix );
 Gan_Bool gan_image_get_maximum_pixel ( Gan_Image *image, Gan_Image *mask, Gan_Pixel *maxpix );

 void gan_image_free_va ( Gan_Image *img, ... );

 Gan_Bool gan_image_has_alpha_channel ( const Gan_Image *img );

/* not user functions: use macros instead */
 Gan_Image *gan_image_set_format_type_dims_gen  ( Gan_Image *img,
                                                 Gan_ImageFormat format,
                                                 Gan_Type type,
                                                 unsigned long height,
                                                 unsigned long width,
                                                 unsigned long stride,
                                                 Gan_Bool alloc_pix_data );

#ifdef __cplusplus
}
#endif

#endif /* #ifndef _GAN_IMAGE_DEFS_H */

---