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