2 * Flash Screen Video decoder
3 * Copyright (C) 2004 Alex Beregszaszi
4 * Copyright (C) 2006 Benjamin Larsson
6 * This file is part of FFmpeg.
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.
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.
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
25 * Flash Screen Video decoder
26 * @author Alex Beregszaszi
27 * @author Benjamin Larsson
30 /* Bitstream description
31 * The picture is divided into blocks that are zlib compressed.
33 * The decoder is fed complete frames, the frameheader contains:
34 * 4bits of block width
35 * 12bits of frame width
36 * 4bits of block height
37 * 12bits of frame height
39 * Directly after the header are the compressed blocks. The blocks
40 * have their compressed size represented with 16bits in the beginnig.
41 * If the size = 0 then the block is unchanged from the previous frame.
42 * All blocks are decompressed until the buffer is consumed.
44 * Encoding ideas, a basic encoder would just use a fixed block size.
45 * Block sizes can be multipels of 16, from 16 to 256. The blocks don't
46 * have to be quadratic. A brute force search with a set of diffrent
47 * block sizes should give a better result then to just use a fixed size.
57 typedef struct FlashSVContext {
58 AVCodecContext *avctx;
60 int image_width, image_height;
61 int block_width, block_height;
68 static void copy_region(uint8_t *sptr, uint8_t *dptr,
69 int dx, int dy, int h, int w, int stride)
73 for (i = dx + h; i > dx; i--) {
74 memcpy(dptr + (i * stride) + dy * 3, sptr, w * 3);
80 static av_cold int flashsv_decode_init(AVCodecContext *avctx)
82 FlashSVContext *s = avctx->priv_data;
83 int zret; // Zlib return code
86 s->zstream.zalloc = Z_NULL;
87 s->zstream.zfree = Z_NULL;
88 s->zstream.opaque = Z_NULL;
89 zret = inflateInit(&(s->zstream));
91 av_log(avctx, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
94 avctx->pix_fmt = PIX_FMT_BGR24;
95 avcodec_get_frame_defaults(&s->frame);
96 s->frame.data[0] = NULL;
102 static int flashsv_decode_frame(AVCodecContext *avctx, void *data,
103 int *data_size, AVPacket *avpkt)
105 const uint8_t *buf = avpkt->data;
106 int buf_size = avpkt->size;
107 FlashSVContext *s = avctx->priv_data;
108 int h_blocks, v_blocks, h_part, v_part, i, j;
111 /* no supplementary picture */
117 init_get_bits(&gb, buf, buf_size * 8);
119 /* start to parse the bitstream */
120 s->block_width = 16 * (get_bits(&gb, 4) + 1);
121 s->image_width = get_bits(&gb, 12);
122 s->block_height = 16 * (get_bits(&gb, 4) + 1);
123 s->image_height = get_bits(&gb, 12);
125 /* calculate amount of blocks and the size of the border blocks */
126 h_blocks = s->image_width / s->block_width;
127 h_part = s->image_width % s->block_width;
128 v_blocks = s->image_height / s->block_height;
129 v_part = s->image_height % s->block_height;
131 /* the block size could change between frames, make sure the buffer
132 * is large enough, if not, get a larger one */
133 if (s->block_size < s->block_width * s->block_height) {
134 av_free(s->tmpblock);
135 if ((s->tmpblock = av_malloc(3 * s->block_width * s->block_height)) == NULL) {
136 av_log(avctx, AV_LOG_ERROR, "Can't allocate decompression buffer.\n");
137 return AVERROR(ENOMEM);
140 s->block_size = s->block_width * s->block_height;
142 /* init the image size once */
143 if ((avctx->width == 0) && (avctx->height == 0)) {
144 avctx->width = s->image_width;
145 avctx->height = s->image_height;
148 /* check for changes of image width and image height */
149 if ((avctx->width != s->image_width) || (avctx->height != s->image_height)) {
150 av_log(avctx, AV_LOG_ERROR, "Frame width or height differs from first frames!\n");
151 av_log(avctx, AV_LOG_ERROR, "fh = %d, fv %d vs ch = %d, cv = %d\n", avctx->height,
152 avctx->width, s->image_height, s->image_width);
156 av_log(avctx, AV_LOG_DEBUG, "image: %dx%d block: %dx%d num: %dx%d part: %dx%d\n",
157 s->image_width, s->image_height, s->block_width, s->block_height,
158 h_blocks, v_blocks, h_part, v_part);
160 s->frame.reference = 1;
161 s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
162 if (avctx->reget_buffer(avctx, &s->frame) < 0) {
163 av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
167 /* loop over all block columns */
168 for (j = 0; j < v_blocks + (v_part ? 1 : 0); j++) {
170 int hp = j * s->block_height; // horiz position in frame
171 int hs = (j < v_blocks) ? s->block_height : v_part; // size of block
174 /* loop over all block rows */
175 for (i = 0; i < h_blocks + (h_part ? 1 : 0); i++) {
176 int wp = i * s->block_width; // vert position in frame
177 int ws = (i < h_blocks) ? s->block_width : h_part; // size of block
179 /* get the size of the compressed zlib chunk */
180 int size = get_bits(&gb, 16);
181 if (8 * size > get_bits_left(&gb)) {
182 avctx->release_buffer(avctx, &s->frame);
183 s->frame.data[0] = NULL;
188 /* no change, don't do anything */
190 /* decompress block */
191 int ret = inflateReset(&(s->zstream));
193 av_log(avctx, AV_LOG_ERROR, "error in decompression (reset) of block %dx%d\n", i, j);
196 s->zstream.next_in = buf + (get_bits_count(&gb) / 8);
197 s->zstream.avail_in = size;
198 s->zstream.next_out = s->tmpblock;
199 s->zstream.avail_out = s->block_size * 3;
200 ret = inflate(&(s->zstream), Z_FINISH);
201 if (ret == Z_DATA_ERROR) {
202 av_log(avctx, AV_LOG_ERROR, "Zlib resync occurred\n");
203 inflateSync(&(s->zstream));
204 ret = inflate(&(s->zstream), Z_FINISH);
207 if ((ret != Z_OK) && (ret != Z_STREAM_END)) {
208 av_log(avctx, AV_LOG_ERROR, "error in decompression of block %dx%d: %d\n", i, j, ret);
211 copy_region(s->tmpblock, s->frame.data[0], s->image_height - (hp + hs + 1),
212 wp, hs, ws, s->frame.linesize[0]);
213 skip_bits_long(&gb, 8 * size); /* skip the consumed bits */
218 *data_size = sizeof(AVFrame);
219 *(AVFrame*)data = s->frame;
221 if ((get_bits_count(&gb) / 8) != buf_size)
222 av_log(avctx, AV_LOG_ERROR, "buffer not fully consumed (%d != %d)\n",
223 buf_size, (get_bits_count(&gb) / 8));
225 /* report that the buffer was completely consumed */
230 static av_cold int flashsv_decode_end(AVCodecContext *avctx)
232 FlashSVContext *s = avctx->priv_data;
233 inflateEnd(&(s->zstream));
234 /* release the frame if needed */
235 if (s->frame.data[0])
236 avctx->release_buffer(avctx, &s->frame);
238 /* free the tmpblock */
239 av_free(s->tmpblock);
245 AVCodec ff_flashsv_decoder = {
247 .type = AVMEDIA_TYPE_VIDEO,
248 .id = CODEC_ID_FLASHSV,
249 .priv_data_size = sizeof(FlashSVContext),
250 .init = flashsv_decode_init,
251 .close = flashsv_decode_end,
252 .decode = flashsv_decode_frame,
253 .capabilities = CODEC_CAP_DR1,
254 .pix_fmts = (const enum PixelFormat[]){PIX_FMT_BGR24, PIX_FMT_NONE},
255 .long_name = NULL_IF_CONFIG_SMALL("Flash Screen Video v1"),