Slightly simplify detection of end of compressed data in xan_unpack
[ffmpeg.git] / 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
35 #include "libavutil/intreadwrite.h"
36 #include "avcodec.h"
37 #include "bytestream.h"
38 #define ALT_BITSTREAM_READER_LE
39 #include "get_bits.h"
40 // for av_memcpy_backptr
41 #include "libavutil/lzo.h"
42
43 typedef struct XanContext {
44
45     AVCodecContext *avctx;
46     AVFrame last_frame;
47     AVFrame current_frame;
48
49     const unsigned char *buf;
50     int size;
51
52     /* scratch space */
53     unsigned char *buffer1;
54     int buffer1_size;
55     unsigned char *buffer2;
56     int buffer2_size;
57
58     int frame_size;
59
60 } XanContext;
61
62 static av_cold int xan_decode_init(AVCodecContext *avctx)
63 {
64     XanContext *s = avctx->priv_data;
65
66     s->avctx = avctx;
67     s->frame_size = 0;
68
69     if ((avctx->codec->id == CODEC_ID_XAN_WC3) &&
70         (s->avctx->palctrl == NULL)) {
71         av_log(avctx, AV_LOG_ERROR, " WC3 Xan video: palette expected.\n");
72         return -1;
73     }
74
75     avctx->pix_fmt = PIX_FMT_PAL8;
76
77     if(avcodec_check_dimensions(avctx, avctx->width, avctx->height))
78         return -1;
79
80     s->buffer1_size = avctx->width * avctx->height;
81     s->buffer1 = av_malloc(s->buffer1_size);
82     s->buffer2_size = avctx->width * avctx->height;
83     s->buffer2 = av_malloc(s->buffer2_size + 130);
84     if (!s->buffer1 || !s->buffer2)
85         return -1;
86
87     return 0;
88 }
89
90 static int xan_huffman_decode(unsigned char *dest, const unsigned char *src,
91     int dest_len)
92 {
93     unsigned char byte = *src++;
94     unsigned char ival = byte + 0x16;
95     const unsigned char * ptr = src + byte*2;
96     unsigned char val = ival;
97     unsigned char *dest_end = dest + dest_len;
98     GetBitContext gb;
99
100     init_get_bits(&gb, ptr, 0); // FIXME: no src size available
101
102     while ( val != 0x16 ) {
103         val = src[val - 0x17 + get_bits1(&gb) * byte];
104
105         if ( val < 0x16 ) {
106             if (dest >= dest_end)
107                 return 0;
108             *dest++ = val;
109             val = ival;
110         }
111     }
112
113     return 0;
114 }
115
116 /**
117  * unpack simple compression
118  *
119  * @param dest destination buffer of dest_len, must be padded with at least 130 bytes
120  */
121 static void xan_unpack(unsigned char *dest, const unsigned char *src, int dest_len)
122 {
123     unsigned char opcode;
124     int size;
125     unsigned char *dest_end = dest + dest_len;
126
127     while (dest < dest_end) {
128         opcode = *src++;
129
130         if (opcode < 0xe0) {
131             int size2, back;
132             if ( (opcode & 0x80) == 0 ) {
133
134                 size = opcode & 3;
135
136                 back  = ((opcode & 0x60) << 3) + *src++ + 1;
137                 size2 = ((opcode & 0x1c) >> 2) + 3;
138
139             } else if ( (opcode & 0x40) == 0 ) {
140
141                 size = *src >> 6;
142
143                 back  = (bytestream_get_be16(&src) & 0x3fff) + 1;
144                 size2 = (opcode & 0x3f) + 4;
145
146             } else {
147
148                 size = opcode & 3;
149
150                 back  = ((opcode & 0x10) << 12) + bytestream_get_be16(&src) + 1;
151                 size2 = ((opcode & 0x0c) <<  6) + *src++ + 5;
152                 if (size + size2 > dest_end - dest)
153                     return;
154             }
155             memcpy(dest, src, size);  dest += size;  src += size;
156             av_memcpy_backptr(dest, back, size2);
157             dest += size2;
158         } else {
159             int finish = opcode >= 0xfc;
160             size = finish ? opcode & 3 : ((opcode & 0x1f) << 2) + 4;
161
162             memcpy(dest, src, size);  dest += size;  src += size;
163             if (finish)
164                 return;
165         }
166     }
167 }
168
169 static inline void xan_wc3_output_pixel_run(XanContext *s,
170     const unsigned char *pixel_buffer, int x, int y, int pixel_count)
171 {
172     int stride;
173     int line_inc;
174     int index;
175     int current_x;
176     int width = s->avctx->width;
177     unsigned char *palette_plane;
178
179     palette_plane = s->current_frame.data[0];
180     stride = s->current_frame.linesize[0];
181     line_inc = stride - width;
182     index = y * stride + x;
183     current_x = x;
184     while((pixel_count--) && (index < s->frame_size)) {
185
186         /* don't do a memcpy() here; keyframes generally copy an entire
187          * frame of data and the stride needs to be accounted for */
188         palette_plane[index++] = *pixel_buffer++;
189
190         current_x++;
191         if (current_x >= width) {
192             index += line_inc;
193             current_x = 0;
194         }
195     }
196 }
197
198 static inline void xan_wc3_copy_pixel_run(XanContext *s,
199     int x, int y, int pixel_count, int motion_x, int motion_y)
200 {
201     int stride;
202     int line_inc;
203     int curframe_index, prevframe_index;
204     int curframe_x, prevframe_x;
205     int width = s->avctx->width;
206     unsigned char *palette_plane, *prev_palette_plane;
207
208     palette_plane = s->current_frame.data[0];
209     prev_palette_plane = s->last_frame.data[0];
210     stride = s->current_frame.linesize[0];
211     line_inc = stride - width;
212     curframe_index = y * stride + x;
213     curframe_x = x;
214     prevframe_index = (y + motion_y) * stride + x + motion_x;
215     prevframe_x = x + motion_x;
216     while((pixel_count--) && (curframe_index < s->frame_size)) {
217
218         palette_plane[curframe_index++] =
219             prev_palette_plane[prevframe_index++];
220
221         curframe_x++;
222         if (curframe_x >= width) {
223             curframe_index += line_inc;
224             curframe_x = 0;
225         }
226
227         prevframe_x++;
228         if (prevframe_x >= width) {
229             prevframe_index += line_inc;
230             prevframe_x = 0;
231         }
232     }
233 }
234
235 static void xan_wc3_decode_frame(XanContext *s) {
236
237     int width = s->avctx->width;
238     int height = s->avctx->height;
239     int total_pixels = width * height;
240     unsigned char opcode;
241     unsigned char flag = 0;
242     int size = 0;
243     int motion_x, motion_y;
244     int x, y;
245
246     unsigned char *opcode_buffer = s->buffer1;
247     int opcode_buffer_size = s->buffer1_size;
248     const unsigned char *imagedata_buffer = s->buffer2;
249
250     /* pointers to segments inside the compressed chunk */
251     const unsigned char *huffman_segment;
252     const unsigned char *size_segment;
253     const unsigned char *vector_segment;
254     const unsigned char *imagedata_segment;
255
256     huffman_segment =   s->buf + AV_RL16(&s->buf[0]);
257     size_segment =      s->buf + AV_RL16(&s->buf[2]);
258     vector_segment =    s->buf + AV_RL16(&s->buf[4]);
259     imagedata_segment = s->buf + AV_RL16(&s->buf[6]);
260
261     xan_huffman_decode(opcode_buffer, huffman_segment, opcode_buffer_size);
262
263     if (imagedata_segment[0] == 2)
264         xan_unpack(s->buffer2, &imagedata_segment[1], s->buffer2_size);
265     else
266         imagedata_buffer = &imagedata_segment[1];
267
268     /* use the decoded data segments to build the frame */
269     x = y = 0;
270     while (total_pixels) {
271
272         opcode = *opcode_buffer++;
273         size = 0;
274
275         switch (opcode) {
276
277         case 0:
278             flag ^= 1;
279             continue;
280
281         case 1:
282         case 2:
283         case 3:
284         case 4:
285         case 5:
286         case 6:
287         case 7:
288         case 8:
289             size = opcode;
290             break;
291
292         case 12:
293         case 13:
294         case 14:
295         case 15:
296         case 16:
297         case 17:
298         case 18:
299             size += (opcode - 10);
300             break;
301
302         case 9:
303         case 19:
304             size = *size_segment++;
305             break;
306
307         case 10:
308         case 20:
309             size = AV_RB16(&size_segment[0]);
310             size_segment += 2;
311             break;
312
313         case 11:
314         case 21:
315             size = AV_RB24(size_segment);
316             size_segment += 3;
317             break;
318         }
319
320         if (opcode < 12) {
321             flag ^= 1;
322             if (flag) {
323                 /* run of (size) pixels is unchanged from last frame */
324                 xan_wc3_copy_pixel_run(s, x, y, size, 0, 0);
325             } else {
326                 /* output a run of pixels from imagedata_buffer */
327                 xan_wc3_output_pixel_run(s, imagedata_buffer, x, y, size);
328                 imagedata_buffer += size;
329             }
330         } else {
331             /* run-based motion compensation from last frame */
332             motion_x = sign_extend(*vector_segment >> 4,  4);
333             motion_y = sign_extend(*vector_segment & 0xF, 4);
334             vector_segment++;
335
336             /* copy a run of pixels from the previous frame */
337             xan_wc3_copy_pixel_run(s, x, y, size, motion_x, motion_y);
338
339             flag = 0;
340         }
341
342         /* coordinate accounting */
343         total_pixels -= size;
344         y += (x + size) / width;
345         x  = (x + size) % width;
346     }
347 }
348
349 static void xan_wc4_decode_frame(XanContext *s) {
350 }
351
352 static int xan_decode_frame(AVCodecContext *avctx,
353                             void *data, int *data_size,
354                             AVPacket *avpkt)
355 {
356     const uint8_t *buf = avpkt->data;
357     int buf_size = avpkt->size;
358     XanContext *s = avctx->priv_data;
359     AVPaletteControl *palette_control = avctx->palctrl;
360
361     if (avctx->get_buffer(avctx, &s->current_frame)) {
362         av_log(s->avctx, AV_LOG_ERROR, "  Xan Video: get_buffer() failed\n");
363         return -1;
364     }
365     s->current_frame.reference = 3;
366
367     if (!s->frame_size)
368         s->frame_size = s->current_frame.linesize[0] * s->avctx->height;
369
370     palette_control->palette_changed = 0;
371     memcpy(s->current_frame.data[1], palette_control->palette,
372         AVPALETTE_SIZE);
373     s->current_frame.palette_has_changed = 1;
374
375     s->buf = buf;
376     s->size = buf_size;
377
378     if (avctx->codec->id == CODEC_ID_XAN_WC3)
379         xan_wc3_decode_frame(s);
380     else if (avctx->codec->id == CODEC_ID_XAN_WC4)
381         xan_wc4_decode_frame(s);
382
383     /* release the last frame if it is allocated */
384     if (s->last_frame.data[0])
385         avctx->release_buffer(avctx, &s->last_frame);
386
387     *data_size = sizeof(AVFrame);
388     *(AVFrame*)data = s->current_frame;
389
390     /* shuffle frames */
391     FFSWAP(AVFrame, s->current_frame, s->last_frame);
392
393     /* always report that the buffer was completely consumed */
394     return buf_size;
395 }
396
397 static av_cold int xan_decode_end(AVCodecContext *avctx)
398 {
399     XanContext *s = avctx->priv_data;
400
401     /* release the frames */
402     if (s->last_frame.data[0])
403         avctx->release_buffer(avctx, &s->last_frame);
404     if (s->current_frame.data[0])
405         avctx->release_buffer(avctx, &s->current_frame);
406
407     av_free(s->buffer1);
408     av_free(s->buffer2);
409
410     return 0;
411 }
412
413 AVCodec xan_wc3_decoder = {
414     "xan_wc3",
415     CODEC_TYPE_VIDEO,
416     CODEC_ID_XAN_WC3,
417     sizeof(XanContext),
418     xan_decode_init,
419     NULL,
420     xan_decode_end,
421     xan_decode_frame,
422     CODEC_CAP_DR1,
423     .long_name = NULL_IF_CONFIG_SMALL("Wing Commander III / Xan"),
424 };
425
426 /*
427 AVCodec xan_wc4_decoder = {
428     "xan_wc4",
429     CODEC_TYPE_VIDEO,
430     CODEC_ID_XAN_WC4,
431     sizeof(XanContext),
432     xan_decode_init,
433     NULL,
434     xan_decode_end,
435     xan_decode_frame,
436     CODEC_CAP_DR1,
437 };
438 */