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->need_workaround = FALSE;
 121         common->dirty = TRUE;
 122     }
 123
 124     return image;
 125 }
 126
 127 source_image_class_t
 128 _pixman_image_classify (pixman_image_t *image,
 129                         int             x,
 130                         int             y,
 131                         int             width,
 132                         int             height)
 133 {
 134     if (image->common.classify)
 135         return image->common.classify (image, x, y, width, height);
 136     else
 137         return SOURCE_IMAGE_CLASS_UNKNOWN;
 138 }
 139
 140 void
 141 _pixman_image_get_scanline_32 (pixman_image_t *image,
 142                                int             x,
 143                                int             y,
 144                                int             width,
 145                                uint32_t *      buffer,
 146                                const uint32_t *mask,
 147                                uint32_t        mask_bits)
 148 {
 149     image->common.get_scanline_32 (image, x, y, width, buffer, mask, mask_bits);
 150 }
 151
 152 /* Even thought the type of buffer is uint32_t *, the function actually expects
 153  * a uint64_t *buffer.
 154  */
 155 void
 156 _pixman_image_get_scanline_64 (pixman_image_t *image,
 157                                int             x,
 158                                int             y,
 159                                int             width,
 160                                uint32_t *      buffer,
 161                                const uint32_t *unused,
 162                                uint32_t        unused2)
 163 {
 164     image->common.get_scanline_64 (image, x, y, width, buffer, unused, unused2);
 165 }
 166
 167 static void
 168 image_property_changed (pixman_image_t *image)
 169 {
 170     image->common.dirty = TRUE;
 171 }
 172
 173 /* Ref Counting */
 174 PIXMAN_EXPORT pixman_image_t *
 175 pixman_image_ref (pixman_image_t *image)
 176 {
 177     image->common.ref_count++;
 178
 179     return image;
 180 }
 181
 182 /* returns TRUE when the image is freed */
 183 PIXMAN_EXPORT pixman_bool_t
 184 pixman_image_unref (pixman_image_t *image)
 185 {
 186     image_common_t *common = (image_common_t *)image;
 187
 188     common->ref_count--;
 189
 190     if (common->ref_count == 0)
 191     {
 192         if (image->common.destroy_func)
 193             image->common.destroy_func (image, image->common.destroy_data);
 194
 195         pixman_region32_fini (&common->clip_region);
 196
 197         if (common->transform)
 198             free (common->transform);
 199
 200         if (common->filter_params)
 201             free (common->filter_params);
 202
 203         if (common->alpha_map)
 204             pixman_image_unref ((pixman_image_t *)common->alpha_map);
 205
 206         if (image->type == LINEAR ||
 207             image->type == RADIAL ||
 208             image->type == CONICAL)
 209         {
 210             if (image->gradient.stops)
 211                 free (image->gradient.stops);
 212         }
 213
 214         if (image->type == BITS && image->bits.free_me)
 215             free (image->bits.free_me);
 216
 217         free (image);
 218
 219         return TRUE;
 220     }
 221
 222     return FALSE;
 223 }
 224
 225 PIXMAN_EXPORT void
 226 pixman_image_set_destroy_function (pixman_image_t *            image,
 227                                    pixman_image_destroy_func_t func,
 228                                    void *                      data)
 229 {
 230     image->common.destroy_func = func;
 231     image->common.destroy_data = data;
 232 }
 233
 234 PIXMAN_EXPORT void *
 235 pixman_image_get_destroy_data (pixman_image_t *image)
 236 {
 237   return image->common.destroy_data;
 238 }
 239
 240 void
 241 _pixman_image_reset_clip_region (pixman_image_t *image)
 242 {
 243     image->common.have_clip_region = FALSE;
 244 }
 245
 246 static void
 247 compute_flags (pixman_image_t *image)
 248 {
 249     uint32_t flags = 0;
 250
 251     if (!image->common.transform)
 252     {
 253         flags |= FAST_PATH_ID_TRANSFORM;
 254     }
 255     else if (image->common.transform &&
 256              image->common.transform->matrix[0][1] == 0 &&
 257              image->common.transform->matrix[1][0] == 0 &&
 258              image->common.transform->matrix[2][0] == 0 &&
 259              image->common.transform->matrix[2][1] == 0 &&
 260              image->common.transform->matrix[2][2] == pixman_fixed_1)
 261     {
 262         flags |= FAST_PATH_SCALE_TRANSFORM;
 263     }
 264
 265     if (!image->common.alpha_map)
 266         flags |= FAST_PATH_NO_ALPHA_MAP;
 267
 268     if (image->common.filter != PIXMAN_FILTER_CONVOLUTION)
 269     {
 270         flags |= FAST_PATH_NO_CONVOLUTION_FILTER;
 271
 272         if (image->common.filter == PIXMAN_FILTER_NEAREST)
 273             flags |= FAST_PATH_NEAREST_FILTER;
 274     }
 275
 276     if (image->common.repeat != PIXMAN_REPEAT_PAD)
 277         flags |= FAST_PATH_NO_PAD_REPEAT;
 278
 279     if (image->common.repeat != PIXMAN_REPEAT_REFLECT)
 280         flags |= FAST_PATH_NO_REFLECT_REPEAT;
 281
 282     flags |= (FAST_PATH_NO_ACCESSORS | FAST_PATH_NO_WIDE_FORMAT);
 283     if (image->common.type == BITS)
 284     {
 285         if (image->bits.read_func || image->bits.write_func)
 286             flags &= ~FAST_PATH_NO_ACCESSORS;
 287
 288         if (PIXMAN_FORMAT_IS_WIDE (image->bits.format))
 289             flags &= ~FAST_PATH_NO_WIDE_FORMAT;
 290     }
 291
 292     if (image->common.component_alpha)
 293         flags |= FAST_PATH_COMPONENT_ALPHA;
 294     else
 295         flags |= FAST_PATH_UNIFIED_ALPHA;
 296
 297     image->common.flags = flags;
 298 }
 299
 300 void
 301 _pixman_image_validate (pixman_image_t *image)
 302 {
 303     if (image->common.dirty)
 304     {
 305         image->common.property_changed (image);
 306
 307         compute_flags (image);
 308
 309         image->common.dirty = FALSE;
 310     }
 311
 312     if (image->common.alpha_map)
 313         _pixman_image_validate ((pixman_image_t *)image->common.alpha_map);
 314 }
 315
 316 PIXMAN_EXPORT pixman_bool_t
 317 pixman_image_set_clip_region32 (pixman_image_t *   image,
 318                                 pixman_region32_t *region)
 319 {
 320     image_common_t *common = (image_common_t *)image;
 321     pixman_bool_t result;
 322
 323     if (region)
 324     {
 325         if ((result = pixman_region32_copy (&common->clip_region, region)))
 326             image->common.have_clip_region = TRUE;
 327     }
 328     else
 329     {
 330         _pixman_image_reset_clip_region (image);
 331
 332         result = TRUE;
 333     }
 334
 335     image_property_changed (image);
 336
 337     return result;
 338 }
 339
 340 PIXMAN_EXPORT pixman_bool_t
 341 pixman_image_set_clip_region (pixman_image_t *   image,
 342                               pixman_region16_t *region)
 343 {
 344     image_common_t *common = (image_common_t *)image;
 345     pixman_bool_t result;
 346
 347     if (region)
 348     {
 349         if ((result = pixman_region32_copy_from_region16 (&common->clip_region, region)))
 350             image->common.have_clip_region = TRUE;
 351     }
 352     else
 353     {
 354         _pixman_image_reset_clip_region (image);
 355
 356         result = TRUE;
 357     }
 358
 359     image_property_changed (image);
 360
 361     return result;
 362 }
 363
 364 PIXMAN_EXPORT void
 365 pixman_image_set_has_client_clip (pixman_image_t *image,
 366                                   pixman_bool_t   client_clip)
 367 {
 368     image->common.client_clip = client_clip;
 369 }
 370
 371 PIXMAN_EXPORT pixman_bool_t
 372 pixman_image_set_transform (pixman_image_t *          image,
 373                             const pixman_transform_t *transform)
 374 {
 375     static const pixman_transform_t id =
 376     {
 377         { { pixman_fixed_1, 0, 0 },
 378           { 0, pixman_fixed_1, 0 },
 379           { 0, 0, pixman_fixed_1 } }
 380     };
 381
 382     image_common_t *common = (image_common_t *)image;
 383     pixman_bool_t result;
 384
 385     if (common->transform == transform)
 386         return TRUE;
 387
 388     if (memcmp (&id, transform, sizeof (pixman_transform_t)) == 0)
 389     {
 390         free (common->transform);
 391         common->transform = NULL;
 392         result = TRUE;
 393
 394         goto out;
 395     }
 396
 397     if (common->transform == NULL)
 398         common->transform = malloc (sizeof (pixman_transform_t));
 399
 400     if (common->transform == NULL)
 401     {
 402         result = FALSE;
 403
 404         goto out;
 405     }
 406
 407     memcpy (common->transform, transform, sizeof(pixman_transform_t));
 408
 409     result = TRUE;
 410
 411 out:
 412     image_property_changed (image);
 413
 414     return result;
 415 }
 416
 417 PIXMAN_EXPORT void
 418 pixman_image_set_repeat (pixman_image_t *image,
 419                          pixman_repeat_t repeat)
 420 {
 421     image->common.repeat = repeat;
 422
 423     image_property_changed (image);
 424 }
 425
 426 PIXMAN_EXPORT pixman_bool_t
 427 pixman_image_set_filter (pixman_image_t *      image,
 428                          pixman_filter_t       filter,
 429                          const pixman_fixed_t *params,
 430                          int                   n_params)
 431 {
 432     image_common_t *common = (image_common_t *)image;
 433     pixman_fixed_t *new_params;
 434
 435     if (params == common->filter_params && filter == common->filter)
 436         return TRUE;
 437
 438     new_params = NULL;
 439     if (params)
 440     {
 441         new_params = pixman_malloc_ab (n_params, sizeof (pixman_fixed_t));
 442         if (!new_params)
 443             return FALSE;
 444
 445         memcpy (new_params,
 446                 params, n_params * sizeof (pixman_fixed_t));
 447     }
 448
 449     common->filter = filter;
 450
 451     if (common->filter_params)
 452         free (common->filter_params);
 453
 454     common->filter_params = new_params;
 455     common->n_filter_params = n_params;
 456
 457     image_property_changed (image);
 458     return TRUE;
 459 }
 460
 461 PIXMAN_EXPORT void
 462 pixman_image_set_source_clipping (pixman_image_t *image,
 463                                   pixman_bool_t   clip_sources)
 464 {
 465     image->common.clip_sources = clip_sources;
 466
 467     image_property_changed (image);
 468 }
 469
 470 /* Unlike all the other property setters, this function does not
 471  * copy the content of indexed. Doing this copying is simply
 472  * way, way too expensive.
 473  */
 474 PIXMAN_EXPORT void
 475 pixman_image_set_indexed (pixman_image_t *        image,
 476                           const pixman_indexed_t *indexed)
 477 {
 478     bits_image_t *bits = (bits_image_t *)image;
 479
 480     bits->indexed = indexed;
 481
 482     image_property_changed (image);
 483 }
 484
 485 PIXMAN_EXPORT void
 486 pixman_image_set_alpha_map (pixman_image_t *image,
 487                             pixman_image_t *alpha_map,
 488                             int16_t         x,
 489                             int16_t         y)
 490 {
 491     image_common_t *common = (image_common_t *)image;
 492
 493     return_if_fail (!alpha_map || alpha_map->type == BITS);
 494
 495     if (common->alpha_map != (bits_image_t *)alpha_map)
 496     {
 497         if (common->alpha_map)
 498             pixman_image_unref ((pixman_image_t *)common->alpha_map);
 499
 500         if (alpha_map)
 501             common->alpha_map = (bits_image_t *)pixman_image_ref (alpha_map);
 502         else
 503             common->alpha_map = NULL;
 504     }
 505
 506     common->alpha_origin_x = x;
 507     common->alpha_origin_y = y;
 508
 509     image_property_changed (image);
 510 }
 511
 512 PIXMAN_EXPORT void
 513 pixman_image_set_component_alpha   (pixman_image_t *image,
 514                                     pixman_bool_t   component_alpha)
 515 {
 516     image->common.component_alpha = component_alpha;
 517
 518     image_property_changed (image);
 519 }
 520
 521 PIXMAN_EXPORT void
 522 pixman_image_set_accessors (pixman_image_t *           image,
 523                             pixman_read_memory_func_t  read_func,
 524                             pixman_write_memory_func_t write_func)
 525 {
 526     return_if_fail (image != NULL);
 527
 528     if (image->type == BITS)
 529     {
 530         image->bits.read_func = read_func;
 531         image->bits.write_func = write_func;
 532
 533         image_property_changed (image);
 534     }
 535 }
 536
 537 PIXMAN_EXPORT uint32_t *
 538 pixman_image_get_data (pixman_image_t *image)
 539 {
 540     if (image->type == BITS)
 541         return image->bits.bits;
 542
 543     return NULL;
 544 }
 545
 546 PIXMAN_EXPORT int
 547 pixman_image_get_width (pixman_image_t *image)
 548 {
 549     if (image->type == BITS)
 550         return image->bits.width;
 551
 552     return 0;
 553 }
 554
 555 PIXMAN_EXPORT int
 556 pixman_image_get_height (pixman_image_t *image)
 557 {
 558     if (image->type == BITS)
 559         return image->bits.height;
 560
 561     return 0;
 562 }
 563
 564 PIXMAN_EXPORT int
 565 pixman_image_get_stride (pixman_image_t *image)
 566 {
 567     if (image->type == BITS)
 568         return image->bits.rowstride * (int) sizeof (uint32_t);
 569
 570     return 0;
 571 }
 572
 573 PIXMAN_EXPORT int
 574 pixman_image_get_depth (pixman_image_t *image)
 575 {
 576     if (image->type == BITS)
 577         return PIXMAN_FORMAT_DEPTH (image->bits.format);
 578
 579     return 0;
 580 }
 581
 582 pixman_bool_t
 583 _pixman_image_is_solid (pixman_image_t *image)
 584 {
 585     if (image->type == SOLID)
 586         return TRUE;
 587
 588     if (image->type != BITS     ||
 589         image->bits.width != 1  ||
 590         image->bits.height != 1)
 591     {
 592         return FALSE;
 593     }
 594
 595     if (image->common.repeat == PIXMAN_REPEAT_NONE)
 596         return FALSE;
 597
 598     return TRUE;
 599 }
 600
 601 uint32_t
 602 _pixman_image_get_solid (pixman_image_t *     image,
 603                          pixman_format_code_t format)
 604 {
 605     uint32_t result;
 606
 607     _pixman_image_get_scanline_32 (image, 0, 0, 1, &result, NULL, 0);
 608
 609     /* If necessary, convert RGB <--> BGR. */
 610     if (PIXMAN_FORMAT_TYPE (format) != PIXMAN_TYPE_ARGB)
 611     {
 612         result = (((result & 0xff000000) >>  0) |
 613                   ((result & 0x00ff0000) >> 16) |
 614                   ((result & 0x0000ff00) >>  0) |
 615                   ((result & 0x000000ff) << 16));
 616     }
 617
 618     return result;
 619 }
 620
 621 pixman_bool_t
 622 _pixman_image_is_opaque (pixman_image_t *image)
 623 {
 624     int i;
 625
 626     if (image->common.alpha_map)
 627         return FALSE;
 628
 629     switch (image->type)
 630     {
 631     case BITS:
 632         if (image->common.repeat == PIXMAN_REPEAT_NONE)
 633             return FALSE;
 634
 635         if (PIXMAN_FORMAT_A (image->bits.format))
 636             return FALSE;
 637         break;
 638
 639     case LINEAR:
 640     case RADIAL:
 641         if (image->common.repeat == PIXMAN_REPEAT_NONE)
 642             return FALSE;
 643
 644         for (i = 0; i < image->gradient.n_stops; ++i)
 645         {
 646             if (image->gradient.stops[i].color.alpha != 0xffff)
 647                 return FALSE;
 648         }
 649         break;
 650
 651     case CONICAL:
 652         /* Conical gradients always have a transparent border */
 653         return FALSE;
 654         break;
 655
 656     case SOLID:
 657         if (image->solid.color.alpha != 0xffff)
 658             return FALSE;
 659         break;
 660
 661     default:
 662         return FALSE;
 663         break;
 664     }
 665
 666     /* Convolution filters can introduce translucency if the sum of the
 667      * weights is lower than 1.
 668      */
 669     if (image->common.filter == PIXMAN_FILTER_CONVOLUTION)
 670         return FALSE;
 671
 672     return TRUE;
 673 }
 674