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;
49 =synopsis i_color black;
50 =synopsis black.rgba.r = black.rgba.g = black.rgba.b = black.rgba.a = 0;
52 Type for 8-bit/sample color.
58 i_color is a union of:
64 gray - contains a single element gray_color, eg. C<c.gray.gray_color>
68 C<rgb> - contains three elements C<r>, C<g>, C<b>, eg. C<c.rgb.r>
72 C<rgba> - contains four elements C<r>, C<g>, C<b>, C<a>, eg. C<c.rgba.a>
76 C<cmyk> - contains four elements C<c>, C<m>, C<y>, C<k>,
77 eg. C<c.cmyk.y>. Note that Imager never uses CMYK colors except when
78 reading/writing files.
82 channels - an array of four channels, eg C<c.channels[2]>.
94 i_sample_t channel[MAXCHANNELS];
98 /* this is the larger sample type, it should be able to accurately represent
99 any sample size we use */
100 typedef double i_fsample_t;
102 typedef struct { i_fsample_t gray_color; } i_fgray_color_t;
103 typedef struct { i_fsample_t r, g, b; } i_frgb_color_t;
104 typedef struct { i_fsample_t r, g, b, a; } i_frgba_color_t;
105 typedef struct { i_fsample_t c, m, y, k; } i_fcmyk_color_t;
111 This is the double/sample color type.
113 Its layout exactly corresponds to i_color.
119 i_fgray_color_t gray;
121 i_frgba_color_t rgba;
122 i_fcmyk_color_t cmyk;
123 i_fsample_t channel[MAXCHANNELS];
127 i_direct_type, /* direct colour, keeps RGB values per pixel */
128 i_palette_type /* keeps a palette index per pixel */
132 /* bits per sample, not per pixel */
133 /* a paletted image might have one bit per sample */
136 i_double_bits = sizeof(double) * 8
140 char *name; /* name of a given tag, might be NULL */
141 int code; /* number of a given tag, -1 if it has no meaning */
142 char *data; /* value of a given tag if it's not an int, may be NULL */
143 int size; /* size of the data */
144 int idata; /* value of a given tag if data is NULL */
148 int count; /* how many tags have been set */
149 int alloc; /* how many tags have been allocated for */
153 typedef struct i_img_ i_img;
154 typedef int (*i_f_ppix_t)(i_img *im, i_img_dim x, i_img_dim y, const i_color *pix);
155 typedef int (*i_f_ppixf_t)(i_img *im, i_img_dim x, i_img_dim y, const i_fcolor *pix);
156 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);
157 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);
158 typedef int (*i_f_gpix_t)(i_img *im, i_img_dim x, i_img_dim y, i_color *pix);
159 typedef int (*i_f_gpixf_t)(i_img *im, i_img_dim x, i_img_dim y, i_fcolor *pix);
160 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);
161 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);
163 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,
164 const int *chans, int chan_count);
165 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,
166 const int *chan, int chan_count);
168 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);
169 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);
170 typedef int (*i_f_addcolors_t)(i_img *im, const i_color *colors, int count);
171 typedef int (*i_f_getcolors_t)(i_img *im, int i, i_color *, int count);
172 typedef int (*i_f_colorcount_t)(i_img *im);
173 typedef int (*i_f_maxcolors_t)(i_img *im);
174 typedef int (*i_f_findcolor_t)(i_img *im, const i_color *color, i_palidx *entry);
175 typedef int (*i_f_setcolors_t)(i_img *im, int index, const i_color *colors,
178 typedef void (*i_f_destroy_t)(i_img *im);
180 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,
181 const int *chans, int chan_count, int bits);
182 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,
183 const int *chans, int chan_count, int bits);
185 (*i_f_psamp_t)(i_img *im, i_img_dim x, i_img_dim r, i_img_dim y,
186 const i_sample_t *samp, const int *chan, int chan_count);
188 (*i_f_psampf_t)(i_img *im, i_img_dim x, i_img_dim r, i_img_dim y,
189 const i_fsample_t *samp, const int *chan, int chan_count);
194 =synopsis i_img *img;
197 This is Imager's image type.
199 It contains the following members:
205 C<channels> - the number of channels in the image
209 C<xsize>, C<ysize> - the width and height of the image in pixels
213 C<bytes> - the number of bytes used to store the image data. Undefined
214 where virtual is non-zero.
218 C<ch_mask> - a mask of writable channels. eg. if this is 6 then only
219 channels 1 and 2 are writable. There may be bits set for which there
220 are no channels in the image.
224 C<bits> - the number of bits stored per sample. Should be one of
225 i_8_bits, i_16_bits, i_double_bits.
229 C<type> - either i_direct_type for direct color images, or i_palette_type
234 C<virtual> - if zero then this image is-self contained. If non-zero
235 then this image could be an interface to some other implementation.
239 C<idata> - the image data. This should not be directly accessed. A new
240 image implementation can use this to store its image data.
241 i_img_destroy() will myfree() this pointer if it's non-null.
245 C<tags> - a structure storing the image's tags. This should only be
246 accessed via the i_tags_*() functions.
250 C<ext_data> - a pointer for use internal to an image implementation.
251 This should be freed by the image's destroy handler.
255 C<im_data> - data internal to Imager. This is initialized by
260 i_f_ppix, i_f_ppixf, i_f_plin, i_f_plinf, i_f_gpix, i_f_gpixf,
261 i_f_glin, i_f_glinf, i_f_gsamp, i_f_gampf - implementations for each
262 of the required image functions. An image implementation should
263 initialize these between calling i_img_alloc() and i_img_init().
267 i_f_gpal, i_f_ppal, i_f_addcolors, i_f_getcolors, i_f_colorcount,
268 i_f_maxcolors, i_f_findcolor, i_f_setcolors - implementations for each
269 paletted image function.
273 i_f_destroy - custom image destruction function. This should be used
274 to release memory if necessary.
278 i_f_gsamp_bits - implements i_gsamp_bits() for this image.
282 i_f_psamp_bits - implements i_psamp_bits() for this image.
286 i_f_psamp - implements psamp() for this image.
290 i_f_psampf - implements psamp() for this image.
294 C<im_data> - image specific data internal to Imager.
298 C<context> - the Imager API context this image belongs to.
307 i_img_dim xsize,ysize;
309 unsigned int ch_mask;
312 int virtual; /* image might not keep any data, must use functions */
313 unsigned char *idata; /* renamed to force inspection of existing code */
314 /* can be NULL if virtual is non-zero */
319 /* interface functions */
321 i_f_ppixf_t i_f_ppixf;
323 i_f_plinf_t i_f_plinf;
325 i_f_gpixf_t i_f_gpixf;
327 i_f_glinf_t i_f_glinf;
328 i_f_gsamp_t i_f_gsamp;
329 i_f_gsampf_t i_f_gsampf;
331 /* only valid for type == i_palette_type */
334 i_f_addcolors_t i_f_addcolors;
335 i_f_getcolors_t i_f_getcolors;
336 i_f_colorcount_t i_f_colorcount;
337 i_f_maxcolors_t i_f_maxcolors;
338 i_f_findcolor_t i_f_findcolor;
339 i_f_setcolors_t i_f_setcolors;
341 i_f_destroy_t i_f_destroy;
344 i_f_gsamp_bits_t i_f_gsamp_bits;
345 i_f_psamp_bits_t i_f_psamp_bits;
348 i_f_psamp_t i_f_psamp;
349 i_f_psampf_t i_f_psampf;
354 im_context_t context;
357 /* ext_data for paletted images
360 int count; /* amount of space used in palette (in entries) */
361 int alloc; /* amount of space allocated for palette (in entries) */
367 The types in here so far are:
369 doubly linked bucket list - pretty efficient
370 octtree - no idea about goodness
379 i_img_dim xsize,ysize;
383 struct i_bitmap* btm_new(i_img_dim xsize,i_img_dim ysize);
384 void btm_destroy(struct i_bitmap *btm);
385 int btm_test(struct i_bitmap *btm,i_img_dim x,i_img_dim y);
386 void btm_set(struct i_bitmap *btm,i_img_dim x,i_img_dim y);
389 /* Stack/Linked list */
394 int fill; /* Number used in this link */
399 int multip; /* # of copies in a single chain */
400 size_t ssize; /* size of each small element */
401 int count; /* number of elements on the list */
407 struct llist *llist_new( int multip, size_t ssize );
408 void llist_destroy( struct llist *l );
409 void llist_push( struct llist *l, const void *data );
410 void llist_dump( struct llist *l );
411 int llist_pop( struct llist *l,void *data );
423 struct octt *octt_new(void);
424 int octt_add(struct octt *ct,unsigned char r,unsigned char g,unsigned char b);
425 void octt_dump(struct octt *ct);
426 void octt_count(struct octt *ct,int *tot,int max,int *overflow);
427 void octt_delete(struct octt *ct);
428 void octt_histo(struct octt *ct, unsigned int **col_usage_it_adr);
430 /* font bounding box results */
431 enum bounding_box_index_t {
446 typedef void (*i_fill_with_color_f)
447 (struct i_fill_tag *fill, i_img_dim x, i_img_dim y, i_img_dim width, int channels,
449 typedef void (*i_fill_with_fcolor_f)
450 (struct i_fill_tag *fill, i_img_dim x, i_img_dim y, i_img_dim width, int channels,
452 typedef void (*i_fill_destroy_f)(struct i_fill_tag *fill);
454 /* combine functions modify their target and are permitted to modify
455 the source to prevent having to perform extra copying/memory
457 The out array has I<channels> channels.
459 The in array has I<channels> channels + an alpha channel if one
460 isn't included in I<channels>.
463 typedef void (*i_fill_combine_f)(i_color *out, i_color *in, int channels,
465 typedef void (*i_fill_combinef_f)(i_fcolor *out, i_fcolor *in, int channels,
468 /* fountain fill types */
476 } i_fountain_seg_type;
484 double start, middle, end;
486 i_fountain_seg_type type;
487 i_fountain_color color;
515 =synopsis i_fill_t *fill;
517 This is the "abstract" base type for Imager's fill types.
519 Unless you're implementing a new fill type you'll typically treat this
525 typedef struct i_fill_tag
527 /* called for 8-bit/sample image (and maybe lower) */
528 /* this may be NULL, if so call fill_with_fcolor */
529 i_fill_with_color_f f_fill_with_color;
531 /* called for other sample sizes */
532 /* this must be non-NULL */
533 i_fill_with_fcolor_f f_fill_with_fcolor;
535 /* called if non-NULL to release any extra resources */
536 i_fill_destroy_f destroy;
538 /* if non-zero the caller will fill data with the original data
540 i_fill_combine_f combine;
541 i_fill_combinef_f combinef;
564 =synopsis i_mutex_t mutex;
566 Opaque type for Imager's mutex API.
570 typedef struct i_mutex_tag *i_mutex_t;
573 describes an axis of a MM font.
574 Modelled on FT2's FT_MM_Axis.
575 It would be nice to have a default entry too, but FT2
578 typedef struct i_font_mm_axis_tag {
584 #define IM_FONT_MM_MAX_AXES 4
587 multiple master information for a font, if any
588 modelled on FT2's FT_Multi_Master.
590 typedef struct i_font_mm_tag {
592 int num_designs; /* provided but not necessarily useful */
593 i_font_mm_axis axis[IM_FONT_MM_MAX_AXES];
598 struct TT_Fonthandle_;
600 typedef struct TT_Fonthandle_ TT_Fonthandle;
604 /* transparency handling for quantized output */
605 typedef enum i_transp_tag {
606 tr_none, /* ignore any alpha channel */
607 tr_threshold, /* threshold the transparency - uses tr_threshold */
608 tr_errdiff, /* error diffusion */
609 tr_ordered /* an ordered dither */
612 /* controls how we build the colour map */
613 typedef enum i_make_colors_tag {
614 mc_none, /* user supplied colour map only */
615 mc_web_map, /* Use the 216 colour web colour map */
616 mc_addi, /* Addi's algorithm */
617 mc_median_cut, /* median cut - similar to giflib, hopefully */
618 mc_mono, /* fixed mono color map */
619 mc_gray, /* 256 gray map */
620 mc_gray4, /* four step gray map */
621 mc_gray16, /* sixteen step gray map */
622 mc_mask = 0xFF /* (mask for generator) */
625 /* controls how we translate the colours */
626 typedef enum i_translate_tag {
627 pt_giflib, /* get gif lib to do it (ignores make_colours) */
628 pt_closest, /* just use the closest match within the hashbox */
629 pt_perturb, /* randomly perturb the data - uses perturb_size*/
630 pt_errdiff /* error diffusion dither - uses errdiff */
633 /* Which error diffusion map to use */
634 typedef enum i_errdiff_tag {
635 ed_floyd, /* floyd-steinberg */
636 ed_jarvis, /* Jarvis, Judice and Ninke */
637 ed_stucki, /* Stucki */
638 ed_custom, /* the map found in ed_map|width|height|orig */
639 ed_mask = 0xFF, /* mask to get the map */
640 ed_bidir = 0x100 /* change direction for each row */
643 /* which ordered dither map to use
644 currently only available for transparency
645 I don't know of a way to do ordered dither of an image against some
648 typedef enum i_ord_dith_tag
650 od_random, /* sort of random */
651 od_dot8, /* large dot */
655 od_slashline, /* / line dither */
656 od_backline, /* \ line dither */
657 od_tiny, /* small checkerbox */
658 od_custom /* custom 8x8 map */
661 /* passed into i_writegif_gen() to control quantization */
662 typedef struct i_quantize_tag {
665 /* how to handle transparency */
667 /* the threshold at which to make pixels opaque */
669 i_errdiff tr_errdiff;
670 i_ord_dith tr_orddith;
671 unsigned char tr_custom[64];
673 /* how to make the colour map */
674 i_make_colors make_colors;
676 /* any existing colours
677 mc_existing is an existing colour table
678 mc_count is the number of existing colours
679 mc_size is the total size of the array that mc_existing points
680 at - this must be at least 256
686 /* how we translate the colours */
687 i_translate translate;
689 /* the error diffusion map to use if translate is mc_errdiff */
691 /* the following define the error diffusion values to use if
692 errdiff is ed_custom. ed_orig is the column on the top row that
693 represents the current
696 int ed_width, ed_height, ed_orig;
698 /* the amount of perturbation to use for translate is mc_perturb */
700 /* version 2 members after here */
703 /* distance measures used by some filters */
705 i_dmeasure_euclidean = 0,
706 i_dmeasure_euclidean_squared = 1,
707 i_dmeasure_manhatten = 2,
708 i_dmeasure_limit = 2,
711 #include "iolayert.h"
713 /* error message information returned by im_errors() */
720 typedef struct i_render_tag i_render;
722 #ifdef IMAGER_FORMAT_ATTR
723 #define I_FORMAT_ATTR(format_index, va_index) \
724 __attribute ((format (printf, format_index, va_index)))
726 #define I_FORMAT_ATTR(format_index, va_index)
731 # define vsnprintf _vsnprintf
734 # define snprintf _snprintf
741 =synopsis printf("left %" i_DF "\n", i_DFc(x));
744 This is a constant string that can be used with functions like
745 printf() to format i_img_dim values after they're been cast with i_DFc().
747 Does not include the leading C<%>.
755 Cast an C<i_img_dim> value to a type for use with the i_DF format
762 =synopsis printf("point (" i_DFp ")\n", i_DFcp(x, y));
765 Format a pair of C<i_img_dim> values. This format string I<does>
766 include the leading C<%>.
774 Casts two C<i_img_dim> values for use with the i_DF (or i_DFp) format.
779 #define i_DFc(x) ((i_dim_format_t)(x))
780 #define i_DFcp(x, y) i_DFc(x), i_DFc(y)
781 #define i_DFp "%" i_DF ", %" i_DF