git.sesse.net Git - ffmpeg/blob - libavcodec/rscc.c

   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: BGRA
  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
  61     /* zlib interaction */
  62     uint8_t *inflated_buf;
  63     uLongf inflated_size;
  64 } RsccContext;
  65
  66 static av_cold int rscc_init(AVCodecContext *avctx)
  67 {
  68     RsccContext *ctx = avctx->priv_data;
  69
  70     /* These needs to be set to estimate uncompressed buffer */
  71     int ret = av_image_check_size(avctx->width, avctx->height, 0, avctx);
  72     if (ret < 0) {
  73         av_log(avctx, AV_LOG_ERROR, "Invalid image size %dx%d.\n",
  74                avctx->width, avctx->height);
  75         return ret;
  76     }
  77
  78     /* Allocate reference frame */
  79     ctx->reference = av_frame_alloc();
  80     if (!ctx->reference)
  81         return AVERROR(ENOMEM);
  82
  83     avctx->pix_fmt = AV_PIX_FMT_BGRA;
  84
  85     /* Store the value to check for keyframes */
  86     ctx->inflated_size = avctx->width * avctx->height * 4;
  87
  88     /* Allocate maximum size possible, a full frame */
  89     ctx->inflated_buf = av_malloc(ctx->inflated_size);
  90     if (!ctx->inflated_buf)
  91         return AVERROR(ENOMEM);
  92
  93     return 0;
  94 }
  95
  96 static av_cold int rscc_close(AVCodecContext *avctx)
  97 {
  98     RsccContext *ctx = avctx->priv_data;
  99
 100     av_freep(&ctx->tiles);
 101     av_freep(&ctx->inflated_buf);
 102     av_frame_free(&ctx->reference);
 103
 104     return 0;
 105 }
 106
 107 static int rscc_decode_frame(AVCodecContext *avctx, void *data,
 108                                      int *got_frame, AVPacket *avpkt)
 109 {
 110     RsccContext *ctx = avctx->priv_data;
 111     GetByteContext *gbc = &ctx->gbc;
 112     GetByteContext tiles_gbc;
 113     AVFrame *frame = data;
 114     const uint8_t *pixels, *raw;
 115     uint8_t *inflated_tiles = NULL;
 116     int tiles_nb, packed_size, pixel_size = 0;
 117     int i, ret = 0;
 118
 119     bytestream2_init(gbc, avpkt->data, avpkt->size);
 120
 121     /* Size check */
 122     if (bytestream2_get_bytes_left(gbc) < 12) {
 123         av_log(avctx, AV_LOG_ERROR, "Packet too small (%d)\n", avpkt->size);
 124         return AVERROR_INVALIDDATA;
 125     }
 126
 127     /* Read number of tiles, and allocate the array */
 128     tiles_nb = bytestream2_get_le16(gbc);
 129     av_fast_malloc(&ctx->tiles, &ctx->tiles_size,
 130                    tiles_nb * sizeof(*ctx->tiles));
 131     if (!ctx->tiles) {
 132         ret = AVERROR(ENOMEM);
 133         goto end;
 134     }
 135
 136     av_log(avctx, AV_LOG_DEBUG, "Frame with %d tiles.\n", tiles_nb);
 137
 138     /* When there are more than 5 tiles, they are packed together with
 139      * a size header. When that size does not match the number of tiles
 140      * times the tile size, it means it needs to be inflated as well */
 141     if (tiles_nb > 5) {
 142         uLongf packed_tiles_size;
 143
 144         if (tiles_nb < 32)
 145             packed_tiles_size = bytestream2_get_byte(gbc);
 146         else
 147             packed_tiles_size = bytestream2_get_le16(gbc);
 148
 149         ff_dlog(avctx, "packed tiles of size %lu.\n", packed_tiles_size);
 150
 151         /* If necessary, uncompress tiles, and hijack the bytestream reader */
 152         if (packed_tiles_size != tiles_nb * TILE_SIZE) {
 153             uLongf length = tiles_nb * TILE_SIZE;
 154             inflated_tiles = av_malloc(length);
 155             if (!inflated_tiles) {
 156                 ret = AVERROR(ENOMEM);
 157                 goto end;
 158             }
 159
 160             ret = uncompress(inflated_tiles, &length,
 161                              gbc->buffer, packed_tiles_size);
 162             if (ret) {
 163                 av_log(avctx, AV_LOG_ERROR, "Tile deflate error %d.\n", ret);
 164                 ret = AVERROR_UNKNOWN;
 165                 goto end;
 166             }
 167
 168             /* Skip the compressed tile section in the main byte reader,
 169              * and point it to read the newly uncompressed data */
 170             bytestream2_skip(gbc, packed_tiles_size);
 171             bytestream2_init(&tiles_gbc, inflated_tiles, length);
 172             gbc = &tiles_gbc;
 173         }
 174     }
 175
 176     /* Fill in array of tiles, keeping track of how many pixels are updated */
 177     for (i = 0; i < tiles_nb; i++) {
 178         ctx->tiles[i].x = bytestream2_get_le16(gbc);
 179         ctx->tiles[i].w = bytestream2_get_le16(gbc);
 180         ctx->tiles[i].y = bytestream2_get_le16(gbc);
 181         ctx->tiles[i].h = bytestream2_get_le16(gbc);
 182
 183         pixel_size += ctx->tiles[i].w * ctx->tiles[i].h * 4;
 184
 185         ff_dlog(avctx, "tile %d orig(%d,%d) %dx%d.\n", i,
 186                 ctx->tiles[i].x, ctx->tiles[i].y,
 187                 ctx->tiles[i].w, ctx->tiles[i].h);
 188
 189         if (ctx->tiles[i].w == 0 || ctx->tiles[i].h == 0) {
 190             av_log(avctx, AV_LOG_ERROR,
 191                    "invalid tile %d at (%d.%d) with size %dx%d.\n", i,
 192                    ctx->tiles[i].x, ctx->tiles[i].y,
 193                    ctx->tiles[i].w, ctx->tiles[i].h);
 194             ret = AVERROR_INVALIDDATA;
 195             goto end;
 196         } else if (ctx->tiles[i].x + ctx->tiles[i].w > avctx->width ||
 197                    ctx->tiles[i].y + ctx->tiles[i].h > avctx->height) {
 198             av_log(avctx, AV_LOG_ERROR,
 199                    "out of bounds tile %d at (%d.%d) with size %dx%d.\n", i,
 200                    ctx->tiles[i].x, ctx->tiles[i].y,
 201                    ctx->tiles[i].w, ctx->tiles[i].h);
 202             ret = AVERROR_INVALIDDATA;
 203             goto end;
 204         }
 205     }
 206
 207     /* Reset the reader in case it had been modified before */
 208     gbc = &ctx->gbc;
 209
 210     /* Extract how much pixel data the tiles contain */
 211     if (pixel_size < 0x100)
 212         packed_size = bytestream2_get_byte(gbc);
 213     else if (pixel_size < 0x10000)
 214         packed_size = bytestream2_get_le16(gbc);
 215     else if (pixel_size < 0x1000000)
 216         packed_size = bytestream2_get_le24(gbc);
 217     else
 218         packed_size = bytestream2_get_le32(gbc);
 219
 220     ff_dlog(avctx, "pixel_size %d packed_size %d.\n", pixel_size, packed_size);
 221
 222     /* Get pixels buffer, it may be deflated or just raw */
 223     if (pixel_size == packed_size) {
 224         pixels = gbc->buffer;
 225     } else {
 226         uLongf len = ctx->inflated_size;
 227         ret = uncompress(ctx->inflated_buf, &len, gbc->buffer, packed_size);
 228         if (ret) {
 229             av_log(avctx, AV_LOG_ERROR, "Pixel deflate error %d.\n", ret);
 230             ret = AVERROR_UNKNOWN;
 231             goto end;
 232         }
 233         pixels = ctx->inflated_buf;
 234     }
 235
 236     /* Allocate when needed */
 237     ret = ff_reget_buffer(avctx, ctx->reference);
 238     if (ret < 0)
 239         goto end;
 240
 241     /* Pointer to actual pixels, will be updated when data is consumed */
 242     raw = pixels;
 243     for (i = 0; i < tiles_nb; i++) {
 244         uint8_t *dst = ctx->reference->data[0] + ctx->reference->linesize[0] *
 245                        (avctx->height - ctx->tiles[i].y - 1) +
 246                        ctx->tiles[i].x * 4;
 247         av_image_copy_plane(dst, -1 * ctx->reference->linesize[0],
 248                             raw, ctx->tiles[i].w * 4,
 249                             ctx->tiles[i].w * 4, ctx->tiles[i].h);
 250         raw += ctx->tiles[i].w * 4 * ctx->tiles[i].h;
 251     }
 252
 253     /* Frame is ready to be output */
 254     ret = av_frame_ref(frame, ctx->reference);
 255     if (ret < 0)
 256         goto end;
 257
 258     /* Keyframe when the number of pixels updated matches the whole surface */
 259     if (pixel_size == ctx->inflated_size) {
 260         frame->pict_type = AV_PICTURE_TYPE_I;
 261         frame->key_frame = 1;
 262     } else {
 263         frame->pict_type = AV_PICTURE_TYPE_P;
 264     }
 265     *got_frame = 1;
 266
 267 end:
 268     av_free(inflated_tiles);
 269     return ret;
 270 }
 271
 272 AVCodec ff_rscc_decoder = {
 273     .name           = "rscc",
 274     .long_name      = NULL_IF_CONFIG_SMALL("innoHeim/Rsupport Screen Capture Codec"),
 275     .type           = AVMEDIA_TYPE_VIDEO,
 276     .id             = AV_CODEC_ID_RSCC,
 277     .init           = rscc_init,
 278     .decode         = rscc_decode_frame,
 279     .close          = rscc_close,
 280     .priv_data_size = sizeof(RsccContext),
 281     .capabilities   = AV_CODEC_CAP_DR1,
 282     .caps_internal  = FF_CODEC_CAP_INIT_THREADSAFE |
 283                       FF_CODEC_CAP_INIT_CLEANUP,
 284 };