LCOV - code coverage report
Current view: top level - libavcodec - rscc.c (source / functions) Hit Total Coverage
Test: coverage.info Lines: 115 165 69.7 %
Date: 2017-12-18 13:19:42 Functions: 3 3 100.0 %

          Line data    Source code
       1             : /*
       2             :  * innoHeim/Rsupport Screen Capture Codec
       3             :  * Copyright (C) 2015 Vittorio Giovara <vittorio.giovara@gmail.com>
       4             :  *
       5             :  * This file is part of FFmpeg.
       6             :  *
       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.
      11             :  *
      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.
      16             :  *
      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
      20             :  */
      21             : 
      22             : /**
      23             :  * @file
      24             :  * innoHeim/Rsupport Screen Capture Codec decoder
      25             :  *
      26             :  * Fourcc: ISCC, RSCC
      27             :  *
      28             :  * Lossless codec, data stored in tiles, with optional deflate compression.
      29             :  *
      30             :  * Header contains the number of tiles in a frame with the tile coordinates,
      31             :  * and it can be deflated or not. Similarly, pixel data comes after the header
      32             :  * and a variable size value, and it can be deflated or just raw.
      33             :  *
      34             :  * Supports: PAL8, BGRA, BGR24, RGB555
      35             :  */
      36             : 
      37             : #include <stdint.h>
      38             : #include <string.h>
      39             : #include <zlib.h>
      40             : 
      41             : #include "libavutil/imgutils.h"
      42             : #include "libavutil/internal.h"
      43             : 
      44             : #include "avcodec.h"
      45             : #include "bytestream.h"
      46             : #include "internal.h"
      47             : 
      48             : #define TILE_SIZE 8
      49             : 
      50             : typedef struct Tile {
      51             :     int x, y;
      52             :     int w, h;
      53             : } Tile;
      54             : 
      55             : typedef struct RsccContext {
      56             :     GetByteContext gbc;
      57             :     AVFrame *reference;
      58             :     Tile *tiles;
      59             :     unsigned int tiles_size;
      60             :     int component_size;
      61             : 
      62             :     uint8_t palette[AVPALETTE_SIZE];
      63             : 
      64             :     /* zlib interaction */
      65             :     uint8_t *inflated_buf;
      66             :     uLongf inflated_size;
      67             : } RsccContext;
      68             : 
      69          10 : static av_cold int rscc_init(AVCodecContext *avctx)
      70             : {
      71          10 :     RsccContext *ctx = avctx->priv_data;
      72             : 
      73             :     /* These needs to be set to estimate uncompressed buffer */
      74          10 :     int ret = av_image_check_size(avctx->width, avctx->height, 0, avctx);
      75          10 :     if (ret < 0) {
      76           0 :         av_log(avctx, AV_LOG_ERROR, "Invalid image size %dx%d.\n",
      77             :                avctx->width, avctx->height);
      78           0 :         return ret;
      79             :     }
      80             : 
      81             :     /* Allocate reference frame */
      82          10 :     ctx->reference = av_frame_alloc();
      83          10 :     if (!ctx->reference)
      84           0 :         return AVERROR(ENOMEM);
      85             : 
      86             :     /* Get pixel format and the size of the pixel */
      87          10 :     if (avctx->codec_tag == MKTAG('I', 'S', 'C', 'C')) {
      88           2 :         avctx->pix_fmt = AV_PIX_FMT_BGRA;
      89           2 :         ctx->component_size = 4;
      90           8 :     } else if (avctx->codec_tag == MKTAG('R', 'S', 'C', 'C')) {
      91           8 :         ctx->component_size = avctx->bits_per_coded_sample / 8;
      92           8 :         switch (avctx->bits_per_coded_sample) {
      93           2 :         case 8:
      94           2 :             avctx->pix_fmt = AV_PIX_FMT_PAL8;
      95           2 :             break;
      96           2 :         case 16:
      97           2 :             avctx->pix_fmt = AV_PIX_FMT_RGB555LE;
      98           2 :             break;
      99           2 :         case 24:
     100           2 :             avctx->pix_fmt = AV_PIX_FMT_BGR24;
     101           2 :             break;
     102           2 :         case 32:
     103           2 :             avctx->pix_fmt = AV_PIX_FMT_BGR0;
     104           2 :             break;
     105           0 :         default:
     106           0 :             av_log(avctx, AV_LOG_ERROR, "Invalid bits per pixel value (%d)\n",
     107             :                    avctx->bits_per_coded_sample);
     108           0 :             return AVERROR_INVALIDDATA;
     109             :         }
     110             :     } else {
     111           0 :         avctx->pix_fmt = AV_PIX_FMT_BGR0;
     112           0 :         ctx->component_size = 4;
     113           0 :         av_log(avctx, AV_LOG_WARNING, "Invalid codec tag\n");
     114             :     }
     115             : 
     116             :     /* Store the value to check for keyframes */
     117          10 :     ctx->inflated_size = avctx->width * avctx->height * ctx->component_size;
     118             : 
     119             :     /* Allocate maximum size possible, a full frame */
     120          10 :     ctx->inflated_buf = av_malloc(ctx->inflated_size);
     121          10 :     if (!ctx->inflated_buf)
     122           0 :         return AVERROR(ENOMEM);
     123             : 
     124          10 :     return 0;
     125             : }
     126             : 
     127          10 : static av_cold int rscc_close(AVCodecContext *avctx)
     128             : {
     129          10 :     RsccContext *ctx = avctx->priv_data;
     130             : 
     131          10 :     av_freep(&ctx->tiles);
     132          10 :     av_freep(&ctx->inflated_buf);
     133          10 :     av_frame_free(&ctx->reference);
     134             : 
     135          10 :     return 0;
     136             : }
     137             : 
     138          32 : static int rscc_decode_frame(AVCodecContext *avctx, void *data,
     139             :                                      int *got_frame, AVPacket *avpkt)
     140             : {
     141          32 :     RsccContext *ctx = avctx->priv_data;
     142          32 :     GetByteContext *gbc = &ctx->gbc;
     143             :     GetByteContext tiles_gbc;
     144          32 :     AVFrame *frame = data;
     145             :     const uint8_t *pixels, *raw;
     146          32 :     uint8_t *inflated_tiles = NULL;
     147          32 :     int tiles_nb, packed_size, pixel_size = 0;
     148          32 :     int i, ret = 0;
     149             : 
     150          32 :     bytestream2_init(gbc, avpkt->data, avpkt->size);
     151             : 
     152             :     /* Size check */
     153          32 :     if (bytestream2_get_bytes_left(gbc) < 12) {
     154           0 :         av_log(avctx, AV_LOG_ERROR, "Packet too small (%d)\n", avpkt->size);
     155           0 :         return AVERROR_INVALIDDATA;
     156             :     }
     157             : 
     158             :     /* Read number of tiles, and allocate the array */
     159          32 :     tiles_nb = bytestream2_get_le16(gbc);
     160          32 :     av_fast_malloc(&ctx->tiles, &ctx->tiles_size,
     161             :                    tiles_nb * sizeof(*ctx->tiles));
     162          32 :     if (!ctx->tiles) {
     163           0 :         ret = AVERROR(ENOMEM);
     164           0 :         goto end;
     165             :     }
     166             : 
     167          32 :     av_log(avctx, AV_LOG_DEBUG, "Frame with %d tiles.\n", tiles_nb);
     168             : 
     169             :     /* When there are more than 5 tiles, they are packed together with
     170             :      * a size header. When that size does not match the number of tiles
     171             :      * times the tile size, it means it needs to be inflated as well */
     172          32 :     if (tiles_nb > 5) {
     173             :         uLongf packed_tiles_size;
     174             : 
     175          24 :         if (tiles_nb < 32)
     176          17 :             packed_tiles_size = bytestream2_get_byte(gbc);
     177             :         else
     178           7 :             packed_tiles_size = bytestream2_get_le16(gbc);
     179             : 
     180             :         ff_dlog(avctx, "packed tiles of size %lu.\n", packed_tiles_size);
     181             : 
     182             :         /* If necessary, uncompress tiles, and hijack the bytestream reader */
     183          24 :         if (packed_tiles_size != tiles_nb * TILE_SIZE) {
     184          24 :             uLongf length = tiles_nb * TILE_SIZE;
     185          24 :             inflated_tiles = av_malloc(length);
     186          24 :             if (!inflated_tiles) {
     187           0 :                 ret = AVERROR(ENOMEM);
     188           0 :                 goto end;
     189             :             }
     190             : 
     191          24 :             ret = uncompress(inflated_tiles, &length,
     192          24 :                              gbc->buffer, packed_tiles_size);
     193          24 :             if (ret) {
     194           0 :                 av_log(avctx, AV_LOG_ERROR, "Tile deflate error %d.\n", ret);
     195           0 :                 ret = AVERROR_UNKNOWN;
     196           0 :                 goto end;
     197             :             }
     198             : 
     199             :             /* Skip the compressed tile section in the main byte reader,
     200             :              * and point it to read the newly uncompressed data */
     201          24 :             bytestream2_skip(gbc, packed_tiles_size);
     202          24 :             bytestream2_init(&tiles_gbc, inflated_tiles, length);
     203          24 :             gbc = &tiles_gbc;
     204             :         }
     205             :     }
     206             : 
     207             :     /* Fill in array of tiles, keeping track of how many pixels are updated */
     208         712 :     for (i = 0; i < tiles_nb; i++) {
     209         680 :         ctx->tiles[i].x = bytestream2_get_le16(gbc);
     210         680 :         ctx->tiles[i].w = bytestream2_get_le16(gbc);
     211         680 :         ctx->tiles[i].y = bytestream2_get_le16(gbc);
     212         680 :         ctx->tiles[i].h = bytestream2_get_le16(gbc);
     213             : 
     214         680 :         if (pixel_size + ctx->tiles[i].w * (int64_t)ctx->tiles[i].h * ctx->component_size > INT_MAX) {
     215           0 :             av_log(avctx, AV_LOG_ERROR, "Invalid tile dimensions\n");
     216           0 :             ret = AVERROR_INVALIDDATA;
     217           0 :             goto end;
     218             :         }
     219             : 
     220         680 :         pixel_size += ctx->tiles[i].w * ctx->tiles[i].h * ctx->component_size;
     221             : 
     222             :         ff_dlog(avctx, "tile %d orig(%d,%d) %dx%d.\n", i,
     223             :                 ctx->tiles[i].x, ctx->tiles[i].y,
     224             :                 ctx->tiles[i].w, ctx->tiles[i].h);
     225             : 
     226         680 :         if (ctx->tiles[i].w == 0 || ctx->tiles[i].h == 0) {
     227           0 :             av_log(avctx, AV_LOG_ERROR,
     228             :                    "invalid tile %d at (%d.%d) with size %dx%d.\n", i,
     229           0 :                    ctx->tiles[i].x, ctx->tiles[i].y,
     230           0 :                    ctx->tiles[i].w, ctx->tiles[i].h);
     231           0 :             ret = AVERROR_INVALIDDATA;
     232           0 :             goto end;
     233        1360 :         } else if (ctx->tiles[i].x + ctx->tiles[i].w > avctx->width ||
     234         680 :                    ctx->tiles[i].y + ctx->tiles[i].h > avctx->height) {
     235           0 :             av_log(avctx, AV_LOG_ERROR,
     236             :                    "out of bounds tile %d at (%d.%d) with size %dx%d.\n", i,
     237           0 :                    ctx->tiles[i].x, ctx->tiles[i].y,
     238           0 :                    ctx->tiles[i].w, ctx->tiles[i].h);
     239           0 :             ret = AVERROR_INVALIDDATA;
     240           0 :             goto end;
     241             :         }
     242             :     }
     243             : 
     244             :     /* Reset the reader in case it had been modified before */
     245          32 :     gbc = &ctx->gbc;
     246             : 
     247             :     /* Extract how much pixel data the tiles contain */
     248          32 :     if (pixel_size < 0x100)
     249           0 :         packed_size = bytestream2_get_byte(gbc);
     250          32 :     else if (pixel_size < 0x10000)
     251           0 :         packed_size = bytestream2_get_le16(gbc);
     252          32 :     else if (pixel_size < 0x1000000)
     253          32 :         packed_size = bytestream2_get_le24(gbc);
     254             :     else
     255           0 :         packed_size = bytestream2_get_le32(gbc);
     256             : 
     257             :     ff_dlog(avctx, "pixel_size %d packed_size %d.\n", pixel_size, packed_size);
     258             : 
     259          32 :     if (packed_size < 0) {
     260           0 :         av_log(avctx, AV_LOG_ERROR, "Invalid tile size %d\n", packed_size);
     261           0 :         ret = AVERROR_INVALIDDATA;
     262           0 :         goto end;
     263             :     }
     264             : 
     265             :     /* Get pixels buffer, it may be deflated or just raw */
     266          32 :     if (pixel_size == packed_size) {
     267           0 :         if (bytestream2_get_bytes_left(gbc) < pixel_size) {
     268           0 :             av_log(avctx, AV_LOG_ERROR, "Insufficient input for %d\n", pixel_size);
     269           0 :             ret = AVERROR_INVALIDDATA;
     270           0 :             goto end;
     271             :         }
     272           0 :         pixels = gbc->buffer;
     273             :     } else {
     274          32 :         uLongf len = ctx->inflated_size;
     275          32 :         if (bytestream2_get_bytes_left(gbc) < packed_size) {
     276           2 :             av_log(avctx, AV_LOG_ERROR, "Insufficient input for %d\n", packed_size);
     277           2 :             ret = AVERROR_INVALIDDATA;
     278           4 :             goto end;
     279             :         }
     280          30 :         ret = uncompress(ctx->inflated_buf, &len, gbc->buffer, packed_size);
     281          30 :         if (ret) {
     282           0 :             av_log(avctx, AV_LOG_ERROR, "Pixel deflate error %d.\n", ret);
     283           0 :             ret = AVERROR_UNKNOWN;
     284           0 :             goto end;
     285             :         }
     286          30 :         pixels = ctx->inflated_buf;
     287             :     }
     288             : 
     289             :     /* Allocate when needed */
     290          30 :     ret = ff_reget_buffer(avctx, ctx->reference);
     291          30 :     if (ret < 0)
     292           0 :         goto end;
     293             : 
     294             :     /* Pointer to actual pixels, will be updated when data is consumed */
     295          30 :     raw = pixels;
     296         694 :     for (i = 0; i < tiles_nb; i++) {
     297        1992 :         uint8_t *dst = ctx->reference->data[0] + ctx->reference->linesize[0] *
     298        1328 :                        (avctx->height - ctx->tiles[i].y - 1) +
     299         664 :                        ctx->tiles[i].x * ctx->component_size;
     300        1992 :         av_image_copy_plane(dst, -1 * ctx->reference->linesize[0],
     301         664 :                             raw, ctx->tiles[i].w * ctx->component_size,
     302         664 :                             ctx->tiles[i].w * ctx->component_size,
     303         664 :                             ctx->tiles[i].h);
     304         664 :         raw += ctx->tiles[i].w * ctx->component_size * ctx->tiles[i].h;
     305             :     }
     306             : 
     307             :     /* Frame is ready to be output */
     308          30 :     ret = av_frame_ref(frame, ctx->reference);
     309          30 :     if (ret < 0)
     310           0 :         goto end;
     311             : 
     312             :     /* Keyframe when the number of pixels updated matches the whole surface */
     313          30 :     if (pixel_size == ctx->inflated_size) {
     314           5 :         frame->pict_type = AV_PICTURE_TYPE_I;
     315           5 :         frame->key_frame = 1;
     316             :     } else {
     317          25 :         frame->pict_type = AV_PICTURE_TYPE_P;
     318             :     }
     319             : 
     320             :     /* Palette handling */
     321          30 :     if (avctx->pix_fmt == AV_PIX_FMT_PAL8) {
     322             :         int size;
     323           1 :         const uint8_t *palette = av_packet_get_side_data(avpkt,
     324             :                                                          AV_PKT_DATA_PALETTE,
     325             :                                                          &size);
     326           1 :         if (palette && size == AVPALETTE_SIZE) {
     327           1 :             frame->palette_has_changed = 1;
     328           1 :             memcpy(ctx->palette, palette, AVPALETTE_SIZE);
     329           0 :         } else if (palette) {
     330           0 :             av_log(avctx, AV_LOG_ERROR, "Palette size %d is wrong\n", size);
     331             :         }
     332           1 :         memcpy (frame->data[1], ctx->palette, AVPALETTE_SIZE);
     333             :     }
     334             : 
     335          30 :     *got_frame = 1;
     336             : 
     337          30 :     ret = avpkt->size;
     338          32 : end:
     339          32 :     av_free(inflated_tiles);
     340          32 :     return ret;
     341             : }
     342             : 
     343             : AVCodec ff_rscc_decoder = {
     344             :     .name           = "rscc",
     345             :     .long_name      = NULL_IF_CONFIG_SMALL("innoHeim/Rsupport Screen Capture Codec"),
     346             :     .type           = AVMEDIA_TYPE_VIDEO,
     347             :     .id             = AV_CODEC_ID_RSCC,
     348             :     .init           = rscc_init,
     349             :     .decode         = rscc_decode_frame,
     350             :     .close          = rscc_close,
     351             :     .priv_data_size = sizeof(RsccContext),
     352             :     .capabilities   = AV_CODEC_CAP_DR1,
     353             :     .caps_internal  = FF_CODEC_CAP_INIT_THREADSAFE |
     354             :                       FF_CODEC_CAP_INIT_CLEANUP,
     355             : };

Generated by: LCOV version 1.13