]>
git.ipfire.org Git - thirdparty/cups.git/blob - filter/image.c
2 * "$Id: image.c 7473 2008-04-21 17:51:58Z mike $"
4 * Base image support for CUPS.
6 * Copyright 2007-2011 by Apple Inc.
7 * Copyright 1993-2005 by Easy Software Products.
9 * These coded instructions, statements, and computer programs are the
10 * property of Apple Inc. and are protected by Federal copyright
11 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
12 * which should have been included with this file. If this file is
13 * file is missing or damaged, see the license at "http://www.cups.org/".
15 * This file is subject to the Apple OS-Developed Software exception.
19 * cupsImageClose() - Close an image file.
20 * cupsImageGetCol() - Get a column of pixels from an image.
21 * cupsImageGetColorSpace() - Get the image colorspace.
22 * cupsImageGetDepth() - Get the number of bytes per pixel.
23 * cupsImageGetHeight() - Get the height of an image.
24 * cupsImageGetRow() - Get a row of pixels from an image.
25 * cupsImageGetWidth() - Get the width of an image.
26 * cupsImageGetXPPI() - Get the horizontal resolution of an image.
27 * cupsImageGetYPPI() - Get the vertical resolution of an image.
28 * cupsImageOpen() - Open an image file and read it into memory.
29 * _cupsImagePutCol() - Put a column of pixels to an image.
30 * _cupsImagePutRow() - Put a row of pixels to an image.
31 * cupsImageSetMaxTiles() - Set the maximum number of tiles to cache.
32 * flush_tile() - Flush the least-recently-used tile in the cache.
33 * get_tile() - Get a cached tile.
37 * Include necessary headers...
40 #include "image-private.h"
47 static void flush_tile(cups_image_t
*img
);
48 static cups_ib_t
*get_tile(cups_image_t
*img
, int x
, int y
);
52 * 'cupsImageClose()' - Close an image file.
56 cupsImageClose(cups_image_t
*img
) /* I - Image to close */
58 cups_ic_t
*current
, /* Current cached tile */
59 *next
; /* Next cached tile */
63 * Wipe the tile cache file (if any)...
66 if (img
->cachefile
>= 0)
68 DEBUG_printf(("Closing/removing swap file \"%s\"...\n", img
->cachename
));
70 close(img
->cachefile
);
71 unlink(img
->cachename
);
75 * Free the image cache...
78 DEBUG_puts("Freeing memory...");
80 for (current
= img
->first
, next
= NULL
; current
!= NULL
; current
= next
)
82 DEBUG_printf(("Freeing cache (%p, next = %p)...\n", current
, next
));
89 * Free the rest of memory...
92 if (img
->tiles
!= NULL
)
94 DEBUG_printf(("Freeing tiles (%p)...\n", img
->tiles
[0]));
98 DEBUG_printf(("Freeing tile pointers (%p)...\n", img
->tiles
));
108 * 'cupsImageGetCol()' - Get a column of pixels from an image.
111 int /* O - -1 on error, 0 on success */
112 cupsImageGetCol(cups_image_t
*img
, /* I - Image */
113 int x
, /* I - Column */
114 int y
, /* I - Start row */
115 int height
, /* I - Column height */
116 cups_ib_t
*pixels
) /* O - Pixel data */
118 int bpp
, /* Bytes per pixel */
119 twidth
, /* Tile width */
120 count
; /* Number of pixels to get */
121 const cups_ib_t
*ib
; /* Pointer into tile */
124 if (img
== NULL
|| x
< 0 || x
>= img
->xsize
|| y
>= img
->ysize
)
133 if ((y
+ height
) > img
->ysize
)
134 height
= img
->ysize
- y
;
139 bpp
= cupsImageGetDepth(img
);
140 twidth
= bpp
* (CUPS_TILE_SIZE
- 1);
144 ib
= get_tile(img
, x
, y
);
149 count
= CUPS_TILE_SIZE
- (y
& (CUPS_TILE_SIZE
- 1));
156 for (; count
> 0; count
--, ib
+= twidth
)
175 * 'cupsImageGetColorSpace()' - Get the image colorspace.
178 cups_icspace_t
/* O - Colorspace */
179 cupsImageGetColorSpace(
180 cups_image_t
*img
) /* I - Image */
182 return (img
->colorspace
);
187 * 'cupsImageGetDepth()' - Get the number of bytes per pixel.
190 int /* O - Bytes per pixel */
191 cupsImageGetDepth(cups_image_t
*img
) /* I - Image */
193 return (abs(img
->colorspace
));
198 * 'cupsImageGetHeight()' - Get the height of an image.
201 unsigned /* O - Height in pixels */
202 cupsImageGetHeight(cups_image_t
*img
) /* I - Image */
209 * 'cupsImageGetRow()' - Get a row of pixels from an image.
212 int /* O - -1 on error, 0 on success */
213 cupsImageGetRow(cups_image_t
*img
, /* I - Image */
214 int x
, /* I - Start column */
216 int width
, /* I - Width of row */
217 cups_ib_t
*pixels
) /* O - Pixel data */
219 int bpp
, /* Bytes per pixel */
220 count
; /* Number of pixels to get */
221 const cups_ib_t
*ib
; /* Pointer to pixels */
224 if (img
== NULL
|| y
< 0 || y
>= img
->ysize
|| x
>= img
->xsize
)
233 if ((x
+ width
) > img
->xsize
)
234 width
= img
->xsize
- x
;
239 bpp
= img
->colorspace
< 0 ? -img
->colorspace
: img
->colorspace
;
243 ib
= get_tile(img
, x
, y
);
248 count
= CUPS_TILE_SIZE
- (x
& (CUPS_TILE_SIZE
- 1));
251 memcpy(pixels
, ib
, count
* bpp
);
252 pixels
+= count
* bpp
;
262 * 'cupsImageGetWidth()' - Get the width of an image.
265 unsigned /* O - Width in pixels */
266 cupsImageGetWidth(cups_image_t
*img
) /* I - Image */
273 * 'cupsImageGetXPPI()' - Get the horizontal resolution of an image.
276 unsigned /* O - Horizontal PPI */
277 cupsImageGetXPPI(cups_image_t
*img
) /* I - Image */
284 * 'cupsImageGetYPPI()' - Get the vertical resolution of an image.
287 unsigned /* O - Vertical PPI */
288 cupsImageGetYPPI(cups_image_t
*img
) /* I - Image */
295 * 'cupsImageOpen()' - Open an image file and read it into memory.
298 cups_image_t
* /* O - New image */
300 const char *filename
, /* I - Filename of image */
301 cups_icspace_t primary
, /* I - Primary colorspace needed */
302 cups_icspace_t secondary
, /* I - Secondary colorspace if primary no good */
303 int saturation
, /* I - Color saturation level */
304 int hue
, /* I - Color hue adjustment */
305 const cups_ib_t
*lut
) /* I - RGB gamma/brightness LUT */
307 FILE *fp
; /* File pointer */
308 unsigned char header
[16], /* First 16 bytes of file */
309 header2
[16]; /* Bytes 2048-2064 (PhotoCD) */
310 cups_image_t
*img
; /* New image buffer */
311 int status
; /* Status of load... */
314 DEBUG_printf(("cupsImageOpen(\"%s\", %d, %d, %d, %d, %p)\n",
315 filename
? filename
: "(null)", primary
, secondary
,
316 saturation
, hue
, lut
));
319 * Figure out the file type...
322 if ((fp
= fopen(filename
, "r")) == NULL
)
325 if (fread(header
, 1, sizeof(header
), fp
) == 0)
331 fseek(fp
, 2048, SEEK_SET
);
332 memset(header2
, 0, sizeof(header2
));
333 fread(header2
, 1, sizeof(header2
), fp
);
334 fseek(fp
, 0, SEEK_SET
);
340 img
= calloc(sizeof(cups_image_t
), 1);
349 * Load the image as appropriate...
353 img
->max_ics
= CUPS_TILE_MINIMUM
;
357 if (!memcmp(header
, "GIF87a", 6) || !memcmp(header
, "GIF89a", 6))
358 status
= _cupsImageReadGIF(img
, fp
, primary
, secondary
, saturation
, hue
,
360 else if (!memcmp(header
, "BM", 2))
361 status
= _cupsImageReadBMP(img
, fp
, primary
, secondary
, saturation
, hue
,
363 else if (header
[0] == 0x01 && header
[1] == 0xda)
364 status
= _cupsImageReadSGI(img
, fp
, primary
, secondary
, saturation
, hue
,
366 else if (header
[0] == 0x59 && header
[1] == 0xa6 &&
367 header
[2] == 0x6a && header
[3] == 0x95)
368 status
= _cupsImageReadSunRaster(img
, fp
, primary
, secondary
, saturation
,
370 else if (header
[0] == 'P' && header
[1] >= '1' && header
[1] <= '6')
371 status
= _cupsImageReadPNM(img
, fp
, primary
, secondary
, saturation
, hue
,
373 else if (!memcmp(header2
, "PCD_IPI", 7))
374 status
= _cupsImageReadPhotoCD(img
, fp
, primary
, secondary
, saturation
,
376 else if (!memcmp(header
+ 8, "\000\010", 2) ||
377 !memcmp(header
+ 8, "\000\030", 2))
378 status
= _cupsImageReadPIX(img
, fp
, primary
, secondary
, saturation
, hue
,
380 #if defined(HAVE_LIBPNG) && defined(HAVE_LIBZ)
381 else if (!memcmp(header
, "\211PNG", 4))
382 status
= _cupsImageReadPNG(img
, fp
, primary
, secondary
, saturation
, hue
,
384 #endif /* HAVE_LIBPNG && HAVE_LIBZ */
386 else if (!memcmp(header
, "\377\330\377", 3) && /* Start-of-Image */
387 header
[3] >= 0xe0 && header
[3] <= 0xef) /* APPn */
388 status
= _cupsImageReadJPEG(img
, fp
, primary
, secondary
, saturation
, hue
,
390 #endif /* HAVE_LIBJPEG */
392 else if (!memcmp(header
, "MM\000\052", 4) ||
393 !memcmp(header
, "II\052\000", 4))
394 status
= _cupsImageReadTIFF(img
, fp
, primary
, secondary
, saturation
, hue
,
396 #endif /* HAVE_LIBTIFF */
414 * '_cupsImagePutCol()' - Put a column of pixels to an image.
417 int /* O - -1 on error, 0 on success */
419 cups_image_t
*img
, /* I - Image */
420 int x
, /* I - Column */
421 int y
, /* I - Start row */
422 int height
, /* I - Column height */
423 const cups_ib_t
*pixels
) /* I - Pixels to put */
425 int bpp
, /* Bytes per pixel */
426 twidth
, /* Width of tile */
427 count
; /* Number of pixels to put */
428 int tilex
, /* Column within tile */
429 tiley
; /* Row within tile */
430 cups_ib_t
*ib
; /* Pointer to pixels in tile */
433 if (img
== NULL
|| x
< 0 || x
>= img
->xsize
|| y
>= img
->ysize
)
442 if ((y
+ height
) > img
->ysize
)
443 height
= img
->ysize
- y
;
448 bpp
= cupsImageGetDepth(img
);
449 twidth
= bpp
* (CUPS_TILE_SIZE
- 1);
450 tilex
= x
/ CUPS_TILE_SIZE
;
451 tiley
= y
/ CUPS_TILE_SIZE
;
455 ib
= get_tile(img
, x
, y
);
460 img
->tiles
[tiley
][tilex
].dirty
= 1;
463 count
= CUPS_TILE_SIZE
- (y
& (CUPS_TILE_SIZE
- 1));
470 for (; count
> 0; count
--, ib
+= twidth
)
489 * '_cupsImagePutRow()' - Put a row of pixels to an image.
492 int /* O - -1 on error, 0 on success */
494 cups_image_t
*img
, /* I - Image */
495 int x
, /* I - Start column */
497 int width
, /* I - Row width */
498 const cups_ib_t
*pixels
) /* I - Pixel data */
500 int bpp
, /* Bytes per pixel */
501 count
; /* Number of pixels to put */
502 int tilex
, /* Column within tile */
503 tiley
; /* Row within tile */
504 cups_ib_t
*ib
; /* Pointer to pixels in tile */
507 if (img
== NULL
|| y
< 0 || y
>= img
->ysize
|| x
>= img
->xsize
)
516 if ((x
+ width
) > img
->xsize
)
517 width
= img
->xsize
- x
;
522 bpp
= img
->colorspace
< 0 ? -img
->colorspace
: img
->colorspace
;
523 tilex
= x
/ CUPS_TILE_SIZE
;
524 tiley
= y
/ CUPS_TILE_SIZE
;
528 ib
= get_tile(img
, x
, y
);
533 img
->tiles
[tiley
][tilex
].dirty
= 1;
535 count
= CUPS_TILE_SIZE
- (x
& (CUPS_TILE_SIZE
- 1));
538 memcpy(ib
, pixels
, count
* bpp
);
539 pixels
+= count
* bpp
;
550 * 'cupsImageSetMaxTiles()' - Set the maximum number of tiles to cache.
552 * If the "max_tiles" argument is 0 then the maximum number of tiles is
553 * computed from the image size or the RIP_CACHE environment variable.
557 cupsImageSetMaxTiles(
558 cups_image_t
*img
, /* I - Image to set */
559 int max_tiles
) /* I - Number of tiles to cache */
561 int cache_size
, /* Size of tile cache in bytes */
562 min_tiles
, /* Minimum number of tiles to cache */
563 max_size
; /* Maximum cache size in bytes */
564 char *cache_env
, /* Cache size environment variable */
565 cache_units
[255]; /* Cache size units */
568 min_tiles
= max(CUPS_TILE_MINIMUM
,
569 1 + max((img
->xsize
+ CUPS_TILE_SIZE
- 1) / CUPS_TILE_SIZE
,
570 (img
->ysize
+ CUPS_TILE_SIZE
- 1) / CUPS_TILE_SIZE
));
573 max_tiles
= ((img
->xsize
+ CUPS_TILE_SIZE
- 1) / CUPS_TILE_SIZE
) *
574 ((img
->ysize
+ CUPS_TILE_SIZE
- 1) / CUPS_TILE_SIZE
);
576 cache_size
= max_tiles
* CUPS_TILE_SIZE
* CUPS_TILE_SIZE
*
577 cupsImageGetDepth(img
);
579 if ((cache_env
= getenv("RIP_MAX_CACHE")) != NULL
)
581 switch (sscanf(cache_env
, "%d%254s", &max_size
, cache_units
))
584 max_size
= 32 * 1024 * 1024;
587 max_size
*= 4 * CUPS_TILE_SIZE
* CUPS_TILE_SIZE
;
590 if (tolower(cache_units
[0] & 255) == 'g')
591 max_size
*= 1024 * 1024 * 1024;
592 else if (tolower(cache_units
[0] & 255) == 'm')
593 max_size
*= 1024 * 1024;
594 else if (tolower(cache_units
[0] & 255) == 'k')
596 else if (tolower(cache_units
[0] & 255) == 't')
597 max_size
*= 4 * CUPS_TILE_SIZE
* CUPS_TILE_SIZE
;
602 max_size
= 32 * 1024 * 1024;
604 if (cache_size
> max_size
)
605 max_tiles
= max_size
/ CUPS_TILE_SIZE
/ CUPS_TILE_SIZE
/
606 cupsImageGetDepth(img
);
608 if (max_tiles
< min_tiles
)
609 max_tiles
= min_tiles
;
611 img
->max_ics
= max_tiles
;
613 DEBUG_printf(("max_ics=%d...\n", img
->max_ics
));
618 * 'flush_tile()' - Flush the least-recently-used tile in the cache.
622 flush_tile(cups_image_t
*img
) /* I - Image */
624 int bpp
; /* Bytes per pixel */
625 cups_itile_t
*tile
; /* Pointer to tile */
628 bpp
= cupsImageGetDepth(img
);
629 tile
= img
->first
->tile
;
637 if (img
->cachefile
< 0)
639 if ((img
->cachefile
= cupsTempFd(img
->cachename
,
640 sizeof(img
->cachename
))) < 0)
647 DEBUG_printf(("Created swap file \"%s\"...\n", img
->cachename
));
652 if (lseek(img
->cachefile
, tile
->pos
, SEEK_SET
) != tile
->pos
)
661 if ((tile
->pos
= lseek(img
->cachefile
, 0, SEEK_END
)) < 0)
669 write(img
->cachefile
, tile
->ic
->pixels
, bpp
* CUPS_TILE_SIZE
* CUPS_TILE_SIZE
);
677 * 'get_tile()' - Get a cached tile.
680 static cups_ib_t
* /* O - Pointer to tile or NULL */
681 get_tile(cups_image_t
*img
, /* I - Image */
682 int x
, /* I - Column in image */
683 int y
) /* I - Row in image */
685 int bpp
, /* Bytes per pixel */
686 tilex
, /* Column within tile */
687 tiley
, /* Row within tile */
688 xtiles
, /* Number of tiles horizontally */
689 ytiles
; /* Number of tiles vertically */
690 cups_ic_t
*ic
; /* Cache pointer */
691 cups_itile_t
*tile
; /* Tile pointer */
694 if (img
->tiles
== NULL
)
696 xtiles
= (img
->xsize
+ CUPS_TILE_SIZE
- 1) / CUPS_TILE_SIZE
;
697 ytiles
= (img
->ysize
+ CUPS_TILE_SIZE
- 1) / CUPS_TILE_SIZE
;
699 DEBUG_printf(("Creating tile array (%dx%d)\n", xtiles
, ytiles
));
701 if ((img
->tiles
= calloc(sizeof(cups_itile_t
*), ytiles
)) == NULL
)
704 if ((tile
= calloc(xtiles
* sizeof(cups_itile_t
), ytiles
)) == NULL
)
707 for (tiley
= 0; tiley
< ytiles
; tiley
++)
709 img
->tiles
[tiley
] = tile
;
710 for (tilex
= xtiles
; tilex
> 0; tilex
--, tile
++)
715 bpp
= cupsImageGetDepth(img
);
716 tilex
= x
/ CUPS_TILE_SIZE
;
717 tiley
= y
/ CUPS_TILE_SIZE
;
718 tile
= img
->tiles
[tiley
] + tilex
;
719 x
&= (CUPS_TILE_SIZE
- 1);
720 y
&= (CUPS_TILE_SIZE
- 1);
722 if ((ic
= tile
->ic
) == NULL
)
724 if (img
->num_ics
< img
->max_ics
)
726 if ((ic
= calloc(sizeof(cups_ic_t
) +
727 bpp
* CUPS_TILE_SIZE
* CUPS_TILE_SIZE
, 1)) == NULL
)
729 if (img
->num_ics
== 0)
737 ic
->pixels
= ((cups_ib_t
*)ic
) + sizeof(cups_ic_t
);
741 DEBUG_printf(("Allocated cache tile %d (%p)...\n", img
->num_ics
, ic
));
746 DEBUG_printf(("Flushing old cache tile (%p)...\n", img
->first
));
757 DEBUG_printf(("Loading cache tile from file position " CUPS_LLFMT
"...\n",
758 CUPS_LLCAST tile
->pos
));
760 lseek(img
->cachefile
, tile
->pos
, SEEK_SET
);
761 read(img
->cachefile
, ic
->pixels
, bpp
* CUPS_TILE_SIZE
* CUPS_TILE_SIZE
);
765 DEBUG_puts("Clearing cache tile...");
767 memset(ic
->pixels
, 0, bpp
* CUPS_TILE_SIZE
* CUPS_TILE_SIZE
);
771 if (ic
== img
->first
)
773 if (ic
->next
!= NULL
)
774 ic
->next
->prev
= NULL
;
776 img
->first
= ic
->next
;
780 else if (img
->first
== NULL
)
786 * Remove the cache entry from the list...
789 if (ic
->prev
!= NULL
)
790 ic
->prev
->next
= ic
->next
;
791 if (ic
->next
!= NULL
)
792 ic
->next
->prev
= ic
->prev
;
795 * And add it to the end...
798 if (img
->last
!= NULL
)
799 img
->last
->next
= ic
;
801 ic
->prev
= img
->last
;
807 return (ic
->pixels
+ bpp
* (y
* CUPS_TILE_SIZE
+ x
));
812 * End of "$Id: image.c 7473 2008-04-21 17:51:58Z mike $".