2 * Photoshop (PSD) image decoder
3 * Copyright (c) 2016 Jokyo Images
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 #include "bytestream.h"
43 typedef struct PSDContext {
46 AVCodecContext *avctx;
51 uint16_t channel_count;
52 uint16_t channel_depth;
54 uint64_t uncompressed_size;
55 unsigned int pixel_size;/* 1 for 8 bits, 2 for 16 bits */
56 uint64_t line_size;/* length of src data (even width) */
61 enum PsdCompr compression;
62 enum PsdColorMode color_mode;
64 uint8_t palette[AVPALETTE_SIZE];
67 static int decode_header(PSDContext * s)
69 int signature, version, color_mode;
73 if (bytestream2_get_bytes_left(&s->gb) < 30) {/* File header section + color map data section length */
74 av_log(s->avctx, AV_LOG_ERROR, "Header too short to parse.\n");
75 return AVERROR_INVALIDDATA;
78 signature = bytestream2_get_le32(&s->gb);
79 if (signature != MKTAG('8','B','P','S')) {
80 av_log(s->avctx, AV_LOG_ERROR, "Wrong signature %d.\n", signature);
81 return AVERROR_INVALIDDATA;
84 version = bytestream2_get_be16(&s->gb);
86 av_log(s->avctx, AV_LOG_ERROR, "Wrong version %d.\n", version);
87 return AVERROR_INVALIDDATA;
90 bytestream2_skip(&s->gb, 6);/* reserved */
92 s->channel_count = bytestream2_get_be16(&s->gb);
93 if ((s->channel_count < 1) || (s->channel_count > 56)) {
94 av_log(s->avctx, AV_LOG_ERROR, "Invalid channel count %d.\n", s->channel_count);
95 return AVERROR_INVALIDDATA;
98 s->height = bytestream2_get_be32(&s->gb);
100 if ((s->height > 30000) && (s->avctx->strict_std_compliance > FF_COMPLIANCE_EXPERIMENTAL)) {
101 av_log(s->avctx, AV_LOG_ERROR,
102 "Height > 30000 is experimental, add "
103 "'-strict %d' if you want to try to decode the picture.\n",
104 FF_COMPLIANCE_EXPERIMENTAL);
105 return AVERROR_EXPERIMENTAL;
108 s->width = bytestream2_get_be32(&s->gb);
109 if ((s->width > 30000) && (s->avctx->strict_std_compliance > FF_COMPLIANCE_EXPERIMENTAL)) {
110 av_log(s->avctx, AV_LOG_ERROR,
111 "Width > 30000 is experimental, add "
112 "'-strict %d' if you want to try to decode the picture.\n",
113 FF_COMPLIANCE_EXPERIMENTAL);
114 return AVERROR_EXPERIMENTAL;
117 if ((ret = ff_set_dimensions(s->avctx, s->width, s->height)) < 0)
120 s->channel_depth = bytestream2_get_be16(&s->gb);
122 color_mode = bytestream2_get_be16(&s->gb);
123 switch (color_mode) {
125 s->color_mode = PSD_BITMAP;
128 s->color_mode = PSD_GRAYSCALE;
131 s->color_mode = PSD_INDEXED;
134 s->color_mode = PSD_RGB;
137 s->color_mode = PSD_CMYK;
140 s->color_mode = PSD_MULTICHANNEL;
143 s->color_mode = PSD_DUOTONE;
146 s->color_mode = PSD_LAB;
149 av_log(s->avctx, AV_LOG_ERROR, "Unknown color mode %d.\n", color_mode);
150 return AVERROR_INVALIDDATA;
154 len_section = bytestream2_get_be32(&s->gb);
155 if (len_section < 0) {
156 av_log(s->avctx, AV_LOG_ERROR, "Negative size for color map data section.\n");
157 return AVERROR_INVALIDDATA;
160 if (bytestream2_get_bytes_left(&s->gb) < (len_section + 4)) { /* section and len next section */
161 av_log(s->avctx, AV_LOG_ERROR, "Incomplete file.\n");
162 return AVERROR_INVALIDDATA;
166 memset(s->palette, 0xff, AVPALETTE_SIZE);
167 for (j = HAVE_BIGENDIAN; j < 3 + HAVE_BIGENDIAN; j++)
168 for (i = 0; i < FFMIN(256, len_section / 3); i++)
169 s->palette[i * 4 + (HAVE_BIGENDIAN ? j : 2 - j)] = bytestream2_get_byteu(&s->gb);
170 len_section -= i * 3;
172 bytestream2_skip(&s->gb, len_section);
174 /* image ressources */
175 len_section = bytestream2_get_be32(&s->gb);
176 if (len_section < 0) {
177 av_log(s->avctx, AV_LOG_ERROR, "Negative size for image ressources section.\n");
178 return AVERROR_INVALIDDATA;
181 if (bytestream2_get_bytes_left(&s->gb) < (len_section + 4)) { /* section and len next section */
182 av_log(s->avctx, AV_LOG_ERROR, "Incomplete file.\n");
183 return AVERROR_INVALIDDATA;
185 bytestream2_skip(&s->gb, len_section);
187 /* layers and masks */
188 len_section = bytestream2_get_be32(&s->gb);
189 if (len_section < 0) {
190 av_log(s->avctx, AV_LOG_ERROR, "Negative size for layers and masks data section.\n");
191 return AVERROR_INVALIDDATA;
194 if (bytestream2_get_bytes_left(&s->gb) < len_section) {
195 av_log(s->avctx, AV_LOG_ERROR, "Incomplete file.\n");
196 return AVERROR_INVALIDDATA;
198 bytestream2_skip(&s->gb, len_section);
201 if (bytestream2_get_bytes_left(&s->gb) < 2) {
202 av_log(s->avctx, AV_LOG_ERROR, "File without image data section.\n");
203 return AVERROR_INVALIDDATA;
206 s->compression = bytestream2_get_be16(&s->gb);
207 switch (s->compression) {
212 avpriv_request_sample(s->avctx, "ZIP without predictor compression");
213 return AVERROR_PATCHWELCOME;
216 avpriv_request_sample(s->avctx, "ZIP with predictor compression");
217 return AVERROR_PATCHWELCOME;
220 av_log(s->avctx, AV_LOG_ERROR, "Unknown compression %d.\n", s->compression);
221 return AVERROR_INVALIDDATA;
227 static int decode_rle(PSDContext * s){
228 unsigned int scanline_count;
229 unsigned int sl, count;
230 unsigned long target_index = 0;
233 unsigned int repeat_count;
236 scanline_count = s->height * s->channel_count;
239 if (bytestream2_get_bytes_left(&s->gb) < scanline_count * 2) {
240 av_log(s->avctx, AV_LOG_ERROR, "Not enough data for rle scanline table.\n");
241 return AVERROR_INVALIDDATA;
243 bytestream2_skip(&s->gb, scanline_count * 2);/* size of each scanline */
245 /* decode rle data scanline by scanline */
246 for (sl = 0; sl < scanline_count; sl++) {
249 while (count < s->line_size) {
250 rle_char = bytestream2_get_byte(&s->gb);
252 if (rle_char <= 0) {/* byte repeat */
253 repeat_count = rle_char * -1;
255 if (bytestream2_get_bytes_left(&s->gb) < 1) {
256 av_log(s->avctx, AV_LOG_ERROR, "Not enough data for rle scanline.\n");
257 return AVERROR_INVALIDDATA;
260 if (target_index + repeat_count >= s->uncompressed_size) {
261 av_log(s->avctx, AV_LOG_ERROR, "Invalid rle char.\n");
262 return AVERROR_INVALIDDATA;
265 v = bytestream2_get_byte(&s->gb);
266 for (p = 0; p <= repeat_count; p++) {
267 s->tmp[target_index++] = v;
269 count += repeat_count + 1;
271 if (bytestream2_get_bytes_left(&s->gb) < rle_char) {
272 av_log(s->avctx, AV_LOG_ERROR, "Not enough data for rle scanline.\n");
273 return AVERROR_INVALIDDATA;
276 if (target_index + rle_char >= s->uncompressed_size) {
277 av_log(s->avctx, AV_LOG_ERROR, "Invalid rle char.\n");
278 return AVERROR_INVALIDDATA;
281 for (p = 0; p <= rle_char; p++) {
282 v = bytestream2_get_byte(&s->gb);
283 s->tmp[target_index++] = v;
285 count += rle_char + 1;
293 static int decode_frame(AVCodecContext *avctx, void *data,
294 int *got_frame, AVPacket *avpkt)
298 const uint8_t *ptr_data;
299 int index_out, c, y, x, p;
300 uint8_t eq_channel[4] = {2,0,1,3};/* RGBA -> GBRA channel order */
301 uint8_t plane_number;
303 AVFrame *picture = data;
305 PSDContext *s = avctx->priv_data;
307 s->channel_count = 0;
308 s->channel_depth = 0;
312 bytestream2_init(&s->gb, avpkt->data, avpkt->size);
314 if ((ret = decode_header(s)) < 0)
317 s->pixel_size = s->channel_depth >> 3;/* in byte */
318 s->line_size = s->width * s->pixel_size;
320 switch (s->color_mode) {
322 if (s->channel_depth != 1 || s->channel_count != 1) {
323 av_log(s->avctx, AV_LOG_ERROR,
324 "Invalid bitmap file (channel_depth %d, channel_count %d)\n",
325 s->channel_depth, s->channel_count);
326 return AVERROR_INVALIDDATA;
328 s->line_size = s->width + 7 >> 3;
329 avctx->pix_fmt = AV_PIX_FMT_MONOWHITE;
332 if (s->channel_depth != 8 || s->channel_count != 1) {
333 av_log(s->avctx, AV_LOG_ERROR,
334 "Invalid indexed file (channel_depth %d, channel_count %d)\n",
335 s->channel_depth, s->channel_count);
336 return AVERROR_INVALIDDATA;
338 avctx->pix_fmt = AV_PIX_FMT_PAL8;
341 if (s->channel_count == 3) {
342 if (s->channel_depth == 8) {
343 avctx->pix_fmt = AV_PIX_FMT_GBRP;
344 } else if (s->channel_depth == 16) {
345 avctx->pix_fmt = AV_PIX_FMT_GBRP16BE;
347 avpriv_report_missing_feature(avctx, "channel depth %d for rgb", s->channel_depth);
348 return AVERROR_PATCHWELCOME;
350 } else if (s->channel_count == 4) {
351 if (s->channel_depth == 8) {
352 avctx->pix_fmt = AV_PIX_FMT_GBRAP;
353 } else if (s->channel_depth == 16) {
354 avctx->pix_fmt = AV_PIX_FMT_GBRAP16BE;
356 avpriv_report_missing_feature(avctx, "channel depth %d for rgb", s->channel_depth);
357 return AVERROR_PATCHWELCOME;
360 avpriv_report_missing_feature(avctx, "channel count %d for rgb", s->channel_count);
361 return AVERROR_PATCHWELCOME;
365 av_log(avctx, AV_LOG_WARNING, "ignoring unknown duotone specification.\n");
367 if (s->channel_count == 1) {
368 if (s->channel_depth == 8) {
369 avctx->pix_fmt = AV_PIX_FMT_GRAY8;
370 } else if (s->channel_depth == 16) {
371 avctx->pix_fmt = AV_PIX_FMT_GRAY16BE;
372 } else if (s->channel_depth == 32) {
373 avctx->pix_fmt = AV_PIX_FMT_GRAYF32BE;
375 avpriv_report_missing_feature(avctx, "channel depth %d for grayscale", s->channel_depth);
376 return AVERROR_PATCHWELCOME;
378 } else if (s->channel_count == 2) {
379 if (s->channel_depth == 8) {
380 avctx->pix_fmt = AV_PIX_FMT_YA8;
381 } else if (s->channel_depth == 16) {
382 avctx->pix_fmt = AV_PIX_FMT_YA16BE;
384 avpriv_report_missing_feature(avctx, "channel depth %d for grayscale", s->channel_depth);
385 return AVERROR_PATCHWELCOME;
388 avpriv_report_missing_feature(avctx, "channel count %d for grayscale", s->channel_count);
389 return AVERROR_PATCHWELCOME;
393 avpriv_report_missing_feature(avctx, "color mode %d", s->color_mode);
394 return AVERROR_PATCHWELCOME;
397 s->uncompressed_size = s->line_size * s->height * s->channel_count;
399 if ((ret = ff_get_buffer(avctx, picture, 0)) < 0)
402 /* decode picture if need */
403 if (s->compression == PSD_RLE) {
404 s->tmp = av_malloc(s->uncompressed_size);
406 return AVERROR(ENOMEM);
417 if (bytestream2_get_bytes_left(&s->gb) < s->uncompressed_size) {
418 av_log(s->avctx, AV_LOG_ERROR, "Not enough data for raw image data section.\n");
419 return AVERROR_INVALIDDATA;
421 ptr_data = s->gb.buffer;
425 if ((avctx->pix_fmt == AV_PIX_FMT_YA8)||(avctx->pix_fmt == AV_PIX_FMT_YA16BE)){/* Interleaved */
426 ptr = picture->data[0];
427 for (c = 0; c < s->channel_count; c++) {
428 for (y = 0; y < s->height; y++) {
429 for (x = 0; x < s->width; x++) {
430 index_out = y * picture->linesize[0] + x * s->channel_count * s->pixel_size + c * s->pixel_size;
431 for (p = 0; p < s->pixel_size; p++) {
432 ptr[index_out + p] = *ptr_data;
439 if (s->channel_count == 1)/* gray 8 or gray 16be */
440 eq_channel[0] = 0;/* assign first channel, to first plane */
442 for (c = 0; c < s->channel_count; c++) {
443 plane_number = eq_channel[c];
444 ptr = picture->data[plane_number];/* get the right plane */
445 for (y = 0; y < s->height; y++) {
446 memcpy(ptr, ptr_data, s->line_size);
447 ptr += picture->linesize[plane_number];
448 ptr_data += s->line_size;
453 if (s->color_mode == PSD_INDEXED) {
454 picture->palette_has_changed = 1;
455 memcpy(picture->data[1], s->palette, AVPALETTE_SIZE);
460 picture->pict_type = AV_PICTURE_TYPE_I;
466 AVCodec ff_psd_decoder = {
468 .long_name = NULL_IF_CONFIG_SMALL("Photoshop PSD file"),
469 .type = AVMEDIA_TYPE_VIDEO,
470 .id = AV_CODEC_ID_PSD,
471 .priv_data_size = sizeof(PSDContext),
472 .decode = decode_frame,
473 .capabilities = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_FRAME_THREADS,