Add pixman_image_fill_boxes() API
[profile/ivi/pixman.git] / pixman / pixman.c
1 /* -*- Mode: c; c-basic-offset: 4; tab-width: 8; indent-tabs-mode: t; -*- */
2 /*
3  * Copyright © 2000 SuSE, Inc.
4  * Copyright © 2007 Red Hat, Inc.
5  *
6  * Permission to use, copy, modify, distribute, and sell this software and its
7  * documentation for any purpose is hereby granted without fee, provided that
8  * the above copyright notice appear in all copies and that both that
9  * copyright notice and this permission notice appear in supporting
10  * documentation, and that the name of SuSE not be used in advertising or
11  * publicity pertaining to distribution of the software without specific,
12  * written prior permission.  SuSE makes no representations about the
13  * suitability of this software for any purpose.  It is provided "as is"
14  * without express or implied warranty.
15  *
16  * SuSE DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL SuSE
18  * BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
19  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
20  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
21  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22  *
23  * Author:  Keith Packard, SuSE, Inc.
24  */
25
26 #ifdef HAVE_CONFIG_H
27 #include <config.h>
28 #endif
29 #include "pixman-private.h"
30
31 /*
32  * Operator optimizations based on source or destination opacity
33  */
34 typedef struct
35 {
36     pixman_op_t op;
37     pixman_op_t op_src_dst_opaque;
38     pixman_op_t op_src_opaque;
39     pixman_op_t op_dst_opaque;
40 } optimized_operator_info_t;
41
42 static const optimized_operator_info_t optimized_operators[] =
43 {
44     /* Input Operator           SRC&DST Opaque          SRC Opaque              DST Opaque      */
45     { PIXMAN_OP_OVER,           PIXMAN_OP_SRC,          PIXMAN_OP_SRC,          PIXMAN_OP_OVER },
46     { PIXMAN_OP_OVER_REVERSE,   PIXMAN_OP_DST,          PIXMAN_OP_OVER_REVERSE, PIXMAN_OP_DST },
47     { PIXMAN_OP_IN,             PIXMAN_OP_SRC,          PIXMAN_OP_IN,           PIXMAN_OP_SRC },
48     { PIXMAN_OP_IN_REVERSE,     PIXMAN_OP_DST,          PIXMAN_OP_DST,          PIXMAN_OP_IN_REVERSE },
49     { PIXMAN_OP_OUT,            PIXMAN_OP_CLEAR,        PIXMAN_OP_OUT,          PIXMAN_OP_CLEAR },
50     { PIXMAN_OP_OUT_REVERSE,    PIXMAN_OP_CLEAR,        PIXMAN_OP_CLEAR,        PIXMAN_OP_OUT_REVERSE },
51     { PIXMAN_OP_ATOP,           PIXMAN_OP_SRC,          PIXMAN_OP_IN,           PIXMAN_OP_OVER },
52     { PIXMAN_OP_ATOP_REVERSE,   PIXMAN_OP_DST,          PIXMAN_OP_OVER_REVERSE, PIXMAN_OP_IN_REVERSE },
53     { PIXMAN_OP_XOR,            PIXMAN_OP_CLEAR,        PIXMAN_OP_OUT,          PIXMAN_OP_OUT_REVERSE },
54     { PIXMAN_OP_SATURATE,       PIXMAN_OP_DST,          PIXMAN_OP_OVER_REVERSE, PIXMAN_OP_DST },
55     { PIXMAN_OP_NONE }
56 };
57
58 static pixman_implementation_t *imp;
59
60 /*
61  * Check if the current operator could be optimized
62  */
63 static const optimized_operator_info_t*
64 pixman_operator_can_be_optimized (pixman_op_t op)
65 {
66     const optimized_operator_info_t *info;
67
68     for (info = optimized_operators; info->op != PIXMAN_OP_NONE; info++)
69     {
70         if (info->op == op)
71             return info;
72     }
73     return NULL;
74 }
75
76 /*
77  * Optimize the current operator based on opacity of source or destination
78  * The output operator should be mathematically equivalent to the source.
79  */
80 static pixman_op_t
81 pixman_optimize_operator (pixman_op_t     op,
82                           pixman_image_t *src_image,
83                           pixman_image_t *mask_image,
84                           pixman_image_t *dst_image)
85 {
86     pixman_bool_t is_source_opaque;
87     pixman_bool_t is_dest_opaque;
88     const optimized_operator_info_t *info = pixman_operator_can_be_optimized (op);
89
90     if (!info || mask_image)
91         return op;
92
93     is_source_opaque = _pixman_image_is_opaque (src_image);
94     is_dest_opaque = _pixman_image_is_opaque (dst_image);
95
96     if (is_source_opaque == FALSE && is_dest_opaque == FALSE)
97         return op;
98
99     if (is_source_opaque && is_dest_opaque)
100         return info->op_src_dst_opaque;
101     else if (is_source_opaque)
102         return info->op_src_opaque;
103     else if (is_dest_opaque)
104         return info->op_dst_opaque;
105
106     return op;
107
108 }
109
110 static void
111 apply_workaround (pixman_image_t *image,
112                   int32_t *       x,
113                   int32_t *       y,
114                   uint32_t **     save_bits,
115                   int *           save_dx,
116                   int *           save_dy)
117 {
118     /* Some X servers generate images that point to the
119      * wrong place in memory, but then set the clip region
120      * to point to the right place. Because of an old bug
121      * in pixman, this would actually work.
122      *
123      * Here we try and undo the damage
124      */
125     int bpp = PIXMAN_FORMAT_BPP (image->bits.format) / 8;
126     pixman_box32_t *extents;
127     uint8_t *t;
128     int dx, dy;
129
130     extents = pixman_region32_extents (&(image->common.clip_region));
131     dx = extents->x1;
132     dy = extents->y1;
133
134     *save_bits = image->bits.bits;
135
136     *x -= dx;
137     *y -= dy;
138     pixman_region32_translate (&(image->common.clip_region), -dx, -dy);
139
140     t = (uint8_t *)image->bits.bits;
141     t += dy * image->bits.rowstride * 4 + dx * bpp;
142     image->bits.bits = (uint32_t *)t;
143
144     *save_dx = dx;
145     *save_dy = dy;
146 }
147
148 static void
149 unapply_workaround (pixman_image_t *image, uint32_t *bits, int dx, int dy)
150 {
151     image->bits.bits = bits;
152     pixman_region32_translate (&image->common.clip_region, dx, dy);
153 }
154
155 PIXMAN_EXPORT void
156 pixman_image_composite (pixman_op_t      op,
157                         pixman_image_t * src,
158                         pixman_image_t * mask,
159                         pixman_image_t * dest,
160                         int16_t          src_x,
161                         int16_t          src_y,
162                         int16_t          mask_x,
163                         int16_t          mask_y,
164                         int16_t          dest_x,
165                         int16_t          dest_y,
166                         uint16_t         width,
167                         uint16_t         height)
168 {
169     pixman_image_composite32 (op, src, mask, dest, src_x, src_y, 
170                               mask_x, mask_y, dest_x, dest_y, width, height);
171 }
172
173 PIXMAN_EXPORT void
174 pixman_image_composite32 (pixman_op_t      op,
175                           pixman_image_t * src,
176                           pixman_image_t * mask,
177                           pixman_image_t * dest,
178                           int32_t          src_x,
179                           int32_t          src_y,
180                           int32_t          mask_x,
181                           int32_t          mask_y,
182                           int32_t          dest_x,
183                           int32_t          dest_y,
184                           int32_t          width,
185                           int32_t          height)
186 {
187     uint32_t *src_bits;
188     int src_dx, src_dy;
189     uint32_t *mask_bits;
190     int mask_dx, mask_dy;
191     uint32_t *dest_bits;
192     int dest_dx, dest_dy;
193
194     _pixman_image_validate (src);
195     if (mask)
196         _pixman_image_validate (mask);
197     _pixman_image_validate (dest);
198     
199     /*
200      * Check if we can replace our operator by a simpler one
201      * if the src or dest are opaque. The output operator should be
202      * mathematically equivalent to the source.
203      */
204     op = pixman_optimize_operator(op, src, mask, dest);
205     if (op == PIXMAN_OP_DST             ||
206         op == PIXMAN_OP_CONJOINT_DST    ||
207         op == PIXMAN_OP_DISJOINT_DST)
208     {
209         return;
210     }
211
212     if (!imp)
213         imp = _pixman_choose_implementation ();
214
215     if (src->common.need_workaround)
216         apply_workaround (src, &src_x, &src_y, &src_bits, &src_dx, &src_dy);
217     if (mask && mask->common.need_workaround)
218         apply_workaround (mask, &mask_x, &mask_y, &mask_bits, &mask_dx, &mask_dy);
219     if (dest->common.need_workaround)
220         apply_workaround (dest, &dest_x, &dest_y, &dest_bits, &dest_dx, &dest_dy);
221
222     _pixman_implementation_composite (imp, op,
223                                       src, mask, dest,
224                                       src_x, src_y,
225                                       mask_x, mask_y,
226                                       dest_x, dest_y,
227                                       width, height);
228
229     if (src->common.need_workaround)
230         unapply_workaround (src, src_bits, src_dx, src_dy);
231     if (mask && mask->common.need_workaround)
232         unapply_workaround (mask, mask_bits, mask_dx, mask_dy);
233     if (dest->common.need_workaround)
234         unapply_workaround (dest, dest_bits, dest_dx, dest_dy);
235 }
236
237 PIXMAN_EXPORT pixman_bool_t
238 pixman_blt (uint32_t *src_bits,
239             uint32_t *dst_bits,
240             int       src_stride,
241             int       dst_stride,
242             int       src_bpp,
243             int       dst_bpp,
244             int       src_x,
245             int       src_y,
246             int       dst_x,
247             int       dst_y,
248             int       width,
249             int       height)
250 {
251     if (!imp)
252         imp = _pixman_choose_implementation ();
253
254     return _pixman_implementation_blt (imp, src_bits, dst_bits, src_stride, dst_stride,
255                                        src_bpp, dst_bpp,
256                                        src_x, src_y,
257                                        dst_x, dst_y,
258                                        width, height);
259 }
260
261 PIXMAN_EXPORT pixman_bool_t
262 pixman_fill (uint32_t *bits,
263              int       stride,
264              int       bpp,
265              int       x,
266              int       y,
267              int       width,
268              int       height,
269              uint32_t xor)
270 {
271     if (!imp)
272         imp = _pixman_choose_implementation ();
273
274     return _pixman_implementation_fill (imp, bits, stride, bpp, x, y, width, height, xor);
275 }
276
277 static uint32_t
278 color_to_uint32 (const pixman_color_t *color)
279 {
280     return
281         (color->alpha >> 8 << 24) |
282         (color->red >> 8 << 16) |
283         (color->green & 0xff00) |
284         (color->blue >> 8);
285 }
286
287 static pixman_bool_t
288 color_to_pixel (pixman_color_t *     color,
289                 uint32_t *           pixel,
290                 pixman_format_code_t format)
291 {
292     uint32_t c = color_to_uint32 (color);
293
294     if (!(format == PIXMAN_a8r8g8b8     ||
295           format == PIXMAN_x8r8g8b8     ||
296           format == PIXMAN_a8b8g8r8     ||
297           format == PIXMAN_x8b8g8r8     ||
298           format == PIXMAN_b8g8r8a8     ||
299           format == PIXMAN_b8g8r8x8     ||
300           format == PIXMAN_r5g6b5       ||
301           format == PIXMAN_b5g6r5       ||
302           format == PIXMAN_a8))
303     {
304         return FALSE;
305     }
306
307     if (PIXMAN_FORMAT_TYPE (format) == PIXMAN_TYPE_ABGR)
308     {
309         c = ((c & 0xff000000) >>  0) |
310             ((c & 0x00ff0000) >> 16) |
311             ((c & 0x0000ff00) >>  0) |
312             ((c & 0x000000ff) << 16);
313     }
314     if (PIXMAN_FORMAT_TYPE (format) == PIXMAN_TYPE_BGRA)
315     {
316         c = ((c & 0xff000000) >> 24) |
317             ((c & 0x00ff0000) >>  8) |
318             ((c & 0x0000ff00) <<  8) |
319             ((c & 0x000000ff) << 24);
320     }
321
322     if (format == PIXMAN_a8)
323         c = c >> 24;
324     else if (format == PIXMAN_r5g6b5 ||
325              format == PIXMAN_b5g6r5)
326         c = CONVERT_8888_TO_0565 (c);
327
328 #if 0
329     printf ("color: %x %x %x %x\n", color->alpha, color->red, color->green, color->blue);
330     printf ("pixel: %x\n", c);
331 #endif
332
333     *pixel = c;
334     return TRUE;
335 }
336
337 PIXMAN_EXPORT pixman_bool_t
338 pixman_image_fill_rectangles (pixman_op_t                 op,
339                               pixman_image_t *            dest,
340                               pixman_color_t *            color,
341                               int                         n_rects,
342                               const pixman_rectangle16_t *rects)
343 {
344     pixman_image_t *solid;
345     pixman_color_t c;
346     int i;
347
348     _pixman_image_validate (dest);
349     
350     if (color->alpha == 0xffff)
351     {
352         if (op == PIXMAN_OP_OVER)
353             op = PIXMAN_OP_SRC;
354     }
355
356     if (op == PIXMAN_OP_CLEAR)
357     {
358         c.red = 0;
359         c.green = 0;
360         c.blue = 0;
361         c.alpha = 0;
362
363         color = &c;
364
365         op = PIXMAN_OP_SRC;
366     }
367
368     if (op == PIXMAN_OP_SRC)
369     {
370         uint32_t pixel;
371
372         if (color_to_pixel (color, &pixel, dest->bits.format))
373         {
374             for (i = 0; i < n_rects; ++i)
375             {
376                 pixman_region32_t fill_region;
377                 int n_boxes, j;
378                 pixman_box32_t *boxes;
379
380                 pixman_region32_init_rect (&fill_region, rects[i].x, rects[i].y, rects[i].width, rects[i].height);
381
382                 if (dest->common.have_clip_region)
383                 {
384                     if (!pixman_region32_intersect (&fill_region,
385                                                     &fill_region,
386                                                     &dest->common.clip_region))
387                         return FALSE;
388                 }
389
390                 boxes = pixman_region32_rectangles (&fill_region, &n_boxes);
391                 for (j = 0; j < n_boxes; ++j)
392                 {
393                     const pixman_box32_t *box = &(boxes[j]);
394                     pixman_fill (dest->bits.bits, dest->bits.rowstride, PIXMAN_FORMAT_BPP (dest->bits.format),
395                                  box->x1, box->y1, box->x2 - box->x1, box->y2 - box->y1,
396                                  pixel);
397                 }
398
399                 pixman_region32_fini (&fill_region);
400             }
401             return TRUE;
402         }
403     }
404
405     solid = pixman_image_create_solid_fill (color);
406     if (!solid)
407         return FALSE;
408
409     for (i = 0; i < n_rects; ++i)
410     {
411         const pixman_rectangle16_t *rect = &(rects[i]);
412
413         pixman_image_composite (op, solid, NULL, dest,
414                                 0, 0, 0, 0,
415                                 rect->x, rect->y,
416                                 rect->width, rect->height);
417     }
418
419     pixman_image_unref (solid);
420
421     return TRUE;
422 }
423
424 PIXMAN_EXPORT pixman_bool_t
425 pixman_image_fill_boxes (pixman_op_t           op,
426                          pixman_image_t *      dest,
427                          pixman_color_t *      color,
428                          int                   n_boxes,
429                          const pixman_box32_t *boxes)
430 {
431     pixman_image_t *solid;
432     pixman_color_t c;
433     int i;
434
435     _pixman_image_validate (dest);
436     
437     if (color->alpha == 0xffff)
438     {
439         if (op == PIXMAN_OP_OVER)
440             op = PIXMAN_OP_SRC;
441     }
442
443     if (op == PIXMAN_OP_CLEAR)
444     {
445         c.red = 0;
446         c.green = 0;
447         c.blue = 0;
448         c.alpha = 0;
449
450         color = &c;
451
452         op = PIXMAN_OP_SRC;
453     }
454
455     if (op == PIXMAN_OP_SRC)
456     {
457         uint32_t pixel;
458
459         if (color_to_pixel (color, &pixel, dest->bits.format))
460         {
461             pixman_region32_t fill_region;
462             int n_rects, j;
463             pixman_box32_t *rects;
464
465             if (!pixman_region32_init_rects (&fill_region, boxes, n_boxes))
466                 return FALSE;
467
468             if (dest->common.have_clip_region)
469             {
470                 if (!pixman_region32_intersect (&fill_region,
471                                                 &fill_region,
472                                                 &dest->common.clip_region))
473                     return FALSE;
474             }
475
476             rects = pixman_region32_rectangles (&fill_region, &n_rects);
477             for (j = 0; j < n_rects; ++j)
478             {
479                 const pixman_box32_t *rect = &(rects[j]);
480                 pixman_fill (dest->bits.bits, dest->bits.rowstride, PIXMAN_FORMAT_BPP (dest->bits.format),
481                              rect->x1, rect->y1, rect->x2 - rect->x1, rect->y2 - rect->y1,
482                              pixel);
483             }
484
485             pixman_region32_fini (&fill_region);
486             return TRUE;
487         }
488     }
489
490     solid = pixman_image_create_solid_fill (color);
491     if (!solid)
492         return FALSE;
493
494     for (i = 0; i < n_boxes; ++i)
495     {
496         const pixman_box32_t *box = &(boxes[i]);
497
498         pixman_image_composite32 (op, solid, NULL, dest,
499                                   0, 0, 0, 0,
500                                   box->x1, box->y1,
501                                   box->x2 - box->x1, box->y2 - box->y1);
502     }
503
504     pixman_image_unref (solid);
505
506     return TRUE;
507 }
508
509 /**
510  * pixman_version:
511  *
512  * Returns the version of the pixman library encoded in a single
513  * integer as per %PIXMAN_VERSION_ENCODE. The encoding ensures that
514  * later versions compare greater than earlier versions.
515  *
516  * A run-time comparison to check that pixman's version is greater than
517  * or equal to version X.Y.Z could be performed as follows:
518  *
519  * <informalexample><programlisting>
520  * if (pixman_version() >= PIXMAN_VERSION_ENCODE(X,Y,Z)) {...}
521  * </programlisting></informalexample>
522  *
523  * See also pixman_version_string() as well as the compile-time
524  * equivalents %PIXMAN_VERSION and %PIXMAN_VERSION_STRING.
525  *
526  * Return value: the encoded version.
527  **/
528 PIXMAN_EXPORT int
529 pixman_version (void)
530 {
531     return PIXMAN_VERSION;
532 }
533
534 /**
535  * pixman_version_string:
536  *
537  * Returns the version of the pixman library as a human-readable string
538  * of the form "X.Y.Z".
539  *
540  * See also pixman_version() as well as the compile-time equivalents
541  * %PIXMAN_VERSION_STRING and %PIXMAN_VERSION.
542  *
543  * Return value: a string containing the version.
544  **/
545 PIXMAN_EXPORT const char*
546 pixman_version_string (void)
547 {
548     return PIXMAN_VERSION_STRING;
549 }
550
551 /**
552  * pixman_format_supported_source:
553  * @format: A pixman_format_code_t format
554  *
555  * Return value: whether the provided format code is a supported
556  * format for a pixman surface used as a source in
557  * rendering.
558  *
559  * Currently, all pixman_format_code_t values are supported.
560  **/
561 PIXMAN_EXPORT pixman_bool_t
562 pixman_format_supported_source (pixman_format_code_t format)
563 {
564     switch (format)
565     {
566     /* 32 bpp formats */
567     case PIXMAN_a2b10g10r10:
568     case PIXMAN_x2b10g10r10:
569     case PIXMAN_a2r10g10b10:
570     case PIXMAN_x2r10g10b10:
571     case PIXMAN_a8r8g8b8:
572     case PIXMAN_x8r8g8b8:
573     case PIXMAN_a8b8g8r8:
574     case PIXMAN_x8b8g8r8:
575     case PIXMAN_b8g8r8a8:
576     case PIXMAN_b8g8r8x8:
577     case PIXMAN_r8g8b8:
578     case PIXMAN_b8g8r8:
579     case PIXMAN_r5g6b5:
580     case PIXMAN_b5g6r5:
581     /* 16 bpp formats */
582     case PIXMAN_a1r5g5b5:
583     case PIXMAN_x1r5g5b5:
584     case PIXMAN_a1b5g5r5:
585     case PIXMAN_x1b5g5r5:
586     case PIXMAN_a4r4g4b4:
587     case PIXMAN_x4r4g4b4:
588     case PIXMAN_a4b4g4r4:
589     case PIXMAN_x4b4g4r4:
590     /* 8bpp formats */
591     case PIXMAN_a8:
592     case PIXMAN_r3g3b2:
593     case PIXMAN_b2g3r3:
594     case PIXMAN_a2r2g2b2:
595     case PIXMAN_a2b2g2r2:
596     case PIXMAN_c8:
597     case PIXMAN_g8:
598     case PIXMAN_x4a4:
599     /* Collides with PIXMAN_c8
600        case PIXMAN_x4c4:
601      */
602     /* Collides with PIXMAN_g8
603        case PIXMAN_x4g4:
604      */
605     /* 4bpp formats */
606     case PIXMAN_a4:
607     case PIXMAN_r1g2b1:
608     case PIXMAN_b1g2r1:
609     case PIXMAN_a1r1g1b1:
610     case PIXMAN_a1b1g1r1:
611     case PIXMAN_c4:
612     case PIXMAN_g4:
613     /* 1bpp formats */
614     case PIXMAN_a1:
615     case PIXMAN_g1:
616     /* YUV formats */
617     case PIXMAN_yuy2:
618     case PIXMAN_yv12:
619         return TRUE;
620
621     default:
622         return FALSE;
623     }
624 }
625
626 /**
627  * pixman_format_supported_destination:
628  * @format: A pixman_format_code_t format
629  *
630  * Return value: whether the provided format code is a supported
631  * format for a pixman surface used as a destination in
632  * rendering.
633  *
634  * Currently, all pixman_format_code_t values are supported
635  * except for the YUV formats.
636  **/
637 PIXMAN_EXPORT pixman_bool_t
638 pixman_format_supported_destination (pixman_format_code_t format)
639 {
640     /* YUV formats cannot be written to at the moment */
641     if (format == PIXMAN_yuy2 || format == PIXMAN_yv12)
642         return FALSE;
643
644     return pixman_format_supported_source (format);
645 }
646