2 * Wing Commander/Xan Video Decoder
3 * Copyright (C) 2011 Konstantin Shishkov
4 * based on work by Mike Melanson
6 * This file is part of FFmpeg.
8 * FFmpeg is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * FFmpeg is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with FFmpeg; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 #include "libavutil/intreadwrite.h"
25 #include "libavutil/mem.h"
26 #include "bytestream.h"
27 #define BITSTREAM_READER_LE
30 typedef struct XanContext {
31 AVCodecContext *avctx;
35 uint8_t *scratch_buffer;
40 static av_cold int xan_decode_init(AVCodecContext *avctx)
42 XanContext *s = avctx->priv_data;
46 avctx->pix_fmt = AV_PIX_FMT_YUV420P;
48 s->buffer_size = avctx->width * avctx->height;
49 s->y_buffer = av_malloc(s->buffer_size);
51 return AVERROR(ENOMEM);
52 s->scratch_buffer = av_malloc(s->buffer_size + 130);
53 if (!s->scratch_buffer) {
54 av_freep(&s->y_buffer);
55 return AVERROR(ENOMEM);
61 static int xan_unpack_luma(XanContext *s,
62 uint8_t *dst, const int dst_size)
67 const uint8_t *dst_end = dst + dst_size;
68 GetByteContext tree = s->gb;
69 int start_off = bytestream2_tell(&tree);
71 tree_size = bytestream2_get_byte(&s->gb);
72 eof = bytestream2_get_byte(&s->gb);
73 tree_root = eof + tree_size;
74 bytestream2_skip(&s->gb, tree_size * 2);
77 bits = bytestream2_get_byte(&s->gb);
80 int bit = !!(bits & mask);
82 bytestream2_seek(&tree, start_off + node*2 + bit - eof * 2, SEEK_SET);
83 node = bytestream2_get_byte(&tree);
93 if (bytestream2_get_bytes_left(&s->gb) <= 0)
95 bits = bytestream2_get_byteu(&s->gb);
99 return dst != dst_end ? AVERROR_INVALIDDATA : 0;
102 /* almost the same as in xan_wc3 decoder */
103 static int xan_unpack(XanContext *s,
104 uint8_t *dest, const int dest_len)
108 uint8_t *orig_dest = dest;
109 const uint8_t *dest_end = dest + dest_len;
111 while (dest < dest_end) {
112 if (bytestream2_get_bytes_left(&s->gb) <= 0)
113 return AVERROR_INVALIDDATA;
115 opcode = bytestream2_get_byteu(&s->gb);
119 if ((opcode & 0x80) == 0) {
121 back = ((opcode & 0x60) << 3) + bytestream2_get_byte(&s->gb) + 1;
122 size2 = ((opcode & 0x1c) >> 2) + 3;
123 } else if ((opcode & 0x40) == 0) {
124 size = bytestream2_peek_byte(&s->gb) >> 6;
125 back = (bytestream2_get_be16(&s->gb) & 0x3fff) + 1;
126 size2 = (opcode & 0x3f) + 4;
129 back = ((opcode & 0x10) << 12) + bytestream2_get_be16(&s->gb) + 1;
130 size2 = ((opcode & 0x0c) << 6) + bytestream2_get_byte(&s->gb) + 5;
131 if (size + size2 > dest_end - dest)
134 if (dest + size + size2 > dest_end ||
135 dest - orig_dest + size < back)
136 return AVERROR_INVALIDDATA;
137 bytestream2_get_buffer(&s->gb, dest, size);
139 av_memcpy_backptr(dest, back, size2);
142 int finish = opcode >= 0xfc;
144 size = finish ? opcode & 3 : ((opcode & 0x1f) << 2) + 4;
145 if (dest_end - dest < size)
146 return AVERROR_INVALIDDATA;
147 bytestream2_get_buffer(&s->gb, dest, size);
153 return dest - orig_dest;
156 static int xan_decode_chroma(AVCodecContext *avctx, unsigned chroma_off)
158 XanContext *s = avctx->priv_data;
162 const uint8_t *src, *src_end;
163 const uint8_t *table;
164 int mode, offset, dec_size, table_size;
168 if (chroma_off + 4 >= bytestream2_get_bytes_left(&s->gb)) {
169 av_log(avctx, AV_LOG_ERROR, "Invalid chroma block position\n");
170 return AVERROR_INVALIDDATA;
172 bytestream2_seek(&s->gb, chroma_off + 4, SEEK_SET);
173 mode = bytestream2_get_le16(&s->gb);
174 table = s->gb.buffer;
175 table_size = bytestream2_get_le16(&s->gb);
176 offset = table_size * 2;
179 if (offset >= bytestream2_get_bytes_left(&s->gb)) {
180 av_log(avctx, AV_LOG_ERROR, "Invalid chroma block offset\n");
181 return AVERROR_INVALIDDATA;
184 bytestream2_skip(&s->gb, offset);
185 memset(s->scratch_buffer, 0, s->buffer_size);
186 dec_size = xan_unpack(s, s->scratch_buffer, s->buffer_size);
188 av_log(avctx, AV_LOG_ERROR, "Chroma unpacking failed\n");
189 return AVERROR_INVALIDDATA;
194 src = s->scratch_buffer;
195 src_end = src + dec_size;
197 for (j = 0; j < avctx->height >> 1; j++) {
198 for (i = 0; i < avctx->width >> 1; i++) {
199 if (src_end - src < 1)
203 if (val >= table_size)
204 return AVERROR_INVALIDDATA;
205 val = AV_RL16(table + (val << 1));
206 uval = (val >> 3) & 0xF8;
207 vval = (val >> 8) & 0xF8;
208 U[i] = uval | (uval >> 5);
209 V[i] = vval | (vval >> 5);
212 U += s->pic.linesize[1];
213 V += s->pic.linesize[2];
216 uint8_t *U2 = U + s->pic.linesize[1];
217 uint8_t *V2 = V + s->pic.linesize[2];
219 for (j = 0; j < avctx->height >> 2; j++) {
220 for (i = 0; i < avctx->width >> 1; i += 2) {
221 if (src_end - src < 1)
225 if (val >= table_size)
226 return AVERROR_INVALIDDATA;
227 val = AV_RL16(table + (val << 1));
228 uval = (val >> 3) & 0xF8;
229 vval = (val >> 8) & 0xF8;
230 U[i] = U[i+1] = U2[i] = U2[i+1] = uval | (uval >> 5);
231 V[i] = V[i+1] = V2[i] = V2[i+1] = vval | (vval >> 5);
234 U += s->pic.linesize[1] * 2;
235 V += s->pic.linesize[2] * 2;
236 U2 += s->pic.linesize[1] * 2;
237 V2 += s->pic.linesize[2] * 2;
244 static int xan_decode_frame_type0(AVCodecContext *avctx)
246 XanContext *s = avctx->priv_data;
247 uint8_t *ybuf, *prev_buf, *src = s->scratch_buffer;
248 unsigned chroma_off, corr_off;
253 chroma_off = bytestream2_get_le32(&s->gb);
254 corr_off = bytestream2_get_le32(&s->gb);
256 if ((ret = xan_decode_chroma(avctx, chroma_off)) != 0)
259 if (corr_off >= bytestream2_size(&s->gb)) {
260 av_log(avctx, AV_LOG_WARNING, "Ignoring invalid correction block position\n");
263 bytestream2_seek(&s->gb, 12, SEEK_SET);
264 ret = xan_unpack_luma(s, src, s->buffer_size >> 1);
266 av_log(avctx, AV_LOG_ERROR, "Luma decoding failed\n");
273 for (j = 1; j < avctx->width - 1; j += 2) {
274 cur = (last + *src++) & 0x1F;
275 ybuf[j] = last + cur;
276 ybuf[j+1] = cur << 1;
282 ybuf += avctx->width;
284 for (i = 1; i < avctx->height; i++) {
285 last = ((prev_buf[0] >> 1) + *src++) & 0x1F;
287 for (j = 1; j < avctx->width - 1; j += 2) {
288 cur = ((prev_buf[j + 1] >> 1) + *src++) & 0x1F;
289 ybuf[j] = last + cur;
290 ybuf[j+1] = cur << 1;
296 ybuf += avctx->width;
302 bytestream2_seek(&s->gb, 8 + corr_off, SEEK_SET);
303 dec_size = xan_unpack(s, s->scratch_buffer, s->buffer_size);
307 dec_size = FFMIN(dec_size, s->buffer_size/2 - 1);
309 for (i = 0; i < dec_size; i++)
310 s->y_buffer[i*2+1] = (s->y_buffer[i*2+1] + (s->scratch_buffer[i] << 1)) & 0x3F;
314 ybuf = s->pic.data[0];
315 for (j = 0; j < avctx->height; j++) {
316 for (i = 0; i < avctx->width; i++)
317 ybuf[i] = (src[i] << 2) | (src[i] >> 3);
319 ybuf += s->pic.linesize[0];
325 static int xan_decode_frame_type1(AVCodecContext *avctx)
327 XanContext *s = avctx->priv_data;
328 uint8_t *ybuf, *src = s->scratch_buffer;
333 if ((ret = xan_decode_chroma(avctx, bytestream2_get_le32(&s->gb))) != 0)
336 bytestream2_seek(&s->gb, 16, SEEK_SET);
337 ret = xan_unpack_luma(s, src,
338 s->buffer_size >> 1);
340 av_log(avctx, AV_LOG_ERROR, "Luma decoding failed\n");
345 for (i = 0; i < avctx->height; i++) {
346 last = (ybuf[0] + (*src++ << 1)) & 0x3F;
348 for (j = 1; j < avctx->width - 1; j += 2) {
349 cur = (ybuf[j + 1] + (*src++ << 1)) & 0x3F;
350 ybuf[j] = (last + cur) >> 1;
356 ybuf += avctx->width;
360 ybuf = s->pic.data[0];
361 for (j = 0; j < avctx->height; j++) {
362 for (i = 0; i < avctx->width; i++)
363 ybuf[i] = (src[i] << 2) | (src[i] >> 3);
365 ybuf += s->pic.linesize[0];
371 static int xan_decode_frame(AVCodecContext *avctx,
372 void *data, int *got_frame,
375 XanContext *s = avctx->priv_data;
379 s->pic.reference = 3;
380 s->pic.buffer_hints = FF_BUFFER_HINTS_VALID |
381 FF_BUFFER_HINTS_PRESERVE |
382 FF_BUFFER_HINTS_REUSABLE;
383 if ((ret = avctx->reget_buffer(avctx, &s->pic))) {
384 av_log(s->avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
388 bytestream2_init(&s->gb, avpkt->data, avpkt->size);
389 ftype = bytestream2_get_le32(&s->gb);
392 ret = xan_decode_frame_type0(avctx);
395 ret = xan_decode_frame_type1(avctx);
398 av_log(avctx, AV_LOG_ERROR, "Unknown frame type %d\n", ftype);
399 return AVERROR_INVALIDDATA;
405 *(AVFrame*)data = s->pic;
410 static av_cold int xan_decode_end(AVCodecContext *avctx)
412 XanContext *s = avctx->priv_data;
415 avctx->release_buffer(avctx, &s->pic);
417 av_freep(&s->y_buffer);
418 av_freep(&s->scratch_buffer);
423 AVCodec ff_xan_wc4_decoder = {
425 .type = AVMEDIA_TYPE_VIDEO,
426 .id = AV_CODEC_ID_XAN_WC4,
427 .priv_data_size = sizeof(XanContext),
428 .init = xan_decode_init,
429 .close = xan_decode_end,
430 .decode = xan_decode_frame,
431 .capabilities = CODEC_CAP_DR1,
432 .long_name = NULL_IF_CONFIG_SMALL("Wing Commander IV / Xxan"),