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

   1 /*
   2  * Psygnosis YOP decoder
   3  *
   4  * Copyright (C) 2010 Mohamed Naufal Basheer <naufal11@gmail.com>
   5  * derived from the code by
   6  * Copyright (C) 2009 Thomas P. Higdon <thomas.p.higdon@gmail.com>
   7  *
   8  * This file is part of Libav.
   9  *
  10  * Libav is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2.1 of the License, or (at your option) any later version.
  14  *
  15  * Libav is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with Libav; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  23  */
  24
  25 #include "libavutil/intreadwrite.h"
  26 #include "libavutil/imgutils.h"
  27
  28 #include "avcodec.h"
  29 #include "get_bits.h"
  30 #include "internal.h"
  31
  32 typedef struct YopDecContext {
  33     AVFrame frame;
  34     AVCodecContext *avctx;
  35
  36     int num_pal_colors;
  37     int first_color[2];
  38     int frame_data_length;
  39
  40     uint8_t *low_nibble;
  41     uint8_t *srcptr;
  42     uint8_t *dstptr;
  43     uint8_t *dstbuf;
  44 } YopDecContext;
  45
  46 // These tables are taken directly from:
  47 // http://wiki.multimedia.cx/index.php?title=Psygnosis_YOP
  48
  49 /**
  50  * Lookup table for painting macroblocks. Bytes 0-2 of each entry contain
  51  * the macroblock positions to be painted (taken as (0, B0, B1, B2)).
  52  * Byte 3 contains the number of bytes consumed on the input,
  53  * equal to max(bytes 0-2) + 1.
  54  */
  55 static const uint8_t paint_lut[15][4] =
  56     {{1, 2, 3, 4}, {1, 2, 0, 3},
  57      {1, 2, 1, 3}, {1, 2, 2, 3},
  58      {1, 0, 2, 3}, {1, 0, 0, 2},
  59      {1, 0, 1, 2}, {1, 1, 2, 3},
  60      {0, 1, 2, 3}, {0, 1, 0, 2},
  61      {1, 1, 0, 2}, {0, 1, 1, 2},
  62      {0, 0, 1, 2}, {0, 0, 0, 1},
  63      {1, 1, 1, 2},
  64     };
  65
  66 /**
  67  * Lookup table for copying macroblocks. Each entry contains the respective
  68  * x and y pixel offset for the copy source.
  69  */
  70 static const int8_t motion_vector[16][2] =
  71     {{-4, -4}, {-2, -4},
  72      { 0, -4}, { 2, -4},
  73      {-4, -2}, {-4,  0},
  74      {-3, -3}, {-1, -3},
  75      { 1, -3}, { 3, -3},
  76      {-3, -1}, {-2, -2},
  77      { 0, -2}, { 2, -2},
  78      { 4, -2}, {-2,  0},
  79     };
  80
  81 static av_cold int yop_decode_init(AVCodecContext *avctx)
  82 {
  83     YopDecContext *s = avctx->priv_data;
  84     s->avctx = avctx;
  85
  86     if (avctx->width & 1 || avctx->height & 1 ||
  87         av_image_check_size(avctx->width, avctx->height, 0, avctx) < 0) {
  88         av_log(avctx, AV_LOG_ERROR, "YOP has invalid dimensions\n");
  89         return AVERROR_INVALIDDATA;
  90     }
  91
  92     if (avctx->extradata_size < 3) {
  93         av_log(avctx, AV_LOG_ERROR, "Missing or incomplete extradata.\n");
  94         return AVERROR_INVALIDDATA;
  95     }
  96
  97     avctx->pix_fmt = AV_PIX_FMT_PAL8;
  98
  99     s->num_pal_colors = avctx->extradata[0];
 100     s->first_color[0] = avctx->extradata[1];
 101     s->first_color[1] = avctx->extradata[2];
 102
 103     if (s->num_pal_colors + s->first_color[0] > 256 ||
 104         s->num_pal_colors + s->first_color[1] > 256) {
 105         av_log(avctx, AV_LOG_ERROR,
 106                "YOP: palette parameters invalid, header probably corrupt\n");
 107         return AVERROR_INVALIDDATA;
 108     }
 109
 110     return 0;
 111 }
 112
 113 static av_cold int yop_decode_close(AVCodecContext *avctx)
 114 {
 115     YopDecContext *s = avctx->priv_data;
 116     if (s->frame.data[0])
 117         avctx->release_buffer(avctx, &s->frame);
 118     return 0;
 119 }
 120
 121 /**
 122  * Paint a macroblock using the pattern in paint_lut.
 123  * @param s codec context
 124  * @param tag the tag that was in the nibble
 125  */
 126 static void yop_paint_block(YopDecContext *s, int tag)
 127 {
 128     s->dstptr[0]                        = s->srcptr[0];
 129     s->dstptr[1]                        = s->srcptr[paint_lut[tag][0]];
 130     s->dstptr[s->frame.linesize[0]]     = s->srcptr[paint_lut[tag][1]];
 131     s->dstptr[s->frame.linesize[0] + 1] = s->srcptr[paint_lut[tag][2]];
 132
 133     // The number of src bytes consumed is in the last part of the lut entry.
 134     s->srcptr += paint_lut[tag][3];
 135 }
 136
 137 /**
 138  * Copy a previously painted macroblock to the current_block.
 139  * @param copy_tag the tag that was in the nibble
 140  */
 141 static int yop_copy_previous_block(YopDecContext *s, int copy_tag)
 142 {
 143     uint8_t *bufptr;
 144
 145     // Calculate position for the copy source
 146     bufptr = s->dstptr + motion_vector[copy_tag][0] +
 147              s->frame.linesize[0] * motion_vector[copy_tag][1];
 148     if (bufptr < s->dstbuf) {
 149         av_log(s->avctx, AV_LOG_ERROR,
 150                "YOP: cannot decode, file probably corrupt\n");
 151         return AVERROR_INVALIDDATA;
 152     }
 153
 154     s->dstptr[0]                        = bufptr[0];
 155     s->dstptr[1]                        = bufptr[1];
 156     s->dstptr[s->frame.linesize[0]]     = bufptr[s->frame.linesize[0]];
 157     s->dstptr[s->frame.linesize[0] + 1] = bufptr[s->frame.linesize[0] + 1];
 158
 159     return 0;
 160 }
 161
 162 /**
 163  * Return the next nibble in sequence, consuming a new byte on the input
 164  * only if necessary.
 165  */
 166 static uint8_t yop_get_next_nibble(YopDecContext *s)
 167 {
 168     int ret;
 169
 170     if (s->low_nibble) {
 171         ret           = *s->low_nibble & 0xf;
 172         s->low_nibble = NULL;
 173     }else {
 174         s->low_nibble = s->srcptr++;
 175         ret           = *s->low_nibble >> 4;
 176     }
 177     return ret;
 178 }
 179
 180 static int yop_decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
 181                             AVPacket *avpkt)
 182 {
 183     YopDecContext *s = avctx->priv_data;
 184     int tag, firstcolor, is_odd_frame;
 185     int ret, i, x, y;
 186     uint32_t *palette;
 187
 188     if (s->frame.data[0])
 189         avctx->release_buffer(avctx, &s->frame);
 190
 191     ret = ff_get_buffer(avctx, &s->frame);
 192     if (ret < 0) {
 193         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
 194         return ret;
 195     }
 196
 197     s->dstbuf     = s->frame.data[0];
 198     s->dstptr     = s->frame.data[0];
 199     s->srcptr     = avpkt->data + 4;
 200     s->low_nibble = NULL;
 201
 202     is_odd_frame = avpkt->data[0];
 203     firstcolor   = s->first_color[is_odd_frame];
 204     palette      = (uint32_t *)s->frame.data[1];
 205
 206     for (i = 0; i < s->num_pal_colors; i++, s->srcptr += 3)
 207         palette[i + firstcolor] = (s->srcptr[0] << 18) |
 208                                   (s->srcptr[1] << 10) |
 209                                   (s->srcptr[2] << 2);
 210
 211     s->frame.palette_has_changed = 1;
 212
 213     for (y = 0; y < avctx->height; y += 2) {
 214         for (x = 0; x < avctx->width; x += 2) {
 215             if (s->srcptr - avpkt->data >= avpkt->size) {
 216                 av_log(avctx, AV_LOG_ERROR, "Packet too small.\n");
 217                 return AVERROR_INVALIDDATA;
 218             }
 219
 220             tag = yop_get_next_nibble(s);
 221
 222             if (tag != 0xf) {
 223                 yop_paint_block(s, tag);
 224             } else {
 225                 tag = yop_get_next_nibble(s);
 226                 ret = yop_copy_previous_block(s, tag);
 227                 if (ret < 0) {
 228                     avctx->release_buffer(avctx, &s->frame);
 229                     return ret;
 230                 }
 231             }
 232             s->dstptr += 2;
 233         }
 234         s->dstptr += 2*s->frame.linesize[0] - x;
 235     }
 236
 237     *got_frame = 1;
 238     *(AVFrame *) data = s->frame;
 239     return avpkt->size;
 240 }
 241
 242 AVCodec ff_yop_decoder = {
 243     .name           = "yop",
 244     .type           = AVMEDIA_TYPE_VIDEO,
 245     .id             = AV_CODEC_ID_YOP,
 246     .priv_data_size = sizeof(YopDecContext),
 247     .init           = yop_decode_init,
 248     .close          = yop_decode_close,
 249     .decode         = yop_decode_frame,
 250     .long_name      = NULL_IF_CONFIG_SMALL("Psygnosis YOP Video"),
 251     .capabilities   = CODEC_CAP_DR1,
 252 };