2003-10-03 05:43:03 +00:00
|
|
|
/*
|
2008-05-15 22:51:38 +00:00
|
|
|
* id Quake II CIN Video Decoder
|
2003-10-03 05:43:03 +00:00
|
|
|
* Copyright (C) 2003 the ffmpeg project
|
|
|
|
*
|
2011-03-18 17:35:10 +00:00
|
|
|
* This file is part of Libav.
|
2006-10-07 15:30:46 +00:00
|
|
|
*
|
2011-03-18 17:35:10 +00:00
|
|
|
* Libav is free software; you can redistribute it and/or
|
2003-10-03 05:43:03 +00:00
|
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
|
|
* License as published by the Free Software Foundation; either
|
2006-10-07 15:30:46 +00:00
|
|
|
* version 2.1 of the License, or (at your option) any later version.
|
2003-10-03 05:43:03 +00:00
|
|
|
*
|
2011-03-18 17:35:10 +00:00
|
|
|
* Libav is distributed in the hope that it will be useful,
|
2003-10-03 05:43:03 +00:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
* Lesser General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
2011-03-18 17:35:10 +00:00
|
|
|
* License along with Libav; if not, write to the Free Software
|
2006-01-12 22:43:26 +00:00
|
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
2003-10-03 05:43:03 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
2010-04-20 14:45:34 +00:00
|
|
|
* @file
|
2008-05-15 22:51:38 +00:00
|
|
|
* id Quake II Cin Video Decoder by Dr. Tim Ferguson
|
|
|
|
* For more information about the id CIN format, visit:
|
2003-10-03 05:43:03 +00:00
|
|
|
* http://www.csse.monash.edu.au/~timf/
|
|
|
|
*
|
2003-10-03 05:50:06 +00:00
|
|
|
* This video decoder outputs PAL8 colorspace data. Interacting with this
|
|
|
|
* decoder is a little involved. During initialization, the demuxer must
|
|
|
|
* transmit the 65536-byte Huffman table(s) to the decoder via extradata.
|
|
|
|
* Then, whenever a palette change is encountered while demuxing the file,
|
|
|
|
* the demuxer must use the same extradata space to transmit an
|
|
|
|
* AVPaletteControl structure.
|
2003-10-03 05:43:03 +00:00
|
|
|
*
|
2008-05-15 22:51:38 +00:00
|
|
|
* id CIN video is purely Huffman-coded, intraframe-only codec. It achieves
|
2003-10-03 05:43:03 +00:00
|
|
|
* a little more compression by exploiting the fact that adjacent pixels
|
|
|
|
* tend to be similar.
|
|
|
|
*
|
2011-10-30 17:02:42 +00:00
|
|
|
* Note that this decoder could use libavcodec's optimized VLC facilities
|
2003-10-03 05:43:03 +00:00
|
|
|
* rather than naive, tree-based Huffman decoding. However, there are 256
|
|
|
|
* Huffman tables. Plus, the VLC bit coding order is right -> left instead
|
|
|
|
* or left -> right, so all of the bits would have to be reversed. Further,
|
|
|
|
* the original Quake II implementation likely used a similar naive
|
|
|
|
* decoding algorithm and it worked fine on much lower spec machines.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include <stdio.h>
|
|
|
|
#include <stdlib.h>
|
|
|
|
#include <string.h>
|
|
|
|
|
|
|
|
#include "avcodec.h"
|
2012-11-10 12:22:56 +00:00
|
|
|
#include "internal.h"
|
2012-08-06 13:49:32 +00:00
|
|
|
#include "libavutil/internal.h"
|
2003-10-03 05:43:03 +00:00
|
|
|
|
|
|
|
#define HUFFMAN_TABLE_SIZE 64 * 1024
|
|
|
|
#define HUF_TOKENS 256
|
|
|
|
#define PALETTE_COUNT 256
|
|
|
|
|
|
|
|
typedef struct
|
|
|
|
{
|
|
|
|
int count;
|
|
|
|
unsigned char used;
|
|
|
|
int children[2];
|
2008-12-14 03:29:33 +00:00
|
|
|
} hnode;
|
2003-10-03 05:43:03 +00:00
|
|
|
|
|
|
|
typedef struct IdcinContext {
|
|
|
|
|
|
|
|
AVCodecContext *avctx;
|
|
|
|
AVFrame frame;
|
|
|
|
|
2008-02-01 03:26:31 +00:00
|
|
|
const unsigned char *buf;
|
2003-10-03 05:43:03 +00:00
|
|
|
int size;
|
|
|
|
|
2008-12-14 03:29:33 +00:00
|
|
|
hnode huff_nodes[256][HUF_TOKENS*2];
|
2003-10-03 05:43:03 +00:00
|
|
|
int num_huff_nodes[256];
|
|
|
|
|
2011-04-09 13:49:51 +00:00
|
|
|
uint32_t pal[256];
|
2003-10-03 05:43:03 +00:00
|
|
|
} IdcinContext;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Find the lowest probability node in a Huffman table, and mark it as
|
|
|
|
* being assigned to a higher probability.
|
2010-06-30 15:38:06 +00:00
|
|
|
* @return the node index of the lowest unused node, or -1 if all nodes
|
2003-10-03 05:43:03 +00:00
|
|
|
* are used.
|
|
|
|
*/
|
2008-12-14 03:29:33 +00:00
|
|
|
static int huff_smallest_node(hnode *hnodes, int num_hnodes) {
|
2003-10-03 05:43:03 +00:00
|
|
|
int i;
|
|
|
|
int best, best_node;
|
|
|
|
|
|
|
|
best = 99999999;
|
|
|
|
best_node = -1;
|
|
|
|
for(i = 0; i < num_hnodes; i++) {
|
|
|
|
if(hnodes[i].used)
|
|
|
|
continue;
|
|
|
|
if(!hnodes[i].count)
|
|
|
|
continue;
|
|
|
|
if(hnodes[i].count < best) {
|
|
|
|
best = hnodes[i].count;
|
|
|
|
best_node = i;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if(best_node == -1)
|
|
|
|
return -1;
|
|
|
|
hnodes[best_node].used = 1;
|
|
|
|
return best_node;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Build the Huffman tree using the generated/loaded probabilities histogram.
|
|
|
|
*
|
|
|
|
* On completion:
|
|
|
|
* huff_nodes[prev][i < HUF_TOKENS] - are the nodes at the base of the tree.
|
|
|
|
* huff_nodes[prev][i >= HUF_TOKENS] - are used to construct the tree.
|
|
|
|
* num_huff_nodes[prev] - contains the index to the root node of the tree.
|
|
|
|
* That is: huff_nodes[prev][num_huff_nodes[prev]] is the root node.
|
|
|
|
*/
|
2008-03-21 03:11:20 +00:00
|
|
|
static av_cold void huff_build_tree(IdcinContext *s, int prev) {
|
2008-12-14 03:29:33 +00:00
|
|
|
hnode *node, *hnodes;
|
2003-10-03 05:43:03 +00:00
|
|
|
int num_hnodes, i;
|
|
|
|
|
|
|
|
num_hnodes = HUF_TOKENS;
|
|
|
|
hnodes = s->huff_nodes[prev];
|
|
|
|
for(i = 0; i < HUF_TOKENS * 2; i++)
|
|
|
|
hnodes[i].used = 0;
|
|
|
|
|
|
|
|
while (1) {
|
|
|
|
node = &hnodes[num_hnodes]; /* next free node */
|
|
|
|
|
|
|
|
/* pick two lowest counts */
|
|
|
|
node->children[0] = huff_smallest_node(hnodes, num_hnodes);
|
|
|
|
if(node->children[0] == -1)
|
|
|
|
break; /* reached the root node */
|
|
|
|
|
|
|
|
node->children[1] = huff_smallest_node(hnodes, num_hnodes);
|
|
|
|
if(node->children[1] == -1)
|
|
|
|
break; /* reached the root node */
|
|
|
|
|
|
|
|
/* combine nodes probability for new node */
|
|
|
|
node->count = hnodes[node->children[0]].count +
|
|
|
|
hnodes[node->children[1]].count;
|
|
|
|
num_hnodes++;
|
|
|
|
}
|
|
|
|
|
|
|
|
s->num_huff_nodes[prev] = num_hnodes - 1;
|
|
|
|
}
|
|
|
|
|
2008-03-21 03:11:20 +00:00
|
|
|
static av_cold int idcin_decode_init(AVCodecContext *avctx)
|
2003-10-03 05:43:03 +00:00
|
|
|
{
|
2007-04-08 20:24:16 +00:00
|
|
|
IdcinContext *s = avctx->priv_data;
|
2003-10-03 05:43:03 +00:00
|
|
|
int i, j, histogram_index = 0;
|
|
|
|
unsigned char *histograms;
|
|
|
|
|
|
|
|
s->avctx = avctx;
|
2012-10-06 10:10:34 +00:00
|
|
|
avctx->pix_fmt = AV_PIX_FMT_PAL8;
|
2003-10-03 05:43:03 +00:00
|
|
|
|
|
|
|
/* make sure the Huffman tables make it */
|
|
|
|
if (s->avctx->extradata_size != HUFFMAN_TABLE_SIZE) {
|
2008-05-15 22:51:38 +00:00
|
|
|
av_log(s->avctx, AV_LOG_ERROR, " id CIN video: expected extradata size of %d\n", HUFFMAN_TABLE_SIZE);
|
2003-10-03 05:43:03 +00:00
|
|
|
return -1;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* build the 256 Huffman decode trees */
|
|
|
|
histograms = (unsigned char *)s->avctx->extradata;
|
|
|
|
for (i = 0; i < 256; i++) {
|
|
|
|
for(j = 0; j < HUF_TOKENS; j++)
|
|
|
|
s->huff_nodes[i][j].count = histograms[histogram_index++];
|
|
|
|
huff_build_tree(s, i);
|
|
|
|
}
|
|
|
|
|
2012-08-01 19:46:08 +00:00
|
|
|
avcodec_get_frame_defaults(&s->frame);
|
2003-10-03 05:43:03 +00:00
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
static void idcin_decode_vlcs(IdcinContext *s)
|
|
|
|
{
|
2008-12-14 03:29:33 +00:00
|
|
|
hnode *hnodes;
|
2003-10-03 05:43:03 +00:00
|
|
|
long x, y;
|
|
|
|
int prev;
|
|
|
|
unsigned char v = 0;
|
|
|
|
int bit_pos, node_num, dat_pos;
|
|
|
|
|
|
|
|
prev = bit_pos = dat_pos = 0;
|
|
|
|
for (y = 0; y < (s->frame.linesize[0] * s->avctx->height);
|
|
|
|
y += s->frame.linesize[0]) {
|
|
|
|
for (x = y; x < y + s->avctx->width; x++) {
|
|
|
|
node_num = s->num_huff_nodes[prev];
|
|
|
|
hnodes = s->huff_nodes[prev];
|
|
|
|
|
|
|
|
while(node_num >= HUF_TOKENS) {
|
|
|
|
if(!bit_pos) {
|
2005-02-16 22:42:41 +00:00
|
|
|
if(dat_pos >= s->size) {
|
2003-11-03 13:26:22 +00:00
|
|
|
av_log(s->avctx, AV_LOG_ERROR, "Huffman decode error.\n");
|
2003-10-03 05:43:03 +00:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
bit_pos = 8;
|
|
|
|
v = s->buf[dat_pos++];
|
|
|
|
}
|
|
|
|
|
|
|
|
node_num = hnodes[node_num].children[v & 0x01];
|
|
|
|
v = v >> 1;
|
|
|
|
bit_pos--;
|
|
|
|
}
|
|
|
|
|
|
|
|
s->frame.data[0][x] = node_num;
|
|
|
|
prev = node_num;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
static int idcin_decode_frame(AVCodecContext *avctx,
|
2012-11-13 18:35:22 +00:00
|
|
|
void *data, int *got_frame,
|
2009-04-07 15:59:50 +00:00
|
|
|
AVPacket *avpkt)
|
2003-10-03 05:43:03 +00:00
|
|
|
{
|
2009-04-07 15:59:50 +00:00
|
|
|
const uint8_t *buf = avpkt->data;
|
|
|
|
int buf_size = avpkt->size;
|
2007-04-08 20:24:16 +00:00
|
|
|
IdcinContext *s = avctx->priv_data;
|
2011-04-09 13:49:51 +00:00
|
|
|
const uint8_t *pal = av_packet_get_side_data(avpkt, AV_PKT_DATA_PALETTE, NULL);
|
2003-10-03 05:43:03 +00:00
|
|
|
|
|
|
|
s->buf = buf;
|
|
|
|
s->size = buf_size;
|
|
|
|
|
|
|
|
if (s->frame.data[0])
|
|
|
|
avctx->release_buffer(avctx, &s->frame);
|
|
|
|
|
2012-11-10 12:22:56 +00:00
|
|
|
if (ff_get_buffer(avctx, &s->frame)) {
|
2008-05-15 22:51:38 +00:00
|
|
|
av_log(avctx, AV_LOG_ERROR, " id CIN Video: get_buffer() failed\n");
|
2003-10-03 05:43:03 +00:00
|
|
|
return -1;
|
|
|
|
}
|
|
|
|
|
|
|
|
idcin_decode_vlcs(s);
|
|
|
|
|
2011-04-09 13:49:51 +00:00
|
|
|
if (pal) {
|
2003-10-30 05:40:58 +00:00
|
|
|
s->frame.palette_has_changed = 1;
|
2011-04-09 13:49:51 +00:00
|
|
|
memcpy(s->pal, pal, AVPALETTE_SIZE);
|
2003-10-30 05:40:58 +00:00
|
|
|
}
|
2011-04-09 13:49:51 +00:00
|
|
|
/* make the palette available on the way out */
|
|
|
|
memcpy(s->frame.data[1], s->pal, AVPALETTE_SIZE);
|
2003-10-03 05:43:03 +00:00
|
|
|
|
2012-11-13 18:35:22 +00:00
|
|
|
*got_frame = 1;
|
2003-10-03 05:43:03 +00:00
|
|
|
*(AVFrame*)data = s->frame;
|
|
|
|
|
|
|
|
/* report that the buffer was completely consumed */
|
|
|
|
return buf_size;
|
|
|
|
}
|
|
|
|
|
2008-03-21 03:11:20 +00:00
|
|
|
static av_cold int idcin_decode_end(AVCodecContext *avctx)
|
2003-10-03 05:43:03 +00:00
|
|
|
{
|
2007-04-08 20:24:16 +00:00
|
|
|
IdcinContext *s = avctx->priv_data;
|
2003-10-03 05:43:03 +00:00
|
|
|
|
|
|
|
if (s->frame.data[0])
|
|
|
|
avctx->release_buffer(avctx, &s->frame);
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2011-01-25 21:40:11 +00:00
|
|
|
AVCodec ff_idcin_decoder = {
|
2011-07-17 10:54:31 +00:00
|
|
|
.name = "idcinvideo",
|
|
|
|
.type = AVMEDIA_TYPE_VIDEO,
|
2012-08-05 09:11:04 +00:00
|
|
|
.id = AV_CODEC_ID_IDCIN,
|
2011-07-17 10:54:31 +00:00
|
|
|
.priv_data_size = sizeof(IdcinContext),
|
|
|
|
.init = idcin_decode_init,
|
|
|
|
.close = idcin_decode_end,
|
|
|
|
.decode = idcin_decode_frame,
|
|
|
|
.capabilities = CODEC_CAP_DR1,
|
2012-04-06 16:19:39 +00:00
|
|
|
.long_name = NULL_IF_CONFIG_SMALL("id Quake II CIN video"),
|
2003-10-03 05:43:03 +00:00
|
|
|
};
|