9 typedef struct im_context_tag *im_context_t;
11 /* used for palette indices in some internal code (which might be
14 typedef unsigned char i_palidx;
16 /* We handle 2 types of sample, this is hopefully the most common, and the
17 smaller of the ones we support */
18 typedef unsigned char i_sample_t;
20 typedef struct { i_sample_t gray_color; } gray_color;
21 typedef struct { i_sample_t r,g,b; } rgb_color;
22 typedef struct { i_sample_t r,g,b,a; } rgba_color;
23 typedef struct { i_sample_t c,m,y,k; } cmyk_color;
25 typedef int undef_int; /* special value to put in typemaps to retun undef on 0 and 1 on 1 */
30 =synopsis i_img_dim x, y;
33 A signed integer type that represents an image dimension or ordinate.
35 May be larger than int on some platforms.
40 typedef ptrdiff_t i_img_dim;
45 =synopsis i_color black;
46 =synopsis black.rgba.r = black.rgba.g = black.rgba.b = black.rgba.a = 0;
48 Type for 8-bit/sample color.
54 i_color is a union of:
60 gray - contains a single element gray_color, eg. C<c.gray.gray_color>
64 C<rgb> - contains three elements C<r>, C<g>, C<b>, eg. C<c.rgb.r>
68 C<rgba> - contains four elements C<r>, C<g>, C<b>, C<a>, eg. C<c.rgba.a>
72 C<cmyk> - contains four elements C<c>, C<m>, C<y>, C<k>,
73 eg. C<c.cmyk.y>. Note that Imager never uses CMYK colors except when
74 reading/writing files.
78 channels - an array of four channels, eg C<c.channels[2]>.
90 i_sample_t channel[MAXCHANNELS];
94 /* this is the larger sample type, it should be able to accurately represent
95 any sample size we use */
96 typedef double i_fsample_t;
98 typedef struct { i_fsample_t gray_color; } i_fgray_color_t;
99 typedef struct { i_fsample_t r, g, b; } i_frgb_color_t;
100 typedef struct { i_fsample_t r, g, b, a; } i_frgba_color_t;
101 typedef struct { i_fsample_t c, m, y, k; } i_fcmyk_color_t;
107 This is the double/sample color type.
109 Its layout exactly corresponds to i_color.
115 i_fgray_color_t gray;
117 i_frgba_color_t rgba;
118 i_fcmyk_color_t cmyk;
119 i_fsample_t channel[MAXCHANNELS];
123 i_direct_type, /* direct colour, keeps RGB values per pixel */
124 i_palette_type /* keeps a palette index per pixel */
128 /* bits per sample, not per pixel */
129 /* a paletted image might have one bit per sample */
132 i_double_bits = sizeof(double) * 8
136 char *name; /* name of a given tag, might be NULL */
137 int code; /* number of a given tag, -1 if it has no meaning */
138 char *data; /* value of a given tag if it's not an int, may be NULL */
139 int size; /* size of the data */
140 int idata; /* value of a given tag if data is NULL */
144 int count; /* how many tags have been set */
145 int alloc; /* how many tags have been allocated for */
149 typedef struct i_img_ i_img;
150 typedef int (*i_f_ppix_t)(i_img *im, i_img_dim x, i_img_dim y, const i_color *pix);
151 typedef int (*i_f_ppixf_t)(i_img *im, i_img_dim x, i_img_dim y, const i_fcolor *pix);
152 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);
153 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);
154 typedef int (*i_f_gpix_t)(i_img *im, i_img_dim x, i_img_dim y, i_color *pix);
155 typedef int (*i_f_gpixf_t)(i_img *im, i_img_dim x, i_img_dim y, i_fcolor *pix);
156 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);
157 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);
159 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,
160 const int *chans, int chan_count);
161 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,
162 const int *chan, int chan_count);
164 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);
165 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);
166 typedef int (*i_f_addcolors_t)(i_img *im, const i_color *colors, int count);
167 typedef int (*i_f_getcolors_t)(i_img *im, int i, i_color *, int count);
168 typedef int (*i_f_colorcount_t)(i_img *im);
169 typedef int (*i_f_maxcolors_t)(i_img *im);
170 typedef int (*i_f_findcolor_t)(i_img *im, const i_color *color, i_palidx *entry);
171 typedef int (*i_f_setcolors_t)(i_img *im, int index, const i_color *colors,
174 typedef void (*i_f_destroy_t)(i_img *im);
176 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,
177 const int *chans, int chan_count, int bits);
178 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,
179 const int *chans, int chan_count, int bits);
181 (*i_f_psamp_t)(i_img *im, i_img_dim x, i_img_dim r, i_img_dim y,
182 const i_sample_t *samp, const int *chan, int chan_count);
184 (*i_f_psampf_t)(i_img *im, i_img_dim x, i_img_dim r, i_img_dim y,
185 const i_fsample_t *samp, const int *chan, int chan_count);
190 =synopsis i_img *img;
193 This is Imager's image type.
195 It contains the following members:
201 C<channels> - the number of channels in the image
205 C<xsize>, C<ysize> - the width and height of the image in pixels
209 C<bytes> - the number of bytes used to store the image data. Undefined
210 where virtual is non-zero.
214 C<ch_mask> - a mask of writable channels. eg. if this is 6 then only
215 channels 1 and 2 are writable. There may be bits set for which there
216 are no channels in the image.
220 C<bits> - the number of bits stored per sample. Should be one of
221 i_8_bits, i_16_bits, i_double_bits.
225 C<type> - either i_direct_type for direct color images, or i_palette_type
230 C<virtual> - if zero then this image is-self contained. If non-zero
231 then this image could be an interface to some other implementation.
235 C<idata> - the image data. This should not be directly accessed. A new
236 image implementation can use this to store its image data.
237 i_img_destroy() will myfree() this pointer if it's non-null.
241 C<tags> - a structure storing the image's tags. This should only be
242 accessed via the i_tags_*() functions.
246 C<ext_data> - a pointer for use internal to an image implementation.
247 This should be freed by the image's destroy handler.
251 C<im_data> - data internal to Imager. This is initialized by
256 i_f_ppix, i_f_ppixf, i_f_plin, i_f_plinf, i_f_gpix, i_f_gpixf,
257 i_f_glin, i_f_glinf, i_f_gsamp, i_f_gampf - implementations for each
258 of the required image functions. An image implementation should
259 initialize these between calling i_img_alloc() and i_img_init().
263 i_f_gpal, i_f_ppal, i_f_addcolors, i_f_getcolors, i_f_colorcount,
264 i_f_maxcolors, i_f_findcolor, i_f_setcolors - implementations for each
265 paletted image function.
269 i_f_destroy - custom image destruction function. This should be used
270 to release memory if necessary.
274 i_f_gsamp_bits - implements i_gsamp_bits() for this image.
278 i_f_psamp_bits - implements i_psamp_bits() for this image.
282 i_f_psamp - implements psamp() for this image.
286 i_f_psampf - implements psamp() for this image.
290 C<im_data> - image specific data internal to Imager.
294 C<context> - the Imager API context this image belongs to.
303 i_img_dim xsize,ysize;
305 unsigned int ch_mask;
308 int virtual; /* image might not keep any data, must use functions */
309 unsigned char *idata; /* renamed to force inspection of existing code */
310 /* can be NULL if virtual is non-zero */
315 /* interface functions */
317 i_f_ppixf_t i_f_ppixf;
319 i_f_plinf_t i_f_plinf;
321 i_f_gpixf_t i_f_gpixf;
323 i_f_glinf_t i_f_glinf;
324 i_f_gsamp_t i_f_gsamp;
325 i_f_gsampf_t i_f_gsampf;
327 /* only valid for type == i_palette_type */
330 i_f_addcolors_t i_f_addcolors;
331 i_f_getcolors_t i_f_getcolors;
332 i_f_colorcount_t i_f_colorcount;
333 i_f_maxcolors_t i_f_maxcolors;
334 i_f_findcolor_t i_f_findcolor;
335 i_f_setcolors_t i_f_setcolors;
337 i_f_destroy_t i_f_destroy;
340 i_f_gsamp_bits_t i_f_gsamp_bits;
341 i_f_psamp_bits_t i_f_psamp_bits;
344 i_f_psamp_t i_f_psamp;
345 i_f_psampf_t i_f_psampf;
350 im_context_t context;
353 /* ext_data for paletted images
356 int count; /* amount of space used in palette (in entries) */
357 int alloc; /* amount of space allocated for palette (in entries) */
363 The types in here so far are:
365 doubly linked bucket list - pretty efficient
366 octtree - no idea about goodness
375 i_img_dim xsize,ysize;
379 struct i_bitmap* btm_new(i_img_dim xsize,i_img_dim ysize);
380 void btm_destroy(struct i_bitmap *btm);
381 int btm_test(struct i_bitmap *btm,i_img_dim x,i_img_dim y);
382 void btm_set(struct i_bitmap *btm,i_img_dim x,i_img_dim y);
385 /* Stack/Linked list */
390 int fill; /* Number used in this link */
395 int multip; /* # of copies in a single chain */
396 size_t ssize; /* size of each small element */
397 int count; /* number of elements on the list */
403 struct llist *llist_new( int multip, size_t ssize );
404 void llist_destroy( struct llist *l );
405 void llist_push( struct llist *l, const void *data );
406 void llist_dump( struct llist *l );
407 int llist_pop( struct llist *l,void *data );
419 struct octt *octt_new(void);
420 int octt_add(struct octt *ct,unsigned char r,unsigned char g,unsigned char b);
421 void octt_dump(struct octt *ct);
422 void octt_count(struct octt *ct,int *tot,int max,int *overflow);
423 void octt_delete(struct octt *ct);
424 void octt_histo(struct octt *ct, unsigned int **col_usage_it_adr);
426 /* font bounding box results */
427 enum bounding_box_index_t {
442 typedef void (*i_fill_with_color_f)
443 (struct i_fill_tag *fill, i_img_dim x, i_img_dim y, i_img_dim width, int channels,
445 typedef void (*i_fill_with_fcolor_f)
446 (struct i_fill_tag *fill, i_img_dim x, i_img_dim y, i_img_dim width, int channels,
448 typedef void (*i_fill_destroy_f)(struct i_fill_tag *fill);
450 /* combine functions modify their target and are permitted to modify
451 the source to prevent having to perform extra copying/memory
453 The out array has I<channels> channels.
455 The in array has I<channels> channels + an alpha channel if one
456 isn't included in I<channels>.
459 typedef void (*i_fill_combine_f)(i_color *out, i_color *in, int channels,
461 typedef void (*i_fill_combinef_f)(i_fcolor *out, i_fcolor *in, int channels,
464 /* fountain fill types */
472 } i_fountain_seg_type;
480 double start, middle, end;
482 i_fountain_seg_type type;
483 i_fountain_color color;
511 =synopsis i_fill_t *fill;
513 This is the "abstract" base type for Imager's fill types.
515 Unless you're implementing a new fill type you'll typically treat this
521 typedef struct i_fill_tag
523 /* called for 8-bit/sample image (and maybe lower) */
524 /* this may be NULL, if so call fill_with_fcolor */
525 i_fill_with_color_f f_fill_with_color;
527 /* called for other sample sizes */
528 /* this must be non-NULL */
529 i_fill_with_fcolor_f f_fill_with_fcolor;
531 /* called if non-NULL to release any extra resources */
532 i_fill_destroy_f destroy;
534 /* if non-zero the caller will fill data with the original data
536 i_fill_combine_f combine;
537 i_fill_combinef_f combinef;
557 describes an axis of a MM font.
558 Modelled on FT2's FT_MM_Axis.
559 It would be nice to have a default entry too, but FT2
562 typedef struct i_font_mm_axis_tag {
568 #define IM_FONT_MM_MAX_AXES 4
571 multiple master information for a font, if any
572 modelled on FT2's FT_Multi_Master.
574 typedef struct i_font_mm_tag {
576 int num_designs; /* provided but not necessarily useful */
577 i_font_mm_axis axis[IM_FONT_MM_MAX_AXES];
582 struct TT_Fonthandle_;
584 typedef struct TT_Fonthandle_ TT_Fonthandle;
588 /* transparency handling for quantized output */
589 typedef enum i_transp_tag {
590 tr_none, /* ignore any alpha channel */
591 tr_threshold, /* threshold the transparency - uses tr_threshold */
592 tr_errdiff, /* error diffusion */
593 tr_ordered /* an ordered dither */
596 /* controls how we build the colour map */
597 typedef enum i_make_colors_tag {
598 mc_none, /* user supplied colour map only */
599 mc_web_map, /* Use the 216 colour web colour map */
600 mc_addi, /* Addi's algorithm */
601 mc_median_cut, /* median cut - similar to giflib, hopefully */
602 mc_mono, /* fixed mono color map */
603 mc_gray, /* 256 gray map */
604 mc_gray4, /* four step gray map */
605 mc_gray16, /* sixteen step gray map */
606 mc_mask = 0xFF /* (mask for generator) */
609 /* controls how we translate the colours */
610 typedef enum i_translate_tag {
611 pt_giflib, /* get gif lib to do it (ignores make_colours) */
612 pt_closest, /* just use the closest match within the hashbox */
613 pt_perturb, /* randomly perturb the data - uses perturb_size*/
614 pt_errdiff /* error diffusion dither - uses errdiff */
617 /* Which error diffusion map to use */
618 typedef enum i_errdiff_tag {
619 ed_floyd, /* floyd-steinberg */
620 ed_jarvis, /* Jarvis, Judice and Ninke */
621 ed_stucki, /* Stucki */
622 ed_custom, /* the map found in ed_map|width|height|orig */
623 ed_mask = 0xFF, /* mask to get the map */
624 ed_bidir = 0x100 /* change direction for each row */
627 /* which ordered dither map to use
628 currently only available for transparency
629 I don't know of a way to do ordered dither of an image against some
632 typedef enum i_ord_dith_tag
634 od_random, /* sort of random */
635 od_dot8, /* large dot */
639 od_slashline, /* / line dither */
640 od_backline, /* \ line dither */
641 od_tiny, /* small checkerbox */
642 od_custom /* custom 8x8 map */
645 /* passed into i_writegif_gen() to control quantization */
646 typedef struct i_quantize_tag {
649 /* how to handle transparency */
651 /* the threshold at which to make pixels opaque */
653 i_errdiff tr_errdiff;
654 i_ord_dith tr_orddith;
655 unsigned char tr_custom[64];
657 /* how to make the colour map */
658 i_make_colors make_colors;
660 /* any existing colours
661 mc_existing is an existing colour table
662 mc_count is the number of existing colours
663 mc_size is the total size of the array that mc_existing points
664 at - this must be at least 256
670 /* how we translate the colours */
671 i_translate translate;
673 /* the error diffusion map to use if translate is mc_errdiff */
675 /* the following define the error diffusion values to use if
676 errdiff is ed_custom. ed_orig is the column on the top row that
677 represents the current
680 int ed_width, ed_height, ed_orig;
682 /* the amount of perturbation to use for translate is mc_perturb */
684 /* version 2 members after here */
687 /* distance measures used by some filters */
689 i_dmeasure_euclidean = 0,
690 i_dmeasure_euclidean_squared = 1,
691 i_dmeasure_manhatten = 2,
692 i_dmeasure_limit = 2,
695 #include "iolayert.h"
697 typedef struct i_render_tag i_render;
699 #ifdef IMAGER_FORMAT_ATTR
700 #define I_FORMAT_ATTR(format_index, va_index) \
701 __attribute ((format (printf, format_index, va_index)))
703 #define I_FORMAT_ATTR(format_index, va_index)
708 # define vsnprintf _vsnprintf
711 # define snprintf _snprintf
718 =synopsis printf("left %" i_DF "\n", i_DFc(x));
721 This is a constant string that can be used with functions like
722 printf() to format i_img_dim values after they're been cast with i_DFc().
724 Does not include the leading C<%>.
732 Cast an C<i_img_dim> value to a type for use with the i_DF format
739 =synopsis printf("point (" i_DFp ")\n", i_DFcp(x, y));
742 Format a pair of C<i_img_dim> values. This format string I<does>
743 include the leading C<%>.
751 Casts two C<i_img_dim> values for use with the i_DF (or i_DFp) format.
756 #define i_DFc(x) ((i_dim_format_t)(x))
757 #define i_DFcp(x, y) i_DFc(x), i_DFc(y)
758 #define i_DFp "%" i_DF ", %" i_DF