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