Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / libavcodec / dsicinav.c
1 /*
2  * Delphine Software International CIN Audio/Video Decoders
3  * Copyright (c) 2006 Gregory Montoir (cyx@users.sourceforge.net)
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
24  * Delphine Software International CIN audio/video decoders
25  */
26
27 #include "avcodec.h"
28 #include "bytestream.h"
29 #include "mathops.h"
30
31
32 typedef enum CinVideoBitmapIndex {
33     CIN_CUR_BMP = 0, /* current */
34     CIN_PRE_BMP = 1, /* previous */
35     CIN_INT_BMP = 2  /* intermediate */
36 } CinVideoBitmapIndex;
37
38 typedef struct CinVideoContext {
39     AVCodecContext *avctx;
40     AVFrame frame;
41     unsigned int bitmap_size;
42     uint32_t palette[256];
43     uint8_t *bitmap_table[3];
44 } CinVideoContext;
45
46 typedef struct CinAudioContext {
47     AVFrame frame;
48     int initial_decode_frame;
49     int delta;
50 } CinAudioContext;
51
52
53 /* table defining a geometric sequence with multiplier = 32767 ^ (1 / 128) */
54 static const int16_t cinaudio_delta16_table[256] = {
55          0,      0,      0,      0,      0,      0,      0,      0,
56          0,      0,      0,      0,      0,      0,      0,      0,
57          0,      0,      0, -30210, -27853, -25680, -23677, -21829,
58     -20126, -18556, -17108, -15774, -14543, -13408, -12362, -11398,
59     -10508,  -9689,  -8933,  -8236,  -7593,  -7001,  -6455,  -5951,
60      -5487,  -5059,  -4664,  -4300,  -3964,  -3655,  -3370,  -3107,
61      -2865,  -2641,  -2435,  -2245,  -2070,  -1908,  -1759,  -1622,
62      -1495,  -1379,  -1271,  -1172,  -1080,   -996,   -918,   -847,
63       -781,   -720,   -663,   -612,   -564,   -520,   -479,   -442,
64       -407,   -376,   -346,   -319,   -294,   -271,   -250,   -230,
65       -212,   -196,   -181,   -166,   -153,   -141,   -130,   -120,
66       -111,   -102,    -94,    -87,    -80,    -74,    -68,    -62,
67        -58,    -53,    -49,    -45,    -41,    -38,    -35,    -32,
68        -30,    -27,    -25,    -23,    -21,    -20,    -18,    -17,
69        -15,    -14,    -13,    -12,    -11,    -10,     -9,     -8,
70         -7,     -6,     -5,     -4,     -3,     -2,     -1,      0,
71          0,      1,      2,      3,      4,      5,      6,      7,
72          8,      9,     10,     11,     12,     13,     14,     15,
73         17,     18,     20,     21,     23,     25,     27,     30,
74         32,     35,     38,     41,     45,     49,     53,     58,
75         62,     68,     74,     80,     87,     94,    102,    111,
76        120,    130,    141,    153,    166,    181,    196,    212,
77        230,    250,    271,    294,    319,    346,    376,    407,
78        442,    479,    520,    564,    612,    663,    720,    781,
79        847,    918,    996,   1080,   1172,   1271,   1379,   1495,
80       1622,   1759,   1908,   2070,   2245,   2435,   2641,   2865,
81       3107,   3370,   3655,   3964,   4300,   4664,   5059,   5487,
82       5951,   6455,   7001,   7593,   8236,   8933,   9689,  10508,
83      11398,  12362,  13408,  14543,  15774,  17108,  18556,  20126,
84      21829,  23677,  25680,  27853,  30210,      0,      0,      0,
85          0,      0,      0,      0,      0,      0,      0,      0,
86          0,      0,      0,      0,      0,      0,      0,      0
87 };
88
89
90 static av_cold int cinvideo_decode_init(AVCodecContext *avctx)
91 {
92     CinVideoContext *cin = avctx->priv_data;
93     unsigned int i;
94
95     cin->avctx = avctx;
96     avctx->pix_fmt = PIX_FMT_PAL8;
97
98     avcodec_get_frame_defaults(&cin->frame);
99     cin->frame.data[0] = NULL;
100
101     cin->bitmap_size = avctx->width * avctx->height;
102     for (i = 0; i < 3; ++i) {
103         cin->bitmap_table[i] = av_mallocz(cin->bitmap_size);
104         if (!cin->bitmap_table[i])
105             av_log(avctx, AV_LOG_ERROR, "Can't allocate bitmap buffers.\n");
106     }
107
108     return 0;
109 }
110
111 static void cin_apply_delta_data(const unsigned char *src, unsigned char *dst, int size)
112 {
113     while (size--)
114         *dst++ += *src++;
115 }
116
117 static int cin_decode_huffman(const unsigned char *src, int src_size, unsigned char *dst, int dst_size)
118 {
119     int b, huff_code = 0;
120     unsigned char huff_code_table[15];
121     unsigned char *dst_cur = dst;
122     unsigned char *dst_end = dst + dst_size;
123     const unsigned char *src_end = src + src_size;
124
125     memcpy(huff_code_table, src, 15); src += 15; src_size -= 15;
126
127     while (src < src_end) {
128         huff_code = *src++;
129         if ((huff_code >> 4) == 15) {
130             b = huff_code << 4;
131             huff_code = *src++;
132             *dst_cur++ = b | (huff_code >> 4);
133         } else
134             *dst_cur++ = huff_code_table[huff_code >> 4];
135         if (dst_cur >= dst_end)
136             break;
137
138         huff_code &= 15;
139         if (huff_code == 15) {
140             *dst_cur++ = *src++;
141         } else
142             *dst_cur++ = huff_code_table[huff_code];
143         if (dst_cur >= dst_end)
144             break;
145     }
146
147     return dst_cur - dst;
148 }
149
150 static int cin_decode_lzss(const unsigned char *src, int src_size, unsigned char *dst, int dst_size)
151 {
152     uint16_t cmd;
153     int i, sz, offset, code;
154     unsigned char *dst_end = dst + dst_size, *dst_start = dst;
155     const unsigned char *src_end = src + src_size;
156
157     while (src < src_end && dst < dst_end) {
158         code = *src++;
159         for (i = 0; i < 8 && src < src_end && dst < dst_end; ++i) {
160             if (code & (1 << i)) {
161                 *dst++ = *src++;
162             } else {
163                 cmd = AV_RL16(src); src += 2;
164                 offset = cmd >> 4;
165                 if ((int) (dst - dst_start) < offset + 1)
166                     return AVERROR_INVALIDDATA;
167                 sz = (cmd & 0xF) + 2;
168                 /* don't use memcpy/memmove here as the decoding routine (ab)uses */
169                 /* buffer overlappings to repeat bytes in the destination */
170                 sz = FFMIN(sz, dst_end - dst);
171                 while (sz--) {
172                     *dst = *(dst - offset - 1);
173                     ++dst;
174                 }
175             }
176         }
177     }
178
179     return 0;
180 }
181
182 static int cin_decode_rle(const unsigned char *src, int src_size, unsigned char *dst, int dst_size)
183 {
184     int len, code;
185     unsigned char *dst_end = dst + dst_size;
186     const unsigned char *src_end = src + src_size;
187
188     while (src + 1 < src_end && dst < dst_end) {
189         code = *src++;
190         if (code & 0x80) {
191             len = code - 0x7F;
192             memset(dst, *src++, FFMIN(len, dst_end - dst));
193         } else {
194             len = code + 1;
195             if (len > src_end-src) {
196                 av_log(0, AV_LOG_ERROR, "RLE overread\n");
197                 return AVERROR_INVALIDDATA;
198             }
199             memcpy(dst, src, FFMIN(len, dst_end - dst));
200             src += len;
201         }
202         dst += len;
203     }
204     return 0;
205 }
206
207 static int cinvideo_decode_frame(AVCodecContext *avctx,
208                                  void *data, int *data_size,
209                                  AVPacket *avpkt)
210 {
211     const uint8_t *buf = avpkt->data;
212     int buf_size = avpkt->size;
213     CinVideoContext *cin = avctx->priv_data;
214     int i, y, palette_type, palette_colors_count, bitmap_frame_type, bitmap_frame_size, res = 0;
215
216     palette_type = buf[0];
217     palette_colors_count = AV_RL16(buf+1);
218     bitmap_frame_type = buf[3];
219     buf += 4;
220
221     bitmap_frame_size = buf_size - 4;
222
223     /* handle palette */
224     if (bitmap_frame_size < palette_colors_count * (3 + (palette_type != 0)))
225         return AVERROR_INVALIDDATA;
226     if (palette_type == 0) {
227         if (palette_colors_count > 256)
228             return AVERROR_INVALIDDATA;
229         for (i = 0; i < palette_colors_count; ++i) {
230             cin->palette[i] = 0xFF << 24 | bytestream_get_le24(&buf);
231             bitmap_frame_size -= 3;
232         }
233     } else {
234         for (i = 0; i < palette_colors_count; ++i) {
235             cin->palette[buf[0]] = 0xFF << 24 | AV_RL24(buf+1);
236             buf += 4;
237             bitmap_frame_size -= 4;
238         }
239     }
240
241     /* note: the decoding routines below assumes that surface.width = surface.pitch */
242     switch (bitmap_frame_type) {
243     case 9:
244         cin_decode_rle(buf, bitmap_frame_size,
245           cin->bitmap_table[CIN_CUR_BMP], cin->bitmap_size);
246         break;
247     case 34:
248         cin_decode_rle(buf, bitmap_frame_size,
249           cin->bitmap_table[CIN_CUR_BMP], cin->bitmap_size);
250         cin_apply_delta_data(cin->bitmap_table[CIN_PRE_BMP],
251           cin->bitmap_table[CIN_CUR_BMP], cin->bitmap_size);
252         break;
253     case 35:
254         cin_decode_huffman(buf, bitmap_frame_size,
255           cin->bitmap_table[CIN_INT_BMP], cin->bitmap_size);
256         cin_decode_rle(cin->bitmap_table[CIN_INT_BMP], bitmap_frame_size,
257           cin->bitmap_table[CIN_CUR_BMP], cin->bitmap_size);
258         break;
259     case 36:
260         bitmap_frame_size = cin_decode_huffman(buf, bitmap_frame_size,
261           cin->bitmap_table[CIN_INT_BMP], cin->bitmap_size);
262         cin_decode_rle(cin->bitmap_table[CIN_INT_BMP], bitmap_frame_size,
263           cin->bitmap_table[CIN_CUR_BMP], cin->bitmap_size);
264         cin_apply_delta_data(cin->bitmap_table[CIN_PRE_BMP],
265           cin->bitmap_table[CIN_CUR_BMP], cin->bitmap_size);
266         break;
267     case 37:
268         cin_decode_huffman(buf, bitmap_frame_size,
269           cin->bitmap_table[CIN_CUR_BMP], cin->bitmap_size);
270         break;
271     case 38:
272         res = cin_decode_lzss(buf, bitmap_frame_size,
273                               cin->bitmap_table[CIN_CUR_BMP],
274                               cin->bitmap_size);
275         if (res < 0)
276             return res;
277         break;
278     case 39:
279         res = cin_decode_lzss(buf, bitmap_frame_size,
280                               cin->bitmap_table[CIN_CUR_BMP],
281                               cin->bitmap_size);
282         if (res < 0)
283             return res;
284         cin_apply_delta_data(cin->bitmap_table[CIN_PRE_BMP],
285           cin->bitmap_table[CIN_CUR_BMP], cin->bitmap_size);
286         break;
287     }
288
289     cin->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
290     if (avctx->reget_buffer(avctx, &cin->frame)) {
291         av_log(cin->avctx, AV_LOG_ERROR, "delphinecinvideo: reget_buffer() failed to allocate a frame\n");
292         return -1;
293     }
294
295     memcpy(cin->frame.data[1], cin->palette, sizeof(cin->palette));
296     cin->frame.palette_has_changed = 1;
297     for (y = 0; y < cin->avctx->height; ++y)
298         memcpy(cin->frame.data[0] + (cin->avctx->height - 1 - y) * cin->frame.linesize[0],
299           cin->bitmap_table[CIN_CUR_BMP] + y * cin->avctx->width,
300           cin->avctx->width);
301
302     FFSWAP(uint8_t *, cin->bitmap_table[CIN_CUR_BMP], cin->bitmap_table[CIN_PRE_BMP]);
303
304     *data_size = sizeof(AVFrame);
305     *(AVFrame *)data = cin->frame;
306
307     return buf_size;
308 }
309
310 static av_cold int cinvideo_decode_end(AVCodecContext *avctx)
311 {
312     CinVideoContext *cin = avctx->priv_data;
313     int i;
314
315     if (cin->frame.data[0])
316         avctx->release_buffer(avctx, &cin->frame);
317
318     for (i = 0; i < 3; ++i)
319         av_free(cin->bitmap_table[i]);
320
321     return 0;
322 }
323
324 static av_cold int cinaudio_decode_init(AVCodecContext *avctx)
325 {
326     CinAudioContext *cin = avctx->priv_data;
327
328     if (avctx->channels != 1) {
329         av_log_ask_for_sample(avctx, "Number of channels is not supported\n");
330         return AVERROR_PATCHWELCOME;
331     }
332
333     cin->initial_decode_frame = 1;
334     cin->delta = 0;
335     avctx->sample_fmt = AV_SAMPLE_FMT_S16;
336
337     avcodec_get_frame_defaults(&cin->frame);
338     avctx->coded_frame = &cin->frame;
339
340     return 0;
341 }
342
343 static int cinaudio_decode_frame(AVCodecContext *avctx, void *data,
344                                  int *got_frame_ptr, AVPacket *avpkt)
345 {
346     const uint8_t *buf = avpkt->data;
347     CinAudioContext *cin = avctx->priv_data;
348     const uint8_t *buf_end = buf + avpkt->size;
349     int16_t *samples;
350     int delta, ret;
351
352     /* get output buffer */
353     cin->frame.nb_samples = avpkt->size - cin->initial_decode_frame;
354     if ((ret = avctx->get_buffer(avctx, &cin->frame)) < 0) {
355         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
356         return ret;
357     }
358     samples = (int16_t *)cin->frame.data[0];
359
360     delta = cin->delta;
361     if (cin->initial_decode_frame) {
362         cin->initial_decode_frame = 0;
363         delta = sign_extend(AV_RL16(buf), 16);
364         buf += 2;
365         *samples++ = delta;
366     }
367     while (buf < buf_end) {
368         delta += cinaudio_delta16_table[*buf++];
369         delta = av_clip_int16(delta);
370         *samples++ = delta;
371     }
372     cin->delta = delta;
373
374     *got_frame_ptr   = 1;
375     *(AVFrame *)data = cin->frame;
376
377     return avpkt->size;
378 }
379
380
381 AVCodec ff_dsicinvideo_decoder = {
382     .name           = "dsicinvideo",
383     .type           = AVMEDIA_TYPE_VIDEO,
384     .id             = CODEC_ID_DSICINVIDEO,
385     .priv_data_size = sizeof(CinVideoContext),
386     .init           = cinvideo_decode_init,
387     .close          = cinvideo_decode_end,
388     .decode         = cinvideo_decode_frame,
389     .capabilities   = CODEC_CAP_DR1,
390     .long_name      = NULL_IF_CONFIG_SMALL("Delphine Software International CIN video"),
391 };
392
393 AVCodec ff_dsicinaudio_decoder = {
394     .name           = "dsicinaudio",
395     .type           = AVMEDIA_TYPE_AUDIO,
396     .id             = CODEC_ID_DSICINAUDIO,
397     .priv_data_size = sizeof(CinAudioContext),
398     .init           = cinaudio_decode_init,
399     .decode         = cinaudio_decode_frame,
400     .capabilities   = CODEC_CAP_DR1,
401     .long_name      = NULL_IF_CONFIG_SMALL("Delphine Software International CIN audio"),
402 };