Various changes:
[imager.git] / imdatatypes.h
CommitLineData
02d1d628
AMH
1#ifndef _DATATYPES_H_
2#define _DATATYPES_H_
3
7ac6a2e9 4#include "imio.h"
92bda632 5#include "imconfig.h"
02d1d628
AMH
6
7#define MAXCHANNELS 4
8
faa9b3e7
TC
9/* used for palette indices in some internal code (which might be
10 exposed at some point
11*/
12typedef unsigned char i_palidx;
13
14/* We handle 2 types of sample, this is hopefully the most common, and the
15 smaller of the ones we support */
16typedef unsigned char i_sample_t;
17
18typedef struct { i_sample_t gray_color; } gray_color;
19typedef struct { i_sample_t r,g,b; } rgb_color;
20typedef struct { i_sample_t r,g,b,a; } rgba_color;
21typedef struct { i_sample_t c,m,y,k; } cmyk_color;
02d1d628
AMH
22
23typedef int undef_int; /* special value to put in typemaps to retun undef on 0 and 1 on 1 */
24
25typedef union {
26 gray_color gray;
27 rgb_color rgb;
28 rgba_color rgba;
29 cmyk_color cmyk;
faa9b3e7 30 i_sample_t channel[MAXCHANNELS];
02d1d628
AMH
31 unsigned int ui;
32} i_color;
33
faa9b3e7
TC
34/* this is the larger sample type, it should be able to accurately represent
35 any sample size we use */
36typedef double i_fsample_t;
02d1d628 37
faa9b3e7
TC
38typedef struct { i_fsample_t gray_color; } i_fgray_color_t;
39typedef struct { i_fsample_t r, g, b; } i_frgb_color_t;
40typedef struct { i_fsample_t r, g, b, a; } i_frgba_color_t;
41typedef struct { i_fsample_t c, m, y, k; } i_fcmyk_color_t;
42
43typedef union {
44 i_fgray_color_t gray;
45 i_frgb_color_t rgb;
46 i_frgba_color_t rgba;
47 i_fcmyk_color_t cmyk;
48 i_fsample_t channel[MAXCHANNELS];
49} i_fcolor;
50
51typedef enum {
52 i_direct_type, /* direct colour, keeps RGB values per pixel */
26fd367b 53 i_palette_type /* keeps a palette index per pixel */
faa9b3e7
TC
54} i_img_type_t;
55
56typedef enum {
57 /* bits per sample, not per pixel */
58 /* a paletted image might have one bit per sample */
59 i_8_bits = 8,
60 i_16_bits = 16,
26fd367b 61 i_double_bits = sizeof(double) * 8
faa9b3e7
TC
62} i_img_bits_t;
63
64typedef struct {
65 char *name; /* name of a given tag, might be NULL */
66 int code; /* number of a given tag, -1 if it has no meaning */
67 char *data; /* value of a given tag if it's not an int, may be NULL */
68 int size; /* size of the data */
69 int idata; /* value of a given tag if data is NULL */
70} i_img_tag;
71
72typedef struct {
73 int count; /* how many tags have been set */
74 int alloc; /* how many tags have been allocated for */
75 i_img_tag *tags;
76} i_img_tags;
77
78typedef struct i_img_ i_img;
97ac0a96
TC
79typedef int (*i_f_ppix_t)(i_img *im, int x, int y, const i_color *pix);
80typedef int (*i_f_ppixf_t)(i_img *im, int x, int y, const i_fcolor *pix);
81typedef int (*i_f_plin_t)(i_img *im, int x, int r, int y, const i_color *vals);
82typedef int (*i_f_plinf_t)(i_img *im, int x, int r, int y, const i_fcolor *vals);
faa9b3e7
TC
83typedef int (*i_f_gpix_t)(i_img *im, int x, int y, i_color *pix);
84typedef int (*i_f_gpixf_t)(i_img *im, int x, int y, i_fcolor *pix);
85typedef int (*i_f_glin_t)(i_img *im, int x, int r, int y, i_color *vals);
86typedef int (*i_f_glinf_t)(i_img *im, int x, int r, int y, i_fcolor *vals);
87
88typedef int (*i_f_gsamp_t)(i_img *im, int x, int r, int y, i_sample_t *samp,
18accb2a 89 const int *chans, int chan_count);
faa9b3e7 90typedef int (*i_f_gsampf_t)(i_img *im, int x, int r, int y, i_fsample_t *samp,
18accb2a 91 const int *chan, int chan_count);
faa9b3e7
TC
92
93typedef int (*i_f_gpal_t)(i_img *im, int x, int r, int y, i_palidx *vals);
97ac0a96
TC
94typedef int (*i_f_ppal_t)(i_img *im, int x, int r, int y, const i_palidx *vals);
95typedef int (*i_f_addcolors_t)(i_img *im, const i_color *colors, int count);
faa9b3e7
TC
96typedef int (*i_f_getcolors_t)(i_img *im, int i, i_color *, int count);
97typedef int (*i_f_colorcount_t)(i_img *im);
98typedef int (*i_f_maxcolors_t)(i_img *im);
97ac0a96
TC
99typedef int (*i_f_findcolor_t)(i_img *im, const i_color *color, i_palidx *entry);
100typedef int (*i_f_setcolors_t)(i_img *im, int index, const i_color *colors,
faa9b3e7
TC
101 int count);
102
103typedef void (*i_f_destroy_t)(i_img *im);
104
105struct i_img_ {
02d1d628
AMH
106 int channels;
107 int xsize,ysize,bytes;
02d1d628 108 unsigned int ch_mask;
faa9b3e7
TC
109 i_img_bits_t bits;
110 i_img_type_t type;
111 int virtual; /* image might not keep any data, must use functions */
112 unsigned char *idata; /* renamed to force inspection of existing code */
113 /* can be NULL if virtual is non-zero */
114 i_img_tags tags;
02d1d628 115
02d1d628 116 void *ext_data;
02d1d628 117
faa9b3e7
TC
118 /* interface functions */
119 i_f_ppix_t i_f_ppix;
120 i_f_ppixf_t i_f_ppixf;
121 i_f_plin_t i_f_plin;
122 i_f_plinf_t i_f_plinf;
123 i_f_gpix_t i_f_gpix;
124 i_f_gpixf_t i_f_gpixf;
125 i_f_glin_t i_f_glin;
126 i_f_glinf_t i_f_glinf;
127 i_f_gsamp_t i_f_gsamp;
128 i_f_gsampf_t i_f_gsampf;
129
130 /* only valid for type == i_palette_type */
131 i_f_gpal_t i_f_gpal;
132 i_f_ppal_t i_f_ppal;
133 i_f_addcolors_t i_f_addcolors;
134 i_f_getcolors_t i_f_getcolors;
135 i_f_colorcount_t i_f_colorcount;
136 i_f_maxcolors_t i_f_maxcolors;
137 i_f_findcolor_t i_f_findcolor;
138 i_f_setcolors_t i_f_setcolors;
139
140 i_f_destroy_t i_f_destroy;
141};
02d1d628 142
faa9b3e7
TC
143/* ext_data for paletted images
144 */
145typedef struct {
146 int count; /* amount of space used in palette (in entries) */
147 int alloc; /* amount of space allocated for palette (in entries) */
148 i_color *pal;
149 int last_found;
150} i_img_pal_ext;
02d1d628 151
faa9b3e7 152/* Helper datatypes
02d1d628
AMH
153 The types in here so far are:
154
155 doubly linked bucket list - pretty efficient
156 octtree - no idea about goodness
157
158 needed: hashes.
159
160*/
161
162
163
164
165
166/* bitmap mask */
167
168struct i_bitmap {
169 int xsize,ysize;
170 char *data;
171};
172
173struct i_bitmap* btm_new(int xsize,int ysize);
174void btm_destroy(struct i_bitmap *btm);
175int btm_test(struct i_bitmap *btm,int x,int y);
176void btm_set(struct i_bitmap *btm,int x,int y);
177
178
179
180
181
182
183
184
185/* Stack/Linked list */
186
187struct llink {
188 struct llink *p,*n;
189 void *data;
190 int fill; /* Number used in this link */
191};
192
193struct llist {
194 struct llink *h,*t;
195 int multip; /* # of copies in a single chain */
196 int ssize; /* size of each small element */
197 int count; /* number of elements on the list */
198};
199
200
201/* Links */
202
203struct llink *llink_new( struct llink* p,int size );
204int llist_llink_push( struct llist *lst, struct llink *lnk, void *data );
205
206/* Lists */
207
208struct llist *llist_new( int multip, int ssize );
209void llist_destroy( struct llist *l );
210void llist_push( struct llist *l, void *data );
211void llist_dump( struct llist *l );
212int llist_pop( struct llist *l,void *data );
213
214
215
216
217/* Octtree */
218
219struct octt {
220 struct octt *t[8];
221 int cnt;
222};
223
faa9b3e7 224struct octt *octt_new(void);
02d1d628
AMH
225int octt_add(struct octt *ct,unsigned char r,unsigned char g,unsigned char b);
226void octt_dump(struct octt *ct);
227void octt_count(struct octt *ct,int *tot,int max,int *overflow);
228void octt_delete(struct octt *ct);
229
3799c4d1
TC
230/* font bounding box results */
231enum bounding_box_index_t {
232 BBOX_NEG_WIDTH,
233 BBOX_GLOBAL_DESCENT,
234 BBOX_POS_WIDTH,
235 BBOX_GLOBAL_ASCENT,
236 BBOX_DESCENT,
237 BBOX_ASCENT,
238 BBOX_ADVANCE_WIDTH,
dc35bde9 239 BBOX_RIGHT_BEARING,
3799c4d1
TC
240 BOUNDING_BOX_COUNT
241};
242
92bda632
TC
243/* Generic fills */
244struct i_fill_tag;
245
246typedef void (*i_fill_with_color_f)
247 (struct i_fill_tag *fill, int x, int y, int width, int channels,
248 i_color *data);
249typedef void (*i_fill_with_fcolor_f)
250 (struct i_fill_tag *fill, int x, int y, int width, int channels,
251 i_fcolor *data);
252typedef void (*i_fill_destroy_f)(struct i_fill_tag *fill);
253typedef void (*i_fill_combine_f)(i_color *out, i_color *in, int channels,
254 int count);
255typedef void (*i_fill_combinef_f)(i_fcolor *out, i_fcolor *in, int channels,
256 int count);
257
258/* fountain fill types */
259typedef enum {
260 i_fst_linear,
261 i_fst_curved,
262 i_fst_sine,
263 i_fst_sphere_up,
264 i_fst_sphere_down,
265 i_fst_end
266} i_fountain_seg_type;
267typedef enum {
268 i_fc_direct,
269 i_fc_hue_up,
270 i_fc_hue_down,
271 i_fc_end
272} i_fountain_color;
273typedef struct {
274 double start, middle, end;
275 i_fcolor c[2];
276 i_fountain_seg_type type;
277 i_fountain_color color;
278} i_fountain_seg;
279typedef enum {
280 i_fr_none,
281 i_fr_sawtooth,
282 i_fr_triangle,
283 i_fr_saw_both,
284 i_fr_tri_both
285} i_fountain_repeat;
286typedef enum {
287 i_ft_linear,
288 i_ft_bilinear,
289 i_ft_radial,
290 i_ft_radial_square,
291 i_ft_revolution,
292 i_ft_conical,
293 i_ft_end
294} i_fountain_type;
295typedef enum {
296 i_fts_none,
297 i_fts_grid,
298 i_fts_random,
299 i_fts_circle
300} i_ft_supersample;
301
302
303typedef struct i_fill_tag
304{
305 /* called for 8-bit/sample image (and maybe lower) */
306 /* this may be NULL, if so call fill_with_fcolor */
307 i_fill_with_color_f fill_with_color;
308
309 /* called for other sample sizes */
310 /* this must be non-NULL */
311 i_fill_with_fcolor_f fill_with_fcolor;
312
313 /* called if non-NULL to release any extra resources */
314 i_fill_destroy_f destroy;
315
316 /* if non-zero the caller will fill data with the original data
317 from the image */
318 i_fill_combine_f combine;
319 i_fill_combinef_f combinef;
320} i_fill_t;
321
322typedef enum {
323 ic_none,
324 ic_normal,
325 ic_multiply,
326 ic_dissolve,
327 ic_add,
328 ic_subtract,
329 ic_diff,
330 ic_lighten,
331 ic_darken,
332 ic_hue,
333 ic_sat,
334 ic_value,
335 ic_color
336} i_combine_t;
337
338/*
339 describes an axis of a MM font.
340 Modelled on FT2's FT_MM_Axis.
341 It would be nice to have a default entry too, but FT2
342 doesn't support it.
343*/
344typedef struct i_font_mm_axis_tag {
345 char const *name;
346 int minimum;
347 int maximum;
348} i_font_mm_axis;
349
350#define IM_FONT_MM_MAX_AXES 4
351
352/*
353 multiple master information for a font, if any
354 modelled on FT2's FT_Multi_Master.
355*/
356typedef struct i_font_mm_tag {
357 int num_axis;
358 int num_designs; /* provided but not necessarily useful */
359 i_font_mm_axis axis[IM_FONT_MM_MAX_AXES];
360} i_font_mm;
361
362#ifdef HAVE_LIBTT
363
364struct TT_Fonthandle_;
365
366typedef struct TT_Fonthandle_ TT_Fonthandle;
367
368#endif
369
370#ifdef HAVE_FT2
371
372typedef struct FT2_Fonthandle FT2_Fonthandle;
373
374#endif
375
376/* transparency handling for quantized output */
377typedef enum i_transp_tag {
378 tr_none, /* ignore any alpha channel */
379 tr_threshold, /* threshold the transparency - uses tr_threshold */
380 tr_errdiff, /* error diffusion */
381 tr_ordered /* an ordered dither */
382} i_transp;
383
384/* controls how we build the colour map */
385typedef enum i_make_colors_tag {
386 mc_none, /* user supplied colour map only */
387 mc_web_map, /* Use the 216 colour web colour map */
388 mc_addi, /* Addi's algorithm */
389 mc_median_cut, /* median cut - similar to giflib, hopefully */
9c106321 390 mc_mono, /* fixed mono color map */
92bda632
TC
391 mc_mask = 0xFF /* (mask for generator) */
392} i_make_colors;
393
394/* controls how we translate the colours */
395typedef enum i_translate_tag {
396 pt_giflib, /* get gif lib to do it (ignores make_colours) */
397 pt_closest, /* just use the closest match within the hashbox */
398 pt_perturb, /* randomly perturb the data - uses perturb_size*/
399 pt_errdiff /* error diffusion dither - uses errdiff */
400} i_translate;
401
402/* Which error diffusion map to use */
403typedef enum i_errdiff_tag {
404 ed_floyd, /* floyd-steinberg */
405 ed_jarvis, /* Jarvis, Judice and Ninke */
406 ed_stucki, /* Stucki */
407 ed_custom, /* the map found in ed_map|width|height|orig */
408 ed_mask = 0xFF, /* mask to get the map */
409 ed_bidir = 0x100 /* change direction for each row */
410} i_errdiff;
411
412/* which ordered dither map to use
413 currently only available for transparency
414 I don't know of a way to do ordered dither of an image against some
415 general palette
416 */
417typedef enum i_ord_dith_tag
418{
419 od_random, /* sort of random */
420 od_dot8, /* large dot */
421 od_dot4,
422 od_hline,
423 od_vline,
424 od_slashline, /* / line dither */
425 od_backline, /* \ line dither */
426 od_tiny, /* small checkerbox */
427 od_custom /* custom 8x8 map */
428} i_ord_dith;
429
430typedef struct i_gif_pos_tag {
431 int x, y;
432} i_gif_pos;
433
434/* passed into i_writegif_gen() to control quantization */
435typedef struct i_quantize_tag {
436 /* how to handle transparency */
437 i_transp transp;
438 /* the threshold at which to make pixels opaque */
439 int tr_threshold;
440 i_errdiff tr_errdiff;
441 i_ord_dith tr_orddith;
442 unsigned char tr_custom[64];
443
444 /* how to make the colour map */
445 i_make_colors make_colors;
446
447 /* any existing colours
448 mc_existing is an existing colour table
449 mc_count is the number of existing colours
450 mc_size is the total size of the array that mc_existing points
451 at - this must be at least 256
452 */
453 i_color *mc_colors;
454 int mc_size;
455 int mc_count;
456
457 /* how we translate the colours */
458 i_translate translate;
459
460 /* the error diffusion map to use if translate is mc_errdiff */
461 i_errdiff errdiff;
462 /* the following define the error diffusion values to use if
463 errdiff is ed_custom. ed_orig is the column on the top row that
464 represents the current
465 */
466 int *ed_map;
467 int ed_width, ed_height, ed_orig;
468
469 /* the amount of perturbation to use for translate is mc_perturb */
470 int perturb;
471} i_quantize;
472
473typedef struct i_gif_opts {
474 /* each image has a local color map */
475 int each_palette;
476
477 /* images are interlaced */
478 int interlace;
479
480 /* time for which image is displayed
481 (in 1/100 seconds)
482 default: 0
483 */
484 int delay_count;
485 int *delays;
486
487 /* user input flags
488 default: 0
489 */
490 int user_input_count;
491 char *user_input_flags;
492
493 /* disposal
494 default: 0 */
495 int disposal_count;
496 char *disposal;
497
498 /* this is added to the color table when we make an image transparent */
499 i_color tran_color;
500
501 /* image positions */
502 int position_count;
503 i_gif_pos *positions;
504
505 /* Netscape loop extension - number of loops */
506 int loop_count;
507
508 /* should be eliminate unused colors? */
509 int eliminate_unused;
510} i_gif_opts;
511
e310e5f9
TC
512/* distance measures used by some filters */
513enum {
514 i_dmeasure_euclidean = 0,
515 i_dmeasure_euclidean_squared = 1,
516 i_dmeasure_manhatten = 2,
517 i_dmeasure_limit = 2,
518};
92bda632 519
0778adbf 520#include "iolayert.h"
92bda632 521
9c106321
TC
522#include "rendert.h"
523
02d1d628
AMH
524#endif
525