re-work XS handling of channel lists
[imager.git] / imexttypes.h
CommitLineData
92bda632
TC
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"
8d14daab 7#include <stdarg.h>
92bda632 8
d1f5892c
TC
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.
8d14daab
TC
13
14 Version 2 changed the types of some parameters and pointers. A
15 simple recompile should be enough in most cases.
16
6d5c85a2
TC
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
d1f5892c 22*/
6d5c85a2 23#define IMAGER_API_VERSION 3
d1f5892c
TC
24
25/*
26 IMAGER_API_LEVEL is the level of the structure. New function pointers
27 will always remain at the end (unless IMAGER_API_VERSION changes), and
28 will result in an increment of IMAGER_API_LEVEL.
29*/
30
6d5c85a2 31#define IMAGER_API_LEVEL 7
d1f5892c 32
92bda632 33typedef struct {
d1f5892c
TC
34 int version;
35 int level;
36
37 /* IMAGER_API_LEVEL 1 functions */
8d14daab 38 void * (*f_mymalloc)(size_t size);
92bda632
TC
39 void (*f_myfree)(void *block);
40 void * (*f_myrealloc)(void *block, size_t newsize);
e310e5f9
TC
41 void* (*f_mymalloc_file_line)(size_t size, char* file, int line);
42 void (*f_myfree_file_line)(void *p, char*file, int line);
43 void* (*f_myrealloc_file_line)(void *p, size_t newsize, char* file,int line);
92bda632 44
8d14daab
TC
45 i_img *(*f_i_img_8_new)(i_img_dim xsize, i_img_dim ysize, int channels);
46 i_img *(*f_i_img_16_new)(i_img_dim xsize, i_img_dim ysize, int channels);
47 i_img *(*f_i_img_double_new)(i_img_dim xsize, i_img_dim ysize, int channels);
48 i_img *(*f_i_img_pal_new)(i_img_dim xsize, i_img_dim ysize, int channels, int maxpal);
92bda632 49 void (*f_i_img_destroy)(i_img *im);
8d14daab
TC
50 i_img *(*f_i_sametype)(i_img *im, i_img_dim xsize, i_img_dim ysize);
51 i_img *(*f_i_sametype_chans)(i_img *im, i_img_dim xsize, i_img_dim ysize, int channels);
52 void (*f_i_img_info)(i_img *im, i_img_dim *info);
53
54 int (*f_i_ppix)(i_img *im, i_img_dim x, i_img_dim y, const i_color *val);
55 int (*f_i_gpix)(i_img *im, i_img_dim x, i_img_dim y, i_color *val);
56 int (*f_i_ppixf)(i_img *im, i_img_dim x, i_img_dim y, const i_fcolor *val);
57 int (*f_i_gpixf)(i_img *im, i_img_dim x, i_img_dim y, i_fcolor *val);
58 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);
59 i_img_dim (*f_i_glin)(i_img *im, i_img_dim l, i_img_dim r, i_img_dim y, i_color *vals);
60 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);
61 i_img_dim (*f_i_glinf)(i_img *im, i_img_dim l, i_img_dim r, i_img_dim y, i_fcolor *vals);
62 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,
92bda632 63 const int *chans, int chan_count);
8d14daab 64 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,
92bda632 65 const int *chans, int chan_count);
8d14daab
TC
66 i_img_dim (*f_i_gpal)(i_img *im, i_img_dim x, i_img_dim r, i_img_dim y, i_palidx *vals);
67 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);
97ac0a96 68 int (*f_i_addcolors)(i_img *im, const i_color *colors, int count);
92bda632
TC
69 int (*f_i_getcolors)(i_img *im, int i, i_color *, int count);
70 int (*f_i_colorcount)(i_img *im);
71 int (*f_i_maxcolors)(i_img *im);
97ac0a96
TC
72 int (*f_i_findcolor)(i_img *im, const i_color *color, i_palidx *entry);
73 int (*f_i_setcolors)(i_img *im, int index, const i_color *colors,
92bda632
TC
74 int count);
75
97ac0a96
TC
76 i_fill_t *(*f_i_new_fill_solid)(const i_color *c, int combine);
77 i_fill_t *(*f_i_new_fill_solidf)(const i_fcolor *c, int combine);
92bda632 78
97ac0a96
TC
79 i_fill_t *(*f_i_new_fill_hatch)(const i_color *fg, const i_color *bg, int combine,
80 int hatch, const unsigned char *cust_hatch,
8d14daab 81 i_img_dim dx, i_img_dim dy);
97ac0a96
TC
82 i_fill_t *(*f_i_new_fill_hatchf)(const i_fcolor *fg, const i_fcolor *bg, int combine,
83 int hatch, const unsigned char *cust_hatch,
8d14daab
TC
84 i_img_dim dx, i_img_dim dy);
85 i_fill_t *(*f_i_new_fill_image)(i_img *im, const double *matrix, i_img_dim xoff,
86 i_img_dim yoff, int combine);
92bda632
TC
87 i_fill_t *(*f_i_new_fill_fount)(double xa, double ya, double xb, double yb,
88 i_fountain_type type, i_fountain_repeat repeat,
89 int combine, int super_sample, double ssample_param,
90 int count, i_fountain_seg *segs);
91
92 void (*f_i_fill_destroy)(i_fill_t *fill);
93
94 void (*f_i_quant_makemap)(i_quantize *quant, i_img **imgs, int count);
95 i_palidx * (*f_i_quant_translate)(i_quantize *quant, i_img *img);
96 void (*f_i_quant_transparent)(i_quantize *quant, i_palidx *indices,
97 i_img *img, i_palidx trans_index);
98
99 void (*f_i_clear_error)(void);
100 void (*f_i_push_error)(int code, char const *msg);
101 void (*f_i_push_errorf)(int code, char const *fmt, ...);
102 void (*f_i_push_errorvf)(int code, char const *fmt, va_list);
103
104 void (*f_i_tags_new)(i_img_tags *tags);
105 int (*f_i_tags_set)(i_img_tags *tags, char const *name, char const *data,
106 int size);
107 int (*f_i_tags_setn)(i_img_tags *tags, char const *name, int idata);
108 void (*f_i_tags_destroy)(i_img_tags *tags);
109 int (*f_i_tags_find)(i_img_tags *tags, char const *name, int start,
110 int *entry);
111 int (*f_i_tags_findn)(i_img_tags *tags, int code, int start, int *entry);
112 int (*f_i_tags_delete)(i_img_tags *tags, int entry);
113 int (*f_i_tags_delbyname)(i_img_tags *tags, char const *name);
114 int (*f_i_tags_delbycode)(i_img_tags *tags, int code);
115 int (*f_i_tags_get_float)(i_img_tags *tags, char const *name, int code,
116 double *value);
117 int (*f_i_tags_set_float)(i_img_tags *tags, char const *name, int code,
118 double value);
119 int (*f_i_tags_set_float2)(i_img_tags *tags, char const *name, int code,
120 double value, int places);
121 int (*f_i_tags_get_int)(i_img_tags *tags, char const *name, int code,
122 int *value);
123 int (*f_i_tags_get_string)(i_img_tags *tags, char const *name, int code,
124 char *value, size_t value_size);
125 int (*f_i_tags_get_color)(i_img_tags *tags, char const *name, int code,
126 i_color *value);
127 int (*f_i_tags_set_color)(i_img_tags *tags, char const *name, int code,
128 i_color const *value);
129
8d14daab
TC
130 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);
131 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);
132 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);
133 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);
134 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);
135 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);
97ac0a96 136 void (*f_i_arc_aa)(i_img *im, double x, double y, double rad, double d1, double d2, const i_color *val);
8d14daab 137 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);
92bda632 138 void (*f_i_arc_aa_cfill)(i_img *im, double x, double y, double rad, double d1, double d2, i_fill_t *fill);
8d14daab
TC
139 void (*f_i_circle_aa)(i_img *im, double x, double y, double rad, const i_color *val);
140 int (*f_i_flood_fill)(i_img *im, i_img_dim seedx, i_img_dim seedy, const i_color *dcol);
141 int (*f_i_flood_cfill)(i_img *im, i_img_dim seedx, i_img_dim seedy, i_fill_t *fill);
92bda632 142
8d14daab
TC
143 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);
144 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);
92bda632 145 i_img *(*f_i_copy)(i_img *im);
8d14daab 146 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);
d1f5892c 147
2b405c9e 148 /* IMAGER_API_LEVEL 2 functions */
8d14daab
TC
149 int (*f_i_set_image_file_limits)(i_img_dim width, i_img_dim height, size_t bytes);
150 int (*f_i_get_image_file_limits)(i_img_dim *width, i_img_dim *height, size_t *bytes);
151 int (*f_i_int_check_image_file_limits)(i_img_dim width, i_img_dim height, int channels, size_t sample_size);
152 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);
153 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);
2b405c9e 154
d5477d3d
TC
155 /* IMAGER_API_LEVEL 3 functions */
156 void (*f_i_img_setmask)(i_img *im, int ch_mask);
157 int (*f_i_img_getmask)(i_img *im);
158 int (*f_i_img_getchannels)(i_img *im);
159 i_img_dim (*f_i_img_get_width)(i_img *im);
160 i_img_dim (*f_i_img_get_height)(i_img *im);
161 void (*f_i_lhead)(const char *file, int line_number);
162 void (*f_i_loog)(int level, const char *msg, ...);
163
164 /* IMAGER_API_LEVEL 4 functions will be added here */
bd8052a6
TC
165 i_img *(*f_i_img_alloc)(void);
166 void (*f_i_img_init)(i_img *);
167
168 /* IMAGER_API_LEVEL 5 functions will be added here */
e5ee047b
TC
169 /* added i_psampf?_bits macros */
170 int (*f_i_img_is_monochrome)(i_img *, int *zero_is_white);
8d14daab 171 int (*f_i_gsamp_bg)(i_img *im, i_img_dim l, i_img_dim r, i_img_dim y, i_sample_t *samples,
797a9f9c 172 int out_channels, i_color const * bg);
8d14daab 173 int (*f_i_gsampf_bg)(i_img *im, i_img_dim l, i_img_dim r, i_img_dim y, i_fsample_t *samples,
797a9f9c
TC
174 int out_channels, i_fcolor const * bg);
175 void (*f_i_get_file_background)(i_img *im, i_color *bg);
176 void (*f_i_get_file_backgroundf)(i_img *im, i_fcolor *bg);
718b8c97 177 unsigned long (*f_i_utf8_advance)(char const **p, size_t *len);
50c75381
TC
178 i_render *(*f_i_render_new)(i_img *im, i_img_dim width);
179 void (*f_i_render_delete)(i_render *r);
180 void (*f_i_render_color)(i_render *r, i_img_dim x, i_img_dim y,
181 i_img_dim width, unsigned char const *src,
182 i_color const *color);
183 void (*f_i_render_fill)(i_render *r, i_img_dim x, i_img_dim y,
184 i_img_dim width, unsigned char const *src,
185 i_fill_t *fill);
186 void (*f_i_render_line)(i_render *r, i_img_dim x, i_img_dim y,
187 i_img_dim width, const i_sample_t *src,
188 i_color *line, i_fill_combine_f combine);
189 void (*f_i_render_linef)(i_render *r, i_img_dim x, i_img_dim y,
190 i_img_dim width, const double *src,
191 i_fcolor *line, i_fill_combinef_f combine);
e5ee047b 192
6d5c85a2
TC
193 /* Level 6 lost to mis-numbering */
194 /* IMAGER_API_LEVEL 7 */
195 int (*f_i_io_getc_imp)(io_glue *ig);
196 int (*f_i_io_peekc_imp)(io_glue *ig);
197 ssize_t (*f_i_io_peekn)(io_glue *ig, void *buf, size_t size);
198 int (*f_i_io_putc_imp)(io_glue *ig, int c);
199 ssize_t (*f_i_io_read)(io_glue *, void *buf, size_t size);
200 ssize_t (*f_i_io_write)(io_glue *, const void *buf, size_t size);
201 off_t (*f_i_io_seek)(io_glue *, off_t offset, int whence);
202 int (*f_i_io_flush)(io_glue *ig);
203 int (*f_i_io_close)(io_glue *ig);
204 int (*f_i_io_set_buffered)(io_glue *ig, int buffered);
205 ssize_t (*f_i_io_gets)(io_glue *ig, char *, size_t, int);
206
207 i_io_glue_t *(*f_io_new_fd)(int fd);
208 i_io_glue_t *(*f_io_new_bufchain)(void);
209 i_io_glue_t *(*f_io_new_buffer)(const char *data, size_t len, i_io_closebufp_t closecb, void *closedata);
210 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);
211 size_t (*f_io_slurp)(i_io_glue_t *ig, unsigned char **c);
212 void (*f_io_glue_destroy)(i_io_glue_t *ig);
213
214 /* IMAGER_API_LEVEL 8 functions will be added here */
215
92bda632
TC
216} im_ext_funcs;
217
218#define PERL_FUNCTION_TABLE_NAME "Imager::__ext_func_table"
219
220#endif