2 * Delphine Software International CIN video decoder
3 * Copyright (c) 2006 Gregory Montoir (cyx@users.sourceforge.net)
5 * This file is part of FFmpeg.
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.
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.
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
24 * Delphine Software International CIN video decoder
28 #include "bytestream.h"
31 typedef enum CinVideoBitmapIndex {
32 CIN_CUR_BMP = 0, /* current */
33 CIN_PRE_BMP = 1, /* previous */
34 CIN_INT_BMP = 2 /* intermediate */
35 } CinVideoBitmapIndex;
37 typedef struct CinVideoContext {
38 AVCodecContext *avctx;
40 unsigned int bitmap_size;
41 uint32_t palette[256];
42 uint8_t *bitmap_table[3];
45 static av_cold void destroy_buffers(CinVideoContext *cin)
49 for (i = 0; i < 3; ++i)
50 av_freep(&cin->bitmap_table[i]);
53 static av_cold int allocate_buffers(CinVideoContext *cin)
57 for (i = 0; i < 3; ++i) {
58 cin->bitmap_table[i] = av_mallocz(cin->bitmap_size);
59 if (!cin->bitmap_table[i]) {
60 av_log(cin->avctx, AV_LOG_ERROR, "Can't allocate bitmap buffers.\n");
61 return AVERROR(ENOMEM);
68 static av_cold int cinvideo_decode_init(AVCodecContext *avctx)
70 CinVideoContext *cin = avctx->priv_data;
73 avctx->pix_fmt = AV_PIX_FMT_PAL8;
75 cin->frame = av_frame_alloc();
77 return AVERROR(ENOMEM);
79 cin->bitmap_size = avctx->width * avctx->height;
80 if (allocate_buffers(cin))
81 return AVERROR(ENOMEM);
86 static void cin_apply_delta_data(const unsigned char *src, unsigned char *dst,
93 static int cin_decode_huffman(const unsigned char *src, int src_size,
94 unsigned char *dst, int dst_size)
97 unsigned char huff_code_table[15];
98 unsigned char *dst_cur = dst;
99 unsigned char *dst_end = dst + dst_size;
100 const unsigned char *src_end = src + src_size;
102 memcpy(huff_code_table, src, 15);
105 while (src < src_end) {
107 if ((huff_code >> 4) == 15) {
110 *dst_cur++ = b | (huff_code >> 4);
112 *dst_cur++ = huff_code_table[huff_code >> 4];
113 if (dst_cur >= dst_end)
117 if (huff_code == 15) {
120 *dst_cur++ = huff_code_table[huff_code];
121 if (dst_cur >= dst_end)
125 return dst_cur - dst;
128 static int cin_decode_lzss(const unsigned char *src, int src_size,
129 unsigned char *dst, int dst_size)
132 int i, sz, offset, code;
133 unsigned char *dst_end = dst + dst_size, *dst_start = dst;
134 const unsigned char *src_end = src + src_size;
136 while (src < src_end && dst < dst_end) {
138 for (i = 0; i < 8 && src < src_end && dst < dst_end; ++i) {
139 if (code & (1 << i)) {
145 if ((int)(dst - dst_start) < offset + 1)
146 return AVERROR_INVALIDDATA;
147 sz = (cmd & 0xF) + 2;
148 /* don't use memcpy/memmove here as the decoding routine
149 * (ab)uses buffer overlappings to repeat bytes in the
151 sz = FFMIN(sz, dst_end - dst);
153 *dst = *(dst - offset - 1);
160 if (dst_end - dst > dst_size - dst_size/10)
161 return AVERROR_INVALIDDATA;
166 static int cin_decode_rle(const unsigned char *src, int src_size,
167 unsigned char *dst, int dst_size)
170 unsigned char *dst_end = dst + dst_size;
171 const unsigned char *src_end = src + src_size;
173 while (src + 1 < src_end && dst < dst_end) {
177 memset(dst, *src++, FFMIN(len, dst_end - dst));
180 if (len > src_end-src) {
181 av_log(NULL, AV_LOG_ERROR, "RLE overread\n");
182 return AVERROR_INVALIDDATA;
184 memcpy(dst, src, FFMIN3(len, dst_end - dst, src_end - src));
190 if (dst_end - dst > dst_size - dst_size/10)
191 return AVERROR_INVALIDDATA;
196 static int cinvideo_decode_frame(AVCodecContext *avctx,
197 void *data, int *got_frame,
200 const uint8_t *buf = avpkt->data;
201 int buf_size = avpkt->size;
202 CinVideoContext *cin = avctx->priv_data;
203 int i, y, palette_type, palette_colors_count,
204 bitmap_frame_type, bitmap_frame_size, res = 0;
206 palette_type = buf[0];
207 palette_colors_count = AV_RL16(buf + 1);
208 bitmap_frame_type = buf[3];
211 bitmap_frame_size = buf_size - 4;
214 if (bitmap_frame_size < palette_colors_count * (3 + (palette_type != 0)))
215 return AVERROR_INVALIDDATA;
216 if (palette_type == 0) {
217 if (palette_colors_count > 256)
218 return AVERROR_INVALIDDATA;
219 for (i = 0; i < palette_colors_count; ++i) {
220 cin->palette[i] = 0xFFU << 24 | bytestream_get_le24(&buf);
221 bitmap_frame_size -= 3;
224 for (i = 0; i < palette_colors_count; ++i) {
225 cin->palette[buf[0]] = 0xFFU << 24 | AV_RL24(buf + 1);
227 bitmap_frame_size -= 4;
231 /* note: the decoding routines below assumes that
232 * surface.width = surface.pitch */
233 switch (bitmap_frame_type) {
235 res = cin_decode_rle(buf, bitmap_frame_size,
236 cin->bitmap_table[CIN_CUR_BMP], cin->bitmap_size);
241 res = cin_decode_rle(buf, bitmap_frame_size,
242 cin->bitmap_table[CIN_CUR_BMP], cin->bitmap_size);
245 cin_apply_delta_data(cin->bitmap_table[CIN_PRE_BMP],
246 cin->bitmap_table[CIN_CUR_BMP], cin->bitmap_size);
249 bitmap_frame_size = cin_decode_huffman(buf, bitmap_frame_size,
250 cin->bitmap_table[CIN_INT_BMP], cin->bitmap_size);
251 res = cin_decode_rle(cin->bitmap_table[CIN_INT_BMP], bitmap_frame_size,
252 cin->bitmap_table[CIN_CUR_BMP], cin->bitmap_size);
257 bitmap_frame_size = cin_decode_huffman(buf, bitmap_frame_size,
258 cin->bitmap_table[CIN_INT_BMP],
260 res = cin_decode_rle(cin->bitmap_table[CIN_INT_BMP], bitmap_frame_size,
261 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);
268 res = cin_decode_huffman(buf, bitmap_frame_size,
269 cin->bitmap_table[CIN_CUR_BMP], cin->bitmap_size);
271 if (cin->bitmap_size - avctx->discard_damaged_percentage*cin->bitmap_size/100 > res)
272 return AVERROR_INVALIDDATA;
275 res = cin_decode_lzss(buf, bitmap_frame_size,
276 cin->bitmap_table[CIN_CUR_BMP],
282 res = cin_decode_lzss(buf, bitmap_frame_size,
283 cin->bitmap_table[CIN_CUR_BMP],
287 cin_apply_delta_data(cin->bitmap_table[CIN_PRE_BMP],
288 cin->bitmap_table[CIN_CUR_BMP], cin->bitmap_size);
292 if ((res = ff_reget_buffer(avctx, cin->frame, 0)) < 0)
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,
302 FFSWAP(uint8_t *, cin->bitmap_table[CIN_CUR_BMP],
303 cin->bitmap_table[CIN_PRE_BMP]);
305 if ((res = av_frame_ref(data, cin->frame)) < 0)
313 static av_cold int cinvideo_decode_end(AVCodecContext *avctx)
315 CinVideoContext *cin = avctx->priv_data;
317 av_frame_free(&cin->frame);
319 destroy_buffers(cin);
324 AVCodec ff_dsicinvideo_decoder = {
325 .name = "dsicinvideo",
326 .long_name = NULL_IF_CONFIG_SMALL("Delphine Software International CIN video"),
327 .type = AVMEDIA_TYPE_VIDEO,
328 .id = AV_CODEC_ID_DSICINVIDEO,
329 .priv_data_size = sizeof(CinVideoContext),
330 .init = cinvideo_decode_init,
331 .close = cinvideo_decode_end,
332 .decode = cinvideo_decode_frame,
333 .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
334 .capabilities = AV_CODEC_CAP_DR1,