2 * Copyright (C) 20019 - The Geeqie Team
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 * GdkPixbuf library - PSD image loader
25 * Copyright (C) 2008 Jan Dudek
27 * Authors: Jan Dudek <jd@jandudek.com>
29 * This library is free software; you can redistribute it and/or
30 * modify it under the terms of the GNU Lesser General Public
31 * License as published by the Free Software Foundation; either
32 * version 2 of the License, or (at your option) any later version.
34 * This library is distributed in the hope that it will be useful,
35 * but WITHOUT ANY WARRANTY; without even the implied warranty of
36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
37 * Lesser General Public License for more
38 * You should have received a copy of the GNU Lesser General Public
39 * License along with this library; if not, write to the
40 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
41 * Boston, MA 02111-1307, USA.
46 * - report errors from parse_psd_header
47 * - other color modes (CMYK at least)
53 #include "image-load.h"
54 #include "image-load-psd.h"
56 struct ImageLoaderPSD {
57 ImageLoaderBackendCbAreaUpdated area_updated_cb;
58 ImageLoaderBackendCbSize size_cb;
59 ImageLoaderBackendCbAreaPrepared area_prepared_cb;
62 guint requested_width;
63 guint requested_height;
69 guchar signature[4]; /* file ID, always "8BPS" */
70 guint16 version; /* version number, always 1 */
72 guint16 channels; /* number of color channels (1-24) */
73 guint32 rows; /* height of image in pixels (1-30000) */
74 guint32 columns; /* width of image in pixels (1-30000) */
75 guint16 depth; /* number of bits per channel (1, 8, 16 or 32) */
76 guint16 color_mode; /* color mode as defined below */
86 PSD_MODE_GRAYSCALE = 1,
90 PSD_MODE_MULTICHANNEL = 7,
95 enum PsdCompressionType
97 PSD_COMPRESSION_NONE = 0,
98 PSD_COMPRESSION_RLE = 1
104 PSD_STATE_COLOR_MODE_BLOCK,
105 PSD_STATE_RESOURCES_BLOCK,
106 PSD_STATE_LAYERS_BLOCK,
107 PSD_STATE_COMPRESSION,
108 PSD_STATE_LINES_LENGTHS,
109 PSD_STATE_CHANNEL_DATA,
122 guint32 bytes_to_skip;
123 gboolean bytes_to_skip_known;
130 PsdColorMode color_mode;
131 PsdCompressionType compression;
133 guchar** ch_bufs; /* channels buffers */
134 guint curr_ch; /* current channel */
137 guint16* lines_lengths;
143 read_uint16 (const guchar* buf)
145 return (buf[0] << 8) | buf[1];
149 read_uint32 (const guchar* buf)
151 return (buf[0] << 24) | (buf[1] << 16) | (buf[2] << 8) | buf[3];
156 * Parse Psdheader from buffer
158 * str is expected to be at least PSD_HEADER_SIZE long
161 psd_parse_header (guchar* str)
165 memcpy(hd.signature, str, 4);
166 hd.version = read_uint16(str + 4);
167 hd.channels = read_uint16(str + 12);
168 hd.rows = read_uint32(str + 14);
169 hd.columns = read_uint32(str + 18);
170 hd.depth = read_uint16(str + 22);
171 hd.color_mode = read_uint16(str + 24);
177 * Attempts to read bytes_needed bytes from data and stores them in buffer.
179 * Returns true if there were enough bytes and false otherwise
180 * (which means we need to call feed_buffer again)
183 feed_buffer (guchar* buffer,
189 guint how_many = bytes_needed - *bytes_read;
190 if (how_many > *size) {
193 memcpy(buffer + *bytes_read, *data, how_many);
194 *bytes_read += how_many;
197 return (*bytes_read == bytes_needed);
201 * Attempts to read size of the block and then skip this block.
203 * Returns true when finishes consuming block data, otherwise false
204 * (false means we need to call skip_block again)
207 skip_block (PsdContext* context, const guchar** data, guint* size)
209 if (!context->bytes_to_skip_known) {
210 context->bytes_read = 0;
211 if (feed_buffer(context->buffer, &context->bytes_read, data, size, 4)) {
212 context->bytes_to_skip = read_uint32(context->buffer);
213 context->bytes_to_skip_known = TRUE;
219 if (*size < context->bytes_to_skip)
222 context->bytes_to_skip -= *size;
227 *size -= context->bytes_to_skip;
228 *data += context->bytes_to_skip;
233 * Decodes RLE-compressed data
236 decompress_line(const guchar* src, guint line_length, guchar* dest)
238 guint16 bytes_read = 0;
240 while (bytes_read < line_length)
242 gchar byte = src[bytes_read];
252 gint count = byte + 1;
254 /* copy next count bytes */
255 for (k = 0; k < count; ++k)
257 *dest = src[bytes_read];
264 gint count = -byte + 1;
266 /* copy next byte count times */
267 guchar next_byte = src[bytes_read];
269 for (k = 0; k < count; ++k)
279 reset_context_buffer(PsdContext* ctx)
282 ctx->bytes_to_skip = 0;
283 ctx->bytes_to_skip_known = FALSE;
286 static void free_context(PsdContext *ctx)
289 g_free(ctx->lines_lengths);
292 for (i = 0; i < ctx->channels; i++) {
293 g_free(ctx->ch_bufs[i]);
299 static gboolean image_loader_psd_load(gpointer loader, const guchar *buf, gsize count, GError **)
301 auto ld = static_cast<ImageLoaderPSD *>(loader);
302 auto ctx = g_new0(PsdContext, 1);
307 ctx->state = PSD_STATE_HEADER;
309 /* we'll allocate larger buffer once we know image size */
310 ctx->buffer = static_cast<guchar *>(g_malloc(PSD_HEADER_SIZE));
311 reset_context_buffer(ctx);
313 ctx->ch_bufs = nullptr;
317 ctx->lines_lengths = nullptr;
318 ctx->finalized = FALSE;
321 switch (ctx->state) {
322 case PSD_STATE_HEADER:
324 ctx->buffer, &ctx->bytes_read,
325 &buf, &size, PSD_HEADER_SIZE))
327 PsdHeader hd = psd_parse_header(ctx->buffer);
329 ctx->width = hd.columns;
330 ctx->height = hd.rows;
331 ctx->channels = hd.channels;
332 ctx->depth = hd.depth;
333 ctx->depth_bytes = (ctx->depth/8 > 0 ? ctx->depth/8 : 1);
334 ctx->color_mode = static_cast<PsdColorMode>(hd.color_mode);
336 if (ctx->color_mode != PSD_MODE_RGB
337 && ctx->color_mode != PSD_MODE_GRAYSCALE
338 && ctx->color_mode != PSD_MODE_CMYK
339 && ctx->color_mode != PSD_MODE_DUOTONE
341 log_printf("warning: psd - Unsupported color mode\n");
346 if (ctx->depth != 8 && ctx->depth != 16) {
347 log_printf("warning: psd - Unsupported color depth\n");
352 /* we need buffer that can contain one channel data for one
353 row in RLE compressed format. 2*width should be enough */
355 ctx->buffer = static_cast<guchar *>(g_malloc(ctx->width * 2 * ctx->depth_bytes));
357 /* this will be needed for RLE decompression */
359 static_cast<guint16 *>(g_malloc(2 * ctx->channels * ctx->height));
361 ctx->pixbuf = gdk_pixbuf_new(GDK_COLORSPACE_RGB,
362 FALSE, 8, ctx->width, ctx->height);
364 if (ctx->lines_lengths == nullptr || ctx->buffer == nullptr ||
365 ctx->pixbuf == nullptr)
367 log_printf("warning: Insufficient memory to load PSD image file\n");
372 /* create separate buffers for each channel */
373 ctx->ch_bufs = static_cast<guchar **>(g_malloc(sizeof(guchar*) * ctx->channels));
374 for (i = 0; i < ctx->channels; i++) {
376 static_cast<guchar *>(g_malloc(ctx->width*ctx->height*ctx->depth_bytes));
378 if (ctx->ch_bufs[i] == nullptr) {
379 log_printf("warning: Insufficient memory to load PSD image file\n");
385 ctx->state = PSD_STATE_COLOR_MODE_BLOCK;
386 reset_context_buffer(ctx);
389 case PSD_STATE_COLOR_MODE_BLOCK:
390 if (skip_block(ctx, &buf, &size)) {
391 ctx->state = PSD_STATE_RESOURCES_BLOCK;
392 reset_context_buffer(ctx);
395 case PSD_STATE_RESOURCES_BLOCK:
396 if (skip_block(ctx, &buf, &size)) {
397 ctx->state = PSD_STATE_LAYERS_BLOCK;
398 reset_context_buffer(ctx);
401 case PSD_STATE_LAYERS_BLOCK:
402 if (skip_block(ctx, &buf, &size)) {
403 ctx->state = PSD_STATE_COMPRESSION;
404 reset_context_buffer(ctx);
407 case PSD_STATE_COMPRESSION:
408 if (feed_buffer(ctx->buffer, &ctx->bytes_read, &buf, &size, 2))
410 ctx->compression = static_cast<PsdCompressionType>(read_uint16(ctx->buffer));
412 if (ctx->compression == PSD_COMPRESSION_RLE) {
413 ctx->state = PSD_STATE_LINES_LENGTHS;
414 reset_context_buffer(ctx);
415 } else if (ctx->compression == PSD_COMPRESSION_NONE) {
416 ctx->state = PSD_STATE_CHANNEL_DATA;
417 reset_context_buffer(ctx);
419 log_printf("warning: psd - Unsupported compression type\n");
424 case PSD_STATE_LINES_LENGTHS:
426 reinterpret_cast<guchar*>(ctx->lines_lengths), &ctx->bytes_read, &buf,
427 &size, 2 * ctx->height * ctx->channels))
429 /* convert from different endianness */
430 for (i = 0; i < ctx->height * ctx->channels; i++) {
431 ctx->lines_lengths[i] = read_uint16(
432 reinterpret_cast<guchar*>(&ctx->lines_lengths[i]));
434 ctx->state = PSD_STATE_CHANNEL_DATA;
435 reset_context_buffer(ctx);
438 case PSD_STATE_CHANNEL_DATA:
440 guint line_length = ctx->width * ctx->depth_bytes;
441 if (ctx->compression == PSD_COMPRESSION_RLE) {
442 line_length = ctx->lines_lengths[
443 ctx->curr_ch * ctx->height + ctx->curr_row];
446 if (feed_buffer(ctx->buffer, &ctx->bytes_read, &buf, &size,
449 if (ctx->compression == PSD_COMPRESSION_RLE) {
450 decompress_line(ctx->buffer, line_length,
451 ctx->ch_bufs[ctx->curr_ch] + ctx->pos
454 memcpy(ctx->ch_bufs[ctx->curr_ch] + ctx->pos,
455 ctx->buffer, line_length);
458 ctx->pos += ctx->width * ctx->depth_bytes;
461 if (ctx->curr_row >= ctx->height) {
465 if (ctx->curr_ch >= ctx->channels) {
466 ctx->state = PSD_STATE_DONE;
470 reset_context_buffer(ctx);
481 if (ctx->state == PSD_STATE_DONE && !ctx->finalized) {
482 /* convert or copy channel buffers to our GdkPixbuf */
483 guchar* pixels = gdk_pixbuf_get_pixels(ctx->pixbuf);
484 guint b = ctx->depth_bytes;
486 if (ctx->color_mode == PSD_MODE_RGB) {
487 for (i = 0; i < ctx->height; i++) {
488 for (j = 0; j < ctx->width; j++) {
489 pixels[3*j+0] = ctx->ch_bufs[0][ctx->width*i*b + j*b];
490 pixels[3*j+1] = ctx->ch_bufs[1][ctx->width*i*b + j*b];
491 pixels[3*j+2] = ctx->ch_bufs[2][ctx->width*i*b + j*b];
493 pixels += gdk_pixbuf_get_rowstride(ctx->pixbuf);
495 } else if (ctx->color_mode == PSD_MODE_GRAYSCALE ||
496 ctx->color_mode == PSD_MODE_DUOTONE)
498 for (i = 0; i < ctx->height; i++) {
499 for (j = 0; j < ctx->width; j++) {
500 pixels[3*j+0] = pixels[3*j+1] = pixels[3*j+2] =
501 ctx->ch_bufs[0][ctx->width*i*b + j*b];
503 pixels += gdk_pixbuf_get_rowstride(ctx->pixbuf);
505 } else if (ctx->color_mode == PSD_MODE_CMYK) {
506 /* unfortunately, this doesn't work 100% correctly...
507 CMYK-RGB conversion distorts colors significantly */
509 guchar* pixels = gdk_pixbuf_get_pixels(ctx->pixbuf);
510 for (i = 0; i < ctx->height; i++) {
511 for (j = 0; j < ctx->width; j++) {
513 static_cast<double>(ctx->ch_bufs[0][ctx->width*i + j]) / 255.0;
515 static_cast<double>(ctx->ch_bufs[1][ctx->width*i + j]) / 255.0;
517 static_cast<double>(ctx->ch_bufs[2][ctx->width*i + j]) / 255.0;
519 static_cast<double>(ctx->ch_bufs[3][ctx->width*i + j]) / 255.0;
521 pixels[3*j+0] = (1.0 - (c * (1.0 - k) + k)) * 255.0;
522 pixels[3*j+1] = (1.0 - (m * (1.0 - k) + k)) * 255.0;
523 pixels[3*j+2] = (1.0 - (y * (1.0 - k) + k)) * 255.0;
525 pixels += gdk_pixbuf_get_rowstride(ctx->pixbuf);
528 ctx->finalized = TRUE;
529 ld->pixbuf = ctx->pixbuf;
530 ld->area_updated_cb(loader, 0, 0, ctx->width, ctx->height, ld->data);
540 /* ------- Geeqie ------------ */
542 static gpointer image_loader_psd_new(ImageLoaderBackendCbAreaUpdated area_updated_cb, ImageLoaderBackendCbSize size_cb, ImageLoaderBackendCbAreaPrepared area_prepared_cb, gpointer data)
544 auto loader = g_new0(ImageLoaderPSD, 1);
545 loader->area_updated_cb = area_updated_cb;
546 loader->size_cb = size_cb;
547 loader->area_prepared_cb = area_prepared_cb;
552 static void image_loader_psd_set_size(gpointer loader, int width, int height)
554 auto ld = static_cast<ImageLoaderPSD *>(loader);
555 ld->requested_width = width;
556 ld->requested_height = height;
559 static GdkPixbuf* image_loader_psd_get_pixbuf(gpointer loader)
561 auto ld = static_cast<ImageLoaderPSD *>(loader);
565 static gchar* image_loader_psd_get_format_name(gpointer)
567 return g_strdup("psd");
570 static gchar** image_loader_psd_get_format_mime_types(gpointer)
572 static const gchar *mime[] = {"application/psd", nullptr};
573 return g_strdupv(const_cast<gchar **>(mime));
576 static gboolean image_loader_psd_close(gpointer, GError **)
581 static void image_loader_psd_abort(gpointer loader)
583 auto ld = static_cast<ImageLoaderPSD *>(loader);
587 static void image_loader_psd_free(gpointer loader)
589 auto ld = static_cast<ImageLoaderPSD *>(loader);
590 if (ld->pixbuf) g_object_unref(ld->pixbuf);
594 void image_loader_backend_set_psd(ImageLoaderBackend *funcs)
596 funcs->loader_new = image_loader_psd_new;
597 funcs->set_size = image_loader_psd_set_size;
598 funcs->load = image_loader_psd_load;
599 funcs->write = nullptr;
600 funcs->get_pixbuf = image_loader_psd_get_pixbuf;
601 funcs->close = image_loader_psd_close;
602 funcs->abort = image_loader_psd_abort;
603 funcs->free = image_loader_psd_free;
604 funcs->get_format_name = image_loader_psd_get_format_name;
605 funcs->get_format_mime_types = image_loader_psd_get_format_mime_types;
607 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */