git.sesse.net Git - ffmpeg/blob - libavcodec/fic.c

   1 /*
   2  * Mirillis FIC decoder
   3  *
   4  * Copyright (c) 2014 Konstantin Shishkov
   5  * Copyright (c) 2014 Derek Buitenhuis
   6  *
   7  * This file is part of FFmpeg.
   8  *
   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.
  13  *
  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.
  18  *
  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
  22  */
  23
  24 #include "libavutil/common.h"
  25 #include "libavutil/opt.h"
  26 #include "avcodec.h"
  27 #include "internal.h"
  28 #include "get_bits.h"
  29 #include "golomb.h"
  30
  31 typedef struct FICThreadContext {
  32     DECLARE_ALIGNED(16, int16_t, block)[64];
  33     uint8_t *src;
  34     int slice_h;
  35     int src_size;
  36     int y_off;
  37     int p_frame;
  38 } FICThreadContext;
  39
  40 typedef struct FICContext {
  41     AVClass *class;
  42     AVCodecContext *avctx;
  43     AVFrame *frame;
  44     AVFrame *final_frame;
  45
  46     FICThreadContext *slice_data;
  47     int slice_data_size;
  48
  49     const uint8_t *qmat;
  50
  51     enum AVPictureType cur_frame_type;
  52
  53     int aligned_width, aligned_height;
  54     int num_slices, slice_h;
  55
  56     uint8_t cursor_buf[4096];
  57     int skip_cursor;
  58 } FICContext;
  59
  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,
  69 };
  70
  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
  80 };
  81
  82 static const uint8_t fic_header[7] = { 0, 0, 1, 'F', 'I', 'C', 'V' };
  83
  84 #define FIC_HEADER_SIZE 27
  85 #define CURSOR_OFFSET 59
  86
  87 static av_always_inline void fic_idct(int16_t *blk, int step, int shift, int rnd)
  88 {
  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;
 109 }
 110
 111 static void fic_idct_put(uint8_t *dst, int stride, int16_t *block)
 112 {
 113     int i, j;
 114     int16_t *ptr;
 115
 116     ptr = 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);
 120         ptr++;
 121     }
 122
 123     ptr = block;
 124     for (i = 0; i < 8; i++) {
 125         fic_idct(ptr, 1, 20, 0);
 126         ptr += 8;
 127     }
 128
 129     ptr = block;
 130     for (j = 0; j < 8; j++) {
 131         for (i = 0; i < 8; i++)
 132             dst[i] = av_clip_uint8(ptr[i]);
 133         dst += stride;
 134         ptr += 8;
 135     }
 136 }
 137 static int fic_decode_block(FICContext *ctx, GetBitContext *gb,
 138                             uint8_t *dst, int stride, int16_t *block, int *is_p)
 139 {
 140     int i, num_coeff;
 141
 142     /* Is it a skip block? */
 143     if (get_bits1(gb)) {
 144         *is_p = 1;
 145         return 0;
 146     }
 147
 148     memset(block, 0, sizeof(*block) * 64);
 149
 150     num_coeff = get_bits(gb, 7);
 151     if (num_coeff > 64)
 152         return AVERROR_INVALIDDATA;
 153
 154     for (i = 0; i < num_coeff; i++) {
 155         int v = get_se_golomb(gb);
 156         if (v < -2048 || v > 2048)
 157              return AVERROR_INVALIDDATA;
 158         block[ff_zigzag_direct[i]] = v *
 159                                      ctx->qmat[ff_zigzag_direct[i]];
 160     }
 161
 162     fic_idct_put(dst, stride, block);
 163
 164     return 0;
 165 }
 166
 167 static int fic_decode_slice(AVCodecContext *avctx, void *tdata)
 168 {
 169     FICContext *ctx        = avctx->priv_data;
 170     FICThreadContext *tctx = tdata;
 171     GetBitContext gb;
 172     uint8_t *src = tctx->src;
 173     int slice_h  = tctx->slice_h;
 174     int src_size = tctx->src_size;
 175     int y_off    = tctx->y_off;
 176     int x, y, p, ret;
 177
 178     ret = init_get_bits8(&gb, src, src_size);
 179     if (ret < 0)
 180         return ret;
 181
 182     for (p = 0; p < 3; p++) {
 183         int stride   = ctx->frame->linesize[p];
 184         uint8_t* dst = ctx->frame->data[p] + (y_off >> !!p) * stride;
 185
 186         for (y = 0; y < (slice_h >> !!p); y += 8) {
 187             for (x = 0; x < (ctx->aligned_width >> !!p); x += 8) {
 188                 int ret;
 189
 190                 if ((ret = fic_decode_block(ctx, &gb, dst + x, stride,
 191                                             tctx->block, &tctx->p_frame)) != 0)
 192                     return ret;
 193             }
 194
 195             dst += 8 * stride;
 196         }
 197     }
 198
 199     return 0;
 200 }
 201
 202 static av_always_inline void fic_alpha_blend(uint8_t *dst, uint8_t *src,
 203                                              int size, uint8_t *alpha)
 204 {
 205     int i;
 206
 207     for (i = 0; i < size; i++)
 208         dst[i] += ((src[i] - dst[i]) * alpha[i]) >> 8;
 209 }
 210
 211 static void fic_draw_cursor(AVCodecContext *avctx, int cur_x, int cur_y)
 212 {
 213     FICContext *ctx = avctx->priv_data;
 214     uint8_t *ptr    = ctx->cursor_buf;
 215     uint8_t *dstptr[3];
 216     uint8_t planes[4][1024];
 217     uint8_t chroma[3][256];
 218     int i, j, p;
 219
 220     /* Convert to YUVA444. */
 221     for (i = 0; i < 1024; i++) {
 222         planes[0][i] = (( 25 * ptr[0] + 129 * ptr[1] +  66 * ptr[2]) / 255) + 16;
 223         planes[1][i] = ((-38 * ptr[0] + 112 * ptr[1] + -74 * ptr[2]) / 255) + 128;
 224         planes[2][i] = ((-18 * ptr[0] + 112 * ptr[1] + -94 * ptr[2]) / 255) + 128;
 225         planes[3][i] = ptr[3];
 226
 227         ptr += 4;
 228     }
 229
 230     /* Subsample chroma. */
 231     for (i = 0; i < 32; i += 2)
 232         for (j = 0; j < 32; j += 2)
 233             for (p = 0; p < 3; p++)
 234                 chroma[p][16 * (i / 2) + j / 2] = (planes[p + 1][32 *  i      + j    ] +
 235                                                    planes[p + 1][32 *  i      + j + 1] +
 236                                                    planes[p + 1][32 * (i + 1) + j    ] +
 237                                                    planes[p + 1][32 * (i + 1) + j + 1]) / 4;
 238
 239     /* Seek to x/y pos of cursor. */
 240     for (i = 0; i < 3; i++)
 241         dstptr[i] = ctx->final_frame->data[i]                        +
 242                     (ctx->final_frame->linesize[i] * (cur_y >> !!i)) +
 243                     (cur_x >> !!i) + !!i;
 244
 245     /* Copy. */
 246     for (i = 0; i < FFMIN(32, avctx->height - cur_y) - 1; i += 2) {
 247         int lsize = FFMIN(32, avctx->width - cur_x);
 248         int csize = lsize / 2;
 249
 250         fic_alpha_blend(dstptr[0],
 251                         planes[0] + i * 32, lsize, planes[3] + i * 32);
 252         fic_alpha_blend(dstptr[0] + ctx->final_frame->linesize[0],
 253                         planes[0] + (i + 1) * 32, lsize, planes[3] + (i + 1) * 32);
 254         fic_alpha_blend(dstptr[1],
 255                         chroma[0] + (i / 2) * 16, csize, chroma[2] + (i / 2) * 16);
 256         fic_alpha_blend(dstptr[2],
 257                         chroma[1] + (i / 2) * 16, csize, chroma[2] + (i / 2) * 16);
 258
 259         dstptr[0] += ctx->final_frame->linesize[0] * 2;
 260         dstptr[1] += ctx->final_frame->linesize[1];
 261         dstptr[2] += ctx->final_frame->linesize[2];
 262     }
 263 }
 264
 265 static int fic_decode_frame(AVCodecContext *avctx, void *data,
 266                             int *got_frame, AVPacket *avpkt)
 267 {
 268     FICContext *ctx = avctx->priv_data;
 269     uint8_t *src = avpkt->data;
 270     int ret;
 271     int slice, nslices;
 272     int msize;
 273     int tsize;
 274     int cur_x, cur_y;
 275     int skip_cursor = ctx->skip_cursor;
 276     uint8_t *sdata;
 277
 278     if ((ret = ff_reget_buffer(avctx, ctx->frame)) < 0)
 279         return ret;
 280
 281     /* Header + at least one slice (4) */
 282     if (avpkt->size < FIC_HEADER_SIZE + 4) {
 283         av_log(avctx, AV_LOG_ERROR, "Frame data is too small.\n");
 284         return AVERROR_INVALIDDATA;
 285     }
 286
 287     /* Check for header. */
 288     if (memcmp(src, fic_header, 7))
 289         av_log(avctx, AV_LOG_WARNING, "Invalid FIC Header.\n");
 290
 291     /* Is it a skip frame? */
 292     if (src[17]) {
 293         if (!ctx->final_frame) {
 294             av_log(avctx, AV_LOG_WARNING, "Initial frame is skipped\n");
 295             return AVERROR_INVALIDDATA;
 296         }
 297         goto skip;
 298     }
 299
 300     nslices = src[13];
 301     if (!nslices) {
 302         av_log(avctx, AV_LOG_ERROR, "Zero slices found.\n");
 303         return AVERROR_INVALIDDATA;
 304     }
 305
 306     /* High or Low Quality Matrix? */
 307     ctx->qmat = src[23] ? fic_qmat_hq : fic_qmat_lq;
 308
 309     /* Skip cursor data. */
 310     tsize = AV_RB24(src + 24);
 311     if (tsize > avpkt->size - FIC_HEADER_SIZE) {
 312         av_log(avctx, AV_LOG_ERROR,
 313                "Packet is too small to contain cursor (%d vs %d bytes).\n",
 314                tsize, avpkt->size - FIC_HEADER_SIZE);
 315         return AVERROR_INVALIDDATA;
 316     }
 317
 318     if (!tsize || !AV_RL16(src + 37) || !AV_RL16(src + 39))
 319         skip_cursor = 1;
 320
 321     if (!skip_cursor && tsize < 32) {
 322         av_log(avctx, AV_LOG_WARNING,
 323                "Cursor data too small. Skipping cursor.\n");
 324         skip_cursor = 1;
 325     }
 326
 327     /* Cursor position. */
 328     cur_x = AV_RL16(src + 33);
 329     cur_y = AV_RL16(src + 35);
 330     if (!skip_cursor && (cur_x > avctx->width || cur_y > avctx->height)) {
 331         av_log(avctx, AV_LOG_DEBUG,
 332                "Invalid cursor position: (%d,%d). Skipping cursor.\n",
 333                cur_x, cur_y);
 334         skip_cursor = 1;
 335     }
 336
 337     if (!skip_cursor && (AV_RL16(src + 37) != 32 || AV_RL16(src + 39) != 32)) {
 338         av_log(avctx, AV_LOG_WARNING,
 339                "Invalid cursor size. Skipping cursor.\n");
 340         skip_cursor = 1;
 341     }
 342
 343     if (!skip_cursor && avpkt->size < CURSOR_OFFSET + sizeof(ctx->cursor_buf)) {
 344         skip_cursor = 1;
 345     }
 346
 347     /* Slice height for all but the last slice. */
 348     ctx->slice_h = 16 * (ctx->aligned_height >> 4) / nslices;
 349     if (ctx->slice_h % 16)
 350         ctx->slice_h = FFALIGN(ctx->slice_h - 16, 16);
 351
 352     /* First slice offset and remaining data. */
 353     sdata = src + tsize + FIC_HEADER_SIZE + 4 * nslices;
 354     msize = avpkt->size - nslices * 4 - tsize - FIC_HEADER_SIZE;
 355
 356     if (msize <= 0) {
 357         av_log(avctx, AV_LOG_ERROR, "Not enough frame data to decode.\n");
 358         return AVERROR_INVALIDDATA;
 359     }
 360
 361     /* Allocate slice data. */
 362     av_fast_malloc(&ctx->slice_data, &ctx->slice_data_size,
 363                    nslices * sizeof(ctx->slice_data[0]));
 364     if (!ctx->slice_data_size) {
 365         av_log(avctx, AV_LOG_ERROR, "Could not allocate slice data.\n");
 366         return AVERROR(ENOMEM);
 367     }
 368     memset(ctx->slice_data, 0, nslices * sizeof(ctx->slice_data[0]));
 369
 370     for (slice = 0; slice < nslices; slice++) {
 371         unsigned slice_off = AV_RB32(src + tsize + FIC_HEADER_SIZE + slice * 4);
 372         unsigned slice_size;
 373         int y_off   = ctx->slice_h * slice;
 374         int slice_h = ctx->slice_h;
 375
 376         /*
 377          * Either read the slice size, or consume all data left.
 378          * Also, special case the last slight height.
 379          */
 380         if (slice == nslices - 1) {
 381             slice_size   = msize;
 382             slice_h      = FFALIGN(avctx->height - ctx->slice_h * (nslices - 1), 16);
 383         } else {
 384             slice_size = AV_RB32(src + tsize + FIC_HEADER_SIZE + slice * 4 + 4);
 385             if (slice_size < slice_off)
 386                 return AVERROR_INVALIDDATA;
 387         }
 388
 389         if (slice_size < slice_off || slice_size > msize)
 390             continue;
 391
 392         slice_size -= slice_off;
 393
 394         ctx->slice_data[slice].src      = sdata + slice_off;
 395         ctx->slice_data[slice].src_size = slice_size;
 396         ctx->slice_data[slice].slice_h  = slice_h;
 397         ctx->slice_data[slice].y_off    = y_off;
 398     }
 399
 400     if ((ret = avctx->execute(avctx, fic_decode_slice, ctx->slice_data,
 401                               NULL, nslices, sizeof(ctx->slice_data[0]))) < 0)
 402         return ret;
 403
 404     ctx->frame->key_frame = 1;
 405     ctx->frame->pict_type = AV_PICTURE_TYPE_I;
 406     for (slice = 0; slice < nslices; slice++) {
 407         if (ctx->slice_data[slice].p_frame) {
 408             ctx->frame->key_frame = 0;
 409             ctx->frame->pict_type = AV_PICTURE_TYPE_P;
 410             break;
 411         }
 412     }
 413     av_frame_free(&ctx->final_frame);
 414     ctx->final_frame = av_frame_clone(ctx->frame);
 415     if (!ctx->final_frame) {
 416         av_log(avctx, AV_LOG_ERROR, "Could not clone frame buffer.\n");
 417         return AVERROR(ENOMEM);
 418     }
 419
 420     /* Make sure we use a user-supplied buffer. */
 421     if ((ret = ff_reget_buffer(avctx, ctx->final_frame)) < 0) {
 422         av_log(avctx, AV_LOG_ERROR, "Could not make frame writable.\n");
 423         return ret;
 424     }
 425
 426     /* Draw cursor. */
 427     if (!skip_cursor) {
 428         memcpy(ctx->cursor_buf, src + CURSOR_OFFSET, sizeof(ctx->cursor_buf));
 429         fic_draw_cursor(avctx, cur_x, cur_y);
 430     }
 431
 432 skip:
 433     *got_frame = 1;
 434     if ((ret = av_frame_ref(data, ctx->final_frame)) < 0)
 435         return ret;
 436
 437     return avpkt->size;
 438 }
 439
 440 static av_cold int fic_decode_close(AVCodecContext *avctx)
 441 {
 442     FICContext *ctx = avctx->priv_data;
 443
 444     av_freep(&ctx->slice_data);
 445     av_frame_free(&ctx->final_frame);
 446     av_frame_free(&ctx->frame);
 447
 448     return 0;
 449 }
 450
 451 static av_cold int fic_decode_init(AVCodecContext *avctx)
 452 {
 453     FICContext *ctx = avctx->priv_data;
 454
 455     /* Initialize various context values */
 456     ctx->avctx            = avctx;
 457     ctx->aligned_width    = FFALIGN(avctx->width,  16);
 458     ctx->aligned_height   = FFALIGN(avctx->height, 16);
 459
 460     avctx->pix_fmt             = AV_PIX_FMT_YUV420P;
 461     avctx->bits_per_raw_sample = 8;
 462
 463     ctx->frame = av_frame_alloc();
 464     if (!ctx->frame)
 465         return AVERROR(ENOMEM);
 466
 467     return 0;
 468 }
 469
 470 static const AVOption options[] = {
 471 { "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 },
 472 { NULL },
 473 };
 474
 475 static const AVClass fic_decoder_class = {
 476     .class_name = "FIC decoder",
 477     .item_name  = av_default_item_name,
 478     .option     = options,
 479     .version    = LIBAVUTIL_VERSION_INT,
 480 };
 481
 482 AVCodec ff_fic_decoder = {
 483     .name           = "fic",
 484     .long_name      = NULL_IF_CONFIG_SMALL("Mirillis FIC"),
 485     .type           = AVMEDIA_TYPE_VIDEO,
 486     .id             = AV_CODEC_ID_FIC,
 487     .priv_data_size = sizeof(FICContext),
 488     .init           = fic_decode_init,
 489     .decode         = fic_decode_frame,
 490     .close          = fic_decode_close,
 491     .capabilities   = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_SLICE_THREADS,
 492     .priv_class     = &fic_decoder_class,
 493 };