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