Add direct-write optimization back
[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_flags_t;
207
208 struct pixman_iter_t
209 {
210     uint32_t *(* get_scanline) (pixman_iter_t *iter, const uint32_t *mask);
211     void      (* write_back)   (pixman_iter_t *iter);
212
213     pixman_image_t *    image;
214     uint32_t *          buffer;
215     int                 x, y;
216     int                 width;
217 };
218
219 void
220 _pixman_bits_image_setup_accessors (bits_image_t *image);
221
222 void
223 _pixman_bits_image_src_iter_init (pixman_image_t *image,
224                                   pixman_iter_t *iter,
225                                   int x, int y, int width, int height,
226                                   uint8_t *buffer, iter_flags_t flags);
227 void
228 _pixman_bits_image_dest_iter_init (pixman_image_t *image,
229                                    pixman_iter_t *iter,
230                                    int x, int y, int width, int height,
231                                    uint8_t *buffer, iter_flags_t flags);
232
233 void
234 _pixman_solid_fill_iter_init (pixman_image_t *image,
235                               pixman_iter_t  *iter,
236                               int x, int y, int width, int height,
237                               uint8_t *buffer, iter_flags_t flags);
238
239 void
240 _pixman_linear_gradient_iter_init (pixman_image_t *image,
241                                    pixman_iter_t  *iter,
242                                    int x, int y, int width, int height,
243                                    uint8_t *buffer, iter_flags_t flags);
244
245 void
246 _pixman_radial_gradient_iter_init (pixman_image_t *image,
247                                    pixman_iter_t *iter,
248                                    int x, int y, int width, int height,
249                                    uint8_t *buffer, iter_flags_t flags);
250
251 void
252 _pixman_conical_gradient_iter_init (pixman_image_t *image,
253                                     pixman_iter_t *iter,
254                                     int x, int y, int width, int height,
255                                     uint8_t *buffer, iter_flags_t flags);
256
257 pixman_image_t *
258 _pixman_image_allocate (void);
259
260 pixman_bool_t
261 _pixman_init_gradient (gradient_t *                  gradient,
262                        const pixman_gradient_stop_t *stops,
263                        int                           n_stops);
264 void
265 _pixman_image_reset_clip_region (pixman_image_t *image);
266
267 void
268 _pixman_image_validate (pixman_image_t *image);
269
270 #define PIXMAN_IMAGE_GET_LINE(image, x, y, type, out_stride, line, mul) \
271     do                                                                  \
272     {                                                                   \
273         uint32_t *__bits__;                                             \
274         int       __stride__;                                           \
275                                                                         \
276         __bits__ = image->bits.bits;                                    \
277         __stride__ = image->bits.rowstride;                             \
278         (out_stride) =                                                  \
279             __stride__ * (int) sizeof (uint32_t) / (int) sizeof (type); \
280         (line) =                                                        \
281             ((type *) __bits__) + (out_stride) * (y) + (mul) * (x);     \
282     } while (0)
283
284 /*
285  * Gradient walker
286  */
287 typedef struct
288 {
289     uint32_t                left_ag;
290     uint32_t                left_rb;
291     uint32_t                right_ag;
292     uint32_t                right_rb;
293     int32_t                 left_x;
294     int32_t                 right_x;
295     int32_t                 stepper;
296
297     pixman_gradient_stop_t *stops;
298     int                     num_stops;
299     unsigned int            spread;
300
301     int                     need_reset;
302 } pixman_gradient_walker_t;
303
304 void
305 _pixman_gradient_walker_init (pixman_gradient_walker_t *walker,
306                               gradient_t *              gradient,
307                               unsigned int              spread);
308
309 void
310 _pixman_gradient_walker_reset (pixman_gradient_walker_t *walker,
311                                pixman_fixed_32_32_t      pos);
312
313 uint32_t
314 _pixman_gradient_walker_pixel (pixman_gradient_walker_t *walker,
315                                pixman_fixed_32_32_t      x);
316
317 /*
318  * Edges
319  */
320
321 #define MAX_ALPHA(n)    ((1 << (n)) - 1)
322 #define N_Y_FRAC(n)     ((n) == 1 ? 1 : (1 << ((n) / 2)) - 1)
323 #define N_X_FRAC(n)     ((n) == 1 ? 1 : (1 << ((n) / 2)) + 1)
324
325 #define STEP_Y_SMALL(n) (pixman_fixed_1 / N_Y_FRAC (n))
326 #define STEP_Y_BIG(n)   (pixman_fixed_1 - (N_Y_FRAC (n) - 1) * STEP_Y_SMALL (n))
327
328 #define Y_FRAC_FIRST(n) (STEP_Y_BIG (n) / 2)
329 #define Y_FRAC_LAST(n)  (Y_FRAC_FIRST (n) + (N_Y_FRAC (n) - 1) * STEP_Y_SMALL (n))
330
331 #define STEP_X_SMALL(n) (pixman_fixed_1 / N_X_FRAC (n))
332 #define STEP_X_BIG(n)   (pixman_fixed_1 - (N_X_FRAC (n) - 1) * STEP_X_SMALL (n))
333
334 #define X_FRAC_FIRST(n) (STEP_X_BIG (n) / 2)
335 #define X_FRAC_LAST(n)  (X_FRAC_FIRST (n) + (N_X_FRAC (n) - 1) * STEP_X_SMALL (n))
336
337 #define RENDER_SAMPLES_X(x, n)                                          \
338     ((n) == 1? 0 : (pixman_fixed_frac (x) +                             \
339                     X_FRAC_FIRST (n)) / STEP_X_SMALL (n))
340
341 void
342 pixman_rasterize_edges_accessors (pixman_image_t *image,
343                                   pixman_edge_t * l,
344                                   pixman_edge_t * r,
345                                   pixman_fixed_t  t,
346                                   pixman_fixed_t  b);
347
348 /*
349  * Implementations
350  */
351 typedef struct pixman_implementation_t pixman_implementation_t;
352
353 typedef void (*pixman_combine_32_func_t) (pixman_implementation_t *imp,
354                                           pixman_op_t              op,
355                                           uint32_t *               dest,
356                                           const uint32_t *         src,
357                                           const uint32_t *         mask,
358                                           int                      width);
359
360 typedef void (*pixman_combine_64_func_t) (pixman_implementation_t *imp,
361                                           pixman_op_t              op,
362                                           uint64_t *               dest,
363                                           const uint64_t *         src,
364                                           const uint64_t *         mask,
365                                           int                      width);
366
367 typedef void (*pixman_composite_func_t) (pixman_implementation_t *imp,
368                                          pixman_op_t              op,
369                                          pixman_image_t *         src,
370                                          pixman_image_t *         mask,
371                                          pixman_image_t *         dest,
372                                          int32_t                  src_x,
373                                          int32_t                  src_y,
374                                          int32_t                  mask_x,
375                                          int32_t                  mask_y,
376                                          int32_t                  dest_x,
377                                          int32_t                  dest_y,
378                                          int32_t                  width,
379                                          int32_t                  height);
380 typedef pixman_bool_t (*pixman_blt_func_t) (pixman_implementation_t *imp,
381                                             uint32_t *               src_bits,
382                                             uint32_t *               dst_bits,
383                                             int                      src_stride,
384                                             int                      dst_stride,
385                                             int                      src_bpp,
386                                             int                      dst_bpp,
387                                             int                      src_x,
388                                             int                      src_y,
389                                             int                      dst_x,
390                                             int                      dst_y,
391                                             int                      width,
392                                             int                      height);
393 typedef pixman_bool_t (*pixman_fill_func_t) (pixman_implementation_t *imp,
394                                              uint32_t *               bits,
395                                              int                      stride,
396                                              int                      bpp,
397                                              int                      x,
398                                              int                      y,
399                                              int                      width,
400                                              int                      height,
401                                              uint32_t                 xor);
402 typedef void (*pixman_iter_init_func_t) (pixman_implementation_t *imp,
403                                          pixman_iter_t           *iter,
404                                          pixman_image_t          *image,
405                                          int                      x,
406                                          int                      y,
407                                          int                      width,
408                                          int                      height,
409                                          uint8_t                 *buffer,
410                                          iter_flags_t             flags);
411
412 void _pixman_setup_combiner_functions_32 (pixman_implementation_t *imp);
413 void _pixman_setup_combiner_functions_64 (pixman_implementation_t *imp);
414
415 typedef struct
416 {
417     pixman_op_t             op;
418     pixman_format_code_t    src_format;
419     uint32_t                src_flags;
420     pixman_format_code_t    mask_format;
421     uint32_t                mask_flags;
422     pixman_format_code_t    dest_format;
423     uint32_t                dest_flags;
424     pixman_composite_func_t func;
425 } pixman_fast_path_t;
426
427 struct pixman_implementation_t
428 {
429     pixman_implementation_t *   toplevel;
430     pixman_implementation_t *   delegate;
431     const pixman_fast_path_t *  fast_paths;
432
433     pixman_blt_func_t           blt;
434     pixman_fill_func_t          fill;
435     pixman_iter_init_func_t     src_iter_init;
436     pixman_iter_init_func_t     dest_iter_init;
437
438     pixman_combine_32_func_t    combine_32[PIXMAN_N_OPERATORS];
439     pixman_combine_32_func_t    combine_32_ca[PIXMAN_N_OPERATORS];
440     pixman_combine_64_func_t    combine_64[PIXMAN_N_OPERATORS];
441     pixman_combine_64_func_t    combine_64_ca[PIXMAN_N_OPERATORS];
442 };
443
444 uint32_t
445 _pixman_image_get_solid (pixman_implementation_t *imp,
446                          pixman_image_t *         image,
447                          pixman_format_code_t     format);
448
449 pixman_implementation_t *
450 _pixman_implementation_create (pixman_implementation_t *delegate,
451                                const pixman_fast_path_t *fast_paths);
452
453 void
454 _pixman_implementation_combine_32 (pixman_implementation_t *imp,
455                                    pixman_op_t              op,
456                                    uint32_t *               dest,
457                                    const uint32_t *         src,
458                                    const uint32_t *         mask,
459                                    int                      width);
460 void
461 _pixman_implementation_combine_64 (pixman_implementation_t *imp,
462                                    pixman_op_t              op,
463                                    uint64_t *               dest,
464                                    const uint64_t *         src,
465                                    const uint64_t *         mask,
466                                    int                      width);
467 void
468 _pixman_implementation_combine_32_ca (pixman_implementation_t *imp,
469                                       pixman_op_t              op,
470                                       uint32_t *               dest,
471                                       const uint32_t *         src,
472                                       const uint32_t *         mask,
473                                       int                      width);
474 void
475 _pixman_implementation_combine_64_ca (pixman_implementation_t *imp,
476                                       pixman_op_t              op,
477                                       uint64_t *               dest,
478                                       const uint64_t *         src,
479                                       const uint64_t *         mask,
480                                       int                      width);
481
482 pixman_bool_t
483 _pixman_implementation_blt (pixman_implementation_t *imp,
484                             uint32_t *               src_bits,
485                             uint32_t *               dst_bits,
486                             int                      src_stride,
487                             int                      dst_stride,
488                             int                      src_bpp,
489                             int                      dst_bpp,
490                             int                      src_x,
491                             int                      src_y,
492                             int                      dst_x,
493                             int                      dst_y,
494                             int                      width,
495                             int                      height);
496
497 pixman_bool_t
498 _pixman_implementation_fill (pixman_implementation_t *imp,
499                              uint32_t *               bits,
500                              int                      stride,
501                              int                      bpp,
502                              int                      x,
503                              int                      y,
504                              int                      width,
505                              int                      height,
506                              uint32_t                 xor);
507
508 void
509 _pixman_implementation_src_iter_init (pixman_implementation_t       *imp,
510                                       pixman_iter_t                 *iter,
511                                       pixman_image_t                *image,
512                                       int                            x,
513                                       int                            y,
514                                       int                            width,
515                                       int                            height,
516                                       uint8_t                       *buffer,
517                                       iter_flags_t                   flags);
518
519 void
520 _pixman_implementation_dest_iter_init (pixman_implementation_t       *imp,
521                                        pixman_iter_t                 *iter,
522                                        pixman_image_t                *image,
523                                        int                            x,
524                                        int                            y,
525                                        int                            width,
526                                        int                            height,
527                                        uint8_t                       *buffer,
528                                        iter_flags_t                   flags);
529
530 /* Specific implementations */
531 pixman_implementation_t *
532 _pixman_implementation_create_general (void);
533
534 pixman_implementation_t *
535 _pixman_implementation_create_fast_path (void);
536
537 #ifdef USE_MMX
538 pixman_implementation_t *
539 _pixman_implementation_create_mmx (void);
540 #endif
541
542 #ifdef USE_SSE2
543 pixman_implementation_t *
544 _pixman_implementation_create_sse2 (void);
545 #endif
546
547 #ifdef USE_ARM_SIMD
548 pixman_implementation_t *
549 _pixman_implementation_create_arm_simd (void);
550 #endif
551
552 #ifdef USE_ARM_NEON
553 pixman_implementation_t *
554 _pixman_implementation_create_arm_neon (void);
555 #endif
556
557 #ifdef USE_VMX
558 pixman_implementation_t *
559 _pixman_implementation_create_vmx (void);
560 #endif
561
562 pixman_implementation_t *
563 _pixman_choose_implementation (void);
564
565
566
567 /*
568  * Utilities
569  */
570 uint32_t *
571 _pixman_iter_get_scanline_noop (pixman_iter_t *iter, const uint32_t *mask);
572
573 /* These "formats" all have depth 0, so they
574  * will never clash with any real ones
575  */
576 #define PIXMAN_null             PIXMAN_FORMAT (0, 0, 0, 0, 0, 0)
577 #define PIXMAN_solid            PIXMAN_FORMAT (0, 1, 0, 0, 0, 0)
578 #define PIXMAN_pixbuf           PIXMAN_FORMAT (0, 2, 0, 0, 0, 0)
579 #define PIXMAN_rpixbuf          PIXMAN_FORMAT (0, 3, 0, 0, 0, 0)
580 #define PIXMAN_unknown          PIXMAN_FORMAT (0, 4, 0, 0, 0, 0)
581 #define PIXMAN_any              PIXMAN_FORMAT (0, 5, 0, 0, 0, 0)
582
583 #define PIXMAN_OP_any           (PIXMAN_N_OPERATORS + 1)
584
585 #define FAST_PATH_ID_TRANSFORM                  (1 <<  0)
586 #define FAST_PATH_NO_ALPHA_MAP                  (1 <<  1)
587 #define FAST_PATH_NO_CONVOLUTION_FILTER         (1 <<  2)
588 #define FAST_PATH_NO_PAD_REPEAT                 (1 <<  3)
589 #define FAST_PATH_NO_REFLECT_REPEAT             (1 <<  4)
590 #define FAST_PATH_NO_ACCESSORS                  (1 <<  5)
591 #define FAST_PATH_NARROW_FORMAT                 (1 <<  6)
592 #define FAST_PATH_COMPONENT_ALPHA               (1 <<  8)
593 #define FAST_PATH_SAMPLES_OPAQUE                (1 <<  7)
594 #define FAST_PATH_UNIFIED_ALPHA                 (1 <<  9)
595 #define FAST_PATH_SCALE_TRANSFORM               (1 << 10)
596 #define FAST_PATH_NEAREST_FILTER                (1 << 11)
597 #define FAST_PATH_HAS_TRANSFORM                 (1 << 12)
598 #define FAST_PATH_IS_OPAQUE                     (1 << 13)
599 #define FAST_PATH_NO_NORMAL_REPEAT              (1 << 14)
600 #define FAST_PATH_NO_NONE_REPEAT                (1 << 15)
601 #define FAST_PATH_SAMPLES_COVER_CLIP            (1 << 16)
602 #define FAST_PATH_X_UNIT_POSITIVE               (1 << 17)
603 #define FAST_PATH_AFFINE_TRANSFORM              (1 << 18)
604 #define FAST_PATH_Y_UNIT_ZERO                   (1 << 19)
605 #define FAST_PATH_BILINEAR_FILTER               (1 << 20)
606
607 #define FAST_PATH_PAD_REPEAT                                            \
608     (FAST_PATH_NO_NONE_REPEAT           |                               \
609      FAST_PATH_NO_NORMAL_REPEAT         |                               \
610      FAST_PATH_NO_REFLECT_REPEAT)
611
612 #define FAST_PATH_NORMAL_REPEAT                                         \
613     (FAST_PATH_NO_NONE_REPEAT           |                               \
614      FAST_PATH_NO_PAD_REPEAT            |                               \
615      FAST_PATH_NO_REFLECT_REPEAT)
616
617 #define FAST_PATH_NONE_REPEAT                                           \
618     (FAST_PATH_NO_NORMAL_REPEAT         |                               \
619      FAST_PATH_NO_PAD_REPEAT            |                               \
620      FAST_PATH_NO_REFLECT_REPEAT)
621
622 #define FAST_PATH_REFLECT_REPEAT                                        \
623     (FAST_PATH_NO_NONE_REPEAT           |                               \
624      FAST_PATH_NO_NORMAL_REPEAT         |                               \
625      FAST_PATH_NO_PAD_REPEAT)
626
627 #define FAST_PATH_STANDARD_FLAGS                                        \
628     (FAST_PATH_NO_CONVOLUTION_FILTER    |                               \
629      FAST_PATH_NO_ACCESSORS             |                               \
630      FAST_PATH_NO_ALPHA_MAP             |                               \
631      FAST_PATH_NARROW_FORMAT)
632
633 #define FAST_PATH_STD_DEST_FLAGS                                        \
634     (FAST_PATH_NO_ACCESSORS             |                               \
635      FAST_PATH_NO_ALPHA_MAP             |                               \
636      FAST_PATH_NARROW_FORMAT)
637
638 #define SOURCE_FLAGS(format)                                            \
639     (FAST_PATH_STANDARD_FLAGS |                                         \
640      ((PIXMAN_ ## format == PIXMAN_solid) ?                             \
641       0 : (FAST_PATH_SAMPLES_COVER_CLIP | FAST_PATH_ID_TRANSFORM)))
642
643 #define MASK_FLAGS(format, extra)                                       \
644     ((PIXMAN_ ## format == PIXMAN_null) ? 0 : (SOURCE_FLAGS (format) | extra))
645
646 #define FAST_PATH(op, src, src_flags, mask, mask_flags, dest, dest_flags, func) \
647     PIXMAN_OP_ ## op,                                                   \
648     PIXMAN_ ## src,                                                     \
649     src_flags,                                                          \
650     PIXMAN_ ## mask,                                                    \
651     mask_flags,                                                         \
652     PIXMAN_ ## dest,                                                    \
653     dest_flags,                                                         \
654     func
655
656 #define PIXMAN_STD_FAST_PATH(op, src, mask, dest, func)                 \
657     { FAST_PATH (                                                       \
658             op,                                                         \
659             src,  SOURCE_FLAGS (src),                                   \
660             mask, MASK_FLAGS (mask, FAST_PATH_UNIFIED_ALPHA),           \
661             dest, FAST_PATH_STD_DEST_FLAGS,                             \
662             func) }
663
664 #define PIXMAN_STD_FAST_PATH_CA(op, src, mask, dest, func)              \
665     { FAST_PATH (                                                       \
666             op,                                                         \
667             src,  SOURCE_FLAGS (src),                                   \
668             mask, MASK_FLAGS (mask, FAST_PATH_COMPONENT_ALPHA),         \
669             dest, FAST_PATH_STD_DEST_FLAGS,                             \
670             func) }
671
672 /* Memory allocation helpers */
673 void *
674 pixman_malloc_ab (unsigned int n, unsigned int b);
675
676 void *
677 pixman_malloc_abc (unsigned int a, unsigned int b, unsigned int c);
678
679 pixman_bool_t
680 pixman_multiply_overflows_int (unsigned int a, unsigned int b);
681
682 pixman_bool_t
683 pixman_addition_overflows_int (unsigned int a, unsigned int b);
684
685 /* Compositing utilities */
686 void
687 pixman_expand (uint64_t *           dst,
688                const uint32_t *     src,
689                pixman_format_code_t format,
690                int                  width);
691
692 void
693 pixman_contract (uint32_t *      dst,
694                  const uint64_t *src,
695                  int             width);
696
697
698 /* Region Helpers */
699 pixman_bool_t
700 pixman_region32_copy_from_region16 (pixman_region32_t *dst,
701                                     pixman_region16_t *src);
702
703 pixman_bool_t
704 pixman_region16_copy_from_region32 (pixman_region16_t *dst,
705                                     pixman_region32_t *src);
706
707
708 /* Misc macros */
709
710 #ifndef FALSE
711 #   define FALSE 0
712 #endif
713
714 #ifndef TRUE
715 #   define TRUE 1
716 #endif
717
718 #ifndef MIN
719 #  define MIN(a, b) ((a < b) ? a : b)
720 #endif
721
722 #ifndef MAX
723 #  define MAX(a, b) ((a > b) ? a : b)
724 #endif
725
726 /* Integer division that rounds towards -infinity */
727 #define DIV(a, b)                                          \
728     ((((a) < 0) == ((b) < 0)) ? (a) / (b) :                \
729      ((a) - (b) + 1 - (((b) < 0) << 1)) / (b))
730
731 /* Modulus that produces the remainder wrt. DIV */
732 #define MOD(a, b) ((a) < 0 ? ((b) - ((-(a) - 1) % (b))) - 1 : (a) % (b))
733
734 #define CLIP(v, low, high) ((v) < (low) ? (low) : ((v) > (high) ? (high) : (v)))
735
736 /* Conversion between 8888 and 0565 */
737
738 #define CONVERT_8888_TO_0565(s)                                         \
739     ((((s) >> 3) & 0x001f) |                                            \
740      (((s) >> 5) & 0x07e0) |                                            \
741      (((s) >> 8) & 0xf800))
742
743 #define CONVERT_0565_TO_0888(s)                                         \
744     (((((s) << 3) & 0xf8) | (((s) >> 2) & 0x7)) |                       \
745      ((((s) << 5) & 0xfc00) | (((s) >> 1) & 0x300)) |                   \
746      ((((s) << 8) & 0xf80000) | (((s) << 3) & 0x70000)))
747
748 #define CONVERT_0565_TO_8888(s) (CONVERT_0565_TO_0888(s) | 0xff000000)
749
750 /* Trivial versions that are useful in macros */
751 #define CONVERT_8888_TO_8888(s) (s)
752 #define CONVERT_0565_TO_0565(s) (s)
753
754 #define PIXMAN_FORMAT_IS_WIDE(f)                                        \
755     (PIXMAN_FORMAT_A (f) > 8 ||                                         \
756      PIXMAN_FORMAT_R (f) > 8 ||                                         \
757      PIXMAN_FORMAT_G (f) > 8 ||                                         \
758      PIXMAN_FORMAT_B (f) > 8)
759
760 #ifdef WORDS_BIGENDIAN
761 #   define SCREEN_SHIFT_LEFT(x,n)       ((x) << (n))
762 #   define SCREEN_SHIFT_RIGHT(x,n)      ((x) >> (n))
763 #else
764 #   define SCREEN_SHIFT_LEFT(x,n)       ((x) >> (n))
765 #   define SCREEN_SHIFT_RIGHT(x,n)      ((x) << (n))
766 #endif
767
768 /*
769  * Various debugging code
770  */
771
772 #undef DEBUG
773
774 #define COMPILE_TIME_ASSERT(x)                                          \
775     do { typedef int compile_time_assertion [(x)?1:-1]; } while (0)
776
777 /* Turn on debugging depending on what type of release this is
778  */
779 #if (((PIXMAN_VERSION_MICRO % 2) == 0) && ((PIXMAN_VERSION_MINOR % 2) == 1))
780
781 /* Debugging gets turned on for development releases because these
782  * are the things that end up in bleeding edge distributions such
783  * as Rawhide etc.
784  *
785  * For performance reasons we don't turn it on for stable releases or
786  * random git checkouts. (Random git checkouts are often used for
787  * performance work).
788  */
789
790 #    define DEBUG
791
792 #endif
793
794 #ifdef DEBUG
795
796 void
797 _pixman_log_error (const char *function, const char *message);
798
799 #define return_if_fail(expr)                                            \
800     do                                                                  \
801     {                                                                   \
802         if (!(expr))                                                    \
803         {                                                               \
804             _pixman_log_error (FUNC, "The expression " # expr " was false"); \
805             return;                                                     \
806         }                                                               \
807     }                                                                   \
808     while (0)
809
810 #define return_val_if_fail(expr, retval)                                \
811     do                                                                  \
812     {                                                                   \
813         if (!(expr))                                                    \
814         {                                                               \
815             _pixman_log_error (FUNC, "The expression " # expr " was false"); \
816             return (retval);                                            \
817         }                                                               \
818     }                                                                   \
819     while (0)
820
821 #define critical_if_fail(expr)                                          \
822     do                                                                  \
823     {                                                                   \
824         if (!(expr))                                                    \
825             _pixman_log_error (FUNC, "The expression " # expr " was false"); \
826     }                                                                   \
827     while (0)
828
829
830 #else
831
832 #define _pixman_log_error(f,m) do { } while (0)                         \
833
834 #define return_if_fail(expr)                                            \
835     do                                                                  \
836     {                                                                   \
837         if (!(expr))                                                    \
838             return;                                                     \
839     }                                                                   \
840     while (0)
841
842 #define return_val_if_fail(expr, retval)                                \
843     do                                                                  \
844     {                                                                   \
845         if (!(expr))                                                    \
846             return (retval);                                            \
847     }                                                                   \
848     while (0)
849
850 #define critical_if_fail(expr)                                          \
851     do                                                                  \
852     {                                                                   \
853     }                                                                   \
854     while (0)
855 #endif
856
857 /*
858  * Timers
859  */
860
861 #ifdef PIXMAN_TIMERS
862
863 static inline uint64_t
864 oil_profile_stamp_rdtsc (void)
865 {
866     uint64_t ts;
867
868     __asm__ __volatile__ ("rdtsc\n" : "=A" (ts));
869     return ts;
870 }
871
872 #define OIL_STAMP oil_profile_stamp_rdtsc
873
874 typedef struct pixman_timer_t pixman_timer_t;
875
876 struct pixman_timer_t
877 {
878     int             initialized;
879     const char *    name;
880     uint64_t        n_times;
881     uint64_t        total;
882     pixman_timer_t *next;
883 };
884
885 extern int timer_defined;
886
887 void pixman_timer_register (pixman_timer_t *timer);
888
889 #define TIMER_BEGIN(tname)                                              \
890     {                                                                   \
891         static pixman_timer_t timer ## tname;                           \
892         uint64_t              begin ## tname;                           \
893                                                                         \
894         if (!timer ## tname.initialized)                                \
895         {                                                               \
896             timer ## tname.initialized = 1;                             \
897             timer ## tname.name = # tname;                              \
898             pixman_timer_register (&timer ## tname);                    \
899         }                                                               \
900                                                                         \
901         timer ## tname.n_times++;                                       \
902         begin ## tname = OIL_STAMP ();
903
904 #define TIMER_END(tname)                                                \
905     timer ## tname.total += OIL_STAMP () - begin ## tname;              \
906     }
907
908 #endif /* PIXMAN_TIMERS */
909
910 #endif /* PIXMAN_PRIVATE_H */