libavcodec/pafvideo.c
7de4a165
 /*
b0633f83
  * Packed Animation File video decoder
7de4a165
  * Copyright (c) 2012 Paul B Mahol
  *
  * 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
  */
 
70daeacd
 #include "libavutil/imgutils.h"
 
7de4a165
 #include "avcodec.h"
70daeacd
 #include "bytestream.h"
b0583016
 #include "copy_block.h"
874c5b02
 #include "internal.h"
70daeacd
 
874c5b02
 
70daeacd
 static const uint8_t block_sequences[16][8] = {
7de4a165
     { 0, 0, 0, 0, 0, 0, 0, 0 },
     { 2, 0, 0, 0, 0, 0, 0, 0 },
     { 5, 7, 0, 0, 0, 0, 0, 0 },
     { 5, 0, 0, 0, 0, 0, 0, 0 },
     { 6, 0, 0, 0, 0, 0, 0, 0 },
     { 5, 7, 5, 7, 0, 0, 0, 0 },
     { 5, 7, 5, 0, 0, 0, 0, 0 },
     { 5, 7, 6, 0, 0, 0, 0, 0 },
     { 5, 5, 0, 0, 0, 0, 0, 0 },
     { 3, 0, 0, 0, 0, 0, 0, 0 },
     { 6, 6, 0, 0, 0, 0, 0, 0 },
     { 2, 4, 0, 0, 0, 0, 0, 0 },
     { 2, 4, 5, 7, 0, 0, 0, 0 },
     { 2, 4, 5, 0, 0, 0, 0, 0 },
     { 2, 4, 6, 0, 0, 0, 0, 0 },
16ddc58b
     { 2, 4, 5, 7, 5, 7, 0, 0 },
7de4a165
 };
 
 typedef struct PAFVideoDecContext {
1c11ab82
     AVFrame  *pic;
7de4a165
     GetByteContext gb;
 
70daeacd
     int width;
     int height;
 
     int current_frame;
7de4a165
     uint8_t *frame[4];
70daeacd
     int frame_size;
     int video_size;
7de4a165
 
     uint8_t *opcodes;
 } PAFVideoDecContext;
 
70daeacd
 static av_cold int paf_video_close(AVCodecContext *avctx)
1c11ab82
 {
     PAFVideoDecContext *c = avctx->priv_data;
     int i;
 
     av_frame_free(&c->pic);
 
     for (i = 0; i < 4; i++)
         av_freep(&c->frame[i]);
 
     return 0;
 }
 
70daeacd
 static av_cold int paf_video_init(AVCodecContext *avctx)
7de4a165
 {
     PAFVideoDecContext *c = avctx->priv_data;
     int i;
 
70daeacd
     c->width  = avctx->width;
     c->height = avctx->height;
 
7de4a165
     if (avctx->height & 3 || avctx->width & 3) {
70daeacd
         av_log(avctx, AV_LOG_ERROR,
                "width %d and height %d must be multiplie of 4.\n",
                avctx->width, avctx->height);
7de4a165
         return AVERROR_INVALIDDATA;
     }
 
ac627b3d
     avctx->pix_fmt = AV_PIX_FMT_PAL8;
7de4a165
 
1c11ab82
     c->pic = av_frame_alloc();
     if (!c->pic)
         return AVERROR(ENOMEM);
 
70daeacd
     c->frame_size = avctx->width * FFALIGN(avctx->height, 256);
     c->video_size = avctx->width * avctx->height;
7de4a165
     for (i = 0; i < 4; i++) {
         c->frame[i] = av_mallocz(c->frame_size);
1c11ab82
         if (!c->frame[i]) {
70daeacd
             paf_video_close(avctx);
7de4a165
             return AVERROR(ENOMEM);
1c11ab82
         }
7de4a165
     }
 
     return 0;
 }
 
70daeacd
 static void read4x4block(PAFVideoDecContext *c, uint8_t *dst, int width)
7de4a165
 {
     int i;
 
     for (i = 0; i < 4; i++) {
         bytestream2_get_buffer(&c->gb, dst, 4);
70daeacd
         dst += width;
7de4a165
     }
 }
 
70daeacd
 static void copy_color_mask(uint8_t *dst, int width, uint8_t mask, uint8_t color)
7de4a165
 {
     int i;
 
     for (i = 0; i < 4; i++) {
70daeacd
         if (mask & (1 << 7 - i))
7de4a165
             dst[i] = color;
70daeacd
         if (mask & (1 << 3 - i))
             dst[width + i] = color;
7de4a165
     }
 }
 
70daeacd
 static void copy_src_mask(uint8_t *dst, int width, uint8_t mask, const uint8_t *src)
7de4a165
 {
     int i;
 
     for (i = 0; i < 4; i++) {
70daeacd
         if (mask & (1 << 7 - i))
7de4a165
             dst[i] = src[i];
70daeacd
         if (mask & (1 << 3 - i))
             dst[width + i] = src[width + i];
7de4a165
     }
 }
 
70daeacd
 static void set_src_position(PAFVideoDecContext *c,
                              const uint8_t **p,
                              const uint8_t **pend)
 {
     int val  = bytestream2_get_be16(&c->gb);
     int page = val >> 14;
     int x    = (val & 0x7F);
     int y    = ((val >> 7) & 0x7F);
 
     *p    = c->frame[page] + x * 2 + y * 2 * c->width;
     *pend = c->frame[page] + c->frame_size;
 }
 
 static int decode_0(PAFVideoDecContext *c, uint8_t *pkt, uint8_t code)
7de4a165
 {
     uint32_t opcode_size, offset;
70daeacd
     uint8_t *dst, *dend, mask = 0, color = 0;
7de4a165
     const uint8_t *src, *send, *opcodes;
70daeacd
     int i, j, op = 0;
7de4a165
 
     i = bytestream2_get_byte(&c->gb);
     if (i) {
         if (code & 0x10) {
             int align;
 
             align = bytestream2_tell(&c->gb) & 3;
             if (align)
                 bytestream2_skip(&c->gb, 4 - align);
         }
         do {
70daeacd
             int page, val, x, y;
             val    = bytestream2_get_be16(&c->gb);
             page   = val >> 14;
             x      = (val & 0x7F) * 2;
             y      = ((val >> 7) & 0x7F) * 2;
             dst    = c->frame[page] + x + y * c->width;
             dend   = c->frame[page] + c->frame_size;
             offset = (x & 0x7F) * 2;
7de4a165
             j      = bytestream2_get_le16(&c->gb) + offset;
9c85329c
             if (bytestream2_get_bytes_left(&c->gb) < (j - offset) * 16)
                 return AVERROR_INVALIDDATA;
7de4a165
             do {
                 offset++;
70daeacd
                 if (dst + 3 * c->width + 4 > dend)
7de4a165
                     return AVERROR_INVALIDDATA;
70daeacd
                 read4x4block(c, dst, c->width);
7de4a165
                 if ((offset & 0x3F) == 0)
70daeacd
                     dst += c->width * 3;
7de4a165
                 dst += 4;
             } while (offset < j);
         } while (--i);
     }
 
bd70a527
     dst  = c->frame[c->current_frame];
     dend = c->frame[c->current_frame] + c->frame_size;
7de4a165
     do {
70daeacd
         set_src_position(c, &src, &send);
         if ((src + 3 * c->width + 4 > send) ||
9c85329c
             (dst + 3 * c->width + 4 > dend) ||
             bytestream2_get_bytes_left(&c->gb) < 4)
7de4a165
             return AVERROR_INVALIDDATA;
70daeacd
         copy_block4(dst, src, c->width, c->width, 4);
7de4a165
         i++;
         if ((i & 0x3F) == 0)
70daeacd
             dst += c->width * 3;
7de4a165
         dst += 4;
     } while (i < c->video_size / 16);
 
     opcode_size = bytestream2_get_le16(&c->gb);
     bytestream2_skip(&c->gb, 2);
 
     if (bytestream2_get_bytes_left(&c->gb) < opcode_size)
         return AVERROR_INVALIDDATA;
 
     opcodes = pkt + bytestream2_tell(&c->gb);
     bytestream2_skipu(&c->gb, opcode_size);
 
     dst = c->frame[c->current_frame];
 
70daeacd
     for (i = 0; i < c->height; i += 4, dst += c->width * 3)
         for (j = 0; j < c->width; j += 4, dst += 4) {
7de4a165
             int opcode, k = 0;
70daeacd
             if (op > opcode_size)
7de4a165
                 return AVERROR_INVALIDDATA;
             if (j & 4) {
70daeacd
                 opcode = opcodes[op] & 15;
                 op++;
7de4a165
             } else {
70daeacd
                 opcode = opcodes[op] >> 4;
7de4a165
             }
 
             while (block_sequences[opcode][k]) {
70daeacd
                 offset = c->width * 2;
7de4a165
                 code   = block_sequences[opcode][k++];
 
                 switch (code) {
                 case 2:
                     offset = 0;
                 case 3:
70daeacd
                     color = bytestream2_get_byte(&c->gb);
7de4a165
                 case 4:
70daeacd
                     mask = bytestream2_get_byte(&c->gb);
                     copy_color_mask(dst + offset, c->width, mask, color);
7de4a165
                     break;
                 case 5:
                     offset = 0;
                 case 6:
70daeacd
                     set_src_position(c, &src, &send);
7de4a165
                 case 7:
70daeacd
                     if (src + offset + c->width + 4 > send)
7de4a165
                         return AVERROR_INVALIDDATA;
                     mask = bytestream2_get_byte(&c->gb);
70daeacd
                     copy_src_mask(dst + offset, c->width, mask, src + offset);
7de4a165
                     break;
                 }
             }
         }
 
     return 0;
 }
 
70daeacd
 static int paf_video_decode(AVCodecContext *avctx, void *data,
                             int *got_frame, AVPacket *pkt)
7de4a165
 {
     PAFVideoDecContext *c = avctx->priv_data;
70daeacd
     uint8_t code, *dst, *end;
7de4a165
     int i, frame, ret;
 
faa5a218
     if (pkt->size < 2)
         return AVERROR_INVALIDDATA;
7de4a165
 
     bytestream2_init(&c->gb, pkt->data, pkt->size);
 
     code = bytestream2_get_byte(&c->gb);
c4360559
     if ((code & 0xF) > 4 || (code & 0xF) == 3) {
faa5a218
         avpriv_request_sample(avctx, "unknown/invalid code");
         return AVERROR_INVALIDDATA;
     }
 
     if ((ret = ff_reget_buffer(avctx, c->pic)) < 0)
         return ret;
 
70daeacd
     if (code & 0x20) {  // frame is keyframe
7de4a165
         for (i = 0; i < 4; i++)
             memset(c->frame[i], 0, c->frame_size);
 
1c11ab82
         memset(c->pic->data[1], 0, AVPALETTE_SIZE);
70daeacd
         c->current_frame  = 0;
1c11ab82
         c->pic->key_frame = 1;
         c->pic->pict_type = AV_PICTURE_TYPE_I;
7de4a165
     } else {
1c11ab82
         c->pic->key_frame = 0;
         c->pic->pict_type = AV_PICTURE_TYPE_P;
7de4a165
     }
 
70daeacd
     if (code & 0x40) {  // palette update
1c11ab82
         uint32_t *out = (uint32_t *)c->pic->data[1];
7de4a165
         int index, count;
 
         index = bytestream2_get_byte(&c->gb);
         count = bytestream2_get_byte(&c->gb) + 1;
 
456f0c64
         if (index + count > 256)
7de4a165
             return AVERROR_INVALIDDATA;
70daeacd
         if (bytestream2_get_bytes_left(&c->gb) < 3 * count)
7de4a165
             return AVERROR_INVALIDDATA;
 
         out += index;
         for (i = 0; i < count; i++) {
             unsigned r, g, b;
 
             r = bytestream2_get_byteu(&c->gb);
             r = r << 2 | r >> 4;
             g = bytestream2_get_byteu(&c->gb);
             g = g << 2 | g >> 4;
             b = bytestream2_get_byteu(&c->gb);
             b = b << 2 | b >> 4;
70daeacd
             *out++ = (0xFFU << 24) | (r << 16) | (g << 8) | b;
7de4a165
         }
1c11ab82
         c->pic->palette_has_changed = 1;
7de4a165
     }
 
     switch (code & 0x0F) {
     case 0:
70daeacd
         /* Block-based motion compensation using 4x4 blocks with either
          * horizontal or vertical vectors; might incorporate VQ as well. */
         if ((ret = decode_0(c, pkt->data, code)) < 0)
7de4a165
             return ret;
         break;
     case 1:
70daeacd
         /* Uncompressed data. This mode specifies that (width * height) bytes
          * should be copied directly from the encoded buffer into the output. */
7de4a165
         dst = c->frame[c->current_frame];
70daeacd
         // possibly chunk length data
7de4a165
         bytestream2_skip(&c->gb, 2);
         if (bytestream2_get_bytes_left(&c->gb) < c->video_size)
             return AVERROR_INVALIDDATA;
         bytestream2_get_bufferu(&c->gb, dst, c->video_size);
         break;
     case 2:
70daeacd
         /* Copy reference frame: Consume the next byte in the stream as the
          * reference frame (which should be 0, 1, 2, or 3, and should not be
          * the same as the current frame number). */
7de4a165
         frame = bytestream2_get_byte(&c->gb);
         if (frame > 3)
             return AVERROR_INVALIDDATA;
         if (frame != c->current_frame)
             memcpy(c->frame[c->current_frame], c->frame[frame], c->frame_size);
         break;
     case 4:
70daeacd
         /* Run length encoding.*/
7de4a165
         dst = c->frame[c->current_frame];
         end = dst + c->video_size;
 
         bytestream2_skip(&c->gb, 2);
 
         while (dst < end) {
             int8_t code;
             int count;
 
             if (bytestream2_get_bytes_left(&c->gb) < 2)
                 return AVERROR_INVALIDDATA;
 
             code  = bytestream2_get_byteu(&c->gb);
             count = FFABS(code) + 1;
 
             if (dst + count > end)
                 return AVERROR_INVALIDDATA;
             if (code < 0)
                 memset(dst, bytestream2_get_byteu(&c->gb), count);
             else
                 bytestream2_get_buffer(&c->gb, dst, count);
             dst += count;
         }
         break;
     default:
faa5a218
         av_assert0(0);
7de4a165
     }
 
70daeacd
     av_image_copy_plane(c->pic->data[0], c->pic->linesize[0],
                         c->frame[c->current_frame], c->width,
                         c->width, c->height);
7de4a165
 
     c->current_frame = (c->current_frame + 1) & 3;
1c11ab82
     if ((ret = av_frame_ref(data, c->pic)) < 0)
80e9e63c
         return ret;
7de4a165
 
70daeacd
     *got_frame = 1;
7de4a165
 
     return pkt->size;
 }
 
 AVCodec ff_paf_video_decoder = {
     .name           = "paf_video",
b46f1910
     .long_name      = NULL_IF_CONFIG_SMALL("Amazing Studio Packed Animation File Video"),
7de4a165
     .type           = AVMEDIA_TYPE_VIDEO,
7a72695c
     .id             = AV_CODEC_ID_PAF_VIDEO,
7de4a165
     .priv_data_size = sizeof(PAFVideoDecContext),
70daeacd
     .init           = paf_video_init,
     .close          = paf_video_close,
     .decode         = paf_video_decode,
def97856
     .capabilities   = AV_CODEC_CAP_DR1,
7de4a165
 };