9 typedef struct im_context_tag *im_context_t;
11 typedef ptrdiff_t im_slot_t;
12 typedef void (*im_slot_destroy_t)(void *);
14 /* used for palette indices in some internal code (which might be
17 typedef unsigned char i_palidx;
19 /* We handle 2 types of sample, this is hopefully the most common, and the
20 smaller of the ones we support */
21 typedef unsigned char i_sample_t;
23 typedef struct { i_sample_t gray_color; } gray_color;
24 typedef struct { i_sample_t r,g,b; } rgb_color;
25 typedef struct { i_sample_t r,g,b,a; } rgba_color;
26 typedef struct { i_sample_t c,m,y,k; } cmyk_color;
28 typedef int undef_int; /* special value to put in typemaps to retun undef on 0 and 1 on 1 */
33 =synopsis i_img_dim x, y;
36 A signed integer type that represents an image dimension or ordinate.
38 May be larger than int on some platforms.
43 typedef ptrdiff_t i_img_dim;
44 typedef size_t i_img_dim_u;
46 #define i_img_dim_MAX ((i_img_dim)(~(i_img_dim_u)0 >> 1))
51 =synopsis i_color black;
52 =synopsis black.rgba.r = black.rgba.g = black.rgba.b = black.rgba.a = 0;
54 Type for 8-bit/sample color.
60 i_color is a union of:
66 gray - contains a single element gray_color, eg. C<c.gray.gray_color>
70 C<rgb> - contains three elements C<r>, C<g>, C<b>, eg. C<c.rgb.r>
74 C<rgba> - contains four elements C<r>, C<g>, C<b>, C<a>, eg. C<c.rgba.a>
78 C<cmyk> - contains four elements C<c>, C<m>, C<y>, C<k>,
79 eg. C<c.cmyk.y>. Note that Imager never uses CMYK colors except when
80 reading/writing files.
84 channels - an array of four channels, eg C<c.channels[2]>.
96 i_sample_t channel[MAXCHANNELS];
100 /* this is the larger sample type, it should be able to accurately represent
101 any sample size we use */
102 typedef double i_fsample_t;
104 typedef struct { i_fsample_t gray_color; } i_fgray_color_t;
105 typedef struct { i_fsample_t r, g, b; } i_frgb_color_t;
106 typedef struct { i_fsample_t r, g, b, a; } i_frgba_color_t;
107 typedef struct { i_fsample_t c, m, y, k; } i_fcmyk_color_t;
113 This is the double/sample color type.
115 Its layout exactly corresponds to i_color.
121 i_fgray_color_t gray;
123 i_frgba_color_t rgba;
124 i_fcmyk_color_t cmyk;
125 i_fsample_t channel[MAXCHANNELS];
129 i_direct_type, /* direct colour, keeps RGB values per pixel */
130 i_palette_type /* keeps a palette index per pixel */
134 /* bits per sample, not per pixel */
135 /* a paletted image might have one bit per sample */
138 i_double_bits = sizeof(double) * 8
142 char *name; /* name of a given tag, might be NULL */
143 int code; /* number of a given tag, -1 if it has no meaning */
144 char *data; /* value of a given tag if it's not an int, may be NULL */
145 int size; /* size of the data */
146 int idata; /* value of a given tag if data is NULL */
150 int count; /* how many tags have been set */
151 int alloc; /* how many tags have been allocated for */
155 typedef struct i_img_ i_img;
156 typedef int (*i_f_ppix_t)(i_img *im, i_img_dim x, i_img_dim y, const i_color *pix);
157 typedef int (*i_f_ppixf_t)(i_img *im, i_img_dim x, i_img_dim y, const i_fcolor *pix);
158 typedef i_img_dim (*i_f_plin_t)(i_img *im, i_img_dim x, i_img_dim r, i_img_dim y, const i_color *vals);
159 typedef i_img_dim (*i_f_plinf_t)(i_img *im, i_img_dim x, i_img_dim r, i_img_dim y, const i_fcolor *vals);
160 typedef int (*i_f_gpix_t)(i_img *im, i_img_dim x, i_img_dim y, i_color *pix);
161 typedef int (*i_f_gpixf_t)(i_img *im, i_img_dim x, i_img_dim y, i_fcolor *pix);
162 typedef i_img_dim (*i_f_glin_t)(i_img *im, i_img_dim x, i_img_dim r, i_img_dim y, i_color *vals);
163 typedef i_img_dim (*i_f_glinf_t)(i_img *im, i_img_dim x, i_img_dim r, i_img_dim y, i_fcolor *vals);
165 typedef i_img_dim (*i_f_gsamp_t)(i_img *im, i_img_dim x, i_img_dim r, i_img_dim y, i_sample_t *samp,
166 const int *chans, int chan_count);
167 typedef i_img_dim (*i_f_gsampf_t)(i_img *im, i_img_dim x, i_img_dim r, i_img_dim y, i_fsample_t *samp,
168 const int *chan, int chan_count);
170 typedef i_img_dim (*i_f_gpal_t)(i_img *im, i_img_dim x, i_img_dim r, i_img_dim y, i_palidx *vals);
171 typedef i_img_dim (*i_f_ppal_t)(i_img *im, i_img_dim x, i_img_dim r, i_img_dim y, const i_palidx *vals);
172 typedef int (*i_f_addcolors_t)(i_img *im, const i_color *colors, int count);
173 typedef int (*i_f_getcolors_t)(i_img *im, int i, i_color *, int count);
174 typedef int (*i_f_colorcount_t)(i_img *im);
175 typedef int (*i_f_maxcolors_t)(i_img *im);
176 typedef int (*i_f_findcolor_t)(i_img *im, const i_color *color, i_palidx *entry);
177 typedef int (*i_f_setcolors_t)(i_img *im, int index, const i_color *colors,
180 typedef void (*i_f_destroy_t)(i_img *im);
182 typedef i_img_dim (*i_f_gsamp_bits_t)(i_img *im, i_img_dim x, i_img_dim r, i_img_dim y, unsigned *samp,
183 const int *chans, int chan_count, int bits);
184 typedef i_img_dim (*i_f_psamp_bits_t)(i_img *im, i_img_dim x, i_img_dim r, i_img_dim y, unsigned const *samp,
185 const int *chans, int chan_count, int bits);
187 (*i_f_psamp_t)(i_img *im, i_img_dim x, i_img_dim r, i_img_dim y,
188 const i_sample_t *samp, const int *chan, int chan_count);
190 (*i_f_psampf_t)(i_img *im, i_img_dim x, i_img_dim r, i_img_dim y,
191 const i_fsample_t *samp, const int *chan, int chan_count);
196 =synopsis i_img *img;
199 This is Imager's image type.
201 It contains the following members:
207 C<channels> - the number of channels in the image
211 C<xsize>, C<ysize> - the width and height of the image in pixels
215 C<bytes> - the number of bytes used to store the image data. Undefined
216 where virtual is non-zero.
220 C<ch_mask> - a mask of writable channels. eg. if this is 6 then only
221 channels 1 and 2 are writable. There may be bits set for which there
222 are no channels in the image.
226 C<bits> - the number of bits stored per sample. Should be one of
227 i_8_bits, i_16_bits, i_double_bits.
231 C<type> - either i_direct_type for direct color images, or i_palette_type
236 C<virtual> - if zero then this image is-self contained. If non-zero
237 then this image could be an interface to some other implementation.
241 C<idata> - the image data. This should not be directly accessed. A new
242 image implementation can use this to store its image data.
243 i_img_destroy() will myfree() this pointer if it's non-null.
247 C<tags> - a structure storing the image's tags. This should only be
248 accessed via the i_tags_*() functions.
252 C<ext_data> - a pointer for use internal to an image implementation.
253 This should be freed by the image's destroy handler.
257 C<im_data> - data internal to Imager. This is initialized by
262 i_f_ppix, i_f_ppixf, i_f_plin, i_f_plinf, i_f_gpix, i_f_gpixf,
263 i_f_glin, i_f_glinf, i_f_gsamp, i_f_gampf - implementations for each
264 of the required image functions. An image implementation should
265 initialize these between calling i_img_alloc() and i_img_init().
269 i_f_gpal, i_f_ppal, i_f_addcolors, i_f_getcolors, i_f_colorcount,
270 i_f_maxcolors, i_f_findcolor, i_f_setcolors - implementations for each
271 paletted image function.
275 i_f_destroy - custom image destruction function. This should be used
276 to release memory if necessary.
280 i_f_gsamp_bits - implements i_gsamp_bits() for this image.
284 i_f_psamp_bits - implements i_psamp_bits() for this image.
288 i_f_psamp - implements psamp() for this image.
292 i_f_psampf - implements psamp() for this image.
296 C<im_data> - image specific data internal to Imager.
300 C<context> - the Imager API context this image belongs to.
309 i_img_dim xsize,ysize;
311 unsigned int ch_mask;
314 int virtual; /* image might not keep any data, must use functions */
315 unsigned char *idata; /* renamed to force inspection of existing code */
316 /* can be NULL if virtual is non-zero */
321 /* interface functions */
323 i_f_ppixf_t i_f_ppixf;
325 i_f_plinf_t i_f_plinf;
327 i_f_gpixf_t i_f_gpixf;
329 i_f_glinf_t i_f_glinf;
330 i_f_gsamp_t i_f_gsamp;
331 i_f_gsampf_t i_f_gsampf;
333 /* only valid for type == i_palette_type */
336 i_f_addcolors_t i_f_addcolors;
337 i_f_getcolors_t i_f_getcolors;
338 i_f_colorcount_t i_f_colorcount;
339 i_f_maxcolors_t i_f_maxcolors;
340 i_f_findcolor_t i_f_findcolor;
341 i_f_setcolors_t i_f_setcolors;
343 i_f_destroy_t i_f_destroy;
346 i_f_gsamp_bits_t i_f_gsamp_bits;
347 i_f_psamp_bits_t i_f_psamp_bits;
350 i_f_psamp_t i_f_psamp;
351 i_f_psampf_t i_f_psampf;
356 im_context_t context;
359 /* ext_data for paletted images
362 int count; /* amount of space used in palette (in entries) */
363 int alloc; /* amount of space allocated for palette (in entries) */
369 The types in here so far are:
371 doubly linked bucket list - pretty efficient
372 octtree - no idea about goodness
381 i_img_dim xsize,ysize;
385 struct i_bitmap* btm_new(i_img_dim xsize,i_img_dim ysize);
386 void btm_destroy(struct i_bitmap *btm);
387 int btm_test(struct i_bitmap *btm,i_img_dim x,i_img_dim y);
388 void btm_set(struct i_bitmap *btm,i_img_dim x,i_img_dim y);
391 /* Stack/Linked list */
396 int fill; /* Number used in this link */
401 int multip; /* # of copies in a single chain */
402 size_t ssize; /* size of each small element */
403 int count; /* number of elements on the list */
409 struct llist *llist_new( int multip, size_t ssize );
410 void llist_destroy( struct llist *l );
411 void llist_push( struct llist *l, const void *data );
412 void llist_dump( struct llist *l );
413 int llist_pop( struct llist *l,void *data );
425 struct octt *octt_new(void);
426 int octt_add(struct octt *ct,unsigned char r,unsigned char g,unsigned char b);
427 void octt_dump(struct octt *ct);
428 void octt_count(struct octt *ct,int *tot,int max,int *overflow);
429 void octt_delete(struct octt *ct);
430 void octt_histo(struct octt *ct, unsigned int **col_usage_it_adr);
432 /* font bounding box results */
433 enum bounding_box_index_t {
448 typedef void (*i_fill_with_color_f)
449 (struct i_fill_tag *fill, i_img_dim x, i_img_dim y, i_img_dim width, int channels,
451 typedef void (*i_fill_with_fcolor_f)
452 (struct i_fill_tag *fill, i_img_dim x, i_img_dim y, i_img_dim width, int channels,
454 typedef void (*i_fill_destroy_f)(struct i_fill_tag *fill);
456 /* combine functions modify their target and are permitted to modify
457 the source to prevent having to perform extra copying/memory
459 The out array has I<channels> channels.
461 The in array has I<channels> channels + an alpha channel if one
462 isn't included in I<channels>.
465 typedef void (*i_fill_combine_f)(i_color *out, i_color *in, int channels,
467 typedef void (*i_fill_combinef_f)(i_fcolor *out, i_fcolor *in, int channels,
470 /* fountain fill types */
478 } i_fountain_seg_type;
486 double start, middle, end;
488 i_fountain_seg_type type;
489 i_fountain_color color;
517 =synopsis i_fill_t *fill;
519 This is the "abstract" base type for Imager's fill types.
521 Unless you're implementing a new fill type you'll typically treat this
527 typedef struct i_fill_tag
529 /* called for 8-bit/sample image (and maybe lower) */
530 /* this may be NULL, if so call fill_with_fcolor */
531 i_fill_with_color_f f_fill_with_color;
533 /* called for other sample sizes */
534 /* this must be non-NULL */
535 i_fill_with_fcolor_f f_fill_with_fcolor;
537 /* called if non-NULL to release any extra resources */
538 i_fill_destroy_f destroy;
540 /* if non-zero the caller will fill data with the original data
542 i_fill_combine_f combine;
543 i_fill_combinef_f combinef;
566 =synopsis i_mutex_t mutex;
568 Opaque type for Imager's mutex API.
572 typedef struct i_mutex_tag *i_mutex_t;
575 describes an axis of a MM font.
576 Modelled on FT2's FT_MM_Axis.
577 It would be nice to have a default entry too, but FT2
580 typedef struct i_font_mm_axis_tag {
586 #define IM_FONT_MM_MAX_AXES 4
589 multiple master information for a font, if any
590 modelled on FT2's FT_Multi_Master.
592 typedef struct i_font_mm_tag {
594 int num_designs; /* provided but not necessarily useful */
595 i_font_mm_axis axis[IM_FONT_MM_MAX_AXES];
600 struct TT_Fonthandle_;
602 typedef struct TT_Fonthandle_ TT_Fonthandle;
606 /* transparency handling for quantized output */
607 typedef enum i_transp_tag {
608 tr_none, /* ignore any alpha channel */
609 tr_threshold, /* threshold the transparency - uses tr_threshold */
610 tr_errdiff, /* error diffusion */
611 tr_ordered /* an ordered dither */
614 /* controls how we build the colour map */
615 typedef enum i_make_colors_tag {
616 mc_none, /* user supplied colour map only */
617 mc_web_map, /* Use the 216 colour web colour map */
618 mc_addi, /* Addi's algorithm */
619 mc_median_cut, /* median cut - similar to giflib, hopefully */
620 mc_mono, /* fixed mono color map */
621 mc_gray, /* 256 gray map */
622 mc_gray4, /* four step gray map */
623 mc_gray16, /* sixteen step gray map */
624 mc_mask = 0xFF /* (mask for generator) */
627 /* controls how we translate the colours */
628 typedef enum i_translate_tag {
629 pt_giflib, /* get gif lib to do it (ignores make_colours) */
630 pt_closest, /* just use the closest match within the hashbox */
631 pt_perturb, /* randomly perturb the data - uses perturb_size*/
632 pt_errdiff /* error diffusion dither - uses errdiff */
635 /* Which error diffusion map to use */
636 typedef enum i_errdiff_tag {
637 ed_floyd, /* floyd-steinberg */
638 ed_jarvis, /* Jarvis, Judice and Ninke */
639 ed_stucki, /* Stucki */
640 ed_custom, /* the map found in ed_map|width|height|orig */
641 ed_mask = 0xFF, /* mask to get the map */
642 ed_bidir = 0x100 /* change direction for each row */
645 /* which ordered dither map to use
646 currently only available for transparency
647 I don't know of a way to do ordered dither of an image against some
650 typedef enum i_ord_dith_tag
652 od_random, /* sort of random */
653 od_dot8, /* large dot */
657 od_slashline, /* / line dither */
658 od_backline, /* \ line dither */
659 od_tiny, /* small checkerbox */
660 od_custom /* custom 8x8 map */
663 /* passed into i_writegif_gen() to control quantization */
664 typedef struct i_quantize_tag {
667 /* how to handle transparency */
669 /* the threshold at which to make pixels opaque */
671 i_errdiff tr_errdiff;
672 i_ord_dith tr_orddith;
673 unsigned char tr_custom[64];
675 /* how to make the colour map */
676 i_make_colors make_colors;
678 /* any existing colours
679 mc_existing is an existing colour table
680 mc_count is the number of existing colours
681 mc_size is the total size of the array that mc_existing points
682 at - this must be at least 256
688 /* how we translate the colours */
689 i_translate translate;
691 /* the error diffusion map to use if translate is mc_errdiff */
693 /* the following define the error diffusion values to use if
694 errdiff is ed_custom. ed_orig is the column on the top row that
695 represents the current
698 int ed_width, ed_height, ed_orig;
700 /* the amount of perturbation to use for translate is mc_perturb */
702 /* version 2 members after here */
705 /* distance measures used by some filters */
707 i_dmeasure_euclidean = 0,
708 i_dmeasure_euclidean_squared = 1,
709 i_dmeasure_manhatten = 2,
710 i_dmeasure_limit = 2,
713 #include "iolayert.h"
715 /* error message information returned by im_errors() */
722 typedef struct i_render_tag i_render;
724 #ifdef IMAGER_FORMAT_ATTR
725 #define I_FORMAT_ATTR(format_index, va_index) \
726 __attribute ((format (printf, format_index, va_index)))
728 #define I_FORMAT_ATTR(format_index, va_index)
733 # define vsnprintf _vsnprintf
736 # define snprintf _snprintf
743 =synopsis printf("left %" i_DF "\n", i_DFc(x));
746 This is a constant string that can be used with functions like
747 printf() to format i_img_dim values after they're been cast with i_DFc().
749 Does not include the leading C<%>.
757 Cast an C<i_img_dim> value to a type for use with the i_DF format
764 =synopsis printf("point (" i_DFp ")\n", i_DFcp(x, y));
767 Format a pair of C<i_img_dim> values. This format string I<does>
768 include the leading C<%>.
776 Casts two C<i_img_dim> values for use with the i_DF (or i_DFp) format.
781 #define i_DFc(x) ((i_dim_format_t)(x))
782 #define i_DFcp(x, y) i_DFc(x), i_DFc(y)
783 #define i_DFp "%" i_DF ", %" i_DF