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 void
 247 _pixman_image_validate (pixman_image_t *image)
 248 {
 249     if (image->common.dirty)
 250     {
 251         image->common.property_changed (image);
 252         image->common.dirty = FALSE;
 253     }
 254
 255     if (image->common.alpha_map)
 256         _pixman_image_validate ((pixman_image_t *)image->common.alpha_map);
 257 }
 258
 259 PIXMAN_EXPORT pixman_bool_t
 260 pixman_image_set_clip_region32 (pixman_image_t *   image,
 261                                 pixman_region32_t *region)
 262 {
 263     image_common_t *common = (image_common_t *)image;
 264     pixman_bool_t result;
 265
 266     if (region)
 267     {
 268         if ((result = pixman_region32_copy (&common->clip_region, region)))
 269             image->common.have_clip_region = TRUE;
 270     }
 271     else
 272     {
 273         _pixman_image_reset_clip_region (image);
 274
 275         result = TRUE;
 276     }
 277
 278     image_property_changed (image);
 279
 280     return result;
 281 }
 282
 283 PIXMAN_EXPORT pixman_bool_t
 284 pixman_image_set_clip_region (pixman_image_t *   image,
 285                               pixman_region16_t *region)
 286 {
 287     image_common_t *common = (image_common_t *)image;
 288     pixman_bool_t result;
 289
 290     if (region)
 291     {
 292         if ((result = pixman_region32_copy_from_region16 (&common->clip_region, region)))
 293             image->common.have_clip_region = TRUE;
 294     }
 295     else
 296     {
 297         _pixman_image_reset_clip_region (image);
 298
 299         result = TRUE;
 300     }
 301
 302     image_property_changed (image);
 303
 304     return result;
 305 }
 306
 307 PIXMAN_EXPORT void
 308 pixman_image_set_has_client_clip (pixman_image_t *image,
 309                                   pixman_bool_t   client_clip)
 310 {
 311     image->common.client_clip = client_clip;
 312 }
 313
 314 PIXMAN_EXPORT pixman_bool_t
 315 pixman_image_set_transform (pixman_image_t *          image,
 316                             const pixman_transform_t *transform)
 317 {
 318     static const pixman_transform_t id =
 319     {
 320         { { pixman_fixed_1, 0, 0 },
 321           { 0, pixman_fixed_1, 0 },
 322           { 0, 0, pixman_fixed_1 } }
 323     };
 324
 325     image_common_t *common = (image_common_t *)image;
 326     pixman_bool_t result;
 327
 328     if (common->transform == transform)
 329         return TRUE;
 330
 331     if (memcmp (&id, transform, sizeof (pixman_transform_t)) == 0)
 332     {
 333         free (common->transform);
 334         common->transform = NULL;
 335         result = TRUE;
 336
 337         goto out;
 338     }
 339
 340     if (common->transform == NULL)
 341         common->transform = malloc (sizeof (pixman_transform_t));
 342
 343     if (common->transform == NULL)
 344     {
 345         result = FALSE;
 346
 347         goto out;
 348     }
 349
 350     memcpy (common->transform, transform, sizeof(pixman_transform_t));
 351
 352     result = TRUE;
 353
 354 out:
 355     image_property_changed (image);
 356
 357     return result;
 358 }
 359
 360 PIXMAN_EXPORT void
 361 pixman_image_set_repeat (pixman_image_t *image,
 362                          pixman_repeat_t repeat)
 363 {
 364     image->common.repeat = repeat;
 365
 366     image_property_changed (image);
 367 }
 368
 369 PIXMAN_EXPORT pixman_bool_t
 370 pixman_image_set_filter (pixman_image_t *      image,
 371                          pixman_filter_t       filter,
 372                          const pixman_fixed_t *params,
 373                          int                   n_params)
 374 {
 375     image_common_t *common = (image_common_t *)image;
 376     pixman_fixed_t *new_params;
 377
 378     if (params == common->filter_params && filter == common->filter)
 379         return TRUE;
 380
 381     new_params = NULL;
 382     if (params)
 383     {
 384         new_params = pixman_malloc_ab (n_params, sizeof (pixman_fixed_t));
 385         if (!new_params)
 386             return FALSE;
 387
 388         memcpy (new_params,
 389                 params, n_params * sizeof (pixman_fixed_t));
 390     }
 391
 392     common->filter = filter;
 393
 394     if (common->filter_params)
 395         free (common->filter_params);
 396
 397     common->filter_params = new_params;
 398     common->n_filter_params = n_params;
 399
 400     image_property_changed (image);
 401     return TRUE;
 402 }
 403
 404 PIXMAN_EXPORT void
 405 pixman_image_set_source_clipping (pixman_image_t *image,
 406                                   pixman_bool_t   clip_sources)
 407 {
 408     image->common.clip_sources = clip_sources;
 409
 410     image_property_changed (image);
 411 }
 412
 413 /* Unlike all the other property setters, this function does not
 414  * copy the content of indexed. Doing this copying is simply
 415  * way, way too expensive.
 416  */
 417 PIXMAN_EXPORT void
 418 pixman_image_set_indexed (pixman_image_t *        image,
 419                           const pixman_indexed_t *indexed)
 420 {
 421     bits_image_t *bits = (bits_image_t *)image;
 422
 423     bits->indexed = indexed;
 424
 425     image_property_changed (image);
 426 }
 427
 428 PIXMAN_EXPORT void
 429 pixman_image_set_alpha_map (pixman_image_t *image,
 430                             pixman_image_t *alpha_map,
 431                             int16_t         x,
 432                             int16_t         y)
 433 {
 434     image_common_t *common = (image_common_t *)image;
 435
 436     return_if_fail (!alpha_map || alpha_map->type == BITS);
 437
 438     if (common->alpha_map != (bits_image_t *)alpha_map)
 439     {
 440         if (common->alpha_map)
 441             pixman_image_unref ((pixman_image_t *)common->alpha_map);
 442
 443         if (alpha_map)
 444             common->alpha_map = (bits_image_t *)pixman_image_ref (alpha_map);
 445         else
 446             common->alpha_map = NULL;
 447     }
 448
 449     common->alpha_origin_x = x;
 450     common->alpha_origin_y = y;
 451
 452     image_property_changed (image);
 453 }
 454
 455 PIXMAN_EXPORT void
 456 pixman_image_set_component_alpha   (pixman_image_t *image,
 457                                     pixman_bool_t   component_alpha)
 458 {
 459     image->common.component_alpha = component_alpha;
 460
 461     image_property_changed (image);
 462 }
 463
 464 PIXMAN_EXPORT void
 465 pixman_image_set_accessors (pixman_image_t *           image,
 466                             pixman_read_memory_func_t  read_func,
 467                             pixman_write_memory_func_t write_func)
 468 {
 469     return_if_fail (image != NULL);
 470
 471     if (image->type == BITS)
 472     {
 473         image->bits.read_func = read_func;
 474         image->bits.write_func = write_func;
 475
 476         image_property_changed (image);
 477     }
 478 }
 479
 480 PIXMAN_EXPORT uint32_t *
 481 pixman_image_get_data (pixman_image_t *image)
 482 {
 483     if (image->type == BITS)
 484         return image->bits.bits;
 485
 486     return NULL;
 487 }
 488
 489 PIXMAN_EXPORT int
 490 pixman_image_get_width (pixman_image_t *image)
 491 {
 492     if (image->type == BITS)
 493         return image->bits.width;
 494
 495     return 0;
 496 }
 497
 498 PIXMAN_EXPORT int
 499 pixman_image_get_height (pixman_image_t *image)
 500 {
 501     if (image->type == BITS)
 502         return image->bits.height;
 503
 504     return 0;
 505 }
 506
 507 PIXMAN_EXPORT int
 508 pixman_image_get_stride (pixman_image_t *image)
 509 {
 510     if (image->type == BITS)
 511         return image->bits.rowstride * (int) sizeof (uint32_t);
 512
 513     return 0;
 514 }
 515
 516 PIXMAN_EXPORT int
 517 pixman_image_get_depth (pixman_image_t *image)
 518 {
 519     if (image->type == BITS)
 520         return PIXMAN_FORMAT_DEPTH (image->bits.format);
 521
 522     return 0;
 523 }
 524
 525 pixman_bool_t
 526 _pixman_image_is_solid (pixman_image_t *image)
 527 {
 528     if (image->type == SOLID)
 529         return TRUE;
 530
 531     if (image->type != BITS     ||
 532         image->bits.width != 1  ||
 533         image->bits.height != 1)
 534     {
 535         return FALSE;
 536     }
 537
 538     if (image->common.repeat == PIXMAN_REPEAT_NONE)
 539         return FALSE;
 540
 541     return TRUE;
 542 }
 543
 544 uint32_t
 545 _pixman_image_get_solid (pixman_image_t *     image,
 546                          pixman_format_code_t format)
 547 {
 548     uint32_t result;
 549
 550     _pixman_image_get_scanline_32 (image, 0, 0, 1, &result, NULL, 0);
 551
 552     /* If necessary, convert RGB <--> BGR. */
 553     if (PIXMAN_FORMAT_TYPE (format) != PIXMAN_TYPE_ARGB)
 554     {
 555         result = (((result & 0xff000000) >>  0) |
 556                   ((result & 0x00ff0000) >> 16) |
 557                   ((result & 0x0000ff00) >>  0) |
 558                   ((result & 0x000000ff) << 16));
 559     }
 560
 561     return result;
 562 }
 563
 564 pixman_bool_t
 565 _pixman_image_is_opaque (pixman_image_t *image)
 566 {
 567     int i;
 568
 569     if (image->common.alpha_map)
 570         return FALSE;
 571
 572     switch (image->type)
 573     {
 574     case BITS:
 575         if (image->common.repeat == PIXMAN_REPEAT_NONE)
 576             return FALSE;
 577
 578         if (PIXMAN_FORMAT_A (image->bits.format))
 579             return FALSE;
 580         break;
 581
 582     case LINEAR:
 583     case RADIAL:
 584         if (image->common.repeat == PIXMAN_REPEAT_NONE)
 585             return FALSE;
 586
 587         for (i = 0; i < image->gradient.n_stops; ++i)
 588         {
 589             if (image->gradient.stops[i].color.alpha != 0xffff)
 590                 return FALSE;
 591         }
 592         break;
 593
 594     case CONICAL:
 595         /* Conical gradients always have a transparent border */
 596         return FALSE;
 597         break;
 598
 599     case SOLID:
 600         if (image->solid.color.alpha != 0xffff)
 601             return FALSE;
 602         break;
 603
 604     default:
 605         return FALSE;
 606         break;
 607     }
 608
 609     /* Convolution filters can introduce translucency if the sum of the
 610      * weights is lower than 1.
 611      */
 612     if (image->common.filter == PIXMAN_FILTER_CONVOLUTION)
 613         return FALSE;
 614
 615     return TRUE;
 616 }
 617