2 * DPX (.dpx) image decoder
3 * Copyright (c) 2009 Jimmy Christensen
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 "libavutil/avstring.h"
23 #include "libavutil/intreadwrite.h"
24 #include "libavutil/intfloat.h"
25 #include "libavutil/imgutils.h"
26 #include "libavutil/timecode.h"
27 #include "bytestream.h"
32 DPX_TRC_USER_DEFINED = 0,
33 DPX_TRC_PRINTING_DENSITY = 1,
35 DPX_TRC_LOGARITHMIC = 3,
36 DPX_TRC_UNSPECIFIED_VIDEO = 4,
37 DPX_TRC_SMPTE_274 = 5,
38 DPX_TRC_ITU_R_709_4 = 6,
39 DPX_TRC_ITU_R_601_625 = 7,
40 DPX_TRC_ITU_R_601_525 = 8,
41 DPX_TRC_SMPTE_170 = 9,
42 DPX_TRC_ITU_R_624_4_PAL = 10,
43 DPX_TRC_Z_LINEAR = 11,
44 DPX_TRC_Z_HOMOGENEOUS = 12,
48 DPX_COL_SPEC_USER_DEFINED = 0,
49 DPX_COL_SPEC_PRINTING_DENSITY = 1,
52 DPX_COL_SPEC_UNSPECIFIED_VIDEO = 4,
53 DPX_COL_SPEC_SMPTE_274 = 5,
54 DPX_COL_SPEC_ITU_R_709_4 = 6,
55 DPX_COL_SPEC_ITU_R_601_625 = 7,
56 DPX_COL_SPEC_ITU_R_601_525 = 8,
57 DPX_COL_SPEC_SMPTE_170 = 9,
58 DPX_COL_SPEC_ITU_R_624_4_PAL = 10,
63 static unsigned int read16(const uint8_t **ptr, int is_big)
75 static unsigned int read32(const uint8_t **ptr, int is_big)
87 static uint16_t read10in32_gray(const uint8_t **ptr, uint32_t *lbuf,
88 int *n_datum, int is_big, int shift)
95 *lbuf = read32(ptr, is_big);
99 temp = *lbuf >> shift & 0x3FF;
105 static uint16_t read10in32(const uint8_t **ptr, uint32_t *lbuf,
106 int *n_datum, int is_big, int shift)
111 *lbuf = read32(ptr, is_big);
115 *lbuf = *lbuf << 10 | *lbuf >> shift & 0x3FFFFF;
117 return *lbuf & 0x3FF;
120 static uint16_t read12in32(const uint8_t **ptr, uint32_t *lbuf,
121 int *n_datum, int is_big)
126 *lbuf = read32(ptr, is_big);
131 case 7: return *lbuf & 0xFFF;
132 case 6: return (*lbuf >> 12) & 0xFFF;
134 uint32_t c = *lbuf >> 24;
135 *lbuf = read32(ptr, is_big);
139 case 4: return (*lbuf >> 4) & 0xFFF;
140 case 3: return (*lbuf >> 16) & 0xFFF;
142 uint32_t c = *lbuf >> 28;
143 *lbuf = read32(ptr, is_big);
147 case 1: return (*lbuf >> 8) & 0xFFF;
148 default: return *lbuf >> 20;
152 static int decode_frame(AVCodecContext *avctx,
157 const uint8_t *buf = avpkt->data;
158 int buf_size = avpkt->size;
159 AVFrame *const p = data;
160 uint8_t *ptr[AV_NUM_DATA_POINTERS];
161 uint32_t header_version, version = 0;
162 char creator[101] = { 0 };
163 char input_device[33] = { 0 };
166 int magic_num, endian;
167 int x, y, stride, i, j, ret;
168 int w, h, bits_per_color, descriptor, elements, packing;
169 int yuv, color_trc, color_spec;
170 int encoding, need_align = 0, unpadded_10bit = 0;
172 unsigned int rgbBuffer = 0;
175 if (avpkt->size <= 1634) {
176 av_log(avctx, AV_LOG_ERROR, "Packet too small for DPX header\n");
177 return AVERROR_INVALIDDATA;
180 magic_num = AV_RB32(buf);
183 /* Check if the files "magic number" is "SDPX" which means it uses
184 * big-endian or XPDS which is for little-endian files */
185 if (magic_num == AV_RL32("SDPX")) {
187 } else if (magic_num == AV_RB32("SDPX")) {
190 av_log(avctx, AV_LOG_ERROR, "DPX marker not found\n");
191 return AVERROR_INVALIDDATA;
194 offset = read32(&buf, endian);
195 if (avpkt->size <= offset) {
196 av_log(avctx, AV_LOG_ERROR, "Invalid data start offset\n");
197 return AVERROR_INVALIDDATA;
200 header_version = read32(&buf, 0);
201 if (header_version == MKTAG('V','1','.','0'))
203 if (header_version == MKTAG('V','2','.','0'))
206 av_log(avctx, AV_LOG_WARNING, "Unknown header format version %s.\n",
207 av_fourcc2str(header_version));
210 buf = avpkt->data + 660;
211 ret = read32(&buf, endian);
212 if (ret != 0xFFFFFFFF) {
213 avpriv_report_missing_feature(avctx, "Encryption");
214 av_log(avctx, AV_LOG_WARNING, "The image is encrypted and may "
215 "not properly decode.\n");
218 // Need to end in 0x304 offset from start of file
219 buf = avpkt->data + 0x304;
220 w = read32(&buf, endian);
221 h = read32(&buf, endian);
223 if ((ret = ff_set_dimensions(avctx, w, h)) < 0)
226 // Need to end in 0x320 to read the descriptor
232 // Need to end in 0x323 to read the bits per color
234 avctx->bits_per_raw_sample =
235 bits_per_color = buf[0];
237 packing = read16(&buf, endian);
238 encoding = read16(&buf, endian);
241 avpriv_report_missing_feature(avctx, "Encoding %d", encoding);
242 return AVERROR_PATCHWELCOME;
245 if (bits_per_color > 32)
246 return AVERROR_INVALIDDATA;
249 avctx->sample_aspect_ratio.num = read32(&buf, endian);
250 avctx->sample_aspect_ratio.den = read32(&buf, endian);
251 if (avctx->sample_aspect_ratio.num > 0 && avctx->sample_aspect_ratio.den > 0)
252 av_reduce(&avctx->sample_aspect_ratio.num, &avctx->sample_aspect_ratio.den,
253 avctx->sample_aspect_ratio.num, avctx->sample_aspect_ratio.den,
256 avctx->sample_aspect_ratio = (AVRational){ 0, 1 };
258 /* preferred frame rate from Motion-picture film header */
259 if (offset >= 1724 + 4) {
260 buf = avpkt->data + 1724;
261 i = read32(&buf, endian);
262 if(i && i != 0xFFFFFFFF) {
263 AVRational q = av_d2q(av_int2float(i), 4096);
264 if (q.num > 0 && q.den > 0)
265 avctx->framerate = q;
269 /* alternative frame rate from television header */
270 if (offset >= 1940 + 4 &&
271 !(avctx->framerate.num && avctx->framerate.den)) {
272 buf = avpkt->data + 1940;
273 i = read32(&buf, endian);
274 if(i && i != 0xFFFFFFFF) {
275 AVRational q = av_d2q(av_int2float(i), 4096);
276 if (q.num > 0 && q.den > 0)
277 avctx->framerate = q;
281 /* SMPTE TC from television header */
282 if (offset >= 1920 + 4) {
285 char tcbuf[AV_TIMECODE_STR_SIZE];
287 buf = avpkt->data + 1920;
288 // read32 to native endian, av_bswap32 to opposite of native for
289 // compatibility with av_timecode_make_smpte_tc_string2 etc
290 tc = av_bswap32(read32(&buf, endian));
292 if (i != 0xFFFFFFFF) {
293 AVFrameSideData *tcside =
294 av_frame_new_side_data(p, AV_FRAME_DATA_S12M_TIMECODE,
295 sizeof(uint32_t) * 4);
297 return AVERROR(ENOMEM);
299 tc_sd = (uint32_t*)tcside->data;
303 av_timecode_make_smpte_tc_string2(tcbuf, avctx->framerate,
305 av_dict_set(&p->metadata, "timecode", tcbuf, 0);
309 /* color range from television header */
310 if (offset >= 1964 + 4) {
311 buf = avpkt->data + 1952;
312 i = read32(&buf, endian);
314 buf = avpkt->data + 1964;
315 j = read32(&buf, endian);
317 if (i != 0xFFFFFFFF && j != 0xFFFFFFFF) {
319 minCV = av_int2float(i);
320 maxCV = av_int2float(j);
321 if (bits_per_color >= 1 &&
322 minCV == 0.0f && maxCV == ((1<<bits_per_color) - 1)) {
323 avctx->color_range = AVCOL_RANGE_JPEG;
324 } else if (bits_per_color >= 8 &&
325 minCV == (1 <<(bits_per_color - 4)) &&
326 maxCV == (235<<(bits_per_color - 8))) {
327 avctx->color_range = AVCOL_RANGE_MPEG;
332 switch (descriptor) {
358 case 103: // UYVA4444
363 avpriv_report_missing_feature(avctx, "Descriptor %d", descriptor);
364 return AVERROR_PATCHWELCOME;
367 switch (bits_per_color) {
369 stride = avctx->width * elements;
373 av_log(avctx, AV_LOG_ERROR, "Packing to 32bit required\n");
376 stride = (avctx->width * elements + 2) / 3 * 4;
379 stride = avctx->width * elements;
393 stride = 2 * avctx->width * elements;
396 stride = 4 * avctx->width * elements;
400 avpriv_report_missing_feature(avctx, "Depth %d", bits_per_color);
401 return AVERROR_PATCHWELCOME;
403 return AVERROR_INVALIDDATA;
408 avctx->color_trc = AVCOL_TRC_LINEAR;
410 case DPX_TRC_SMPTE_274:
411 case DPX_TRC_ITU_R_709_4:
412 avctx->color_trc = AVCOL_TRC_BT709;
414 case DPX_TRC_ITU_R_601_625:
415 case DPX_TRC_ITU_R_601_525:
416 case DPX_TRC_SMPTE_170:
417 avctx->color_trc = AVCOL_TRC_SMPTE170M;
419 case DPX_TRC_ITU_R_624_4_PAL:
420 avctx->color_trc = AVCOL_TRC_GAMMA28;
422 case DPX_TRC_USER_DEFINED:
423 case DPX_TRC_UNSPECIFIED_VIDEO:
427 av_log(avctx, AV_LOG_VERBOSE, "Cannot map DPX transfer characteristic "
428 "%d to color_trc.\n", color_trc);
432 switch (color_spec) {
433 case DPX_COL_SPEC_SMPTE_274:
434 case DPX_COL_SPEC_ITU_R_709_4:
435 avctx->color_primaries = AVCOL_PRI_BT709;
437 case DPX_COL_SPEC_ITU_R_601_625:
438 case DPX_COL_SPEC_ITU_R_624_4_PAL:
439 avctx->color_primaries = AVCOL_PRI_BT470BG;
441 case DPX_COL_SPEC_ITU_R_601_525:
442 case DPX_COL_SPEC_SMPTE_170:
443 avctx->color_primaries = AVCOL_PRI_SMPTE170M;
445 case DPX_COL_SPEC_USER_DEFINED:
446 case DPX_COL_SPEC_UNSPECIFIED_VIDEO:
450 av_log(avctx, AV_LOG_VERBOSE, "Cannot map DPX color specification "
451 "%d to color_primaries.\n", color_spec);
456 switch (color_spec) {
457 case DPX_COL_SPEC_SMPTE_274:
458 case DPX_COL_SPEC_ITU_R_709_4:
459 avctx->colorspace = AVCOL_SPC_BT709;
461 case DPX_COL_SPEC_ITU_R_601_625:
462 case DPX_COL_SPEC_ITU_R_624_4_PAL:
463 avctx->colorspace = AVCOL_SPC_BT470BG;
465 case DPX_COL_SPEC_ITU_R_601_525:
466 case DPX_COL_SPEC_SMPTE_170:
467 avctx->colorspace = AVCOL_SPC_SMPTE170M;
469 case DPX_COL_SPEC_USER_DEFINED:
470 case DPX_COL_SPEC_UNSPECIFIED_VIDEO:
474 av_log(avctx, AV_LOG_INFO, "Cannot map DPX color specification "
475 "%d to colorspace.\n", color_spec);
479 avctx->colorspace = AVCOL_SPC_RGB;
482 // Table 3c: Runs will always break at scan line boundaries. Packing
483 // will always break to the next 32-bit word at scan-line boundaries.
484 // Unfortunately, the encoder produced invalid files, so attempt
486 need_align = FFALIGN(stride, 4);
487 if (need_align*avctx->height + (int64_t)offset > avpkt->size) {
488 // Alignment seems unappliable, try without
489 if (stride*avctx->height + (int64_t)offset > avpkt->size) {
490 av_log(avctx, AV_LOG_ERROR, "Overread buffer. Invalid header?\n");
491 return AVERROR_INVALIDDATA;
493 av_log(avctx, AV_LOG_INFO, "Decoding DPX without scanline "
498 need_align -= stride;
499 stride = FFALIGN(stride, 4);
502 switch (1000 * descriptor + 10 * bits_per_color + endian) {
513 avctx->pix_fmt = AV_PIX_FMT_GRAY8;
517 avctx->pix_fmt = AV_PIX_FMT_GRAY12;
524 avctx->pix_fmt = AV_PIX_FMT_GRAYF32LE;
531 avctx->pix_fmt = AV_PIX_FMT_GRAYF32BE;
535 avctx->pix_fmt = AV_PIX_FMT_RGB24;
539 avctx->pix_fmt = AV_PIX_FMT_ABGR;
543 avctx->pix_fmt = AV_PIX_FMT_RGBA;
547 avctx->pix_fmt = AV_PIX_FMT_GBRP10;
551 avctx->pix_fmt = AV_PIX_FMT_GBRAP10;
555 avctx->pix_fmt = AV_PIX_FMT_GBRP12;
559 avctx->pix_fmt = AV_PIX_FMT_GBRAP12;
563 avctx->pix_fmt = AV_PIX_FMT_GRAY10;
566 avctx->pix_fmt = AV_PIX_FMT_GRAY16BE;
569 avctx->pix_fmt = AV_PIX_FMT_GRAY16LE;
572 avctx->pix_fmt = AV_PIX_FMT_RGB48BE;
575 avctx->pix_fmt = AV_PIX_FMT_RGB48LE;
578 avctx->pix_fmt = AV_PIX_FMT_RGBA64BE;
581 avctx->pix_fmt = AV_PIX_FMT_RGBA64LE;
584 avctx->pix_fmt = AV_PIX_FMT_GBRPF32LE;
587 avctx->pix_fmt = AV_PIX_FMT_GBRPF32BE;
590 avctx->pix_fmt = AV_PIX_FMT_GBRAPF32LE;
593 avctx->pix_fmt = AV_PIX_FMT_GBRAPF32BE;
596 avctx->pix_fmt = AV_PIX_FMT_UYVY422;
599 avctx->pix_fmt = AV_PIX_FMT_YUV444P;
602 avctx->pix_fmt = AV_PIX_FMT_YUVA444P;
605 av_log(avctx, AV_LOG_ERROR, "Unsupported format %d\n",
606 1000 * descriptor + 10 * bits_per_color + endian);
607 return AVERROR_PATCHWELCOME;
610 ff_set_sar(avctx, avctx->sample_aspect_ratio);
612 if ((ret = ff_get_buffer(avctx, p, 0)) < 0)
615 av_strlcpy(creator, avpkt->data + 160, 100);
617 av_dict_set(&p->metadata, "Creator", creator, 0);
619 av_strlcpy(input_device, avpkt->data + 1556, 32);
620 input_device[32] = '\0';
621 av_dict_set(&p->metadata, "Input Device", input_device, 0);
623 // Some devices do not pad 10bit samples to whole 32bit words per row
624 if (!memcmp(input_device, "Scanity", 7) ||
625 !memcmp(creator, "Lasergraphics Inc.", 18)) {
629 // Move pointer to offset from start of file
630 buf = avpkt->data + offset;
632 for (i=0; i<AV_NUM_DATA_POINTERS; i++)
635 switch (bits_per_color) {
637 for (x = 0; x < avctx->height; x++) {
638 uint16_t *dst[4] = {(uint16_t*)ptr[0],
642 int shift = elements > 1 ? packing == 1 ? 22 : 20 : packing == 1 ? 2 : 0;
643 for (y = 0; y < avctx->width; y++) {
645 *dst[2]++ = read10in32(&buf, &rgbBuffer,
646 &n_datum, endian, shift);
648 *dst[0]++ = read10in32_gray(&buf, &rgbBuffer,
649 &n_datum, endian, shift);
651 *dst[0]++ = read10in32(&buf, &rgbBuffer,
652 &n_datum, endian, shift);
654 *dst[1]++ = read10in32(&buf, &rgbBuffer,
655 &n_datum, endian, shift);
658 read10in32(&buf, &rgbBuffer,
659 &n_datum, endian, shift);
663 for (i = 0; i < elements; i++)
664 ptr[i] += p->linesize[i];
668 for (x = 0; x < avctx->height; x++) {
669 uint16_t *dst[4] = {(uint16_t*)ptr[0],
673 int shift = packing == 1 ? 4 : 0;
674 for (y = 0; y < avctx->width; y++) {
677 *dst[2]++ = read16(&buf, endian) >> shift & 0xFFF;
678 *dst[0]++ = read16(&buf, endian) >> shift & 0xFFF;
680 *dst[1]++ = read16(&buf, endian) >> shift & 0xFFF;
682 *dst[3]++ = read16(&buf, endian) >> shift & 0xFFF;
685 *dst[2]++ = read12in32(&buf, &rgbBuffer,
687 *dst[0]++ = read12in32(&buf, &rgbBuffer,
690 *dst[1]++ = read12in32(&buf, &rgbBuffer,
693 *dst[3]++ = read12in32(&buf, &rgbBuffer,
698 for (i = 0; i < elements; i++)
699 ptr[i] += p->linesize[i];
700 // Jump to next aligned position
706 av_image_copy_plane(ptr[0], p->linesize[0],
708 elements * avctx->width * 4, avctx->height);
710 for (y = 0; y < avctx->height; y++) {
711 ptr[0] = p->data[0] + y * p->linesize[0];
712 ptr[1] = p->data[1] + y * p->linesize[1];
713 ptr[2] = p->data[2] + y * p->linesize[2];
714 ptr[3] = p->data[3] + y * p->linesize[3];
715 for (x = 0; x < avctx->width; x++) {
716 AV_WN32(ptr[2], AV_RN32(buf));
717 AV_WN32(ptr[0], AV_RN32(buf + 4));
718 AV_WN32(ptr[1], AV_RN32(buf + 8));
719 if (avctx->pix_fmt == AV_PIX_FMT_GBRAPF32BE ||
720 avctx->pix_fmt == AV_PIX_FMT_GBRAPF32LE) {
721 AV_WN32(ptr[3], AV_RN32(buf + 12));
737 if ( avctx->pix_fmt == AV_PIX_FMT_YUVA444P
738 || avctx->pix_fmt == AV_PIX_FMT_YUV444P) {
739 for (x = 0; x < avctx->height; x++) {
740 ptr[0] = p->data[0] + x * p->linesize[0];
741 ptr[1] = p->data[1] + x * p->linesize[1];
742 ptr[2] = p->data[2] + x * p->linesize[2];
743 ptr[3] = p->data[3] + x * p->linesize[3];
744 for (y = 0; y < avctx->width; y++) {
748 if (avctx->pix_fmt == AV_PIX_FMT_YUVA444P)
753 av_image_copy_plane(ptr[0], p->linesize[0],
755 elements * avctx->width, avctx->height);
765 AVCodec ff_dpx_decoder = {
767 .long_name = NULL_IF_CONFIG_SMALL("DPX (Digital Picture Exchange) image"),
768 .type = AVMEDIA_TYPE_VIDEO,
769 .id = AV_CODEC_ID_DPX,
770 .decode = decode_frame,
771 .capabilities = AV_CODEC_CAP_DR1,