Move initialization of iterators for bits images to pixman-bits-image.c
[profile/ivi/pixman.git] / pixman / pixman-private.h
1 #ifndef PACKAGE
2 #  error config.h must be included before pixman-private.h
3 #endif
4
5 #ifndef PIXMAN_PRIVATE_H
6 #define PIXMAN_PRIVATE_H
7
8 #define PIXMAN_DISABLE_DEPRECATED
9 #define PIXMAN_USE_INTERNAL_API
10
11 #include "pixman.h"
12 #include <time.h>
13 #include <assert.h>
14 #include <stdio.h>
15 #include <string.h>
16
17 #include "pixman-compiler.h"
18
19 /*
20  * Images
21  */
22 typedef struct image_common image_common_t;
23 typedef struct solid_fill solid_fill_t;
24 typedef struct gradient gradient_t;
25 typedef struct linear_gradient linear_gradient_t;
26 typedef struct horizontal_gradient horizontal_gradient_t;
27 typedef struct vertical_gradient vertical_gradient_t;
28 typedef struct conical_gradient conical_gradient_t;
29 typedef struct radial_gradient radial_gradient_t;
30 typedef struct bits_image bits_image_t;
31 typedef struct circle circle_t;
32
33 typedef void (*fetch_scanline_t) (pixman_image_t *image,
34                                   int             x,
35                                   int             y,
36                                   int             width,
37                                   uint32_t       *buffer,
38                                   const uint32_t *mask);
39
40 typedef uint32_t (*fetch_pixel_32_t) (bits_image_t *image,
41                                       int           x,
42                                       int           y);
43
44 typedef uint64_t (*fetch_pixel_64_t) (bits_image_t *image,
45                                       int           x,
46                                       int           y);
47
48 typedef void (*store_scanline_t) (bits_image_t *  image,
49                                   int             x,
50                                   int             y,
51                                   int             width,
52                                   const uint32_t *values);
53
54 typedef enum
55 {
56     BITS,
57     LINEAR,
58     CONICAL,
59     RADIAL,
60     SOLID
61 } image_type_t;
62
63 typedef enum
64 {
65     SOURCE_IMAGE_CLASS_UNKNOWN,
66     SOURCE_IMAGE_CLASS_HORIZONTAL,
67 } source_image_class_t;
68
69 typedef source_image_class_t (*classify_func_t) (pixman_image_t *image,
70                                                 int             x,
71                                                 int             y,
72                                                 int             width,
73                                                 int             height);
74 typedef void (*property_changed_func_t) (pixman_image_t *image);
75
76 struct image_common
77 {
78     image_type_t                type;
79     int32_t                     ref_count;
80     pixman_region32_t           clip_region;
81     int32_t                     alpha_count;        /* How many times this image is being used as an alpha map */
82     pixman_bool_t               have_clip_region;   /* FALSE if there is no clip */
83     pixman_bool_t               client_clip;        /* Whether the source clip was
84                                                        set by a client */
85     pixman_bool_t               clip_sources;       /* Whether the clip applies when
86                                                      * the image is used as a source
87                                                      */
88     pixman_bool_t               dirty;
89     pixman_transform_t *        transform;
90     pixman_repeat_t             repeat;
91     pixman_filter_t             filter;
92     pixman_fixed_t *            filter_params;
93     int                         n_filter_params;
94     bits_image_t *              alpha_map;
95     int                         alpha_origin_x;
96     int                         alpha_origin_y;
97     pixman_bool_t               component_alpha;
98     classify_func_t             classify;
99     property_changed_func_t     property_changed;
100     fetch_scanline_t            get_scanline_32;
101     fetch_scanline_t            get_scanline_64;
102
103     pixman_image_destroy_func_t destroy_func;
104     void *                      destroy_data;
105
106     uint32_t                    flags;
107     pixman_format_code_t        extended_format_code;
108 };
109
110 struct solid_fill
111 {
112     image_common_t common;
113     pixman_color_t color;
114     
115     uint32_t       color_32;
116     uint64_t       color_64;
117 };
118
119 struct gradient
120 {
121     image_common_t          common;
122     int                     n_stops;
123     pixman_gradient_stop_t *stops;
124 };
125
126 struct linear_gradient
127 {
128     gradient_t           common;
129     pixman_point_fixed_t p1;
130     pixman_point_fixed_t p2;
131 };
132
133 struct circle
134 {
135     pixman_fixed_t x;
136     pixman_fixed_t y;
137     pixman_fixed_t radius;
138 };
139
140 struct radial_gradient
141 {
142     gradient_t common;
143
144     circle_t   c1;
145     circle_t   c2;
146
147     circle_t   delta;
148     double     a;
149     double     inva;
150     double     mindr;
151 };
152
153 struct conical_gradient
154 {
155     gradient_t           common;
156     pixman_point_fixed_t center;
157     double               angle;
158 };
159
160 struct bits_image
161 {
162     image_common_t             common;
163     pixman_format_code_t       format;
164     const pixman_indexed_t *   indexed;
165     int                        width;
166     int                        height;
167     uint32_t *                 bits;
168     uint32_t *                 free_me;
169     int                        rowstride;  /* in number of uint32_t's */
170
171     fetch_scanline_t           fetch_scanline_32;
172     fetch_pixel_32_t           fetch_pixel_32;
173     store_scanline_t           store_scanline_32;
174
175     fetch_scanline_t           fetch_scanline_64;
176     fetch_pixel_64_t           fetch_pixel_64;
177     store_scanline_t           store_scanline_64;
178
179     /* Used for indirect access to the bits */
180     pixman_read_memory_func_t  read_func;
181     pixman_write_memory_func_t write_func;
182 };
183
184 union pixman_image
185 {
186     image_type_t       type;
187     image_common_t     common;
188     bits_image_t       bits;
189     gradient_t         gradient;
190     linear_gradient_t  linear;
191     conical_gradient_t conical;
192     radial_gradient_t  radial;
193     solid_fill_t       solid;
194 };
195
196 typedef struct pixman_iter_t pixman_iter_t;
197 typedef enum
198 {
199     ITER_NARROW = (1 << 0),
200 } iter_flags_t;
201
202 struct pixman_iter_t
203 {
204     uint32_t *(* get_scanline) (pixman_iter_t *iter, const uint32_t *mask);
205     void      (* write_back)   (pixman_iter_t *iter);
206
207     pixman_image_t *    image;
208     uint32_t *          buffer;
209     int                 x, y;
210     int                 width;
211 };
212
213 void
214 _pixman_bits_image_setup_accessors (bits_image_t *image);
215
216 void
217 _pixman_bits_image_src_iter_init (pixman_image_t *image,
218                                   pixman_iter_t *iter,
219                                   int x, int y, int width, int height,
220                                   uint8_t *buffer, iter_flags_t flags);
221 void
222 _pixman_bits_image_dest_iter_init (pixman_image_t *image,
223                                    pixman_iter_t *iter,
224                                    int x, int y, int width, int height,
225                                    uint8_t *buffer, iter_flags_t flags);
226
227 void
228 _pixman_image_get_scanline_generic_64  (pixman_image_t *image,
229                                         int             x,
230                                         int             y,
231                                         int             width,
232                                         uint32_t *      buffer,
233                                         const uint32_t *mask);
234
235 source_image_class_t
236 _pixman_image_classify (pixman_image_t *image,
237                         int             x,
238                         int             y,
239                         int             width,
240                         int             height);
241
242 void
243 _pixman_image_get_scanline_32 (pixman_image_t *image,
244                                int             x,
245                                int             y,
246                                int             width,
247                                uint32_t *      buffer,
248                                const uint32_t *mask);
249
250 /* Even thought the type of buffer is uint32_t *, the function actually expects
251  * a uint64_t *buffer.
252  */
253 void
254 _pixman_image_get_scanline_64 (pixman_image_t *image,
255                                int             x,
256                                int             y,
257                                int             width,
258                                uint32_t *      buffer,
259                                const uint32_t *unused);
260
261 void
262 _pixman_image_store_scanline_32 (bits_image_t *  image,
263                                  int             x,
264                                  int             y,
265                                  int             width,
266                                  const uint32_t *buffer);
267
268 /* Even though the type of buffer is uint32_t *, the function
269  * actually expects a uint64_t *buffer.
270  */
271 void
272 _pixman_image_store_scanline_64 (bits_image_t *  image,
273                                  int             x,
274                                  int             y,
275                                  int             width,
276                                  const uint32_t *buffer);
277
278 pixman_image_t *
279 _pixman_image_allocate (void);
280
281 pixman_bool_t
282 _pixman_init_gradient (gradient_t *                  gradient,
283                        const pixman_gradient_stop_t *stops,
284                        int                           n_stops);
285 void
286 _pixman_image_reset_clip_region (pixman_image_t *image);
287
288 void
289 _pixman_image_validate (pixman_image_t *image);
290
291 uint32_t
292 _pixman_image_get_solid (pixman_image_t *     image,
293                          pixman_format_code_t format);
294
295 #define PIXMAN_IMAGE_GET_LINE(image, x, y, type, out_stride, line, mul) \
296     do                                                                  \
297     {                                                                   \
298         uint32_t *__bits__;                                             \
299         int       __stride__;                                           \
300                                                                         \
301         __bits__ = image->bits.bits;                                    \
302         __stride__ = image->bits.rowstride;                             \
303         (out_stride) =                                                  \
304             __stride__ * (int) sizeof (uint32_t) / (int) sizeof (type); \
305         (line) =                                                        \
306             ((type *) __bits__) + (out_stride) * (y) + (mul) * (x);     \
307     } while (0)
308
309 /*
310  * Gradient walker
311  */
312 typedef struct
313 {
314     uint32_t                left_ag;
315     uint32_t                left_rb;
316     uint32_t                right_ag;
317     uint32_t                right_rb;
318     int32_t                 left_x;
319     int32_t                 right_x;
320     int32_t                 stepper;
321
322     pixman_gradient_stop_t *stops;
323     int                     num_stops;
324     unsigned int            spread;
325
326     int                     need_reset;
327 } pixman_gradient_walker_t;
328
329 void
330 _pixman_gradient_walker_init (pixman_gradient_walker_t *walker,
331                               gradient_t *              gradient,
332                               unsigned int              spread);
333
334 void
335 _pixman_gradient_walker_reset (pixman_gradient_walker_t *walker,
336                                pixman_fixed_32_32_t      pos);
337
338 uint32_t
339 _pixman_gradient_walker_pixel (pixman_gradient_walker_t *walker,
340                                pixman_fixed_32_32_t      x);
341
342 /*
343  * Edges
344  */
345
346 #define MAX_ALPHA(n)    ((1 << (n)) - 1)
347 #define N_Y_FRAC(n)     ((n) == 1 ? 1 : (1 << ((n) / 2)) - 1)
348 #define N_X_FRAC(n)     ((n) == 1 ? 1 : (1 << ((n) / 2)) + 1)
349
350 #define STEP_Y_SMALL(n) (pixman_fixed_1 / N_Y_FRAC (n))
351 #define STEP_Y_BIG(n)   (pixman_fixed_1 - (N_Y_FRAC (n) - 1) * STEP_Y_SMALL (n))
352
353 #define Y_FRAC_FIRST(n) (STEP_Y_BIG (n) / 2)
354 #define Y_FRAC_LAST(n)  (Y_FRAC_FIRST (n) + (N_Y_FRAC (n) - 1) * STEP_Y_SMALL (n))
355
356 #define STEP_X_SMALL(n) (pixman_fixed_1 / N_X_FRAC (n))
357 #define STEP_X_BIG(n)   (pixman_fixed_1 - (N_X_FRAC (n) - 1) * STEP_X_SMALL (n))
358
359 #define X_FRAC_FIRST(n) (STEP_X_BIG (n) / 2)
360 #define X_FRAC_LAST(n)  (X_FRAC_FIRST (n) + (N_X_FRAC (n) - 1) * STEP_X_SMALL (n))
361
362 #define RENDER_SAMPLES_X(x, n)                                          \
363     ((n) == 1? 0 : (pixman_fixed_frac (x) +                             \
364                     X_FRAC_FIRST (n)) / STEP_X_SMALL (n))
365
366 void
367 pixman_rasterize_edges_accessors (pixman_image_t *image,
368                                   pixman_edge_t * l,
369                                   pixman_edge_t * r,
370                                   pixman_fixed_t  t,
371                                   pixman_fixed_t  b);
372
373 /*
374  * Implementations
375  */
376 typedef struct pixman_implementation_t pixman_implementation_t;
377
378 typedef void (*pixman_combine_32_func_t) (pixman_implementation_t *imp,
379                                           pixman_op_t              op,
380                                           uint32_t *               dest,
381                                           const uint32_t *         src,
382                                           const uint32_t *         mask,
383                                           int                      width);
384
385 typedef void (*pixman_combine_64_func_t) (pixman_implementation_t *imp,
386                                           pixman_op_t              op,
387                                           uint64_t *               dest,
388                                           const uint64_t *         src,
389                                           const uint64_t *         mask,
390                                           int                      width);
391
392 typedef void (*pixman_composite_func_t) (pixman_implementation_t *imp,
393                                          pixman_op_t              op,
394                                          pixman_image_t *         src,
395                                          pixman_image_t *         mask,
396                                          pixman_image_t *         dest,
397                                          int32_t                  src_x,
398                                          int32_t                  src_y,
399                                          int32_t                  mask_x,
400                                          int32_t                  mask_y,
401                                          int32_t                  dest_x,
402                                          int32_t                  dest_y,
403                                          int32_t                  width,
404                                          int32_t                  height);
405 typedef pixman_bool_t (*pixman_blt_func_t) (pixman_implementation_t *imp,
406                                             uint32_t *               src_bits,
407                                             uint32_t *               dst_bits,
408                                             int                      src_stride,
409                                             int                      dst_stride,
410                                             int                      src_bpp,
411                                             int                      dst_bpp,
412                                             int                      src_x,
413                                             int                      src_y,
414                                             int                      dst_x,
415                                             int                      dst_y,
416                                             int                      width,
417                                             int                      height);
418 typedef pixman_bool_t (*pixman_fill_func_t) (pixman_implementation_t *imp,
419                                              uint32_t *               bits,
420                                              int                      stride,
421                                              int                      bpp,
422                                              int                      x,
423                                              int                      y,
424                                              int                      width,
425                                              int                      height,
426                                              uint32_t                 xor);
427
428 void _pixman_setup_combiner_functions_32 (pixman_implementation_t *imp);
429 void _pixman_setup_combiner_functions_64 (pixman_implementation_t *imp);
430
431 typedef struct
432 {
433     pixman_op_t             op;
434     pixman_format_code_t    src_format;
435     uint32_t                src_flags;
436     pixman_format_code_t    mask_format;
437     uint32_t                mask_flags;
438     pixman_format_code_t    dest_format;
439     uint32_t                dest_flags;
440     pixman_composite_func_t func;
441 } pixman_fast_path_t;
442
443 struct pixman_implementation_t
444 {
445     pixman_implementation_t *   toplevel;
446     pixman_implementation_t *   delegate;
447     const pixman_fast_path_t *  fast_paths;
448     
449     pixman_blt_func_t           blt;
450     pixman_fill_func_t          fill;
451
452     pixman_combine_32_func_t    combine_32[PIXMAN_N_OPERATORS];
453     pixman_combine_32_func_t    combine_32_ca[PIXMAN_N_OPERATORS];
454     pixman_combine_64_func_t    combine_64[PIXMAN_N_OPERATORS];
455     pixman_combine_64_func_t    combine_64_ca[PIXMAN_N_OPERATORS];
456 };
457
458 pixman_implementation_t *
459 _pixman_implementation_create (pixman_implementation_t *delegate,
460                                const pixman_fast_path_t *fast_paths);
461
462 void
463 _pixman_implementation_combine_32 (pixman_implementation_t *imp,
464                                    pixman_op_t              op,
465                                    uint32_t *               dest,
466                                    const uint32_t *         src,
467                                    const uint32_t *         mask,
468                                    int                      width);
469 void
470 _pixman_implementation_combine_64 (pixman_implementation_t *imp,
471                                    pixman_op_t              op,
472                                    uint64_t *               dest,
473                                    const uint64_t *         src,
474                                    const uint64_t *         mask,
475                                    int                      width);
476 void
477 _pixman_implementation_combine_32_ca (pixman_implementation_t *imp,
478                                       pixman_op_t              op,
479                                       uint32_t *               dest,
480                                       const uint32_t *         src,
481                                       const uint32_t *         mask,
482                                       int                      width);
483 void
484 _pixman_implementation_combine_64_ca (pixman_implementation_t *imp,
485                                       pixman_op_t              op,
486                                       uint64_t *               dest,
487                                       const uint64_t *         src,
488                                       const uint64_t *         mask,
489                                       int                      width);
490
491 pixman_bool_t
492 _pixman_implementation_blt (pixman_implementation_t *imp,
493                             uint32_t *               src_bits,
494                             uint32_t *               dst_bits,
495                             int                      src_stride,
496                             int                      dst_stride,
497                             int                      src_bpp,
498                             int                      dst_bpp,
499                             int                      src_x,
500                             int                      src_y,
501                             int                      dst_x,
502                             int                      dst_y,
503                             int                      width,
504                             int                      height);
505
506 pixman_bool_t
507 _pixman_implementation_fill (pixman_implementation_t *imp,
508                              uint32_t *               bits,
509                              int                      stride,
510                              int                      bpp,
511                              int                      x,
512                              int                      y,
513                              int                      width,
514                              int                      height,
515                              uint32_t                 xor);
516
517 /* Specific implementations */
518 pixman_implementation_t *
519 _pixman_implementation_create_general (void);
520
521 pixman_implementation_t *
522 _pixman_implementation_create_fast_path (void);
523
524 #ifdef USE_MMX
525 pixman_implementation_t *
526 _pixman_implementation_create_mmx (void);
527 #endif
528
529 #ifdef USE_SSE2
530 pixman_implementation_t *
531 _pixman_implementation_create_sse2 (void);
532 #endif
533
534 #ifdef USE_ARM_SIMD
535 pixman_implementation_t *
536 _pixman_implementation_create_arm_simd (void);
537 #endif
538
539 #ifdef USE_ARM_NEON
540 pixman_implementation_t *
541 _pixman_implementation_create_arm_neon (void);
542 #endif
543
544 #ifdef USE_VMX
545 pixman_implementation_t *
546 _pixman_implementation_create_vmx (void);
547 #endif
548
549 pixman_implementation_t *
550 _pixman_choose_implementation (void);
551
552
553
554 /*
555  * Utilities
556  */
557
558 /* These "formats" all have depth 0, so they
559  * will never clash with any real ones
560  */
561 #define PIXMAN_null             PIXMAN_FORMAT (0, 0, 0, 0, 0, 0)
562 #define PIXMAN_solid            PIXMAN_FORMAT (0, 1, 0, 0, 0, 0)
563 #define PIXMAN_pixbuf           PIXMAN_FORMAT (0, 2, 0, 0, 0, 0)
564 #define PIXMAN_rpixbuf          PIXMAN_FORMAT (0, 3, 0, 0, 0, 0)
565 #define PIXMAN_unknown          PIXMAN_FORMAT (0, 4, 0, 0, 0, 0)
566 #define PIXMAN_any              PIXMAN_FORMAT (0, 5, 0, 0, 0, 0)
567
568 #define PIXMAN_OP_any           (PIXMAN_N_OPERATORS + 1)
569
570 #define FAST_PATH_ID_TRANSFORM                  (1 <<  0)
571 #define FAST_PATH_NO_ALPHA_MAP                  (1 <<  1)
572 #define FAST_PATH_NO_CONVOLUTION_FILTER         (1 <<  2)
573 #define FAST_PATH_NO_PAD_REPEAT                 (1 <<  3)
574 #define FAST_PATH_NO_REFLECT_REPEAT             (1 <<  4)
575 #define FAST_PATH_NO_ACCESSORS                  (1 <<  5)
576 #define FAST_PATH_NARROW_FORMAT                 (1 <<  6)
577 #define FAST_PATH_COMPONENT_ALPHA               (1 <<  8)
578 #define FAST_PATH_SAMPLES_OPAQUE                (1 <<  7)
579 #define FAST_PATH_UNIFIED_ALPHA                 (1 <<  9)
580 #define FAST_PATH_SCALE_TRANSFORM               (1 << 10)
581 #define FAST_PATH_NEAREST_FILTER                (1 << 11)
582 #define FAST_PATH_HAS_TRANSFORM                 (1 << 12)
583 #define FAST_PATH_IS_OPAQUE                     (1 << 13)
584 #define FAST_PATH_NO_NORMAL_REPEAT              (1 << 14)
585 #define FAST_PATH_NO_NONE_REPEAT                (1 << 15)
586 #define FAST_PATH_SAMPLES_COVER_CLIP            (1 << 16)
587 #define FAST_PATH_X_UNIT_POSITIVE               (1 << 17)
588 #define FAST_PATH_AFFINE_TRANSFORM              (1 << 18)
589 #define FAST_PATH_Y_UNIT_ZERO                   (1 << 19)
590 #define FAST_PATH_BILINEAR_FILTER               (1 << 20)
591
592 #define FAST_PATH_PAD_REPEAT                                            \
593     (FAST_PATH_NO_NONE_REPEAT           |                               \
594      FAST_PATH_NO_NORMAL_REPEAT         |                               \
595      FAST_PATH_NO_REFLECT_REPEAT)
596
597 #define FAST_PATH_NORMAL_REPEAT                                         \
598     (FAST_PATH_NO_NONE_REPEAT           |                               \
599      FAST_PATH_NO_PAD_REPEAT            |                               \
600      FAST_PATH_NO_REFLECT_REPEAT)
601
602 #define FAST_PATH_NONE_REPEAT                                           \
603     (FAST_PATH_NO_NORMAL_REPEAT         |                               \
604      FAST_PATH_NO_PAD_REPEAT            |                               \
605      FAST_PATH_NO_REFLECT_REPEAT)
606
607 #define FAST_PATH_REFLECT_REPEAT                                        \
608     (FAST_PATH_NO_NONE_REPEAT           |                               \
609      FAST_PATH_NO_NORMAL_REPEAT         |                               \
610      FAST_PATH_NO_PAD_REPEAT)
611
612 #define FAST_PATH_STANDARD_FLAGS                                        \
613     (FAST_PATH_NO_CONVOLUTION_FILTER    |                               \
614      FAST_PATH_NO_ACCESSORS             |                               \
615      FAST_PATH_NO_ALPHA_MAP             |                               \
616      FAST_PATH_NARROW_FORMAT)
617
618 #define FAST_PATH_STD_DEST_FLAGS                                        \
619     (FAST_PATH_NO_ACCESSORS             |                               \
620      FAST_PATH_NO_ALPHA_MAP             |                               \
621      FAST_PATH_NARROW_FORMAT)
622
623 #define SOURCE_FLAGS(format)                                            \
624     (FAST_PATH_STANDARD_FLAGS |                                         \
625      ((PIXMAN_ ## format == PIXMAN_solid) ?                             \
626       0 : (FAST_PATH_SAMPLES_COVER_CLIP | FAST_PATH_ID_TRANSFORM)))
627
628 #define MASK_FLAGS(format, extra)                                       \
629     ((PIXMAN_ ## format == PIXMAN_null) ? 0 : (SOURCE_FLAGS (format) | extra))
630
631 #define FAST_PATH(op, src, src_flags, mask, mask_flags, dest, dest_flags, func) \
632     PIXMAN_OP_ ## op,                                                   \
633     PIXMAN_ ## src,                                                     \
634     src_flags,                                                          \
635     PIXMAN_ ## mask,                                                    \
636     mask_flags,                                                         \
637     PIXMAN_ ## dest,                                                    \
638     dest_flags,                                                         \
639     func
640
641 #define PIXMAN_STD_FAST_PATH(op, src, mask, dest, func)                 \
642     { FAST_PATH (                                                       \
643             op,                                                         \
644             src,  SOURCE_FLAGS (src),                                   \
645             mask, MASK_FLAGS (mask, FAST_PATH_UNIFIED_ALPHA),           \
646             dest, FAST_PATH_STD_DEST_FLAGS,                             \
647             func) }
648
649 #define PIXMAN_STD_FAST_PATH_CA(op, src, mask, dest, func)              \
650     { FAST_PATH (                                                       \
651             op,                                                         \
652             src,  SOURCE_FLAGS (src),                                   \
653             mask, MASK_FLAGS (mask, FAST_PATH_COMPONENT_ALPHA),         \
654             dest, FAST_PATH_STD_DEST_FLAGS,                             \
655             func) }
656
657 /* Memory allocation helpers */
658 void *
659 pixman_malloc_ab (unsigned int n, unsigned int b);
660
661 void *
662 pixman_malloc_abc (unsigned int a, unsigned int b, unsigned int c);
663
664 pixman_bool_t
665 pixman_multiply_overflows_int (unsigned int a, unsigned int b);
666
667 pixman_bool_t
668 pixman_addition_overflows_int (unsigned int a, unsigned int b);
669
670 /* Compositing utilities */
671 void
672 pixman_expand (uint64_t *           dst,
673                const uint32_t *     src,
674                pixman_format_code_t format,
675                int                  width);
676
677 void
678 pixman_contract (uint32_t *      dst,
679                  const uint64_t *src,
680                  int             width);
681
682
683 /* Region Helpers */
684 pixman_bool_t
685 pixman_region32_copy_from_region16 (pixman_region32_t *dst,
686                                     pixman_region16_t *src);
687
688 pixman_bool_t
689 pixman_region16_copy_from_region32 (pixman_region16_t *dst,
690                                     pixman_region32_t *src);
691
692
693 /* Misc macros */
694
695 #ifndef FALSE
696 #   define FALSE 0
697 #endif
698
699 #ifndef TRUE
700 #   define TRUE 1
701 #endif
702
703 #ifndef MIN
704 #  define MIN(a, b) ((a < b) ? a : b)
705 #endif
706
707 #ifndef MAX
708 #  define MAX(a, b) ((a > b) ? a : b)
709 #endif
710
711 /* Integer division that rounds towards -infinity */
712 #define DIV(a, b)                                          \
713     ((((a) < 0) == ((b) < 0)) ? (a) / (b) :                \
714      ((a) - (b) + 1 - (((b) < 0) << 1)) / (b))
715
716 /* Modulus that produces the remainder wrt. DIV */
717 #define MOD(a, b) ((a) < 0 ? ((b) - ((-(a) - 1) % (b))) - 1 : (a) % (b))
718
719 #define CLIP(v, low, high) ((v) < (low) ? (low) : ((v) > (high) ? (high) : (v)))
720
721 /* Conversion between 8888 and 0565 */
722
723 #define CONVERT_8888_TO_0565(s)                                         \
724     ((((s) >> 3) & 0x001f) |                                            \
725      (((s) >> 5) & 0x07e0) |                                            \
726      (((s) >> 8) & 0xf800))
727
728 #define CONVERT_0565_TO_0888(s)                                         \
729     (((((s) << 3) & 0xf8) | (((s) >> 2) & 0x7)) |                       \
730      ((((s) << 5) & 0xfc00) | (((s) >> 1) & 0x300)) |                   \
731      ((((s) << 8) & 0xf80000) | (((s) << 3) & 0x70000)))
732
733 #define CONVERT_0565_TO_8888(s) (CONVERT_0565_TO_0888(s) | 0xff000000)
734
735 /* Trivial versions that are useful in macros */
736 #define CONVERT_8888_TO_8888(s) (s)
737 #define CONVERT_0565_TO_0565(s) (s)
738
739 #define PIXMAN_FORMAT_IS_WIDE(f)                                        \
740     (PIXMAN_FORMAT_A (f) > 8 ||                                         \
741      PIXMAN_FORMAT_R (f) > 8 ||                                         \
742      PIXMAN_FORMAT_G (f) > 8 ||                                         \
743      PIXMAN_FORMAT_B (f) > 8)
744
745 #ifdef WORDS_BIGENDIAN
746 #   define SCREEN_SHIFT_LEFT(x,n)       ((x) << (n))
747 #   define SCREEN_SHIFT_RIGHT(x,n)      ((x) >> (n))
748 #else
749 #   define SCREEN_SHIFT_LEFT(x,n)       ((x) >> (n))
750 #   define SCREEN_SHIFT_RIGHT(x,n)      ((x) << (n))
751 #endif
752
753 /*
754  * Various debugging code
755  */
756
757 #undef DEBUG
758
759 #define COMPILE_TIME_ASSERT(x)                                          \
760     do { typedef int compile_time_assertion [(x)?1:-1]; } while (0)
761
762 /* Turn on debugging depending on what type of release this is
763  */
764 #if (((PIXMAN_VERSION_MICRO % 2) == 0) && ((PIXMAN_VERSION_MINOR % 2) == 1))
765
766 /* Debugging gets turned on for development releases because these
767  * are the things that end up in bleeding edge distributions such
768  * as Rawhide etc.
769  *
770  * For performance reasons we don't turn it on for stable releases or
771  * random git checkouts. (Random git checkouts are often used for
772  * performance work).
773  */
774
775 #    define DEBUG
776
777 #endif
778
779 #ifdef DEBUG
780
781 void
782 _pixman_log_error (const char *function, const char *message);
783
784 #define return_if_fail(expr)                                            \
785     do                                                                  \
786     {                                                                   \
787         if (!(expr))                                                    \
788         {                                                               \
789             _pixman_log_error (FUNC, "The expression " # expr " was false"); \
790             return;                                                     \
791         }                                                               \
792     }                                                                   \
793     while (0)
794
795 #define return_val_if_fail(expr, retval)                                \
796     do                                                                  \
797     {                                                                   \
798         if (!(expr))                                                    \
799         {                                                               \
800             _pixman_log_error (FUNC, "The expression " # expr " was false"); \
801             return (retval);                                            \
802         }                                                               \
803     }                                                                   \
804     while (0)
805
806 #define critical_if_fail(expr)                                          \
807     do                                                                  \
808     {                                                                   \
809         if (!(expr))                                                    \
810             _pixman_log_error (FUNC, "The expression " # expr " was false"); \
811     }                                                                   \
812     while (0)
813
814
815 #else
816
817 #define _pixman_log_error(f,m) do { } while (0)                         \
818
819 #define return_if_fail(expr)                                            \
820     do                                                                  \
821     {                                                                   \
822         if (!(expr))                                                    \
823             return;                                                     \
824     }                                                                   \
825     while (0)
826
827 #define return_val_if_fail(expr, retval)                                \
828     do                                                                  \
829     {                                                                   \
830         if (!(expr))                                                    \
831             return (retval);                                            \
832     }                                                                   \
833     while (0)
834
835 #define critical_if_fail(expr)                                          \
836     do                                                                  \
837     {                                                                   \
838     }                                                                   \
839     while (0)
840 #endif
841
842 /*
843  * Timers
844  */
845
846 #ifdef PIXMAN_TIMERS
847
848 static inline uint64_t
849 oil_profile_stamp_rdtsc (void)
850 {
851     uint64_t ts;
852
853     __asm__ __volatile__ ("rdtsc\n" : "=A" (ts));
854     return ts;
855 }
856
857 #define OIL_STAMP oil_profile_stamp_rdtsc
858
859 typedef struct pixman_timer_t pixman_timer_t;
860
861 struct pixman_timer_t
862 {
863     int             initialized;
864     const char *    name;
865     uint64_t        n_times;
866     uint64_t        total;
867     pixman_timer_t *next;
868 };
869
870 extern int timer_defined;
871
872 void pixman_timer_register (pixman_timer_t *timer);
873
874 #define TIMER_BEGIN(tname)                                              \
875     {                                                                   \
876         static pixman_timer_t timer ## tname;                           \
877         uint64_t              begin ## tname;                           \
878                                                                         \
879         if (!timer ## tname.initialized)                                \
880         {                                                               \
881             timer ## tname.initialized = 1;                             \
882             timer ## tname.name = # tname;                              \
883             pixman_timer_register (&timer ## tname);                    \
884         }                                                               \
885                                                                         \
886         timer ## tname.n_times++;                                       \
887         begin ## tname = OIL_STAMP ();
888
889 #define TIMER_END(tname)                                                \
890     timer ## tname.total += OIL_STAMP () - begin ## tname;              \
891     }
892
893 #endif /* PIXMAN_TIMERS */
894
895 #endif /* PIXMAN_PRIVATE_H */