FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
pngenc.c
Go to the documentation of this file.
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 
22 #include "avcodec.h"
23 #include "internal.h"
24 #include "bytestream.h"
25 #include "huffyuvencdsp.h"
26 #include "png.h"
27 
28 #include "libavutil/avassert.h"
29 #include "libavutil/opt.h"
30 
31 #include <zlib.h>
32 
33 #define IOBUF_SIZE 4096
34 
35 typedef struct PNGEncContext {
36  AVClass *class;
38 
42 
44 
45  z_stream zstream;
47  int dpi; ///< Physical pixel density, in dots per inch, if set
48  int dpm; ///< Physical pixel density, in dots per meter, if set
50 
51 static void png_get_interlaced_row(uint8_t *dst, int row_size,
52  int bits_per_pixel, int pass,
53  const uint8_t *src, int width)
54 {
55  int x, mask, dst_x, j, b, bpp;
56  uint8_t *d;
57  const uint8_t *s;
58  static const int masks[] = {0x80, 0x08, 0x88, 0x22, 0xaa, 0x55, 0xff};
59 
60  mask = masks[pass];
61  switch (bits_per_pixel) {
62  case 1:
63  memset(dst, 0, row_size);
64  dst_x = 0;
65  for (x = 0; x < width; x++) {
66  j = (x & 7);
67  if ((mask << j) & 0x80) {
68  b = (src[x >> 3] >> (7 - j)) & 1;
69  dst[dst_x >> 3] |= b << (7 - (dst_x & 7));
70  dst_x++;
71  }
72  }
73  break;
74  default:
75  bpp = bits_per_pixel >> 3;
76  d = dst;
77  s = src;
78  for (x = 0; x < width; x++) {
79  j = x & 7;
80  if ((mask << j) & 0x80) {
81  memcpy(d, s, bpp);
82  d += bpp;
83  }
84  s += bpp;
85  }
86  break;
87  }
88 }
89 
91  int w, int bpp)
92 {
93  int i;
94  for (i = 0; i < w; i++) {
95  int a, b, c, p, pa, pb, pc;
96 
97  a = src[i - bpp];
98  b = top[i];
99  c = top[i - bpp];
100 
101  p = b - c;
102  pc = a - c;
103 
104  pa = abs(p);
105  pb = abs(pc);
106  pc = abs(p + pc);
107 
108  if (pa <= pb && pa <= pc)
109  p = a;
110  else if (pb <= pc)
111  p = b;
112  else
113  p = c;
114  dst[i] = src[i] - p;
115  }
116 }
117 
118 static void sub_left_prediction(PNGEncContext *c, uint8_t *dst, const uint8_t *src, int bpp, int size)
119 {
120  const uint8_t *src1 = src + bpp;
121  const uint8_t *src2 = src;
122  int x, unaligned_w;
123 
124  memcpy(dst, src, bpp);
125  dst += bpp;
126  size -= bpp;
127  unaligned_w = FFMIN(32 - bpp, size);
128  for (x = 0; x < unaligned_w; x++)
129  *dst++ = *src1++ - *src2++;
130  size -= unaligned_w;
131  c->hdsp.diff_bytes(dst, src1, src2, size);
132 }
133 
134 static void png_filter_row(PNGEncContext *c, uint8_t *dst, int filter_type,
135  uint8_t *src, uint8_t *top, int size, int bpp)
136 {
137  int i;
138 
139  switch (filter_type) {
141  memcpy(dst, src, size);
142  break;
144  sub_left_prediction(c, dst, src, bpp, size);
145  break;
146  case PNG_FILTER_VALUE_UP:
147  c->hdsp.diff_bytes(dst, src, top, size);
148  break;
150  for (i = 0; i < bpp; i++)
151  dst[i] = src[i] - (top[i] >> 1);
152  for (; i < size; i++)
153  dst[i] = src[i] - ((src[i - bpp] + top[i]) >> 1);
154  break;
156  for (i = 0; i < bpp; i++)
157  dst[i] = src[i] - top[i];
158  sub_png_paeth_prediction(dst + i, src + i, top + i, size - i, bpp);
159  break;
160  }
161 }
162 
164  uint8_t *src, uint8_t *top, int size, int bpp)
165 {
166  int pred = s->filter_type;
167  av_assert0(bpp || !pred);
168  if (!top && pred)
169  pred = PNG_FILTER_VALUE_SUB;
170  if (pred == PNG_FILTER_VALUE_MIXED) {
171  int i;
172  int cost, bcost = INT_MAX;
173  uint8_t *buf1 = dst, *buf2 = dst + size + 16;
174  for (pred = 0; pred < 5; pred++) {
175  png_filter_row(s, buf1 + 1, pred, src, top, size, bpp);
176  buf1[0] = pred;
177  cost = 0;
178  for (i = 0; i <= size; i++)
179  cost += abs((int8_t) buf1[i]);
180  if (cost < bcost) {
181  bcost = cost;
182  FFSWAP(uint8_t *, buf1, buf2);
183  }
184  }
185  return buf2;
186  } else {
187  png_filter_row(s, dst + 1, pred, src, top, size, bpp);
188  dst[0] = pred;
189  return dst;
190  }
191 }
192 
193 static void png_write_chunk(uint8_t **f, uint32_t tag,
194  const uint8_t *buf, int length)
195 {
196  uint32_t crc;
197  uint8_t tagbuf[4];
198 
199  bytestream_put_be32(f, length);
200  crc = crc32(0, Z_NULL, 0);
201  AV_WL32(tagbuf, tag);
202  crc = crc32(crc, tagbuf, 4);
203  bytestream_put_be32(f, av_bswap32(tag));
204  if (length > 0) {
205  crc = crc32(crc, buf, length);
206  memcpy(*f, buf, length);
207  *f += length;
208  }
209  bytestream_put_be32(f, crc);
210 }
211 
212 /* XXX: do filtering */
213 static int png_write_row(PNGEncContext *s, const uint8_t *data, int size)
214 {
215  int ret;
216 
217  s->zstream.avail_in = size;
218  s->zstream.next_in = data;
219  while (s->zstream.avail_in > 0) {
220  ret = deflate(&s->zstream, Z_NO_FLUSH);
221  if (ret != Z_OK)
222  return -1;
223  if (s->zstream.avail_out == 0) {
224  if (s->bytestream_end - s->bytestream > IOBUF_SIZE + 100)
226  MKTAG('I', 'D', 'A', 'T'), s->buf, IOBUF_SIZE);
227  s->zstream.avail_out = IOBUF_SIZE;
228  s->zstream.next_out = s->buf;
229  }
230  }
231  return 0;
232 }
233 
235  const AVFrame *pict, int *got_packet)
236 {
237  PNGEncContext *s = avctx->priv_data;
238  const AVFrame *const p = pict;
239  int bit_depth, color_type, y, len, row_size, ret, is_progressive;
240  int bits_per_pixel, pass_row_size, enc_row_size;
241  int64_t max_packet_size;
242  int compression_level;
243  uint8_t *ptr, *top, *crow_buf, *crow;
244  uint8_t *crow_base = NULL;
245  uint8_t *progressive_buf = NULL;
246  uint8_t *top_buf = NULL;
247 
248  is_progressive = !!(avctx->flags & CODEC_FLAG_INTERLACED_DCT);
249  switch (avctx->pix_fmt) {
250  case AV_PIX_FMT_RGBA64BE:
251  bit_depth = 16;
252  color_type = PNG_COLOR_TYPE_RGB_ALPHA;
253  break;
254  case AV_PIX_FMT_RGB48BE:
255  bit_depth = 16;
256  color_type = PNG_COLOR_TYPE_RGB;
257  break;
258  case AV_PIX_FMT_RGBA:
259  bit_depth = 8;
260  color_type = PNG_COLOR_TYPE_RGB_ALPHA;
261  break;
262  case AV_PIX_FMT_RGB24:
263  bit_depth = 8;
264  color_type = PNG_COLOR_TYPE_RGB;
265  break;
266  case AV_PIX_FMT_GRAY16BE:
267  bit_depth = 16;
268  color_type = PNG_COLOR_TYPE_GRAY;
269  break;
270  case AV_PIX_FMT_GRAY8:
271  bit_depth = 8;
272  color_type = PNG_COLOR_TYPE_GRAY;
273  break;
274  case AV_PIX_FMT_GRAY8A:
275  bit_depth = 8;
276  color_type = PNG_COLOR_TYPE_GRAY_ALPHA;
277  break;
278  case AV_PIX_FMT_YA16BE:
279  bit_depth = 16;
280  color_type = PNG_COLOR_TYPE_GRAY_ALPHA;
281  break;
283  bit_depth = 1;
284  color_type = PNG_COLOR_TYPE_GRAY;
285  break;
286  case AV_PIX_FMT_PAL8:
287  bit_depth = 8;
288  color_type = PNG_COLOR_TYPE_PALETTE;
289  break;
290  default:
291  return -1;
292  }
293  bits_per_pixel = ff_png_get_nb_channels(color_type) * bit_depth;
294  row_size = (avctx->width * bits_per_pixel + 7) >> 3;
295 
296  s->zstream.zalloc = ff_png_zalloc;
297  s->zstream.zfree = ff_png_zfree;
298  s->zstream.opaque = NULL;
299  compression_level = avctx->compression_level == FF_COMPRESSION_DEFAULT
300  ? Z_DEFAULT_COMPRESSION
301  : av_clip(avctx->compression_level, 0, 9);
302  ret = deflateInit2(&s->zstream, compression_level,
303  Z_DEFLATED, 15, 8, Z_DEFAULT_STRATEGY);
304  if (ret != Z_OK)
305  return -1;
306 
307  enc_row_size = deflateBound(&s->zstream, row_size);
308  max_packet_size = avctx->height * (int64_t)(enc_row_size +
309  ((enc_row_size + IOBUF_SIZE - 1) / IOBUF_SIZE) * 12)
311  if (max_packet_size > INT_MAX)
312  return AVERROR(ENOMEM);
313  if ((ret = ff_alloc_packet2(avctx, pkt, max_packet_size)) < 0)
314  return ret;
315 
316  s->bytestream_start =
317  s->bytestream = pkt->data;
318  s->bytestream_end = pkt->data + pkt->size;
319 
320  crow_base = av_malloc((row_size + 32) << (s->filter_type == PNG_FILTER_VALUE_MIXED));
321  if (!crow_base)
322  goto fail;
323  // pixel data should be aligned, but there's a control byte before it
324  crow_buf = crow_base + 15;
325  if (is_progressive) {
326  progressive_buf = av_malloc(row_size + 1);
327  if (!progressive_buf)
328  goto fail;
329  }
330  if (is_progressive) {
331  top_buf = av_malloc(row_size + 1);
332  if (!top_buf)
333  goto fail;
334  }
335 
336  /* write png header */
338  s->bytestream += 8;
339 
340  AV_WB32(s->buf, avctx->width);
341  AV_WB32(s->buf + 4, avctx->height);
342  s->buf[8] = bit_depth;
343  s->buf[9] = color_type;
344  s->buf[10] = 0; /* compression type */
345  s->buf[11] = 0; /* filter type */
346  s->buf[12] = is_progressive; /* interlace type */
347 
348  png_write_chunk(&s->bytestream, MKTAG('I', 'H', 'D', 'R'), s->buf, 13);
349 
350  if (s->dpm) {
351  AV_WB32(s->buf, s->dpm);
352  AV_WB32(s->buf + 4, s->dpm);
353  s->buf[8] = 1; /* unit specifier is meter */
354  } else {
355  AV_WB32(s->buf, avctx->sample_aspect_ratio.num);
356  AV_WB32(s->buf + 4, avctx->sample_aspect_ratio.den);
357  s->buf[8] = 0; /* unit specifier is unknown */
358  }
359  png_write_chunk(&s->bytestream, MKTAG('p', 'H', 'Y', 's'), s->buf, 9);
360 
361  /* put the palette if needed */
362  if (color_type == PNG_COLOR_TYPE_PALETTE) {
363  int has_alpha, alpha, i;
364  unsigned int v;
365  uint32_t *palette;
366  uint8_t *alpha_ptr;
367 
368  palette = (uint32_t *)p->data[1];
369  ptr = s->buf;
370  alpha_ptr = s->buf + 256 * 3;
371  has_alpha = 0;
372  for (i = 0; i < 256; i++) {
373  v = palette[i];
374  alpha = v >> 24;
375  if (alpha != 0xff)
376  has_alpha = 1;
377  *alpha_ptr++ = alpha;
378  bytestream_put_be24(&ptr, v);
379  }
381  MKTAG('P', 'L', 'T', 'E'), s->buf, 256 * 3);
382  if (has_alpha) {
384  MKTAG('t', 'R', 'N', 'S'), s->buf + 256 * 3, 256);
385  }
386  }
387 
388  /* now put each row */
389  s->zstream.avail_out = IOBUF_SIZE;
390  s->zstream.next_out = s->buf;
391  if (is_progressive) {
392  int pass;
393 
394  for (pass = 0; pass < NB_PASSES; pass++) {
395  /* NOTE: a pass is completely omitted if no pixels would be
396  * output */
397  pass_row_size = ff_png_pass_row_size(pass, bits_per_pixel, avctx->width);
398  if (pass_row_size > 0) {
399  top = NULL;
400  for (y = 0; y < avctx->height; y++)
401  if ((ff_png_pass_ymask[pass] << (y & 7)) & 0x80) {
402  ptr = p->data[0] + y * p->linesize[0];
403  FFSWAP(uint8_t *, progressive_buf, top_buf);
404  png_get_interlaced_row(progressive_buf, pass_row_size,
405  bits_per_pixel, pass,
406  ptr, avctx->width);
407  crow = png_choose_filter(s, crow_buf, progressive_buf,
408  top, pass_row_size, bits_per_pixel >> 3);
409  png_write_row(s, crow, pass_row_size + 1);
410  top = progressive_buf;
411  }
412  }
413  }
414  } else {
415  top = NULL;
416  for (y = 0; y < avctx->height; y++) {
417  ptr = p->data[0] + y * p->linesize[0];
418  crow = png_choose_filter(s, crow_buf, ptr, top,
419  row_size, bits_per_pixel >> 3);
420  png_write_row(s, crow, row_size + 1);
421  top = ptr;
422  }
423  }
424  /* compress last bytes */
425  for (;;) {
426  ret = deflate(&s->zstream, Z_FINISH);
427  if (ret == Z_OK || ret == Z_STREAM_END) {
428  len = IOBUF_SIZE - s->zstream.avail_out;
429  if (len > 0 && s->bytestream_end - s->bytestream > len + 100) {
430  png_write_chunk(&s->bytestream, MKTAG('I', 'D', 'A', 'T'), s->buf, len);
431  }
432  s->zstream.avail_out = IOBUF_SIZE;
433  s->zstream.next_out = s->buf;
434  if (ret == Z_STREAM_END)
435  break;
436  } else {
437  goto fail;
438  }
439  }
440  png_write_chunk(&s->bytestream, MKTAG('I', 'E', 'N', 'D'), NULL, 0);
441 
442  pkt->size = s->bytestream - s->bytestream_start;
443  pkt->flags |= AV_PKT_FLAG_KEY;
444  *got_packet = 1;
445  ret = 0;
446 
447 the_end:
448  av_free(crow_base);
449  av_free(progressive_buf);
450  av_free(top_buf);
451  deflateEnd(&s->zstream);
452  return ret;
453 fail:
454  ret = -1;
455  goto the_end;
456 }
457 
459 {
460  PNGEncContext *s = avctx->priv_data;
461 
462  switch (avctx->pix_fmt) {
463  case AV_PIX_FMT_RGBA:
464  avctx->bits_per_coded_sample = 32;
465  break;
466  case AV_PIX_FMT_RGB24:
467  avctx->bits_per_coded_sample = 24;
468  break;
469  case AV_PIX_FMT_GRAY8:
470  avctx->bits_per_coded_sample = 0x28;
471  break;
473  avctx->bits_per_coded_sample = 1;
474  break;
475  case AV_PIX_FMT_PAL8:
476  avctx->bits_per_coded_sample = 8;
477  }
478 
479  avctx->coded_frame = av_frame_alloc();
480  if (!avctx->coded_frame)
481  return AVERROR(ENOMEM);
482 
484  avctx->coded_frame->key_frame = 1;
485 
487 
488  s->filter_type = av_clip(avctx->prediction_method,
491  if (avctx->pix_fmt == AV_PIX_FMT_MONOBLACK)
493 
494  if (s->dpi && s->dpm) {
495  av_log(avctx, AV_LOG_ERROR, "Only one of 'dpi' or 'dpm' options should be set\n");
496  return AVERROR(EINVAL);
497  } else if (s->dpi) {
498  s->dpm = s->dpi * 10000 / 254;
499  }
500 
501  return 0;
502 }
503 
505 {
506  av_frame_free(&avctx->coded_frame);
507  return 0;
508 }
509 
510 #define OFFSET(x) offsetof(PNGEncContext, x)
511 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
512 static const AVOption options[] = {
513  {"dpi", "Set image resolution (in dots per inch)", OFFSET(dpi), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 0x10000, VE},
514  {"dpm", "Set image resolution (in dots per meter)", OFFSET(dpm), AV_OPT_TYPE_INT, {.i64 = 0}, 0, 0x10000, VE},
515  { NULL }
516 };
517 
518 static const AVClass pngenc_class = {
519  .class_name = "PNG encoder",
520  .item_name = av_default_item_name,
521  .option = options,
522  .version = LIBAVUTIL_VERSION_INT,
523 };
524 
526  .name = "png",
527  .long_name = NULL_IF_CONFIG_SMALL("PNG (Portable Network Graphics) image"),
528  .type = AVMEDIA_TYPE_VIDEO,
529  .id = AV_CODEC_ID_PNG,
530  .priv_data_size = sizeof(PNGEncContext),
531  .init = png_enc_init,
532  .close = png_enc_close,
533  .encode2 = encode_frame,
535  .pix_fmts = (const enum AVPixelFormat[]) {
542  },
543  .priv_class = &pngenc_class,
544 };