2 * Copyright (c) 2010-2011 Maxim Poliakovski
3 * Copyright (c) 2010-2011 Elvis Presley
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
24 * Known FOURCCs: 'apch' (HQ), 'apcn' (SD), 'apcs' (LT), 'acpo' (Proxy), 'ap4h' (4444)
29 #define LONG_BITSTREAM_READER
35 #include "simple_idct.h"
36 #include "proresdec.h"
37 #include "proresdata.h"
39 static void permute(uint8_t *dst, const uint8_t *src, const uint8_t permutation[64])
42 for (i = 0; i < 64; i++)
43 dst[i] = permutation[src[i]];
46 static av_cold int decode_init(AVCodecContext *avctx)
48 ProresContext *ctx = avctx->priv_data;
49 uint8_t idct_permutation[64];
51 avctx->bits_per_raw_sample = 10;
53 ff_blockdsp_init(&ctx->bdsp, avctx);
54 ff_proresdsp_init(&ctx->prodsp, avctx);
56 ff_init_scantable_permutation(idct_permutation,
57 ctx->prodsp.idct_permutation_type);
59 permute(ctx->progressive_scan, ff_prores_progressive_scan, idct_permutation);
60 permute(ctx->interlaced_scan, ff_prores_interlaced_scan, idct_permutation);
65 static int decode_frame_header(ProresContext *ctx, const uint8_t *buf,
66 const int data_size, AVCodecContext *avctx)
68 int hdr_size, width, height, flags;
72 hdr_size = AV_RB16(buf);
73 av_dlog(avctx, "header size %d\n", hdr_size);
74 if (hdr_size > data_size) {
75 av_log(avctx, AV_LOG_ERROR, "error, wrong header size\n");
76 return AVERROR_INVALIDDATA;
79 version = AV_RB16(buf + 2);
80 av_dlog(avctx, "%.4s version %d\n", buf+4, version);
82 av_log(avctx, AV_LOG_ERROR, "unsupported version: %d\n", version);
83 return AVERROR_PATCHWELCOME;
86 width = AV_RB16(buf + 8);
87 height = AV_RB16(buf + 10);
88 if (width != avctx->width || height != avctx->height) {
89 av_log(avctx, AV_LOG_ERROR, "picture resolution change: %dx%d -> %dx%d\n",
90 avctx->width, avctx->height, width, height);
91 return AVERROR_PATCHWELCOME;
94 ctx->frame_type = (buf[12] >> 2) & 3;
95 ctx->alpha_info = buf[17] & 0xf;
97 if (ctx->alpha_info > 2) {
98 av_log(avctx, AV_LOG_ERROR, "Invalid alpha mode %d\n", ctx->alpha_info);
99 return AVERROR_INVALIDDATA;
101 if (avctx->skip_alpha) ctx->alpha_info = 0;
103 av_dlog(avctx, "frame type %d\n", ctx->frame_type);
105 if (ctx->frame_type == 0) {
106 ctx->scan = ctx->progressive_scan; // permuted
108 ctx->scan = ctx->interlaced_scan; // permuted
109 ctx->frame->interlaced_frame = 1;
110 ctx->frame->top_field_first = ctx->frame_type == 1;
113 if (ctx->alpha_info) {
114 avctx->pix_fmt = (buf[12] & 0xC0) == 0xC0 ? AV_PIX_FMT_YUVA444P10 : AV_PIX_FMT_YUVA422P10;
116 avctx->pix_fmt = (buf[12] & 0xC0) == 0xC0 ? AV_PIX_FMT_YUV444P10 : AV_PIX_FMT_YUV422P10;
121 av_dlog(avctx, "flags %x\n", flags);
124 if(buf + data_size - ptr < 64) {
125 av_log(avctx, AV_LOG_ERROR, "Header truncated\n");
126 return AVERROR_INVALIDDATA;
128 permute(ctx->qmat_luma, ctx->prodsp.idct_permutation, ptr);
131 memset(ctx->qmat_luma, 4, 64);
135 if(buf + data_size - ptr < 64) {
136 av_log(avctx, AV_LOG_ERROR, "Header truncated\n");
137 return AVERROR_INVALIDDATA;
139 permute(ctx->qmat_chroma, ctx->prodsp.idct_permutation, ptr);
141 memset(ctx->qmat_chroma, 4, 64);
147 static int decode_picture_header(AVCodecContext *avctx, const uint8_t *buf, const int buf_size)
149 ProresContext *ctx = avctx->priv_data;
150 int i, hdr_size, slice_count;
151 unsigned pic_data_size;
152 int log2_slice_mb_width, log2_slice_mb_height;
153 int slice_mb_count, mb_x, mb_y;
154 const uint8_t *data_ptr, *index_ptr;
156 hdr_size = buf[0] >> 3;
157 if (hdr_size < 8 || hdr_size > buf_size) {
158 av_log(avctx, AV_LOG_ERROR, "error, wrong picture header size\n");
159 return AVERROR_INVALIDDATA;
162 pic_data_size = AV_RB32(buf + 1);
163 if (pic_data_size > buf_size) {
164 av_log(avctx, AV_LOG_ERROR, "error, wrong picture data size\n");
165 return AVERROR_INVALIDDATA;
168 log2_slice_mb_width = buf[7] >> 4;
169 log2_slice_mb_height = buf[7] & 0xF;
170 if (log2_slice_mb_width > 3 || log2_slice_mb_height) {
171 av_log(avctx, AV_LOG_ERROR, "unsupported slice resolution: %dx%d\n",
172 1 << log2_slice_mb_width, 1 << log2_slice_mb_height);
173 return AVERROR_INVALIDDATA;
176 ctx->mb_width = (avctx->width + 15) >> 4;
178 ctx->mb_height = (avctx->height + 31) >> 5;
180 ctx->mb_height = (avctx->height + 15) >> 4;
182 slice_count = AV_RB16(buf + 5);
184 if (ctx->slice_count != slice_count || !ctx->slices) {
185 av_freep(&ctx->slices);
186 ctx->slice_count = 0;
187 ctx->slices = av_mallocz_array(slice_count, sizeof(*ctx->slices));
189 return AVERROR(ENOMEM);
190 ctx->slice_count = slice_count;
194 return AVERROR(EINVAL);
196 if (hdr_size + slice_count*2 > buf_size) {
197 av_log(avctx, AV_LOG_ERROR, "error, wrong slice count\n");
198 return AVERROR_INVALIDDATA;
201 // parse slice information
202 index_ptr = buf + hdr_size;
203 data_ptr = index_ptr + slice_count*2;
205 slice_mb_count = 1 << log2_slice_mb_width;
209 for (i = 0; i < slice_count; i++) {
210 SliceContext *slice = &ctx->slices[i];
212 slice->data = data_ptr;
213 data_ptr += AV_RB16(index_ptr + i*2);
215 while (ctx->mb_width - mb_x < slice_mb_count)
216 slice_mb_count >>= 1;
220 slice->mb_count = slice_mb_count;
221 slice->data_size = data_ptr - slice->data;
223 if (slice->data_size < 6) {
224 av_log(avctx, AV_LOG_ERROR, "error, wrong slice data size\n");
225 return AVERROR_INVALIDDATA;
228 mb_x += slice_mb_count;
229 if (mb_x == ctx->mb_width) {
230 slice_mb_count = 1 << log2_slice_mb_width;
234 if (data_ptr > buf + buf_size) {
235 av_log(avctx, AV_LOG_ERROR, "error, slice out of bounds\n");
236 return AVERROR_INVALIDDATA;
240 if (mb_x || mb_y != ctx->mb_height) {
241 av_log(avctx, AV_LOG_ERROR, "error wrong mb count y %d h %d\n",
242 mb_y, ctx->mb_height);
243 return AVERROR_INVALIDDATA;
246 return pic_data_size;
249 #define DECODE_CODEWORD(val, codebook) \
251 unsigned int rice_order, exp_order, switch_bits; \
252 unsigned int q, buf, bits; \
254 UPDATE_CACHE(re, gb); \
255 buf = GET_CACHE(re, gb); \
257 /* number of bits to switch between rice and exp golomb */ \
258 switch_bits = codebook & 3; \
259 rice_order = codebook >> 5; \
260 exp_order = (codebook >> 2) & 7; \
262 q = 31 - av_log2(buf); \
264 if (q > switch_bits) { /* exp golomb */ \
265 bits = exp_order - switch_bits + (q<<1); \
266 val = SHOW_UBITS(re, gb, bits) - (1 << exp_order) + \
267 ((switch_bits + 1) << rice_order); \
268 SKIP_BITS(re, gb, bits); \
269 } else if (rice_order) { \
270 SKIP_BITS(re, gb, q+1); \
271 val = (q << rice_order) + SHOW_UBITS(re, gb, rice_order); \
272 SKIP_BITS(re, gb, rice_order); \
275 SKIP_BITS(re, gb, q+1); \
279 #define TOSIGNED(x) (((x) >> 1) ^ (-((x) & 1)))
281 #define FIRST_DC_CB 0xB8
283 static const uint8_t dc_codebook[7] = { 0x04, 0x28, 0x28, 0x4D, 0x4D, 0x70, 0x70};
285 static av_always_inline void decode_dc_coeffs(GetBitContext *gb, int16_t *out,
286 int blocks_per_slice)
293 DECODE_CODEWORD(code, FIRST_DC_CB);
294 prev_dc = TOSIGNED(code);
297 out += 64; // dc coeff for the next block
301 for (i = 1; i < blocks_per_slice; i++, out += 64) {
302 DECODE_CODEWORD(code, dc_codebook[FFMIN(code, 6U)]);
303 if(code) sign ^= -(code & 1);
305 prev_dc += (((code + 1) >> 1) ^ sign) - sign;
308 CLOSE_READER(re, gb);
311 // adaptive codebook switching lut according to previous run/level values
312 static const uint8_t run_to_cb[16] = { 0x06, 0x06, 0x05, 0x05, 0x04, 0x29, 0x29, 0x29, 0x29, 0x28, 0x28, 0x28, 0x28, 0x28, 0x28, 0x4C };
313 static const uint8_t lev_to_cb[10] = { 0x04, 0x0A, 0x05, 0x06, 0x04, 0x28, 0x28, 0x28, 0x28, 0x4C };
315 static av_always_inline int decode_ac_coeffs(AVCodecContext *avctx, GetBitContext *gb,
316 int16_t *out, int blocks_per_slice)
318 ProresContext *ctx = avctx->priv_data;
319 int block_mask, sign;
320 unsigned pos, run, level;
321 int max_coeffs, i, bits_left;
322 int log2_block_count = av_log2(blocks_per_slice);
325 UPDATE_CACHE(re, gb); \
329 max_coeffs = 64 << log2_block_count;
330 block_mask = blocks_per_slice - 1;
332 for (pos = block_mask;;) {
333 bits_left = gb->size_in_bits - re_index;
334 if (!bits_left || (bits_left < 32 && !SHOW_UBITS(re, gb, bits_left)))
337 DECODE_CODEWORD(run, run_to_cb[FFMIN(run, 15)]);
339 if (pos >= max_coeffs) {
340 av_log(avctx, AV_LOG_ERROR, "ac tex damaged %d, %d\n", pos, max_coeffs);
341 return AVERROR_INVALIDDATA;
344 DECODE_CODEWORD(level, lev_to_cb[FFMIN(level, 9)]);
347 i = pos >> log2_block_count;
349 sign = SHOW_SBITS(re, gb, 1);
350 SKIP_BITS(re, gb, 1);
351 out[((pos & block_mask) << 6) + ctx->scan[i]] = ((level ^ sign) - sign);
354 CLOSE_READER(re, gb);
358 static int decode_slice_luma(AVCodecContext *avctx, SliceContext *slice,
359 uint16_t *dst, int dst_stride,
360 const uint8_t *buf, unsigned buf_size,
363 ProresContext *ctx = avctx->priv_data;
364 LOCAL_ALIGNED_16(int16_t, blocks, [8*4*64]);
367 int i, blocks_per_slice = slice->mb_count<<2;
370 for (i = 0; i < blocks_per_slice; i++)
371 ctx->bdsp.clear_block(blocks+(i<<6));
373 init_get_bits(&gb, buf, buf_size << 3);
375 decode_dc_coeffs(&gb, blocks, blocks_per_slice);
376 if ((ret = decode_ac_coeffs(avctx, &gb, blocks, blocks_per_slice)) < 0)
380 for (i = 0; i < slice->mb_count; i++) {
381 ctx->prodsp.idct_put(dst, dst_stride, block+(0<<6), qmat);
382 ctx->prodsp.idct_put(dst +8, dst_stride, block+(1<<6), qmat);
383 ctx->prodsp.idct_put(dst+4*dst_stride , dst_stride, block+(2<<6), qmat);
384 ctx->prodsp.idct_put(dst+4*dst_stride+8, dst_stride, block+(3<<6), qmat);
391 static int decode_slice_chroma(AVCodecContext *avctx, SliceContext *slice,
392 uint16_t *dst, int dst_stride,
393 const uint8_t *buf, unsigned buf_size,
394 const int16_t *qmat, int log2_blocks_per_mb)
396 ProresContext *ctx = avctx->priv_data;
397 LOCAL_ALIGNED_16(int16_t, blocks, [8*4*64]);
400 int i, j, blocks_per_slice = slice->mb_count << log2_blocks_per_mb;
403 for (i = 0; i < blocks_per_slice; i++)
404 ctx->bdsp.clear_block(blocks+(i<<6));
406 init_get_bits(&gb, buf, buf_size << 3);
408 decode_dc_coeffs(&gb, blocks, blocks_per_slice);
409 if ((ret = decode_ac_coeffs(avctx, &gb, blocks, blocks_per_slice)) < 0)
413 for (i = 0; i < slice->mb_count; i++) {
414 for (j = 0; j < log2_blocks_per_mb; j++) {
415 ctx->prodsp.idct_put(dst, dst_stride, block+(0<<6), qmat);
416 ctx->prodsp.idct_put(dst+4*dst_stride, dst_stride, block+(1<<6), qmat);
424 static void unpack_alpha(GetBitContext *gb, uint16_t *dst, int num_coeffs,
427 const int mask = (1 << num_bits) - 1;
428 int i, idx, val, alpha_val;
435 val = get_bits(gb, num_bits);
438 val = get_bits(gb, num_bits == 16 ? 7 : 4);
440 val = (val + 2) >> 1;
444 alpha_val = (alpha_val + val) & mask;
445 if (num_bits == 16) {
446 dst[idx++] = alpha_val >> 6;
448 dst[idx++] = (alpha_val << 2) | (alpha_val >> 6);
450 if (idx >= num_coeffs)
452 } while (get_bits_left(gb)>0 && get_bits1(gb));
453 val = get_bits(gb, 4);
455 val = get_bits(gb, 11);
456 if (idx + val > num_coeffs)
457 val = num_coeffs - idx;
458 if (num_bits == 16) {
459 for (i = 0; i < val; i++)
460 dst[idx++] = alpha_val >> 6;
462 for (i = 0; i < val; i++)
463 dst[idx++] = (alpha_val << 2) | (alpha_val >> 6);
466 } while (idx < num_coeffs);
470 * Decode alpha slice plane.
472 static void decode_slice_alpha(ProresContext *ctx,
473 uint16_t *dst, int dst_stride,
474 const uint8_t *buf, int buf_size,
475 int blocks_per_slice)
479 LOCAL_ALIGNED_16(int16_t, blocks, [8*4*64]);
482 for (i = 0; i < blocks_per_slice<<2; i++)
483 ctx->bdsp.clear_block(blocks+(i<<6));
485 init_get_bits(&gb, buf, buf_size << 3);
487 if (ctx->alpha_info == 2) {
488 unpack_alpha(&gb, blocks, blocks_per_slice * 4 * 64, 16);
490 unpack_alpha(&gb, blocks, blocks_per_slice * 4 * 64, 8);
494 for (i = 0; i < 16; i++) {
495 memcpy(dst, block, 16 * blocks_per_slice * sizeof(*dst));
496 dst += dst_stride >> 1;
497 block += 16 * blocks_per_slice;
501 static int decode_slice_thread(AVCodecContext *avctx, void *arg, int jobnr, int threadnr)
503 ProresContext *ctx = avctx->priv_data;
504 SliceContext *slice = &ctx->slices[jobnr];
505 const uint8_t *buf = slice->data;
506 AVFrame *pic = ctx->frame;
507 int i, hdr_size, qscale, log2_chroma_blocks_per_mb;
508 int luma_stride, chroma_stride;
509 int y_data_size, u_data_size, v_data_size, a_data_size;
510 uint8_t *dest_y, *dest_u, *dest_v, *dest_a;
511 int16_t qmat_luma_scaled[64];
512 int16_t qmat_chroma_scaled[64];
517 //av_log(avctx, AV_LOG_INFO, "slice %d mb width %d mb x %d y %d\n",
518 // jobnr, slice->mb_count, slice->mb_x, slice->mb_y);
521 hdr_size = buf[0] >> 3;
522 qscale = av_clip(buf[1], 1, 224);
523 qscale = qscale > 128 ? qscale - 96 << 2: qscale;
524 y_data_size = AV_RB16(buf + 2);
525 u_data_size = AV_RB16(buf + 4);
526 v_data_size = slice->data_size - y_data_size - u_data_size - hdr_size;
527 if (hdr_size > 7) v_data_size = AV_RB16(buf + 6);
528 a_data_size = slice->data_size - y_data_size - u_data_size -
529 v_data_size - hdr_size;
531 if (y_data_size < 0 || u_data_size < 0 || v_data_size < 0
532 || hdr_size+y_data_size+u_data_size+v_data_size > slice->data_size){
533 av_log(avctx, AV_LOG_ERROR, "invalid plane data size\n");
534 return AVERROR_INVALIDDATA;
539 for (i = 0; i < 64; i++) {
540 qmat_luma_scaled [i] = ctx->qmat_luma [i] * qscale;
541 qmat_chroma_scaled[i] = ctx->qmat_chroma[i] * qscale;
544 if (ctx->frame_type == 0) {
545 luma_stride = pic->linesize[0];
546 chroma_stride = pic->linesize[1];
548 luma_stride = pic->linesize[0] << 1;
549 chroma_stride = pic->linesize[1] << 1;
552 if (avctx->pix_fmt == AV_PIX_FMT_YUV444P10 || avctx->pix_fmt == AV_PIX_FMT_YUVA444P10) {
554 log2_chroma_blocks_per_mb = 2;
557 log2_chroma_blocks_per_mb = 1;
560 dest_y = pic->data[0] + (slice->mb_y << 4) * luma_stride + (slice->mb_x << 5);
561 dest_u = pic->data[1] + (slice->mb_y << 4) * chroma_stride + (slice->mb_x << mb_x_shift);
562 dest_v = pic->data[2] + (slice->mb_y << 4) * chroma_stride + (slice->mb_x << mb_x_shift);
563 dest_a = pic->data[3] + (slice->mb_y << 4) * luma_stride + (slice->mb_x << 5);
565 if (ctx->frame_type && ctx->first_field ^ ctx->frame->top_field_first) {
566 dest_y += pic->linesize[0];
567 dest_u += pic->linesize[1];
568 dest_v += pic->linesize[2];
569 dest_a += pic->linesize[3];
572 ret = decode_slice_luma(avctx, slice, (uint16_t*)dest_y, luma_stride,
573 buf, y_data_size, qmat_luma_scaled);
577 if (!(avctx->flags & CODEC_FLAG_GRAY)) {
578 ret = decode_slice_chroma(avctx, slice, (uint16_t*)dest_u, chroma_stride,
579 buf + y_data_size, u_data_size,
580 qmat_chroma_scaled, log2_chroma_blocks_per_mb);
584 ret = decode_slice_chroma(avctx, slice, (uint16_t*)dest_v, chroma_stride,
585 buf + y_data_size + u_data_size, v_data_size,
586 qmat_chroma_scaled, log2_chroma_blocks_per_mb);
590 /* decode alpha plane if available */
591 if (ctx->alpha_info && pic->data[3] && a_data_size)
592 decode_slice_alpha(ctx, (uint16_t*)dest_a, luma_stride,
593 buf + y_data_size + u_data_size + v_data_size,
594 a_data_size, slice->mb_count);
600 static int decode_picture(AVCodecContext *avctx)
602 ProresContext *ctx = avctx->priv_data;
605 avctx->execute2(avctx, decode_slice_thread, NULL, NULL, ctx->slice_count);
607 for (i = 0; i < ctx->slice_count; i++)
608 if (ctx->slices[i].ret < 0)
609 return ctx->slices[i].ret;
614 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
617 ProresContext *ctx = avctx->priv_data;
618 AVFrame *frame = data;
619 const uint8_t *buf = avpkt->data;
620 int buf_size = avpkt->size;
621 int frame_hdr_size, pic_size, ret;
623 if (buf_size < 28 || AV_RL32(buf + 4) != AV_RL32("icpf")) {
624 av_log(avctx, AV_LOG_ERROR, "invalid frame header\n");
625 return AVERROR_INVALIDDATA;
629 ctx->frame->pict_type = AV_PICTURE_TYPE_I;
630 ctx->frame->key_frame = 1;
631 ctx->first_field = 1;
636 frame_hdr_size = decode_frame_header(ctx, buf, buf_size, avctx);
637 if (frame_hdr_size < 0)
638 return frame_hdr_size;
640 buf += frame_hdr_size;
641 buf_size -= frame_hdr_size;
643 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
647 pic_size = decode_picture_header(avctx, buf, buf_size);
649 av_log(avctx, AV_LOG_ERROR, "error decoding picture header\n");
653 if ((ret = decode_picture(avctx)) < 0) {
654 av_log(avctx, AV_LOG_ERROR, "error decoding picture\n");
659 buf_size -= pic_size;
661 if (ctx->frame_type && buf_size > 0 && ctx->first_field) {
662 ctx->first_field = 0;
671 static av_cold int decode_close(AVCodecContext *avctx)
673 ProresContext *ctx = avctx->priv_data;
675 av_freep(&ctx->slices);
680 AVCodec ff_prores_decoder = {
682 .long_name = NULL_IF_CONFIG_SMALL("ProRes"),
683 .type = AVMEDIA_TYPE_VIDEO,
684 .id = AV_CODEC_ID_PRORES,
685 .priv_data_size = sizeof(ProresContext),
687 .close = decode_close,
688 .decode = decode_frame,
689 .capabilities = CODEC_CAP_DR1 | CODEC_CAP_SLICE_THREADS,