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