vqavideo.c
上传用户:wstnjxml
上传日期:2014-04-03
资源大小:7248k
文件大小:19k
源码类别:

Windows CE

开发平台:

C/C++

  1. /*
  2.  * Westwood Studios VQA Video Decoder
  3.  * Copyright (C) 2003 the ffmpeg project
  4.  *
  5.  * This library is free software; you can redistribute it and/or
  6.  * modify it under the terms of the GNU Lesser General Public
  7.  * License as published by the Free Software Foundation; either
  8.  * version 2 of the License, or (at your option) any later version.
  9.  *
  10.  * This library is distributed in the hope that it will be useful,
  11.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13.  * Lesser General Public License for more details.
  14.  *
  15.  * You should have received a copy of the GNU Lesser General Public
  16.  * License along with this library; if not, write to the Free Software
  17.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18.  *
  19.  */
  20. /**
  21.  * @file vqavideo.c
  22.  * VQA Video Decoder by Mike Melanson (melanson@pcisys.net)
  23.  * For more information about the RPZA format, visit:
  24.  *   http://www.pcisys.net/~melanson/codecs/
  25.  *
  26.  * The VQA video decoder outputs PAL8 or RGB555 colorspace data, depending
  27.  * on the type of data in the file.
  28.  *
  29.  * This decoder needs the 42-byte VQHD header from the beginning
  30.  * of the VQA file passed through the extradata field. The VQHD header
  31.  * is laid out as:
  32.  *
  33.  *   bytes 0-3   chunk fourcc: 'VQHD'
  34.  *   bytes 4-7   chunk size in big-endian format, should be 0x0000002A
  35.  *   bytes 8-49  VQHD chunk data
  36.  *
  37.  * Bytes 8-49 are what this decoder expects to see.
  38.  *
  39.  * Briefly, VQA is a vector quantized animation format that operates in a
  40.  * VGA palettized colorspace. It operates on pixel vectors (blocks)
  41.  * of either 4x2 or 4x4 in size. Compressed VQA chunks can contain vector
  42.  * codebooks, palette information, and code maps for rendering vectors onto
  43.  * frames. Any of these components can also be compressed with a run-length
  44.  * encoding (RLE) algorithm commonly referred to as "format80".
  45.  *
  46.  * VQA takes a novel approach to rate control. Each group of n frames
  47.  * (usually, n = 8) relies on a different vector codebook. Rather than
  48.  * transporting an entire codebook every 8th frame, the new codebook is
  49.  * broken up into 8 pieces and sent along with the compressed video chunks
  50.  * for each of the 8 frames preceding the 8 frames which require the
  51.  * codebook. A full codebook is also sent on the very first frame of a
  52.  * file. This is an interesting technique, although it makes random file
  53.  * seeking difficult despite the fact that the frames are all intracoded.
  54.  *
  55.  * V1,2 VQA uses 12-bit codebook indices. If the 12-bit indices were
  56.  * packed into bytes and then RLE compressed, bytewise, the results would
  57.  * be poor. That is why the coding method divides each index into 2 parts,
  58.  * the top 4 bits and the bottom 8 bits, then RL encodes the 4-bit pieces
  59.  * together and the 8-bit pieces together. If most of the vectors are
  60.  * clustered into one group of 256 vectors, most of the 4-bit index pieces
  61.  * should be the same.
  62.  */
  63. #include <stdio.h>
  64. #include <stdlib.h>
  65. #include <string.h>
  66. #include <unistd.h>
  67. #include "common.h"
  68. #include "avcodec.h"
  69. #include "dsputil.h"
  70. #define PALETTE_COUNT 256
  71. #define VQA_HEADER_SIZE 0x2A
  72. #define CHUNK_PREAMBLE_SIZE 8
  73. /* allocate the maximum vector space, regardless of the file version:
  74.  * (0xFF00 codebook vectors + 0x100 solid pixel vectors) * (4x4 pixels/block) */
  75. #define MAX_CODEBOOK_VECTORS 0xFF00
  76. #define SOLID_PIXEL_VECTORS 0x100
  77. #define MAX_VECTORS (MAX_CODEBOOK_VECTORS + SOLID_PIXEL_VECTORS)
  78. #define MAX_CODEBOOK_SIZE (MAX_VECTORS * 4 * 4)
  79. #define CBF0_TAG MKBETAG('C', 'B', 'F', '0')
  80. #define CBFZ_TAG MKBETAG('C', 'B', 'F', 'Z')
  81. #define CBP0_TAG MKBETAG('C', 'B', 'P', '0')
  82. #define CBPZ_TAG MKBETAG('C', 'B', 'P', 'Z')
  83. #define CPL0_TAG MKBETAG('C', 'P', 'L', '0')
  84. #define CPLZ_TAG MKBETAG('C', 'P', 'L', 'Z')
  85. #define VPTZ_TAG MKBETAG('V', 'P', 'T', 'Z')
  86. #define VQA_DEBUG 0
  87. #if VQA_DEBUG
  88. #define vqa_debug printf
  89. #else
  90. static inline void vqa_debug(const char *format, ...) { }
  91. #endif
  92. typedef struct VqaContext {
  93.     AVCodecContext *avctx;
  94.     DSPContext dsp;
  95.     AVFrame frame;
  96.     unsigned char *buf;
  97.     int size;
  98.     unsigned int palette[PALETTE_COUNT];
  99.     int width;   /* width of a frame */
  100.     int height;   /* height of a frame */
  101.     int vector_width;  /* width of individual vector */
  102.     int vector_height;  /* height of individual vector */
  103.     int vqa_version;  /* this should be either 1, 2 or 3 */
  104.     unsigned char *codebook;         /* the current codebook */
  105.     int codebook_size;
  106.     unsigned char *next_codebook_buffer;  /* accumulator for next codebook */
  107.     int next_codebook_buffer_index;
  108.     unsigned char *decode_buffer;
  109.     int decode_buffer_size;
  110.     /* number of frames to go before replacing codebook */
  111.     int partial_countdown;
  112.     int partial_count;
  113. } VqaContext;
  114. static int vqa_decode_init(AVCodecContext *avctx)
  115. {
  116.     VqaContext *s = (VqaContext *)avctx->priv_data;
  117.     unsigned char *vqa_header;
  118.     int i, j, codebook_index;;
  119.     s->avctx = avctx;
  120.     avctx->pix_fmt = PIX_FMT_PAL8;
  121.     avctx->has_b_frames = 0;
  122.     dsputil_init(&s->dsp, avctx);
  123.     /* make sure the extradata made it */
  124.     if (s->avctx->extradata_size != VQA_HEADER_SIZE) {
  125.         av_log(s->avctx, AV_LOG_ERROR, "  VQA video: expected extradata size of %dn", VQA_HEADER_SIZE);
  126.         return -1;
  127.     }
  128.     /* load up the VQA parameters from the header */
  129.     vqa_header = (unsigned char *)s->avctx->extradata;
  130.     s->vqa_version = vqa_header[0];
  131.     s->width = LE_16(&vqa_header[6]);
  132.     s->height = LE_16(&vqa_header[8]);
  133.     if(avcodec_check_dimensions(avctx, s->width, s->height)){
  134.         s->width= s->height= 0;
  135.         return -1;
  136.     }
  137.     s->vector_width = vqa_header[10];
  138.     s->vector_height = vqa_header[11];
  139.     s->partial_count = s->partial_countdown = vqa_header[13];
  140.     /* the vector dimensions have to meet very stringent requirements */
  141.     if ((s->vector_width != 4) ||
  142.         ((s->vector_height != 2) && (s->vector_height != 4))) {
  143.         /* return without further initialization */
  144.         return -1;
  145.     }
  146.     /* allocate codebooks */
  147.     s->codebook_size = MAX_CODEBOOK_SIZE;
  148.     s->codebook = av_malloc(s->codebook_size);
  149.     s->next_codebook_buffer = av_malloc(s->codebook_size);
  150.     /* initialize the solid-color vectors */
  151.     if (s->vector_height == 4) {
  152.         codebook_index = 0xFF00 * 16;
  153.         for (i = 0; i < 256; i++)
  154.             for (j = 0; j < 16; j++)
  155.                 s->codebook[codebook_index++] = i;
  156.     } else {
  157.         codebook_index = 0xF00 * 8;
  158.         for (i = 0; i < 256; i++)
  159.             for (j = 0; j < 8; j++)
  160.                 s->codebook[codebook_index++] = i;
  161.     }
  162.     s->next_codebook_buffer_index = 0;
  163.     /* allocate decode buffer */
  164.     s->decode_buffer_size = (s->width / s->vector_width) *
  165.         (s->height / s->vector_height) * 2;
  166.     s->decode_buffer = av_malloc(s->decode_buffer_size);
  167.     s->frame.data[0] = NULL;
  168.     return 0;
  169. }
  170. #define CHECK_COUNT() 
  171.     if (dest_index + count > dest_size) { 
  172.         av_log(NULL, AV_LOG_ERROR, "  VQA video: decode_format80 problem: next op would overflow dest_indexn"); 
  173.         av_log(NULL, AV_LOG_ERROR, "  VQA video: current dest_index = %d, count = %d, dest_size = %dn", 
  174.             dest_index, count, dest_size); 
  175.         return; 
  176.     }
  177. static void decode_format80(unsigned char *src, int src_size,
  178.     unsigned char *dest, int dest_size, int check_size) {
  179.     int src_index = 0;
  180.     int dest_index = 0;
  181.     int count;
  182.     int src_pos;
  183.     unsigned char color;
  184.     int i;
  185.     while (src_index < src_size) {
  186.         vqa_debug("      opcode %02X: ", src[src_index]);
  187.         /* 0x80 means that frame is finished */
  188.         if (src[src_index] == 0x80)
  189.             return;
  190.         if (dest_index >= dest_size) {
  191.             av_log(NULL, AV_LOG_ERROR, "  VQA video: decode_format80 problem: dest_index (%d) exceeded dest_size (%d)n",
  192.                 dest_index, dest_size);
  193.             return;
  194.         }
  195.         if (src[src_index] == 0xFF) {
  196.             src_index++;
  197.             count = LE_16(&src[src_index]);
  198.             src_index += 2;
  199.             src_pos = LE_16(&src[src_index]);
  200.             src_index += 2;
  201.             vqa_debug("(1) copy %X bytes from absolute pos %Xn", count, src_pos);
  202.             CHECK_COUNT();
  203.             for (i = 0; i < count; i++)
  204.                 dest[dest_index + i] = dest[src_pos + i];
  205.             dest_index += count;
  206.         } else if (src[src_index] == 0xFE) {
  207.             src_index++;
  208.             count = LE_16(&src[src_index]);
  209.             src_index += 2;
  210.             color = src[src_index++];
  211.             vqa_debug("(2) set %X bytes to %02Xn", count, color);
  212.             CHECK_COUNT();
  213.             memset(&dest[dest_index], color, count);
  214.             dest_index += count;
  215.         } else if ((src[src_index] & 0xC0) == 0xC0) {
  216.             count = (src[src_index++] & 0x3F) + 3;
  217.             src_pos = LE_16(&src[src_index]);
  218.             src_index += 2;
  219.             vqa_debug("(3) copy %X bytes from absolute pos %Xn", count, src_pos);
  220.             CHECK_COUNT();
  221.             for (i = 0; i < count; i++)
  222.                 dest[dest_index + i] = dest[src_pos + i];
  223.             dest_index += count;
  224.         } else if (src[src_index] > 0x80) {
  225.             count = src[src_index++] & 0x3F;
  226.             vqa_debug("(4) copy %X bytes from source to destn", count);
  227.             CHECK_COUNT();
  228.             memcpy(&dest[dest_index], &src[src_index], count);
  229.             src_index += count;
  230.             dest_index += count;
  231.         } else {
  232.             count = ((src[src_index] & 0x70) >> 4) + 3;
  233.             src_pos = BE_16(&src[src_index]) & 0x0FFF;
  234.             src_index += 2;
  235.             vqa_debug("(5) copy %X bytes from relpos %Xn", count, src_pos);
  236.             CHECK_COUNT();
  237.             for (i = 0; i < count; i++)
  238.                 dest[dest_index + i] = dest[dest_index - src_pos + i];
  239.             dest_index += count;
  240.         }
  241.     }
  242.     /* validate that the entire destination buffer was filled; this is
  243.      * important for decoding frame maps since each vector needs to have a
  244.      * codebook entry; it is not important for compressed codebooks because
  245.      * not every entry needs to be filled */
  246.     if (check_size)
  247.         if (dest_index < dest_size)
  248.             av_log(NULL, AV_LOG_ERROR, "  VQA video: decode_format80 problem: decode finished with dest_index (%d) < dest_size (%d)n",
  249.                 dest_index, dest_size);
  250. }
  251. static void vqa_decode_chunk(VqaContext *s)
  252. {
  253.     unsigned int chunk_type;
  254.     unsigned int chunk_size;
  255.     int byte_skip;
  256.     unsigned int index = 0;
  257.     int i;
  258.     unsigned char r, g, b;
  259.     int index_shift;
  260.     int cbf0_chunk = -1;
  261.     int cbfz_chunk = -1;
  262.     int cbp0_chunk = -1;
  263.     int cbpz_chunk = -1;
  264.     int cpl0_chunk = -1;
  265.     int cplz_chunk = -1;
  266.     int vptz_chunk = -1;
  267.     int x, y;
  268.     int lines = 0;
  269.     int pixel_ptr;
  270.     int vector_index = 0;
  271.     int lobyte = 0;
  272.     int hibyte = 0;
  273.     int lobytes = 0;
  274.     int hibytes = s->decode_buffer_size / 2;
  275.     /* first, traverse through the frame and find the subchunks */
  276.     while (index < s->size) {
  277.         chunk_type = BE_32(&s->buf[index]);
  278.         chunk_size = BE_32(&s->buf[index + 4]);
  279.         switch (chunk_type) {
  280.         case CBF0_TAG:
  281.             cbf0_chunk = index;
  282.             break;
  283.         case CBFZ_TAG:
  284.             cbfz_chunk = index;
  285.             break;
  286.         case CBP0_TAG:
  287.             cbp0_chunk = index;
  288.             break;
  289.         case CBPZ_TAG:
  290.             cbpz_chunk = index;
  291.             break;
  292.         case CPL0_TAG:
  293.             cpl0_chunk = index;
  294.             break;
  295.         case CPLZ_TAG:
  296.             cplz_chunk = index;
  297.             break;
  298.         case VPTZ_TAG:
  299.             vptz_chunk = index;
  300.             break;
  301.         default:
  302.             av_log(s->avctx, AV_LOG_ERROR, "  VQA video: Found unknown chunk type: %c%c%c%c (%08X)n",
  303.             (chunk_type >> 24) & 0xFF,
  304.             (chunk_type >> 16) & 0xFF,
  305.             (chunk_type >>  8) & 0xFF,
  306.             (chunk_type >>  0) & 0xFF,
  307.             chunk_type);
  308.             break;
  309.         }
  310.         byte_skip = chunk_size & 0x01;
  311.         index += (CHUNK_PREAMBLE_SIZE + chunk_size + byte_skip);
  312.     }
  313.     /* next, deal with the palette */
  314.     if ((cpl0_chunk != -1) && (cplz_chunk != -1)) {
  315.         /* a chunk should not have both chunk types */
  316.         av_log(s->avctx, AV_LOG_ERROR, "  VQA video: problem: found both CPL0 and CPLZ chunksn");
  317.         return;
  318.     }
  319.     /* decompress the palette chunk */
  320.     if (cplz_chunk != -1) {
  321. /* yet to be handled */
  322.     }
  323.     /* convert the RGB palette into the machine's endian format */
  324.     if (cpl0_chunk != -1) {
  325.         chunk_size = BE_32(&s->buf[cpl0_chunk + 4]);
  326.         /* sanity check the palette size */
  327.         if (chunk_size / 3 > 256) {
  328.             av_log(s->avctx, AV_LOG_ERROR, "  VQA video: problem: found a palette chunk with %d colorsn",
  329.                 chunk_size / 3);
  330.             return;
  331.         }
  332.         cpl0_chunk += CHUNK_PREAMBLE_SIZE;
  333.         for (i = 0; i < chunk_size / 3; i++) {
  334.             /* scale by 4 to transform 6-bit palette -> 8-bit */
  335.             r = s->buf[cpl0_chunk++] * 4;
  336.             g = s->buf[cpl0_chunk++] * 4;
  337.             b = s->buf[cpl0_chunk++] * 4;
  338.             s->palette[i] = (r << 16) | (g << 8) | (b);
  339.         }
  340.     }
  341.     /* next, look for a full codebook */
  342.     if ((cbf0_chunk != -1) && (cbfz_chunk != -1)) {
  343.         /* a chunk should not have both chunk types */
  344.         av_log(s->avctx, AV_LOG_ERROR, "  VQA video: problem: found both CBF0 and CBFZ chunksn");
  345.         return;
  346.     }
  347.     /* decompress the full codebook chunk */
  348.     if (cbfz_chunk != -1) {
  349.         chunk_size = BE_32(&s->buf[cbfz_chunk + 4]);
  350.         cbfz_chunk += CHUNK_PREAMBLE_SIZE;
  351.         decode_format80(&s->buf[cbfz_chunk], chunk_size,
  352.             s->codebook, s->codebook_size, 0);
  353.     }
  354.     /* copy a full codebook */
  355.     if (cbf0_chunk != -1) {
  356.         chunk_size = BE_32(&s->buf[cbf0_chunk + 4]);
  357.         /* sanity check the full codebook size */
  358.         if (chunk_size > MAX_CODEBOOK_SIZE) {
  359.             av_log(s->avctx, AV_LOG_ERROR, "  VQA video: problem: CBF0 chunk too large (0x%X bytes)n",
  360.                 chunk_size);
  361.             return;
  362.         }
  363.         cbf0_chunk += CHUNK_PREAMBLE_SIZE;
  364.         memcpy(s->codebook, &s->buf[cbf0_chunk], chunk_size);
  365.     }
  366.     /* decode the frame */
  367.     if (vptz_chunk == -1) {
  368.         /* something is wrong if there is no VPTZ chunk */
  369.         av_log(s->avctx, AV_LOG_ERROR, "  VQA video: problem: no VPTZ chunk foundn");
  370.         return;
  371.     }
  372.     chunk_size = BE_32(&s->buf[vptz_chunk + 4]);
  373.     vptz_chunk += CHUNK_PREAMBLE_SIZE;
  374.     decode_format80(&s->buf[vptz_chunk], chunk_size,
  375.         s->decode_buffer, s->decode_buffer_size, 1);
  376.     /* render the final PAL8 frame */
  377.     if (s->vector_height == 4)
  378.         index_shift = 4;
  379.     else
  380.         index_shift = 3;
  381.     for (y = 0; y < s->frame.linesize[0] * s->height; 
  382.         y += s->frame.linesize[0] * s->vector_height) {
  383.         for (x = y; x < y + s->width; x += 4, lobytes++, hibytes++) {
  384.             pixel_ptr = x;
  385.             /* get the vector index, the method for which varies according to
  386.              * VQA file version */
  387.             switch (s->vqa_version) {
  388.             case 1:
  389. /* still need sample media for this case (only one game, "Legend of 
  390.  * Kyrandia III : Malcolm's Revenge", is known to use this version) */
  391.                 lines = 0;
  392.                 break;
  393.             case 2:
  394.                 lobyte = s->decode_buffer[lobytes];
  395.                 hibyte = s->decode_buffer[hibytes];
  396.                 vector_index = (hibyte << 8) | lobyte;
  397.                 vector_index <<= index_shift;
  398.                 lines = s->vector_height;
  399.                 break;
  400.             case 3:
  401. /* not implemented yet */
  402.                 lines = 0;
  403.                 break;
  404.             }
  405.             while (lines--) {
  406.                 s->frame.data[0][pixel_ptr + 0] = s->codebook[vector_index++];
  407.                 s->frame.data[0][pixel_ptr + 1] = s->codebook[vector_index++];
  408.                 s->frame.data[0][pixel_ptr + 2] = s->codebook[vector_index++];
  409.                 s->frame.data[0][pixel_ptr + 3] = s->codebook[vector_index++];
  410.                 pixel_ptr += s->frame.linesize[0];
  411.             }
  412.         }
  413.     }
  414.     /* handle partial codebook */
  415.     if ((cbp0_chunk != -1) && (cbpz_chunk != -1)) {
  416.         /* a chunk should not have both chunk types */
  417.         av_log(s->avctx, AV_LOG_ERROR, "  VQA video: problem: found both CBP0 and CBPZ chunksn");
  418.         return;
  419.     }
  420.     if (cbp0_chunk != -1) {
  421.         chunk_size = BE_32(&s->buf[cbp0_chunk + 4]);
  422.         cbp0_chunk += CHUNK_PREAMBLE_SIZE;
  423.         /* accumulate partial codebook */
  424.         memcpy(&s->next_codebook_buffer[s->next_codebook_buffer_index],
  425.             &s->buf[cbp0_chunk], chunk_size);
  426.         s->next_codebook_buffer_index += chunk_size;
  427.         s->partial_countdown--;
  428.         if (s->partial_countdown == 0) {
  429.             /* time to replace codebook */
  430.             memcpy(s->codebook, s->next_codebook_buffer, 
  431.                 s->next_codebook_buffer_index);
  432.             /* reset accounting */
  433.             s->next_codebook_buffer_index = 0;
  434.             s->partial_countdown = s->partial_count;
  435.         }
  436.     }
  437.     if (cbpz_chunk != -1) {
  438.         chunk_size = BE_32(&s->buf[cbpz_chunk + 4]);
  439.         cbpz_chunk += CHUNK_PREAMBLE_SIZE;
  440.         /* accumulate partial codebook */
  441.         memcpy(&s->next_codebook_buffer[s->next_codebook_buffer_index],
  442.             &s->buf[cbpz_chunk], chunk_size);
  443.         s->next_codebook_buffer_index += chunk_size;
  444.         s->partial_countdown--;
  445.         if (s->partial_countdown == 0) {
  446.             /* decompress codebook */
  447.             decode_format80(s->next_codebook_buffer, 
  448.                 s->next_codebook_buffer_index, 
  449.                 s->codebook, s->codebook_size, 0);
  450.             /* reset accounting */
  451.             s->next_codebook_buffer_index = 0;
  452.             s->partial_countdown = s->partial_count;
  453.         }
  454.     }
  455. }
  456. static int vqa_decode_frame(AVCodecContext *avctx,
  457.                             void *data, int *data_size,
  458.                             uint8_t *buf, int buf_size)
  459. {
  460.     VqaContext *s = (VqaContext *)avctx->priv_data;
  461.     s->buf = buf;
  462.     s->size = buf_size;
  463.     if (s->frame.data[0])
  464.         avctx->release_buffer(avctx, &s->frame);
  465.     if (avctx->get_buffer(avctx, &s->frame)) {
  466.         av_log(s->avctx, AV_LOG_ERROR, "  VQA Video: get_buffer() failedn");
  467.         return -1;
  468.     }
  469.     vqa_decode_chunk(s);
  470.     /* make the palette available on the way out */
  471.     memcpy(s->frame.data[1], s->palette, PALETTE_COUNT * 4);
  472.     s->frame.palette_has_changed = 1;
  473.     *data_size = sizeof(AVFrame);
  474.     *(AVFrame*)data = s->frame;
  475.     /* report that the buffer was completely consumed */
  476.     return buf_size;
  477. }
  478. static int vqa_decode_end(AVCodecContext *avctx)
  479. {
  480.     VqaContext *s = (VqaContext *)avctx->priv_data;
  481.     av_free(s->codebook);
  482.     av_free(s->next_codebook_buffer);
  483.     av_free(s->decode_buffer);
  484.     if (s->frame.data[0])
  485.         avctx->release_buffer(avctx, &s->frame);
  486.     return 0;
  487. }
  488. AVCodec vqa_decoder = {
  489.     "vqavideo",
  490.     CODEC_TYPE_VIDEO,
  491.     CODEC_ID_WS_VQA,
  492.     sizeof(VqaContext),
  493.     vqa_decode_init,
  494.     NULL,
  495.     vqa_decode_end,
  496.     vqa_decode_frame,
  497.     CODEC_CAP_DR1,
  498. };