Mercurial > libavcodec.hg
comparison idcinvideo.c @ 1498:9eb9b77cf418 libavcodec
implemented Id Quake II CIN support
author | tmmm |
---|---|
date | Fri, 03 Oct 2003 05:43:03 +0000 |
parents | |
children | 446ff1d593b0 |
comparison
equal
deleted
inserted
replaced
1497:37e16bd36d2c | 1498:9eb9b77cf418 |
---|---|
1 /* | |
2 * Id Quake II CIN 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 /** | |
22 * @file idcinvideo.c | |
23 * Id Quake II Cin Video Decoder by Dr. Tim Ferguson | |
24 * For more information about the Id CIN format, visit: | |
25 * http://www.csse.monash.edu.au/~timf/ | |
26 * | |
27 * This video decoder outputs PAL8 colorspace data. | |
28 * | |
29 * Id CIN video is purely Huffman-coded, intraframe-only codec. It achieves | |
30 * a little more compression by exploiting the fact that adjacent pixels | |
31 * tend to be similar. | |
32 * | |
33 * Note that this decoder could use ffmpeg's optimized VLC facilities | |
34 * rather than naive, tree-based Huffman decoding. However, there are 256 | |
35 * Huffman tables. Plus, the VLC bit coding order is right -> left instead | |
36 * or left -> right, so all of the bits would have to be reversed. Further, | |
37 * the original Quake II implementation likely used a similar naive | |
38 * decoding algorithm and it worked fine on much lower spec machines. | |
39 */ | |
40 | |
41 #include <stdio.h> | |
42 #include <stdlib.h> | |
43 #include <string.h> | |
44 #include <unistd.h> | |
45 | |
46 #include "common.h" | |
47 #include "avcodec.h" | |
48 #include "dsputil.h" | |
49 | |
50 #define HUFFMAN_TABLE_SIZE 64 * 1024 | |
51 #define HUF_TOKENS 256 | |
52 #define PALETTE_COUNT 256 | |
53 | |
54 typedef struct | |
55 { | |
56 int count; | |
57 unsigned char used; | |
58 int children[2]; | |
59 } hnode_t; | |
60 | |
61 typedef struct IdcinContext { | |
62 | |
63 AVCodecContext *avctx; | |
64 DSPContext dsp; | |
65 AVFrame frame; | |
66 | |
67 unsigned char *buf; | |
68 int size; | |
69 | |
70 unsigned char palette[PALETTE_COUNT * 4]; | |
71 | |
72 hnode_t huff_nodes[256][HUF_TOKENS*2]; | |
73 int num_huff_nodes[256]; | |
74 | |
75 } IdcinContext; | |
76 | |
77 /* | |
78 * Find the lowest probability node in a Huffman table, and mark it as | |
79 * being assigned to a higher probability. | |
80 * Returns the node index of the lowest unused node, or -1 if all nodes | |
81 * are used. | |
82 */ | |
83 static int huff_smallest_node(hnode_t *hnodes, int num_hnodes) { | |
84 int i; | |
85 int best, best_node; | |
86 | |
87 best = 99999999; | |
88 best_node = -1; | |
89 for(i = 0; i < num_hnodes; i++) { | |
90 if(hnodes[i].used) | |
91 continue; | |
92 if(!hnodes[i].count) | |
93 continue; | |
94 if(hnodes[i].count < best) { | |
95 best = hnodes[i].count; | |
96 best_node = i; | |
97 } | |
98 } | |
99 | |
100 if(best_node == -1) | |
101 return -1; | |
102 hnodes[best_node].used = 1; | |
103 return best_node; | |
104 } | |
105 | |
106 /* | |
107 * Build the Huffman tree using the generated/loaded probabilities histogram. | |
108 * | |
109 * On completion: | |
110 * huff_nodes[prev][i < HUF_TOKENS] - are the nodes at the base of the tree. | |
111 * huff_nodes[prev][i >= HUF_TOKENS] - are used to construct the tree. | |
112 * num_huff_nodes[prev] - contains the index to the root node of the tree. | |
113 * That is: huff_nodes[prev][num_huff_nodes[prev]] is the root node. | |
114 */ | |
115 static void huff_build_tree(IdcinContext *s, int prev) { | |
116 hnode_t *node, *hnodes; | |
117 int num_hnodes, i; | |
118 | |
119 num_hnodes = HUF_TOKENS; | |
120 hnodes = s->huff_nodes[prev]; | |
121 for(i = 0; i < HUF_TOKENS * 2; i++) | |
122 hnodes[i].used = 0; | |
123 | |
124 while (1) { | |
125 node = &hnodes[num_hnodes]; /* next free node */ | |
126 | |
127 /* pick two lowest counts */ | |
128 node->children[0] = huff_smallest_node(hnodes, num_hnodes); | |
129 if(node->children[0] == -1) | |
130 break; /* reached the root node */ | |
131 | |
132 node->children[1] = huff_smallest_node(hnodes, num_hnodes); | |
133 if(node->children[1] == -1) | |
134 break; /* reached the root node */ | |
135 | |
136 /* combine nodes probability for new node */ | |
137 node->count = hnodes[node->children[0]].count + | |
138 hnodes[node->children[1]].count; | |
139 num_hnodes++; | |
140 } | |
141 | |
142 s->num_huff_nodes[prev] = num_hnodes - 1; | |
143 } | |
144 | |
145 static int idcin_decode_init(AVCodecContext *avctx) | |
146 { | |
147 IdcinContext *s = (IdcinContext *)avctx->priv_data; | |
148 int i, j, histogram_index = 0; | |
149 unsigned char *histograms; | |
150 | |
151 s->avctx = avctx; | |
152 avctx->pix_fmt = PIX_FMT_PAL8; | |
153 avctx->has_b_frames = 0; | |
154 dsputil_init(&s->dsp, avctx); | |
155 | |
156 /* make sure the Huffman tables make it */ | |
157 if (s->avctx->extradata_size != HUFFMAN_TABLE_SIZE) { | |
158 printf(" Id CIN video: expected extradata size of %d\n", HUFFMAN_TABLE_SIZE); | |
159 return -1; | |
160 } | |
161 | |
162 /* build the 256 Huffman decode trees */ | |
163 histograms = (unsigned char *)s->avctx->extradata; | |
164 for (i = 0; i < 256; i++) { | |
165 for(j = 0; j < HUF_TOKENS; j++) | |
166 s->huff_nodes[i][j].count = histograms[histogram_index++]; | |
167 huff_build_tree(s, i); | |
168 } | |
169 | |
170 s->frame.data[0] = NULL; | |
171 | |
172 return 0; | |
173 } | |
174 | |
175 static void idcin_decode_vlcs(IdcinContext *s) | |
176 { | |
177 hnode_t *hnodes; | |
178 long x, y; | |
179 int prev; | |
180 unsigned char v = 0; | |
181 int bit_pos, node_num, dat_pos; | |
182 | |
183 prev = bit_pos = dat_pos = 0; | |
184 for (y = 0; y < (s->frame.linesize[0] * s->avctx->height); | |
185 y += s->frame.linesize[0]) { | |
186 for (x = y; x < y + s->avctx->width; x++) { | |
187 node_num = s->num_huff_nodes[prev]; | |
188 hnodes = s->huff_nodes[prev]; | |
189 | |
190 while(node_num >= HUF_TOKENS) { | |
191 if(!bit_pos) { | |
192 if(dat_pos > s->size) { | |
193 printf("Huffman decode error.\n"); | |
194 return; | |
195 } | |
196 bit_pos = 8; | |
197 v = s->buf[dat_pos++]; | |
198 } | |
199 | |
200 node_num = hnodes[node_num].children[v & 0x01]; | |
201 v = v >> 1; | |
202 bit_pos--; | |
203 } | |
204 | |
205 s->frame.data[0][x] = node_num; | |
206 prev = node_num; | |
207 } | |
208 } | |
209 } | |
210 | |
211 static int idcin_decode_frame(AVCodecContext *avctx, | |
212 void *data, int *data_size, | |
213 uint8_t *buf, int buf_size) | |
214 { | |
215 IdcinContext *s = (IdcinContext *)avctx->priv_data; | |
216 AVPaletteControl *palette_control = | |
217 (AVPaletteControl *)avctx->extradata; | |
218 int i; | |
219 unsigned int *palette32; | |
220 int palette_index = 0; | |
221 unsigned char r, g, b; | |
222 | |
223 s->buf = buf; | |
224 s->size = buf_size; | |
225 | |
226 if (palette_control->palette_changed) { | |
227 palette32 = (unsigned int *)s->palette; | |
228 for (i = 0; i < PALETTE_COUNT; i++) { | |
229 r = palette_control->palette[palette_index++] * 1; | |
230 g = palette_control->palette[palette_index++] * 1; | |
231 b = palette_control->palette[palette_index++] * 1; | |
232 palette32[i] = (r << 16) | (g << 8) | (b); | |
233 } | |
234 palette_control->palette_changed = 0; | |
235 } | |
236 | |
237 if (s->frame.data[0]) | |
238 avctx->release_buffer(avctx, &s->frame); | |
239 | |
240 if (avctx->get_buffer(avctx, &s->frame)) { | |
241 printf (" Id CIN Video: get_buffer() failed\n"); | |
242 return -1; | |
243 } | |
244 | |
245 idcin_decode_vlcs(s); | |
246 | |
247 /* make the palette available on the way out */ | |
248 memcpy(s->frame.data[1], s->palette, PALETTE_COUNT * 4); | |
249 | |
250 *data_size = sizeof(AVFrame); | |
251 *(AVFrame*)data = s->frame; | |
252 | |
253 /* report that the buffer was completely consumed */ | |
254 return buf_size; | |
255 } | |
256 | |
257 static int idcin_decode_end(AVCodecContext *avctx) | |
258 { | |
259 IdcinContext *s = (IdcinContext *)avctx->priv_data; | |
260 | |
261 if (s->frame.data[0]) | |
262 avctx->release_buffer(avctx, &s->frame); | |
263 | |
264 return 0; | |
265 } | |
266 | |
267 AVCodec idcin_decoder = { | |
268 "idcinvideo", | |
269 CODEC_TYPE_VIDEO, | |
270 CODEC_ID_IDCIN, | |
271 sizeof(IdcinContext), | |
272 idcin_decode_init, | |
273 NULL, | |
274 idcin_decode_end, | |
275 idcin_decode_frame, | |
276 CODEC_CAP_DR1, | |
277 }; | |
278 |