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 */
79 #define PSD_HEADER_SIZE 26
84 PSD_MODE_GRAYSCALE = 1,
88 PSD_MODE_MULTICHANNEL = 7,
93 enum PsdCompressionType
95 PSD_COMPRESSION_NONE = 0,
96 PSD_COMPRESSION_RLE = 1
102 PSD_STATE_COLOR_MODE_BLOCK,
103 PSD_STATE_RESOURCES_BLOCK,
104 PSD_STATE_LAYERS_BLOCK,
105 PSD_STATE_COMPRESSION,
106 PSD_STATE_LINES_LENGTHS,
107 PSD_STATE_CHANNEL_DATA,
120 guint32 bytes_to_skip;
121 gboolean bytes_to_skip_known;
128 PsdColorMode color_mode;
129 PsdCompressionType compression;
131 guchar** ch_bufs; /* channels buffers */
132 guint curr_ch; /* current channel */
135 guint16* lines_lengths;
141 read_uint16 (guchar* buf)
143 return (buf[0] << 8) | buf[1];
147 read_uint32 (guchar* buf)
149 return (buf[0] << 24) | (buf[1] << 16) | (buf[2] << 8) | buf[3];
154 * Parse Psdheader from buffer
156 * str is expected to be at least PSD_HEADER_SIZE long
159 psd_parse_header (guchar* str)
163 memcpy(hd.signature, str, 4);
164 hd.version = read_uint16(str + 4);
165 hd.channels = read_uint16(str + 12);
166 hd.rows = read_uint32(str + 14);
167 hd.columns = read_uint32(str + 18);
168 hd.depth = read_uint16(str + 22);
169 hd.color_mode = read_uint16(str + 24);
175 * Attempts to read bytes_needed bytes from data and stores them in buffer.
177 * Returns true if there were enough bytes and false otherwise
178 * (which means we need to call feed_buffer again)
181 feed_buffer (guchar* buffer,
187 guint how_many = bytes_needed - *bytes_read;
188 if (how_many > *size) {
191 memcpy(buffer + *bytes_read, *data, how_many);
192 *bytes_read += how_many;
195 return (*bytes_read == bytes_needed);
199 * Attempts to read size of the block and then skip this block.
201 * Returns true when finishes consuming block data, otherwise false
202 * (false means we need to call skip_block again)
205 skip_block (PsdContext* context, const guchar** data, guint* size)
207 if (!context->bytes_to_skip_known) {
208 context->bytes_read = 0;
209 if (feed_buffer(context->buffer, &context->bytes_read, data, size, 4)) {
210 context->bytes_to_skip = read_uint32(context->buffer);
211 context->bytes_to_skip_known = TRUE;
216 if (*size < context->bytes_to_skip) {
218 context->bytes_to_skip -= *size;
222 *size -= context->bytes_to_skip;
223 *data += context->bytes_to_skip;
229 * Decodes RLE-compressed data
232 decompress_line(const guchar* src, guint line_length, guchar* dest)
234 guint16 bytes_read = 0;
236 while (bytes_read < line_length) {
237 gchar byte = src[bytes_read];
242 } else if (byte > -1) {
243 gint count = byte + 1;
245 /* copy next count bytes */
246 for (k = 0; k < count; ++k) {
247 *dest = src[bytes_read];
252 gint count = -byte + 1;
254 /* copy next byte count times */
255 guchar next_byte = src[bytes_read];
257 for (k = 0; k < count; ++k) {
266 reset_context_buffer(PsdContext* ctx)
269 ctx->bytes_to_skip = 0;
270 ctx->bytes_to_skip_known = FALSE;
273 static void free_context(PsdContext *ctx)
276 g_free(ctx->lines_lengths);
279 for (i = 0; i < ctx->channels; i++) {
280 g_free(ctx->ch_bufs[i]);
286 static gboolean image_loader_psd_load(gpointer loader, const guchar *buf, gsize count, GError **)
288 auto ld = static_cast<ImageLoaderPSD *>(loader);
289 auto ctx = g_new0(PsdContext, 1);
294 ctx->state = PSD_STATE_HEADER;
296 /* we'll allocate larger buffer once we know image size */
297 ctx->buffer = static_cast<guchar *>(g_malloc(PSD_HEADER_SIZE));
298 reset_context_buffer(ctx);
300 ctx->ch_bufs = nullptr;
304 ctx->lines_lengths = nullptr;
305 ctx->finalized = FALSE;
308 switch (ctx->state) {
309 case PSD_STATE_HEADER:
311 ctx->buffer, &ctx->bytes_read,
312 &buf, &size, PSD_HEADER_SIZE))
314 PsdHeader hd = psd_parse_header(ctx->buffer);
316 ctx->width = hd.columns;
317 ctx->height = hd.rows;
318 ctx->channels = hd.channels;
319 ctx->depth = hd.depth;
320 ctx->depth_bytes = (ctx->depth/8 > 0 ? ctx->depth/8 : 1);
321 ctx->color_mode = static_cast<PsdColorMode>(hd.color_mode);
323 if (ctx->color_mode != PSD_MODE_RGB
324 && ctx->color_mode != PSD_MODE_GRAYSCALE
325 && ctx->color_mode != PSD_MODE_CMYK
326 && ctx->color_mode != PSD_MODE_DUOTONE
328 log_printf("warning: psd - Unsupported color mode\n");
333 if (ctx->depth != 8 && ctx->depth != 16) {
334 log_printf("warning: psd - Unsupported color depth\n");
339 /* we need buffer that can contain one channel data for one
340 row in RLE compressed format. 2*width should be enough */
342 ctx->buffer = static_cast<guchar *>(g_malloc(ctx->width * 2 * ctx->depth_bytes));
344 /* this will be needed for RLE decompression */
346 static_cast<guint16 *>(g_malloc(2 * ctx->channels * ctx->height));
348 ctx->pixbuf = gdk_pixbuf_new(GDK_COLORSPACE_RGB,
349 FALSE, 8, ctx->width, ctx->height);
351 if (ctx->lines_lengths == nullptr || ctx->buffer == nullptr ||
352 ctx->pixbuf == nullptr)
354 log_printf("warning: Insufficient memory to load PSD image file\n");
359 /* create separate buffers for each channel */
360 ctx->ch_bufs = static_cast<guchar **>(g_malloc(sizeof(guchar*) * ctx->channels));
361 for (i = 0; i < ctx->channels; i++) {
363 static_cast<guchar *>(g_malloc(ctx->width*ctx->height*ctx->depth_bytes));
365 if (ctx->ch_bufs[i] == nullptr) {
366 log_printf("warning: Insufficient memory to load PSD image file\n");
372 ctx->state = PSD_STATE_COLOR_MODE_BLOCK;
373 reset_context_buffer(ctx);
376 case PSD_STATE_COLOR_MODE_BLOCK:
377 if (skip_block(ctx, &buf, &size)) {
378 ctx->state = PSD_STATE_RESOURCES_BLOCK;
379 reset_context_buffer(ctx);
382 case PSD_STATE_RESOURCES_BLOCK:
383 if (skip_block(ctx, &buf, &size)) {
384 ctx->state = PSD_STATE_LAYERS_BLOCK;
385 reset_context_buffer(ctx);
388 case PSD_STATE_LAYERS_BLOCK:
389 if (skip_block(ctx, &buf, &size)) {
390 ctx->state = PSD_STATE_COMPRESSION;
391 reset_context_buffer(ctx);
394 case PSD_STATE_COMPRESSION:
395 if (feed_buffer(ctx->buffer, &ctx->bytes_read, &buf, &size, 2))
397 ctx->compression = static_cast<PsdCompressionType>(read_uint16(ctx->buffer));
399 if (ctx->compression == PSD_COMPRESSION_RLE) {
400 ctx->state = PSD_STATE_LINES_LENGTHS;
401 reset_context_buffer(ctx);
402 } else if (ctx->compression == PSD_COMPRESSION_NONE) {
403 ctx->state = PSD_STATE_CHANNEL_DATA;
404 reset_context_buffer(ctx);
406 log_printf("warning: psd - Unsupported compression type\n");
411 case PSD_STATE_LINES_LENGTHS:
413 reinterpret_cast<guchar*>(ctx->lines_lengths), &ctx->bytes_read, &buf,
414 &size, 2 * ctx->height * ctx->channels))
416 /* convert from different endianness */
417 for (i = 0; i < ctx->height * ctx->channels; i++) {
418 ctx->lines_lengths[i] = read_uint16(
419 reinterpret_cast<guchar*>(&ctx->lines_lengths[i]));
421 ctx->state = PSD_STATE_CHANNEL_DATA;
422 reset_context_buffer(ctx);
425 case PSD_STATE_CHANNEL_DATA:
427 guint line_length = ctx->width * ctx->depth_bytes;
428 if (ctx->compression == PSD_COMPRESSION_RLE) {
429 line_length = ctx->lines_lengths[
430 ctx->curr_ch * ctx->height + ctx->curr_row];
433 if (feed_buffer(ctx->buffer, &ctx->bytes_read, &buf, &size,
436 if (ctx->compression == PSD_COMPRESSION_RLE) {
437 decompress_line(ctx->buffer, line_length,
438 ctx->ch_bufs[ctx->curr_ch] + ctx->pos
441 memcpy(ctx->ch_bufs[ctx->curr_ch] + ctx->pos,
442 ctx->buffer, line_length);
445 ctx->pos += ctx->width * ctx->depth_bytes;
448 if (ctx->curr_row >= ctx->height) {
452 if (ctx->curr_ch >= ctx->channels) {
453 ctx->state = PSD_STATE_DONE;
457 reset_context_buffer(ctx);
468 if (ctx->state == PSD_STATE_DONE && !ctx->finalized) {
469 /* convert or copy channel buffers to our GdkPixbuf */
470 guchar* pixels = gdk_pixbuf_get_pixels(ctx->pixbuf);
471 guint b = ctx->depth_bytes;
473 if (ctx->color_mode == PSD_MODE_RGB) {
474 for (i = 0; i < ctx->height; i++) {
475 for (j = 0; j < ctx->width; j++) {
476 pixels[3*j+0] = ctx->ch_bufs[0][ctx->width*i*b + j*b];
477 pixels[3*j+1] = ctx->ch_bufs[1][ctx->width*i*b + j*b];
478 pixels[3*j+2] = ctx->ch_bufs[2][ctx->width*i*b + j*b];
480 pixels += gdk_pixbuf_get_rowstride(ctx->pixbuf);
482 } else if (ctx->color_mode == PSD_MODE_GRAYSCALE ||
483 ctx->color_mode == PSD_MODE_DUOTONE)
485 for (i = 0; i < ctx->height; i++) {
486 for (j = 0; j < ctx->width; j++) {
487 pixels[3*j+0] = pixels[3*j+1] = pixels[3*j+2] =
488 ctx->ch_bufs[0][ctx->width*i*b + j*b];
490 pixels += gdk_pixbuf_get_rowstride(ctx->pixbuf);
492 } else if (ctx->color_mode == PSD_MODE_CMYK) {
493 /* unfortunately, this doesn't work 100% correctly...
494 CMYK-RGB conversion distorts colors significantly */
496 guchar* pixels = gdk_pixbuf_get_pixels(ctx->pixbuf);
497 for (i = 0; i < ctx->height; i++) {
498 for (j = 0; j < ctx->width; j++) {
500 static_cast<double>(ctx->ch_bufs[0][ctx->width*i + j]) / 255.0;
502 static_cast<double>(ctx->ch_bufs[1][ctx->width*i + j]) / 255.0;
504 static_cast<double>(ctx->ch_bufs[2][ctx->width*i + j]) / 255.0;
506 static_cast<double>(ctx->ch_bufs[3][ctx->width*i + j]) / 255.0;
508 pixels[3*j+0] = (1.0 - (c * (1.0 - k) + k)) * 255.0;
509 pixels[3*j+1] = (1.0 - (m * (1.0 - k) + k)) * 255.0;
510 pixels[3*j+2] = (1.0 - (y * (1.0 - k) + k)) * 255.0;
512 pixels += gdk_pixbuf_get_rowstride(ctx->pixbuf);
515 ctx->finalized = TRUE;
516 ld->pixbuf = ctx->pixbuf;
517 ld->area_updated_cb(loader, 0, 0, ctx->width, ctx->height, ld->data);
527 /* ------- Geeqie ------------ */
529 static gpointer image_loader_psd_new(ImageLoaderBackendCbAreaUpdated area_updated_cb, ImageLoaderBackendCbSize size_cb, ImageLoaderBackendCbAreaPrepared area_prepared_cb, gpointer data)
531 auto loader = g_new0(ImageLoaderPSD, 1);
532 loader->area_updated_cb = area_updated_cb;
533 loader->size_cb = size_cb;
534 loader->area_prepared_cb = area_prepared_cb;
539 static void image_loader_psd_set_size(gpointer loader, int width, int height)
541 auto ld = static_cast<ImageLoaderPSD *>(loader);
542 ld->requested_width = width;
543 ld->requested_height = height;
546 static GdkPixbuf* image_loader_psd_get_pixbuf(gpointer loader)
548 auto ld = static_cast<ImageLoaderPSD *>(loader);
552 static gchar* image_loader_psd_get_format_name(gpointer)
554 return g_strdup("psd");
557 static gchar** image_loader_psd_get_format_mime_types(gpointer)
559 static const gchar *mime[] = {"application/psd", nullptr};
560 return g_strdupv(const_cast<gchar **>(mime));
563 static gboolean image_loader_psd_close(gpointer, GError **)
568 static void image_loader_psd_abort(gpointer loader)
570 auto ld = static_cast<ImageLoaderPSD *>(loader);
574 static void image_loader_psd_free(gpointer loader)
576 auto ld = static_cast<ImageLoaderPSD *>(loader);
577 if (ld->pixbuf) g_object_unref(ld->pixbuf);
581 void image_loader_backend_set_psd(ImageLoaderBackend *funcs)
583 funcs->loader_new = image_loader_psd_new;
584 funcs->set_size = image_loader_psd_set_size;
585 funcs->load = image_loader_psd_load;
586 funcs->write = nullptr;
587 funcs->get_pixbuf = image_loader_psd_get_pixbuf;
588 funcs->close = image_loader_psd_close;
589 funcs->abort = image_loader_psd_abort;
590 funcs->free = image_loader_psd_free;
591 funcs->get_format_name = image_loader_psd_get_format_name;
592 funcs->get_format_mime_types = image_loader_psd_get_format_mime_types;
594 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */