4 * Copyright (c) 2014 Konstantin Shishkov
5 * Copyright (c) 2014 Derek Buitenhuis
7 * This file is part of FFmpeg.
9 * FFmpeg is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
14 * FFmpeg is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with FFmpeg; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 #include "libavutil/common.h"
25 #include "libavutil/opt.h"
31 typedef struct FICThreadContext {
32 DECLARE_ALIGNED(16, int16_t, block)[64];
40 typedef struct FICContext {
42 AVCodecContext *avctx;
46 FICThreadContext *slice_data;
51 enum AVPictureType cur_frame_type;
53 int aligned_width, aligned_height;
54 int num_slices, slice_h;
56 uint8_t cursor_buf[4096];
60 static const uint8_t fic_qmat_hq[64] = {
61 1, 2, 2, 2, 3, 3, 3, 4,
62 2, 2, 2, 3, 3, 3, 4, 4,
63 2, 2, 3, 3, 3, 4, 4, 4,
64 2, 2, 3, 3, 3, 4, 4, 5,
65 2, 3, 3, 3, 4, 4, 5, 6,
66 3, 3, 3, 4, 4, 5, 6, 7,
67 3, 3, 3, 4, 4, 5, 7, 7,
68 3, 3, 4, 4, 5, 7, 7, 7,
71 static const uint8_t fic_qmat_lq[64] = {
72 1, 5, 6, 7, 8, 9, 9, 11,
73 5, 5, 7, 8, 9, 9, 11, 12,
74 6, 7, 8, 9, 9, 11, 11, 12,
75 7, 7, 8, 9, 9, 11, 12, 13,
76 7, 8, 9, 9, 10, 11, 13, 16,
77 8, 9, 9, 10, 11, 13, 16, 19,
78 8, 9, 9, 11, 12, 15, 18, 23,
79 9, 9, 11, 12, 15, 18, 23, 27
82 static const uint8_t fic_header[7] = { 0, 0, 1, 'F', 'I', 'C', 'V' };
84 #define FIC_HEADER_SIZE 27
85 #define CURSOR_OFFSET 59
87 static av_always_inline void fic_idct(int16_t *blk, int step, int shift, int rnd)
89 const unsigned t0 = 27246 * blk[3 * step] + 18405 * blk[5 * step];
90 const unsigned t1 = 27246 * blk[5 * step] - 18405 * blk[3 * step];
91 const unsigned t2 = 6393 * blk[7 * step] + 32139 * blk[1 * step];
92 const unsigned t3 = 6393 * blk[1 * step] - 32139 * blk[7 * step];
93 const unsigned t4 = 5793U * ((int)(t2 + t0 + 0x800) >> 12);
94 const unsigned t5 = 5793U * ((int)(t3 + t1 + 0x800) >> 12);
95 const unsigned t6 = t2 - t0;
96 const unsigned t7 = t3 - t1;
97 const unsigned t8 = 17734 * blk[2 * step] - 42813 * blk[6 * step];
98 const unsigned t9 = 17734 * blk[6 * step] + 42814 * blk[2 * step];
99 const unsigned tA = (blk[0 * step] - blk[4 * step]) * 32768 + rnd;
100 const unsigned tB = (blk[0 * step] + blk[4 * step]) * 32768 + rnd;
101 blk[0 * step] = (int)( t4 + t9 + tB) >> shift;
102 blk[1 * step] = (int)( t6 + t7 + t8 + tA) >> shift;
103 blk[2 * step] = (int)( t6 - t7 - t8 + tA) >> shift;
104 blk[3 * step] = (int)( t5 - t9 + tB) >> shift;
105 blk[4 * step] = (int)( -t5 - t9 + tB) >> shift;
106 blk[5 * step] = (int)(-(t6 - t7) - t8 + tA) >> shift;
107 blk[6 * step] = (int)(-(t6 + t7) + t8 + tA) >> shift;
108 blk[7 * step] = (int)( -t4 + t9 + tB) >> shift;
111 static void fic_idct_put(uint8_t *dst, int stride, int16_t *block)
117 fic_idct(ptr++, 8, 13, (1 << 12) + (1 << 17));
118 for (i = 1; i < 8; i++) {
119 fic_idct(ptr, 8, 13, 1 << 12);
124 for (i = 0; i < 8; i++) {
125 fic_idct(ptr, 1, 20, 0);
130 for (j = 0; j < 8; j++) {
131 for (i = 0; i < 8; i++)
132 dst[i] = av_clip_uint8(ptr[i]);
137 static int fic_decode_block(FICContext *ctx, GetBitContext *gb,
138 uint8_t *dst, int stride, int16_t *block, int *is_p)
142 if (get_bits_left(gb) < 8)
143 return AVERROR_INVALIDDATA;
145 /* Is it a skip block? */
151 memset(block, 0, sizeof(*block) * 64);
153 num_coeff = get_bits(gb, 7);
155 return AVERROR_INVALIDDATA;
157 for (i = 0; i < num_coeff; i++) {
158 int v = get_se_golomb(gb);
159 if (v < -2048 || v > 2048)
160 return AVERROR_INVALIDDATA;
161 block[ff_zigzag_direct[i]] = v *
162 ctx->qmat[ff_zigzag_direct[i]];
165 fic_idct_put(dst, stride, block);
170 static int fic_decode_slice(AVCodecContext *avctx, void *tdata)
172 FICContext *ctx = avctx->priv_data;
173 FICThreadContext *tctx = tdata;
175 uint8_t *src = tctx->src;
176 int slice_h = tctx->slice_h;
177 int src_size = tctx->src_size;
178 int y_off = tctx->y_off;
181 ret = init_get_bits8(&gb, src, src_size);
185 for (p = 0; p < 3; p++) {
186 int stride = ctx->frame->linesize[p];
187 uint8_t* dst = ctx->frame->data[p] + (y_off >> !!p) * stride;
189 for (y = 0; y < (slice_h >> !!p); y += 8) {
190 for (x = 0; x < (ctx->aligned_width >> !!p); x += 8) {
193 if ((ret = fic_decode_block(ctx, &gb, dst + x, stride,
194 tctx->block, &tctx->p_frame)) != 0)
205 static av_always_inline void fic_alpha_blend(uint8_t *dst, uint8_t *src,
206 int size, uint8_t *alpha)
210 for (i = 0; i < size; i++)
211 dst[i] += ((src[i] - dst[i]) * alpha[i]) >> 8;
214 static void fic_draw_cursor(AVCodecContext *avctx, int cur_x, int cur_y)
216 FICContext *ctx = avctx->priv_data;
217 uint8_t *ptr = ctx->cursor_buf;
219 uint8_t planes[4][1024];
220 uint8_t chroma[3][256];
223 /* Convert to YUVA444. */
224 for (i = 0; i < 1024; i++) {
225 planes[0][i] = (( 25 * ptr[0] + 129 * ptr[1] + 66 * ptr[2]) / 255) + 16;
226 planes[1][i] = ((-38 * ptr[0] + 112 * ptr[1] + -74 * ptr[2]) / 255) + 128;
227 planes[2][i] = ((-18 * ptr[0] + 112 * ptr[1] + -94 * ptr[2]) / 255) + 128;
228 planes[3][i] = ptr[3];
233 /* Subsample chroma. */
234 for (i = 0; i < 32; i += 2)
235 for (j = 0; j < 32; j += 2)
236 for (p = 0; p < 3; p++)
237 chroma[p][16 * (i / 2) + j / 2] = (planes[p + 1][32 * i + j ] +
238 planes[p + 1][32 * i + j + 1] +
239 planes[p + 1][32 * (i + 1) + j ] +
240 planes[p + 1][32 * (i + 1) + j + 1]) / 4;
242 /* Seek to x/y pos of cursor. */
243 for (i = 0; i < 3; i++)
244 dstptr[i] = ctx->final_frame->data[i] +
245 (ctx->final_frame->linesize[i] * (cur_y >> !!i)) +
246 (cur_x >> !!i) + !!i;
249 for (i = 0; i < FFMIN(32, avctx->height - cur_y) - 1; i += 2) {
250 int lsize = FFMIN(32, avctx->width - cur_x);
251 int csize = lsize / 2;
253 fic_alpha_blend(dstptr[0],
254 planes[0] + i * 32, lsize, planes[3] + i * 32);
255 fic_alpha_blend(dstptr[0] + ctx->final_frame->linesize[0],
256 planes[0] + (i + 1) * 32, lsize, planes[3] + (i + 1) * 32);
257 fic_alpha_blend(dstptr[1],
258 chroma[0] + (i / 2) * 16, csize, chroma[2] + (i / 2) * 16);
259 fic_alpha_blend(dstptr[2],
260 chroma[1] + (i / 2) * 16, csize, chroma[2] + (i / 2) * 16);
262 dstptr[0] += ctx->final_frame->linesize[0] * 2;
263 dstptr[1] += ctx->final_frame->linesize[1];
264 dstptr[2] += ctx->final_frame->linesize[2];
268 static int fic_decode_frame(AVCodecContext *avctx, void *data,
269 int *got_frame, AVPacket *avpkt)
271 FICContext *ctx = avctx->priv_data;
272 uint8_t *src = avpkt->data;
278 int skip_cursor = ctx->skip_cursor;
281 if ((ret = ff_reget_buffer(avctx, ctx->frame, 0)) < 0)
284 /* Header + at least one slice (4) */
285 if (avpkt->size < FIC_HEADER_SIZE + 4) {
286 av_log(avctx, AV_LOG_ERROR, "Frame data is too small.\n");
287 return AVERROR_INVALIDDATA;
290 /* Check for header. */
291 if (memcmp(src, fic_header, 7))
292 av_log(avctx, AV_LOG_WARNING, "Invalid FIC Header.\n");
294 /* Is it a skip frame? */
296 if (!ctx->final_frame) {
297 av_log(avctx, AV_LOG_WARNING, "Initial frame is skipped\n");
298 return AVERROR_INVALIDDATA;
305 av_log(avctx, AV_LOG_ERROR, "Zero slices found.\n");
306 return AVERROR_INVALIDDATA;
309 /* High or Low Quality Matrix? */
310 ctx->qmat = src[23] ? fic_qmat_hq : fic_qmat_lq;
312 /* Skip cursor data. */
313 tsize = AV_RB24(src + 24);
314 if (tsize > avpkt->size - FIC_HEADER_SIZE) {
315 av_log(avctx, AV_LOG_ERROR,
316 "Packet is too small to contain cursor (%d vs %d bytes).\n",
317 tsize, avpkt->size - FIC_HEADER_SIZE);
318 return AVERROR_INVALIDDATA;
321 if (!tsize || !AV_RL16(src + 37) || !AV_RL16(src + 39))
324 if (!skip_cursor && tsize < 32) {
325 av_log(avctx, AV_LOG_WARNING,
326 "Cursor data too small. Skipping cursor.\n");
330 /* Cursor position. */
331 cur_x = AV_RL16(src + 33);
332 cur_y = AV_RL16(src + 35);
333 if (!skip_cursor && (cur_x > avctx->width || cur_y > avctx->height)) {
334 av_log(avctx, AV_LOG_DEBUG,
335 "Invalid cursor position: (%d,%d). Skipping cursor.\n",
340 if (!skip_cursor && (AV_RL16(src + 37) != 32 || AV_RL16(src + 39) != 32)) {
341 av_log(avctx, AV_LOG_WARNING,
342 "Invalid cursor size. Skipping cursor.\n");
346 if (!skip_cursor && avpkt->size < CURSOR_OFFSET + sizeof(ctx->cursor_buf)) {
350 /* Slice height for all but the last slice. */
351 ctx->slice_h = 16 * (ctx->aligned_height >> 4) / nslices;
352 if (ctx->slice_h % 16)
353 ctx->slice_h = FFALIGN(ctx->slice_h - 16, 16);
355 /* First slice offset and remaining data. */
356 sdata = src + tsize + FIC_HEADER_SIZE + 4 * nslices;
357 msize = avpkt->size - nslices * 4 - tsize - FIC_HEADER_SIZE;
359 if (msize <= ctx->aligned_width/8 * (ctx->aligned_height/8) / 8) {
360 av_log(avctx, AV_LOG_ERROR, "Not enough frame data to decode.\n");
361 return AVERROR_INVALIDDATA;
364 /* Allocate slice data. */
365 av_fast_malloc(&ctx->slice_data, &ctx->slice_data_size,
366 nslices * sizeof(ctx->slice_data[0]));
367 if (!ctx->slice_data_size) {
368 av_log(avctx, AV_LOG_ERROR, "Could not allocate slice data.\n");
369 return AVERROR(ENOMEM);
371 memset(ctx->slice_data, 0, nslices * sizeof(ctx->slice_data[0]));
373 for (slice = 0; slice < nslices; slice++) {
374 unsigned slice_off = AV_RB32(src + tsize + FIC_HEADER_SIZE + slice * 4);
376 int y_off = ctx->slice_h * slice;
377 int slice_h = ctx->slice_h;
380 * Either read the slice size, or consume all data left.
381 * Also, special case the last slight height.
383 if (slice == nslices - 1) {
385 slice_h = FFALIGN(avctx->height - ctx->slice_h * (nslices - 1), 16);
387 slice_size = AV_RB32(src + tsize + FIC_HEADER_SIZE + slice * 4 + 4);
388 if (slice_size < slice_off)
389 return AVERROR_INVALIDDATA;
392 if (slice_size < slice_off || slice_size > msize)
395 slice_size -= slice_off;
397 ctx->slice_data[slice].src = sdata + slice_off;
398 ctx->slice_data[slice].src_size = slice_size;
399 ctx->slice_data[slice].slice_h = slice_h;
400 ctx->slice_data[slice].y_off = y_off;
403 if ((ret = avctx->execute(avctx, fic_decode_slice, ctx->slice_data,
404 NULL, nslices, sizeof(ctx->slice_data[0]))) < 0)
407 ctx->frame->key_frame = 1;
408 ctx->frame->pict_type = AV_PICTURE_TYPE_I;
409 for (slice = 0; slice < nslices; slice++) {
410 if (ctx->slice_data[slice].p_frame) {
411 ctx->frame->key_frame = 0;
412 ctx->frame->pict_type = AV_PICTURE_TYPE_P;
416 av_frame_free(&ctx->final_frame);
417 ctx->final_frame = av_frame_clone(ctx->frame);
418 if (!ctx->final_frame) {
419 av_log(avctx, AV_LOG_ERROR, "Could not clone frame buffer.\n");
420 return AVERROR(ENOMEM);
423 /* Make sure we use a user-supplied buffer. */
424 if ((ret = ff_reget_buffer(avctx, ctx->final_frame, 0)) < 0) {
425 av_log(avctx, AV_LOG_ERROR, "Could not make frame writable.\n");
431 memcpy(ctx->cursor_buf, src + CURSOR_OFFSET, sizeof(ctx->cursor_buf));
432 fic_draw_cursor(avctx, cur_x, cur_y);
437 if ((ret = av_frame_ref(data, ctx->final_frame)) < 0)
443 static av_cold int fic_decode_close(AVCodecContext *avctx)
445 FICContext *ctx = avctx->priv_data;
447 av_freep(&ctx->slice_data);
448 av_frame_free(&ctx->final_frame);
449 av_frame_free(&ctx->frame);
454 static av_cold int fic_decode_init(AVCodecContext *avctx)
456 FICContext *ctx = avctx->priv_data;
458 /* Initialize various context values */
460 ctx->aligned_width = FFALIGN(avctx->width, 16);
461 ctx->aligned_height = FFALIGN(avctx->height, 16);
463 avctx->pix_fmt = AV_PIX_FMT_YUV420P;
464 avctx->bits_per_raw_sample = 8;
466 ctx->frame = av_frame_alloc();
468 return AVERROR(ENOMEM);
473 static const AVOption options[] = {
474 { "skip_cursor", "skip the cursor", offsetof(FICContext, skip_cursor), AV_OPT_TYPE_BOOL, {.i64 = 0 }, 0, 1, AV_OPT_FLAG_DECODING_PARAM | AV_OPT_FLAG_VIDEO_PARAM },
478 static const AVClass fic_decoder_class = {
479 .class_name = "FIC decoder",
480 .item_name = av_default_item_name,
482 .version = LIBAVUTIL_VERSION_INT,
485 AVCodec ff_fic_decoder = {
487 .long_name = NULL_IF_CONFIG_SMALL("Mirillis FIC"),
488 .type = AVMEDIA_TYPE_VIDEO,
489 .id = AV_CODEC_ID_FIC,
490 .priv_data_size = sizeof(FICContext),
491 .init = fic_decode_init,
492 .decode = fic_decode_frame,
493 .close = fic_decode_close,
494 .capabilities = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_SLICE_THREADS,
495 .priv_class = &fic_decoder_class,