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