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;
163 char input_device[33];
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;
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;
246 avctx->sample_aspect_ratio.num = read32(&buf, endian);
247 avctx->sample_aspect_ratio.den = read32(&buf, endian);
248 if (avctx->sample_aspect_ratio.num > 0 && avctx->sample_aspect_ratio.den > 0)
249 av_reduce(&avctx->sample_aspect_ratio.num, &avctx->sample_aspect_ratio.den,
250 avctx->sample_aspect_ratio.num, avctx->sample_aspect_ratio.den,
253 avctx->sample_aspect_ratio = (AVRational){ 0, 1 };
255 /* preferred frame rate from Motion-picture film header */
256 if (offset >= 1724 + 4) {
257 buf = avpkt->data + 1724;
258 i = read32(&buf, endian);
259 if(i && i != 0xFFFFFFFF) {
260 AVRational q = av_d2q(av_int2float(i), 4096);
261 if (q.num > 0 && q.den > 0)
262 avctx->framerate = q;
266 /* alternative frame rate from television header */
267 if (offset >= 1940 + 4 &&
268 !(avctx->framerate.num && avctx->framerate.den)) {
269 buf = avpkt->data + 1940;
270 i = read32(&buf, endian);
271 if(i && i != 0xFFFFFFFF) {
272 AVRational q = av_d2q(av_int2float(i), 4096);
273 if (q.num > 0 && q.den > 0)
274 avctx->framerate = q;
278 /* SMPTE TC from television header */
279 if (offset >= 1920 + 4) {
282 char tcbuf[AV_TIMECODE_STR_SIZE];
284 buf = avpkt->data + 1920;
285 // read32 to native endian, av_bswap32 to opposite of native for
286 // compatibility with av_timecode_make_smpte_tc_string2 etc
287 tc = av_bswap32(read32(&buf, endian));
289 if (i != 0xFFFFFFFF) {
290 AVFrameSideData *tcside =
291 av_frame_new_side_data(p, AV_FRAME_DATA_S12M_TIMECODE,
292 sizeof(uint32_t) * 4);
294 return AVERROR(ENOMEM);
296 tc_sd = (uint32_t*)tcside->data;
300 av_timecode_make_smpte_tc_string2(tcbuf, avctx->framerate,
302 av_dict_set(&p->metadata, "timecode", tcbuf, 0);
306 /* color range from television header */
307 if (offset >= 1964 + 4) {
308 buf = avpkt->data + 1952;
309 i = read32(&buf, endian);
311 buf = avpkt->data + 1964;
312 j = read32(&buf, endian);
314 if (i != 0xFFFFFFFF && j != 0xFFFFFFFF) {
316 minCV = av_int2float(i);
317 maxCV = av_int2float(j);
318 if (bits_per_color >= 1 &&
319 minCV == 0.0f && maxCV == ((1<<bits_per_color) - 1)) {
320 avctx->color_range = AVCOL_RANGE_JPEG;
321 } else if (bits_per_color >= 8 &&
322 minCV == (1 <<(bits_per_color - 4)) &&
323 maxCV == (235<<(bits_per_color - 8))) {
324 avctx->color_range = AVCOL_RANGE_MPEG;
329 switch (descriptor) {
349 case 103: // UYVA4444
354 avpriv_report_missing_feature(avctx, "Descriptor %d", descriptor);
355 return AVERROR_PATCHWELCOME;
358 switch (bits_per_color) {
360 stride = avctx->width * elements;
364 av_log(avctx, AV_LOG_ERROR, "Packing to 32bit required\n");
367 stride = (avctx->width * elements + 2) / 3 * 4;
370 stride = avctx->width * elements;
384 stride = 2 * avctx->width * elements;
389 avpriv_report_missing_feature(avctx, "Depth %d", bits_per_color);
390 return AVERROR_PATCHWELCOME;
392 return AVERROR_INVALIDDATA;
397 avctx->color_trc = AVCOL_TRC_LINEAR;
399 case DPX_TRC_SMPTE_274:
400 case DPX_TRC_ITU_R_709_4:
401 avctx->color_trc = AVCOL_TRC_BT709;
403 case DPX_TRC_ITU_R_601_625:
404 case DPX_TRC_ITU_R_601_525:
405 case DPX_TRC_SMPTE_170:
406 avctx->color_trc = AVCOL_TRC_SMPTE170M;
408 case DPX_TRC_ITU_R_624_4_PAL:
409 avctx->color_trc = AVCOL_TRC_GAMMA28;
411 case DPX_TRC_USER_DEFINED:
412 case DPX_TRC_UNSPECIFIED_VIDEO:
416 av_log(avctx, AV_LOG_VERBOSE, "Cannot map DPX transfer characteristic "
417 "%d to color_trc.\n", color_trc);
421 switch (color_spec) {
422 case DPX_COL_SPEC_SMPTE_274:
423 case DPX_COL_SPEC_ITU_R_709_4:
424 avctx->color_primaries = AVCOL_PRI_BT709;
426 case DPX_COL_SPEC_ITU_R_601_625:
427 case DPX_COL_SPEC_ITU_R_624_4_PAL:
428 avctx->color_primaries = AVCOL_PRI_BT470BG;
430 case DPX_COL_SPEC_ITU_R_601_525:
431 case DPX_COL_SPEC_SMPTE_170:
432 avctx->color_primaries = AVCOL_PRI_SMPTE170M;
434 case DPX_COL_SPEC_USER_DEFINED:
435 case DPX_COL_SPEC_UNSPECIFIED_VIDEO:
439 av_log(avctx, AV_LOG_VERBOSE, "Cannot map DPX color specification "
440 "%d to color_primaries.\n", color_spec);
445 switch (color_spec) {
446 case DPX_COL_SPEC_SMPTE_274:
447 case DPX_COL_SPEC_ITU_R_709_4:
448 avctx->colorspace = AVCOL_SPC_BT709;
450 case DPX_COL_SPEC_ITU_R_601_625:
451 case DPX_COL_SPEC_ITU_R_624_4_PAL:
452 avctx->colorspace = AVCOL_SPC_BT470BG;
454 case DPX_COL_SPEC_ITU_R_601_525:
455 case DPX_COL_SPEC_SMPTE_170:
456 avctx->colorspace = AVCOL_SPC_SMPTE170M;
458 case DPX_COL_SPEC_USER_DEFINED:
459 case DPX_COL_SPEC_UNSPECIFIED_VIDEO:
463 av_log(avctx, AV_LOG_INFO, "Cannot map DPX color specification "
464 "%d to colorspace.\n", color_spec);
468 avctx->colorspace = AVCOL_SPC_RGB;
471 // Table 3c: Runs will always break at scan line boundaries. Packing
472 // will always break to the next 32-bit word at scan-line boundaries.
473 // Unfortunately, the encoder produced invalid files, so attempt
475 need_align = FFALIGN(stride, 4);
476 if (need_align*avctx->height + (int64_t)offset > avpkt->size) {
477 // Alignment seems unappliable, try without
478 if (stride*avctx->height + (int64_t)offset > avpkt->size) {
479 av_log(avctx, AV_LOG_ERROR, "Overread buffer. Invalid header?\n");
480 return AVERROR_INVALIDDATA;
482 av_log(avctx, AV_LOG_INFO, "Decoding DPX without scanline "
487 need_align -= stride;
488 stride = FFALIGN(stride, 4);
491 switch (1000 * descriptor + 10 * bits_per_color + endian) {
494 avctx->pix_fmt = AV_PIX_FMT_GRAY8;
498 avctx->pix_fmt = AV_PIX_FMT_GRAY12;
502 avctx->pix_fmt = AV_PIX_FMT_RGB24;
506 avctx->pix_fmt = AV_PIX_FMT_ABGR;
510 avctx->pix_fmt = AV_PIX_FMT_RGBA;
514 avctx->pix_fmt = AV_PIX_FMT_GBRP10;
518 avctx->pix_fmt = AV_PIX_FMT_GBRAP10;
522 avctx->pix_fmt = AV_PIX_FMT_GBRP12;
526 avctx->pix_fmt = AV_PIX_FMT_GBRAP12;
530 avctx->pix_fmt = AV_PIX_FMT_GRAY10;
533 avctx->pix_fmt = AV_PIX_FMT_GRAY16BE;
536 avctx->pix_fmt = AV_PIX_FMT_GRAY16LE;
539 avctx->pix_fmt = AV_PIX_FMT_RGB48BE;
542 avctx->pix_fmt = AV_PIX_FMT_RGB48LE;
545 avctx->pix_fmt = AV_PIX_FMT_RGBA64BE;
548 avctx->pix_fmt = AV_PIX_FMT_RGBA64LE;
551 avctx->pix_fmt = AV_PIX_FMT_UYVY422;
554 avctx->pix_fmt = AV_PIX_FMT_YUV444P;
557 avctx->pix_fmt = AV_PIX_FMT_YUVA444P;
560 av_log(avctx, AV_LOG_ERROR, "Unsupported format\n");
561 return AVERROR_PATCHWELCOME;
564 ff_set_sar(avctx, avctx->sample_aspect_ratio);
566 if ((ret = ff_get_buffer(avctx, p, 0)) < 0)
569 av_strlcpy(creator, avpkt->data + 160, 100);
571 av_dict_set(&p->metadata, "Creator", creator, 0);
573 av_strlcpy(input_device, avpkt->data + 1556, 32);
574 input_device[32] = '\0';
575 av_dict_set(&p->metadata, "Input Device", input_device, 0);
577 // Move pointer to offset from start of file
578 buf = avpkt->data + offset;
580 for (i=0; i<AV_NUM_DATA_POINTERS; i++)
583 switch (bits_per_color) {
585 for (x = 0; x < avctx->height; x++) {
586 uint16_t *dst[4] = {(uint16_t*)ptr[0],
590 int shift = elements > 1 ? packing == 1 ? 22 : 20 : packing == 1 ? 2 : 0;
591 for (y = 0; y < avctx->width; y++) {
593 *dst[2]++ = read10in32(&buf, &rgbBuffer,
594 &n_datum, endian, shift);
596 *dst[0]++ = read10in32_gray(&buf, &rgbBuffer,
597 &n_datum, endian, shift);
599 *dst[0]++ = read10in32(&buf, &rgbBuffer,
600 &n_datum, endian, shift);
602 *dst[1]++ = read10in32(&buf, &rgbBuffer,
603 &n_datum, endian, shift);
606 read10in32(&buf, &rgbBuffer,
607 &n_datum, endian, shift);
609 if (memcmp(input_device, "Scanity", 7))
611 for (i = 0; i < elements; i++)
612 ptr[i] += p->linesize[i];
616 for (x = 0; x < avctx->height; x++) {
617 uint16_t *dst[4] = {(uint16_t*)ptr[0],
621 int shift = packing == 1 ? 4 : 0;
622 for (y = 0; y < avctx->width; y++) {
625 *dst[2]++ = read16(&buf, endian) >> shift & 0xFFF;
626 *dst[0]++ = read16(&buf, endian) >> shift & 0xFFF;
628 *dst[1]++ = read16(&buf, endian) >> shift & 0xFFF;
630 *dst[3]++ = read16(&buf, endian) >> shift & 0xFFF;
633 *dst[2]++ = read12in32(&buf, &rgbBuffer,
635 *dst[0]++ = read12in32(&buf, &rgbBuffer,
638 *dst[1]++ = read12in32(&buf, &rgbBuffer,
641 *dst[3]++ = read12in32(&buf, &rgbBuffer,
646 for (i = 0; i < elements; i++)
647 ptr[i] += p->linesize[i];
648 // Jump to next aligned position
655 if ( avctx->pix_fmt == AV_PIX_FMT_YUVA444P
656 || avctx->pix_fmt == AV_PIX_FMT_YUV444P) {
657 for (x = 0; x < avctx->height; x++) {
658 ptr[0] = p->data[0] + x * p->linesize[0];
659 ptr[1] = p->data[1] + x * p->linesize[1];
660 ptr[2] = p->data[2] + x * p->linesize[2];
661 ptr[3] = p->data[3] + x * p->linesize[3];
662 for (y = 0; y < avctx->width; y++) {
666 if (avctx->pix_fmt == AV_PIX_FMT_YUVA444P)
671 av_image_copy_plane(ptr[0], p->linesize[0],
673 elements * avctx->width, avctx->height);
683 AVCodec ff_dpx_decoder = {
685 .long_name = NULL_IF_CONFIG_SMALL("DPX (Digital Picture Exchange) image"),
686 .type = AVMEDIA_TYPE_VIDEO,
687 .id = AV_CODEC_ID_DPX,
688 .decode = decode_frame,
689 .capabilities = AV_CODEC_CAP_DR1,