palimg.c

   1 /*
   2 =head1 NAME
   3
   4   palimg.c - implements paletted images for Imager.
   5
   6 =head1 SYNOPSIS
   7
   8 =head1 DESCRIPTION
   9
  10 Implements paletted images using the new image interface.
  11
  12 =over
  13
  14 =item IIM_base_8bit_pal
  15
  16 Basic 8-bit/sample paletted image
  17
  18 =cut
  19 */
  20
  21 #include "imager.h"
  22 #include "imageri.h"
  23
  24 #define PALEXT(im) ((i_img_pal_ext*)((im)->ext_data))
  25 static int i_ppix_p(i_img *im, int x, int y, const i_color *val);
  26 static int i_gpix_p(i_img *im, int x, int y, i_color *val);
  27 static int i_glin_p(i_img *im, int l, int r, int y, i_color *vals);
  28 static int i_plin_p(i_img *im, int l, int r, int y, const i_color *vals);
  29 static int i_gsamp_p(i_img *im, int l, int r, int y, i_sample_t *samps, int const *chans, int chan_count);
  30 static int i_gpal_p(i_img *pm, int l, int r, int y, i_palidx *vals);
  31 static int i_ppal_p(i_img *pm, int l, int r, int y, const i_palidx *vals);
  32 static int i_addcolors_p(i_img *im, const i_color *color, int count);
  33 static int i_getcolors_p(i_img *im, int i, i_color *color, int count);
  34 static int i_colorcount_p(i_img *im);
  35 static int i_maxcolors_p(i_img *im);
  36 static int i_findcolor_p(i_img *im, const i_color *color, i_palidx *entry);
  37 static int i_setcolors_p(i_img *im, int index, const i_color *color, int count);
  38
  39 static void i_destroy_p(i_img *im);
  40
  41 static i_img IIM_base_8bit_pal =
  42 {
  43   0, /* channels set */
  44   0, 0, 0, /* xsize, ysize, bytes */
  45   ~0U, /* ch_mask */
  46   i_8_bits, /* bits */
  47   i_palette_type, /* type */
  48   0, /* virtual */
  49   NULL, /* idata */
  50   { 0, 0, NULL }, /* tags */
  51   NULL, /* ext_data */
  52
  53   i_ppix_p, /* i_f_ppix */
  54   i_ppixf_fp, /* i_f_ppixf */
  55   i_plin_p, /* i_f_plin */
  56   i_plinf_fp, /* i_f_plinf */
  57   i_gpix_p, /* i_f_gpix */
  58   i_gpixf_fp, /* i_f_gpixf */
  59   i_glin_p, /* i_f_glin */
  60   i_glinf_fp, /* i_f_glinf */
  61   i_gsamp_p, /* i_f_gsamp */
  62   i_gsampf_fp, /* i_f_gsampf */
  63
  64   i_gpal_p, /* i_f_gpal */
  65   i_ppal_p, /* i_f_ppal */
  66   i_addcolors_p, /* i_f_addcolors */
  67   i_getcolors_p, /* i_f_getcolors */
  68   i_colorcount_p, /* i_f_colorcount */
  69   i_maxcolors_p, /* i_f_maxcolors */
  70   i_findcolor_p, /* i_f_findcolor */
  71   i_setcolors_p, /* i_f_setcolors */
  72
  73   i_destroy_p, /* i_f_destroy */
  74
  75   i_gsamp_bits_fb,
  76   NULL, /* i_f_psamp_bits */
  77 };
  78
  79 /*
  80 =item i_img_pal_new(x, y, channels, maxpal)
  81
  82 =category Image creation/destruction
  83 =synopsis i_img *img = i_img_pal_new(width, height, channels, max_palette_size)
  84
  85 Creates a new paletted image of the supplied dimensions.
  86
  87 I<maxpal> is the maximum palette size and should normally be 256.
  88
  89 Returns a new image or NULL on failure.
  90
  91 =cut
  92 */
  93 i_img *
  94 i_img_pal_new(int x, int y, int channels, int maxpal) {
  95   i_img *im;
  96   i_img_pal_ext *palext;
  97   int bytes, line_bytes;
  98
  99   i_clear_error();
 100   if (maxpal < 1 || maxpal > 256) {
 101     i_push_error(0, "Maximum of 256 palette entries");
 102     return NULL;
 103   }
 104   if (x < 1 || y < 1) {
 105     i_push_error(0, "Image sizes must be positive");
 106     return NULL;
 107   }
 108   if (channels < 1 || channels > MAXCHANNELS) {
 109     i_push_errorf(0, "Channels must be positive and <= %d", MAXCHANNELS);
 110     return NULL;
 111   }
 112   bytes = sizeof(i_palidx) * x * y;
 113   if (bytes / y / sizeof(i_palidx) != x) {
 114     i_push_error(0, "integer overflow calculating image allocation");
 115     return NULL;
 116   }
 117
 118   /* basic assumption: we can always allocate a buffer representing a
 119      line from the image, otherwise we're going to have trouble
 120      working with the image */
 121   line_bytes = sizeof(i_color) * x;
 122   if (line_bytes / x != sizeof(i_color)) {
 123     i_push_error(0, "integer overflow calculating scanline allocation");
 124     return NULL;
 125   }
 126
 127   im = i_img_alloc();
 128   memcpy(im, &IIM_base_8bit_pal, sizeof(i_img));
 129   palext = mymalloc(sizeof(i_img_pal_ext));
 130   palext->pal = mymalloc(sizeof(i_color) * maxpal);
 131   palext->count = 0;
 132   palext->alloc = maxpal;
 133   palext->last_found = -1;
 134   im->ext_data = palext;
 135   i_tags_new(&im->tags);
 136   im->bytes = bytes;
 137   im->idata = mymalloc(im->bytes);
 138   im->channels = channels;
 139   memset(im->idata, 0, im->bytes);
 140   im->xsize = x;
 141   im->ysize = y;
 142
 143   i_img_init(im);
 144
 145   return im;
 146 }
 147
 148 /*
 149 =item i_img_rgb_convert(i_img *targ, i_img *src)
 150
 151 Converts paletted data in src to RGB data in targ
 152
 153 Internal function.
 154
 155 src must be a paletted image and targ must be an RGB image with the
 156 same width, height and channels.
 157
 158 =cut
 159 */
 160 static void i_img_rgb_convert(i_img *targ, i_img *src) {
 161   i_color *row = mymalloc(sizeof(i_color) * targ->xsize);
 162   int y;
 163   for (y = 0; y < targ->ysize; ++y) {
 164     i_glin(src, 0, src->xsize, y, row);
 165     i_plin(targ, 0, src->xsize, y, row);
 166   }
 167   myfree(row);
 168 }
 169
 170 /*
 171 =item i_img_to_rgb_inplace(im)
 172
 173 Converts im from a paletted image to an RGB image.
 174
 175 The conversion is done in place.
 176
 177 The conversion cannot be done for virtual images.
 178
 179 =cut
 180 */
 181 int i_img_to_rgb_inplace(i_img *im) {
 182   i_img temp;
 183
 184   if (im->virtual)
 185     return 0;
 186
 187   if (im->type == i_direct_type)
 188     return 1; /* trivial success */
 189
 190   i_img_empty_ch(&temp, im->xsize, im->ysize, im->channels);
 191   i_img_rgb_convert(&temp, im);
 192
 193   /* nasty hack */
 194   (im->i_f_destroy)(im);
 195   myfree(im->idata);
 196   *im = temp;
 197
 198   return 1;
 199 }
 200
 201 /*
 202 =item i_img_to_pal(i_img *im, i_quantize *quant)
 203
 204 Converts an RGB image to a paletted image
 205
 206 =cut
 207 */
 208 i_img *i_img_to_pal(i_img *src, i_quantize *quant) {
 209   i_palidx *result;
 210   i_img *im;
 211
 212   i_clear_error();
 213
 214   i_quant_makemap(quant, &src, 1);
 215   result = i_quant_translate(quant, src);
 216
 217   if (result) {
 218
 219     im = i_img_pal_new(src->xsize, src->ysize, src->channels, quant->mc_size);
 220
 221     /* copy things over */
 222     memcpy(im->idata, result, im->bytes);
 223     PALEXT(im)->count = quant->mc_count;
 224     memcpy(PALEXT(im)->pal, quant->mc_colors, sizeof(i_color) * quant->mc_count);
 225
 226     myfree(result);
 227
 228     return im;
 229   }
 230   else {
 231     return NULL;
 232   }
 233 }
 234
 235 /*
 236 =item i_img_to_rgb(i_img *src)
 237
 238 =cut
 239 */
 240 i_img *i_img_to_rgb(i_img *src) {
 241   i_img *im = i_img_empty_ch(NULL, src->xsize, src->ysize, src->channels);
 242   i_img_rgb_convert(im, src);
 243
 244   return im;
 245 }
 246
 247 /*
 248 =item i_destroy_p(i_img *im)
 249
 250 Destroys data related to a paletted image.
 251
 252 =cut
 253 */
 254 static void i_destroy_p(i_img *im) {
 255   if (im) {
 256     i_img_pal_ext *palext = im->ext_data;
 257     if (palext) {
 258       if (palext->pal)
 259         myfree(palext->pal);
 260       myfree(palext);
 261     }
 262   }
 263 }
 264
 265 /*
 266 =item i_ppix_p(i_img *im, int x, int y, const i_color *val)
 267
 268 Write to a pixel in the image.
 269
 270 Warning: converts the image to a RGB image if the color isn't already
 271 present in the image.
 272
 273 =cut
 274 */
 275 static int
 276 i_ppix_p(i_img *im, int x, int y, const i_color *val) {
 277   i_palidx which;
 278   if (x < 0 || x >= im->xsize || y < 0 || y >= im->ysize)
 279     return -1;
 280   if (i_findcolor(im, val, &which)) {
 281     ((i_palidx *)im->idata)[x + y * im->xsize] = which;
 282     return 0;
 283   }
 284   else {
 285     if (i_img_to_rgb_inplace(im)) {
 286       return i_ppix(im, x, y, val);
 287     }
 288     else
 289       return -1;
 290   }
 291 }
 292
 293 /*
 294 =item i_gpix_p(i_img *im, int x, int y, i_color *val)
 295
 296 Retrieve a pixel, converting from a palette index to a color.
 297
 298 =cut
 299 */
 300 static int i_gpix_p(i_img *im, int x, int y, i_color *val) {
 301   i_palidx which;
 302   if (x < 0 || x >= im->xsize || y < 0 || y >= im->ysize) {
 303     return -1;
 304   }
 305   which = ((i_palidx *)im->idata)[x + y * im->xsize];
 306   if (which > PALEXT(im)->count)
 307     return -1;
 308   *val = PALEXT(im)->pal[which];
 309
 310   return 0;
 311 }
 312
 313 /*
 314 =item i_glinp(i_img *im, int l, int r, int y, i_color *vals)
 315
 316 Retrieve a row of pixels.
 317
 318 =cut
 319 */
 320 static int i_glin_p(i_img *im, int l, int r, int y, i_color *vals) {
 321   if (y >= 0 && y < im->ysize && l < im->xsize && l >= 0) {
 322     int palsize = PALEXT(im)->count;
 323     i_color *pal = PALEXT(im)->pal;
 324     i_palidx *data;
 325     int count, i;
 326     if (r > im->xsize)
 327       r = im->xsize;
 328     data = ((i_palidx *)im->idata) + l + y * im->xsize;
 329     count = r - l;
 330     for (i = 0; i < count; ++i) {
 331       i_palidx which = *data++;
 332       if (which < palsize)
 333         vals[i] = pal[which];
 334     }
 335     return count;
 336   }
 337   else {
 338     return 0;
 339   }
 340 }
 341
 342 /*
 343 =item i_plin_p(i_img *im, int l, int r, int y, const i_color *vals)
 344
 345 Write a line of color data to the image.
 346
 347 If any color value is not in the image when the image is converted to
 348 RGB.
 349
 350 =cut
 351 */
 352 static int
 353 i_plin_p(i_img *im, int l, int r, int y, const i_color *vals) {
 354   int count, i;
 355   i_palidx *data;
 356   i_palidx which;
 357   if (y >=0 && y < im->ysize && l < im->xsize && l >= 0) {
 358     if (r > im->xsize)
 359       r = im->xsize;
 360     data = ((i_palidx *)im->idata) + l + y * im->xsize;
 361     count = r - l;
 362     for (i = 0; i < count; ++i) {
 363       if (i_findcolor(im, vals+i, &which)) {
 364         ((i_palidx *)data)[i] = which;
 365       }
 366       else {
 367         if (i_img_to_rgb_inplace(im)) {
 368           return i+i_plin(im, l+i, r, y, vals+i);
 369         }
 370       }
 371     }
 372     return count;
 373   }
 374   else {
 375     return 0;
 376   }
 377 }
 378
 379 /*
 380 =item i_gsamp_p(i_img *im, int l, int r, int y, i_sample_t *samps, int chans, int chan_count)
 381
 382 =cut
 383 */
 384 static int i_gsamp_p(i_img *im, int l, int r, int y, i_sample_t *samps,
 385               int const *chans, int chan_count) {
 386   int ch;
 387   if (y >= 0 && y < im->ysize && l < im->xsize && l >= 0) {
 388     int palsize = PALEXT(im)->count;
 389     i_color *pal = PALEXT(im)->pal;
 390     i_palidx *data;
 391     int count, i, w;
 392     if (r > im->xsize)
 393       r = im->xsize;
 394     data = ((i_palidx *)im->idata) + l + y * im->xsize;
 395     count = 0;
 396     w = r - l;
 397     if (chans) {
 398       for (ch = 0; ch < chan_count; ++ch) {
 399         if (chans[ch] < 0 || chans[ch] >= im->channels) {
 400           i_push_errorf(0, "No channel %d in this image", chans[ch]);
 401         }
 402       }
 403
 404       for (i = 0; i < w; ++i) {
 405         i_palidx which = *data++;
 406         if (which < palsize) {
 407           for (ch = 0; ch < chan_count; ++ch) {
 408             *samps++ = pal[which].channel[chans[ch]];
 409             ++count;
 410           }
 411         }
 412       }
 413     }
 414     else {
 415       if (chan_count <= 0 || chan_count > im->channels) {
 416         i_push_errorf(0, "chan_count %d out of range, must be >0, <= channels",
 417                       chan_count);
 418         return 0;
 419       }
 420       for (i = 0; i < w; ++i) {
 421         i_palidx which = *data++;
 422         if (which < palsize) {
 423           for (ch = 0; ch < chan_count; ++ch) {
 424             *samps++ = pal[which].channel[ch];
 425             ++count;
 426           }
 427         }
 428       }
 429     }
 430     return count;
 431   }
 432   else {
 433     return 0;
 434   }
 435 }
 436
 437 /*
 438 =item i_gpal_p(i_img *im, int l, int r, int y, i_palidx *vals)
 439
 440 =cut
 441 */
 442
 443 static int i_gpal_p(i_img *im, int l, int r, int y, i_palidx *vals) {
 444   if (y >= 0 && y < im->ysize && l < im->xsize && l >= 0) {
 445     i_palidx *data;
 446     int i, w;
 447     if (r > im->xsize)
 448       r = im->xsize;
 449     data = ((i_palidx *)im->idata) + l + y * im->xsize;
 450     w = r - l;
 451     for (i = 0; i < w; ++i) {
 452       *vals++ = *data++;
 453     }
 454     return i;
 455   }
 456   else {
 457     return 0;
 458   }
 459 }
 460
 461 /*
 462 =item i_ppal_p(i_img *im, int l, int r, int y, const i_palidx *vals)
 463
 464 =cut
 465 */
 466
 467 static int i_ppal_p(i_img *im, int l, int r, int y, const i_palidx *vals) {
 468   if (y >= 0 && y < im->ysize && l < im->xsize && l >= 0) {
 469     i_palidx *data;
 470     int i, w;
 471     if (r > im->xsize)
 472       r = im->xsize;
 473     data = ((i_palidx *)im->idata) + l + y * im->xsize;
 474     w = r - l;
 475     for (i = 0; i < w; ++i) {
 476       *data++ = *vals++;
 477     }
 478     return i;
 479   }
 480   else {
 481     return 0;
 482   }
 483 }
 484
 485 /*
 486 =item i_addcolors_p(i_img *im, const i_color *color, int count)
 487
 488 =cut
 489 */
 490 static int i_addcolors_p(i_img *im, const i_color *color, int count) {
 491   if (PALEXT(im)->count + count <= PALEXT(im)->alloc) {
 492     int result = PALEXT(im)->count;
 493     int index = result;
 494
 495     PALEXT(im)->count += count;
 496     while (count) {
 497       PALEXT(im)->pal[index++] = *color++;
 498       --count;
 499     }
 500
 501     return result;
 502   }
 503   else
 504     return -1;
 505 }
 506
 507 /*
 508 =item i_getcolors_p(i_img *im, int i, i_color *color, int count)
 509
 510 =cut
 511 */
 512 static int i_getcolors_p(i_img *im, int i, i_color *color, int count) {
 513   if (i >= 0 && i+count <= PALEXT(im)->count) {
 514     while (count) {
 515       *color++ = PALEXT(im)->pal[i++];
 516       --count;
 517     }
 518     return 1;
 519   }
 520   else
 521     return 0;
 522 }
 523
 524 static int color_eq(i_img *im, const i_color *c1, const i_color *c2) {
 525   int ch;
 526   for (ch = 0; ch < im->channels; ++ch) {
 527     if (c1->channel[ch] != c2->channel[ch])
 528       return 0;
 529   }
 530   return 1;
 531 }
 532
 533 /*
 534 =item i_colorcount_p(i_img *im)
 535
 536 =cut
 537 */
 538 static int i_colorcount_p(i_img *im) {
 539   return PALEXT(im)->count;
 540 }
 541
 542 /*
 543 =item i_maxcolors_p(i_img *im)
 544
 545 =cut
 546 */
 547 static int i_maxcolors_p(i_img *im) {
 548   return PALEXT(im)->alloc;
 549 }
 550
 551 /*
 552 =item i_setcolors_p(i_img *im, int index, const i_color *colors, int count)
 553
 554 =cut
 555 */
 556 static int i_setcolors_p(i_img *im, int index, const i_color *colors, int count) {
 557   if (index >= 0 && count >= 1 && index + count <= PALEXT(im)->count) {
 558     while (count) {
 559       PALEXT(im)->pal[index++] = *colors++;
 560       --count;
 561     }
 562     return 1;
 563   }
 564
 565   return 0;
 566 }
 567
 568 /*
 569 =item i_findcolor_p(i_img *im)
 570
 571 =cut
 572 */
 573 static int i_findcolor_p(i_img *im, const i_color *color, i_palidx *entry) {
 574   if (PALEXT(im)->count) {
 575     int i;
 576     /* often the same color comes up several times in a row */
 577     if (PALEXT(im)->last_found >= 0) {
 578       if (color_eq(im, color, PALEXT(im)->pal + PALEXT(im)->last_found)) {
 579         *entry = PALEXT(im)->last_found;
 580         return 1;
 581       }
 582     }
 583     for (i = 0; i < PALEXT(im)->count; ++i) {
 584       if (color_eq(im, color, PALEXT(im)->pal + i)) {
 585         PALEXT(im)->last_found = *entry = i;
 586         return 1;
 587       }
 588     }
 589   }
 590   return 0;
 591 }
 592
 593 /*
 594 =back
 595
 596 =head1 AUTHOR
 597
 598 Tony Cook <tony@develop-help.com>
 599
 600 =head1 SEE ALSO
 601
 602 Imager(3)
 603
 604 =cut
 605 */