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 FFmpeg.
   9  *
  10  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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
  31 typedef struct YopDecContext {
  32     AVFrame frame;
  33     AVCodecContext *avctx;
  34
  35     int num_pal_colors;
  36     int first_color[2];
  37     int frame_data_length;
  38     int row_pos;
  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 -1;
  90     }
  91
  92     avctx->pix_fmt = PIX_FMT_PAL8;
  93
  94     avcodec_get_frame_defaults(&s->frame);
  95     s->num_pal_colors = avctx->extradata[0];
  96     s->first_color[0] = avctx->extradata[1];
  97     s->first_color[1] = avctx->extradata[2];
  98
  99     if (s->num_pal_colors + s->first_color[0] > 256 ||
 100         s->num_pal_colors + s->first_color[1] > 256) {
 101         av_log(avctx, AV_LOG_ERROR,
 102                "YOP: palette parameters invalid, header probably corrupt\n");
 103         return AVERROR_INVALIDDATA;
 104     }
 105
 106     return 0;
 107 }
 108
 109 static av_cold int yop_decode_close(AVCodecContext *avctx)
 110 {
 111     YopDecContext *s = avctx->priv_data;
 112     if (s->frame.data[0])
 113         avctx->release_buffer(avctx, &s->frame);
 114     return 0;
 115 }
 116
 117 /**
 118  * Paint a macroblock using the pattern in paint_lut.
 119  * @param s codec context
 120  * @param tag the tag that was in the nibble
 121  */
 122 static void yop_paint_block(YopDecContext *s, int tag)
 123 {
 124     s->dstptr[0]                        = s->srcptr[0];
 125     s->dstptr[1]                        = s->srcptr[paint_lut[tag][0]];
 126     s->dstptr[s->frame.linesize[0]]     = s->srcptr[paint_lut[tag][1]];
 127     s->dstptr[s->frame.linesize[0] + 1] = s->srcptr[paint_lut[tag][2]];
 128
 129     // The number of src bytes consumed is in the last part of the lut entry.
 130     s->srcptr += paint_lut[tag][3];
 131 }
 132
 133 /**
 134  * Copy a previously painted macroblock to the current_block.
 135  * @param copy_tag the tag that was in the nibble
 136  */
 137 static int yop_copy_previous_block(YopDecContext *s, int copy_tag)
 138 {
 139     uint8_t *bufptr;
 140
 141     // Calculate position for the copy source
 142     bufptr = s->dstptr + motion_vector[copy_tag][0] +
 143              s->frame.linesize[0] * motion_vector[copy_tag][1];
 144     if (bufptr < s->dstbuf) {
 145         av_log(s->avctx, AV_LOG_ERROR,
 146                "YOP: cannot decode, file probably corrupt\n");
 147         return AVERROR_INVALIDDATA;
 148     }
 149
 150     s->dstptr[0]                        = bufptr[0];
 151     s->dstptr[1]                        = bufptr[1];
 152     s->dstptr[s->frame.linesize[0]]     = bufptr[s->frame.linesize[0]];
 153     s->dstptr[s->frame.linesize[0] + 1] = bufptr[s->frame.linesize[0] + 1];
 154
 155     return 0;
 156 }
 157
 158 /**
 159  * Return the next nibble in sequence, consuming a new byte on the input
 160  * only if necessary.
 161  */
 162 static uint8_t yop_get_next_nibble(YopDecContext *s)
 163 {
 164     int ret;
 165
 166     if (s->low_nibble) {
 167         ret           = *s->low_nibble & 0xf;
 168         s->low_nibble = NULL;
 169     }else {
 170         s->low_nibble = s->srcptr++;
 171         ret           = *s->low_nibble >> 4;
 172     }
 173     return ret;
 174 }
 175
 176 /**
 177  * Take s->dstptr to the next macroblock in sequence.
 178  */
 179 static void yop_next_macroblock(YopDecContext *s)
 180 {
 181     // If we are advancing to the next row of macroblocks
 182     if (s->row_pos == s->frame.linesize[0] - 2) {
 183         s->dstptr  += s->frame.linesize[0];
 184         s->row_pos =  0;
 185     }else {
 186         s->row_pos += 2;
 187     }
 188     s->dstptr += 2;
 189 }
 190
 191 static int yop_decode_frame(AVCodecContext *avctx, void *data, int *data_size,
 192                             AVPacket *avpkt)
 193 {
 194     YopDecContext *s = avctx->priv_data;
 195     int tag, firstcolor, is_odd_frame;
 196     int ret, i;
 197     uint32_t *palette;
 198
 199     if (s->frame.data[0])
 200         avctx->release_buffer(avctx, &s->frame);
 201
 202     ret = avctx->get_buffer(avctx, &s->frame);
 203     if (ret < 0) {
 204         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
 205         return ret;
 206     }
 207
 208     s->frame.linesize[0] = avctx->width;
 209
 210     s->dstbuf     = s->frame.data[0];
 211     s->dstptr     = s->frame.data[0];
 212     s->srcptr     = avpkt->data + 4;
 213     s->row_pos    = 0;
 214     s->low_nibble = NULL;
 215
 216     is_odd_frame = avpkt->data[0];
 217     firstcolor   = s->first_color[is_odd_frame];
 218     palette      = (uint32_t *)s->frame.data[1];
 219
 220     for (i = 0; i < s->num_pal_colors; i++, s->srcptr += 3) {
 221         palette[i + firstcolor] = (s->srcptr[0] << 18) |
 222                                   (s->srcptr[1] << 10) |
 223                                   (s->srcptr[2] << 2);
 224         palette[i + firstcolor] |= 0xFF << 24 |
 225                                    (palette[i + firstcolor] >> 6) & 0x30303;
 226     }
 227
 228     s->frame.palette_has_changed = 1;
 229
 230     while (s->dstptr - s->dstbuf <
 231            avctx->width * avctx->height &&
 232            s->srcptr - avpkt->data < avpkt->size) {
 233
 234         tag = yop_get_next_nibble(s);
 235
 236         if (tag != 0xf) {
 237             yop_paint_block(s, tag);
 238         }else {
 239             tag = yop_get_next_nibble(s);
 240             ret = yop_copy_previous_block(s, tag);
 241             if (ret < 0) {
 242                 avctx->release_buffer(avctx, &s->frame);
 243                 return ret;
 244             }
 245         }
 246         yop_next_macroblock(s);
 247     }
 248
 249     *data_size        = sizeof(AVFrame);
 250     *(AVFrame *) data = s->frame;
 251     return avpkt->size;
 252 }
 253
 254 AVCodec ff_yop_decoder = {
 255     .name           = "yop",
 256     .type           = AVMEDIA_TYPE_VIDEO,
 257     .id             = CODEC_ID_YOP,
 258     .priv_data_size = sizeof(YopDecContext),
 259     .init           = yop_decode_init,
 260     .close          = yop_decode_close,
 261     .decode         = yop_decode_frame,
 262     .long_name = NULL_IF_CONFIG_SMALL("Psygnosis YOP Video"),
 263 };