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