2 * innoHeim/Rsupport Screen Capture Codec
3 * Copyright (C) 2015 Vittorio Giovara <vittorio.giovara@gmail.com>
5 * This file is part of FFmpeg.
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.
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.
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
24 * innoHeim/Rsupport Screen Capture Codec decoder
28 * Lossless codec, data stored in tiles, with optional deflate compression.
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.
34 * Supports: PAL8, BGRA, BGR24, RGB555
41 #include "libavutil/imgutils.h"
42 #include "libavutil/internal.h"
45 #include "bytestream.h"
55 typedef struct RsccContext {
59 unsigned int tiles_size;
62 uint8_t palette[AVPALETTE_SIZE];
64 /* zlib interaction */
65 uint8_t *inflated_buf;
69 static av_cold int rscc_init(AVCodecContext *avctx)
71 RsccContext *ctx = avctx->priv_data;
73 /* These needs to be set to estimate uncompressed buffer */
74 int ret = av_image_check_size(avctx->width, avctx->height, 0, avctx);
76 av_log(avctx, AV_LOG_ERROR, "Invalid image size %dx%d.\n",
77 avctx->width, avctx->height);
81 /* Allocate reference frame */
82 ctx->reference = av_frame_alloc();
84 return AVERROR(ENOMEM);
86 /* Get pixel format and the size of the pixel */
87 if (avctx->codec_tag == MKTAG('I', 'S', 'C', 'C')) {
88 avctx->pix_fmt = AV_PIX_FMT_BGRA;
89 ctx->component_size = 4;
90 } else if (avctx->codec_tag == MKTAG('R', 'S', 'C', 'C')) {
91 ctx->component_size = avctx->bits_per_coded_sample / 8;
92 switch (avctx->bits_per_coded_sample) {
94 avctx->pix_fmt = AV_PIX_FMT_PAL8;
97 avctx->pix_fmt = AV_PIX_FMT_RGB555LE;
100 avctx->pix_fmt = AV_PIX_FMT_BGR24;
103 avctx->pix_fmt = AV_PIX_FMT_BGR0;
106 av_log(avctx, AV_LOG_ERROR, "Invalid bits per pixel value (%d)\n",
107 avctx->bits_per_coded_sample);
108 return AVERROR_INVALIDDATA;
111 avctx->pix_fmt = AV_PIX_FMT_BGR0;
112 ctx->component_size = 4;
113 av_log(avctx, AV_LOG_WARNING, "Invalid codec tag\n");
116 /* Store the value to check for keyframes */
117 ctx->inflated_size = avctx->width * avctx->height * ctx->component_size;
119 /* Allocate maximum size possible, a full frame */
120 ctx->inflated_buf = av_malloc(ctx->inflated_size);
121 if (!ctx->inflated_buf)
122 return AVERROR(ENOMEM);
127 static av_cold int rscc_close(AVCodecContext *avctx)
129 RsccContext *ctx = avctx->priv_data;
131 av_freep(&ctx->tiles);
132 av_freep(&ctx->inflated_buf);
133 av_frame_free(&ctx->reference);
138 static int rscc_decode_frame(AVCodecContext *avctx, void *data,
139 int *got_frame, AVPacket *avpkt)
141 RsccContext *ctx = avctx->priv_data;
142 GetByteContext *gbc = &ctx->gbc;
143 GetByteContext tiles_gbc;
144 AVFrame *frame = data;
145 const uint8_t *pixels, *raw;
146 uint8_t *inflated_tiles = NULL;
147 int tiles_nb, packed_size, pixel_size = 0;
150 bytestream2_init(gbc, avpkt->data, avpkt->size);
153 if (bytestream2_get_bytes_left(gbc) < 12) {
154 av_log(avctx, AV_LOG_ERROR, "Packet too small (%d)\n", avpkt->size);
155 return AVERROR_INVALIDDATA;
158 /* Read number of tiles, and allocate the array */
159 tiles_nb = bytestream2_get_le16(gbc);
160 av_fast_malloc(&ctx->tiles, &ctx->tiles_size,
161 tiles_nb * sizeof(*ctx->tiles));
163 ret = AVERROR(ENOMEM);
167 av_log(avctx, AV_LOG_DEBUG, "Frame with %d tiles.\n", tiles_nb);
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 */
173 uLongf packed_tiles_size;
176 packed_tiles_size = bytestream2_get_byte(gbc);
178 packed_tiles_size = bytestream2_get_le16(gbc);
180 ff_dlog(avctx, "packed tiles of size %lu.\n", packed_tiles_size);
182 /* If necessary, uncompress tiles, and hijack the bytestream reader */
183 if (packed_tiles_size != tiles_nb * TILE_SIZE) {
184 uLongf length = tiles_nb * TILE_SIZE;
185 inflated_tiles = av_malloc(length);
186 if (!inflated_tiles) {
187 ret = AVERROR(ENOMEM);
191 ret = uncompress(inflated_tiles, &length,
192 gbc->buffer, packed_tiles_size);
194 av_log(avctx, AV_LOG_ERROR, "Tile deflate error %d.\n", ret);
195 ret = AVERROR_UNKNOWN;
199 /* Skip the compressed tile section in the main byte reader,
200 * and point it to read the newly uncompressed data */
201 bytestream2_skip(gbc, packed_tiles_size);
202 bytestream2_init(&tiles_gbc, inflated_tiles, length);
207 /* Fill in array of tiles, keeping track of how many pixels are updated */
208 for (i = 0; i < tiles_nb; i++) {
209 ctx->tiles[i].x = bytestream2_get_le16(gbc);
210 ctx->tiles[i].w = bytestream2_get_le16(gbc);
211 ctx->tiles[i].y = bytestream2_get_le16(gbc);
212 ctx->tiles[i].h = bytestream2_get_le16(gbc);
214 if (pixel_size + ctx->tiles[i].w * (int64_t)ctx->tiles[i].h * ctx->component_size > INT_MAX) {
215 av_log(avctx, AV_LOG_ERROR, "Invalid tile dimensions\n");
216 ret = AVERROR_INVALIDDATA;
220 pixel_size += ctx->tiles[i].w * ctx->tiles[i].h * ctx->component_size;
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);
226 if (ctx->tiles[i].w == 0 || ctx->tiles[i].h == 0) {
227 av_log(avctx, AV_LOG_ERROR,
228 "invalid tile %d at (%d.%d) with size %dx%d.\n", i,
229 ctx->tiles[i].x, ctx->tiles[i].y,
230 ctx->tiles[i].w, ctx->tiles[i].h);
231 ret = AVERROR_INVALIDDATA;
233 } else if (ctx->tiles[i].x + ctx->tiles[i].w > avctx->width ||
234 ctx->tiles[i].y + ctx->tiles[i].h > avctx->height) {
235 av_log(avctx, AV_LOG_ERROR,
236 "out of bounds tile %d at (%d.%d) with size %dx%d.\n", i,
237 ctx->tiles[i].x, ctx->tiles[i].y,
238 ctx->tiles[i].w, ctx->tiles[i].h);
239 ret = AVERROR_INVALIDDATA;
244 /* Reset the reader in case it had been modified before */
247 /* Extract how much pixel data the tiles contain */
248 if (pixel_size < 0x100)
249 packed_size = bytestream2_get_byte(gbc);
250 else if (pixel_size < 0x10000)
251 packed_size = bytestream2_get_le16(gbc);
252 else if (pixel_size < 0x1000000)
253 packed_size = bytestream2_get_le24(gbc);
255 packed_size = bytestream2_get_le32(gbc);
257 ff_dlog(avctx, "pixel_size %d packed_size %d.\n", pixel_size, packed_size);
259 if (packed_size < 0) {
260 av_log(avctx, AV_LOG_ERROR, "Invalid tile size %d\n", packed_size);
261 ret = AVERROR_INVALIDDATA;
265 /* Get pixels buffer, it may be deflated or just raw */
266 if (pixel_size == packed_size) {
267 if (bytestream2_get_bytes_left(gbc) < pixel_size) {
268 av_log(avctx, AV_LOG_ERROR, "Insufficient input for %d\n", pixel_size);
269 ret = AVERROR_INVALIDDATA;
272 pixels = gbc->buffer;
274 uLongf len = ctx->inflated_size;
275 if (bytestream2_get_bytes_left(gbc) < packed_size) {
276 av_log(avctx, AV_LOG_ERROR, "Insufficient input for %d\n", packed_size);
277 ret = AVERROR_INVALIDDATA;
280 ret = uncompress(ctx->inflated_buf, &len, gbc->buffer, packed_size);
282 av_log(avctx, AV_LOG_ERROR, "Pixel deflate error %d.\n", ret);
283 ret = AVERROR_UNKNOWN;
286 pixels = ctx->inflated_buf;
289 /* Allocate when needed */
290 ret = ff_reget_buffer(avctx, ctx->reference);
294 /* Pointer to actual pixels, will be updated when data is consumed */
296 for (i = 0; i < tiles_nb; i++) {
297 uint8_t *dst = ctx->reference->data[0] + ctx->reference->linesize[0] *
298 (avctx->height - ctx->tiles[i].y - 1) +
299 ctx->tiles[i].x * ctx->component_size;
300 av_image_copy_plane(dst, -1 * ctx->reference->linesize[0],
301 raw, ctx->tiles[i].w * ctx->component_size,
302 ctx->tiles[i].w * ctx->component_size,
304 raw += ctx->tiles[i].w * ctx->component_size * ctx->tiles[i].h;
307 /* Frame is ready to be output */
308 ret = av_frame_ref(frame, ctx->reference);
312 /* Keyframe when the number of pixels updated matches the whole surface */
313 if (pixel_size == ctx->inflated_size) {
314 frame->pict_type = AV_PICTURE_TYPE_I;
315 frame->key_frame = 1;
317 frame->pict_type = AV_PICTURE_TYPE_P;
320 /* Palette handling */
321 if (avctx->pix_fmt == AV_PIX_FMT_PAL8) {
323 const uint8_t *palette = av_packet_get_side_data(avpkt,
326 if (palette && size == AVPALETTE_SIZE) {
327 frame->palette_has_changed = 1;
328 memcpy(ctx->palette, palette, AVPALETTE_SIZE);
329 } else if (palette) {
330 av_log(avctx, AV_LOG_ERROR, "Palette size %d is wrong\n", size);
332 memcpy (frame->data[1], ctx->palette, AVPALETTE_SIZE);
339 av_free(inflated_tiles);
343 AVCodec ff_rscc_decoder = {
345 .long_name = NULL_IF_CONFIG_SMALL("innoHeim/Rsupport Screen Capture Codec"),
346 .type = AVMEDIA_TYPE_VIDEO,
347 .id = AV_CODEC_ID_RSCC,
349 .decode = rscc_decode_frame,
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,