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 *src_end;
  43     uint8_t *dstptr;
  44     uint8_t *dstbuf;
  45 } YopDecContext;
  46
  47 // These tables are taken directly from:
  48 // http://wiki.multimedia.cx/index.php?title=Psygnosis_YOP
  49
  50 /**
  51  * Lookup table for painting macroblocks. Bytes 0-2 of each entry contain
  52  * the macroblock positions to be painted (taken as (0, B0, B1, B2)).
  53  * Byte 3 contains the number of bytes consumed on the input,
  54  * equal to max(bytes 0-2) + 1.
  55  */
  56 static const uint8_t paint_lut[15][4] =
  57     {{1, 2, 3, 4}, {1, 2, 0, 3},
  58      {1, 2, 1, 3}, {1, 2, 2, 3},
  59      {1, 0, 2, 3}, {1, 0, 0, 2},
  60      {1, 0, 1, 2}, {1, 1, 2, 3},
  61      {0, 1, 2, 3}, {0, 1, 0, 2},
  62      {1, 1, 0, 2}, {0, 1, 1, 2},
  63      {0, 0, 1, 2}, {0, 0, 0, 1},
  64      {1, 1, 1, 2},
  65     };
  66
  67 /**
  68  * Lookup table for copying macroblocks. Each entry contains the respective
  69  * x and y pixel offset for the copy source.
  70  */
  71 static const int8_t motion_vector[16][2] =
  72     {{-4, -4}, {-2, -4},
  73      { 0, -4}, { 2, -4},
  74      {-4, -2}, {-4,  0},
  75      {-3, -3}, {-1, -3},
  76      { 1, -3}, { 3, -3},
  77      {-3, -1}, {-2, -2},
  78      { 0, -2}, { 2, -2},
  79      { 4, -2}, {-2,  0},
  80     };
  81
  82 static av_cold int yop_decode_init(AVCodecContext *avctx)
  83 {
  84     YopDecContext *s = avctx->priv_data;
  85     s->avctx = avctx;
  86
  87     if (avctx->width & 1 || avctx->height & 1 ||
  88         av_image_check_size(avctx->width, avctx->height, 0, avctx) < 0) {
  89         av_log(avctx, AV_LOG_ERROR, "YOP has invalid dimensions\n");
  90         return AVERROR_INVALIDDATA;
  91     }
  92
  93     if (avctx->extradata_size < 3) {
  94         av_log(avctx, AV_LOG_ERROR, "Missing or incomplete extradata.\n");
  95         return AVERROR_INVALIDDATA;
  96     }
  97
  98     avctx->pix_fmt = AV_PIX_FMT_PAL8;
  99
 100     s->num_pal_colors = avctx->extradata[0];
 101     s->first_color[0] = avctx->extradata[1];
 102     s->first_color[1] = avctx->extradata[2];
 103
 104     if (s->num_pal_colors + s->first_color[0] > 256 ||
 105         s->num_pal_colors + s->first_color[1] > 256) {
 106         av_log(avctx, AV_LOG_ERROR,
 107                "YOP: palette parameters invalid, header probably corrupt\n");
 108         return AVERROR_INVALIDDATA;
 109     }
 110
 111     return 0;
 112 }
 113
 114 static av_cold int yop_decode_close(AVCodecContext *avctx)
 115 {
 116     YopDecContext *s = avctx->priv_data;
 117     if (s->frame.data[0])
 118         avctx->release_buffer(avctx, &s->frame);
 119     return 0;
 120 }
 121
 122 /**
 123  * Paint a macroblock using the pattern in paint_lut.
 124  * @param s codec context
 125  * @param tag the tag that was in the nibble
 126  */
 127 static int yop_paint_block(YopDecContext *s, int tag)
 128 {
 129     if (s->src_end - s->srcptr < paint_lut[tag][3]) {
 130         av_log(s->avctx, AV_LOG_ERROR, "Packet too small.\n");
 131         return AVERROR_INVALIDDATA;
 132     }
 133
 134     s->dstptr[0]                        = s->srcptr[0];
 135     s->dstptr[1]                        = s->srcptr[paint_lut[tag][0]];
 136     s->dstptr[s->frame.linesize[0]]     = s->srcptr[paint_lut[tag][1]];
 137     s->dstptr[s->frame.linesize[0] + 1] = s->srcptr[paint_lut[tag][2]];
 138
 139     // The number of src bytes consumed is in the last part of the lut entry.
 140     s->srcptr += paint_lut[tag][3];
 141     return 0;
 142 }
 143
 144 /**
 145  * Copy a previously painted macroblock to the current_block.
 146  * @param copy_tag the tag that was in the nibble
 147  */
 148 static int yop_copy_previous_block(YopDecContext *s, int copy_tag)
 149 {
 150     uint8_t *bufptr;
 151
 152     // Calculate position for the copy source
 153     bufptr = s->dstptr + motion_vector[copy_tag][0] +
 154              s->frame.linesize[0] * motion_vector[copy_tag][1];
 155     if (bufptr < s->dstbuf) {
 156         av_log(s->avctx, AV_LOG_ERROR,
 157                "YOP: cannot decode, file probably corrupt\n");
 158         return AVERROR_INVALIDDATA;
 159     }
 160
 161     s->dstptr[0]                        = bufptr[0];
 162     s->dstptr[1]                        = bufptr[1];
 163     s->dstptr[s->frame.linesize[0]]     = bufptr[s->frame.linesize[0]];
 164     s->dstptr[s->frame.linesize[0] + 1] = bufptr[s->frame.linesize[0] + 1];
 165
 166     return 0;
 167 }
 168
 169 /**
 170  * Return the next nibble in sequence, consuming a new byte on the input
 171  * only if necessary.
 172  */
 173 static uint8_t yop_get_next_nibble(YopDecContext *s)
 174 {
 175     int ret;
 176
 177     if (s->low_nibble) {
 178         ret           = *s->low_nibble & 0xf;
 179         s->low_nibble = NULL;
 180     }else {
 181         s->low_nibble = s->srcptr++;
 182         ret           = *s->low_nibble >> 4;
 183     }
 184     return ret;
 185 }
 186
 187 static int yop_decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
 188                             AVPacket *avpkt)
 189 {
 190     YopDecContext *s = avctx->priv_data;
 191     int tag, firstcolor, is_odd_frame;
 192     int ret, i, x, y;
 193     uint32_t *palette;
 194
 195     if (avpkt->size < 4 + 3 * s->num_pal_colors) {
 196         av_log(avctx, AV_LOG_ERROR, "Packet too small.\n");
 197         return AVERROR_INVALIDDATA;
 198     }
 199
 200     if (s->frame.data[0])
 201         avctx->release_buffer(avctx, &s->frame);
 202
 203     ret = ff_get_buffer(avctx, &s->frame);
 204     if (ret < 0) {
 205         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
 206         return ret;
 207     }
 208
 209     if (!avctx->frame_number)
 210         memset(s->frame.data[1], 0, AVPALETTE_SIZE);
 211
 212     s->dstbuf     = s->frame.data[0];
 213     s->dstptr     = s->frame.data[0];
 214     s->srcptr     = avpkt->data + 4;
 215     s->src_end    = avpkt->data + avpkt->size;
 216     s->low_nibble = NULL;
 217
 218     is_odd_frame = avpkt->data[0];
 219     firstcolor   = s->first_color[is_odd_frame];
 220     palette      = (uint32_t *)s->frame.data[1];
 221
 222     for (i = 0; i < s->num_pal_colors; i++, s->srcptr += 3)
 223         palette[i + firstcolor] = (s->srcptr[0] << 18) |
 224                                   (s->srcptr[1] << 10) |
 225                                   (s->srcptr[2] << 2);
 226
 227     s->frame.palette_has_changed = 1;
 228
 229     for (y = 0; y < avctx->height; y += 2) {
 230         for (x = 0; x < avctx->width; x += 2) {
 231             if (s->srcptr - avpkt->data >= avpkt->size) {
 232                 av_log(avctx, AV_LOG_ERROR, "Packet too small.\n");
 233                 return AVERROR_INVALIDDATA;
 234             }
 235
 236             tag = yop_get_next_nibble(s);
 237
 238             if (tag != 0xf) {
 239                 ret = yop_paint_block(s, tag);
 240                 if (ret < 0)
 241                     return ret;
 242             } else {
 243                 tag = yop_get_next_nibble(s);
 244                 ret = yop_copy_previous_block(s, tag);
 245                 if (ret < 0) {
 246                     avctx->release_buffer(avctx, &s->frame);
 247                     return ret;
 248                 }
 249             }
 250             s->dstptr += 2;
 251         }
 252         s->dstptr += 2*s->frame.linesize[0] - x;
 253     }
 254
 255     *got_frame = 1;
 256     *(AVFrame *) data = s->frame;
 257     return avpkt->size;
 258 }
 259
 260 AVCodec ff_yop_decoder = {
 261     .name           = "yop",
 262     .type           = AVMEDIA_TYPE_VIDEO,
 263     .id             = AV_CODEC_ID_YOP,
 264     .priv_data_size = sizeof(YopDecContext),
 265     .init           = yop_decode_init,
 266     .close          = yop_decode_close,
 267     .decode         = yop_decode_frame,
 268     .long_name      = NULL_IF_CONFIG_SMALL("Psygnosis YOP Video"),
 269     .capabilities   = CODEC_CAP_DR1,
 270 };