Screenpresso SPV1 decoder
[ffmpeg.git] / libavcodec / screenpresso.c
1 /*
2  * Screenpresso decoder
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  * Screenpresso decoder
25  *
26  * Fourcc: SPV1
27  *
28  * Screenpresso simply horizontally flips and then deflates frames,
29  * alternating full pictures and deltas. Deltas are related to the currently
30  * rebuilt frame (not the reference), and since there is no coordinate system
31  * they contain exactly as many pixel as the keyframe.
32  *
33  * Supports: BGR24
34  */
35
36 #include <stdint.h>
37 #include <string.h>
38 #include <zlib.h>
39
40 #include "libavutil/imgutils.h"
41 #include "libavutil/internal.h"
42
43 #include "avcodec.h"
44 #include "internal.h"
45
46 typedef struct ScreenpressoContext {
47     AVFrame *current;
48
49     /* zlib interation */
50     uint8_t *inflated_buf;
51     uLongf inflated_size;
52 } ScreenpressoContext;
53
54 static av_cold int screenpresso_close(AVCodecContext *avctx)
55 {
56     ScreenpressoContext *ctx = avctx->priv_data;
57
58     av_frame_free(&ctx->current);
59     av_freep(&ctx->inflated_buf);
60
61     return 0;
62 }
63
64 static av_cold int screenpresso_init(AVCodecContext *avctx)
65 {
66     ScreenpressoContext *ctx = avctx->priv_data;
67
68     /* These needs to be set to estimate uncompressed buffer */
69     int ret = av_image_check_size(avctx->width, avctx->height, 0, avctx);
70     if (ret < 0) {
71         av_log(avctx, AV_LOG_ERROR, "Invalid image size %dx%d.\n",
72                avctx->width, avctx->height);
73         return ret;
74     }
75
76     /* Allocate current frame */
77     ctx->current = av_frame_alloc();
78     if (!ctx->current)
79         return AVERROR(ENOMEM);
80
81     avctx->pix_fmt = AV_PIX_FMT_BGR24;
82
83     return 0;
84 }
85
86 static void sum_delta_flipped(uint8_t       *dst, int dst_linesize,
87                               const uint8_t *src, int src_linesize,
88                               int bytewidth, int height)
89 {
90     int i;
91     for (; height > 0; height--) {
92         for (i = 0; i < bytewidth; i++)
93             dst[i] += src[(height - 1) * src_linesize + i];
94         dst += dst_linesize;
95     }
96 }
97
98 static int screenpresso_decode_frame(AVCodecContext *avctx, void *data,
99                                      int *got_frame, AVPacket *avpkt)
100 {
101     ScreenpressoContext *ctx = avctx->priv_data;
102     AVFrame *frame = data;
103     int keyframe;
104     int ret;
105
106     /* Size check */
107     if (avpkt->size < 3) {
108         av_log(avctx, AV_LOG_ERROR, "Packet too small (%d)\n", avpkt->size);
109         return AVERROR_INVALIDDATA;
110     }
111
112     /* Basic sanity check, but not really harmful */
113     if ((avpkt->data[0] != 0x73 && avpkt->data[0] != 0x72) ||
114         avpkt->data[1] != 8) { // bpp probably
115         av_log(avctx, AV_LOG_WARNING, "Unknown header 0x%02X%02X\n",
116                avpkt->data[0], avpkt->data[1]);
117     }
118     keyframe = (avpkt->data[0] == 0x73);
119
120     /* Resize deflate buffer and frame on resolution change */
121     if (ctx->inflated_size != avctx->width * avctx->height * 3) {
122         av_frame_unref(ctx->current);
123         ret = ff_get_buffer(avctx, ctx->current, AV_GET_BUFFER_FLAG_REF);
124         if (ret < 0)
125             return ret;
126
127         /* If malloc fails, reset len to avoid preserving an invalid value */
128         ctx->inflated_size = avctx->width * avctx->height * 3;
129         ret = av_reallocp(&ctx->inflated_buf, ctx->inflated_size);
130         if (ret < 0) {
131             ctx->inflated_size = 0;
132             return ret;
133         }
134     }
135
136     /* Inflate the frame after the 2 byte header */
137     ret = uncompress(ctx->inflated_buf, &ctx->inflated_size,
138                      avpkt->data + 2, avpkt->size - 2);
139     if (ret) {
140         av_log(avctx, AV_LOG_ERROR, "Deflate error %d.\n", ret);
141         return AVERROR_UNKNOWN;
142     }
143
144     /* When a keyframe is found, copy it (flipped) */
145     if (keyframe)
146         av_image_copy_plane(ctx->current->data[0] +
147                             ctx->current->linesize[0] * (avctx->height - 1),
148                             -1 * ctx->current->linesize[0],
149                             ctx->inflated_buf, avctx->width * 3,
150                             avctx->width * 3, avctx->height);
151     /* Otherwise sum the delta on top of the current frame */
152     else
153         sum_delta_flipped(ctx->current->data[0], ctx->current->linesize[0],
154                           ctx->inflated_buf, avctx->width * 3,
155                           avctx->width * 3, avctx->height);
156
157     /* Frame is ready to be output */
158     ret = av_frame_ref(frame, ctx->current);
159     if (ret < 0)
160         return ret;
161
162     /* Usual properties */
163     if (keyframe) {
164         frame->pict_type = AV_PICTURE_TYPE_I;
165         frame->key_frame = 1;
166     } else {
167         frame->pict_type = AV_PICTURE_TYPE_P;
168     }
169     *got_frame = 1;
170
171     return 0;
172 }
173
174 AVCodec ff_screenpresso_decoder = {
175     .name           = "screenpresso",
176     .long_name      = NULL_IF_CONFIG_SMALL("Screenpresso"),
177     .type           = AVMEDIA_TYPE_VIDEO,
178     .id             = AV_CODEC_ID_SCREENPRESSO,
179     .init           = screenpresso_init,
180     .decode         = screenpresso_decode_frame,
181     .close          = screenpresso_close,
182     .priv_data_size = sizeof(ScreenpressoContext),
183     .capabilities   = AV_CODEC_CAP_DR1,
184     .caps_internal  = FF_CODEC_CAP_INIT_THREADSAFE |
185                       FF_CODEC_CAP_INIT_CLEANUP,
186 };