2 # error config.h must be included before pixman-private.h
5 #ifndef PIXMAN_PRIVATE_H
6 #define PIXMAN_PRIVATE_H
8 #define PIXMAN_DISABLE_DEPRECATED
9 #define PIXMAN_USE_INTERNAL_API
17 #include "pixman-compiler.h"
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;
33 typedef void (*fetch_scanline_t) (pixman_image_t *image,
38 const uint32_t *mask);
40 typedef uint32_t (*fetch_pixel_32_t) (bits_image_t *image,
44 typedef uint64_t (*fetch_pixel_64_t) (bits_image_t *image,
48 typedef void (*store_scanline_t) (bits_image_t * image,
52 const uint32_t *values);
63 typedef void (*property_changed_func_t) (pixman_image_t *image);
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
74 pixman_bool_t clip_sources; /* Whether the clip applies when
75 * the image is used as a source
78 pixman_transform_t * transform;
79 pixman_repeat_t repeat;
80 pixman_filter_t filter;
81 pixman_fixed_t * filter_params;
83 bits_image_t * alpha_map;
86 pixman_bool_t component_alpha;
87 property_changed_func_t property_changed;
89 pixman_image_destroy_func_t destroy_func;
93 pixman_format_code_t extended_format_code;
98 image_common_t common;
107 image_common_t common;
109 pixman_gradient_stop_t *stops;
112 struct linear_gradient
115 pixman_point_fixed_t p1;
116 pixman_point_fixed_t p2;
123 pixman_fixed_t radius;
126 struct radial_gradient
139 struct conical_gradient
142 pixman_point_fixed_t center;
148 image_common_t common;
149 pixman_format_code_t format;
150 const pixman_indexed_t * indexed;
155 int rowstride; /* in number of uint32_t's */
157 fetch_scanline_t get_scanline_32;
158 fetch_scanline_t get_scanline_64;
160 fetch_scanline_t fetch_scanline_32;
161 fetch_pixel_32_t fetch_pixel_32;
162 store_scanline_t store_scanline_32;
164 fetch_scanline_t fetch_scanline_64;
165 fetch_pixel_64_t fetch_pixel_64;
166 store_scanline_t store_scanline_64;
168 /* Used for indirect access to the bits */
169 pixman_read_memory_func_t read_func;
170 pixman_write_memory_func_t write_func;
176 image_common_t common;
179 linear_gradient_t linear;
180 conical_gradient_t conical;
181 radial_gradient_t radial;
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);
191 ITER_NARROW = (1 << 0),
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.
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
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.
208 ITER_LOCALIZED_ALPHA = (1 << 1),
209 ITER_IGNORE_ALPHA = (1 << 2),
210 ITER_IGNORE_RGB = (1 << 3)
215 /* These are initialized by _pixman_implementation_{src,dest}_init */
216 pixman_image_t * image;
223 /* These function pointers are initialized by the implementation */
224 pixman_iter_get_scanline_t get_scanline;
225 pixman_iter_write_back_t write_back;
227 /* These fields are scratch data that implementations can use */
233 _pixman_bits_image_setup_accessors (bits_image_t *image);
236 _pixman_bits_image_src_iter_init (pixman_image_t *image, pixman_iter_t *iter);
239 _pixman_bits_image_dest_iter_init (pixman_image_t *image, pixman_iter_t *iter);
242 _pixman_solid_fill_iter_init (pixman_image_t *image, pixman_iter_t *iter);
245 _pixman_linear_gradient_iter_init (pixman_image_t *image, pixman_iter_t *iter);
248 _pixman_radial_gradient_iter_init (pixman_image_t *image, pixman_iter_t *iter);
251 _pixman_conical_gradient_iter_init (pixman_image_t *image, pixman_iter_t *iter);
254 _pixman_image_allocate (void);
257 _pixman_init_gradient (gradient_t * gradient,
258 const pixman_gradient_stop_t *stops,
261 _pixman_image_reset_clip_region (pixman_image_t *image);
264 _pixman_image_validate (pixman_image_t *image);
266 #define PIXMAN_IMAGE_GET_LINE(image, x, y, type, out_stride, line, mul) \
269 uint32_t *__bits__; \
272 __bits__ = image->bits.bits; \
273 __stride__ = image->bits.rowstride; \
275 __stride__ * (int) sizeof (uint32_t) / (int) sizeof (type); \
277 ((type *) __bits__) + (out_stride) * (y) + (mul) * (x); \
293 pixman_gradient_stop_t *stops;
298 } pixman_gradient_walker_t;
301 _pixman_gradient_walker_init (pixman_gradient_walker_t *walker,
302 gradient_t * gradient,
303 unsigned int spread);
306 _pixman_gradient_walker_reset (pixman_gradient_walker_t *walker,
307 pixman_fixed_32_32_t pos);
310 _pixman_gradient_walker_pixel (pixman_gradient_walker_t *walker,
311 pixman_fixed_32_32_t x);
317 #define MAX_ALPHA(n) ((1 << (n)) - 1)
318 #define N_Y_FRAC(n) ((n) == 1 ? 1 : (1 << ((n) / 2)) - 1)
319 #define N_X_FRAC(n) ((n) == 1 ? 1 : (1 << ((n) / 2)) + 1)
321 #define STEP_Y_SMALL(n) (pixman_fixed_1 / N_Y_FRAC (n))
322 #define STEP_Y_BIG(n) (pixman_fixed_1 - (N_Y_FRAC (n) - 1) * STEP_Y_SMALL (n))
324 #define Y_FRAC_FIRST(n) (STEP_Y_BIG (n) / 2)
325 #define Y_FRAC_LAST(n) (Y_FRAC_FIRST (n) + (N_Y_FRAC (n) - 1) * STEP_Y_SMALL (n))
327 #define STEP_X_SMALL(n) (pixman_fixed_1 / N_X_FRAC (n))
328 #define STEP_X_BIG(n) (pixman_fixed_1 - (N_X_FRAC (n) - 1) * STEP_X_SMALL (n))
330 #define X_FRAC_FIRST(n) (STEP_X_BIG (n) / 2)
331 #define X_FRAC_LAST(n) (X_FRAC_FIRST (n) + (N_X_FRAC (n) - 1) * STEP_X_SMALL (n))
333 #define RENDER_SAMPLES_X(x, n) \
334 ((n) == 1? 0 : (pixman_fixed_frac (x) + \
335 X_FRAC_FIRST (n)) / STEP_X_SMALL (n))
338 pixman_rasterize_edges_accessors (pixman_image_t *image,
347 typedef struct pixman_implementation_t pixman_implementation_t;
352 pixman_image_t * src_image;
353 pixman_image_t * mask_image;
354 pixman_image_t * dest_image;
363 } pixman_composite_info_t;
365 #define PIXMAN_COMPOSITE_ARGS(info) \
366 MAYBE_UNUSED pixman_op_t op = info->op; \
367 MAYBE_UNUSED pixman_image_t * src_image = info->src_image; \
368 MAYBE_UNUSED pixman_image_t * mask_image = info->mask_image; \
369 MAYBE_UNUSED pixman_image_t * dest_image = info->dest_image; \
370 MAYBE_UNUSED int32_t src_x = info->src_x; \
371 MAYBE_UNUSED int32_t src_y = info->src_y; \
372 MAYBE_UNUSED int32_t mask_x = info->mask_x; \
373 MAYBE_UNUSED int32_t mask_y = info->mask_y; \
374 MAYBE_UNUSED int32_t dest_x = info->dest_x; \
375 MAYBE_UNUSED int32_t dest_y = info->dest_y; \
376 MAYBE_UNUSED int32_t width = info->width; \
377 MAYBE_UNUSED int32_t height = info->height
379 typedef void (*pixman_combine_32_func_t) (pixman_implementation_t *imp,
382 const uint32_t * src,
383 const uint32_t * mask,
386 typedef void (*pixman_combine_64_func_t) (pixman_implementation_t *imp,
389 const uint64_t * src,
390 const uint64_t * mask,
393 typedef void (*pixman_composite_func_t) (pixman_implementation_t *imp,
394 pixman_composite_info_t *info);
395 typedef pixman_bool_t (*pixman_blt_func_t) (pixman_implementation_t *imp,
408 typedef pixman_bool_t (*pixman_fill_func_t) (pixman_implementation_t *imp,
417 typedef void (*pixman_iter_init_func_t) (pixman_implementation_t *imp,
418 pixman_iter_t *iter);
420 void _pixman_setup_combiner_functions_32 (pixman_implementation_t *imp);
421 void _pixman_setup_combiner_functions_64 (pixman_implementation_t *imp);
426 pixman_format_code_t src_format;
428 pixman_format_code_t mask_format;
430 pixman_format_code_t dest_format;
432 pixman_composite_func_t func;
433 } pixman_fast_path_t;
435 struct pixman_implementation_t
437 pixman_implementation_t * toplevel;
438 pixman_implementation_t * delegate;
439 const pixman_fast_path_t * fast_paths;
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;
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];
453 _pixman_image_get_solid (pixman_implementation_t *imp,
454 pixman_image_t * image,
455 pixman_format_code_t format);
457 pixman_implementation_t *
458 _pixman_implementation_create (pixman_implementation_t *delegate,
459 const pixman_fast_path_t *fast_paths);
462 _pixman_implementation_combine_32 (pixman_implementation_t *imp,
465 const uint32_t * src,
466 const uint32_t * mask,
469 _pixman_implementation_combine_64 (pixman_implementation_t *imp,
472 const uint64_t * src,
473 const uint64_t * mask,
476 _pixman_implementation_combine_32_ca (pixman_implementation_t *imp,
479 const uint32_t * src,
480 const uint32_t * mask,
483 _pixman_implementation_combine_64_ca (pixman_implementation_t *imp,
486 const uint64_t * src,
487 const uint64_t * mask,
491 _pixman_implementation_blt (pixman_implementation_t *imp,
506 _pixman_implementation_fill (pixman_implementation_t *imp,
517 _pixman_implementation_src_iter_init (pixman_implementation_t *imp,
519 pixman_image_t *image,
528 _pixman_implementation_dest_iter_init (pixman_implementation_t *imp,
530 pixman_image_t *image,
538 /* Specific implementations */
539 pixman_implementation_t *
540 _pixman_implementation_create_general (void);
542 pixman_implementation_t *
543 _pixman_implementation_create_fast_path (pixman_implementation_t *fallback);
545 pixman_implementation_t *
546 _pixman_implementation_create_noop (pixman_implementation_t *fallback);
549 pixman_implementation_t *
550 _pixman_implementation_create_mmx (pixman_implementation_t *fallback);
554 pixman_implementation_t *
555 _pixman_implementation_create_sse2 (pixman_implementation_t *fallback);
559 pixman_implementation_t *
560 _pixman_implementation_create_arm_simd (pixman_implementation_t *fallback);
564 pixman_implementation_t *
565 _pixman_implementation_create_arm_neon (pixman_implementation_t *fallback);
569 pixman_implementation_t *
570 _pixman_implementation_create_vmx (pixman_implementation_t *fallback);
573 pixman_implementation_t *
574 _pixman_choose_implementation (void);
582 _pixman_iter_get_scanline_noop (pixman_iter_t *iter, const uint32_t *mask);
584 /* These "formats" all have depth 0, so they
585 * will never clash with any real ones
587 #define PIXMAN_null PIXMAN_FORMAT (0, 0, 0, 0, 0, 0)
588 #define PIXMAN_solid PIXMAN_FORMAT (0, 1, 0, 0, 0, 0)
589 #define PIXMAN_pixbuf PIXMAN_FORMAT (0, 2, 0, 0, 0, 0)
590 #define PIXMAN_rpixbuf PIXMAN_FORMAT (0, 3, 0, 0, 0, 0)
591 #define PIXMAN_unknown PIXMAN_FORMAT (0, 4, 0, 0, 0, 0)
592 #define PIXMAN_any PIXMAN_FORMAT (0, 5, 0, 0, 0, 0)
594 #define PIXMAN_OP_any (PIXMAN_N_OPERATORS + 1)
596 #define FAST_PATH_ID_TRANSFORM (1 << 0)
597 #define FAST_PATH_NO_ALPHA_MAP (1 << 1)
598 #define FAST_PATH_NO_CONVOLUTION_FILTER (1 << 2)
599 #define FAST_PATH_NO_PAD_REPEAT (1 << 3)
600 #define FAST_PATH_NO_REFLECT_REPEAT (1 << 4)
601 #define FAST_PATH_NO_ACCESSORS (1 << 5)
602 #define FAST_PATH_NARROW_FORMAT (1 << 6)
603 #define FAST_PATH_COMPONENT_ALPHA (1 << 8)
604 #define FAST_PATH_SAMPLES_OPAQUE (1 << 7)
605 #define FAST_PATH_UNIFIED_ALPHA (1 << 9)
606 #define FAST_PATH_SCALE_TRANSFORM (1 << 10)
607 #define FAST_PATH_NEAREST_FILTER (1 << 11)
608 #define FAST_PATH_HAS_TRANSFORM (1 << 12)
609 #define FAST_PATH_IS_OPAQUE (1 << 13)
610 #define FAST_PATH_NO_NORMAL_REPEAT (1 << 14)
611 #define FAST_PATH_NO_NONE_REPEAT (1 << 15)
612 #define FAST_PATH_X_UNIT_POSITIVE (1 << 16)
613 #define FAST_PATH_AFFINE_TRANSFORM (1 << 17)
614 #define FAST_PATH_Y_UNIT_ZERO (1 << 18)
615 #define FAST_PATH_BILINEAR_FILTER (1 << 19)
616 #define FAST_PATH_ROTATE_90_TRANSFORM (1 << 20)
617 #define FAST_PATH_ROTATE_180_TRANSFORM (1 << 21)
618 #define FAST_PATH_ROTATE_270_TRANSFORM (1 << 22)
619 #define FAST_PATH_SAMPLES_COVER_CLIP_NEAREST (1 << 23)
620 #define FAST_PATH_SAMPLES_COVER_CLIP_BILINEAR (1 << 24)
622 #define FAST_PATH_PAD_REPEAT \
623 (FAST_PATH_NO_NONE_REPEAT | \
624 FAST_PATH_NO_NORMAL_REPEAT | \
625 FAST_PATH_NO_REFLECT_REPEAT)
627 #define FAST_PATH_NORMAL_REPEAT \
628 (FAST_PATH_NO_NONE_REPEAT | \
629 FAST_PATH_NO_PAD_REPEAT | \
630 FAST_PATH_NO_REFLECT_REPEAT)
632 #define FAST_PATH_NONE_REPEAT \
633 (FAST_PATH_NO_NORMAL_REPEAT | \
634 FAST_PATH_NO_PAD_REPEAT | \
635 FAST_PATH_NO_REFLECT_REPEAT)
637 #define FAST_PATH_REFLECT_REPEAT \
638 (FAST_PATH_NO_NONE_REPEAT | \
639 FAST_PATH_NO_NORMAL_REPEAT | \
640 FAST_PATH_NO_PAD_REPEAT)
642 #define FAST_PATH_STANDARD_FLAGS \
643 (FAST_PATH_NO_CONVOLUTION_FILTER | \
644 FAST_PATH_NO_ACCESSORS | \
645 FAST_PATH_NO_ALPHA_MAP | \
646 FAST_PATH_NARROW_FORMAT)
648 #define FAST_PATH_STD_DEST_FLAGS \
649 (FAST_PATH_NO_ACCESSORS | \
650 FAST_PATH_NO_ALPHA_MAP | \
651 FAST_PATH_NARROW_FORMAT)
653 #define SOURCE_FLAGS(format) \
654 (FAST_PATH_STANDARD_FLAGS | \
655 ((PIXMAN_ ## format == PIXMAN_solid) ? \
656 0 : (FAST_PATH_SAMPLES_COVER_CLIP_NEAREST | FAST_PATH_NEAREST_FILTER | FAST_PATH_ID_TRANSFORM)))
658 #define MASK_FLAGS(format, extra) \
659 ((PIXMAN_ ## format == PIXMAN_null) ? 0 : (SOURCE_FLAGS (format) | extra))
661 #define FAST_PATH(op, src, src_flags, mask, mask_flags, dest, dest_flags, func) \
671 #define PIXMAN_STD_FAST_PATH(op, src, mask, dest, func) \
674 src, SOURCE_FLAGS (src), \
675 mask, MASK_FLAGS (mask, FAST_PATH_UNIFIED_ALPHA), \
676 dest, FAST_PATH_STD_DEST_FLAGS, \
679 #define PIXMAN_STD_FAST_PATH_CA(op, src, mask, dest, func) \
682 src, SOURCE_FLAGS (src), \
683 mask, MASK_FLAGS (mask, FAST_PATH_COMPONENT_ALPHA), \
684 dest, FAST_PATH_STD_DEST_FLAGS, \
687 /* Memory allocation helpers */
689 pixman_malloc_ab (unsigned int n, unsigned int b);
692 pixman_malloc_abc (unsigned int a, unsigned int b, unsigned int c);
695 _pixman_multiply_overflows_size (size_t a, size_t b);
698 _pixman_multiply_overflows_int (unsigned int a, unsigned int b);
701 _pixman_addition_overflows_int (unsigned int a, unsigned int b);
703 /* Compositing utilities */
705 pixman_expand (uint64_t * dst,
706 const uint32_t * src,
707 pixman_format_code_t format,
711 pixman_contract (uint32_t * dst,
718 pixman_region32_copy_from_region16 (pixman_region32_t *dst,
719 pixman_region16_t *src);
722 pixman_region16_copy_from_region32 (pixman_region16_t *dst,
723 pixman_region32_t *src);
737 # define MIN(a, b) ((a < b) ? a : b)
741 # define MAX(a, b) ((a > b) ? a : b)
744 /* Integer division that rounds towards -infinity */
746 ((((a) < 0) == ((b) < 0)) ? (a) / (b) : \
747 ((a) - (b) + 1 - (((b) < 0) << 1)) / (b))
749 /* Modulus that produces the remainder wrt. DIV */
750 #define MOD(a, b) ((a) < 0 ? ((b) - ((-(a) - 1) % (b))) - 1 : (a) % (b))
752 #define CLIP(v, low, high) ((v) < (low) ? (low) : ((v) > (high) ? (high) : (v)))
754 /* Conversion between 8888 and 0565 */
756 #define CONVERT_8888_TO_0565(s) \
757 ((((s) >> 3) & 0x001f) | \
758 (((s) >> 5) & 0x07e0) | \
759 (((s) >> 8) & 0xf800))
761 #define CONVERT_0565_TO_0888(s) \
762 (((((s) << 3) & 0xf8) | (((s) >> 2) & 0x7)) | \
763 ((((s) << 5) & 0xfc00) | (((s) >> 1) & 0x300)) | \
764 ((((s) << 8) & 0xf80000) | (((s) << 3) & 0x70000)))
766 #define CONVERT_0565_TO_8888(s) (CONVERT_0565_TO_0888(s) | 0xff000000)
768 /* Trivial versions that are useful in macros */
769 #define CONVERT_8888_TO_8888(s) (s)
770 #define CONVERT_x888_TO_8888(s) ((s) | 0xff000000)
771 #define CONVERT_0565_TO_0565(s) (s)
773 #define PIXMAN_FORMAT_IS_WIDE(f) \
774 (PIXMAN_FORMAT_A (f) > 8 || \
775 PIXMAN_FORMAT_R (f) > 8 || \
776 PIXMAN_FORMAT_G (f) > 8 || \
777 PIXMAN_FORMAT_B (f) > 8)
779 #ifdef WORDS_BIGENDIAN
780 # define SCREEN_SHIFT_LEFT(x,n) ((x) << (n))
781 # define SCREEN_SHIFT_RIGHT(x,n) ((x) >> (n))
783 # define SCREEN_SHIFT_LEFT(x,n) ((x) >> (n))
784 # define SCREEN_SHIFT_RIGHT(x,n) ((x) << (n))
787 static force_inline uint32_t
788 unorm_to_unorm (uint32_t val, int from_bits, int to_bits)
795 /* Delete any extra bits */
796 val &= ((1 << from_bits) - 1);
798 if (from_bits >= to_bits)
799 return val >> (from_bits - to_bits);
801 /* Start out with the high bit of val in the high bit of result. */
802 result = val << (to_bits - from_bits);
804 /* Copy the bits in result, doubling the number of bits each time, until
805 * we fill all to_bits. Unrolled manually because from_bits and to_bits
806 * are usually known statically, so the compiler can turn all of this
809 #define REPLICATE() \
812 if (from_bits < to_bits) \
814 result |= result >> from_bits; \
831 * Various debugging code
836 #define COMPILE_TIME_ASSERT(x) \
837 do { typedef int compile_time_assertion [(x)?1:-1]; } while (0)
839 /* Turn on debugging depending on what type of release this is
841 #if (((PIXMAN_VERSION_MICRO % 2) == 0) && ((PIXMAN_VERSION_MINOR % 2) == 1))
843 /* Debugging gets turned on for development releases because these
844 * are the things that end up in bleeding edge distributions such
847 * For performance reasons we don't turn it on for stable releases or
848 * random git checkouts. (Random git checkouts are often used for
859 _pixman_log_error (const char *function, const char *message);
861 #define return_if_fail(expr) \
866 _pixman_log_error (FUNC, "The expression " # expr " was false"); \
872 #define return_val_if_fail(expr, retval) \
877 _pixman_log_error (FUNC, "The expression " # expr " was false"); \
883 #define critical_if_fail(expr) \
887 _pixman_log_error (FUNC, "The expression " # expr " was false"); \
894 #define _pixman_log_error(f,m) do { } while (0) \
896 #define return_if_fail(expr) \
904 #define return_val_if_fail(expr, retval) \
912 #define critical_if_fail(expr) \
925 static inline uint64_t
926 oil_profile_stamp_rdtsc (void)
930 __asm__ __volatile__ ("rdtsc\n" : "=A" (ts));
934 #define OIL_STAMP oil_profile_stamp_rdtsc
936 typedef struct pixman_timer_t pixman_timer_t;
938 struct pixman_timer_t
944 pixman_timer_t *next;
947 extern int timer_defined;
949 void pixman_timer_register (pixman_timer_t *timer);
951 #define TIMER_BEGIN(tname) \
953 static pixman_timer_t timer ## tname; \
954 uint64_t begin ## tname; \
956 if (!timer ## tname.initialized) \
958 timer ## tname.initialized = 1; \
959 timer ## tname.name = # tname; \
960 pixman_timer_register (&timer ## tname); \
963 timer ## tname.n_times++; \
964 begin ## tname = OIL_STAMP ();
966 #define TIMER_END(tname) \
967 timer ## tname.total += OIL_STAMP () - begin ## tname; \
970 #endif /* PIXMAN_TIMERS */
972 #endif /* PIXMAN_PRIVATE_H */