libavcodec/mimic.c
a7129de5
 /*
6d27d8b1
  * Copyright (C) 2005  Ole André Vadla Ravnås <oleavr@gmail.com>
57149a92
  * Copyright (C) 2008  Ramiro Polla
a7129de5
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #include <stdlib.h>
 #include <string.h>
 #include <stdint.h>
 
 #include "avcodec.h"
e74433a8
 #include "blockdsp.h"
f3a29b75
 #include "internal.h"
9106a698
 #include "get_bits.h"
fc22c009
 #include "bytestream.h"
c67b449b
 #include "bswapdsp.h"
cc5d17e0
 #include "hpeldsp.h"
e3fcb143
 #include "idctdsp.h"
d375c104
 #include "thread.h"
a7129de5
 
 #define MIMIC_HEADER_SIZE   20
 
7f9f771e
 typedef struct MimicContext {
a7129de5
     AVCodecContext *avctx;
 
     int             num_vblocks[3];
     int             num_hblocks[3];
 
9bf993a5
     void           *swap_buf;
a7129de5
     int             swap_buf_size;
 
     int             cur_index;
     int             prev_index;
 
759001c5
     ThreadFrame     frames     [16];
a7129de5
 
88bd7fdc
     DECLARE_ALIGNED(16, int16_t, dct_block)[64];
a7129de5
 
     GetBitContext   gb;
     ScanTable       scantable;
e74433a8
     BlockDSPContext bdsp;
c67b449b
     BswapDSPContext bbdsp;
cc5d17e0
     HpelDSPContext  hdsp;
e3fcb143
     IDCTDSPContext  idsp;
c9108634
     VLC             vlc;
d375c104
 
     /* Kept in the context so multithreading can have a constant to read from */
     int             next_cur_index;
     int             next_prev_index;
a7129de5
 } MimicContext;
 
 static const uint32_t huffcodes[] = {
     0x0000000a, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000,
     0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000,
     0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x0000000b,
     0x0000001b, 0x00000038, 0x00000078, 0x00000079, 0x0000007a, 0x000000f9,
     0x000000fa, 0x000003fb, 0x000007f8, 0x000007f9, 0x000007fa, 0x000007fb,
     0x00000ff8, 0x00000ff9, 0x00000001, 0x00000039, 0x0000007b, 0x000000fb,
     0x000001f8, 0x000001f9, 0x00000ffa, 0x00000ffb, 0x00001ff8, 0x00001ff9,
     0x00001ffa, 0x00001ffb, 0x00003ff8, 0x00003ff9, 0x00003ffa, 0x00000000,
     0x00000004, 0x0000003a, 0x000001fa, 0x00003ffb, 0x00007ff8, 0x00007ff9,
     0x00007ffa, 0x00007ffb, 0x0000fff8, 0x0000fff9, 0x0000fffa, 0x0000fffb,
     0x0001fff8, 0x0001fff9, 0x0001fffa, 0x00000000, 0x0000000c, 0x000000f8,
     0x000001fb, 0x0001fffb, 0x0003fff8, 0x0003fff9, 0x0003fffa, 0x0003fffb,
     0x0007fff8, 0x0007fff9, 0x0007fffa, 0x0007fffb, 0x000ffff8, 0x000ffff9,
     0x000ffffa, 0x00000000, 0x0000001a, 0x000003f8, 0x000ffffb, 0x001ffff8,
     0x001ffff9, 0x001ffffa, 0x001ffffb, 0x003ffff8, 0x003ffff9, 0x003ffffa,
     0x003ffffb, 0x007ffff8, 0x007ffff9, 0x007ffffa, 0x007ffffb, 0x00000000,
     0x0000003b, 0x000003f9, 0x00fffff8, 0x00fffff9, 0x00fffffa, 0x00fffffb,
     0x01fffff8, 0x01fffff9, 0x01fffffa, 0x01fffffb, 0x03fffff8, 0x03fffff9,
     0x03fffffa, 0x03fffffb, 0x07fffff8, 0x00000000, 0x000003fa, 0x07fffff9,
     0x07fffffa, 0x07fffffb, 0x0ffffff8, 0x0ffffff9, 0x0ffffffa, 0x0ffffffb,
     0x1ffffff8, 0x1ffffff9, 0x1ffffffa, 0x1ffffffb, 0x3ffffff8, 0x3ffffff9,
     0x3ffffffa,
 };
 
 static const uint8_t huffbits[] = {
      4,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,
      0,  0,  0,  0,  2,  4,  5,  6,  7,  7,  7,  8,
      8, 10, 11, 11, 11, 11, 12, 12,  2,  6,  7,  8,
      9,  9, 12, 12, 13, 13, 13, 13, 14, 14, 14,  0,
      3,  6,  9, 14, 15, 15, 15, 15, 16, 16, 16, 16,
     17, 17, 17,  0,  4,  8,  9, 17, 18, 18, 18, 18,
     19, 19, 19, 19, 20, 20, 20,  0,  5, 10, 20, 21,
     21, 21, 21, 22, 22, 22, 22, 23, 23, 23, 23,  0,
      6, 10, 24, 24, 24, 24, 25, 25, 25, 25, 26, 26,
     26, 26, 27,  0, 10, 27, 27, 27, 28, 28, 28, 28,
     29, 29, 29, 29, 30, 30, 30,
 };
 
 static const uint8_t col_zag[64] = {
      0,  8,  1,  2,  9, 16, 24, 17,
     10,  3,  4, 11, 18, 25, 32, 40,
     33, 26, 19, 12,  5,  6, 13, 20,
     27, 34, 41, 48, 56, 49, 42, 35,
     28, 21, 14,  7, 15, 22, 29, 36,
     43, 50, 57, 58, 51, 44, 37, 30,
     23, 31, 38, 45, 52, 59, 39, 46,
399e4652
     53, 60, 61, 54, 47, 55, 62, 63,
a7129de5
 };
 
759001c5
 static av_cold int mimic_decode_end(AVCodecContext *avctx)
 {
     MimicContext *ctx = avctx->priv_data;
     int i;
 
b8f276e6
     av_freep(&ctx->swap_buf);
     ctx->swap_buf_size = 0;
759001c5
 
     for (i = 0; i < FF_ARRAY_ELEMS(ctx->frames); i++) {
         if (ctx->frames[i].f)
             ff_thread_release_buffer(avctx, &ctx->frames[i]);
         av_frame_free(&ctx->frames[i].f);
     }
 
     if (!avctx->internal->is_copy)
         ff_free_vlc(&ctx->vlc);
 
     return 0;
 }
 
98a6fff9
 static av_cold int mimic_decode_init(AVCodecContext *avctx)
a7129de5
 {
     MimicContext *ctx = avctx->priv_data;
759001c5
     int ret, i;
 
     avctx->internal->allocate_progress = 1;
a7129de5
 
     ctx->prev_index = 0;
a0cabd0a
     ctx->cur_index  = 15;
a7129de5
 
b965cb90
     if ((ret = init_vlc(&ctx->vlc, 11, FF_ARRAY_ELEMS(huffbits),
                         huffbits, 1, 1, huffcodes, 4, 4, 0)) < 0) {
a7129de5
         av_log(avctx, AV_LOG_ERROR, "error initializing vlc table\n");
b965cb90
         return ret;
a7129de5
     }
e74433a8
     ff_blockdsp_init(&ctx->bdsp, avctx);
c67b449b
     ff_bswapdsp_init(&ctx->bbdsp);
cc5d17e0
     ff_hpeldsp_init(&ctx->hdsp, avctx->flags);
e3fcb143
     ff_idctdsp_init(&ctx->idsp, avctx);
     ff_init_scantable(ctx->idsp.idct_permutation, &ctx->scantable, col_zag);
a7129de5
 
759001c5
     for (i = 0; i < FF_ARRAY_ELEMS(ctx->frames); i++) {
         ctx->frames[i].f = av_frame_alloc();
         if (!ctx->frames[i].f) {
             mimic_decode_end(avctx);
             return AVERROR(ENOMEM);
         }
     }
 
a7129de5
     return 0;
 }
 
2cbaa078
 #if HAVE_THREADS
d375c104
 static int mimic_decode_update_thread_context(AVCodecContext *avctx, const AVCodecContext *avctx_from)
 {
     MimicContext *dst = avctx->priv_data, *src = avctx_from->priv_data;
759001c5
     int i, ret;
d375c104
 
a0cabd0a
     if (avctx == avctx_from)
         return 0;
d375c104
 
     dst->cur_index  = src->next_cur_index;
     dst->prev_index = src->next_prev_index;
 
759001c5
     for (i = 0; i < FF_ARRAY_ELEMS(dst->frames); i++) {
         ff_thread_release_buffer(avctx, &dst->frames[i]);
500220a8
         if (i != src->next_cur_index && src->frames[i].f->data[0]) {
759001c5
             ret = ff_thread_ref_frame(&dst->frames[i], &src->frames[i]);
             if (ret < 0)
                 return ret;
         }
     }
d375c104
 
     return 0;
 }
2cbaa078
 #endif
d375c104
 
1bf6e565
 static const int8_t vlcdec_lookup[9][64] = {
a7129de5
     {    0, },
     {   -1,   1, },
     {   -3,   3,   -2,   2, },
     {   -7,   7,   -6,   6,   -5,   5,   -4,   4, },
     {  -15,  15,  -14,  14,  -13,  13,  -12,  12,
        -11,  11,  -10,  10,   -9,   9,   -8,   8, },
     {  -31,  31,  -30,  30,  -29,  29,  -28,  28,
        -27,  27,  -26,  26,  -25,  25,  -24,  24,
        -23,  23,  -22,  22,  -21,  21,  -20,  20,
        -19,  19,  -18,  18,  -17,  17,  -16,  16, },
     {  -63,  63,  -62,  62,  -61,  61,  -60,  60,
        -59,  59,  -58,  58,  -57,  57,  -56,  56,
        -55,  55,  -54,  54,  -53,  53,  -52,  52,
        -51,  51,  -50,  50,  -49,  49,  -48,  48,
        -47,  47,  -46,  46,  -45,  45,  -44,  44,
        -43,  43,  -42,  42,  -41,  41,  -40,  40,
        -39,  39,  -38,  38,  -37,  37,  -36,  36,
        -35,  35,  -34,  34,  -33,  33,  -32,  32, },
     { -127, 127, -126, 126, -125, 125, -124, 124,
       -123, 123, -122, 122, -121, 121, -120, 120,
       -119, 119, -118, 118, -117, 117, -116, 116,
       -115, 115, -114, 114, -113, 113, -112, 112,
       -111, 111, -110, 110, -109, 109, -108, 108,
       -107, 107, -106, 106, -105, 105, -104, 104,
       -103, 103, -102, 102, -101, 101, -100, 100,
        -99,  99,  -98,  98,  -97,  97,  -96,  96, },
     {  -95,  95,  -94,  94,  -93,  93,  -92,  92,
        -91,  91,  -90,  90,  -89,  89,  -88,  88,
        -87,  87,  -86,  86,  -85,  85,  -84,  84,
        -83,  83,  -82,  82,  -81,  81,  -80,  80,
        -79,  79,  -78,  78,  -77,  77,  -76,  76,
        -75,  75,  -74,  74,  -73,  73,  -72,  72,
        -71,  71,  -70,  70,  -69,  69,  -68,  68,
        -67,  67,  -66,  66,  -65,  65,  -64,  64, },
 };
 
bebfc16a
 static int vlc_decode_block(MimicContext *ctx, int num_coeffs, int qscale)
a7129de5
 {
88bd7fdc
     int16_t *block = ctx->dct_block;
a7129de5
     unsigned int pos;
 
e74433a8
     ctx->bdsp.clear_block(block);
a7129de5
 
     block[0] = get_bits(&ctx->gb, 8) << 3;
 
a0cabd0a
     for (pos = 1; pos < num_coeffs; pos++) {
a7129de5
         uint32_t vlc, num_bits;
         int value;
         int coeff;
 
630e1b27
         vlc = get_vlc2(&ctx->gb, ctx->vlc.table, ctx->vlc.bits, 3);
a0cabd0a
         if (!vlc) /* end-of-block code */
a7129de5
             return 0;
b965cb90
         if (vlc == -1)
             return AVERROR_INVALIDDATA;
a7129de5
 
         /* pos_add and num_bits are coded in the vlc code */
a0cabd0a
         pos     += vlc & 15; // pos_add
         num_bits = vlc >> 4; // num_bits
a7129de5
 
a0cabd0a
         if (pos >= 64)
b965cb90
             return AVERROR_INVALIDDATA;
a7129de5
 
         value = get_bits(&ctx->gb, num_bits);
 
2d2b5a14
         /* FFmpeg's IDCT behaves somewhat different from the original code, so
a7129de5
          * a factor of 4 was added to the input */
 
         coeff = vlcdec_lookup[num_bits][value];
a0cabd0a
         if (pos < 3)
139d8812
             coeff *= 16;
a7129de5
         else /* TODO Use >> 10 instead of / 1001 */
             coeff = (coeff * qscale) / 1001;
 
         block[ctx->scantable.permutated[pos]] = coeff;
     }
 
b965cb90
     return 0;
a7129de5
 }
 
 static int decode(MimicContext *ctx, int quality, int num_coeffs,
                   int is_iframe)
 {
b965cb90
     int ret, y, x, plane, cur_row = 0;
a7129de5
 
a0cabd0a
     for (plane = 0; plane < 3; plane++) {
a7129de5
         const int is_chroma = !!plane;
a0cabd0a
         const int qscale    = av_clip(10000 - quality, is_chroma ? 1000 : 2000,
                                       10000) << 2;
6a23a342
         const int stride    = ctx->frames[ctx->cur_index ].f->linesize[plane];
         const uint8_t *src  = ctx->frames[ctx->prev_index].f->data[plane];
         uint8_t       *dst  = ctx->frames[ctx->cur_index ].f->data[plane];
a0cabd0a
 
         for (y = 0; y < ctx->num_vblocks[plane]; y++) {
             for (x = 0; x < ctx->num_hblocks[plane]; x++) {
a7129de5
                 /* Check for a change condition in the current block.
                  * - iframes always change.
                  * - Luma plane changes on get_bits1 == 0
                  * - Chroma planes change on get_bits1 == 1 */
a0cabd0a
                 if (is_iframe || get_bits1(&ctx->gb) == is_chroma) {
a7129de5
                     /* Luma planes may use a backreference from the 15 last
                      * frames preceding the previous. (get_bits1 == 1)
                      * Chroma planes don't use backreferences. */
a0cabd0a
                     if (is_chroma || is_iframe || !get_bits1(&ctx->gb)) {
b965cb90
                         if ((ret = vlc_decode_block(ctx, num_coeffs,
                                                     qscale)) < 0) {
                             av_log(ctx->avctx, AV_LOG_ERROR, "Error decoding "
                                    "block.\n");
                             return ret;
                         }
e3fcb143
                         ctx->idsp.idct_put(dst, stride, ctx->dct_block);
a7129de5
                     } else {
                         unsigned int backref = get_bits(&ctx->gb, 4);
a0cabd0a
                         int index            = (ctx->cur_index + backref) & 15;
6a23a342
                         uint8_t *p           = ctx->frames[index].f->data[0];
a7129de5
 
80387f0e
                         if (index != ctx->cur_index && p) {
759001c5
                             ff_thread_await_progress(&ctx->frames[index],
a0cabd0a
                                                      cur_row, 0);
a7129de5
                             p += src -
6a23a342
                                  ctx->frames[ctx->prev_index].f->data[plane];
cc5d17e0
                             ctx->hdsp.put_pixels_tab[1][0](dst, p, stride, 8);
a7129de5
                         } else {
                             av_log(ctx->avctx, AV_LOG_ERROR,
                                      "No such backreference! Buggy sample.\n");
                         }
                     }
                 } else {
759001c5
                     ff_thread_await_progress(&ctx->frames[ctx->prev_index],
a0cabd0a
                                              cur_row, 0);
cc5d17e0
                     ctx->hdsp.put_pixels_tab[1][0](dst, src, stride, 8);
a7129de5
                 }
                 src += 8;
                 dst += 8;
             }
a0cabd0a
             src += (stride - ctx->num_hblocks[plane]) << 3;
             dst += (stride - ctx->num_hblocks[plane]) << 3;
d375c104
 
759001c5
             ff_thread_report_progress(&ctx->frames[ctx->cur_index],
a0cabd0a
                                       cur_row++, 0);
a7129de5
         }
     }
 
b965cb90
     return 0;
a7129de5
 }
 
 /**
6a23a342
  * Flip the buffer upside-down and put it in the YVU order to revert the
a7129de5
  * way Mimic encodes frames.
  */
6a23a342
 static void flip_swap_frame(AVFrame *f)
a7129de5
 {
     int i;
6a23a342
     uint8_t *data_1 = f->data[1];
     f->data[0] = f->data[0] + ( f->height       - 1) * f->linesize[0];
     f->data[1] = f->data[2] + ((f->height >> 1) - 1) * f->linesize[2];
     f->data[2] = data_1     + ((f->height >> 1) - 1) * f->linesize[1];
a0cabd0a
     for (i = 0; i < 3; i++)
6a23a342
         f->linesize[i] *= -1;
a7129de5
 }
 
 static int mimic_decode_frame(AVCodecContext *avctx, void *data,
df9b9567
                               int *got_frame, AVPacket *avpkt)
a7129de5
 {
7a00bbad
     const uint8_t *buf = avpkt->data;
a0cabd0a
     int buf_size       = avpkt->size;
     int swap_buf_size  = buf_size - MIMIC_HEADER_SIZE;
     MimicContext *ctx  = avctx->priv_data;
dba425ad
     GetByteContext gb;
a7129de5
     int is_pframe;
     int width, height;
     int quality, num_coeffs;
80387f0e
     int res;
a7129de5
 
33c5c3ad
     if (buf_size <= MIMIC_HEADER_SIZE) {
a7129de5
         av_log(avctx, AV_LOG_ERROR, "insufficient data\n");
b965cb90
         return AVERROR_INVALIDDATA;
a7129de5
     }
 
dba425ad
     bytestream2_init(&gb, buf, MIMIC_HEADER_SIZE);
     bytestream2_skip(&gb, 2); /* some constant (always 256) */
     quality    = bytestream2_get_le16u(&gb);
     width      = bytestream2_get_le16u(&gb);
     height     = bytestream2_get_le16u(&gb);
     bytestream2_skip(&gb, 4); /* some constant */
     is_pframe  = bytestream2_get_le32u(&gb);
     num_coeffs = bytestream2_get_byteu(&gb);
     bytestream2_skip(&gb, 3); /* some constant */
a7129de5
 
a0cabd0a
     if (!ctx->avctx) {
a7129de5
         int i;
 
a0cabd0a
         if (!(width == 160 && height == 120) &&
             !(width == 320 && height == 240)) {
a7129de5
             av_log(avctx, AV_LOG_ERROR, "invalid width/height!\n");
b965cb90
             return AVERROR_INVALIDDATA;
a7129de5
         }
 
e46bc305
         res = ff_set_dimensions(avctx, width, height);
         if (res < 0)
             return res;
 
a7129de5
         ctx->avctx     = avctx;
716d413c
         avctx->pix_fmt = AV_PIX_FMT_YUV420P;
a0cabd0a
         for (i = 0; i < 3; i++) {
21f94684
             ctx->num_vblocks[i] = AV_CEIL_RSHIFT(height,   3 + !!i);
570d63ee
             ctx->num_hblocks[i] =                width >> (3 + !!i);
a7129de5
         }
a0cabd0a
     } else if (width != ctx->avctx->width || height != ctx->avctx->height) {
12e25ed2
         avpriv_request_sample(avctx, "Resolution changing");
b965cb90
         return AVERROR_PATCHWELCOME;
a7129de5
     }
 
759001c5
     if (is_pframe && !ctx->frames[ctx->prev_index].f->data[0]) {
a7129de5
         av_log(avctx, AV_LOG_ERROR, "decoding must start with keyframe\n");
b965cb90
         return AVERROR_INVALIDDATA;
a7129de5
     }
 
759001c5
     ff_thread_release_buffer(avctx, &ctx->frames[ctx->cur_index]);
     ctx->frames[ctx->cur_index].f->pict_type = is_pframe ? AV_PICTURE_TYPE_P :
                                                            AV_PICTURE_TYPE_I;
     if ((res = ff_thread_get_buffer(avctx, &ctx->frames[ctx->cur_index],
1ec94b0f
                                     AV_GET_BUFFER_FLAG_REF)) < 0)
b965cb90
         return res;
a7129de5
 
d375c104
     ctx->next_prev_index = ctx->cur_index;
     ctx->next_cur_index  = (ctx->cur_index - 1) & 15;
 
     ff_thread_finish_setup(avctx);
 
e8b060f7
     av_fast_padded_malloc(&ctx->swap_buf, &ctx->swap_buf_size, swap_buf_size);
a0cabd0a
     if (!ctx->swap_buf)
55775b09
         return AVERROR(ENOMEM);
a7129de5
 
c67b449b
     ctx->bbdsp.bswap_buf(ctx->swap_buf,
                          (const uint32_t *) (buf + MIMIC_HEADER_SIZE),
                          swap_buf_size >> 2);
a7129de5
     init_get_bits(&ctx->gb, ctx->swap_buf, swap_buf_size << 3);
 
80387f0e
     res = decode(ctx, quality, num_coeffs, !is_pframe);
759001c5
     ff_thread_report_progress(&ctx->frames[ctx->cur_index], INT_MAX, 0);
b965cb90
     if (res < 0) {
4a326923
         if (!(avctx->active_thread_type & FF_THREAD_FRAME))
759001c5
             ff_thread_release_buffer(avctx, &ctx->frames[ctx->cur_index]);
4a326923
         return res;
a7129de5
     }
 
759001c5
     if ((res = av_frame_ref(data, ctx->frames[ctx->cur_index].f)) < 0)
         return res;
df9b9567
     *got_frame      = 1;
a7129de5
 
6a23a342
     flip_swap_frame(data);
 
d375c104
     ctx->prev_index = ctx->next_prev_index;
     ctx->cur_index  = ctx->next_cur_index;
a7129de5
 
     return buf_size;
 }
 
2cbaa078
 #if HAVE_THREADS
759001c5
 static av_cold int mimic_init_thread_copy(AVCodecContext *avctx)
a7129de5
 {
     MimicContext *ctx = avctx->priv_data;
     int i;
 
759001c5
     for (i = 0; i < FF_ARRAY_ELEMS(ctx->frames); i++) {
         ctx->frames[i].f = av_frame_alloc();
         if (!ctx->frames[i].f) {
             mimic_decode_end(avctx);
             return AVERROR(ENOMEM);
         }
     }
a7129de5
 
     return 0;
 }
2cbaa078
 #endif
a7129de5
 
e7e2df27
 AVCodec ff_mimic_decoder = {
00c3b67b
     .name                  = "mimic",
b2bed932
     .long_name             = NULL_IF_CONFIG_SMALL("Mimic"),
00c3b67b
     .type                  = AVMEDIA_TYPE_VIDEO,
36ef5369
     .id                    = AV_CODEC_ID_MIMIC,
00c3b67b
     .priv_data_size        = sizeof(MimicContext),
     .init                  = mimic_decode_init,
     .close                 = mimic_decode_end,
     .decode                = mimic_decode_frame,
def97856
     .capabilities          = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_FRAME_THREADS,
759001c5
     .update_thread_context = ONLY_IF_THREADS_ENABLED(mimic_decode_update_thread_context),
     .init_thread_copy      = ONLY_IF_THREADS_ENABLED(mimic_init_thread_copy),
a7129de5
 };