Merge remote branch 'qatar/master'
[ffmpeg.git] / libavcodec / flashsvenc.c
1 /*
2  * Flash Screen Video encoder
3  * Copyright (C) 2004 Alex Beregszaszi
4  * Copyright (C) 2006 Benjamin Larsson
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /* Encoding development sponsored by http://fh-campuswien.ac.at */
24
25 /**
26  * @file
27  * Flash Screen Video encoder
28  * @author Alex Beregszaszi
29  * @author Benjamin Larsson
30  */
31
32 /* Bitstream description
33  * The picture is divided into blocks that are zlib-compressed.
34  *
35  * The decoder is fed complete frames, the frameheader contains:
36  * 4bits of block width
37  * 12bits of frame width
38  * 4bits of block height
39  * 12bits of frame height
40  *
41  * Directly after the header are the compressed blocks. The blocks
42  * have their compressed size represented with 16bits in the beginig.
43  * If the size = 0 then the block is unchanged from the previous frame.
44  * All blocks are decompressed until the buffer is consumed.
45  *
46  * Encoding ideas, a basic encoder would just use a fixed block size.
47  * Block sizes can be multipels of 16, from 16 to 256. The blocks don't
48  * have to be quadratic. A brute force search with a set of different
49  * block sizes should give a better result than to just use a fixed size.
50  */
51
52 /* TODO:
53  * Don't reencode the frame in brute force mode if the frame is a dupe. Speed up.
54  * Make the difference check faster.
55  */
56
57 #include <stdio.h>
58 #include <stdlib.h>
59 #include <zlib.h>
60
61 #include "avcodec.h"
62 #include "put_bits.h"
63 #include "bytestream.h"
64
65
66 typedef struct FlashSVContext {
67     AVCodecContext *avctx;
68     uint8_t        *previous_frame;
69     AVFrame         frame;
70     int             image_width, image_height;
71     int             block_width, block_height;
72     uint8_t        *tmpblock;
73     uint8_t        *encbuffer;
74     int             block_size;
75     z_stream        zstream;
76     int             last_key_frame;
77 } FlashSVContext;
78
79 static int copy_region_enc(uint8_t *sptr, uint8_t *dptr, int dx, int dy,
80                            int h, int w, int stride, uint8_t *pfptr)
81 {
82     int i, j;
83     uint8_t *nsptr;
84     uint8_t *npfptr;
85     int diff = 0;
86
87     for (i = dx + h; i > dx; i--) {
88         nsptr  = sptr  + (i * stride) + dy * 3;
89         npfptr = pfptr + (i * stride) + dy * 3;
90         for (j = 0; j < w * 3; j++) {
91             diff    |= npfptr[j] ^ nsptr[j];
92             dptr[j]  = nsptr[j];
93         }
94         dptr += w * 3;
95     }
96     if (diff)
97         return 1;
98     return 0;
99 }
100
101 static av_cold int flashsv_encode_init(AVCodecContext *avctx)
102 {
103     FlashSVContext *s = avctx->priv_data;
104
105     s->avctx = avctx;
106
107     if ((avctx->width > 4095) || (avctx->height > 4095)) {
108         av_log(avctx, AV_LOG_ERROR, "Input dimensions too large, input must be max 4096x4096 !\n");
109         return AVERROR_INVALIDDATA;
110     }
111
112     // Needed if zlib unused or init aborted before deflateInit
113     memset(&(s->zstream), 0, sizeof(z_stream));
114
115     s->last_key_frame = 0;
116
117     s->image_width  = avctx->width;
118     s->image_height = avctx->height;
119
120     s->tmpblock  = av_mallocz(3 * 256 * 256);
121     s->encbuffer = av_mallocz(s->image_width * s->image_height * 3);
122
123     if (!s->tmpblock || !s->encbuffer) {
124         av_log(avctx, AV_LOG_ERROR, "Memory allocation failed.\n");
125         return AVERROR(ENOMEM);
126     }
127
128     return 0;
129 }
130
131
132 static int encode_bitstream(FlashSVContext *s, AVFrame *p, uint8_t *buf,
133                             int buf_size, int block_width, int block_height,
134                             uint8_t *previous_frame, int *I_frame)
135 {
136
137     PutBitContext pb;
138     int h_blocks, v_blocks, h_part, v_part, i, j;
139     int buf_pos, res;
140     int pred_blocks = 0;
141
142     init_put_bits(&pb, buf, buf_size * 8);
143
144     put_bits(&pb,  4, (block_width / 16) - 1);
145     put_bits(&pb, 12, s->image_width);
146     put_bits(&pb,  4, (block_height / 16) - 1);
147     put_bits(&pb, 12, s->image_height);
148     flush_put_bits(&pb);
149     buf_pos = 4;
150
151     h_blocks = s->image_width  / block_width;
152     h_part   = s->image_width  % block_width;
153     v_blocks = s->image_height / block_height;
154     v_part   = s->image_height % block_height;
155
156     /* loop over all block columns */
157     for (j = 0; j < v_blocks + (v_part ? 1 : 0); j++) {
158
159         int hp = j * block_height; // horiz position in frame
160         int hs = (j < v_blocks) ? block_height : v_part; // size of block
161
162         /* loop over all block rows */
163         for (i = 0; i < h_blocks + (h_part ? 1 : 0); i++) {
164             int wp  = i * block_width; // vert position in frame
165             int ws  = (i < h_blocks) ? block_width : h_part; // size of block
166             int ret = Z_OK;
167             uint8_t *ptr;
168
169             ptr = buf + buf_pos;
170
171             /* copy the block to the temp buffer before compression
172              * (if it differs from the previous frame's block) */
173             res = copy_region_enc(p->data[0], s->tmpblock,
174                                   s->image_height - (hp + hs + 1),
175                                   wp, hs, ws, p->linesize[0], previous_frame);
176
177             if (res || *I_frame) {
178                 unsigned long zsize;
179                 zsize = 3 * block_width * block_height;
180                 ret   = compress2(ptr + 2, &zsize, s->tmpblock, 3 * ws * hs, 9);
181
182
183                 //ret = deflateReset(&(s->zstream));
184                 if (ret != Z_OK)
185                     av_log(s->avctx, AV_LOG_ERROR, "error while compressing block %dx%d\n", i, j);
186
187                 bytestream_put_be16(&ptr, (unsigned int) zsize);
188                 buf_pos += zsize + 2;
189                 //av_log(avctx, AV_LOG_ERROR, "buf_pos = %d\n", buf_pos);
190             } else {
191                 pred_blocks++;
192                 bytestream_put_be16(&ptr, 0);
193                 buf_pos += 2;
194             }
195         }
196     }
197
198     if (pred_blocks)
199         *I_frame = 0;
200     else
201         *I_frame = 1;
202
203     return buf_pos;
204 }
205
206
207 static int flashsv_encode_frame(AVCodecContext *avctx, uint8_t *buf,
208                                 int buf_size, void *data)
209 {
210     FlashSVContext * const s = avctx->priv_data;
211     AVFrame *pict = data;
212     AVFrame * const p = &s->frame;
213     uint8_t *pfptr;
214     int res;
215     int I_frame = 0;
216     int opt_w, opt_h;
217
218     *p = *pict;
219
220     /* First frame needs to be a keyframe */
221     if (avctx->frame_number == 0) {
222         s->previous_frame = av_mallocz(FFABS(p->linesize[0]) * s->image_height);
223         if (!s->previous_frame) {
224             av_log(avctx, AV_LOG_ERROR, "Memory allocation failed.\n");
225             return AVERROR(ENOMEM);
226         }
227         I_frame = 1;
228     }
229
230     if (p->linesize[0] < 0)
231         pfptr = s->previous_frame - ((s->image_height - 1) * p->linesize[0]);
232     else
233         pfptr = s->previous_frame;
234
235     /* Check the placement of keyframes */
236     if (avctx->gop_size > 0) {
237         if (avctx->frame_number >= s->last_key_frame + avctx->gop_size) {
238             I_frame = 1;
239         }
240     }
241
242     opt_w = 4;
243     opt_h = 4;
244
245     if (buf_size < s->image_width*s->image_height*3) {
246         //Conservative upper bound check for compressed data
247         av_log(avctx, AV_LOG_ERROR, "buf_size %d <  %d\n",
248                buf_size, s->image_width * s->image_height * 3);
249         return -1;
250     }
251
252     res = encode_bitstream(s, p, buf, buf_size, opt_w * 16, opt_h * 16, pfptr, &I_frame);
253
254     //save the current frame
255     if (p->linesize[0] > 0)
256         memcpy(s->previous_frame, p->data[0], s->image_height * p->linesize[0]);
257     else
258         memcpy(s->previous_frame, p->data[0] + p->linesize[0] * (s->image_height - 1),
259                s->image_height * FFABS(p->linesize[0]));
260
261     //mark the frame type so the muxer can mux it correctly
262     if (I_frame) {
263         p->pict_type = AV_PICTURE_TYPE_I;
264         p->key_frame = 1;
265         s->last_key_frame = avctx->frame_number;
266         av_log(avctx, AV_LOG_DEBUG, "Inserting key frame at frame %d\n", avctx->frame_number);
267     } else {
268         p->pict_type = AV_PICTURE_TYPE_P;
269         p->key_frame = 0;
270     }
271
272     avctx->coded_frame = p;
273
274     return res;
275 }
276
277 static av_cold int flashsv_encode_end(AVCodecContext *avctx)
278 {
279     FlashSVContext *s = avctx->priv_data;
280
281     deflateEnd(&(s->zstream));
282
283     av_free(s->encbuffer);
284     av_free(s->previous_frame);
285     av_free(s->tmpblock);
286
287     return 0;
288 }
289
290 AVCodec ff_flashsv_encoder = {
291     .name           = "flashsv",
292     .type           = AVMEDIA_TYPE_VIDEO,
293     .id             = CODEC_ID_FLASHSV,
294     .priv_data_size = sizeof(FlashSVContext),
295     .init           = flashsv_encode_init,
296     .encode         = flashsv_encode_frame,
297     .close          = flashsv_encode_end,
298     .pix_fmts       = (const enum PixelFormat[]){PIX_FMT_BGR24, PIX_FMT_NONE},
299     .long_name      = NULL_IF_CONFIG_SMALL("Flash Screen Video"),
300 };
301