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
34 #include "simple_idct.h"
35 #include "proresdec.h"
36 #include "proresdata.h"
38 static void permute(uint8_t *dst, const uint8_t *src, const uint8_t permutation[64])
41 for (i = 0; i < 64; i++)
42 dst[i] = permutation[src[i]];
45 static av_cold int decode_init(AVCodecContext *avctx)
47 ProresContext *ctx = avctx->priv_data;
48 uint8_t idct_permutation[64];
50 avctx->bits_per_raw_sample = 10;
52 ff_dsputil_init(&ctx->dsp, avctx);
53 ff_proresdsp_init(&ctx->prodsp, avctx);
55 ff_init_scantable_permutation(idct_permutation,
56 ctx->prodsp.idct_permutation_type);
58 permute(ctx->progressive_scan, ff_prores_progressive_scan, idct_permutation);
59 permute(ctx->interlaced_scan, ff_prores_interlaced_scan, idct_permutation);
64 static int decode_frame_header(ProresContext *ctx, const uint8_t *buf,
65 const int data_size, AVCodecContext *avctx)
67 int hdr_size, width, height, flags;
71 hdr_size = AV_RB16(buf);
72 av_dlog(avctx, "header size %d\n", hdr_size);
73 if (hdr_size > data_size) {
74 av_log(avctx, AV_LOG_ERROR, "error, wrong header size\n");
75 return AVERROR_INVALIDDATA;
78 version = AV_RB16(buf + 2);
79 av_dlog(avctx, "%.4s version %d\n", buf+4, version);
81 av_log(avctx, AV_LOG_ERROR, "unsupported version: %d\n", version);
82 return AVERROR_PATCHWELCOME;
85 width = AV_RB16(buf + 8);
86 height = AV_RB16(buf + 10);
87 if (width != avctx->width || height != avctx->height) {
88 av_log(avctx, AV_LOG_ERROR, "picture resolution change: %dx%d -> %dx%d\n",
89 avctx->width, avctx->height, width, height);
90 return AVERROR_PATCHWELCOME;
93 ctx->frame_type = (buf[12] >> 2) & 3;
94 ctx->alpha_info = buf[17] & 0xf;
96 if (ctx->alpha_info > 2) {
97 av_log(avctx, AV_LOG_ERROR, "Invalid alpha mode %d\n", ctx->alpha_info);
98 return AVERROR_INVALIDDATA;
101 av_dlog(avctx, "frame type %d\n", ctx->frame_type);
103 if (ctx->frame_type == 0) {
104 ctx->scan = ctx->progressive_scan; // permuted
106 ctx->scan = ctx->interlaced_scan; // permuted
107 ctx->frame->interlaced_frame = 1;
108 ctx->frame->top_field_first = ctx->frame_type == 1;
111 if (ctx->alpha_info) {
112 avctx->pix_fmt = (buf[12] & 0xC0) == 0xC0 ? AV_PIX_FMT_YUVA444P10 : AV_PIX_FMT_YUVA422P10;
114 avctx->pix_fmt = (buf[12] & 0xC0) == 0xC0 ? AV_PIX_FMT_YUV444P10 : AV_PIX_FMT_YUV422P10;
119 av_dlog(avctx, "flags %x\n", flags);
122 if(buf + data_size - ptr < 64) {
123 av_log(avctx, AV_LOG_ERROR, "Header truncated\n");
124 return AVERROR_INVALIDDATA;
126 permute(ctx->qmat_luma, ctx->prodsp.idct_permutation, ptr);
129 memset(ctx->qmat_luma, 4, 64);
133 if(buf + data_size - ptr < 64) {
134 av_log(avctx, AV_LOG_ERROR, "Header truncated\n");
135 return AVERROR_INVALIDDATA;
137 permute(ctx->qmat_chroma, ctx->prodsp.idct_permutation, ptr);
139 memset(ctx->qmat_chroma, 4, 64);
145 static int decode_picture_header(AVCodecContext *avctx, const uint8_t *buf, const int buf_size)
147 ProresContext *ctx = avctx->priv_data;
148 int i, hdr_size, slice_count;
149 unsigned pic_data_size;
150 int log2_slice_mb_width, log2_slice_mb_height;
151 int slice_mb_count, mb_x, mb_y;
152 const uint8_t *data_ptr, *index_ptr;
154 hdr_size = buf[0] >> 3;
155 if (hdr_size < 8 || hdr_size > buf_size) {
156 av_log(avctx, AV_LOG_ERROR, "error, wrong picture header size\n");
157 return AVERROR_INVALIDDATA;
160 pic_data_size = AV_RB32(buf + 1);
161 if (pic_data_size > buf_size) {
162 av_log(avctx, AV_LOG_ERROR, "error, wrong picture data size\n");
163 return AVERROR_INVALIDDATA;
166 log2_slice_mb_width = buf[7] >> 4;
167 log2_slice_mb_height = buf[7] & 0xF;
168 if (log2_slice_mb_width > 3 || log2_slice_mb_height) {
169 av_log(avctx, AV_LOG_ERROR, "unsupported slice resolution: %dx%d\n",
170 1 << log2_slice_mb_width, 1 << log2_slice_mb_height);
171 return AVERROR_INVALIDDATA;
174 ctx->mb_width = (avctx->width + 15) >> 4;
176 ctx->mb_height = (avctx->height + 31) >> 5;
178 ctx->mb_height = (avctx->height + 15) >> 4;
180 slice_count = AV_RB16(buf + 5);
182 if (ctx->slice_count != slice_count || !ctx->slices) {
183 av_freep(&ctx->slices);
184 ctx->slices = av_mallocz(slice_count * sizeof(*ctx->slices));
186 return AVERROR(ENOMEM);
187 ctx->slice_count = slice_count;
191 return AVERROR(EINVAL);
193 if (hdr_size + slice_count*2 > buf_size) {
194 av_log(avctx, AV_LOG_ERROR, "error, wrong slice count\n");
195 return AVERROR_INVALIDDATA;
198 // parse slice information
199 index_ptr = buf + hdr_size;
200 data_ptr = index_ptr + slice_count*2;
202 slice_mb_count = 1 << log2_slice_mb_width;
206 for (i = 0; i < slice_count; i++) {
207 SliceContext *slice = &ctx->slices[i];
209 slice->data = data_ptr;
210 data_ptr += AV_RB16(index_ptr + i*2);
212 while (ctx->mb_width - mb_x < slice_mb_count)
213 slice_mb_count >>= 1;
217 slice->mb_count = slice_mb_count;
218 slice->data_size = data_ptr - slice->data;
220 if (slice->data_size < 6) {
221 av_log(avctx, AV_LOG_ERROR, "error, wrong slice data size\n");
222 return AVERROR_INVALIDDATA;
225 mb_x += slice_mb_count;
226 if (mb_x == ctx->mb_width) {
227 slice_mb_count = 1 << log2_slice_mb_width;
231 if (data_ptr > buf + buf_size) {
232 av_log(avctx, AV_LOG_ERROR, "error, slice out of bounds\n");
233 return AVERROR_INVALIDDATA;
237 if (mb_x || mb_y != ctx->mb_height) {
238 av_log(avctx, AV_LOG_ERROR, "error wrong mb count y %d h %d\n",
239 mb_y, ctx->mb_height);
240 return AVERROR_INVALIDDATA;
243 return pic_data_size;
246 #define DECODE_CODEWORD(val, codebook) \
248 unsigned int rice_order, exp_order, switch_bits; \
249 unsigned int q, buf, bits; \
251 UPDATE_CACHE(re, gb); \
252 buf = GET_CACHE(re, gb); \
254 /* number of bits to switch between rice and exp golomb */ \
255 switch_bits = codebook & 3; \
256 rice_order = codebook >> 5; \
257 exp_order = (codebook >> 2) & 7; \
259 q = 31 - av_log2(buf); \
261 if (q > switch_bits) { /* exp golomb */ \
262 bits = exp_order - switch_bits + (q<<1); \
263 val = SHOW_UBITS(re, gb, bits) - (1 << exp_order) + \
264 ((switch_bits + 1) << rice_order); \
265 SKIP_BITS(re, gb, bits); \
266 } else if (rice_order) { \
267 SKIP_BITS(re, gb, q+1); \
268 val = (q << rice_order) + SHOW_UBITS(re, gb, rice_order); \
269 SKIP_BITS(re, gb, rice_order); \
272 SKIP_BITS(re, gb, q+1); \
276 #define TOSIGNED(x) (((x) >> 1) ^ (-((x) & 1)))
278 #define FIRST_DC_CB 0xB8
280 static const uint8_t dc_codebook[7] = { 0x04, 0x28, 0x28, 0x4D, 0x4D, 0x70, 0x70};
282 static av_always_inline void decode_dc_coeffs(GetBitContext *gb, int16_t *out,
283 int blocks_per_slice)
290 DECODE_CODEWORD(code, FIRST_DC_CB);
291 prev_dc = TOSIGNED(code);
294 out += 64; // dc coeff for the next block
298 for (i = 1; i < blocks_per_slice; i++, out += 64) {
299 DECODE_CODEWORD(code, dc_codebook[FFMIN(code, 6U)]);
300 if(code) sign ^= -(code & 1);
302 prev_dc += (((code + 1) >> 1) ^ sign) - sign;
305 CLOSE_READER(re, gb);
308 // adaptive codebook switching lut according to previous run/level values
309 static const uint8_t run_to_cb[16] = { 0x06, 0x06, 0x05, 0x05, 0x04, 0x29, 0x29, 0x29, 0x29, 0x28, 0x28, 0x28, 0x28, 0x28, 0x28, 0x4C };
310 static const uint8_t lev_to_cb[10] = { 0x04, 0x0A, 0x05, 0x06, 0x04, 0x28, 0x28, 0x28, 0x28, 0x4C };
312 static av_always_inline void decode_ac_coeffs(AVCodecContext *avctx, GetBitContext *gb,
313 int16_t *out, int blocks_per_slice)
315 ProresContext *ctx = avctx->priv_data;
316 int block_mask, sign;
317 unsigned pos, run, level;
318 int max_coeffs, i, bits_left;
319 int log2_block_count = av_log2(blocks_per_slice);
322 UPDATE_CACHE(re, gb); \
326 max_coeffs = 64 << log2_block_count;
327 block_mask = blocks_per_slice - 1;
329 for (pos = block_mask;;) {
330 bits_left = gb->size_in_bits - re_index;
331 if (!bits_left || (bits_left < 32 && !SHOW_UBITS(re, gb, bits_left)))
334 DECODE_CODEWORD(run, run_to_cb[FFMIN(run, 15)]);
336 if (pos >= max_coeffs) {
337 av_log(avctx, AV_LOG_ERROR, "ac tex damaged %d, %d\n", pos, max_coeffs);
341 DECODE_CODEWORD(level, lev_to_cb[FFMIN(level, 9)]);
344 i = pos >> log2_block_count;
346 sign = SHOW_SBITS(re, gb, 1);
347 SKIP_BITS(re, gb, 1);
348 out[((pos & block_mask) << 6) + ctx->scan[i]] = ((level ^ sign) - sign);
351 CLOSE_READER(re, gb);
354 static void decode_slice_luma(AVCodecContext *avctx, SliceContext *slice,
355 uint16_t *dst, int dst_stride,
356 const uint8_t *buf, unsigned buf_size,
359 ProresContext *ctx = avctx->priv_data;
360 LOCAL_ALIGNED_16(int16_t, blocks, [8*4*64]);
363 int i, blocks_per_slice = slice->mb_count<<2;
365 for (i = 0; i < blocks_per_slice; i++)
366 ctx->dsp.clear_block(blocks+(i<<6));
368 init_get_bits(&gb, buf, buf_size << 3);
370 decode_dc_coeffs(&gb, blocks, blocks_per_slice);
371 decode_ac_coeffs(avctx, &gb, blocks, blocks_per_slice);
374 for (i = 0; i < slice->mb_count; i++) {
375 ctx->prodsp.idct_put(dst, dst_stride, block+(0<<6), qmat);
376 ctx->prodsp.idct_put(dst +8, dst_stride, block+(1<<6), qmat);
377 ctx->prodsp.idct_put(dst+4*dst_stride , dst_stride, block+(2<<6), qmat);
378 ctx->prodsp.idct_put(dst+4*dst_stride+8, dst_stride, block+(3<<6), qmat);
384 static void decode_slice_chroma(AVCodecContext *avctx, SliceContext *slice,
385 uint16_t *dst, int dst_stride,
386 const uint8_t *buf, unsigned buf_size,
387 const int16_t *qmat, int log2_blocks_per_mb)
389 ProresContext *ctx = avctx->priv_data;
390 LOCAL_ALIGNED_16(int16_t, blocks, [8*4*64]);
393 int i, j, blocks_per_slice = slice->mb_count << log2_blocks_per_mb;
395 for (i = 0; i < blocks_per_slice; i++)
396 ctx->dsp.clear_block(blocks+(i<<6));
398 init_get_bits(&gb, buf, buf_size << 3);
400 decode_dc_coeffs(&gb, blocks, blocks_per_slice);
401 decode_ac_coeffs(avctx, &gb, blocks, blocks_per_slice);
404 for (i = 0; i < slice->mb_count; i++) {
405 for (j = 0; j < log2_blocks_per_mb; j++) {
406 ctx->prodsp.idct_put(dst, dst_stride, block+(0<<6), qmat);
407 ctx->prodsp.idct_put(dst+4*dst_stride, dst_stride, block+(1<<6), qmat);
414 static void unpack_alpha(GetBitContext *gb, uint16_t *dst, int num_coeffs,
417 const int mask = (1 << num_bits) - 1;
418 int i, idx, val, alpha_val;
425 val = get_bits(gb, num_bits);
428 val = get_bits(gb, num_bits == 16 ? 7 : 4);
430 val = (val + 2) >> 1;
434 alpha_val = (alpha_val + val) & mask;
435 if (num_bits == 16) {
436 dst[idx++] = alpha_val >> 6;
438 dst[idx++] = (alpha_val << 2) | (alpha_val >> 6);
440 if (idx >= num_coeffs)
442 } while (get_bits_left(gb)>0 && get_bits1(gb));
443 val = get_bits(gb, 4);
445 val = get_bits(gb, 11);
446 if (idx + val > num_coeffs)
447 val = num_coeffs - idx;
448 if (num_bits == 16) {
449 for (i = 0; i < val; i++)
450 dst[idx++] = alpha_val >> 6;
452 for (i = 0; i < val; i++)
453 dst[idx++] = (alpha_val << 2) | (alpha_val >> 6);
456 } while (idx < num_coeffs);
460 * Decode alpha slice plane.
462 static void decode_slice_alpha(ProresContext *ctx,
463 uint16_t *dst, int dst_stride,
464 const uint8_t *buf, int buf_size,
465 int blocks_per_slice)
469 LOCAL_ALIGNED_16(int16_t, blocks, [8*4*64]);
472 for (i = 0; i < blocks_per_slice<<2; i++)
473 ctx->dsp.clear_block(blocks+(i<<6));
475 init_get_bits(&gb, buf, buf_size << 3);
477 if (ctx->alpha_info == 2) {
478 unpack_alpha(&gb, blocks, blocks_per_slice * 4 * 64, 16);
480 unpack_alpha(&gb, blocks, blocks_per_slice * 4 * 64, 8);
484 for (i = 0; i < 16; i++) {
485 memcpy(dst, block, 16 * blocks_per_slice * sizeof(*dst));
486 dst += dst_stride >> 1;
487 block += 16 * blocks_per_slice;
491 static int decode_slice_thread(AVCodecContext *avctx, void *arg, int jobnr, int threadnr)
493 ProresContext *ctx = avctx->priv_data;
494 SliceContext *slice = &ctx->slices[jobnr];
495 const uint8_t *buf = slice->data;
496 AVFrame *pic = ctx->frame;
497 int i, hdr_size, qscale, log2_chroma_blocks_per_mb;
498 int luma_stride, chroma_stride;
499 int y_data_size, u_data_size, v_data_size, a_data_size;
500 uint8_t *dest_y, *dest_u, *dest_v, *dest_a;
501 int16_t qmat_luma_scaled[64];
502 int16_t qmat_chroma_scaled[64];
506 //av_log(avctx, AV_LOG_INFO, "slice %d mb width %d mb x %d y %d\n",
507 // jobnr, slice->mb_count, slice->mb_x, slice->mb_y);
510 hdr_size = buf[0] >> 3;
511 qscale = av_clip(buf[1], 1, 224);
512 qscale = qscale > 128 ? qscale - 96 << 2: qscale;
513 y_data_size = AV_RB16(buf + 2);
514 u_data_size = AV_RB16(buf + 4);
515 v_data_size = slice->data_size - y_data_size - u_data_size - hdr_size;
516 if (hdr_size > 7) v_data_size = AV_RB16(buf + 6);
517 a_data_size = slice->data_size - y_data_size - u_data_size -
518 v_data_size - hdr_size;
520 if (y_data_size < 0 || u_data_size < 0 || v_data_size < 0
521 || hdr_size+y_data_size+u_data_size+v_data_size > slice->data_size){
522 av_log(avctx, AV_LOG_ERROR, "invalid plane data size\n");
523 return AVERROR_INVALIDDATA;
528 for (i = 0; i < 64; i++) {
529 qmat_luma_scaled [i] = ctx->qmat_luma [i] * qscale;
530 qmat_chroma_scaled[i] = ctx->qmat_chroma[i] * qscale;
533 if (ctx->frame_type == 0) {
534 luma_stride = pic->linesize[0];
535 chroma_stride = pic->linesize[1];
537 luma_stride = pic->linesize[0] << 1;
538 chroma_stride = pic->linesize[1] << 1;
541 if (avctx->pix_fmt == AV_PIX_FMT_YUV444P10 || avctx->pix_fmt == AV_PIX_FMT_YUVA444P10) {
543 log2_chroma_blocks_per_mb = 2;
546 log2_chroma_blocks_per_mb = 1;
549 dest_y = pic->data[0] + (slice->mb_y << 4) * luma_stride + (slice->mb_x << 5);
550 dest_u = pic->data[1] + (slice->mb_y << 4) * chroma_stride + (slice->mb_x << mb_x_shift);
551 dest_v = pic->data[2] + (slice->mb_y << 4) * chroma_stride + (slice->mb_x << mb_x_shift);
552 dest_a = pic->data[3] + (slice->mb_y << 4) * luma_stride + (slice->mb_x << 5);
554 if (ctx->frame_type && ctx->first_field ^ ctx->frame->top_field_first) {
555 dest_y += pic->linesize[0];
556 dest_u += pic->linesize[1];
557 dest_v += pic->linesize[2];
558 dest_a += pic->linesize[3];
561 decode_slice_luma(avctx, slice, (uint16_t*)dest_y, luma_stride,
562 buf, y_data_size, qmat_luma_scaled);
564 if (!(avctx->flags & CODEC_FLAG_GRAY)) {
565 decode_slice_chroma(avctx, slice, (uint16_t*)dest_u, chroma_stride,
566 buf + y_data_size, u_data_size,
567 qmat_chroma_scaled, log2_chroma_blocks_per_mb);
568 decode_slice_chroma(avctx, slice, (uint16_t*)dest_v, chroma_stride,
569 buf + y_data_size + u_data_size, v_data_size,
570 qmat_chroma_scaled, log2_chroma_blocks_per_mb);
572 /* decode alpha plane if available */
573 if (ctx->alpha_info && pic->data[3] && a_data_size)
574 decode_slice_alpha(ctx, (uint16_t*)dest_a, luma_stride,
575 buf + y_data_size + u_data_size + v_data_size,
576 a_data_size, slice->mb_count);
582 static int decode_picture(AVCodecContext *avctx)
584 ProresContext *ctx = avctx->priv_data;
587 avctx->execute2(avctx, decode_slice_thread, NULL, NULL, ctx->slice_count);
589 for (i = 0; i < ctx->slice_count; i++)
590 if (ctx->slices[i].ret < 0)
591 return ctx->slices[i].ret;
596 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
599 ProresContext *ctx = avctx->priv_data;
600 AVFrame *frame = data;
601 const uint8_t *buf = avpkt->data;
602 int buf_size = avpkt->size;
603 int frame_hdr_size, pic_size, ret;
605 if (buf_size < 28 || AV_RL32(buf + 4) != AV_RL32("icpf")) {
606 av_log(avctx, AV_LOG_ERROR, "invalid frame header\n");
607 return AVERROR_INVALIDDATA;
611 ctx->frame->pict_type = AV_PICTURE_TYPE_I;
612 ctx->frame->key_frame = 1;
613 ctx->first_field = 1;
618 frame_hdr_size = decode_frame_header(ctx, buf, buf_size, avctx);
619 if (frame_hdr_size < 0)
620 return frame_hdr_size;
622 buf += frame_hdr_size;
623 buf_size -= frame_hdr_size;
625 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
629 pic_size = decode_picture_header(avctx, buf, buf_size);
631 av_log(avctx, AV_LOG_ERROR, "error decoding picture header\n");
635 if ((ret = decode_picture(avctx)) < 0) {
636 av_log(avctx, AV_LOG_ERROR, "error decoding picture\n");
641 buf_size -= pic_size;
643 if (ctx->frame_type && buf_size > 0 && ctx->first_field) {
644 ctx->first_field = 0;
653 static av_cold int decode_close(AVCodecContext *avctx)
655 ProresContext *ctx = avctx->priv_data;
657 av_freep(&ctx->slices);
662 AVCodec ff_prores_decoder = {
664 .type = AVMEDIA_TYPE_VIDEO,
665 .id = AV_CODEC_ID_PRORES,
666 .priv_data_size = sizeof(ProresContext),
668 .close = decode_close,
669 .decode = decode_frame,
670 .long_name = NULL_IF_CONFIG_SMALL("ProRes"),
671 .capabilities = CODEC_CAP_DR1 | CODEC_CAP_SLICE_THREADS,