3 * Copyright (c) 2007 Bartlomiej Wolowiec
5 * This file is part of FFmpeg.
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.
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.
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
25 * @author Bartlomiej Wolowiec
33 #include "libavutil/imgutils.h"
34 #include "libavutil/log.h"
35 #include "libavutil/opt.h"
36 #include "libavutil/pixdesc.h"
38 #include "bytestream.h"
39 #include "codec_internal.h"
47 #define TIFF_MAX_ENTRY 32
49 /** sizes of various TIFF field types (string size = 1)*/
50 static const uint8_t type_sizes2[14] = {
51 0, 1, 1, 2, 4, 8, 1, 1, 2, 4, 8, 4, 8, 4
54 typedef struct TiffEncoderContext {
55 AVClass *class; ///< for private options
56 AVCodecContext *avctx;
58 int width; ///< picture width
59 int height; ///< picture height
60 unsigned int bpp; ///< bits per pixel
61 int compr; ///< compression level
62 int bpp_tab_size; ///< bpp_tab size
63 enum TiffPhotometric photometric_interpretation; ///< photometric interpretation
64 int strips; ///< number of strips
65 uint32_t *strip_sizes;
66 unsigned int strip_sizes_size;
67 uint32_t *strip_offsets;
68 unsigned int strip_offsets_size;
70 unsigned int yuv_line_size;
71 int rps; ///< row per strip
72 uint8_t entries[TIFF_MAX_ENTRY * 12]; ///< entries in header
73 int num_entries; ///< number of entries
74 uint8_t **buf; ///< actual position in buffer
75 uint8_t *buf_start; ///< pointer to first byte in buffer
76 int buf_size; ///< buffer size
77 uint16_t subsampling[2]; ///< YUV subsampling factors
78 struct LZWEncodeState *lzws; ///< LZW encode state
79 uint32_t dpi; ///< image resolution in DPI
83 * Check free space in buffer.
85 * @param s Tiff context
86 * @param need Needed bytes
87 * @return 0 - ok, 1 - no free space
89 static inline int check_size(TiffEncoderContext *s, uint64_t need)
91 if (s->buf_size < *s->buf - s->buf_start + need) {
92 *s->buf = s->buf_start + s->buf_size + 1;
93 av_log(s->avctx, AV_LOG_ERROR, "Buffer is too small\n");
100 * Put n values to buffer.
102 * @param p pointer to pointer to output buffer
103 * @param n number of values
104 * @param val pointer to values
105 * @param type type of values
106 * @param flip = 0 - normal copy, >0 - flip
108 static void tnput(uint8_t **p, int n, const uint8_t *val, enum TiffTypes type,
113 flip ^= ((int[]) { 0, 0, 0, 1, 3, 3 })[type];
115 for (i = 0; i < n * type_sizes2[type]; i++)
116 *(*p)++ = val[i ^ flip];
120 * Add entry to directory in tiff header.
122 * @param s Tiff context
123 * @param tag tag that identifies the entry
124 * @param type entry type
125 * @param count the number of values
126 * @param ptr_val pointer to values
128 static int add_entry(TiffEncoderContext *s, enum TiffTags tag,
129 enum TiffTypes type, int count, const void *ptr_val)
131 uint8_t *entries_ptr = s->entries + 12 * s->num_entries;
133 av_assert0(s->num_entries < TIFF_MAX_ENTRY);
135 bytestream_put_le16(&entries_ptr, tag);
136 bytestream_put_le16(&entries_ptr, type);
137 bytestream_put_le32(&entries_ptr, count);
139 if (type_sizes[type] * (int64_t)count <= 4) {
140 tnput(&entries_ptr, count, ptr_val, type, 0);
142 bytestream_put_le32(&entries_ptr, *s->buf - s->buf_start);
143 if (check_size(s, count * (int64_t)type_sizes2[type]))
144 return AVERROR_INVALIDDATA;
145 tnput(s->buf, count, ptr_val, type, 0);
152 static int add_entry1(TiffEncoderContext *s,
153 enum TiffTags tag, enum TiffTypes type, int val)
157 return add_entry(s, tag, type, 1,
158 type == TIFF_SHORT ? (void *)&w : (void *)&dw);
162 * Encode one strip in tiff file.
164 * @param s Tiff context
165 * @param src input buffer
166 * @param dst output buffer
167 * @param n size of input buffer
168 * @param compr compression method
169 * @return number of output bytes. If an output error is encountered, a negative
170 * value corresponding to an AVERROR error code is returned.
172 static int encode_strip(TiffEncoderContext *s, const int8_t *src,
173 uint8_t *dst, int n, int compr)
178 case TIFF_ADOBE_DEFLATE:
180 unsigned long zlen = s->buf_size - (*s->buf - s->buf_start);
181 if (compress(dst, &zlen, src, n) != Z_OK) {
182 av_log(s->avctx, AV_LOG_ERROR, "Compressing failed\n");
183 return AVERROR_EXTERNAL;
189 if (check_size(s, n))
190 return AVERROR(EINVAL);
194 return ff_rle_encode(dst, s->buf_size - (*s->buf - s->buf_start),
195 src, 1, n, 2, 0xff, -1, 0);
197 return ff_lzw_encode(s->lzws, src, n);
199 av_log(s->avctx, AV_LOG_ERROR, "Unsupported compression method: %d\n",
201 return AVERROR(EINVAL);
205 static void pack_yuv(TiffEncoderContext *s, const AVFrame *p,
206 uint8_t *dst, int lnum)
209 int w = (s->width - 1) / s->subsampling[0] + 1;
210 const uint8_t *pu = &p->data[1][lnum / s->subsampling[1] * p->linesize[1]];
211 const uint8_t *pv = &p->data[2][lnum / s->subsampling[1] * p->linesize[2]];
212 if (s->width % s->subsampling[0] || s->height % s->subsampling[1]) {
213 for (i = 0; i < w; i++) {
214 for (j = 0; j < s->subsampling[1]; j++)
215 for (k = 0; k < s->subsampling[0]; k++)
216 *dst++ = p->data[0][FFMIN(lnum + j, s->height-1) * p->linesize[0] +
217 FFMIN(i * s->subsampling[0] + k, s->width-1)];
222 for (i = 0; i < w; i++) {
223 for (j = 0; j < s->subsampling[1]; j++)
224 for (k = 0; k < s->subsampling[0]; k++)
225 *dst++ = p->data[0][(lnum + j) * p->linesize[0] +
226 i * s->subsampling[0] + k];
233 #define ADD_ENTRY(s, tag, type, count, ptr_val) \
235 ret = add_entry(s, tag, type, count, ptr_val); \
240 #define ADD_ENTRY1(s, tag, type, val) \
242 ret = add_entry1(s, tag, type, val); \
247 static int encode_frame(AVCodecContext *avctx, AVPacket *pkt,
248 const AVFrame *pict, int *got_packet)
250 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(avctx->pix_fmt);
251 TiffEncoderContext *s = avctx->priv_data;
252 const AVFrame *const p = pict;
258 uint32_t res[2] = { s->dpi, 1 }; // image resolution (72/1)
261 int is_yuv = 0, alpha = 0;
262 int shift_h, shift_v;
265 s->width = avctx->width;
266 s->height = avctx->height;
267 s->subsampling[0] = 1;
268 s->subsampling[1] = 1;
271 return AVERROR(EINVAL);
273 avctx->bits_per_coded_sample =
274 s->bpp = av_get_bits_per_pixel(desc);
275 s->bpp_tab_size = desc->nb_components;
277 switch (avctx->pix_fmt) {
278 case AV_PIX_FMT_RGBA64LE:
279 case AV_PIX_FMT_RGBA:
281 case AV_PIX_FMT_RGB48LE:
282 case AV_PIX_FMT_RGB24:
283 s->photometric_interpretation = TIFF_PHOTOMETRIC_RGB;
285 case AV_PIX_FMT_GRAY8:
286 avctx->bits_per_coded_sample = 0x28;
287 case AV_PIX_FMT_GRAY8A:
288 case AV_PIX_FMT_YA16LE:
289 alpha = avctx->pix_fmt == AV_PIX_FMT_GRAY8A || avctx->pix_fmt == AV_PIX_FMT_YA16LE;
290 case AV_PIX_FMT_GRAY16LE:
291 case AV_PIX_FMT_MONOBLACK:
292 s->photometric_interpretation = TIFF_PHOTOMETRIC_BLACK_IS_ZERO;
294 case AV_PIX_FMT_PAL8:
295 s->photometric_interpretation = TIFF_PHOTOMETRIC_PALETTE;
297 case AV_PIX_FMT_MONOWHITE:
298 s->photometric_interpretation = TIFF_PHOTOMETRIC_WHITE_IS_ZERO;
300 case AV_PIX_FMT_YUV420P:
301 case AV_PIX_FMT_YUV422P:
302 case AV_PIX_FMT_YUV440P:
303 case AV_PIX_FMT_YUV444P:
304 case AV_PIX_FMT_YUV410P:
305 case AV_PIX_FMT_YUV411P:
306 av_pix_fmt_get_chroma_sub_sample(avctx->pix_fmt, &shift_h, &shift_v);
307 s->photometric_interpretation = TIFF_PHOTOMETRIC_YCBCR;
308 s->subsampling[0] = 1 << shift_h;
309 s->subsampling[1] = 1 << shift_v;
313 av_log(s->avctx, AV_LOG_ERROR,
314 "This colors format is not supported\n");
315 return AVERROR(EINVAL);
318 for (i = 0; i < s->bpp_tab_size; i++)
319 bpp_tab[i] = desc->comp[i].depth;
321 if (s->compr == TIFF_DEFLATE ||
322 s->compr == TIFF_ADOBE_DEFLATE ||
323 s->compr == TIFF_LZW)
324 // best choice for DEFLATE
327 // suggest size of strip
328 s->rps = FFMAX(8192 / (((s->width * s->bpp) >> 3) + 1), 1);
330 s->rps = ((s->rps - 1) / s->subsampling[1] + 1) * s->subsampling[1];
332 strips = (s->height - 1) / s->rps + 1;
334 bytes_per_row = (((s->width - 1) / s->subsampling[0] + 1) * s->bpp *
335 s->subsampling[0] * s->subsampling[1] + 7) >> 3;
336 packet_size = avctx->height * bytes_per_row * 2 +
337 avctx->height * 4 + AV_INPUT_BUFFER_MIN_SIZE;
339 if ((ret = ff_alloc_packet(avctx, pkt, packet_size)) < 0)
342 s->buf_start = pkt->data;
344 s->buf_size = pkt->size;
346 if (check_size(s, 8)) {
347 ret = AVERROR(EINVAL);
352 bytestream_put_le16(&ptr, 0x4949);
353 bytestream_put_le16(&ptr, 42);
356 bytestream_put_le32(&ptr, 0);
358 if (strips > INT_MAX / FFMAX(sizeof(s->strip_sizes[0]), sizeof(s->strip_offsets[0]))) {
359 ret = AVERROR(ENOMEM);
362 av_fast_padded_mallocz(&s->strip_sizes , &s->strip_sizes_size , sizeof(s->strip_sizes [0]) * strips);
363 av_fast_padded_mallocz(&s->strip_offsets, &s->strip_offsets_size, sizeof(s->strip_offsets[0]) * strips);
365 if (!s->strip_sizes || !s->strip_offsets) {
366 ret = AVERROR(ENOMEM);
371 av_fast_padded_malloc(&s->yuv_line, &s->yuv_line_size, bytes_per_row);
372 if (s->yuv_line == NULL) {
373 av_log(s->avctx, AV_LOG_ERROR, "Not enough memory\n");
374 ret = AVERROR(ENOMEM);
380 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
385 zlen = bytes_per_row * s->rps;
386 zbuf = av_malloc(zlen);
388 ret = AVERROR(ENOMEM);
391 s->strip_offsets[0] = ptr - pkt->data;
393 for (j = 0; j < s->rps; j++) {
395 pack_yuv(s, p, s->yuv_line, j);
396 memcpy(zbuf + zn, s->yuv_line, bytes_per_row);
397 j += s->subsampling[1] - 1;
399 memcpy(zbuf + j * bytes_per_row,
400 p->data[0] + j * p->linesize[0], bytes_per_row);
403 ret = encode_strip(s, zbuf, ptr, zn, s->compr);
406 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
410 s->strip_sizes[0] = ptr - pkt->data - s->strip_offsets[0];
414 if (s->compr == TIFF_LZW) {
415 s->lzws = av_malloc(ff_lzw_encode_state_size);
417 ret = AVERROR(ENOMEM);
421 for (i = 0; i < s->height; i++) {
422 if (s->strip_sizes[i / s->rps] == 0) {
423 if (s->compr == TIFF_LZW) {
424 ff_lzw_encode_init(s->lzws, ptr,
425 s->buf_size - (*s->buf - s->buf_start),
428 s->strip_offsets[i / s->rps] = ptr - pkt->data;
431 pack_yuv(s, p, s->yuv_line, i);
432 ret = encode_strip(s, s->yuv_line, ptr, bytes_per_row, s->compr);
433 i += s->subsampling[1] - 1;
435 ret = encode_strip(s, p->data[0] + i * p->linesize[0],
436 ptr, bytes_per_row, s->compr);
438 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
441 s->strip_sizes[i / s->rps] += ret;
443 if (s->compr == TIFF_LZW &&
444 (i == s->height - 1 || i % s->rps == s->rps - 1)) {
445 ret = ff_lzw_encode_flush(s->lzws);
446 s->strip_sizes[(i / s->rps)] += ret;
450 if (s->compr == TIFF_LZW)
456 ADD_ENTRY1(s, TIFF_SUBFILE, TIFF_LONG, 0);
457 ADD_ENTRY1(s, TIFF_WIDTH, TIFF_LONG, s->width);
458 ADD_ENTRY1(s, TIFF_HEIGHT, TIFF_LONG, s->height);
461 ADD_ENTRY(s, TIFF_BPP, TIFF_SHORT, s->bpp_tab_size, bpp_tab);
463 ADD_ENTRY1(s, TIFF_COMPR, TIFF_SHORT, s->compr);
464 ADD_ENTRY1(s, TIFF_PHOTOMETRIC, TIFF_SHORT, s->photometric_interpretation);
465 ADD_ENTRY(s, TIFF_STRIP_OFFS, TIFF_LONG, strips, s->strip_offsets);
468 ADD_ENTRY1(s, TIFF_SAMPLES_PER_PIXEL, TIFF_SHORT, s->bpp_tab_size);
470 ADD_ENTRY1(s, TIFF_ROWSPERSTRIP, TIFF_LONG, s->rps);
471 ADD_ENTRY(s, TIFF_STRIP_SIZE, TIFF_LONG, strips, s->strip_sizes);
472 ADD_ENTRY(s, TIFF_XRES, TIFF_RATIONAL, 1, res);
473 if (avctx->sample_aspect_ratio.num > 0 &&
474 avctx->sample_aspect_ratio.den > 0) {
475 AVRational y = av_mul_q(av_make_q(s->dpi, 1),
476 avctx->sample_aspect_ratio);
480 ADD_ENTRY(s, TIFF_YRES, TIFF_RATIONAL, 1, res);
481 ADD_ENTRY1(s, TIFF_RES_UNIT, TIFF_SHORT, 2);
483 if (!(avctx->flags & AV_CODEC_FLAG_BITEXACT))
484 ADD_ENTRY(s, TIFF_SOFTWARE_NAME, TIFF_STRING,
485 strlen(LIBAVCODEC_IDENT) + 1, LIBAVCODEC_IDENT);
487 if (avctx->pix_fmt == AV_PIX_FMT_PAL8) {
488 uint16_t pal[256 * 3];
489 for (i = 0; i < 256; i++) {
490 uint32_t rgb = *(uint32_t *) (p->data[1] + i * 4);
491 pal[i] = ((rgb >> 16) & 0xff) * 257;
492 pal[i + 256] = ((rgb >> 8) & 0xff) * 257;
493 pal[i + 512] = (rgb & 0xff) * 257;
495 ADD_ENTRY(s, TIFF_PAL, TIFF_SHORT, 256 * 3, pal);
498 ADD_ENTRY1(s,TIFF_EXTRASAMPLES, TIFF_SHORT, 2);
500 /** according to CCIR Recommendation 601.1 */
501 uint32_t refbw[12] = { 15, 1, 235, 1, 128, 1, 240, 1, 128, 1, 240, 1 };
502 ADD_ENTRY(s, TIFF_YCBCR_SUBSAMPLING, TIFF_SHORT, 2, s->subsampling);
503 if (avctx->chroma_sample_location == AVCHROMA_LOC_TOPLEFT)
504 ADD_ENTRY1(s, TIFF_YCBCR_POSITIONING, TIFF_SHORT, 2);
505 ADD_ENTRY(s, TIFF_REFERENCE_BW, TIFF_RATIONAL, 6, refbw);
507 // write offset to dir
508 bytestream_put_le32(&offset, ptr - pkt->data);
510 if (check_size(s, 6 + s->num_entries * 12)) {
511 ret = AVERROR(EINVAL);
514 bytestream_put_le16(&ptr, s->num_entries); // write tag count
515 bytestream_put_buffer(&ptr, s->entries, s->num_entries * 12);
516 bytestream_put_le32(&ptr, 0);
518 pkt->size = ptr - pkt->data;
522 return ret < 0 ? ret : 0;
525 static av_cold int encode_init(AVCodecContext *avctx)
527 TiffEncoderContext *s = avctx->priv_data;
530 if (s->compr == TIFF_DEFLATE) {
531 av_log(avctx, AV_LOG_ERROR,
532 "Deflate compression needs zlib compiled in\n");
533 return AVERROR(ENOSYS);
542 static av_cold int encode_close(AVCodecContext *avctx)
544 TiffEncoderContext *s = avctx->priv_data;
546 av_freep(&s->strip_sizes);
547 av_freep(&s->strip_offsets);
548 av_freep(&s->yuv_line);
553 #define OFFSET(x) offsetof(TiffEncoderContext, x)
554 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
555 static const AVOption options[] = {
556 {"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},
557 { "compression_algo", NULL, OFFSET(compr), AV_OPT_TYPE_INT, { .i64 = TIFF_PACKBITS }, TIFF_RAW, TIFF_DEFLATE, VE, "compression_algo" },
558 { "packbits", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = TIFF_PACKBITS }, 0, 0, VE, "compression_algo" },
559 { "raw", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = TIFF_RAW }, 0, 0, VE, "compression_algo" },
560 { "lzw", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = TIFF_LZW }, 0, 0, VE, "compression_algo" },
561 { "deflate", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = TIFF_DEFLATE }, 0, 0, VE, "compression_algo" },
565 static const AVClass tiffenc_class = {
566 .class_name = "TIFF encoder",
567 .item_name = av_default_item_name,
569 .version = LIBAVUTIL_VERSION_INT,
572 const FFCodec ff_tiff_encoder = {
574 CODEC_LONG_NAME("TIFF image"),
575 .p.type = AVMEDIA_TYPE_VIDEO,
576 .p.id = AV_CODEC_ID_TIFF,
577 .p.capabilities = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_FRAME_THREADS |
578 AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE,
579 .priv_data_size = sizeof(TiffEncoderContext),
581 .close = encode_close,
582 FF_CODEC_ENCODE_CB(encode_frame),
583 .p.pix_fmts = (const enum AVPixelFormat[]) {
584 AV_PIX_FMT_RGB24, AV_PIX_FMT_RGB48LE, AV_PIX_FMT_PAL8,
585 AV_PIX_FMT_RGBA, AV_PIX_FMT_RGBA64LE,
586 AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY8A, AV_PIX_FMT_GRAY16LE, AV_PIX_FMT_YA16LE,
587 AV_PIX_FMT_MONOBLACK, AV_PIX_FMT_MONOWHITE,
588 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P,
589 AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P,
592 .p.priv_class = &tiffenc_class,