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