Fix opacity check
[profile/ivi/pixman.git] / pixman / pixman-image.c
1 /*
2  * Copyright © 2000 SuSE, Inc.
3  * Copyright © 2007 Red Hat, Inc.
4  *
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.
14  *
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.
21  */
22
23 #ifdef HAVE_CONFIG_H
24 #include <config.h>
25 #endif
26
27 #include <stdlib.h>
28 #include <stdio.h>
29 #include <string.h>
30 #include <assert.h>
31
32 #include "pixman-private.h"
33 #include "pixman-combine32.h"
34
35 pixman_bool_t
36 _pixman_init_gradient (gradient_t *                  gradient,
37                        const pixman_gradient_stop_t *stops,
38                        int                           n_stops)
39 {
40     return_val_if_fail (n_stops > 0, FALSE);
41
42     gradient->stops = pixman_malloc_ab (n_stops, sizeof (pixman_gradient_stop_t));
43     if (!gradient->stops)
44         return FALSE;
45
46     memcpy (gradient->stops, stops, n_stops * sizeof (pixman_gradient_stop_t));
47
48     gradient->n_stops = n_stops;
49
50     return TRUE;
51 }
52
53 /*
54  * By default, just evaluate the image at 32bpp and expand.  Individual image
55  * types can plug in a better scanline getter if they want to. For example
56  * we  could produce smoother gradients by evaluating them at higher color
57  * depth, but that's a project for the future.
58  */
59 void
60 _pixman_image_get_scanline_generic_64 (pixman_image_t * image,
61                                        int              x,
62                                        int              y,
63                                        int              width,
64                                        uint32_t *       buffer,
65                                        const uint32_t * mask)
66 {
67     uint32_t *mask8 = NULL;
68
69     /* Contract the mask image, if one exists, so that the 32-bit fetch
70      * function can use it.
71      */
72     if (mask)
73     {
74         mask8 = pixman_malloc_ab (width, sizeof(uint32_t));
75         if (!mask8)
76             return;
77
78         pixman_contract (mask8, (uint64_t *)mask, width);
79     }
80
81     /* Fetch the source image into the first half of buffer. */
82     _pixman_image_get_scanline_32 (image, x, y, width, (uint32_t*)buffer, mask8);
83
84     /* Expand from 32bpp to 64bpp in place. */
85     pixman_expand ((uint64_t *)buffer, buffer, PIXMAN_a8r8g8b8, width);
86
87     free (mask8);
88 }
89
90 pixman_image_t *
91 _pixman_image_allocate (void)
92 {
93     pixman_image_t *image = malloc (sizeof (pixman_image_t));
94
95     if (image)
96     {
97         image_common_t *common = &image->common;
98
99         pixman_region32_init (&common->clip_region);
100
101         common->alpha_count = 0;
102         common->have_clip_region = FALSE;
103         common->clip_sources = FALSE;
104         common->transform = NULL;
105         common->repeat = PIXMAN_REPEAT_NONE;
106         common->filter = PIXMAN_FILTER_NEAREST;
107         common->filter_params = NULL;
108         common->n_filter_params = 0;
109         common->alpha_map = NULL;
110         common->component_alpha = FALSE;
111         common->ref_count = 1;
112         common->classify = NULL;
113         common->client_clip = FALSE;
114         common->destroy_func = NULL;
115         common->destroy_data = NULL;
116         common->dirty = TRUE;
117     }
118
119     return image;
120 }
121
122 source_image_class_t
123 _pixman_image_classify (pixman_image_t *image,
124                         int             x,
125                         int             y,
126                         int             width,
127                         int             height)
128 {
129     if (image->common.classify)
130         return image->common.classify (image, x, y, width, height);
131     else
132         return SOURCE_IMAGE_CLASS_UNKNOWN;
133 }
134
135 void
136 _pixman_image_get_scanline_32 (pixman_image_t *image,
137                                int             x,
138                                int             y,
139                                int             width,
140                                uint32_t *      buffer,
141                                const uint32_t *mask)
142 {
143     image->common.get_scanline_32 (image, x, y, width, buffer, mask);
144 }
145
146 /* Even thought the type of buffer is uint32_t *, the function actually expects
147  * a uint64_t *buffer.
148  */
149 void
150 _pixman_image_get_scanline_64 (pixman_image_t *image,
151                                int             x,
152                                int             y,
153                                int             width,
154                                uint32_t *      buffer,
155                                const uint32_t *unused)
156 {
157     image->common.get_scanline_64 (image, x, y, width, buffer, unused);
158 }
159
160 static void
161 image_property_changed (pixman_image_t *image)
162 {
163     image->common.dirty = TRUE;
164 }
165
166 /* Ref Counting */
167 PIXMAN_EXPORT pixman_image_t *
168 pixman_image_ref (pixman_image_t *image)
169 {
170     image->common.ref_count++;
171
172     return image;
173 }
174
175 /* returns TRUE when the image is freed */
176 PIXMAN_EXPORT pixman_bool_t
177 pixman_image_unref (pixman_image_t *image)
178 {
179     image_common_t *common = (image_common_t *)image;
180
181     common->ref_count--;
182
183     if (common->ref_count == 0)
184     {
185         if (image->common.destroy_func)
186             image->common.destroy_func (image, image->common.destroy_data);
187
188         pixman_region32_fini (&common->clip_region);
189
190         if (common->transform)
191             free (common->transform);
192
193         if (common->filter_params)
194             free (common->filter_params);
195
196         if (common->alpha_map)
197             pixman_image_unref ((pixman_image_t *)common->alpha_map);
198
199         if (image->type == LINEAR ||
200             image->type == RADIAL ||
201             image->type == CONICAL)
202         {
203             if (image->gradient.stops)
204                 free (image->gradient.stops);
205         }
206
207         if (image->type == BITS && image->bits.free_me)
208             free (image->bits.free_me);
209
210         free (image);
211
212         return TRUE;
213     }
214
215     return FALSE;
216 }
217
218 PIXMAN_EXPORT void
219 pixman_image_set_destroy_function (pixman_image_t *            image,
220                                    pixman_image_destroy_func_t func,
221                                    void *                      data)
222 {
223     image->common.destroy_func = func;
224     image->common.destroy_data = data;
225 }
226
227 PIXMAN_EXPORT void *
228 pixman_image_get_destroy_data (pixman_image_t *image)
229 {
230   return image->common.destroy_data;
231 }
232
233 void
234 _pixman_image_reset_clip_region (pixman_image_t *image)
235 {
236     image->common.have_clip_region = FALSE;
237 }
238
239 /* Executive Summary: This function is a no-op that only exists
240  * for historical reasons.
241  *
242  * There used to be a bug in the X server where it would rely on
243  * out-of-bounds accesses when it was asked to composite with a
244  * window as the source. It would create a pixman image pointing
245  * to some bogus position in memory, but then set a clip region
246  * to the position where the actual bits were.
247  *
248  * Due to a bug in old versions of pixman, where it would not clip
249  * against the image bounds when a clip region was set, this would
250  * actually work. So when the pixman bug was fixed, a workaround was
251  * added to allow certain out-of-bound accesses. This function disabled
252  * those workarounds.
253  *
254  * Since 0.21.2, pixman doesn't do these workarounds anymore, so now
255  * this function is a no-op.
256  */
257 PIXMAN_EXPORT void
258 pixman_disable_out_of_bounds_workaround (void)
259 {
260 }
261
262 static void
263 compute_image_info (pixman_image_t *image)
264 {
265     pixman_format_code_t code;
266     uint32_t flags = 0;
267
268     /* Transform */
269     if (!image->common.transform)
270     {
271         flags |= (FAST_PATH_ID_TRANSFORM        |
272                   FAST_PATH_X_UNIT_POSITIVE     |
273                   FAST_PATH_Y_UNIT_ZERO         |
274                   FAST_PATH_AFFINE_TRANSFORM);
275     }
276     else
277     {
278         flags |= FAST_PATH_HAS_TRANSFORM;
279
280         if (image->common.transform->matrix[2][0] == 0                  &&
281             image->common.transform->matrix[2][1] == 0                  &&
282             image->common.transform->matrix[2][2] == pixman_fixed_1)
283         {
284             flags |= FAST_PATH_AFFINE_TRANSFORM;
285
286             if (image->common.transform->matrix[0][1] == 0 &&
287                 image->common.transform->matrix[1][0] == 0)
288             {
289                 flags |= FAST_PATH_SCALE_TRANSFORM;
290             }
291         }
292
293         if (image->common.transform->matrix[0][0] > 0)
294             flags |= FAST_PATH_X_UNIT_POSITIVE;
295
296         if (image->common.transform->matrix[1][0] == 0)
297             flags |= FAST_PATH_Y_UNIT_ZERO;
298     }
299
300     /* Filter */
301     switch (image->common.filter)
302     {
303     case PIXMAN_FILTER_NEAREST:
304     case PIXMAN_FILTER_FAST:
305         flags |= (FAST_PATH_NEAREST_FILTER | FAST_PATH_NO_CONVOLUTION_FILTER);
306         break;
307
308     case PIXMAN_FILTER_BILINEAR:
309     case PIXMAN_FILTER_GOOD:
310     case PIXMAN_FILTER_BEST:
311         flags |= (FAST_PATH_BILINEAR_FILTER | FAST_PATH_NO_CONVOLUTION_FILTER);
312         break;
313
314     case PIXMAN_FILTER_CONVOLUTION:
315         break;
316
317     default:
318         flags |= FAST_PATH_NO_CONVOLUTION_FILTER;
319         break;
320     }
321
322     /* Repeat mode */
323     switch (image->common.repeat)
324     {
325     case PIXMAN_REPEAT_NONE:
326         flags |=
327             FAST_PATH_NO_REFLECT_REPEAT         |
328             FAST_PATH_NO_PAD_REPEAT             |
329             FAST_PATH_NO_NORMAL_REPEAT;
330         break;
331
332     case PIXMAN_REPEAT_REFLECT:
333         flags |=
334             FAST_PATH_NO_PAD_REPEAT             |
335             FAST_PATH_NO_NONE_REPEAT            |
336             FAST_PATH_NO_NORMAL_REPEAT;
337         break;
338
339     case PIXMAN_REPEAT_PAD:
340         flags |=
341             FAST_PATH_NO_REFLECT_REPEAT         |
342             FAST_PATH_NO_NONE_REPEAT            |
343             FAST_PATH_NO_NORMAL_REPEAT;
344         break;
345
346     default:
347         flags |=
348             FAST_PATH_NO_REFLECT_REPEAT         |
349             FAST_PATH_NO_PAD_REPEAT             |
350             FAST_PATH_NO_NONE_REPEAT;
351         break;
352     }
353
354     /* Component alpha */
355     if (image->common.component_alpha)
356         flags |= FAST_PATH_COMPONENT_ALPHA;
357     else
358         flags |= FAST_PATH_UNIFIED_ALPHA;
359
360     flags |= (FAST_PATH_NO_ACCESSORS | FAST_PATH_NARROW_FORMAT);
361
362     /* Type specific checks */
363     switch (image->type)
364     {
365     case SOLID:
366         code = PIXMAN_solid;
367
368         if (image->solid.color.alpha == 0xffff)
369             flags |= FAST_PATH_IS_OPAQUE;
370         break;
371
372     case BITS:
373         if (image->bits.width == 1      &&
374             image->bits.height == 1     &&
375             image->common.repeat != PIXMAN_REPEAT_NONE)
376         {
377             code = PIXMAN_solid;
378         }
379         else
380         {
381             code = image->bits.format;
382         }
383
384         if (!PIXMAN_FORMAT_A (image->bits.format)                               &&
385             PIXMAN_FORMAT_TYPE (image->bits.format) != PIXMAN_TYPE_GRAY         &&
386             PIXMAN_FORMAT_TYPE (image->bits.format) != PIXMAN_TYPE_COLOR)
387         {
388             flags |= FAST_PATH_SAMPLES_OPAQUE;
389
390             if (image->common.repeat != PIXMAN_REPEAT_NONE)
391                 flags |= FAST_PATH_IS_OPAQUE;
392         }
393
394         if (image->bits.read_func || image->bits.write_func)
395             flags &= ~FAST_PATH_NO_ACCESSORS;
396
397         if (PIXMAN_FORMAT_IS_WIDE (image->bits.format))
398             flags &= ~FAST_PATH_NARROW_FORMAT;
399         break;
400
401     case RADIAL:
402         code = PIXMAN_unknown;
403
404         /*
405          * As explained in pixman-radial-gradient.c, every point of
406          * the plane has a valid associated radius (and thus will be
407          * colored) if and only if a is negative (i.e. one of the two
408          * circles contains the other one).
409          */
410
411         if (image->radial.a >= 0)
412             break;
413
414         /* Fall through */
415
416     case LINEAR:
417         code = PIXMAN_unknown;
418
419         if (image->common.repeat != PIXMAN_REPEAT_NONE)
420         {
421             int i;
422
423             flags |= FAST_PATH_IS_OPAQUE;
424             for (i = 0; i < image->gradient.n_stops; ++i)
425             {
426                 if (image->gradient.stops[i].color.alpha != 0xffff)
427                 {
428                     flags &= ~FAST_PATH_IS_OPAQUE;
429                     break;
430                 }
431             }
432         }
433         break;
434
435     default:
436         code = PIXMAN_unknown;
437         break;
438     }
439
440     /* Alpha map */
441     if (!image->common.alpha_map)
442     {
443         flags |= FAST_PATH_NO_ALPHA_MAP;
444     }
445     else
446     {
447         if (PIXMAN_FORMAT_IS_WIDE (image->common.alpha_map->format))
448             flags &= ~FAST_PATH_NARROW_FORMAT;
449     }
450
451     /* Both alpha maps and convolution filters can introduce
452      * non-opaqueness in otherwise opaque images. Also
453      * an image with component alpha turned on is only opaque
454      * if all channels are opaque, so we simply turn it off
455      * unconditionally for those images.
456      */
457     if (image->common.alpha_map                                 ||
458         image->common.filter == PIXMAN_FILTER_CONVOLUTION       ||
459         image->common.component_alpha)
460     {
461         flags &= ~(FAST_PATH_IS_OPAQUE | FAST_PATH_SAMPLES_OPAQUE);
462     }
463
464     image->common.flags = flags;
465     image->common.extended_format_code = code;
466 }
467
468 void
469 _pixman_image_validate (pixman_image_t *image)
470 {
471     if (image->common.dirty)
472     {
473         compute_image_info (image);
474
475         /* It is important that property_changed is
476          * called *after* compute_image_info() because
477          * property_changed() can make use of the flags
478          * to set up accessors etc.
479          */
480         image->common.property_changed (image);
481
482         image->common.dirty = FALSE;
483     }
484
485     if (image->common.alpha_map)
486         _pixman_image_validate ((pixman_image_t *)image->common.alpha_map);
487 }
488
489 PIXMAN_EXPORT pixman_bool_t
490 pixman_image_set_clip_region32 (pixman_image_t *   image,
491                                 pixman_region32_t *region)
492 {
493     image_common_t *common = (image_common_t *)image;
494     pixman_bool_t result;
495
496     if (region)
497     {
498         if ((result = pixman_region32_copy (&common->clip_region, region)))
499             image->common.have_clip_region = TRUE;
500     }
501     else
502     {
503         _pixman_image_reset_clip_region (image);
504
505         result = TRUE;
506     }
507
508     image_property_changed (image);
509
510     return result;
511 }
512
513 PIXMAN_EXPORT pixman_bool_t
514 pixman_image_set_clip_region (pixman_image_t *   image,
515                               pixman_region16_t *region)
516 {
517     image_common_t *common = (image_common_t *)image;
518     pixman_bool_t result;
519
520     if (region)
521     {
522         if ((result = pixman_region32_copy_from_region16 (&common->clip_region, region)))
523             image->common.have_clip_region = TRUE;
524     }
525     else
526     {
527         _pixman_image_reset_clip_region (image);
528
529         result = TRUE;
530     }
531
532     image_property_changed (image);
533
534     return result;
535 }
536
537 PIXMAN_EXPORT void
538 pixman_image_set_has_client_clip (pixman_image_t *image,
539                                   pixman_bool_t   client_clip)
540 {
541     image->common.client_clip = client_clip;
542 }
543
544 PIXMAN_EXPORT pixman_bool_t
545 pixman_image_set_transform (pixman_image_t *          image,
546                             const pixman_transform_t *transform)
547 {
548     static const pixman_transform_t id =
549     {
550         { { pixman_fixed_1, 0, 0 },
551           { 0, pixman_fixed_1, 0 },
552           { 0, 0, pixman_fixed_1 } }
553     };
554
555     image_common_t *common = (image_common_t *)image;
556     pixman_bool_t result;
557
558     if (common->transform == transform)
559         return TRUE;
560
561     if (memcmp (&id, transform, sizeof (pixman_transform_t)) == 0)
562     {
563         free (common->transform);
564         common->transform = NULL;
565         result = TRUE;
566
567         goto out;
568     }
569
570     if (common->transform == NULL)
571         common->transform = malloc (sizeof (pixman_transform_t));
572
573     if (common->transform == NULL)
574     {
575         result = FALSE;
576
577         goto out;
578     }
579
580     memcpy (common->transform, transform, sizeof(pixman_transform_t));
581
582     result = TRUE;
583
584 out:
585     image_property_changed (image);
586
587     return result;
588 }
589
590 PIXMAN_EXPORT void
591 pixman_image_set_repeat (pixman_image_t *image,
592                          pixman_repeat_t repeat)
593 {
594     image->common.repeat = repeat;
595
596     image_property_changed (image);
597 }
598
599 PIXMAN_EXPORT pixman_bool_t
600 pixman_image_set_filter (pixman_image_t *      image,
601                          pixman_filter_t       filter,
602                          const pixman_fixed_t *params,
603                          int                   n_params)
604 {
605     image_common_t *common = (image_common_t *)image;
606     pixman_fixed_t *new_params;
607
608     if (params == common->filter_params && filter == common->filter)
609         return TRUE;
610
611     new_params = NULL;
612     if (params)
613     {
614         new_params = pixman_malloc_ab (n_params, sizeof (pixman_fixed_t));
615         if (!new_params)
616             return FALSE;
617
618         memcpy (new_params,
619                 params, n_params * sizeof (pixman_fixed_t));
620     }
621
622     common->filter = filter;
623
624     if (common->filter_params)
625         free (common->filter_params);
626
627     common->filter_params = new_params;
628     common->n_filter_params = n_params;
629
630     image_property_changed (image);
631     return TRUE;
632 }
633
634 PIXMAN_EXPORT void
635 pixman_image_set_source_clipping (pixman_image_t *image,
636                                   pixman_bool_t   clip_sources)
637 {
638     image->common.clip_sources = clip_sources;
639
640     image_property_changed (image);
641 }
642
643 /* Unlike all the other property setters, this function does not
644  * copy the content of indexed. Doing this copying is simply
645  * way, way too expensive.
646  */
647 PIXMAN_EXPORT void
648 pixman_image_set_indexed (pixman_image_t *        image,
649                           const pixman_indexed_t *indexed)
650 {
651     bits_image_t *bits = (bits_image_t *)image;
652
653     bits->indexed = indexed;
654
655     image_property_changed (image);
656 }
657
658 PIXMAN_EXPORT void
659 pixman_image_set_alpha_map (pixman_image_t *image,
660                             pixman_image_t *alpha_map,
661                             int16_t         x,
662                             int16_t         y)
663 {
664     image_common_t *common = (image_common_t *)image;
665
666     return_if_fail (!alpha_map || alpha_map->type == BITS);
667
668     if (alpha_map && common->alpha_count > 0)
669     {
670         /* If this image is being used as an alpha map itself,
671          * then you can't give it an alpha map of its own.
672          */
673         return;
674     }
675
676     if (alpha_map && alpha_map->common.alpha_map)
677     {
678         /* If the image has an alpha map of its own,
679          * then it can't be used as an alpha map itself
680          */
681         return;
682     }
683
684     if (common->alpha_map != (bits_image_t *)alpha_map)
685     {
686         if (common->alpha_map)
687         {
688             common->alpha_map->common.alpha_count--;
689
690             pixman_image_unref ((pixman_image_t *)common->alpha_map);
691         }
692
693         if (alpha_map)
694         {
695             common->alpha_map = (bits_image_t *)pixman_image_ref (alpha_map);
696
697             common->alpha_map->common.alpha_count++;
698         }
699         else
700         {
701             common->alpha_map = NULL;
702         }
703     }
704
705     common->alpha_origin_x = x;
706     common->alpha_origin_y = y;
707
708     image_property_changed (image);
709 }
710
711 PIXMAN_EXPORT void
712 pixman_image_set_component_alpha   (pixman_image_t *image,
713                                     pixman_bool_t   component_alpha)
714 {
715     image->common.component_alpha = component_alpha;
716
717     image_property_changed (image);
718 }
719
720 PIXMAN_EXPORT pixman_bool_t
721 pixman_image_get_component_alpha   (pixman_image_t       *image)
722 {
723     return image->common.component_alpha;
724 }
725
726 PIXMAN_EXPORT void
727 pixman_image_set_accessors (pixman_image_t *           image,
728                             pixman_read_memory_func_t  read_func,
729                             pixman_write_memory_func_t write_func)
730 {
731     return_if_fail (image != NULL);
732
733     if (image->type == BITS)
734     {
735         image->bits.read_func = read_func;
736         image->bits.write_func = write_func;
737
738         image_property_changed (image);
739     }
740 }
741
742 PIXMAN_EXPORT uint32_t *
743 pixman_image_get_data (pixman_image_t *image)
744 {
745     if (image->type == BITS)
746         return image->bits.bits;
747
748     return NULL;
749 }
750
751 PIXMAN_EXPORT int
752 pixman_image_get_width (pixman_image_t *image)
753 {
754     if (image->type == BITS)
755         return image->bits.width;
756
757     return 0;
758 }
759
760 PIXMAN_EXPORT int
761 pixman_image_get_height (pixman_image_t *image)
762 {
763     if (image->type == BITS)
764         return image->bits.height;
765
766     return 0;
767 }
768
769 PIXMAN_EXPORT int
770 pixman_image_get_stride (pixman_image_t *image)
771 {
772     if (image->type == BITS)
773         return image->bits.rowstride * (int) sizeof (uint32_t);
774
775     return 0;
776 }
777
778 PIXMAN_EXPORT int
779 pixman_image_get_depth (pixman_image_t *image)
780 {
781     if (image->type == BITS)
782         return PIXMAN_FORMAT_DEPTH (image->bits.format);
783
784     return 0;
785 }
786
787 PIXMAN_EXPORT pixman_format_code_t
788 pixman_image_get_format (pixman_image_t *image)
789 {
790     if (image->type == BITS)
791         return image->bits.format;
792
793     return 0;
794 }
795
796 uint32_t
797 _pixman_image_get_solid (pixman_image_t *     image,
798                          pixman_format_code_t format)
799 {
800     uint32_t result;
801
802     _pixman_image_get_scanline_32 (image, 0, 0, 1, &result, NULL);
803
804     /* If necessary, convert RGB <--> BGR. */
805     if (PIXMAN_FORMAT_TYPE (format) != PIXMAN_TYPE_ARGB)
806     {
807         result = (((result & 0xff000000) >>  0) |
808                   ((result & 0x00ff0000) >> 16) |
809                   ((result & 0x0000ff00) >>  0) |
810                   ((result & 0x000000ff) << 16));
811     }
812
813     return result;
814 }