libavcodec/xan.c

   1 /*
   2  * Wing Commander/Xan Video Decoder
   3  * Copyright (C) 2003 the ffmpeg project
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * FFmpeg is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with FFmpeg; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 /**
  23  * @file libavcodec/xan.c
  24  * Xan video decoder for Wing Commander III computer game
  25  * by Mario Brito (mbrito@student.dei.uc.pt)
  26  * and Mike Melanson (melanson@pcisys.net)
  27  *
  28  * The xan_wc3 decoder outputs PAL8 data.
  29  */
  30
  31 #include <stdio.h>
  32 #include <stdlib.h>
  33 #include <string.h>
  34 #include <unistd.h>
  35
  36 #include "libavutil/intreadwrite.h"
  37 #include "avcodec.h"
  38 // for av_memcpy_backptr
  39 #include "libavutil/lzo.h"
  40
  41 typedef struct XanContext {
  42
  43     AVCodecContext *avctx;
  44     AVFrame last_frame;
  45     AVFrame current_frame;
  46
  47     const unsigned char *buf;
  48     int size;
  49
  50     /* scratch space */
  51     unsigned char *buffer1;
  52     int buffer1_size;
  53     unsigned char *buffer2;
  54     int buffer2_size;
  55
  56     int frame_size;
  57
  58 } XanContext;
  59
  60 static av_cold int xan_decode_init(AVCodecContext *avctx)
  61 {
  62     XanContext *s = avctx->priv_data;
  63
  64     s->avctx = avctx;
  65     s->frame_size = 0;
  66
  67     if ((avctx->codec->id == CODEC_ID_XAN_WC3) &&
  68         (s->avctx->palctrl == NULL)) {
  69         av_log(avctx, AV_LOG_ERROR, " WC3 Xan video: palette expected.\n");
  70         return -1;
  71     }
  72
  73     avctx->pix_fmt = PIX_FMT_PAL8;
  74
  75     if(avcodec_check_dimensions(avctx, avctx->width, avctx->height))
  76         return -1;
  77
  78     s->buffer1_size = avctx->width * avctx->height;
  79     s->buffer1 = av_malloc(s->buffer1_size);
  80     s->buffer2_size = avctx->width * avctx->height;
  81     s->buffer2 = av_malloc(s->buffer2_size + 12);
  82     if (!s->buffer1 || !s->buffer2)
  83         return -1;
  84
  85     return 0;
  86 }
  87
  88 static int xan_huffman_decode(unsigned char *dest, const unsigned char *src,
  89     int dest_len)
  90 {
  91     unsigned char byte = *src++;
  92     unsigned char ival = byte + 0x16;
  93     const unsigned char * ptr = src + byte*2;
  94     unsigned char val = ival;
  95     int counter = 0;
  96     unsigned char *dest_end = dest + dest_len;
  97
  98     unsigned char bits = *ptr++;
  99
 100     while ( val != 0x16 ) {
 101         if ( (1 << counter) & bits )
 102             val = src[byte + val - 0x17];
 103         else
 104             val = src[val - 0x17];
 105
 106         if ( val < 0x16 ) {
 107             if (dest + 1 > dest_end)
 108                 return 0;
 109             *dest++ = val;
 110             val = ival;
 111         }
 112
 113         if (counter++ == 7) {
 114             counter = 0;
 115             bits = *ptr++;
 116         }
 117     }
 118
 119     return 0;
 120 }
 121
 122 /**
 123  * unpack simple compression
 124  *
 125  * @param dest destination buffer of dest_len, must be sufficiently padded for av_memcpy_backptr
 126  */
 127 static void xan_unpack(unsigned char *dest, const unsigned char *src, int dest_len)
 128 {
 129     unsigned char opcode;
 130     int size;
 131     int offset;
 132     int byte1, byte2, byte3;
 133     unsigned char *dest_end = dest + dest_len;
 134
 135     for (;;) {
 136         opcode = *src++;
 137
 138         if ( (opcode & 0x80) == 0 ) {
 139
 140             offset = *src++;
 141
 142             size = opcode & 3;
 143             if (dest + size > dest_end)
 144                 return;
 145             memcpy(dest, src, size);  dest += size;  src += size;
 146
 147             size = ((opcode & 0x1c) >> 2) + 3;
 148             if (dest + size > dest_end)
 149                 return;
 150             av_memcpy_backptr(dest, ((opcode & 0x60) << 3) + offset + 1, size);
 151             dest += size;
 152
 153         } else if ( (opcode & 0x40) == 0 ) {
 154
 155             byte1 = *src++;
 156             byte2 = *src++;
 157
 158             size = byte1 >> 6;
 159             if (dest + size > dest_end)
 160                 return;
 161             memcpy(dest, src, size);  dest += size;  src += size;
 162
 163             size = (opcode & 0x3f) + 4;
 164             if (dest + size > dest_end)
 165                 return;
 166             av_memcpy_backptr(dest, ((byte1 & 0x3f) << 8) + byte2 + 1, size);
 167             dest += size;
 168
 169         } else if ( (opcode & 0x20) == 0 ) {
 170
 171             byte1 = *src++;
 172             byte2 = *src++;
 173             byte3 = *src++;
 174
 175             size = opcode & 3;
 176             if (dest + size > dest_end)
 177                 return;
 178             memcpy(dest, src, size);  dest += size;  src += size;
 179
 180             size = byte3 + 5 + ((opcode & 0xc) << 6);
 181             if (dest + size > dest_end)
 182                 return;
 183             av_memcpy_backptr(dest,
 184                 ((opcode & 0x10) << 12) + 1 + (byte1 << 8) + byte2,
 185                 size);
 186             dest += size;
 187         } else {
 188             size = ((opcode & 0x1f) << 2) + 4;
 189
 190             if (size > 0x70)
 191                 break;
 192
 193             if (dest + size > dest_end)
 194                 return;
 195             memcpy(dest, src, size);  dest += size;  src += size;
 196         }
 197     }
 198
 199     size = opcode & 3;
 200     memcpy(dest, src, size);  dest += size;  src += size;
 201 }
 202
 203 static inline void xan_wc3_output_pixel_run(XanContext *s,
 204     const unsigned char *pixel_buffer, int x, int y, int pixel_count)
 205 {
 206     int stride;
 207     int line_inc;
 208     int index;
 209     int current_x;
 210     int width = s->avctx->width;
 211     unsigned char *palette_plane;
 212
 213     palette_plane = s->current_frame.data[0];
 214     stride = s->current_frame.linesize[0];
 215     line_inc = stride - width;
 216     index = y * stride + x;
 217     current_x = x;
 218     while((pixel_count--) && (index < s->frame_size)) {
 219
 220         /* don't do a memcpy() here; keyframes generally copy an entire
 221          * frame of data and the stride needs to be accounted for */
 222         palette_plane[index++] = *pixel_buffer++;
 223
 224         current_x++;
 225         if (current_x >= width) {
 226             index += line_inc;
 227             current_x = 0;
 228         }
 229     }
 230 }
 231
 232 static inline void xan_wc3_copy_pixel_run(XanContext *s,
 233     int x, int y, int pixel_count, int motion_x, int motion_y)
 234 {
 235     int stride;
 236     int line_inc;
 237     int curframe_index, prevframe_index;
 238     int curframe_x, prevframe_x;
 239     int width = s->avctx->width;
 240     unsigned char *palette_plane, *prev_palette_plane;
 241
 242     palette_plane = s->current_frame.data[0];
 243     prev_palette_plane = s->last_frame.data[0];
 244     stride = s->current_frame.linesize[0];
 245     line_inc = stride - width;
 246     curframe_index = y * stride + x;
 247     curframe_x = x;
 248     prevframe_index = (y + motion_y) * stride + x + motion_x;
 249     prevframe_x = x + motion_x;
 250     while((pixel_count--) && (curframe_index < s->frame_size)) {
 251
 252         palette_plane[curframe_index++] =
 253             prev_palette_plane[prevframe_index++];
 254
 255         curframe_x++;
 256         if (curframe_x >= width) {
 257             curframe_index += line_inc;
 258             curframe_x = 0;
 259         }
 260
 261         prevframe_x++;
 262         if (prevframe_x >= width) {
 263             prevframe_index += line_inc;
 264             prevframe_x = 0;
 265         }
 266     }
 267 }
 268
 269 static void xan_wc3_decode_frame(XanContext *s) {
 270
 271     int width = s->avctx->width;
 272     int height = s->avctx->height;
 273     int total_pixels = width * height;
 274     unsigned char opcode;
 275     unsigned char flag = 0;
 276     int size = 0;
 277     int motion_x, motion_y;
 278     int x, y;
 279
 280     unsigned char *opcode_buffer = s->buffer1;
 281     int opcode_buffer_size = s->buffer1_size;
 282     const unsigned char *imagedata_buffer = s->buffer2;
 283
 284     /* pointers to segments inside the compressed chunk */
 285     const unsigned char *huffman_segment;
 286     const unsigned char *size_segment;
 287     const unsigned char *vector_segment;
 288     const unsigned char *imagedata_segment;
 289
 290     huffman_segment =   s->buf + AV_RL16(&s->buf[0]);
 291     size_segment =      s->buf + AV_RL16(&s->buf[2]);
 292     vector_segment =    s->buf + AV_RL16(&s->buf[4]);
 293     imagedata_segment = s->buf + AV_RL16(&s->buf[6]);
 294
 295     xan_huffman_decode(opcode_buffer, huffman_segment, opcode_buffer_size);
 296
 297     if (imagedata_segment[0] == 2)
 298         xan_unpack(s->buffer2, &imagedata_segment[1], s->buffer2_size);
 299     else
 300         imagedata_buffer = &imagedata_segment[1];
 301
 302     /* use the decoded data segments to build the frame */
 303     x = y = 0;
 304     while (total_pixels) {
 305
 306         opcode = *opcode_buffer++;
 307         size = 0;
 308
 309         switch (opcode) {
 310
 311         case 0:
 312             flag ^= 1;
 313             continue;
 314
 315         case 1:
 316         case 2:
 317         case 3:
 318         case 4:
 319         case 5:
 320         case 6:
 321         case 7:
 322         case 8:
 323             size = opcode;
 324             break;
 325
 326         case 12:
 327         case 13:
 328         case 14:
 329         case 15:
 330         case 16:
 331         case 17:
 332         case 18:
 333             size += (opcode - 10);
 334             break;
 335
 336         case 9:
 337         case 19:
 338             size = *size_segment++;
 339             break;
 340
 341         case 10:
 342         case 20:
 343             size = AV_RB16(&size_segment[0]);
 344             size_segment += 2;
 345             break;
 346
 347         case 11:
 348         case 21:
 349             size = AV_RB24(size_segment);
 350             size_segment += 3;
 351             break;
 352         }
 353
 354         if (opcode < 12) {
 355             flag ^= 1;
 356             if (flag) {
 357                 /* run of (size) pixels is unchanged from last frame */
 358                 xan_wc3_copy_pixel_run(s, x, y, size, 0, 0);
 359             } else {
 360                 /* output a run of pixels from imagedata_buffer */
 361                 xan_wc3_output_pixel_run(s, imagedata_buffer, x, y, size);
 362                 imagedata_buffer += size;
 363             }
 364         } else {
 365             /* run-based motion compensation from last frame */
 366             motion_x = (*vector_segment >> 4) & 0xF;
 367             motion_y = *vector_segment & 0xF;
 368             vector_segment++;
 369
 370             /* sign extension */
 371             if (motion_x & 0x8)
 372                 motion_x |= 0xFFFFFFF0;
 373             if (motion_y & 0x8)
 374                 motion_y |= 0xFFFFFFF0;
 375
 376             /* copy a run of pixels from the previous frame */
 377             xan_wc3_copy_pixel_run(s, x, y, size, motion_x, motion_y);
 378
 379             flag = 0;
 380         }
 381
 382         /* coordinate accounting */
 383         total_pixels -= size;
 384         while (size) {
 385             if (x + size >= width) {
 386                 y++;
 387                 size -= (width - x);
 388                 x = 0;
 389             } else {
 390                 x += size;
 391                 size = 0;
 392             }
 393         }
 394     }
 395 }
 396
 397 static void xan_wc4_decode_frame(XanContext *s) {
 398 }
 399
 400 static int xan_decode_frame(AVCodecContext *avctx,
 401                             void *data, int *data_size,
 402                             AVPacket *avpkt)
 403 {
 404     const uint8_t *buf = avpkt->data;
 405     int buf_size = avpkt->size;
 406     XanContext *s = avctx->priv_data;
 407     AVPaletteControl *palette_control = avctx->palctrl;
 408
 409     if (avctx->get_buffer(avctx, &s->current_frame)) {
 410         av_log(s->avctx, AV_LOG_ERROR, "  Xan Video: get_buffer() failed\n");
 411         return -1;
 412     }
 413     s->current_frame.reference = 3;
 414
 415     if (!s->frame_size)
 416         s->frame_size = s->current_frame.linesize[0] * s->avctx->height;
 417
 418     palette_control->palette_changed = 0;
 419     memcpy(s->current_frame.data[1], palette_control->palette,
 420         AVPALETTE_SIZE);
 421     s->current_frame.palette_has_changed = 1;
 422
 423     s->buf = buf;
 424     s->size = buf_size;
 425
 426     if (avctx->codec->id == CODEC_ID_XAN_WC3)
 427         xan_wc3_decode_frame(s);
 428     else if (avctx->codec->id == CODEC_ID_XAN_WC4)
 429         xan_wc4_decode_frame(s);
 430
 431     /* release the last frame if it is allocated */
 432     if (s->last_frame.data[0])
 433         avctx->release_buffer(avctx, &s->last_frame);
 434
 435     *data_size = sizeof(AVFrame);
 436     *(AVFrame*)data = s->current_frame;
 437
 438     /* shuffle frames */
 439     FFSWAP(AVFrame, s->current_frame, s->last_frame);
 440
 441     /* always report that the buffer was completely consumed */
 442     return buf_size;
 443 }
 444
 445 static av_cold int xan_decode_end(AVCodecContext *avctx)
 446 {
 447     XanContext *s = avctx->priv_data;
 448
 449     /* release the frames */
 450     if (s->last_frame.data[0])
 451         avctx->release_buffer(avctx, &s->last_frame);
 452     if (s->current_frame.data[0])
 453         avctx->release_buffer(avctx, &s->current_frame);
 454
 455     av_free(s->buffer1);
 456     av_free(s->buffer2);
 457
 458     return 0;
 459 }
 460
 461 AVCodec xan_wc3_decoder = {
 462     "xan_wc3",
 463     CODEC_TYPE_VIDEO,
 464     CODEC_ID_XAN_WC3,
 465     sizeof(XanContext),
 466     xan_decode_init,
 467     NULL,
 468     xan_decode_end,
 469     xan_decode_frame,
 470     CODEC_CAP_DR1,
 471     .long_name = NULL_IF_CONFIG_SMALL("Wing Commander III / Xan"),
 472 };
 473
 474 /*
 475 AVCodec xan_wc4_decoder = {
 476     "xan_wc4",
 477     CODEC_TYPE_VIDEO,
 478     CODEC_ID_XAN_WC4,
 479     sizeof(XanContext),
 480     xan_decode_init,
 481     NULL,
 482     xan_decode_end,
 483     xan_decode_frame,
 484     CODEC_CAP_DR1,
 485 };
 486 */