fix qtrle encoding when previous frame linesize differs, fix #998
[ffmpeg.git] / libavcodec / qtrleenc.c
1 /*
2  * Quicktime Animation (RLE) Video Encoder
3  * Copyright (C) 2007 Clemens Fruhwirth
4  * Copyright (C) 2007 Alexis Ballier
5  *
6  * This file is based on flashsvenc.c.
7  *
8  * This file is part of FFmpeg.
9  *
10  * FFmpeg is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 2.1 of the License, or (at your option) any later version.
14  *
15  * FFmpeg is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with FFmpeg; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  */
24
25 #include "avcodec.h"
26 #include "bytestream.h"
27
28 /** Maximum RLE code for bulk copy */
29 #define MAX_RLE_BULK   127
30 /** Maximum RLE code for repeat */
31 #define MAX_RLE_REPEAT 128
32 /** Maximum RLE code for skip */
33 #define MAX_RLE_SKIP   254
34
35 typedef struct QtrleEncContext {
36     AVCodecContext *avctx;
37     AVFrame frame;
38     int pixel_size;
39     AVPicture previous_frame;
40     unsigned int max_buf_size;
41     /**
42      * This array will contain at ith position the value of the best RLE code
43      * if the line started at pixel i
44      * There can be 3 values :
45      * skip (0)     : skip as much as possible pixels because they are equal to the
46      *                previous frame ones
47      * repeat (<-1) : repeat that pixel -rle_code times, still as much as
48      *                possible
49      * copy (>0)    : copy the raw next rle_code pixels */
50     signed char *rlecode_table;
51     /**
52      * This array will contain the length of the best rle encoding of the line
53      * starting at ith pixel */
54     int *length_table;
55     /**
56      * Will contain at ith position the number of consecutive pixels equal to the previous
57      * frame starting from pixel i */
58     uint8_t* skip_table;
59 } QtrleEncContext;
60
61 static av_cold int qtrle_encode_init(AVCodecContext *avctx)
62 {
63     QtrleEncContext *s = avctx->priv_data;
64
65     if (avcodec_check_dimensions(avctx, avctx->width, avctx->height) < 0) {
66         return -1;
67     }
68     s->avctx=avctx;
69
70     switch (avctx->pix_fmt) {
71 /*    case PIX_FMT_RGB555:
72         s->pixel_size = 2;
73         break;*/
74     case PIX_FMT_RGB24:
75         s->pixel_size = 3;
76         break;
77     default:
78         av_log(avctx, AV_LOG_ERROR, "Unsupported colorspace.\n");
79         break;
80     }
81     avctx->bits_per_coded_sample = s->pixel_size*8;
82
83     s->rlecode_table = av_mallocz(s->avctx->width);
84     s->skip_table    = av_mallocz(s->avctx->width);
85     s->length_table  = av_mallocz((s->avctx->width + 1)*sizeof(int));
86     if (!s->skip_table || !s->length_table || !s->rlecode_table) {
87         av_log(avctx, AV_LOG_ERROR, "Error allocating memory.\n");
88         return -1;
89     }
90     if (avpicture_alloc(&s->previous_frame, avctx->pix_fmt, avctx->width, avctx->height) < 0) {
91         av_log(avctx, AV_LOG_ERROR, "Error allocating picture\n");
92         return -1;
93     }
94
95     s->max_buf_size = s->avctx->width*s->avctx->height*s->pixel_size /* image base material */
96                       + 15                                           /* header + footer */
97                       + s->avctx->height*2                           /* skip code+rle end */
98                       + s->avctx->width/MAX_RLE_BULK + 1             /* rle codes */;
99     avctx->coded_frame = &s->frame;
100     return 0;
101 }
102
103 /**
104  * Computes the best RLE sequence for a line
105  */
106 static void qtrle_encode_line(QtrleEncContext *s, AVFrame *p, int line, uint8_t **buf)
107 {
108     int width=s->avctx->width;
109     int i;
110     signed char rlecode;
111
112     /* We will use it to compute the best bulk copy sequence */
113     unsigned int bulkcount;
114     /* This will be the number of pixels equal to the preivous frame one's
115      * starting from the ith pixel */
116     unsigned int skipcount;
117     /* This will be the number of consecutive equal pixels in the current
118      * frame, starting from the ith one also */
119     unsigned int av_uninit(repeatcount);
120
121     /* The cost of the three different possibilities */
122     int total_bulk_cost;
123     int total_skip_cost;
124     int total_repeat_cost;
125
126     int temp_cost;
127     int j;
128
129     uint8_t *this_line = p->               data[0] + line*p->               linesize[0] +
130         (width - 1)*s->pixel_size;
131     uint8_t *prev_line = s->previous_frame.data[0] + line*s->previous_frame.linesize[0] +
132         (width - 1)*s->pixel_size;
133
134     s->length_table[width] = 0;
135     skipcount = 0;
136
137     for (i = width - 1; i >= 0; i--) {
138
139         if (!s->frame.key_frame && !memcmp(this_line, prev_line, s->pixel_size))
140             skipcount = FFMIN(skipcount + 1, MAX_RLE_SKIP);
141         else
142             skipcount = 0;
143
144         total_skip_cost  = s->length_table[i + skipcount] + 2;
145         s->skip_table[i] = skipcount;
146
147
148         if (i < width - 1 && !memcmp(this_line, this_line + s->pixel_size, s->pixel_size))
149             repeatcount = FFMIN(repeatcount + 1, MAX_RLE_REPEAT);
150         else
151             repeatcount = 1;
152
153         total_repeat_cost = s->length_table[i + repeatcount] + 1 + s->pixel_size;
154
155         /* skip code is free for the first pixel, it costs one byte for repeat and bulk copy
156          * so let's make it aware */
157         if (i == 0) {
158             total_skip_cost--;
159             total_repeat_cost++;
160         }
161
162         if (repeatcount > 1 && (skipcount == 0 || total_repeat_cost < total_skip_cost)) {
163             /* repeat is the best */
164             s->length_table[i]  = total_repeat_cost;
165             s->rlecode_table[i] = -repeatcount;
166         }
167         else if (skipcount > 0) {
168             /* skip is the best choice here */
169             s->length_table[i]  = total_skip_cost;
170             s->rlecode_table[i] = 0;
171         }
172         else {
173             /* We cannot do neither skip nor repeat
174              * thus we search for the best bulk copy to do */
175
176             int limit = FFMIN(width - i, MAX_RLE_BULK);
177
178             temp_cost = 1 + s->pixel_size + !i;
179             total_bulk_cost = INT_MAX;
180
181             for (j = 1; j <= limit; j++) {
182                 if (s->length_table[i + j] + temp_cost < total_bulk_cost) {
183                     /* We have found a better bulk copy ... */
184                     total_bulk_cost = s->length_table[i + j] + temp_cost;
185                     bulkcount = j;
186                 }
187                 temp_cost += s->pixel_size;
188             }
189
190             s->length_table[i]  = total_bulk_cost;
191             s->rlecode_table[i] = bulkcount;
192         }
193
194         this_line -= s->pixel_size;
195         prev_line -= s->pixel_size;
196     }
197
198     /* Good ! Now we have the best sequence for this line, let's ouput it */
199
200     /* We do a special case for the first pixel so that we avoid testing it in
201      * the whole loop */
202
203     i=0;
204     this_line = p->               data[0] + line*p->linesize[0];
205
206     if (s->rlecode_table[0] == 0) {
207         bytestream_put_byte(buf, s->skip_table[0] + 1);
208         i += s->skip_table[0];
209     }
210     else bytestream_put_byte(buf, 1);
211
212
213     while (i < width) {
214         rlecode = s->rlecode_table[i];
215         bytestream_put_byte(buf, rlecode);
216         if (rlecode == 0) {
217             /* Write a skip sequence */
218             bytestream_put_byte(buf, s->skip_table[i] + 1);
219             i += s->skip_table[i];
220         }
221         else if (rlecode > 0) {
222             /* bulk copy */
223             bytestream_put_buffer(buf, this_line + i*s->pixel_size, rlecode*s->pixel_size);
224             i += rlecode;
225         }
226         else {
227             /* repeat the bits */
228             bytestream_put_buffer(buf, this_line + i*s->pixel_size, s->pixel_size);
229             i -= rlecode;
230         }
231     }
232     bytestream_put_byte(buf, -1); // end RLE line
233 }
234
235 /** Encodes frame including header */
236 static int encode_frame(QtrleEncContext *s, AVFrame *p, uint8_t *buf)
237 {
238     int i;
239     int start_line = 0;
240     int end_line = s->avctx->height;
241     uint8_t *orig_buf = buf;
242
243     if (!s->frame.key_frame) {
244         unsigned line_size = s->avctx->width * s->pixel_size;
245         for (start_line = 0; start_line < s->avctx->height; start_line++)
246             if (memcmp(p->data[0] + start_line*p->linesize[0],
247                        s->previous_frame.data[0] + start_line*s->previous_frame.linesize[0],
248                        line_size))
249                 break;
250
251         for (end_line=s->avctx->height; end_line > start_line; end_line--)
252             if (memcmp(p->data[0] + (end_line - 1)*p->linesize[0],
253                        s->previous_frame.data[0] + (end_line - 1)*s->previous_frame.linesize[0],
254                        line_size))
255                 break;
256     }
257
258     bytestream_put_be32(&buf, 0);                         // CHUNK SIZE, patched later
259
260     if ((start_line == 0 && end_line == s->avctx->height) || start_line == s->avctx->height)
261         bytestream_put_be16(&buf, 0);                     // header
262     else {
263         bytestream_put_be16(&buf, 8);                     // header
264         bytestream_put_be16(&buf, start_line);            // starting line
265         bytestream_put_be16(&buf, 0);                     // unknown
266         bytestream_put_be16(&buf, end_line - start_line); // lines to update
267         bytestream_put_be16(&buf, 0);                     // unknown
268     }
269     for (i = start_line; i < end_line; i++)
270         qtrle_encode_line(s, p, i, &buf);
271
272     bytestream_put_byte(&buf, 0);                         // zero skip code = frame finished
273     AV_WB32(orig_buf, buf - orig_buf);                    // patch the chunk size
274     return buf - orig_buf;
275 }
276
277 static int qtrle_encode_frame(AVCodecContext *avctx, uint8_t *buf, int buf_size, void *data)
278 {
279     QtrleEncContext * const s = avctx->priv_data;
280     AVFrame *pict = data;
281     AVFrame * const p = &s->frame;
282     int chunksize;
283
284     *p = *pict;
285
286     if (buf_size < s->max_buf_size) {
287         /* Upper bound check for compressed data */
288         av_log(avctx, AV_LOG_ERROR, "buf_size %d <  %d\n", buf_size, s->max_buf_size);
289         return -1;
290     }
291
292     if (avctx->gop_size == 0 || (s->avctx->frame_number % avctx->gop_size) == 0) {
293         /* I-Frame */
294         p->pict_type = FF_I_TYPE;
295         p->key_frame = 1;
296     } else {
297         /* P-Frame */
298         p->pict_type = FF_P_TYPE;
299         p->key_frame = 0;
300     }
301
302     chunksize = encode_frame(s, pict, buf);
303
304     /* save the current frame */
305     av_picture_copy(&s->previous_frame, (AVPicture *)p, avctx->pix_fmt, avctx->width, avctx->height);
306     return chunksize;
307 }
308
309 static av_cold int qtrle_encode_end(AVCodecContext *avctx)
310 {
311     QtrleEncContext *s = avctx->priv_data;
312
313     avpicture_free(&s->previous_frame);
314     av_free(s->rlecode_table);
315     av_free(s->length_table);
316     av_free(s->skip_table);
317     return 0;
318 }
319
320 AVCodec qtrle_encoder = {
321     "qtrle",
322     CODEC_TYPE_VIDEO,
323     CODEC_ID_QTRLE,
324     sizeof(QtrleEncContext),
325     qtrle_encode_init,
326     qtrle_encode_frame,
327     qtrle_encode_end,
328     .pix_fmts = (enum PixelFormat[]){PIX_FMT_RGB24, PIX_FMT_NONE},
329     .long_name = NULL_IF_CONFIG_SMALL("QuickTime Animation (RLE) video"),
330 };