libavcodec/pngenc.c
b958a7f1
 /*
  * PNG image format
406792e7
  * Copyright (c) 2003 Fabrice Bellard
b958a7f1
  *
  * This file is part of FFmpeg.
  *
  * FFmpeg is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2.1 of the License, or (at your option) any later version.
  *
  * FFmpeg is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with FFmpeg; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
c598b569
 
b958a7f1
 #include "avcodec.h"
5c6c6254
 #include "internal.h"
b958a7f1
 #include "bytestream.h"
512f3ffe
 #include "huffyuvencdsp.h"
b958a7f1
 #include "png.h"
 
65efc66d
 #include "libavutil/avassert.h"
bc63a760
 #include "libavutil/opt.h"
65efc66d
 
b958a7f1
 #include <zlib.h>
 
e0eddd12
 #define IOBUF_SIZE 4096
 
 typedef struct PNGEncContext {
bc63a760
     AVClass *class;
512f3ffe
     HuffYUVEncDSPContext hdsp;
4a5b619d
 
e0eddd12
     uint8_t *bytestream;
     uint8_t *bytestream_start;
     uint8_t *bytestream_end;
 
4a5b619d
     int filter_type;
 
e0eddd12
     z_stream zstream;
     uint8_t buf[IOBUF_SIZE];
bc63a760
     int dpi;                     ///< Physical pixel density, in dots per inch, if set
     int dpm;                     ///< Physical pixel density, in dots per meter, if set
e0eddd12
 } PNGEncContext;
 
b958a7f1
 static void png_get_interlaced_row(uint8_t *dst, int row_size,
                                    int bits_per_pixel, int pass,
                                    const uint8_t *src, int width)
 {
     int x, mask, dst_x, j, b, bpp;
     uint8_t *d;
     const uint8_t *s;
fe1de12f
     static const int masks[] = {0x80, 0x08, 0x88, 0x22, 0xaa, 0x55, 0xff};
b958a7f1
 
fe1de12f
     mask = masks[pass];
c598b569
     switch (bits_per_pixel) {
b958a7f1
     case 1:
         memset(dst, 0, row_size);
         dst_x = 0;
c598b569
         for (x = 0; x < width; x++) {
b958a7f1
             j = (x & 7);
             if ((mask << j) & 0x80) {
                 b = (src[x >> 3] >> (7 - j)) & 1;
                 dst[dst_x >> 3] |= b << (7 - (dst_x & 7));
                 dst_x++;
             }
         }
         break;
     default:
         bpp = bits_per_pixel >> 3;
         d = dst;
         s = src;
c598b569
         for (x = 0; x < width; x++) {
b958a7f1
             j = x & 7;
             if ((mask << j) & 0x80) {
                 memcpy(d, s, bpp);
                 d += bpp;
             }
             s += bpp;
         }
         break;
     }
 }
 
c598b569
 static void sub_png_paeth_prediction(uint8_t *dst, uint8_t *src, uint8_t *top,
                                      int w, int bpp)
4a5b619d
 {
     int i;
c598b569
     for (i = 0; i < w; i++) {
4a5b619d
         int a, b, c, p, pa, pb, pc;
 
         a = src[i - bpp];
         b = top[i];
         c = top[i - bpp];
 
c598b569
         p  = b - c;
4a5b619d
         pc = a - c;
 
         pa = abs(p);
         pb = abs(pc);
         pc = abs(p + pc);
 
         if (pa <= pb && pa <= pc)
             p = a;
         else if (pb <= pc)
             p = b;
         else
             p = c;
         dst[i] = src[i] - p;
     }
 }
 
48a69163
 static void sub_left_prediction(PNGEncContext *c, uint8_t *dst, const uint8_t *src, int bpp, int size)
57ec555e
 {
     const uint8_t *src1 = src + bpp;
     const uint8_t *src2 = src;
     int x, unaligned_w;
 
     memcpy(dst, src, bpp);
     dst += bpp;
     size -= bpp;
     unaligned_w = FFMIN(32 - bpp, size);
     for (x = 0; x < unaligned_w; x++)
         *dst++ = *src1++ - *src2++;
     size -= unaligned_w;
48a69163
     c->hdsp.diff_bytes(dst, src1, src2, size);
57ec555e
 }
 
512f3ffe
 static void png_filter_row(PNGEncContext *c, uint8_t *dst, int filter_type,
4a5b619d
                            uint8_t *src, uint8_t *top, int size, int bpp)
 {
     int i;
 
c598b569
     switch (filter_type) {
4a5b619d
     case PNG_FILTER_VALUE_NONE:
         memcpy(dst, src, size);
         break;
     case PNG_FILTER_VALUE_SUB:
48a69163
         sub_left_prediction(c, dst, src, bpp, size);
4a5b619d
         break;
     case PNG_FILTER_VALUE_UP:
512f3ffe
         c->hdsp.diff_bytes(dst, src, top, size);
4a5b619d
         break;
     case PNG_FILTER_VALUE_AVG:
c598b569
         for (i = 0; i < bpp; i++)
4a5b619d
             dst[i] = src[i] - (top[i] >> 1);
c598b569
         for (; i < size; i++)
             dst[i] = src[i] - ((src[i - bpp] + top[i]) >> 1);
4a5b619d
         break;
     case PNG_FILTER_VALUE_PAETH:
c598b569
         for (i = 0; i < bpp; i++)
4a5b619d
             dst[i] = src[i] - top[i];
c598b569
         sub_png_paeth_prediction(dst + i, src + i, top + i, size - i, bpp);
4a5b619d
         break;
     }
 }
 
 static uint8_t *png_choose_filter(PNGEncContext *s, uint8_t *dst,
                                   uint8_t *src, uint8_t *top, int size, int bpp)
 {
     int pred = s->filter_type;
65efc66d
     av_assert0(bpp || !pred);
c598b569
     if (!top && pred)
4a5b619d
         pred = PNG_FILTER_VALUE_SUB;
c598b569
     if (pred == PNG_FILTER_VALUE_MIXED) {
4a5b619d
         int i;
         int cost, bcost = INT_MAX;
         uint8_t *buf1 = dst, *buf2 = dst + size + 16;
c598b569
         for (pred = 0; pred < 5; pred++) {
512f3ffe
             png_filter_row(s, buf1 + 1, pred, src, top, size, bpp);
4a5b619d
             buf1[0] = pred;
             cost = 0;
c598b569
             for (i = 0; i <= size; i++)
                 cost += abs((int8_t) buf1[i]);
             if (cost < bcost) {
4a5b619d
                 bcost = cost;
c598b569
                 FFSWAP(uint8_t *, buf1, buf2);
4a5b619d
             }
         }
         return buf2;
     } else {
512f3ffe
         png_filter_row(s, dst + 1, pred, src, top, size, bpp);
4a5b619d
         dst[0] = pred;
         return dst;
     }
 }
 
b958a7f1
 static void png_write_chunk(uint8_t **f, uint32_t tag,
                             const uint8_t *buf, int length)
 {
     uint32_t crc;
     uint8_t tagbuf[4];
 
     bytestream_put_be32(f, length);
     crc = crc32(0, Z_NULL, 0);
     AV_WL32(tagbuf, tag);
     crc = crc32(crc, tagbuf, 4);
8fc0162a
     bytestream_put_be32(f, av_bswap32(tag));
b958a7f1
     if (length > 0) {
         crc = crc32(crc, buf, length);
         memcpy(*f, buf, length);
         *f += length;
     }
     bytestream_put_be32(f, crc);
 }
 
 /* XXX: do filtering */
e0eddd12
 static int png_write_row(PNGEncContext *s, const uint8_t *data, int size)
b958a7f1
 {
     int ret;
 
     s->zstream.avail_in = size;
c598b569
     s->zstream.next_in  = (uint8_t *)data;
b958a7f1
     while (s->zstream.avail_in > 0) {
         ret = deflate(&s->zstream, Z_NO_FLUSH);
         if (ret != Z_OK)
             return -1;
         if (s->zstream.avail_out == 0) {
c598b569
             if (s->bytestream_end - s->bytestream > IOBUF_SIZE + 100)
                 png_write_chunk(&s->bytestream,
                                 MKTAG('I', 'D', 'A', 'T'), s->buf, IOBUF_SIZE);
b958a7f1
             s->zstream.avail_out = IOBUF_SIZE;
c598b569
             s->zstream.next_out  = s->buf;
b958a7f1
         }
     }
     return 0;
 }
 
83c7fe32
 static int encode_frame(AVCodecContext *avctx, AVPacket *pkt,
                         const AVFrame *pict, int *got_packet)
 {
c598b569
     PNGEncContext *s       = avctx->priv_data;
     const AVFrame *const p = pict;
b958a7f1
     int bit_depth, color_type, y, len, row_size, ret, is_progressive;
afc0cc22
     int bits_per_pixel, pass_row_size, enc_row_size;
     int64_t max_packet_size;
9ba718e4
     int compression_level;
c598b569
     uint8_t *ptr, *top, *crow_buf, *crow;
     uint8_t *crow_base       = NULL;
4a5b619d
     uint8_t *progressive_buf = NULL;
c598b569
     uint8_t *top_buf         = NULL;
b958a7f1
 
     is_progressive = !!(avctx->flags & CODEC_FLAG_INTERLACED_DCT);
c598b569
     switch (avctx->pix_fmt) {
ac627b3d
     case AV_PIX_FMT_RGBA64BE:
cccac765
         bit_depth = 16;
f94ce3bc
         color_type = PNG_COLOR_TYPE_RGB_ALPHA;
         break;
ac627b3d
     case AV_PIX_FMT_RGB48BE:
cccac765
         bit_depth = 16;
f94ce3bc
         color_type = PNG_COLOR_TYPE_RGB;
         break;
ac627b3d
     case AV_PIX_FMT_RGBA:
c598b569
         bit_depth  = 8;
b958a7f1
         color_type = PNG_COLOR_TYPE_RGB_ALPHA;
         break;
716d413c
     case AV_PIX_FMT_RGB24:
c598b569
         bit_depth  = 8;
b958a7f1
         color_type = PNG_COLOR_TYPE_RGB;
         break;
ac627b3d
     case AV_PIX_FMT_GRAY16BE:
c598b569
         bit_depth  = 16;
fdc013da
         color_type = PNG_COLOR_TYPE_GRAY;
         break;
716d413c
     case AV_PIX_FMT_GRAY8:
c598b569
         bit_depth  = 8;
b958a7f1
         color_type = PNG_COLOR_TYPE_GRAY;
         break;
ac627b3d
     case AV_PIX_FMT_GRAY8A:
ed10ca4c
         bit_depth = 8;
         color_type = PNG_COLOR_TYPE_GRAY_ALPHA;
         break;
716d413c
     case AV_PIX_FMT_MONOBLACK:
c598b569
         bit_depth  = 1;
b958a7f1
         color_type = PNG_COLOR_TYPE_GRAY;
         break;
716d413c
     case AV_PIX_FMT_PAL8:
c598b569
         bit_depth  = 8;
b958a7f1
         color_type = PNG_COLOR_TYPE_PALETTE;
         break;
     default:
         return -1;
     }
     bits_per_pixel = ff_png_get_nb_channels(color_type) * bit_depth;
c598b569
     row_size       = (avctx->width * bits_per_pixel + 7) >> 3;
b958a7f1
 
     s->zstream.zalloc = ff_png_zalloc;
c598b569
     s->zstream.zfree  = ff_png_zfree;
b958a7f1
     s->zstream.opaque = NULL;
c598b569
     compression_level = avctx->compression_level == FF_COMPRESSION_DEFAULT
                       ? Z_DEFAULT_COMPRESSION
                       : av_clip(avctx->compression_level, 0, 9);
9ba718e4
     ret = deflateInit2(&s->zstream, compression_level,
b958a7f1
                        Z_DEFLATED, 15, 8, Z_DEFAULT_STRATEGY);
     if (ret != Z_OK)
         return -1;
677df4d2
 
     enc_row_size    = deflateBound(&s->zstream, row_size);
afc0cc22
     max_packet_size = avctx->height * (int64_t)(enc_row_size +
677df4d2
                                        ((enc_row_size + IOBUF_SIZE - 1) / IOBUF_SIZE) * 12)
                       + FF_MIN_BUFFER_SIZE;
afc0cc22
     if (max_packet_size > INT_MAX)
         return AVERROR(ENOMEM);
ae2c33b0
     if ((ret = ff_alloc_packet2(avctx, pkt, max_packet_size)) < 0)
677df4d2
         return ret;
 
     s->bytestream_start =
     s->bytestream       = pkt->data;
     s->bytestream_end   = pkt->data + pkt->size;
 
4a5b619d
     crow_base = av_malloc((row_size + 32) << (s->filter_type == PNG_FILTER_VALUE_MIXED));
     if (!crow_base)
b958a7f1
         goto fail;
c598b569
     // pixel data should be aligned, but there's a control byte before it
     crow_buf = crow_base + 15;
b958a7f1
     if (is_progressive) {
4a5b619d
         progressive_buf = av_malloc(row_size + 1);
         if (!progressive_buf)
             goto fail;
     }
107f55cb
     if (is_progressive) {
4a5b619d
         top_buf = av_malloc(row_size + 1);
         if (!top_buf)
b958a7f1
             goto fail;
     }
 
     /* write png header */
a09ae4ef
     AV_WB64(s->bytestream, PNGSIG);
b958a7f1
     s->bytestream += 8;
 
     AV_WB32(s->buf, avctx->width);
     AV_WB32(s->buf + 4, avctx->height);
c598b569
     s->buf[8]  = bit_depth;
     s->buf[9]  = color_type;
b958a7f1
     s->buf[10] = 0; /* compression type */
     s->buf[11] = 0; /* filter type */
     s->buf[12] = is_progressive; /* interlace type */
 
     png_write_chunk(&s->bytestream, MKTAG('I', 'H', 'D', 'R'), s->buf, 13);
 
bc63a760
     if (s->dpm) {
       AV_WB32(s->buf, s->dpm);
       AV_WB32(s->buf + 4, s->dpm);
       s->buf[8] = 1; /* unit specifier is meter */
     } else {
       AV_WB32(s->buf, avctx->sample_aspect_ratio.num);
       AV_WB32(s->buf + 4, avctx->sample_aspect_ratio.den);
       s->buf[8] = 0; /* unit specifier is unknown */
     }
f58f9023
     png_write_chunk(&s->bytestream, MKTAG('p', 'H', 'Y', 's'), s->buf, 9);
 
b958a7f1
     /* put the palette if needed */
     if (color_type == PNG_COLOR_TYPE_PALETTE) {
         int has_alpha, alpha, i;
         unsigned int v;
         uint32_t *palette;
         uint8_t *alpha_ptr;
 
c598b569
         palette   = (uint32_t *)p->data[1];
         ptr       = s->buf;
b958a7f1
         alpha_ptr = s->buf + 256 * 3;
         has_alpha = 0;
c598b569
         for (i = 0; i < 256; i++) {
             v     = palette[i];
b958a7f1
             alpha = v >> 24;
a99dbe01
             if (alpha != 0xff)
b958a7f1
                 has_alpha = 1;
             *alpha_ptr++ = alpha;
             bytestream_put_be24(&ptr, v);
         }
c598b569
         png_write_chunk(&s->bytestream,
                         MKTAG('P', 'L', 'T', 'E'), s->buf, 256 * 3);
b958a7f1
         if (has_alpha) {
c598b569
             png_write_chunk(&s->bytestream,
                             MKTAG('t', 'R', 'N', 'S'), s->buf + 256 * 3, 256);
b958a7f1
         }
     }
 
     /* now put each row */
     s->zstream.avail_out = IOBUF_SIZE;
c598b569
     s->zstream.next_out  = s->buf;
b958a7f1
     if (is_progressive) {
         int pass;
 
c598b569
         for (pass = 0; pass < NB_PASSES; pass++) {
511cf612
             /* NOTE: a pass is completely omitted if no pixels would be
c598b569
              * output */
b958a7f1
             pass_row_size = ff_png_pass_row_size(pass, bits_per_pixel, avctx->width);
             if (pass_row_size > 0) {
4a5b619d
                 top = NULL;
c598b569
                 for (y = 0; y < avctx->height; y++)
b958a7f1
                     if ((ff_png_pass_ymask[pass] << (y & 7)) & 0x80) {
                         ptr = p->data[0] + y * p->linesize[0];
c598b569
                         FFSWAP(uint8_t *, progressive_buf, top_buf);
4a5b619d
                         png_get_interlaced_row(progressive_buf, pass_row_size,
b958a7f1
                                                bits_per_pixel, pass,
4a5b619d
                                                ptr, avctx->width);
c598b569
                         crow = png_choose_filter(s, crow_buf, progressive_buf,
                                                  top, pass_row_size, bits_per_pixel >> 3);
4a5b619d
                         png_write_row(s, crow, pass_row_size + 1);
                         top = progressive_buf;
b958a7f1
                     }
             }
         }
     } else {
4a5b619d
         top = NULL;
c598b569
         for (y = 0; y < avctx->height; y++) {
b958a7f1
             ptr = p->data[0] + y * p->linesize[0];
c598b569
             crow = png_choose_filter(s, crow_buf, ptr, top,
                                      row_size, bits_per_pixel >> 3);
4a5b619d
             png_write_row(s, crow, row_size + 1);
             top = ptr;
b958a7f1
         }
     }
     /* compress last bytes */
c598b569
     for (;;) {
b958a7f1
         ret = deflate(&s->zstream, Z_FINISH);
         if (ret == Z_OK || ret == Z_STREAM_END) {
             len = IOBUF_SIZE - s->zstream.avail_out;
             if (len > 0 && s->bytestream_end - s->bytestream > len + 100) {
                 png_write_chunk(&s->bytestream, MKTAG('I', 'D', 'A', 'T'), s->buf, len);
             }
             s->zstream.avail_out = IOBUF_SIZE;
c598b569
             s->zstream.next_out  = s->buf;
b958a7f1
             if (ret == Z_STREAM_END)
                 break;
         } else {
             goto fail;
         }
     }
     png_write_chunk(&s->bytestream, MKTAG('I', 'E', 'N', 'D'), NULL, 0);
 
83c7fe32
     pkt->size   = s->bytestream - s->bytestream_start;
     pkt->flags |= AV_PKT_FLAG_KEY;
     *got_packet = 1;
     ret         = 0;
 
c598b569
 the_end:
4a5b619d
     av_free(crow_base);
     av_free(progressive_buf);
     av_free(top_buf);
b958a7f1
     deflateEnd(&s->zstream);
     return ret;
c598b569
 fail:
b958a7f1
     ret = -1;
     goto the_end;
 }
 
c598b569
 static av_cold int png_enc_init(AVCodecContext *avctx)
 {
e0eddd12
     PNGEncContext *s = avctx->priv_data;
 
a00d4c59
     switch (avctx->pix_fmt) {
c4dc6c4c
     case AV_PIX_FMT_RGBA:
         avctx->bits_per_coded_sample = 32;
         break;
     case AV_PIX_FMT_RGB24:
         avctx->bits_per_coded_sample = 24;
         break;
     case AV_PIX_FMT_GRAY8:
         avctx->bits_per_coded_sample = 0x28;
         break;
     case AV_PIX_FMT_MONOBLACK:
         avctx->bits_per_coded_sample = 1;
         break;
     case AV_PIX_FMT_PAL8:
         avctx->bits_per_coded_sample = 8;
     }
 
78c6c9d6
     avctx->coded_frame = av_frame_alloc();
     if (!avctx->coded_frame)
         return AVERROR(ENOMEM);
 
     avctx->coded_frame->pict_type = AV_PICTURE_TYPE_I;
     avctx->coded_frame->key_frame = 1;
 
512f3ffe
     ff_huffyuvencdsp_init(&s->hdsp);
4a5b619d
 
c598b569
     s->filter_type = av_clip(avctx->prediction_method,
                              PNG_FILTER_VALUE_NONE,
                              PNG_FILTER_VALUE_MIXED);
     if (avctx->pix_fmt == AV_PIX_FMT_MONOBLACK)
4a5b619d
         s->filter_type = PNG_FILTER_VALUE_NONE;
e0eddd12
 
bc63a760
     if (s->dpi && s->dpm) {
       av_log(avctx, AV_LOG_ERROR, "Only one of 'dpi' or 'dpm' options should be set\n");
       return AVERROR(EINVAL);
     } else if (s->dpi) {
       s->dpm = s->dpi * 10000 / 254;
     }
 
e0eddd12
     return 0;
 }
 
78c6c9d6
 static av_cold int png_enc_close(AVCodecContext *avctx)
 {
     av_frame_free(&avctx->coded_frame);
     return 0;
 }
 
bc63a760
 #define OFFSET(x) offsetof(PNGEncContext, x)
 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
 static const AVOption options[] = {
     {"dpi", "Set image resolution (in dots per inch)",  OFFSET(dpi), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 0x10000, VE},
     {"dpm", "Set image resolution (in dots per meter)", OFFSET(dpm), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 0x10000, VE},
     { NULL }
 };
 
 static const AVClass pngenc_class = {
     .class_name = "PNG encoder",
     .item_name  = av_default_item_name,
     .option     = options,
     .version    = LIBAVUTIL_VERSION_INT,
 };
 
e7e2df27
 AVCodec ff_png_encoder = {
ec6402b7
     .name           = "png",
b2bed932
     .long_name      = NULL_IF_CONFIG_SMALL("PNG (Portable Network Graphics) image"),
ec6402b7
     .type           = AVMEDIA_TYPE_VIDEO,
36ef5369
     .id             = AV_CODEC_ID_PNG,
ec6402b7
     .priv_data_size = sizeof(PNGEncContext),
     .init           = png_enc_init,
78c6c9d6
     .close          = png_enc_close,
83c7fe32
     .encode2        = encode_frame,
616ef2e8
     .capabilities   = CODEC_CAP_FRAME_THREADS | CODEC_CAP_INTRA_ONLY,
c598b569
     .pix_fmts       = (const enum AVPixelFormat[]) {
ac627b3d
         AV_PIX_FMT_RGB24, AV_PIX_FMT_RGBA,
         AV_PIX_FMT_RGB48BE, AV_PIX_FMT_RGBA64BE,
         AV_PIX_FMT_PAL8,
         AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY8A,
         AV_PIX_FMT_GRAY16BE,
716d413c
         AV_PIX_FMT_MONOBLACK, AV_PIX_FMT_NONE
00c3b67b
     },
bc63a760
     .priv_class     = &pngenc_class,
b958a7f1
 };