Simplify RGB32 png encoding.
[ffmpeg.git] / libavcodec / pngenc.c
1 /*
2  * PNG image format
3  * Copyright (c) 2003 Fabrice Bellard
4  *
5  * This file is part of FFmpeg.
6  *
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.
11  *
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.
16  *
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
20  */
21 #include "avcodec.h"
22 #include "bytestream.h"
23 #include "dsputil.h"
24 #include "png.h"
25
26 /* TODO:
27  * - add 2, 4 and 16 bit depth support
28  */
29
30 #include <zlib.h>
31
32 //#define DEBUG
33
34 #define IOBUF_SIZE 4096
35
36 typedef struct PNGEncContext {
37     DSPContext dsp;
38
39     uint8_t *bytestream;
40     uint8_t *bytestream_start;
41     uint8_t *bytestream_end;
42     AVFrame picture;
43
44     int filter_type;
45
46     z_stream zstream;
47     uint8_t buf[IOBUF_SIZE];
48 } PNGEncContext;
49
50 static void png_get_interlaced_row(uint8_t *dst, int row_size,
51                                    int bits_per_pixel, int pass,
52                                    const uint8_t *src, int width)
53 {
54     int x, mask, dst_x, j, b, bpp;
55     uint8_t *d;
56     const uint8_t *s;
57
58     mask = ff_png_pass_mask[pass];
59     switch(bits_per_pixel) {
60     case 1:
61         memset(dst, 0, row_size);
62         dst_x = 0;
63         for(x = 0; x < width; x++) {
64             j = (x & 7);
65             if ((mask << j) & 0x80) {
66                 b = (src[x >> 3] >> (7 - j)) & 1;
67                 dst[dst_x >> 3] |= b << (7 - (dst_x & 7));
68                 dst_x++;
69             }
70         }
71         break;
72     default:
73         bpp = bits_per_pixel >> 3;
74         d = dst;
75         s = src;
76         for(x = 0; x < width; x++) {
77             j = x & 7;
78             if ((mask << j) & 0x80) {
79                 memcpy(d, s, bpp);
80                 d += bpp;
81             }
82             s += bpp;
83         }
84         break;
85     }
86 }
87
88 static void sub_png_paeth_prediction(uint8_t *dst, uint8_t *src, uint8_t *top, int w, int bpp)
89 {
90     int i;
91     for(i = 0; i < w; i++) {
92         int a, b, c, p, pa, pb, pc;
93
94         a = src[i - bpp];
95         b = top[i];
96         c = top[i - bpp];
97
98         p = b - c;
99         pc = a - c;
100
101         pa = abs(p);
102         pb = abs(pc);
103         pc = abs(p + pc);
104
105         if (pa <= pb && pa <= pc)
106             p = a;
107         else if (pb <= pc)
108             p = b;
109         else
110             p = c;
111         dst[i] = src[i] - p;
112     }
113 }
114
115 static void png_filter_row(DSPContext *dsp, uint8_t *dst, int filter_type,
116                            uint8_t *src, uint8_t *top, int size, int bpp)
117 {
118     int i;
119
120     switch(filter_type) {
121     case PNG_FILTER_VALUE_NONE:
122         memcpy(dst, src, size);
123         break;
124     case PNG_FILTER_VALUE_SUB:
125         dsp->diff_bytes(dst, src, src-bpp, size);
126         memcpy(dst, src, bpp);
127         break;
128     case PNG_FILTER_VALUE_UP:
129         dsp->diff_bytes(dst, src, top, size);
130         break;
131     case PNG_FILTER_VALUE_AVG:
132         for(i = 0; i < bpp; i++)
133             dst[i] = src[i] - (top[i] >> 1);
134         for(; i < size; i++)
135             dst[i] = src[i] - ((src[i-bpp] + top[i]) >> 1);
136         break;
137     case PNG_FILTER_VALUE_PAETH:
138         for(i = 0; i < bpp; i++)
139             dst[i] = src[i] - top[i];
140         sub_png_paeth_prediction(dst+i, src+i, top+i, size-i, bpp);
141         break;
142     }
143 }
144
145 static uint8_t *png_choose_filter(PNGEncContext *s, uint8_t *dst,
146                                   uint8_t *src, uint8_t *top, int size, int bpp)
147 {
148     int pred = s->filter_type;
149     assert(bpp || !pred);
150     if(!top && pred)
151         pred = PNG_FILTER_VALUE_SUB;
152     if(pred == PNG_FILTER_VALUE_MIXED) {
153         int i;
154         int cost, bcost = INT_MAX;
155         uint8_t *buf1 = dst, *buf2 = dst + size + 16;
156         for(pred=0; pred<5; pred++) {
157             png_filter_row(&s->dsp, buf1+1, pred, src, top, size, bpp);
158             buf1[0] = pred;
159             cost = 0;
160             for(i=0; i<=size; i++)
161                 cost += abs((int8_t)buf1[i]);
162             if(cost < bcost) {
163                 bcost = cost;
164                 FFSWAP(uint8_t*, buf1, buf2);
165             }
166         }
167         return buf2;
168     } else {
169         png_filter_row(&s->dsp, dst+1, pred, src, top, size, bpp);
170         dst[0] = pred;
171         return dst;
172     }
173 }
174
175 static void png_write_chunk(uint8_t **f, uint32_t tag,
176                             const uint8_t *buf, int length)
177 {
178     uint32_t crc;
179     uint8_t tagbuf[4];
180
181     bytestream_put_be32(f, length);
182     crc = crc32(0, Z_NULL, 0);
183     AV_WL32(tagbuf, tag);
184     crc = crc32(crc, tagbuf, 4);
185     bytestream_put_be32(f, av_bswap32(tag));
186     if (length > 0) {
187         crc = crc32(crc, buf, length);
188         memcpy(*f, buf, length);
189         *f += length;
190     }
191     bytestream_put_be32(f, crc);
192 }
193
194 /* XXX: do filtering */
195 static int png_write_row(PNGEncContext *s, const uint8_t *data, int size)
196 {
197     int ret;
198
199     s->zstream.avail_in = size;
200     s->zstream.next_in = (uint8_t *)data;
201     while (s->zstream.avail_in > 0) {
202         ret = deflate(&s->zstream, Z_NO_FLUSH);
203         if (ret != Z_OK)
204             return -1;
205         if (s->zstream.avail_out == 0) {
206             if(s->bytestream_end - s->bytestream > IOBUF_SIZE + 100)
207                 png_write_chunk(&s->bytestream, MKTAG('I', 'D', 'A', 'T'), s->buf, IOBUF_SIZE);
208             s->zstream.avail_out = IOBUF_SIZE;
209             s->zstream.next_out = s->buf;
210         }
211     }
212     return 0;
213 }
214
215 static int encode_frame(AVCodecContext *avctx, unsigned char *buf, int buf_size, void *data){
216     PNGEncContext *s = avctx->priv_data;
217     AVFrame *pict = data;
218     AVFrame * const p= &s->picture;
219     int bit_depth, color_type, y, len, row_size, ret, is_progressive;
220     int bits_per_pixel, pass_row_size;
221     int compression_level;
222     uint8_t *ptr, *top;
223     uint8_t *crow_base = NULL, *crow_buf, *crow;
224     uint8_t *progressive_buf = NULL;
225     uint8_t *top_buf = NULL;
226
227     *p = *pict;
228     p->pict_type= AV_PICTURE_TYPE_I;
229     p->key_frame= 1;
230
231     s->bytestream_start=
232     s->bytestream= buf;
233     s->bytestream_end= buf+buf_size;
234
235     is_progressive = !!(avctx->flags & CODEC_FLAG_INTERLACED_DCT);
236     switch(avctx->pix_fmt) {
237     case PIX_FMT_RGBA:
238         bit_depth = 8;
239         color_type = PNG_COLOR_TYPE_RGB_ALPHA;
240         break;
241     case PIX_FMT_RGB24:
242         bit_depth = 8;
243         color_type = PNG_COLOR_TYPE_RGB;
244         break;
245     case PIX_FMT_GRAY16BE:
246         bit_depth = 16;
247         color_type = PNG_COLOR_TYPE_GRAY;
248         break;
249     case PIX_FMT_GRAY8:
250         bit_depth = 8;
251         color_type = PNG_COLOR_TYPE_GRAY;
252         break;
253     case PIX_FMT_GRAY8A:
254         bit_depth = 8;
255         color_type = PNG_COLOR_TYPE_GRAY_ALPHA;
256         break;
257     case PIX_FMT_MONOBLACK:
258         bit_depth = 1;
259         color_type = PNG_COLOR_TYPE_GRAY;
260         break;
261     case PIX_FMT_PAL8:
262         bit_depth = 8;
263         color_type = PNG_COLOR_TYPE_PALETTE;
264         break;
265     default:
266         return -1;
267     }
268     bits_per_pixel = ff_png_get_nb_channels(color_type) * bit_depth;
269     row_size = (avctx->width * bits_per_pixel + 7) >> 3;
270
271     s->zstream.zalloc = ff_png_zalloc;
272     s->zstream.zfree = ff_png_zfree;
273     s->zstream.opaque = NULL;
274     compression_level = avctx->compression_level == FF_COMPRESSION_DEFAULT ?
275                             Z_DEFAULT_COMPRESSION :
276                             av_clip(avctx->compression_level, 0, 9);
277     ret = deflateInit2(&s->zstream, compression_level,
278                        Z_DEFLATED, 15, 8, Z_DEFAULT_STRATEGY);
279     if (ret != Z_OK)
280         return -1;
281     crow_base = av_malloc((row_size + 32) << (s->filter_type == PNG_FILTER_VALUE_MIXED));
282     if (!crow_base)
283         goto fail;
284     crow_buf = crow_base + 15; // pixel data should be aligned, but there's a control byte before it
285     if (is_progressive) {
286         progressive_buf = av_malloc(row_size + 1);
287         if (!progressive_buf)
288             goto fail;
289     }
290     if (is_progressive) {
291         top_buf = av_malloc(row_size + 1);
292         if (!top_buf)
293             goto fail;
294     }
295
296     /* write png header */
297     memcpy(s->bytestream, ff_pngsig, 8);
298     s->bytestream += 8;
299
300     AV_WB32(s->buf, avctx->width);
301     AV_WB32(s->buf + 4, avctx->height);
302     s->buf[8] = bit_depth;
303     s->buf[9] = color_type;
304     s->buf[10] = 0; /* compression type */
305     s->buf[11] = 0; /* filter type */
306     s->buf[12] = is_progressive; /* interlace type */
307
308     png_write_chunk(&s->bytestream, MKTAG('I', 'H', 'D', 'R'), s->buf, 13);
309
310     /* put the palette if needed */
311     if (color_type == PNG_COLOR_TYPE_PALETTE) {
312         int has_alpha, alpha, i;
313         unsigned int v;
314         uint32_t *palette;
315         uint8_t *alpha_ptr;
316
317         palette = (uint32_t *)p->data[1];
318         ptr = s->buf;
319         alpha_ptr = s->buf + 256 * 3;
320         has_alpha = 0;
321         for(i = 0; i < 256; i++) {
322             v = palette[i];
323             alpha = v >> 24;
324             if (alpha != 0xff)
325                 has_alpha = 1;
326             *alpha_ptr++ = alpha;
327             bytestream_put_be24(&ptr, v);
328         }
329         png_write_chunk(&s->bytestream, MKTAG('P', 'L', 'T', 'E'), s->buf, 256 * 3);
330         if (has_alpha) {
331             png_write_chunk(&s->bytestream, MKTAG('t', 'R', 'N', 'S'), s->buf + 256 * 3, 256);
332         }
333     }
334
335     /* now put each row */
336     s->zstream.avail_out = IOBUF_SIZE;
337     s->zstream.next_out = s->buf;
338     if (is_progressive) {
339         int pass;
340
341         for(pass = 0; pass < NB_PASSES; pass++) {
342             /* NOTE: a pass is completely omited if no pixels would be
343                output */
344             pass_row_size = ff_png_pass_row_size(pass, bits_per_pixel, avctx->width);
345             if (pass_row_size > 0) {
346                 top = NULL;
347                 for(y = 0; y < avctx->height; y++) {
348                     if ((ff_png_pass_ymask[pass] << (y & 7)) & 0x80) {
349                         ptr = p->data[0] + y * p->linesize[0];
350                         FFSWAP(uint8_t*, progressive_buf, top_buf);
351                         png_get_interlaced_row(progressive_buf, pass_row_size,
352                                                bits_per_pixel, pass,
353                                                ptr, avctx->width);
354                         crow = png_choose_filter(s, crow_buf, progressive_buf, top, pass_row_size, bits_per_pixel>>3);
355                         png_write_row(s, crow, pass_row_size + 1);
356                         top = progressive_buf;
357                     }
358                 }
359             }
360         }
361     } else {
362         top = NULL;
363         for(y = 0; y < avctx->height; y++) {
364             ptr = p->data[0] + y * p->linesize[0];
365             crow = png_choose_filter(s, crow_buf, ptr, top, row_size, bits_per_pixel>>3);
366             png_write_row(s, crow, row_size + 1);
367             top = ptr;
368         }
369     }
370     /* compress last bytes */
371     for(;;) {
372         ret = deflate(&s->zstream, Z_FINISH);
373         if (ret == Z_OK || ret == Z_STREAM_END) {
374             len = IOBUF_SIZE - s->zstream.avail_out;
375             if (len > 0 && s->bytestream_end - s->bytestream > len + 100) {
376                 png_write_chunk(&s->bytestream, MKTAG('I', 'D', 'A', 'T'), s->buf, len);
377             }
378             s->zstream.avail_out = IOBUF_SIZE;
379             s->zstream.next_out = s->buf;
380             if (ret == Z_STREAM_END)
381                 break;
382         } else {
383             goto fail;
384         }
385     }
386     png_write_chunk(&s->bytestream, MKTAG('I', 'E', 'N', 'D'), NULL, 0);
387
388     ret = s->bytestream - s->bytestream_start;
389  the_end:
390     av_free(crow_base);
391     av_free(progressive_buf);
392     av_free(top_buf);
393     deflateEnd(&s->zstream);
394     return ret;
395  fail:
396     ret = -1;
397     goto the_end;
398 }
399
400 static av_cold int png_enc_init(AVCodecContext *avctx){
401     PNGEncContext *s = avctx->priv_data;
402
403     avcodec_get_frame_defaults(&s->picture);
404     avctx->coded_frame= &s->picture;
405     dsputil_init(&s->dsp, avctx);
406
407     s->filter_type = av_clip(avctx->prediction_method, PNG_FILTER_VALUE_NONE, PNG_FILTER_VALUE_MIXED);
408     if(avctx->pix_fmt == PIX_FMT_MONOBLACK)
409         s->filter_type = PNG_FILTER_VALUE_NONE;
410
411     return 0;
412 }
413
414 AVCodec ff_png_encoder = {
415     .name           = "png",
416     .type           = AVMEDIA_TYPE_VIDEO,
417     .id             = CODEC_ID_PNG,
418     .priv_data_size = sizeof(PNGEncContext),
419     .init           = png_enc_init,
420     .encode         = encode_frame,
421     .pix_fmts= (const enum PixelFormat[]){PIX_FMT_RGB24, PIX_FMT_RGBA, PIX_FMT_PAL8, PIX_FMT_GRAY8, PIX_FMT_GRAY8A, PIX_FMT_GRAY16BE, PIX_FMT_MONOBLACK, PIX_FMT_NONE},
422     .long_name= NULL_IF_CONFIG_SMALL("PNG image"),
423 };