]> git.sesse.net Git - ffmpeg/blob - libavcodec/tiffenc.c
Merge commit '50079a6aa93291e6dc9d9fb8d33da83f79e9311d'
[ffmpeg] / libavcodec / tiffenc.c
1 /*
2  * TIFF image encoder
3  * Copyright (c) 2007 Bartlomiej Wolowiec
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 /**
23  * @file
24  * TIFF image encoder
25  * @author Bartlomiej Wolowiec
26  */
27
28 #include "config.h"
29 #if CONFIG_ZLIB
30 #include <zlib.h>
31 #endif
32
33 #include "libavutil/imgutils.h"
34 #include "libavutil/log.h"
35 #include "libavutil/opt.h"
36 #include "libavutil/pixdesc.h"
37 #include "avcodec.h"
38 #include "bytestream.h"
39 #include "internal.h"
40 #include "lzw.h"
41 #include "put_bits.h"
42 #include "rle.h"
43 #include "tiff.h"
44
45 #define TIFF_MAX_ENTRY 32
46
47 /** sizes of various TIFF field types (string size = 1)*/
48 static const uint8_t type_sizes2[14] = {
49     0, 1, 1, 2, 4, 8, 1, 1, 2, 4, 8, 4, 8, 4
50 };
51
52 typedef struct TiffEncoderContext {
53     AVClass *class;                         ///< for private options
54     AVCodecContext *avctx;
55
56     int width;                              ///< picture width
57     int height;                             ///< picture height
58     unsigned int bpp;                       ///< bits per pixel
59     int compr;                              ///< compression level
60     int bpp_tab_size;                       ///< bpp_tab size
61     int photometric_interpretation;         ///< photometric interpretation
62     int strips;                             ///< number of strips
63     uint32_t *strip_sizes;
64     unsigned int strip_sizes_size;
65     uint32_t *strip_offsets;
66     unsigned int strip_offsets_size;
67     uint8_t *yuv_line;
68     unsigned int yuv_line_size;
69     int rps;                                ///< row per strip
70     uint8_t entries[TIFF_MAX_ENTRY * 12];   ///< entries in header
71     int num_entries;                        ///< number of entries
72     uint8_t **buf;                          ///< actual position in buffer
73     uint8_t *buf_start;                     ///< pointer to first byte in buffer
74     int buf_size;                           ///< buffer size
75     uint16_t subsampling[2];                ///< YUV subsampling factors
76     struct LZWEncodeState *lzws;            ///< LZW encode state
77     uint32_t dpi;                           ///< image resolution in DPI
78 } TiffEncoderContext;
79
80 /**
81  * Check free space in buffer.
82  *
83  * @param s Tiff context
84  * @param need Needed bytes
85  * @return 0 - ok, 1 - no free space
86  */
87 static inline int check_size(TiffEncoderContext *s, uint64_t need)
88 {
89     if (s->buf_size < *s->buf - s->buf_start + need) {
90         *s->buf = s->buf_start + s->buf_size + 1;
91         av_log(s->avctx, AV_LOG_ERROR, "Buffer is too small\n");
92         return 1;
93     }
94     return 0;
95 }
96
97 /**
98  * Put n values to buffer.
99  *
100  * @param p pointer to pointer to output buffer
101  * @param n number of values
102  * @param val pointer to values
103  * @param type type of values
104  * @param flip = 0 - normal copy, >0 - flip
105  */
106 static void tnput(uint8_t **p, int n, const uint8_t *val, enum TiffTypes type,
107                   int flip)
108 {
109     int i;
110 #if HAVE_BIGENDIAN
111     flip ^= ((int[]) { 0, 0, 0, 1, 3, 3 })[type];
112 #endif
113     for (i = 0; i < n * type_sizes2[type]; i++)
114         *(*p)++ = val[i ^ flip];
115 }
116
117 /**
118  * Add entry to directory in tiff header.
119  *
120  * @param s Tiff context
121  * @param tag tag that identifies the entry
122  * @param type entry type
123  * @param count the number of values
124  * @param ptr_val pointer to values
125  */
126 static void add_entry(TiffEncoderContext *s, enum TiffTags tag,
127                       enum TiffTypes type, int count, const void *ptr_val)
128 {
129     uint8_t *entries_ptr = s->entries + 12 * s->num_entries;
130
131     av_assert0(s->num_entries < TIFF_MAX_ENTRY);
132
133     bytestream_put_le16(&entries_ptr, tag);
134     bytestream_put_le16(&entries_ptr, type);
135     bytestream_put_le32(&entries_ptr, count);
136
137     if (type_sizes[type] * (int64_t)count <= 4) {
138         tnput(&entries_ptr, count, ptr_val, type, 0);
139     } else {
140         bytestream_put_le32(&entries_ptr, *s->buf - s->buf_start);
141         check_size(s, count * (int64_t)type_sizes2[type]);
142         tnput(s->buf, count, ptr_val, type, 0);
143     }
144
145     s->num_entries++;
146 }
147
148 static void add_entry1(TiffEncoderContext *s,
149                        enum TiffTags tag, enum TiffTypes type, int val)
150 {
151     uint16_t w  = val;
152     uint32_t dw = val;
153     add_entry(s, tag, type, 1, type == TIFF_SHORT ? (void *)&w : (void *)&dw);
154 }
155
156 /**
157  * Encode one strip in tiff file.
158  *
159  * @param s Tiff context
160  * @param src input buffer
161  * @param dst output buffer
162  * @param n size of input buffer
163  * @param compr compression method
164  * @return number of output bytes. If an output error is encountered, -1 is returned
165  */
166 static int encode_strip(TiffEncoderContext *s, const int8_t *src,
167                         uint8_t *dst, int n, int compr)
168 {
169     switch (compr) {
170 #if CONFIG_ZLIB
171     case TIFF_DEFLATE:
172     case TIFF_ADOBE_DEFLATE:
173     {
174         unsigned long zlen = s->buf_size - (*s->buf - s->buf_start);
175         if (compress(dst, &zlen, src, n) != Z_OK) {
176             av_log(s->avctx, AV_LOG_ERROR, "Compressing failed\n");
177             return -1;
178         }
179         return zlen;
180     }
181 #endif
182     case TIFF_RAW:
183         if (check_size(s, n))
184             return -1;
185         memcpy(dst, src, n);
186         return n;
187     case TIFF_PACKBITS:
188         return ff_rle_encode(dst, s->buf_size - (*s->buf - s->buf_start),
189                              src, 1, n, 2, 0xff, -1, 0);
190     case TIFF_LZW:
191         return ff_lzw_encode(s->lzws, src, n);
192     default:
193         return -1;
194     }
195 }
196
197 static void pack_yuv(TiffEncoderContext *s, const AVFrame *p,
198                      uint8_t *dst, int lnum)
199 {
200     int i, j, k;
201     int w       = (s->width - 1) / s->subsampling[0] + 1;
202     uint8_t *pu = &p->data[1][lnum / s->subsampling[1] * p->linesize[1]];
203     uint8_t *pv = &p->data[2][lnum / s->subsampling[1] * p->linesize[2]];
204     if (s->width % s->subsampling[0] || s->height % s->subsampling[1]) {
205         for (i = 0; i < w; i++) {
206             for (j = 0; j < s->subsampling[1]; j++)
207                 for (k = 0; k < s->subsampling[0]; k++)
208                     *dst++ = p->data[0][FFMIN(lnum + j, s->height-1) * p->linesize[0] +
209                                         FFMIN(i * s->subsampling[0] + k, s->width-1)];
210             *dst++ = *pu++;
211             *dst++ = *pv++;
212         }
213     }else{
214         for (i = 0; i < w; i++) {
215             for (j = 0; j < s->subsampling[1]; j++)
216                 for (k = 0; k < s->subsampling[0]; k++)
217                     *dst++ = p->data[0][(lnum + j) * p->linesize[0] +
218                                         i * s->subsampling[0] + k];
219             *dst++ = *pu++;
220             *dst++ = *pv++;
221         }
222     }
223 }
224
225 static int encode_frame(AVCodecContext *avctx, AVPacket *pkt,
226                         const AVFrame *pict, int *got_packet)
227 {
228     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(avctx->pix_fmt);
229     TiffEncoderContext *s = avctx->priv_data;
230     const AVFrame *const p = pict;
231     int i;
232     uint8_t *ptr;
233     uint8_t *offset;
234     uint32_t strips;
235     int bytes_per_row;
236     uint32_t res[2] = { s->dpi, 1 };    // image resolution (72/1)
237     uint16_t bpp_tab[4];
238     int ret = -1;
239     int is_yuv = 0, alpha = 0;
240     int shift_h, shift_v;
241
242     s->width          = avctx->width;
243     s->height         = avctx->height;
244     s->subsampling[0] = 1;
245     s->subsampling[1] = 1;
246
247     avctx->bits_per_coded_sample =
248     s->bpp          = av_get_bits_per_pixel(desc);
249     s->bpp_tab_size = desc->nb_components;
250
251     switch (avctx->pix_fmt) {
252     case AV_PIX_FMT_RGBA64LE:
253     case AV_PIX_FMT_RGBA:
254         alpha = 1;
255     case AV_PIX_FMT_RGB48LE:
256     case AV_PIX_FMT_RGB24:
257         s->photometric_interpretation = 2;
258         break;
259     case AV_PIX_FMT_GRAY8:
260         avctx->bits_per_coded_sample = 0x28;
261     case AV_PIX_FMT_GRAY8A:
262         alpha = avctx->pix_fmt == AV_PIX_FMT_GRAY8A;
263     case AV_PIX_FMT_GRAY16LE:
264     case AV_PIX_FMT_MONOBLACK:
265         s->photometric_interpretation = 1;
266         break;
267     case AV_PIX_FMT_PAL8:
268         s->photometric_interpretation = 3;
269         break;
270     case AV_PIX_FMT_MONOWHITE:
271         s->photometric_interpretation = 0;
272         break;
273     case AV_PIX_FMT_YUV420P:
274     case AV_PIX_FMT_YUV422P:
275     case AV_PIX_FMT_YUV440P:
276     case AV_PIX_FMT_YUV444P:
277     case AV_PIX_FMT_YUV410P:
278     case AV_PIX_FMT_YUV411P:
279         av_pix_fmt_get_chroma_sub_sample(avctx->pix_fmt, &shift_h, &shift_v);
280         s->photometric_interpretation = 6;
281         s->subsampling[0]             = 1 << shift_h;
282         s->subsampling[1]             = 1 << shift_v;
283         is_yuv                        = 1;
284         break;
285     default:
286         av_log(s->avctx, AV_LOG_ERROR,
287                "This colors format is not supported\n");
288         return -1;
289     }
290
291     for (i = 0; i < s->bpp_tab_size; i++)
292         bpp_tab[i] = desc->comp[i].depth_minus1 + 1;
293
294     if (s->compr == TIFF_DEFLATE       ||
295         s->compr == TIFF_ADOBE_DEFLATE ||
296         s->compr == TIFF_LZW)
297         // best choice for DEFLATE
298         s->rps = s->height;
299     else
300         // suggest size of strip
301         s->rps = FFMAX(8192 / (((s->width * s->bpp) >> 3) + 1), 1);
302     // round rps up
303     s->rps = ((s->rps - 1) / s->subsampling[1] + 1) * s->subsampling[1];
304
305     strips = (s->height - 1) / s->rps + 1;
306
307     if ((ret = ff_alloc_packet2(avctx, pkt,
308                              avctx->width * avctx->height * s->bpp * 2 +
309                              avctx->height * 4 + FF_MIN_BUFFER_SIZE)) < 0)
310         return ret;
311     ptr          = pkt->data;
312     s->buf_start = pkt->data;
313     s->buf       = &ptr;
314     s->buf_size  = pkt->size;
315
316     if (check_size(s, 8))
317         goto fail;
318
319     // write header
320     bytestream_put_le16(&ptr, 0x4949);
321     bytestream_put_le16(&ptr, 42);
322
323     offset = ptr;
324     bytestream_put_le32(&ptr, 0);
325
326     av_fast_padded_mallocz(&s->strip_sizes  , &s->strip_sizes_size  , sizeof(s->strip_sizes  [0]) * strips);
327     av_fast_padded_mallocz(&s->strip_offsets, &s->strip_offsets_size, sizeof(s->strip_offsets[0]) * strips);
328
329     if (!s->strip_sizes || !s->strip_offsets) {
330         ret = AVERROR(ENOMEM);
331         goto fail;
332     }
333
334     bytes_per_row = (((s->width - 1) / s->subsampling[0] + 1) * s->bpp *
335                      s->subsampling[0] * s->subsampling[1] + 7) >> 3;
336     if (is_yuv) {
337         av_fast_padded_malloc(&s->yuv_line, &s->yuv_line_size, bytes_per_row);
338         if (s->yuv_line == NULL) {
339             av_log(s->avctx, AV_LOG_ERROR, "Not enough memory\n");
340             ret = AVERROR(ENOMEM);
341             goto fail;
342         }
343     }
344
345 #if CONFIG_ZLIB
346     if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
347         uint8_t *zbuf;
348         int zlen, zn;
349         int j;
350
351         zlen = bytes_per_row * s->rps;
352         zbuf = av_malloc(zlen);
353         if (!zbuf) {
354             ret = AVERROR(ENOMEM);
355             goto fail;
356         }
357         s->strip_offsets[0] = ptr - pkt->data;
358         zn               = 0;
359         for (j = 0; j < s->rps; j++) {
360             if (is_yuv) {
361                 pack_yuv(s, p, s->yuv_line, j);
362                 memcpy(zbuf + zn, s->yuv_line, bytes_per_row);
363                 j += s->subsampling[1] - 1;
364             } else
365                 memcpy(zbuf + j * bytes_per_row,
366                        p->data[0] + j * p->linesize[0], bytes_per_row);
367             zn += bytes_per_row;
368         }
369         ret = encode_strip(s, zbuf, ptr, zn, s->compr);
370         av_free(zbuf);
371         if (ret < 0) {
372             av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
373             goto fail;
374         }
375         ptr           += ret;
376         s->strip_sizes[0] = ptr - pkt->data - s->strip_offsets[0];
377     } else
378 #endif
379     {
380     if (s->compr == TIFF_LZW) {
381         s->lzws = av_malloc(ff_lzw_encode_state_size);
382         if (!s->lzws) {
383             ret = AVERROR(ENOMEM);
384             goto fail;
385         }
386     }
387     for (i = 0; i < s->height; i++) {
388         if (s->strip_sizes[i / s->rps] == 0) {
389             if (s->compr == TIFF_LZW) {
390                 ff_lzw_encode_init(s->lzws, ptr,
391                                    s->buf_size - (*s->buf - s->buf_start),
392                                    12, FF_LZW_TIFF, put_bits);
393             }
394             s->strip_offsets[i / s->rps] = ptr - pkt->data;
395         }
396         if (is_yuv) {
397             pack_yuv(s, p, s->yuv_line, i);
398             ret = encode_strip(s, s->yuv_line, ptr, bytes_per_row, s->compr);
399             i  += s->subsampling[1] - 1;
400         } else
401             ret = encode_strip(s, p->data[0] + i * p->linesize[0],
402                                ptr, bytes_per_row, s->compr);
403         if (ret < 0) {
404             av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
405             goto fail;
406         }
407         s->strip_sizes[i / s->rps] += ret;
408         ptr                     += ret;
409         if (s->compr == TIFF_LZW &&
410             (i == s->height - 1 || i % s->rps == s->rps - 1)) {
411             ret = ff_lzw_encode_flush(s->lzws, flush_put_bits);
412             s->strip_sizes[(i / s->rps)] += ret;
413             ptr                          += ret;
414         }
415     }
416     if (s->compr == TIFF_LZW)
417         av_free(s->lzws);
418     }
419
420     s->num_entries = 0;
421
422     add_entry1(s, TIFF_SUBFILE, TIFF_LONG, 0);
423     add_entry1(s, TIFF_WIDTH,   TIFF_LONG, s->width);
424     add_entry1(s, TIFF_HEIGHT,  TIFF_LONG, s->height);
425
426     if (s->bpp_tab_size)
427         add_entry(s, TIFF_BPP, TIFF_SHORT, s->bpp_tab_size, bpp_tab);
428
429     add_entry1(s, TIFF_COMPR,      TIFF_SHORT, s->compr);
430     add_entry1(s, TIFF_INVERT,     TIFF_SHORT, s->photometric_interpretation);
431     add_entry(s,  TIFF_STRIP_OFFS, TIFF_LONG,  strips, s->strip_offsets);
432
433     if (s->bpp_tab_size)
434         add_entry1(s, TIFF_SAMPLES_PER_PIXEL, TIFF_SHORT, s->bpp_tab_size);
435
436     add_entry1(s, TIFF_ROWSPERSTRIP, TIFF_LONG,     s->rps);
437     add_entry(s,  TIFF_STRIP_SIZE,   TIFF_LONG,     strips, s->strip_sizes);
438     add_entry(s,  TIFF_XRES,         TIFF_RATIONAL, 1,      res);
439     add_entry(s,  TIFF_YRES,         TIFF_RATIONAL, 1,      res);
440     add_entry1(s, TIFF_RES_UNIT,     TIFF_SHORT,    2);
441
442     if (!(avctx->flags & CODEC_FLAG_BITEXACT))
443         add_entry(s, TIFF_SOFTWARE_NAME, TIFF_STRING,
444                   strlen(LIBAVCODEC_IDENT) + 1, LIBAVCODEC_IDENT);
445
446     if (avctx->pix_fmt == AV_PIX_FMT_PAL8) {
447         uint16_t pal[256 * 3];
448         for (i = 0; i < 256; i++) {
449             uint32_t rgb = *(uint32_t *) (p->data[1] + i * 4);
450             pal[i]       = ((rgb >> 16) & 0xff) * 257;
451             pal[i + 256] = ((rgb >>  8) & 0xff) * 257;
452             pal[i + 512] =  (rgb        & 0xff) * 257;
453         }
454         add_entry(s, TIFF_PAL, TIFF_SHORT, 256 * 3, pal);
455     }
456     if (alpha)
457         add_entry1(s,TIFF_EXTRASAMPLES,      TIFF_SHORT,            2);
458     if (is_yuv) {
459         /** according to CCIR Recommendation 601.1 */
460         uint32_t refbw[12] = { 15, 1, 235, 1, 128, 1, 240, 1, 128, 1, 240, 1 };
461         add_entry(s, TIFF_YCBCR_SUBSAMPLING, TIFF_SHORT,    2, s->subsampling);
462         if (avctx->chroma_sample_location == AVCHROMA_LOC_TOPLEFT)
463             add_entry1(s, TIFF_YCBCR_POSITIONING, TIFF_SHORT, 2);
464         add_entry(s, TIFF_REFERENCE_BW,      TIFF_RATIONAL, 6, refbw);
465     }
466     // write offset to dir
467     bytestream_put_le32(&offset, ptr - pkt->data);
468
469     if (check_size(s, 6 + s->num_entries * 12)) {
470         ret = AVERROR(EINVAL);
471         goto fail;
472     }
473     bytestream_put_le16(&ptr, s->num_entries);  // write tag count
474     bytestream_put_buffer(&ptr, s->entries, s->num_entries * 12);
475     bytestream_put_le32(&ptr, 0);
476
477     pkt->size   = ptr - pkt->data;
478     pkt->flags |= AV_PKT_FLAG_KEY;
479     *got_packet = 1;
480
481 fail:
482     return ret < 0 ? ret : 0;
483 }
484
485 static av_cold int encode_init(AVCodecContext *avctx)
486 {
487     TiffEncoderContext *s = avctx->priv_data;
488
489     avctx->coded_frame = av_frame_alloc();
490     if (!avctx->coded_frame)
491         return AVERROR(ENOMEM);
492
493     avctx->coded_frame->pict_type = AV_PICTURE_TYPE_I;
494     avctx->coded_frame->key_frame = 1;
495     s->avctx = avctx;
496
497     return 0;
498 }
499
500 static av_cold int encode_close(AVCodecContext *avctx)
501 {
502     TiffEncoderContext *s = avctx->priv_data;
503
504     av_frame_free(&avctx->coded_frame);
505     av_freep(&s->strip_sizes);
506     av_freep(&s->strip_offsets);
507     av_freep(&s->yuv_line);
508
509     return 0;
510 }
511
512 #define OFFSET(x) offsetof(TiffEncoderContext, x)
513 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
514 static const AVOption options[] = {
515     {"dpi", "set the image resolution (in dpi)", OFFSET(dpi), AV_OPT_TYPE_INT, {.i64 = 72}, 1, 0x10000, AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_ENCODING_PARAM},
516     { "compression_algo", NULL, OFFSET(compr), AV_OPT_TYPE_INT,   { .i64 = TIFF_PACKBITS }, TIFF_RAW, TIFF_DEFLATE, VE, "compression_algo" },
517     { "packbits",         NULL, 0,             AV_OPT_TYPE_CONST, { .i64 = TIFF_PACKBITS }, 0,        0,            VE, "compression_algo" },
518     { "raw",              NULL, 0,             AV_OPT_TYPE_CONST, { .i64 = TIFF_RAW      }, 0,        0,            VE, "compression_algo" },
519     { "lzw",              NULL, 0,             AV_OPT_TYPE_CONST, { .i64 = TIFF_LZW      }, 0,        0,            VE, "compression_algo" },
520 #if CONFIG_ZLIB
521     { "deflate",          NULL, 0,             AV_OPT_TYPE_CONST, { .i64 = TIFF_DEFLATE  }, 0,        0,            VE, "compression_algo" },
522 #endif
523     { NULL },
524 };
525
526 static const AVClass tiffenc_class = {
527     .class_name = "TIFF encoder",
528     .item_name  = av_default_item_name,
529     .option     = options,
530     .version    = LIBAVUTIL_VERSION_INT,
531 };
532
533 AVCodec ff_tiff_encoder = {
534     .name           = "tiff",
535     .long_name      = NULL_IF_CONFIG_SMALL("TIFF image"),
536     .type           = AVMEDIA_TYPE_VIDEO,
537     .id             = AV_CODEC_ID_TIFF,
538     .priv_data_size = sizeof(TiffEncoderContext),
539     .init           = encode_init,
540     .close          = encode_close,
541     .encode2        = encode_frame,
542     .pix_fmts       = (const enum AVPixelFormat[]) {
543         AV_PIX_FMT_RGB24, AV_PIX_FMT_PAL8, AV_PIX_FMT_GRAY8,
544         AV_PIX_FMT_GRAY8A, AV_PIX_FMT_GRAY16LE,
545         AV_PIX_FMT_MONOBLACK, AV_PIX_FMT_MONOWHITE,
546         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P,
547         AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_RGB48LE,
548         AV_PIX_FMT_RGBA, AV_PIX_FMT_RGBA64LE,
549         AV_PIX_FMT_NONE
550     },
551     .priv_class     = &tiffenc_class,
552 };