Merge commit '4436f25a1682ada3f7226cb6fadf429946933161'
[ffmpeg.git] / libavcodec / flashsv.c
1 /*
2  * Flash Screen Video decoder
3  * Copyright (C) 2004 Alex Beregszaszi
4  * Copyright (C) 2006 Benjamin Larsson
5  *
6  * This file is part of FFmpeg.
7  *
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.
12  *
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.
17  *
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
21  */
22
23 /**
24  * @file
25  * Flash Screen Video decoder
26  * @author Alex Beregszaszi
27  * @author Benjamin Larsson
28  * @author Daniel Verkamp
29  * @author Konstantin Shishkov
30  *
31  * A description of the bitstream format for Flash Screen Video version 1/2
32  * is part of the SWF File Format Specification (version 10), which can be
33  * downloaded from http://www.adobe.com/devnet/swf.html.
34  */
35
36 #include <stdio.h>
37 #include <stdlib.h>
38 #include <zlib.h>
39
40 #include "libavutil/intreadwrite.h"
41 #include "avcodec.h"
42 #include "bytestream.h"
43 #include "get_bits.h"
44
45 typedef struct BlockInfo {
46     uint8_t *pos;
47     int      size;
48     int      unp_size;
49 } BlockInfo;
50
51 typedef struct FlashSVContext {
52     AVCodecContext *avctx;
53     AVFrame         frame;
54     int             image_width, image_height;
55     int             block_width, block_height;
56     uint8_t        *tmpblock;
57     int             block_size;
58     z_stream        zstream;
59     int             ver;
60     const uint32_t *pal;
61     int             is_keyframe;
62     uint8_t        *keyframedata;
63     uint8_t        *keyframe;
64     BlockInfo      *blocks;
65     uint8_t        *deflate_block;
66     int             deflate_block_size;
67     int             color_depth;
68     int             zlibprime_curr, zlibprime_prev;
69     int             diff_start, diff_height;
70 } FlashSVContext;
71
72
73 static int decode_hybrid(const uint8_t *sptr, uint8_t *dptr, int dx, int dy,
74                          int h, int w, int stride, const uint32_t *pal)
75 {
76     int x, y;
77     const uint8_t *orig_src = sptr;
78
79     for (y = dx+h; y > dx; y--) {
80         uint8_t *dst = dptr + (y * stride) + dy * 3;
81         for (x = 0; x < w; x++) {
82             if (*sptr & 0x80) {
83                 /* 15-bit color */
84                 unsigned c = AV_RB16(sptr) & ~0x8000;
85                 unsigned b =  c        & 0x1F;
86                 unsigned g = (c >>  5) & 0x1F;
87                 unsigned r =  c >> 10;
88                 /* 000aaabb -> aaabbaaa  */
89                 *dst++ = (b << 3) | (b >> 2);
90                 *dst++ = (g << 3) | (g >> 2);
91                 *dst++ = (r << 3) | (r >> 2);
92                 sptr += 2;
93             } else {
94                 /* palette index */
95                 uint32_t c = pal[*sptr++];
96                 bytestream_put_le24(&dst, c);
97             }
98         }
99     }
100     return sptr - orig_src;
101 }
102
103 static av_cold int flashsv_decode_init(AVCodecContext *avctx)
104 {
105     FlashSVContext *s = avctx->priv_data;
106     int zret; // Zlib return code
107
108     s->avctx          = avctx;
109     s->zstream.zalloc = Z_NULL;
110     s->zstream.zfree  = Z_NULL;
111     s->zstream.opaque = Z_NULL;
112     zret = inflateInit(&s->zstream);
113     if (zret != Z_OK) {
114         av_log(avctx, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
115         return 1;
116     }
117     avctx->pix_fmt = AV_PIX_FMT_BGR24;
118     avcodec_get_frame_defaults(&s->frame);
119     s->frame.data[0] = NULL;
120
121     return 0;
122 }
123
124
125 static int flashsv2_prime(FlashSVContext *s, uint8_t *src,
126                           int size, int unp_size)
127 {
128     z_stream zs;
129     int zret; // Zlib return code
130
131     zs.zalloc = NULL;
132     zs.zfree  = NULL;
133     zs.opaque = NULL;
134
135     s->zstream.next_in   = src;
136     s->zstream.avail_in  = size;
137     s->zstream.next_out  = s->tmpblock;
138     s->zstream.avail_out = s->block_size * 3;
139     inflate(&s->zstream, Z_SYNC_FLUSH);
140
141     deflateInit(&zs, 0);
142     zs.next_in   = s->tmpblock;
143     zs.avail_in  = s->block_size * 3 - s->zstream.avail_out;
144     zs.next_out  = s->deflate_block;
145     zs.avail_out = s->deflate_block_size;
146     deflate(&zs, Z_SYNC_FLUSH);
147     deflateEnd(&zs);
148
149     if ((zret = inflateReset(&s->zstream)) != Z_OK) {
150         av_log(s->avctx, AV_LOG_ERROR, "Inflate reset error: %d\n", zret);
151         return AVERROR_UNKNOWN;
152     }
153
154     s->zstream.next_in   = s->deflate_block;
155     s->zstream.avail_in  = s->deflate_block_size - zs.avail_out;
156     s->zstream.next_out  = s->tmpblock;
157     s->zstream.avail_out = s->block_size * 3;
158     inflate(&s->zstream, Z_SYNC_FLUSH);
159
160     return 0;
161 }
162
163 static int flashsv_decode_block(AVCodecContext *avctx, AVPacket *avpkt,
164                                 GetBitContext *gb, int block_size,
165                                 int width, int height, int x_pos, int y_pos,
166                                 int blk_idx)
167 {
168     struct FlashSVContext *s = avctx->priv_data;
169     uint8_t *line = s->tmpblock;
170     int k;
171     int ret = inflateReset(&s->zstream);
172     if (ret != Z_OK) {
173         av_log(avctx, AV_LOG_ERROR, "Inflate reset error: %d\n", ret);
174         return AVERROR_UNKNOWN;
175     }
176     if (s->zlibprime_curr || s->zlibprime_prev) {
177         ret = flashsv2_prime(s, s->blocks[blk_idx].pos, s->blocks[blk_idx].size,
178                        s->blocks[blk_idx].unp_size);
179         if (ret < 0)
180             return ret;
181     }
182     s->zstream.next_in   = avpkt->data + get_bits_count(gb) / 8;
183     s->zstream.avail_in  = block_size;
184     s->zstream.next_out  = s->tmpblock;
185     s->zstream.avail_out = s->block_size * 3;
186     ret = inflate(&s->zstream, Z_FINISH);
187     if (ret == Z_DATA_ERROR) {
188         av_log(avctx, AV_LOG_ERROR, "Zlib resync occurred\n");
189         inflateSync(&s->zstream);
190         ret = inflate(&s->zstream, Z_FINISH);
191     }
192
193     if (ret != Z_OK && ret != Z_STREAM_END) {
194         //return -1;
195     }
196
197     if (s->is_keyframe) {
198         s->blocks[blk_idx].pos      = s->keyframedata + (get_bits_count(gb) / 8);
199         s->blocks[blk_idx].size     = block_size;
200         s->blocks[blk_idx].unp_size = s->block_size * 3 - s->zstream.avail_out;
201     }
202     if (!s->color_depth) {
203         /* Flash Screen Video stores the image upside down, so copy
204          * lines to destination in reverse order. */
205         for (k = 1; k <= s->diff_height; k++) {
206             memcpy(s->frame.data[0] + x_pos * 3 +
207                    (s->image_height - y_pos - s->diff_start - k) * s->frame.linesize[0],
208                    line, width * 3);
209             /* advance source pointer to next line */
210             line += width * 3;
211         }
212     } else {
213         /* hybrid 15-bit/palette mode */
214         decode_hybrid(s->tmpblock, s->frame.data[0],
215                       s->image_height - (y_pos + 1 + s->diff_start + s->diff_height),
216                       x_pos, s->diff_height, width,
217                       s->frame.linesize[0], s->pal);
218     }
219     skip_bits_long(gb, 8 * block_size); /* skip the consumed bits */
220     return 0;
221 }
222
223 static int calc_deflate_block_size(int tmpblock_size)
224 {
225     z_stream zstream;
226     int size;
227
228     zstream.zalloc = Z_NULL;
229     zstream.zfree  = Z_NULL;
230     zstream.opaque = Z_NULL;
231     if (deflateInit(&zstream, 0) != Z_OK)
232         return -1;
233     size = deflateBound(&zstream, tmpblock_size);
234     deflateEnd(&zstream);
235
236     return size;
237 }
238
239 static int flashsv_decode_frame(AVCodecContext *avctx, void *data,
240                                 int *data_size, AVPacket *avpkt)
241 {
242     int buf_size       = avpkt->size;
243     FlashSVContext *s  = avctx->priv_data;
244     int h_blocks, v_blocks, h_part, v_part, i, j;
245     GetBitContext gb;
246
247     /* no supplementary picture */
248     if (buf_size == 0)
249         return 0;
250     if (buf_size < 4)
251         return -1;
252
253     init_get_bits(&gb, avpkt->data, buf_size * 8);
254
255     /* start to parse the bitstream */
256     s->block_width  = 16 * (get_bits(&gb,  4) + 1);
257     s->image_width  =       get_bits(&gb, 12);
258     s->block_height = 16 * (get_bits(&gb,  4) + 1);
259     s->image_height =       get_bits(&gb, 12);
260
261     if (s->ver == 2) {
262         skip_bits(&gb, 6);
263         if (get_bits1(&gb)) {
264             av_log_missing_feature(avctx, "iframe", 1);
265             return AVERROR_PATCHWELCOME;
266         }
267         if (get_bits1(&gb)) {
268             av_log_missing_feature(avctx, "custom palette", 1);
269             return AVERROR_PATCHWELCOME;
270         }
271     }
272
273     /* calculate number of blocks and size of border (partial) blocks */
274     h_blocks = s->image_width  / s->block_width;
275     h_part   = s->image_width  % s->block_width;
276     v_blocks = s->image_height / s->block_height;
277     v_part   = s->image_height % s->block_height;
278
279     /* the block size could change between frames, make sure the buffer
280      * is large enough, if not, get a larger one */
281     if (s->block_size < s->block_width * s->block_height) {
282         int tmpblock_size = 3 * s->block_width * s->block_height;
283
284         s->tmpblock = av_realloc(s->tmpblock, tmpblock_size);
285         if (!s->tmpblock) {
286             av_log(avctx, AV_LOG_ERROR, "Can't allocate decompression buffer.\n");
287             return AVERROR(ENOMEM);
288         }
289         if (s->ver == 2) {
290             s->deflate_block_size = calc_deflate_block_size(tmpblock_size);
291             if (s->deflate_block_size <= 0) {
292                 av_log(avctx, AV_LOG_ERROR, "Can't determine deflate buffer size.\n");
293                 return -1;
294             }
295             s->deflate_block = av_realloc(s->deflate_block, s->deflate_block_size);
296             if (!s->deflate_block) {
297                 av_log(avctx, AV_LOG_ERROR, "Can't allocate deflate buffer.\n");
298                 return AVERROR(ENOMEM);
299             }
300         }
301     }
302     s->block_size = s->block_width * s->block_height;
303
304     /* initialize the image size once */
305     if (avctx->width == 0 && avctx->height == 0) {
306         avctx->width  = s->image_width;
307         avctx->height = s->image_height;
308     }
309
310     /* check for changes of image width and image height */
311     if (avctx->width != s->image_width || avctx->height != s->image_height) {
312         av_log(avctx, AV_LOG_ERROR,
313                "Frame width or height differs from first frame!\n");
314         av_log(avctx, AV_LOG_ERROR, "fh = %d, fv %d  vs  ch = %d, cv = %d\n",
315                avctx->height, avctx->width, s->image_height, s->image_width);
316         return AVERROR_INVALIDDATA;
317     }
318
319     /* we care for keyframes only in Screen Video v2 */
320     s->is_keyframe = (avpkt->flags & AV_PKT_FLAG_KEY) && (s->ver == 2);
321     if (s->is_keyframe) {
322         s->keyframedata = av_realloc(s->keyframedata, avpkt->size);
323         memcpy(s->keyframedata, avpkt->data, avpkt->size);
324         s->blocks = av_realloc(s->blocks,
325                                (v_blocks + !!v_part) * (h_blocks + !!h_part)
326                                * sizeof(s->blocks[0]));
327     }
328
329     av_dlog(avctx, "image: %dx%d block: %dx%d num: %dx%d part: %dx%d\n",
330             s->image_width, s->image_height, s->block_width, s->block_height,
331             h_blocks, v_blocks, h_part, v_part);
332
333     s->frame.reference    = 3;
334     s->frame.buffer_hints = FF_BUFFER_HINTS_VALID    |
335                             FF_BUFFER_HINTS_PRESERVE |
336                             FF_BUFFER_HINTS_REUSABLE;
337     if (avctx->reget_buffer(avctx, &s->frame) < 0) {
338         av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
339         return -1;
340     }
341
342     /* loop over all block columns */
343     for (j = 0; j < v_blocks + (v_part ? 1 : 0); j++) {
344
345         int y_pos  = j * s->block_height; // vertical position in frame
346         int cur_blk_height = (j < v_blocks) ? s->block_height : v_part;
347
348         /* loop over all block rows */
349         for (i = 0; i < h_blocks + (h_part ? 1 : 0); i++) {
350             int x_pos = i * s->block_width; // horizontal position in frame
351             int cur_blk_width = (i < h_blocks) ? s->block_width : h_part;
352             int has_diff = 0;
353
354             /* get the size of the compressed zlib chunk */
355             int size = get_bits(&gb, 16);
356
357             s->color_depth    = 0;
358             s->zlibprime_curr = 0;
359             s->zlibprime_prev = 0;
360             s->diff_start     = 0;
361             s->diff_height    = cur_blk_height;
362
363             if (8 * size > get_bits_left(&gb)) {
364                 avctx->release_buffer(avctx, &s->frame);
365                 s->frame.data[0] = NULL;
366                 return AVERROR_INVALIDDATA;
367             }
368
369             if (s->ver == 2 && size) {
370                 skip_bits(&gb, 3);
371                 s->color_depth    = get_bits(&gb, 2);
372                 has_diff          = get_bits1(&gb);
373                 s->zlibprime_curr = get_bits1(&gb);
374                 s->zlibprime_prev = get_bits1(&gb);
375
376                 if (s->color_depth != 0 && s->color_depth != 2) {
377                     av_log(avctx, AV_LOG_ERROR,
378                            "%dx%d invalid color depth %d\n", i, j, s->color_depth);
379                     return AVERROR_INVALIDDATA;
380                 }
381
382                 if (has_diff) {
383                     s->diff_start  = get_bits(&gb, 8);
384                     s->diff_height = get_bits(&gb, 8);
385                     av_log(avctx, AV_LOG_DEBUG,
386                            "%dx%d diff start %d height %d\n",
387                            i, j, s->diff_start, s->diff_height);
388                     size -= 2;
389                 }
390
391                 if (s->zlibprime_prev)
392                     av_log(avctx, AV_LOG_DEBUG, "%dx%d zlibprime_prev\n", i, j);
393
394                 if (s->zlibprime_curr) {
395                     int col = get_bits(&gb, 8);
396                     int row = get_bits(&gb, 8);
397                     av_log(avctx, AV_LOG_DEBUG, "%dx%d zlibprime_curr %dx%d\n", i, j, col, row);
398                     size -= 2;
399                     av_log_missing_feature(avctx, "zlibprime_curr", 1);
400                     return AVERROR_PATCHWELCOME;
401                 }
402                 size--; // account for flags byte
403             }
404
405             if (has_diff) {
406                 int k;
407                 int off = (s->image_height - y_pos - 1) * s->frame.linesize[0];
408
409                 for (k = 0; k < cur_blk_height; k++)
410                     memcpy(s->frame.data[0] + off - k*s->frame.linesize[0] + x_pos*3,
411                            s->keyframe + off - k*s->frame.linesize[0] + x_pos*3,
412                            cur_blk_width * 3);
413             }
414
415             /* skip unchanged blocks, which have size 0 */
416             if (size) {
417                 if (flashsv_decode_block(avctx, avpkt, &gb, size,
418                                          cur_blk_width, cur_blk_height,
419                                          x_pos, y_pos,
420                                          i + j * (h_blocks + !!h_part)))
421                     av_log(avctx, AV_LOG_ERROR,
422                            "error in decompression of block %dx%d\n", i, j);
423             }
424         }
425     }
426     if (s->is_keyframe && s->ver == 2) {
427         if (!s->keyframe) {
428             s->keyframe = av_malloc(s->frame.linesize[0] * avctx->height);
429             if (!s->keyframe) {
430                 av_log(avctx, AV_LOG_ERROR, "Cannot allocate image data\n");
431                 return AVERROR(ENOMEM);
432             }
433         }
434         memcpy(s->keyframe, s->frame.data[0], s->frame.linesize[0] * avctx->height);
435     }
436
437     *data_size = sizeof(AVFrame);
438     *(AVFrame*)data = s->frame;
439
440     if ((get_bits_count(&gb) / 8) != buf_size)
441         av_log(avctx, AV_LOG_ERROR, "buffer not fully consumed (%d != %d)\n",
442                buf_size, (get_bits_count(&gb) / 8));
443
444     /* report that the buffer was completely consumed */
445     return buf_size;
446 }
447
448
449 static av_cold int flashsv_decode_end(AVCodecContext *avctx)
450 {
451     FlashSVContext *s = avctx->priv_data;
452     inflateEnd(&s->zstream);
453     /* release the frame if needed */
454     if (s->frame.data[0])
455         avctx->release_buffer(avctx, &s->frame);
456
457     /* free the tmpblock */
458     av_free(s->tmpblock);
459
460     return 0;
461 }
462
463
464 #if CONFIG_FLASHSV_DECODER
465 AVCodec ff_flashsv_decoder = {
466     .name           = "flashsv",
467     .type           = AVMEDIA_TYPE_VIDEO,
468     .id             = AV_CODEC_ID_FLASHSV,
469     .priv_data_size = sizeof(FlashSVContext),
470     .init           = flashsv_decode_init,
471     .close          = flashsv_decode_end,
472     .decode         = flashsv_decode_frame,
473     .capabilities   = CODEC_CAP_DR1,
474     .pix_fmts       = (const enum AVPixelFormat[]){ AV_PIX_FMT_BGR24, AV_PIX_FMT_NONE },
475     .long_name      = NULL_IF_CONFIG_SMALL("Flash Screen Video v1"),
476 };
477 #endif /* CONFIG_FLASHSV_DECODER */
478
479 #if CONFIG_FLASHSV2_DECODER
480 static const uint32_t ff_flashsv2_default_palette[128] = {
481     0x000000, 0x333333, 0x666666, 0x999999, 0xCCCCCC, 0xFFFFFF,
482     0x330000, 0x660000, 0x990000, 0xCC0000, 0xFF0000, 0x003300,
483     0x006600, 0x009900, 0x00CC00, 0x00FF00, 0x000033, 0x000066,
484     0x000099, 0x0000CC, 0x0000FF, 0x333300, 0x666600, 0x999900,
485     0xCCCC00, 0xFFFF00, 0x003333, 0x006666, 0x009999, 0x00CCCC,
486     0x00FFFF, 0x330033, 0x660066, 0x990099, 0xCC00CC, 0xFF00FF,
487     0xFFFF33, 0xFFFF66, 0xFFFF99, 0xFFFFCC, 0xFF33FF, 0xFF66FF,
488     0xFF99FF, 0xFFCCFF, 0x33FFFF, 0x66FFFF, 0x99FFFF, 0xCCFFFF,
489     0xCCCC33, 0xCCCC66, 0xCCCC99, 0xCCCCFF, 0xCC33CC, 0xCC66CC,
490     0xCC99CC, 0xCCFFCC, 0x33CCCC, 0x66CCCC, 0x99CCCC, 0xFFCCCC,
491     0x999933, 0x999966, 0x9999CC, 0x9999FF, 0x993399, 0x996699,
492     0x99CC99, 0x99FF99, 0x339999, 0x669999, 0xCC9999, 0xFF9999,
493     0x666633, 0x666699, 0x6666CC, 0x6666FF, 0x663366, 0x669966,
494     0x66CC66, 0x66FF66, 0x336666, 0x996666, 0xCC6666, 0xFF6666,
495     0x333366, 0x333399, 0x3333CC, 0x3333FF, 0x336633, 0x339933,
496     0x33CC33, 0x33FF33, 0x663333, 0x993333, 0xCC3333, 0xFF3333,
497     0x003366, 0x336600, 0x660033, 0x006633, 0x330066, 0x663300,
498     0x336699, 0x669933, 0x993366, 0x339966, 0x663399, 0x996633,
499     0x6699CC, 0x99CC66, 0xCC6699, 0x66CC99, 0x9966CC, 0xCC9966,
500     0x99CCFF, 0xCCFF99, 0xFF99CC, 0x99FFCC, 0xCC99FF, 0xFFCC99,
501     0x111111, 0x222222, 0x444444, 0x555555, 0xAAAAAA, 0xBBBBBB,
502     0xDDDDDD, 0xEEEEEE
503 };
504
505 static av_cold int flashsv2_decode_init(AVCodecContext *avctx)
506 {
507     FlashSVContext *s = avctx->priv_data;
508     flashsv_decode_init(avctx);
509     s->pal = ff_flashsv2_default_palette;
510     s->ver = 2;
511
512     return 0;
513 }
514
515 static av_cold int flashsv2_decode_end(AVCodecContext *avctx)
516 {
517     FlashSVContext *s = avctx->priv_data;
518
519     av_freep(&s->keyframedata);
520     av_freep(&s->blocks);
521     av_freep(&s->keyframe);
522     av_freep(&s->deflate_block);
523     flashsv_decode_end(avctx);
524
525     return 0;
526 }
527
528 AVCodec ff_flashsv2_decoder = {
529     .name           = "flashsv2",
530     .type           = AVMEDIA_TYPE_VIDEO,
531     .id             = AV_CODEC_ID_FLASHSV2,
532     .priv_data_size = sizeof(FlashSVContext),
533     .init           = flashsv2_decode_init,
534     .close          = flashsv2_decode_end,
535     .decode         = flashsv_decode_frame,
536     .capabilities   = CODEC_CAP_DR1,
537     .pix_fmts       = (const enum AVPixelFormat[]){ AV_PIX_FMT_BGR24, AV_PIX_FMT_NONE },
538     .long_name      = NULL_IF_CONFIG_SMALL("Flash Screen Video v2"),
539 };
540 #endif /* CONFIG_FLASHSV2_DECODER */