imexttypes.h

   1 #ifndef IMAGER_IMEXTTYPES_H_
   2 #define IMAGER_IMEXTTYPES_H_
   3
   4 /* keep this file simple - apidocs.perl parses it. */
   5
   6 #include "imdatatypes.h"
   7 #include <stdarg.h>
   8
   9 /*
  10  IMAGER_API_VERSION is similar to the version number in the third and
  11  fourth bytes of TIFF files - if it ever changes then the API has changed
  12  too much for any application to remain compatible.
  13
  14  Version 2 changed the types of some parameters and pointers.  A
  15  simple recompile should be enough in most cases.
  16
  17  Version 3 changed the behaviour of some of the I/O layer functions,
  18  and in some cases the initial seek position when calling file
  19  readers.  Switching away from calling readcb etc to i_io_read() etc
  20  should fix your code.
  21
  22  Version 4 added i_psamp() and i_psampf() pointers to the i_img
  23  structure.
  24
  25  Version 5 changed the return types of i_get_file_background() and
  26  i_get_file_backgroundf() from void to int.
  27
  28 */
  29 #define IMAGER_API_VERSION 5
  30
  31 /*
  32  IMAGER_API_LEVEL is the level of the structure.  New function pointers
  33  will always remain at the end (unless IMAGER_API_VERSION changes), and
  34  will result in an increment of IMAGER_API_LEVEL.
  35 */
  36
  37 #define IMAGER_API_LEVEL 8
  38
  39 typedef struct {
  40   int version;
  41   int level;
  42
  43   /* IMAGER_API_LEVEL 1 functions */
  44   void * (*f_mymalloc)(size_t size);
  45   void (*f_myfree)(void *block);
  46   void * (*f_myrealloc)(void *block, size_t newsize);
  47   void* (*f_mymalloc_file_line)(size_t size, char* file, int line);
  48   void  (*f_myfree_file_line)(void *p, char*file, int line);
  49   void* (*f_myrealloc_file_line)(void *p, size_t newsize, char* file,int line);
  50
  51   i_img *(*f_i_img_8_new)(i_img_dim xsize, i_img_dim ysize, int channels); /* SKIP */
  52   i_img *(*f_i_img_16_new)(i_img_dim xsize, i_img_dim ysize, int channels);  /* SKIP */
  53   i_img *(*f_i_img_double_new)(i_img_dim xsize, i_img_dim ysize, int channels); /* SKIP */
  54   i_img *(*f_i_img_pal_new)(i_img_dim xsize, i_img_dim ysize, int channels, int maxpal); /* SKIP */
  55   void (*f_i_img_destroy)(i_img *im);
  56   i_img *(*f_i_sametype)(i_img *im, i_img_dim xsize, i_img_dim ysize);
  57   i_img *(*f_i_sametype_chans)(i_img *im, i_img_dim xsize, i_img_dim ysize, int channels);
  58   void (*f_i_img_info)(i_img *im, i_img_dim *info);
  59
  60   int (*f_i_ppix)(i_img *im, i_img_dim x, i_img_dim y, const i_color *val);
  61   int (*f_i_gpix)(i_img *im, i_img_dim x, i_img_dim y, i_color *val);
  62   int (*f_i_ppixf)(i_img *im, i_img_dim x, i_img_dim y, const i_fcolor *val);
  63   int (*f_i_gpixf)(i_img *im, i_img_dim x, i_img_dim y, i_fcolor *val);
  64   i_img_dim (*f_i_plin)(i_img *im, i_img_dim l, i_img_dim r, i_img_dim y, const i_color *vals);
  65   i_img_dim (*f_i_glin)(i_img *im, i_img_dim l, i_img_dim r, i_img_dim y, i_color *vals);
  66   i_img_dim (*f_i_plinf)(i_img *im, i_img_dim l, i_img_dim r, i_img_dim y, const i_fcolor *vals);
  67   i_img_dim (*f_i_glinf)(i_img *im, i_img_dim l, i_img_dim r, i_img_dim y, i_fcolor *vals);
  68   i_img_dim (*f_i_gsamp)(i_img *im, i_img_dim l, i_img_dim r, i_img_dim y, i_sample_t *samp,
  69                    const int *chans, int chan_count);
  70   i_img_dim (*f_i_gsampf)(i_img *im, i_img_dim l, i_img_dim r, i_img_dim y, i_fsample_t *samp,
  71                    const int *chans, int chan_count);
  72   i_img_dim (*f_i_gpal)(i_img *im, i_img_dim x, i_img_dim r, i_img_dim y, i_palidx *vals);
  73   i_img_dim (*f_i_ppal)(i_img *im, i_img_dim x, i_img_dim r, i_img_dim y, const i_palidx *vals);
  74   int (*f_i_addcolors)(i_img *im, const i_color *colors, int count);
  75   int (*f_i_getcolors)(i_img *im, int i, i_color *, int count);
  76   int (*f_i_colorcount)(i_img *im);
  77   int (*f_i_maxcolors)(i_img *im);
  78   int (*f_i_findcolor)(i_img *im, const i_color *color, i_palidx *entry);
  79   int (*f_i_setcolors)(i_img *im, int index, const i_color *colors,
  80                        int count);
  81
  82   i_fill_t *(*f_i_new_fill_solid)(const i_color *c, int combine);
  83   i_fill_t *(*f_i_new_fill_solidf)(const i_fcolor *c, int combine);
  84
  85   i_fill_t *(*f_i_new_fill_hatch)(const i_color *fg, const i_color *bg, int combine,
  86                                   int hatch, const unsigned char *cust_hatch,
  87                                   i_img_dim dx, i_img_dim dy);
  88   i_fill_t *(*f_i_new_fill_hatchf)(const i_fcolor *fg, const i_fcolor *bg, int combine,
  89                                   int hatch, const unsigned char *cust_hatch,
  90                                   i_img_dim dx, i_img_dim dy);
  91   i_fill_t *(*f_i_new_fill_image)(i_img *im, const double *matrix, i_img_dim xoff,
  92                                 i_img_dim yoff, int combine);
  93   i_fill_t *(*f_i_new_fill_fount)(double xa, double ya, double xb, double yb,
  94                  i_fountain_type type, i_fountain_repeat repeat,
  95                  int combine, int super_sample, double ssample_param,
  96                  int count, i_fountain_seg *segs);
  97
  98   void (*f_i_fill_destroy)(i_fill_t *fill);
  99
 100   void (*f_i_quant_makemap)(i_quantize *quant, i_img **imgs, int count);
 101   i_palidx * (*f_i_quant_translate)(i_quantize *quant, i_img *img);
 102   void (*f_i_quant_transparent)(i_quantize *quant, i_palidx *indices,
 103                                 i_img *img, i_palidx trans_index);
 104
 105   void (*f_i_clear_error)(void); /* SKIP */
 106   void (*f_i_push_error)(int code, char const *msg); /* SKIP */
 107   void (*f_i_push_errorf)(int code, char const *fmt, ...) I_FORMAT_ATTR(2,3);
 108   void (*f_i_push_errorvf)(int code, char const *fmt, va_list); /* SKIP */
 109
 110   void (*f_i_tags_new)(i_img_tags *tags);
 111   int (*f_i_tags_set)(i_img_tags *tags, char const *name, char const *data,
 112                       int size);
 113   int (*f_i_tags_setn)(i_img_tags *tags, char const *name, int idata);
 114   void (*f_i_tags_destroy)(i_img_tags *tags);
 115   int (*f_i_tags_find)(i_img_tags *tags, char const *name, int start,
 116                        int *entry);
 117   int (*f_i_tags_findn)(i_img_tags *tags, int code, int start, int *entry);
 118   int (*f_i_tags_delete)(i_img_tags *tags, int entry);
 119   int (*f_i_tags_delbyname)(i_img_tags *tags, char const *name);
 120   int (*f_i_tags_delbycode)(i_img_tags *tags, int code);
 121   int (*f_i_tags_get_float)(i_img_tags *tags, char const *name, int code,
 122                             double *value);
 123   int (*f_i_tags_set_float)(i_img_tags *tags, char const *name, int code,
 124                             double value);
 125   int (*f_i_tags_set_float2)(i_img_tags *tags, char const *name, int code,
 126                              double value, int places);
 127   int (*f_i_tags_get_int)(i_img_tags *tags, char const *name, int code,
 128                           int *value);
 129   int (*f_i_tags_get_string)(i_img_tags *tags, char const *name, int code,
 130                              char *value, size_t value_size);
 131   int (*f_i_tags_get_color)(i_img_tags *tags, char const *name, int code,
 132                             i_color *value);
 133   int (*f_i_tags_set_color)(i_img_tags *tags, char const *name, int code,
 134                             i_color const *value);
 135
 136   void (*f_i_box)(i_img *im, i_img_dim x1, i_img_dim y1, i_img_dim x2, i_img_dim y2, const i_color *val);
 137   void (*f_i_box_filled)(i_img *im, i_img_dim x1, i_img_dim y1, i_img_dim x2, i_img_dim y2, const i_color *val);
 138   void (*f_i_box_cfill)(i_img *im, i_img_dim x1, i_img_dim y1, i_img_dim x2, i_img_dim y2, i_fill_t *fill);
 139   void (*f_i_line)(i_img *im, i_img_dim x1, i_img_dim y1, i_img_dim x2, i_img_dim y2, const i_color *val, int endp);
 140   void (*f_i_line_aa)(i_img *im, i_img_dim x1, i_img_dim y1, i_img_dim x2, i_img_dim y2, const i_color *val, int endp);
 141   void (*f_i_arc)(i_img *im, i_img_dim x, i_img_dim y, double rad, double d1, double d2, const i_color *val);
 142   void (*f_i_arc_aa)(i_img *im, double x, double y, double rad, double d1, double d2, const i_color *val);
 143   void (*f_i_arc_cfill)(i_img *im, i_img_dim x, i_img_dim y, double rad, double d1, double d2, i_fill_t *val);
 144   void (*f_i_arc_aa_cfill)(i_img *im, double x, double y, double rad, double d1, double d2, i_fill_t *fill);
 145   void (*f_i_circle_aa)(i_img *im, double x, double y, double rad, const i_color *val);
 146   int (*f_i_flood_fill)(i_img *im, i_img_dim seedx, i_img_dim seedy, const i_color *dcol);
 147   int (*f_i_flood_cfill)(i_img *im, i_img_dim seedx, i_img_dim seedy, i_fill_t *fill);
 148
 149   void (*f_i_copyto)(i_img *im, i_img *src, i_img_dim x1, i_img_dim y1, i_img_dim x2, i_img_dim y2, i_img_dim tx, i_img_dim ty);
 150   void (*f_i_copyto_trans)(i_img *im, i_img *src, i_img_dim x1, i_img_dim y1, i_img_dim x2, i_img_dim y2, i_img_dim tx, i_img_dim ty, const i_color *trans);
 151   i_img *(*f_i_copy)(i_img *im);
 152   int (*f_i_rubthru)(i_img *im, i_img *src, i_img_dim tx, i_img_dim ty, i_img_dim src_minx, i_img_dim src_miny, i_img_dim src_maxx, i_img_dim src_maxy);
 153
 154   /* IMAGER_API_LEVEL 2 functions */
 155   int (*f_i_set_image_file_limits)(i_img_dim width, i_img_dim height, size_t bytes); /* SKIP */
 156   int (*f_i_get_image_file_limits)(i_img_dim *width, i_img_dim *height, size_t *bytes); /* SKIP */
 157   int (*f_i_int_check_image_file_limits)(i_img_dim width, i_img_dim height, int channels, size_t sample_size); /* SKIP */
 158   int (*f_i_flood_fill_border)(i_img *im, i_img_dim seedx, i_img_dim seedy, const i_color *dcol, const i_color *border);
 159   int (*f_i_flood_cfill_border)(i_img *im, i_img_dim seedx, i_img_dim seedy, i_fill_t *fill, const i_color *border);
 160
 161   /* IMAGER_API_LEVEL 3 functions */
 162   void (*f_i_img_setmask)(i_img *im, int ch_mask);
 163   int (*f_i_img_getmask)(i_img *im);
 164   int (*f_i_img_getchannels)(i_img *im);
 165   i_img_dim (*f_i_img_get_width)(i_img *im);
 166   i_img_dim (*f_i_img_get_height)(i_img *im);
 167   void (*f_i_lhead)(const char *file, int line_number);
 168   void (*f_i_loog)(int level, const char *msg, ...) I_FORMAT_ATTR(2,3);
 169
 170   /* IMAGER_API_LEVEL 4 functions will be added here */
 171   i_img *(*f_i_img_alloc)(void); /* SKIP */
 172   void (*f_i_img_init)(i_img *); /* SKIP */
 173
 174   /* IMAGER_API_LEVEL 5 functions will be added here */
 175   /* added i_psampf?_bits macros */
 176   int (*f_i_img_is_monochrome)(i_img *, int *zero_is_white);
 177   int (*f_i_gsamp_bg)(i_img *im, i_img_dim l, i_img_dim r, i_img_dim y, i_sample_t *samples,
 178                       int out_channels, i_color const * bg);
 179   int (*f_i_gsampf_bg)(i_img *im, i_img_dim l, i_img_dim r, i_img_dim y, i_fsample_t *samples,
 180                       int out_channels, i_fcolor const * bg);
 181   int (*f_i_get_file_background)(i_img *im, i_color *bg);
 182   int (*f_i_get_file_backgroundf)(i_img *im, i_fcolor *bg);
 183   unsigned long (*f_i_utf8_advance)(char const **p, size_t *len);
 184   i_render *(*f_i_render_new)(i_img *im, i_img_dim width);
 185   void (*f_i_render_delete)(i_render *r);
 186   void (*f_i_render_color)(i_render *r, i_img_dim x, i_img_dim y,
 187                            i_img_dim width, unsigned char const *src,
 188                            i_color const *color);
 189   void (*f_i_render_fill)(i_render *r, i_img_dim x, i_img_dim y,
 190                           i_img_dim width, unsigned char const *src,
 191                           i_fill_t *fill);
 192   void (*f_i_render_line)(i_render *r, i_img_dim x, i_img_dim y,
 193                           i_img_dim width, const i_sample_t *src,
 194                           i_color *line, i_fill_combine_f combine);
 195   void (*f_i_render_linef)(i_render *r, i_img_dim x, i_img_dim y,
 196                           i_img_dim width, const double *src,
 197                           i_fcolor *line, i_fill_combinef_f combine);
 198
 199   /* Level 6 lost to mis-numbering */
 200   /* IMAGER_API_LEVEL 7 */
 201   int (*f_i_io_getc_imp)(io_glue *ig);
 202   int (*f_i_io_peekc_imp)(io_glue *ig);
 203   ssize_t (*f_i_io_peekn)(io_glue *ig, void *buf, size_t size);
 204   int (*f_i_io_putc_imp)(io_glue *ig, int c);
 205   ssize_t (*f_i_io_read)(io_glue *, void *buf, size_t size);
 206   ssize_t (*f_i_io_write)(io_glue *, const void *buf, size_t size);
 207   off_t (*f_i_io_seek)(io_glue *, off_t offset, int whence);
 208   int (*f_i_io_flush)(io_glue *ig);
 209   int (*f_i_io_close)(io_glue *ig);
 210   int (*f_i_io_set_buffered)(io_glue *ig, int buffered);
 211   ssize_t (*f_i_io_gets)(io_glue *ig, char *, size_t, int);
 212
 213   i_io_glue_t *(*f_io_new_fd)(int fd); /* SKIP */
 214   i_io_glue_t *(*f_io_new_bufchain)(void); /* SKIP */
 215   i_io_glue_t *(*f_io_new_buffer)(const char *data, size_t len, i_io_closebufp_t closecb, void *closedata); /* SKIP */
 216   i_io_glue_t *(*f_io_new_cb)(void *p, i_io_readl_t readcb, i_io_writel_t writecb, i_io_seekl_t seekcb, i_io_closel_t closecb, i_io_destroyl_t destroycb); /* SKIP */
 217   size_t (*f_io_slurp)(i_io_glue_t *ig, unsigned char **c);
 218   void (*f_io_glue_destroy)(i_io_glue_t *ig);
 219
 220   /* IMAGER_API_LEVEL 8 functions will be added here */
 221   i_img *(*f_im_img_8_new)(im_context_t ctx, i_img_dim xsize, i_img_dim ysize, int channels);
 222   i_img *(*f_im_img_16_new)(im_context_t ctx, i_img_dim xsize, i_img_dim ysize, int channels);
 223   i_img *(*f_im_img_double_new)(im_context_t ctx, i_img_dim xsize, i_img_dim ysize, int channels);
 224   i_img *(*f_im_img_pal_new)(im_context_t ctx, i_img_dim xsize, i_img_dim ysize, int channels, int maxpal);
 225
 226   void (*f_im_clear_error)(im_context_t ctx);
 227   void (*f_im_push_error)(im_context_t ctx, int code, char const *msg);
 228   void (*f_im_push_errorvf)(im_context_t ctx, int code, char const *fmt, va_list);
 229   void (*f_im_push_errorf)(im_context_t , int code, char const *fmt, ...) I_FORMAT_ATTR(3,4);
 230
 231   int (*f_im_set_image_file_limits)(im_context_t ctx, i_img_dim width, i_img_dim height, size_t bytes);
 232   int (*f_im_get_image_file_limits)(im_context_t ctx, i_img_dim *width, i_img_dim *height, size_t *bytes);
 233   int (*f_im_int_check_image_file_limits)(im_context_t ctx, i_img_dim width, i_img_dim height, int channels, size_t sample_size);
 234
 235   i_img *(*f_im_img_alloc)(im_context_t ctx);
 236   void (*f_im_img_init)(im_context_t ctx, i_img *);
 237
 238   i_io_glue_t *(*f_im_io_new_fd)(im_context_t ctx, int fd);
 239   i_io_glue_t *(*f_im_io_new_bufchain)(im_context_t ctx);
 240   i_io_glue_t *(*f_im_io_new_buffer)(im_context_t ctx, const char *data, size_t len, i_io_closebufp_t closecb, void *closedata);
 241   i_io_glue_t *(*f_im_io_new_cb)(im_context_t ctx, void *p, i_io_readl_t readcb, i_io_writel_t writecb, i_io_seekl_t seekcb, i_io_closel_t closecb, i_io_destroyl_t destroycb);
 242
 243   im_context_t (*f_im_get_context)(void);
 244
 245   void (*f_im_lhead)( im_context_t, const char *file, int line  );
 246   void (*f_im_loog)(im_context_t, int level,const char *msg, ... ) I_FORMAT_ATTR(3,4);
 247   void (*f_im_context_refinc)(im_context_t, const char *where);
 248   void (*f_im_context_refdec)(im_context_t, const char *where);
 249   i_errmsg *(*f_im_errors)(im_context_t);
 250   i_mutex_t (*f_i_mutex_new)(void);
 251   void (*f_i_mutex_destroy)(i_mutex_t m);
 252   void (*f_i_mutex_lock)(i_mutex_t m);
 253   void (*f_i_mutex_unlock)(i_mutex_t m);
 254   im_slot_t (*f_im_context_slot_new)(im_slot_destroy_t);
 255   int (*f_im_context_slot_set)(im_context_t, im_slot_t, void *);
 256   void *(*f_im_context_slot_get)(im_context_t, im_slot_t);
 257 } im_ext_funcs;
 258
 259 #define PERL_FUNCTION_TABLE_NAME "Imager::__ext_func_table"
 260
 261 #endif