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