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)
51 #include "image-load-psd.h"
55 #include <gdk-pixbuf/gdk-pixbuf.h>
56 #include <glib-object.h>
60 #include "image-load.h"
65 struct ImageLoaderPSD : public ImageLoaderBackend
68 ~ImageLoaderPSD() override;
70 void init(AreaUpdatedCb area_updated_cb, SizePreparedCb size_prepared_cb, AreaPreparedCb area_prepared_cb, gpointer data) override;
71 gboolean write(const guchar *buf, gsize &chunk_size, gsize count, GError **error) override;
72 GdkPixbuf *get_pixbuf() override;
73 gchar *get_format_name() override;
74 gchar **get_format_mime_types() override;
77 AreaUpdatedCb area_updated_cb;
85 guchar signature[4]; /* file ID, always "8BPS" */
86 guint16 version; /* version number, always 1 */
88 guint16 channels; /* number of color channels (1-24) */
89 guint32 rows; /* height of image in pixels (1-30000) */
90 guint32 columns; /* width of image in pixels (1-30000) */
91 guint16 depth; /* number of bits per channel (1, 8, 16 or 32) */
92 guint16 color_mode; /* color mode as defined below */
102 PSD_MODE_GRAYSCALE = 1,
103 PSD_MODE_INDEXED = 2,
106 PSD_MODE_MULTICHANNEL = 7,
107 PSD_MODE_DUOTONE = 8,
111 enum PsdCompressionType
113 PSD_COMPRESSION_NONE = 0,
114 PSD_COMPRESSION_RLE = 1
120 PSD_STATE_COLOR_MODE_BLOCK,
121 PSD_STATE_RESOURCES_BLOCK,
122 PSD_STATE_LAYERS_BLOCK,
123 PSD_STATE_COMPRESSION,
124 PSD_STATE_LINES_LENGTHS,
125 PSD_STATE_CHANNEL_DATA,
138 guint32 bytes_to_skip;
139 gboolean bytes_to_skip_known;
146 PsdColorMode color_mode;
147 PsdCompressionType compression;
149 guchar** ch_bufs; /* channels buffers */
150 guint curr_ch; /* current channel */
153 guint16* lines_lengths;
158 guint16 read_uint16 (const guchar* buf)
160 return (buf[0] << 8) | buf[1];
163 guint32 read_uint32 (const guchar* buf)
165 return (buf[0] << 24) | (buf[1] << 16) | (buf[2] << 8) | buf[3];
170 * Parse Psdheader from buffer
172 * str is expected to be at least PSD_HEADER_SIZE long
174 PsdHeader psd_parse_header (guchar* str)
178 memcpy(hd.signature, str, 4);
179 hd.version = read_uint16(str + 4);
180 hd.channels = read_uint16(str + 12);
181 hd.rows = read_uint32(str + 14);
182 hd.columns = read_uint32(str + 18);
183 hd.depth = read_uint16(str + 22);
184 hd.color_mode = read_uint16(str + 24);
190 * Attempts to read bytes_needed bytes from data and stores them in buffer.
192 * Returns true if there were enough bytes and false otherwise
193 * (which means we need to call feed_buffer again)
196 feed_buffer (guchar* buffer,
202 guint how_many = bytes_needed - *bytes_read;
203 if (how_many > *size) {
206 memcpy(buffer + *bytes_read, *data, how_many);
207 *bytes_read += how_many;
210 return (*bytes_read == bytes_needed);
214 * Attempts to read size of the block and then skip this block.
216 * Returns true when finishes consuming block data, otherwise false
217 * (false means we need to call skip_block again)
219 gboolean skip_block (PsdContext* context, const guchar** data, guint* size)
221 if (!context->bytes_to_skip_known) {
222 context->bytes_read = 0;
223 if (feed_buffer(context->buffer, &context->bytes_read, data, size, 4)) {
224 context->bytes_to_skip = read_uint32(context->buffer);
225 context->bytes_to_skip_known = TRUE;
231 if (*size < context->bytes_to_skip)
234 context->bytes_to_skip -= *size;
239 *size -= context->bytes_to_skip;
240 *data += context->bytes_to_skip;
245 * Decodes RLE-compressed data
247 void decompress_line(const guchar* src, guint line_length, guchar* dest)
249 guint16 bytes_read = 0;
251 while (bytes_read < line_length)
253 gchar byte = src[bytes_read];
263 gint count = byte + 1;
265 /* copy next count bytes */
266 for (k = 0; k < count; ++k)
268 *dest = src[bytes_read];
275 gint count = -byte + 1;
277 /* copy next byte count times */
278 guchar next_byte = src[bytes_read];
280 for (k = 0; k < count; ++k)
289 void reset_context_buffer(PsdContext* ctx)
292 ctx->bytes_to_skip = 0;
293 ctx->bytes_to_skip_known = FALSE;
296 void free_context(PsdContext *ctx)
299 g_free(ctx->lines_lengths);
302 for (i = 0; i < ctx->channels; i++) {
303 g_free(ctx->ch_bufs[i]);
309 gboolean ImageLoaderPSD::write(const guchar *buf, gsize &chunk_size, gsize count, GError **)
311 auto ctx = g_new0(PsdContext, 1);
316 ctx->state = PSD_STATE_HEADER;
318 /* we'll allocate larger buffer once we know image size */
319 ctx->buffer = static_cast<guchar *>(g_malloc(PSD_HEADER_SIZE));
320 reset_context_buffer(ctx);
322 ctx->ch_bufs = nullptr;
326 ctx->lines_lengths = nullptr;
327 ctx->finalized = FALSE;
330 switch (ctx->state) {
331 case PSD_STATE_HEADER:
333 ctx->buffer, &ctx->bytes_read,
334 &buf, &size, PSD_HEADER_SIZE))
336 PsdHeader hd = psd_parse_header(ctx->buffer);
338 ctx->width = hd.columns;
339 ctx->height = hd.rows;
340 ctx->channels = hd.channels;
341 ctx->depth = hd.depth;
342 ctx->depth_bytes = (ctx->depth/8 > 0 ? ctx->depth/8 : 1);
343 ctx->color_mode = static_cast<PsdColorMode>(hd.color_mode);
345 if (ctx->color_mode != PSD_MODE_RGB
346 && ctx->color_mode != PSD_MODE_GRAYSCALE
347 && ctx->color_mode != PSD_MODE_CMYK
348 && ctx->color_mode != PSD_MODE_DUOTONE
350 log_printf("warning: psd - Unsupported color mode\n");
355 if (ctx->depth != 8 && ctx->depth != 16) {
356 log_printf("warning: psd - Unsupported color depth\n");
361 /* we need buffer that can contain one channel data for one
362 row in RLE compressed format. 2*width should be enough */
364 ctx->buffer = static_cast<guchar *>(g_malloc(ctx->width * 2 * ctx->depth_bytes));
366 /* this will be needed for RLE decompression */
368 static_cast<guint16 *>(g_malloc(2 * ctx->channels * ctx->height));
370 ctx->pixbuf = gdk_pixbuf_new(GDK_COLORSPACE_RGB,
371 FALSE, 8, ctx->width, ctx->height);
373 if (ctx->lines_lengths == nullptr || ctx->buffer == nullptr ||
374 ctx->pixbuf == nullptr)
376 log_printf("warning: Insufficient memory to load PSD image file\n");
381 /* create separate buffers for each channel */
382 ctx->ch_bufs = static_cast<guchar **>(g_malloc(sizeof(guchar*) * ctx->channels));
383 for (i = 0; i < ctx->channels; i++) {
385 static_cast<guchar *>(g_malloc(ctx->width*ctx->height*ctx->depth_bytes));
387 if (ctx->ch_bufs[i] == nullptr) {
388 log_printf("warning: Insufficient memory to load PSD image file\n");
394 ctx->state = PSD_STATE_COLOR_MODE_BLOCK;
395 reset_context_buffer(ctx);
398 case PSD_STATE_COLOR_MODE_BLOCK:
399 if (skip_block(ctx, &buf, &size)) {
400 ctx->state = PSD_STATE_RESOURCES_BLOCK;
401 reset_context_buffer(ctx);
404 case PSD_STATE_RESOURCES_BLOCK:
405 if (skip_block(ctx, &buf, &size)) {
406 ctx->state = PSD_STATE_LAYERS_BLOCK;
407 reset_context_buffer(ctx);
410 case PSD_STATE_LAYERS_BLOCK:
411 if (skip_block(ctx, &buf, &size)) {
412 ctx->state = PSD_STATE_COMPRESSION;
413 reset_context_buffer(ctx);
416 case PSD_STATE_COMPRESSION:
417 if (feed_buffer(ctx->buffer, &ctx->bytes_read, &buf, &size, 2))
419 ctx->compression = static_cast<PsdCompressionType>(read_uint16(ctx->buffer));
421 if (ctx->compression == PSD_COMPRESSION_RLE) {
422 ctx->state = PSD_STATE_LINES_LENGTHS;
423 reset_context_buffer(ctx);
424 } else if (ctx->compression == PSD_COMPRESSION_NONE) {
425 ctx->state = PSD_STATE_CHANNEL_DATA;
426 reset_context_buffer(ctx);
428 log_printf("warning: psd - Unsupported compression type\n");
433 case PSD_STATE_LINES_LENGTHS:
435 reinterpret_cast<guchar*>(ctx->lines_lengths), &ctx->bytes_read, &buf,
436 &size, 2 * ctx->height * ctx->channels))
438 /* convert from different endianness */
439 for (i = 0; i < ctx->height * ctx->channels; i++) {
440 ctx->lines_lengths[i] = read_uint16(
441 reinterpret_cast<guchar*>(&ctx->lines_lengths[i]));
443 ctx->state = PSD_STATE_CHANNEL_DATA;
444 reset_context_buffer(ctx);
447 case PSD_STATE_CHANNEL_DATA:
449 guint line_length = ctx->width * ctx->depth_bytes;
450 if (ctx->compression == PSD_COMPRESSION_RLE) {
451 line_length = ctx->lines_lengths[
452 ctx->curr_ch * ctx->height + ctx->curr_row];
455 if (feed_buffer(ctx->buffer, &ctx->bytes_read, &buf, &size,
458 if (ctx->compression == PSD_COMPRESSION_RLE) {
459 decompress_line(ctx->buffer, line_length,
460 ctx->ch_bufs[ctx->curr_ch] + ctx->pos
463 memcpy(ctx->ch_bufs[ctx->curr_ch] + ctx->pos,
464 ctx->buffer, line_length);
467 ctx->pos += ctx->width * ctx->depth_bytes;
470 if (ctx->curr_row >= ctx->height) {
474 if (ctx->curr_ch >= ctx->channels) {
475 ctx->state = PSD_STATE_DONE;
479 reset_context_buffer(ctx);
490 if (ctx->state == PSD_STATE_DONE && !ctx->finalized) {
491 /* convert or copy channel buffers to our GdkPixbuf */
492 guchar* pixels = gdk_pixbuf_get_pixels(ctx->pixbuf);
493 guint b = ctx->depth_bytes;
495 if (ctx->color_mode == PSD_MODE_RGB) {
496 for (i = 0; i < ctx->height; i++) {
497 for (j = 0; j < ctx->width; j++) {
498 pixels[3*j+0] = ctx->ch_bufs[0][ctx->width*i*b + j*b];
499 pixels[3*j+1] = ctx->ch_bufs[1][ctx->width*i*b + j*b];
500 pixels[3*j+2] = ctx->ch_bufs[2][ctx->width*i*b + j*b];
502 pixels += gdk_pixbuf_get_rowstride(ctx->pixbuf);
504 } else if (ctx->color_mode == PSD_MODE_GRAYSCALE ||
505 ctx->color_mode == PSD_MODE_DUOTONE)
507 for (i = 0; i < ctx->height; i++) {
508 for (j = 0; j < ctx->width; j++) {
509 pixels[3*j+0] = pixels[3*j+1] = pixels[3*j+2] =
510 ctx->ch_bufs[0][ctx->width*i*b + j*b];
512 pixels += gdk_pixbuf_get_rowstride(ctx->pixbuf);
514 } else if (ctx->color_mode == PSD_MODE_CMYK) {
515 /* unfortunately, this doesn't work 100% correctly...
516 CMYK-RGB conversion distorts colors significantly */
518 guchar* pixels = gdk_pixbuf_get_pixels(ctx->pixbuf);
519 for (i = 0; i < ctx->height; i++) {
520 for (j = 0; j < ctx->width; j++) {
522 static_cast<double>(ctx->ch_bufs[0][ctx->width*i + j]) / 255.0;
524 static_cast<double>(ctx->ch_bufs[1][ctx->width*i + j]) / 255.0;
526 static_cast<double>(ctx->ch_bufs[2][ctx->width*i + j]) / 255.0;
528 static_cast<double>(ctx->ch_bufs[3][ctx->width*i + j]) / 255.0;
530 pixels[3*j+0] = (1.0 - (c * (1.0 - k) + k)) * 255.0;
531 pixels[3*j+1] = (1.0 - (m * (1.0 - k) + k)) * 255.0;
532 pixels[3*j+2] = (1.0 - (y * (1.0 - k) + k)) * 255.0;
534 pixels += gdk_pixbuf_get_rowstride(ctx->pixbuf);
537 ctx->finalized = TRUE;
538 pixbuf = ctx->pixbuf;
539 area_updated_cb(nullptr, 0, 0, ctx->width, ctx->height, data);
550 /* ------- Geeqie ------------ */
552 void ImageLoaderPSD::init(AreaUpdatedCb area_updated_cb, SizePreparedCb, AreaPreparedCb, gpointer data)
554 this->area_updated_cb = area_updated_cb;
558 GdkPixbuf *ImageLoaderPSD::get_pixbuf()
563 gchar *ImageLoaderPSD::get_format_name()
565 return g_strdup("psd");
568 gchar **ImageLoaderPSD::get_format_mime_types()
570 static const gchar *mime[] = {"application/psd", nullptr};
571 return g_strdupv(const_cast<gchar **>(mime));
574 ImageLoaderPSD::~ImageLoaderPSD()
576 if (pixbuf) g_object_unref(pixbuf);
581 std::unique_ptr<ImageLoaderBackend> get_image_loader_backend_psd()
583 return std::make_unique<ImageLoaderPSD>();
585 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */