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