Remove unused stop_range field
[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 LINEAR:
402     case RADIAL:
403         code = PIXMAN_unknown;
404
405         if (image->common.repeat != PIXMAN_REPEAT_NONE)
406         {
407             int i;
408
409             flags |= FAST_PATH_IS_OPAQUE;
410             for (i = 0; i < image->gradient.n_stops; ++i)
411             {
412                 if (image->gradient.stops[i].color.alpha != 0xffff)
413                 {
414                     flags &= ~FAST_PATH_IS_OPAQUE;
415                     break;
416                 }
417             }
418         }
419         break;
420
421     default:
422         code = PIXMAN_unknown;
423         break;
424     }
425
426     /* Alpha map */
427     if (!image->common.alpha_map)
428     {
429         flags |= FAST_PATH_NO_ALPHA_MAP;
430     }
431     else
432     {
433         if (PIXMAN_FORMAT_IS_WIDE (image->common.alpha_map->format))
434             flags &= ~FAST_PATH_NARROW_FORMAT;
435     }
436
437     /* Both alpha maps and convolution filters can introduce
438      * non-opaqueness in otherwise opaque images. Also
439      * an image with component alpha turned on is only opaque
440      * if all channels are opaque, so we simply turn it off
441      * unconditionally for those images.
442      */
443     if (image->common.alpha_map                                 ||
444         image->common.filter == PIXMAN_FILTER_CONVOLUTION       ||
445         image->common.component_alpha)
446     {
447         flags &= ~(FAST_PATH_IS_OPAQUE | FAST_PATH_SAMPLES_OPAQUE);
448     }
449
450     image->common.flags = flags;
451     image->common.extended_format_code = code;
452 }
453
454 void
455 _pixman_image_validate (pixman_image_t *image)
456 {
457     if (image->common.dirty)
458     {
459         compute_image_info (image);
460
461         /* It is important that property_changed is
462          * called *after* compute_image_info() because
463          * property_changed() can make use of the flags
464          * to set up accessors etc.
465          */
466         image->common.property_changed (image);
467
468         image->common.dirty = FALSE;
469     }
470
471     if (image->common.alpha_map)
472         _pixman_image_validate ((pixman_image_t *)image->common.alpha_map);
473 }
474
475 PIXMAN_EXPORT pixman_bool_t
476 pixman_image_set_clip_region32 (pixman_image_t *   image,
477                                 pixman_region32_t *region)
478 {
479     image_common_t *common = (image_common_t *)image;
480     pixman_bool_t result;
481
482     if (region)
483     {
484         if ((result = pixman_region32_copy (&common->clip_region, region)))
485             image->common.have_clip_region = TRUE;
486     }
487     else
488     {
489         _pixman_image_reset_clip_region (image);
490
491         result = TRUE;
492     }
493
494     image_property_changed (image);
495
496     return result;
497 }
498
499 PIXMAN_EXPORT pixman_bool_t
500 pixman_image_set_clip_region (pixman_image_t *   image,
501                               pixman_region16_t *region)
502 {
503     image_common_t *common = (image_common_t *)image;
504     pixman_bool_t result;
505
506     if (region)
507     {
508         if ((result = pixman_region32_copy_from_region16 (&common->clip_region, region)))
509             image->common.have_clip_region = TRUE;
510     }
511     else
512     {
513         _pixman_image_reset_clip_region (image);
514
515         result = TRUE;
516     }
517
518     image_property_changed (image);
519
520     return result;
521 }
522
523 PIXMAN_EXPORT void
524 pixman_image_set_has_client_clip (pixman_image_t *image,
525                                   pixman_bool_t   client_clip)
526 {
527     image->common.client_clip = client_clip;
528 }
529
530 PIXMAN_EXPORT pixman_bool_t
531 pixman_image_set_transform (pixman_image_t *          image,
532                             const pixman_transform_t *transform)
533 {
534     static const pixman_transform_t id =
535     {
536         { { pixman_fixed_1, 0, 0 },
537           { 0, pixman_fixed_1, 0 },
538           { 0, 0, pixman_fixed_1 } }
539     };
540
541     image_common_t *common = (image_common_t *)image;
542     pixman_bool_t result;
543
544     if (common->transform == transform)
545         return TRUE;
546
547     if (memcmp (&id, transform, sizeof (pixman_transform_t)) == 0)
548     {
549         free (common->transform);
550         common->transform = NULL;
551         result = TRUE;
552
553         goto out;
554     }
555
556     if (common->transform == NULL)
557         common->transform = malloc (sizeof (pixman_transform_t));
558
559     if (common->transform == NULL)
560     {
561         result = FALSE;
562
563         goto out;
564     }
565
566     memcpy (common->transform, transform, sizeof(pixman_transform_t));
567
568     result = TRUE;
569
570 out:
571     image_property_changed (image);
572
573     return result;
574 }
575
576 PIXMAN_EXPORT void
577 pixman_image_set_repeat (pixman_image_t *image,
578                          pixman_repeat_t repeat)
579 {
580     image->common.repeat = repeat;
581
582     image_property_changed (image);
583 }
584
585 PIXMAN_EXPORT pixman_bool_t
586 pixman_image_set_filter (pixman_image_t *      image,
587                          pixman_filter_t       filter,
588                          const pixman_fixed_t *params,
589                          int                   n_params)
590 {
591     image_common_t *common = (image_common_t *)image;
592     pixman_fixed_t *new_params;
593
594     if (params == common->filter_params && filter == common->filter)
595         return TRUE;
596
597     new_params = NULL;
598     if (params)
599     {
600         new_params = pixman_malloc_ab (n_params, sizeof (pixman_fixed_t));
601         if (!new_params)
602             return FALSE;
603
604         memcpy (new_params,
605                 params, n_params * sizeof (pixman_fixed_t));
606     }
607
608     common->filter = filter;
609
610     if (common->filter_params)
611         free (common->filter_params);
612
613     common->filter_params = new_params;
614     common->n_filter_params = n_params;
615
616     image_property_changed (image);
617     return TRUE;
618 }
619
620 PIXMAN_EXPORT void
621 pixman_image_set_source_clipping (pixman_image_t *image,
622                                   pixman_bool_t   clip_sources)
623 {
624     image->common.clip_sources = clip_sources;
625
626     image_property_changed (image);
627 }
628
629 /* Unlike all the other property setters, this function does not
630  * copy the content of indexed. Doing this copying is simply
631  * way, way too expensive.
632  */
633 PIXMAN_EXPORT void
634 pixman_image_set_indexed (pixman_image_t *        image,
635                           const pixman_indexed_t *indexed)
636 {
637     bits_image_t *bits = (bits_image_t *)image;
638
639     bits->indexed = indexed;
640
641     image_property_changed (image);
642 }
643
644 PIXMAN_EXPORT void
645 pixman_image_set_alpha_map (pixman_image_t *image,
646                             pixman_image_t *alpha_map,
647                             int16_t         x,
648                             int16_t         y)
649 {
650     image_common_t *common = (image_common_t *)image;
651
652     return_if_fail (!alpha_map || alpha_map->type == BITS);
653
654     if (alpha_map && common->alpha_count > 0)
655     {
656         /* If this image is being used as an alpha map itself,
657          * then you can't give it an alpha map of its own.
658          */
659         return;
660     }
661
662     if (alpha_map && alpha_map->common.alpha_map)
663     {
664         /* If the image has an alpha map of its own,
665          * then it can't be used as an alpha map itself
666          */
667         return;
668     }
669
670     if (common->alpha_map != (bits_image_t *)alpha_map)
671     {
672         if (common->alpha_map)
673         {
674             common->alpha_map->common.alpha_count--;
675
676             pixman_image_unref ((pixman_image_t *)common->alpha_map);
677         }
678
679         if (alpha_map)
680         {
681             common->alpha_map = (bits_image_t *)pixman_image_ref (alpha_map);
682
683             common->alpha_map->common.alpha_count++;
684         }
685         else
686         {
687             common->alpha_map = NULL;
688         }
689     }
690
691     common->alpha_origin_x = x;
692     common->alpha_origin_y = y;
693
694     image_property_changed (image);
695 }
696
697 PIXMAN_EXPORT void
698 pixman_image_set_component_alpha   (pixman_image_t *image,
699                                     pixman_bool_t   component_alpha)
700 {
701     image->common.component_alpha = component_alpha;
702
703     image_property_changed (image);
704 }
705
706 PIXMAN_EXPORT pixman_bool_t
707 pixman_image_get_component_alpha   (pixman_image_t       *image)
708 {
709     return image->common.component_alpha;
710 }
711
712 PIXMAN_EXPORT void
713 pixman_image_set_accessors (pixman_image_t *           image,
714                             pixman_read_memory_func_t  read_func,
715                             pixman_write_memory_func_t write_func)
716 {
717     return_if_fail (image != NULL);
718
719     if (image->type == BITS)
720     {
721         image->bits.read_func = read_func;
722         image->bits.write_func = write_func;
723
724         image_property_changed (image);
725     }
726 }
727
728 PIXMAN_EXPORT uint32_t *
729 pixman_image_get_data (pixman_image_t *image)
730 {
731     if (image->type == BITS)
732         return image->bits.bits;
733
734     return NULL;
735 }
736
737 PIXMAN_EXPORT int
738 pixman_image_get_width (pixman_image_t *image)
739 {
740     if (image->type == BITS)
741         return image->bits.width;
742
743     return 0;
744 }
745
746 PIXMAN_EXPORT int
747 pixman_image_get_height (pixman_image_t *image)
748 {
749     if (image->type == BITS)
750         return image->bits.height;
751
752     return 0;
753 }
754
755 PIXMAN_EXPORT int
756 pixman_image_get_stride (pixman_image_t *image)
757 {
758     if (image->type == BITS)
759         return image->bits.rowstride * (int) sizeof (uint32_t);
760
761     return 0;
762 }
763
764 PIXMAN_EXPORT int
765 pixman_image_get_depth (pixman_image_t *image)
766 {
767     if (image->type == BITS)
768         return PIXMAN_FORMAT_DEPTH (image->bits.format);
769
770     return 0;
771 }
772
773 PIXMAN_EXPORT pixman_format_code_t
774 pixman_image_get_format (pixman_image_t *image)
775 {
776     if (image->type == BITS)
777         return image->bits.format;
778
779     return 0;
780 }
781
782 uint32_t
783 _pixman_image_get_solid (pixman_image_t *     image,
784                          pixman_format_code_t format)
785 {
786     uint32_t result;
787
788     _pixman_image_get_scanline_32 (image, 0, 0, 1, &result, NULL);
789
790     /* If necessary, convert RGB <--> BGR. */
791     if (PIXMAN_FORMAT_TYPE (format) != PIXMAN_TYPE_ARGB)
792     {
793         result = (((result & 0xff000000) >>  0) |
794                   ((result & 0x00ff0000) >> 16) |
795                   ((result & 0x0000ff00) >>  0) |
796                   ((result & 0x000000ff) << 16));
797     }
798
799     return result;
800 }