2 * Copyright © 2000 SuSE, Inc.
3 * Copyright © 2007 Red Hat, Inc.
5 * Permission to use, copy, modify, distribute, and sell this software and its
6 * documentation for any purpose is hereby granted without fee, provided that
7 * the above copyright notice appear in all copies and that both that
8 * copyright notice and this permission notice appear in supporting
9 * documentation, and that the name of SuSE not be used in advertising or
10 * publicity pertaining to distribution of the software without specific,
11 * written prior permission. SuSE makes no representations about the
12 * suitability of this software for any purpose. It is provided "as is"
13 * without express or implied warranty.
15 * SuSE DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL SuSE
17 * BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
18 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
19 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
20 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
32 #include "pixman-private.h"
34 static const pixman_color_t transparent_black = { 0, 0, 0, 0 };
37 gradient_property_changed (pixman_image_t *image)
39 gradient_t *gradient = &image->gradient;
40 int n = gradient->n_stops;
41 pixman_gradient_stop_t *stops = gradient->stops;
42 pixman_gradient_stop_t *begin = &(gradient->stops[-1]);
43 pixman_gradient_stop_t *end = &(gradient->stops[n]);
45 switch (gradient->common.repeat)
48 case PIXMAN_REPEAT_NONE:
50 begin->color = transparent_black;
52 end->color = transparent_black;
55 case PIXMAN_REPEAT_NORMAL:
56 begin->x = stops[n - 1].x - pixman_fixed_1;
57 begin->color = stops[n - 1].color;
58 end->x = stops[0].x + pixman_fixed_1;
59 end->color = stops[0].color;
62 case PIXMAN_REPEAT_REFLECT:
63 begin->x = - stops[0].x;
64 begin->color = stops[0].color;
65 end->x = pixman_int_to_fixed (2) - stops[n - 1].x;
66 end->color = stops[n - 1].color;
69 case PIXMAN_REPEAT_PAD:
71 begin->color = stops[0].color;
73 end->color = stops[n - 1].color;
79 _pixman_init_gradient (gradient_t * gradient,
80 const pixman_gradient_stop_t *stops,
83 return_val_if_fail (n_stops > 0, FALSE);
85 /* We allocate two extra stops, one before the beginning of the stop list,
86 * and one after the end. These stops are initialized to whatever color
87 * would be used for positions outside the range of the stop list.
89 * This saves a bit of computation in the gradient walker.
91 * The pointer we store in the gradient_t struct still points to the
92 * first user-supplied struct, so when freeing, we will have to
96 pixman_malloc_ab (n_stops + 2, sizeof (pixman_gradient_stop_t));
100 gradient->stops += 1;
101 memcpy (gradient->stops, stops, n_stops * sizeof (pixman_gradient_stop_t));
102 gradient->n_stops = n_stops;
104 gradient->common.property_changed = gradient_property_changed;
110 _pixman_image_init (pixman_image_t *image)
112 image_common_t *common = &image->common;
114 pixman_region32_init (&common->clip_region);
116 common->alpha_count = 0;
117 common->have_clip_region = FALSE;
118 common->clip_sources = FALSE;
119 common->transform = NULL;
120 common->repeat = PIXMAN_REPEAT_NONE;
121 common->filter = PIXMAN_FILTER_NEAREST;
122 common->filter_params = NULL;
123 common->n_filter_params = 0;
124 common->alpha_map = NULL;
125 common->component_alpha = FALSE;
126 common->ref_count = 1;
127 common->property_changed = NULL;
128 common->client_clip = FALSE;
129 common->destroy_func = NULL;
130 common->destroy_data = NULL;
131 common->dirty = TRUE;
135 _pixman_image_fini (pixman_image_t *image)
137 image_common_t *common = (image_common_t *)image;
141 if (common->ref_count == 0)
143 if (image->common.destroy_func)
144 image->common.destroy_func (image, image->common.destroy_data);
146 pixman_region32_fini (&common->clip_region);
148 free (common->transform);
149 free (common->filter_params);
151 if (common->alpha_map)
152 pixman_image_unref ((pixman_image_t *)common->alpha_map);
154 if (image->type == LINEAR ||
155 image->type == RADIAL ||
156 image->type == CONICAL)
158 if (image->gradient.stops)
160 /* See _pixman_init_gradient() for an explanation of the - 1 */
161 free (image->gradient.stops - 1);
164 /* This will trigger if someone adds a property_changed
165 * method to the linear/radial/conical gradient overwriting
169 image->common.property_changed == gradient_property_changed);
172 if (image->type == BITS && image->bits.free_me)
173 free (image->bits.free_me);
182 _pixman_image_allocate (void)
184 pixman_image_t *image = malloc (sizeof (pixman_image_t));
187 _pixman_image_init (image);
193 image_property_changed (pixman_image_t *image)
195 image->common.dirty = TRUE;
199 PIXMAN_EXPORT pixman_image_t *
200 pixman_image_ref (pixman_image_t *image)
202 image->common.ref_count++;
207 /* returns TRUE when the image is freed */
208 PIXMAN_EXPORT pixman_bool_t
209 pixman_image_unref (pixman_image_t *image)
211 if (_pixman_image_fini (image))
221 pixman_image_set_destroy_function (pixman_image_t * image,
222 pixman_image_destroy_func_t func,
225 image->common.destroy_func = func;
226 image->common.destroy_data = data;
230 pixman_image_get_destroy_data (pixman_image_t *image)
232 return image->common.destroy_data;
236 _pixman_image_reset_clip_region (pixman_image_t *image)
238 image->common.have_clip_region = FALSE;
241 /* Executive Summary: This function is a no-op that only exists
242 * for historical reasons.
244 * There used to be a bug in the X server where it would rely on
245 * out-of-bounds accesses when it was asked to composite with a
246 * window as the source. It would create a pixman image pointing
247 * to some bogus position in memory, but then set a clip region
248 * to the position where the actual bits were.
250 * Due to a bug in old versions of pixman, where it would not clip
251 * against the image bounds when a clip region was set, this would
252 * actually work. So when the pixman bug was fixed, a workaround was
253 * added to allow certain out-of-bound accesses. This function disabled
256 * Since 0.21.2, pixman doesn't do these workarounds anymore, so now
257 * this function is a no-op.
260 pixman_disable_out_of_bounds_workaround (void)
265 compute_image_info (pixman_image_t *image)
267 pixman_format_code_t code;
271 if (!image->common.transform)
273 flags |= (FAST_PATH_ID_TRANSFORM |
274 FAST_PATH_X_UNIT_POSITIVE |
275 FAST_PATH_Y_UNIT_ZERO |
276 FAST_PATH_AFFINE_TRANSFORM);
280 flags |= FAST_PATH_HAS_TRANSFORM;
282 if (image->common.transform->matrix[2][0] == 0 &&
283 image->common.transform->matrix[2][1] == 0 &&
284 image->common.transform->matrix[2][2] == pixman_fixed_1)
286 flags |= FAST_PATH_AFFINE_TRANSFORM;
288 if (image->common.transform->matrix[0][1] == 0 &&
289 image->common.transform->matrix[1][0] == 0)
291 if (image->common.transform->matrix[0][0] == -pixman_fixed_1 &&
292 image->common.transform->matrix[1][1] == -pixman_fixed_1)
294 flags |= FAST_PATH_ROTATE_180_TRANSFORM;
296 flags |= FAST_PATH_SCALE_TRANSFORM;
298 else if (image->common.transform->matrix[0][0] == 0 &&
299 image->common.transform->matrix[1][1] == 0)
301 pixman_fixed_t m01 = image->common.transform->matrix[0][1];
302 pixman_fixed_t m10 = image->common.transform->matrix[1][0];
304 if (m01 == -pixman_fixed_1 && m10 == pixman_fixed_1)
305 flags |= FAST_PATH_ROTATE_90_TRANSFORM;
306 else if (m01 == pixman_fixed_1 && m10 == -pixman_fixed_1)
307 flags |= FAST_PATH_ROTATE_270_TRANSFORM;
311 if (image->common.transform->matrix[0][0] > 0)
312 flags |= FAST_PATH_X_UNIT_POSITIVE;
314 if (image->common.transform->matrix[1][0] == 0)
315 flags |= FAST_PATH_Y_UNIT_ZERO;
319 switch (image->common.filter)
321 case PIXMAN_FILTER_NEAREST:
322 case PIXMAN_FILTER_FAST:
323 flags |= (FAST_PATH_NEAREST_FILTER | FAST_PATH_NO_CONVOLUTION_FILTER);
326 case PIXMAN_FILTER_BILINEAR:
327 case PIXMAN_FILTER_GOOD:
328 case PIXMAN_FILTER_BEST:
329 flags |= (FAST_PATH_BILINEAR_FILTER | FAST_PATH_NO_CONVOLUTION_FILTER);
331 /* Here we have a chance to optimize BILINEAR filter to NEAREST if
332 * they are equivalent for the currently used transformation matrix.
334 if (flags & FAST_PATH_ID_TRANSFORM)
336 flags |= FAST_PATH_NEAREST_FILTER;
338 else if (flags & FAST_PATH_AFFINE_TRANSFORM)
340 /* Suppose the transform is
346 * and the destination coordinates are (n + 0.5, m + 0.5). Then
347 * the transformed x coordinate is:
349 * tx = t00 * (n + 0.5) + t01 * (m + 0.5) + t02
350 * = t00 * n + t01 * m + t02 + (t00 + t01) * 0.5
352 * which implies that if t00, t01 and t02 are all integers
353 * and (t00 + t01) is odd, then tx will be an integer plus 0.5,
354 * which means a BILINEAR filter will reduce to NEAREST. The same
355 * applies in the y direction
357 pixman_fixed_t (*t)[3] = image->common.transform->matrix;
359 if ((pixman_fixed_frac (
360 t[0][0] | t[0][1] | t[0][2] |
361 t[1][0] | t[1][1] | t[1][2]) == 0) &&
362 (pixman_fixed_to_int (
363 (t[0][0] + t[0][1]) & (t[1][0] + t[1][1])) % 2) == 1)
365 /* FIXME: there are some affine-test failures, showing that
366 * handling of BILINEAR and NEAREST filter is not quite
367 * equivalent when getting close to 32K for the translation
368 * components of the matrix. That's likely some bug, but for
369 * now just skip BILINEAR->NEAREST optimization in this case.
371 pixman_fixed_t magic_limit = pixman_int_to_fixed (30000);
372 if (image->common.transform->matrix[0][2] <= magic_limit &&
373 image->common.transform->matrix[1][2] <= magic_limit &&
374 image->common.transform->matrix[0][2] >= -magic_limit &&
375 image->common.transform->matrix[1][2] >= -magic_limit)
377 flags |= FAST_PATH_NEAREST_FILTER;
383 case PIXMAN_FILTER_CONVOLUTION:
386 case PIXMAN_FILTER_SEPARABLE_CONVOLUTION:
387 flags |= FAST_PATH_SEPARABLE_CONVOLUTION_FILTER;
391 flags |= FAST_PATH_NO_CONVOLUTION_FILTER;
396 switch (image->common.repeat)
398 case PIXMAN_REPEAT_NONE:
400 FAST_PATH_NO_REFLECT_REPEAT |
401 FAST_PATH_NO_PAD_REPEAT |
402 FAST_PATH_NO_NORMAL_REPEAT;
405 case PIXMAN_REPEAT_REFLECT:
407 FAST_PATH_NO_PAD_REPEAT |
408 FAST_PATH_NO_NONE_REPEAT |
409 FAST_PATH_NO_NORMAL_REPEAT;
412 case PIXMAN_REPEAT_PAD:
414 FAST_PATH_NO_REFLECT_REPEAT |
415 FAST_PATH_NO_NONE_REPEAT |
416 FAST_PATH_NO_NORMAL_REPEAT;
421 FAST_PATH_NO_REFLECT_REPEAT |
422 FAST_PATH_NO_PAD_REPEAT |
423 FAST_PATH_NO_NONE_REPEAT;
427 /* Component alpha */
428 if (image->common.component_alpha)
429 flags |= FAST_PATH_COMPONENT_ALPHA;
431 flags |= FAST_PATH_UNIFIED_ALPHA;
433 flags |= (FAST_PATH_NO_ACCESSORS | FAST_PATH_NARROW_FORMAT);
435 /* Type specific checks */
441 if (image->solid.color.alpha == 0xffff)
442 flags |= FAST_PATH_IS_OPAQUE;
446 if (image->bits.width == 1 &&
447 image->bits.height == 1 &&
448 image->common.repeat != PIXMAN_REPEAT_NONE)
454 code = image->bits.format;
455 flags |= FAST_PATH_BITS_IMAGE;
458 if (!PIXMAN_FORMAT_A (image->bits.format) &&
459 PIXMAN_FORMAT_TYPE (image->bits.format) != PIXMAN_TYPE_GRAY &&
460 PIXMAN_FORMAT_TYPE (image->bits.format) != PIXMAN_TYPE_COLOR)
462 flags |= FAST_PATH_SAMPLES_OPAQUE;
464 if (image->common.repeat != PIXMAN_REPEAT_NONE)
465 flags |= FAST_PATH_IS_OPAQUE;
468 if (image->bits.read_func || image->bits.write_func)
469 flags &= ~FAST_PATH_NO_ACCESSORS;
471 if (PIXMAN_FORMAT_IS_WIDE (image->bits.format))
472 flags &= ~FAST_PATH_NARROW_FORMAT;
476 code = PIXMAN_unknown;
479 * As explained in pixman-radial-gradient.c, every point of
480 * the plane has a valid associated radius (and thus will be
481 * colored) if and only if a is negative (i.e. one of the two
482 * circles contains the other one).
485 if (image->radial.a >= 0)
492 code = PIXMAN_unknown;
494 if (image->common.repeat != PIXMAN_REPEAT_NONE)
498 flags |= FAST_PATH_IS_OPAQUE;
499 for (i = 0; i < image->gradient.n_stops; ++i)
501 if (image->gradient.stops[i].color.alpha != 0xffff)
503 flags &= ~FAST_PATH_IS_OPAQUE;
511 code = PIXMAN_unknown;
515 /* Alpha maps are only supported for BITS images, so it's always
516 * safe to ignore their presense for non-BITS images
518 if (!image->common.alpha_map || image->type != BITS)
520 flags |= FAST_PATH_NO_ALPHA_MAP;
524 if (PIXMAN_FORMAT_IS_WIDE (image->common.alpha_map->format))
525 flags &= ~FAST_PATH_NARROW_FORMAT;
528 /* Both alpha maps and convolution filters can introduce
529 * non-opaqueness in otherwise opaque images. Also
530 * an image with component alpha turned on is only opaque
531 * if all channels are opaque, so we simply turn it off
532 * unconditionally for those images.
534 if (image->common.alpha_map ||
535 image->common.filter == PIXMAN_FILTER_CONVOLUTION ||
536 image->common.filter == PIXMAN_FILTER_SEPARABLE_CONVOLUTION ||
537 image->common.component_alpha)
539 flags &= ~(FAST_PATH_IS_OPAQUE | FAST_PATH_SAMPLES_OPAQUE);
542 image->common.flags = flags;
543 image->common.extended_format_code = code;
547 _pixman_image_validate (pixman_image_t *image)
549 if (image->common.dirty)
551 compute_image_info (image);
553 /* It is important that property_changed is
554 * called *after* compute_image_info() because
555 * property_changed() can make use of the flags
556 * to set up accessors etc.
558 if (image->common.property_changed)
559 image->common.property_changed (image);
561 image->common.dirty = FALSE;
564 if (image->common.alpha_map)
565 _pixman_image_validate ((pixman_image_t *)image->common.alpha_map);
568 PIXMAN_EXPORT pixman_bool_t
569 pixman_image_set_clip_region32 (pixman_image_t * image,
570 pixman_region32_t *region)
572 image_common_t *common = (image_common_t *)image;
573 pixman_bool_t result;
577 if ((result = pixman_region32_copy (&common->clip_region, region)))
578 image->common.have_clip_region = TRUE;
582 _pixman_image_reset_clip_region (image);
587 image_property_changed (image);
592 PIXMAN_EXPORT pixman_bool_t
593 pixman_image_set_clip_region (pixman_image_t * image,
594 pixman_region16_t *region)
596 image_common_t *common = (image_common_t *)image;
597 pixman_bool_t result;
601 if ((result = pixman_region32_copy_from_region16 (&common->clip_region, region)))
602 image->common.have_clip_region = TRUE;
606 _pixman_image_reset_clip_region (image);
611 image_property_changed (image);
617 pixman_image_set_has_client_clip (pixman_image_t *image,
618 pixman_bool_t client_clip)
620 image->common.client_clip = client_clip;
623 PIXMAN_EXPORT pixman_bool_t
624 pixman_image_set_transform (pixman_image_t * image,
625 const pixman_transform_t *transform)
627 static const pixman_transform_t id =
629 { { pixman_fixed_1, 0, 0 },
630 { 0, pixman_fixed_1, 0 },
631 { 0, 0, pixman_fixed_1 } }
634 image_common_t *common = (image_common_t *)image;
635 pixman_bool_t result;
637 if (common->transform == transform)
640 if (!transform || memcmp (&id, transform, sizeof (pixman_transform_t)) == 0)
642 free (common->transform);
643 common->transform = NULL;
649 if (common->transform &&
650 memcmp (common->transform, transform, sizeof (pixman_transform_t)) == 0)
655 if (common->transform == NULL)
656 common->transform = malloc (sizeof (pixman_transform_t));
658 if (common->transform == NULL)
665 memcpy (common->transform, transform, sizeof(pixman_transform_t));
670 image_property_changed (image);
676 pixman_image_set_repeat (pixman_image_t *image,
677 pixman_repeat_t repeat)
679 if (image->common.repeat == repeat)
682 image->common.repeat = repeat;
684 image_property_changed (image);
687 PIXMAN_EXPORT pixman_bool_t
688 pixman_image_set_filter (pixman_image_t * image,
689 pixman_filter_t filter,
690 const pixman_fixed_t *params,
693 image_common_t *common = (image_common_t *)image;
694 pixman_fixed_t *new_params;
696 if (params == common->filter_params && filter == common->filter)
699 if (filter == PIXMAN_FILTER_SEPARABLE_CONVOLUTION)
701 int width = pixman_fixed_to_int (params[0]);
702 int height = pixman_fixed_to_int (params[1]);
703 int x_phase_bits = pixman_fixed_to_int (params[2]);
704 int y_phase_bits = pixman_fixed_to_int (params[3]);
705 int n_x_phases = (1 << x_phase_bits);
706 int n_y_phases = (1 << y_phase_bits);
709 n_params == 4 + n_x_phases * width + n_y_phases * height, FALSE);
715 new_params = pixman_malloc_ab (n_params, sizeof (pixman_fixed_t));
720 params, n_params * sizeof (pixman_fixed_t));
723 common->filter = filter;
725 if (common->filter_params)
726 free (common->filter_params);
728 common->filter_params = new_params;
729 common->n_filter_params = n_params;
731 image_property_changed (image);
736 pixman_image_set_source_clipping (pixman_image_t *image,
737 pixman_bool_t clip_sources)
739 if (image->common.clip_sources == clip_sources)
742 image->common.clip_sources = clip_sources;
744 image_property_changed (image);
747 /* Unlike all the other property setters, this function does not
748 * copy the content of indexed. Doing this copying is simply
749 * way, way too expensive.
752 pixman_image_set_indexed (pixman_image_t * image,
753 const pixman_indexed_t *indexed)
755 bits_image_t *bits = (bits_image_t *)image;
757 if (bits->indexed == indexed)
760 bits->indexed = indexed;
762 image_property_changed (image);
766 pixman_image_set_alpha_map (pixman_image_t *image,
767 pixman_image_t *alpha_map,
771 image_common_t *common = (image_common_t *)image;
773 return_if_fail (!alpha_map || alpha_map->type == BITS);
775 if (alpha_map && common->alpha_count > 0)
777 /* If this image is being used as an alpha map itself,
778 * then you can't give it an alpha map of its own.
783 if (alpha_map && alpha_map->common.alpha_map)
785 /* If the image has an alpha map of its own,
786 * then it can't be used as an alpha map itself
791 if (common->alpha_map != (bits_image_t *)alpha_map)
793 if (common->alpha_map)
795 common->alpha_map->common.alpha_count--;
797 pixman_image_unref ((pixman_image_t *)common->alpha_map);
802 common->alpha_map = (bits_image_t *)pixman_image_ref (alpha_map);
804 common->alpha_map->common.alpha_count++;
808 common->alpha_map = NULL;
812 common->alpha_origin_x = x;
813 common->alpha_origin_y = y;
815 image_property_changed (image);
819 pixman_image_set_component_alpha (pixman_image_t *image,
820 pixman_bool_t component_alpha)
822 if (image->common.component_alpha == component_alpha)
825 image->common.component_alpha = component_alpha;
827 image_property_changed (image);
830 PIXMAN_EXPORT pixman_bool_t
831 pixman_image_get_component_alpha (pixman_image_t *image)
833 return image->common.component_alpha;
837 pixman_image_set_accessors (pixman_image_t * image,
838 pixman_read_memory_func_t read_func,
839 pixman_write_memory_func_t write_func)
841 return_if_fail (image != NULL);
843 if (image->type == BITS)
845 /* Accessors only work for <= 32 bpp. */
846 if (PIXMAN_FORMAT_BPP(image->bits.format) > 32)
847 return_if_fail (!read_func && !write_func);
849 image->bits.read_func = read_func;
850 image->bits.write_func = write_func;
852 image_property_changed (image);
856 PIXMAN_EXPORT uint32_t *
857 pixman_image_get_data (pixman_image_t *image)
859 if (image->type == BITS)
860 return image->bits.bits;
866 pixman_image_get_width (pixman_image_t *image)
868 if (image->type == BITS)
869 return image->bits.width;
875 pixman_image_get_height (pixman_image_t *image)
877 if (image->type == BITS)
878 return image->bits.height;
884 pixman_image_get_stride (pixman_image_t *image)
886 if (image->type == BITS)
887 return image->bits.rowstride * (int) sizeof (uint32_t);
893 pixman_image_get_depth (pixman_image_t *image)
895 if (image->type == BITS)
896 return PIXMAN_FORMAT_DEPTH (image->bits.format);
901 PIXMAN_EXPORT pixman_format_code_t
902 pixman_image_get_format (pixman_image_t *image)
904 if (image->type == BITS)
905 return image->bits.format;
911 _pixman_image_get_solid (pixman_implementation_t *imp,
912 pixman_image_t * image,
913 pixman_format_code_t format)
917 if (image->type == SOLID)
919 result = image->solid.color_32;
921 else if (image->type == BITS)
923 if (image->bits.format == PIXMAN_a8r8g8b8)
924 result = image->bits.bits[0];
925 else if (image->bits.format == PIXMAN_x8r8g8b8)
926 result = image->bits.bits[0] | 0xff000000;
927 else if (image->bits.format == PIXMAN_a8)
928 result = (*(uint8_t *)image->bits.bits) << 24;
937 _pixman_implementation_iter_init (
938 imp, &iter, image, 0, 0, 1, 1,
940 ITER_NARROW | ITER_SRC, image->common.flags);
942 result = *iter.get_scanline (&iter, NULL);
948 /* If necessary, convert RGB <--> BGR. */
949 if (PIXMAN_FORMAT_TYPE (format) != PIXMAN_TYPE_ARGB
950 && PIXMAN_FORMAT_TYPE (format) != PIXMAN_TYPE_ARGB_SRGB)
952 result = (((result & 0xff000000) >> 0) |
953 ((result & 0x00ff0000) >> 16) |
954 ((result & 0x0000ff00) >> 0) |
955 ((result & 0x000000ff) << 16));