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"
45 #define TIFF_MAX_ENTRY 32
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
52 typedef struct TiffEncoderContext {
53 AVClass *class; ///< for private options
54 AVCodecContext *avctx;
57 int width; ///< picture width
58 int height; ///< picture height
59 unsigned int bpp; ///< bits per pixel
60 int compr; ///< compression level
61 int bpp_tab_size; ///< bpp_tab size
62 int photometric_interpretation; ///< photometric interpretation
63 int strips; ///< number of strips
64 uint32_t *strip_sizes;
65 unsigned int strip_sizes_size;
66 uint32_t *strip_offsets;
67 unsigned int strip_offsets_size;
69 unsigned int yuv_line_size;
70 int rps; ///< row per strip
71 uint8_t entries[TIFF_MAX_ENTRY * 12]; ///< entries in header
72 int num_entries; ///< number of entries
73 uint8_t **buf; ///< actual position in buffer
74 uint8_t *buf_start; ///< pointer to first byte in buffer
75 int buf_size; ///< buffer size
76 uint16_t subsampling[2]; ///< YUV subsampling factors
77 struct LZWEncodeState *lzws; ///< LZW encode state
78 uint32_t dpi; ///< image resolution in DPI
82 * Check free space in buffer.
84 * @param s Tiff context
85 * @param need Needed bytes
86 * @return 0 - ok, 1 - no free space
88 static inline int check_size(TiffEncoderContext *s, uint64_t need)
90 if (s->buf_size < *s->buf - s->buf_start + need) {
91 *s->buf = s->buf_start + s->buf_size + 1;
92 av_log(s->avctx, AV_LOG_ERROR, "Buffer is too small\n");
99 * Put n values to buffer.
101 * @param p pointer to pointer to output buffer
102 * @param n number of values
103 * @param val pointer to values
104 * @param type type of values
105 * @param flip = 0 - normal copy, >0 - flip
107 static void tnput(uint8_t **p, int n, const uint8_t *val, enum TiffTypes type,
112 flip ^= ((int[]) { 0, 0, 0, 1, 3, 3 })[type];
114 for (i = 0; i < n * type_sizes2[type]; i++)
115 *(*p)++ = val[i ^ flip];
119 * Add entry to directory in tiff header.
121 * @param s Tiff context
122 * @param tag tag that identifies the entry
123 * @param type entry type
124 * @param count the number of values
125 * @param ptr_val pointer to values
127 static void add_entry(TiffEncoderContext *s, enum TiffTags tag,
128 enum TiffTypes type, int count, const void *ptr_val)
130 uint8_t *entries_ptr = s->entries + 12 * s->num_entries;
132 av_assert0(s->num_entries < TIFF_MAX_ENTRY);
134 bytestream_put_le16(&entries_ptr, tag);
135 bytestream_put_le16(&entries_ptr, type);
136 bytestream_put_le32(&entries_ptr, count);
138 if (type_sizes[type] * (int64_t)count <= 4) {
139 tnput(&entries_ptr, count, ptr_val, type, 0);
141 bytestream_put_le32(&entries_ptr, *s->buf - s->buf_start);
142 check_size(s, count * (int64_t)type_sizes2[type]);
143 tnput(s->buf, count, ptr_val, type, 0);
149 static void add_entry1(TiffEncoderContext *s,
150 enum TiffTags tag, enum TiffTypes type, int val)
154 add_entry(s, tag, type, 1, type == TIFF_SHORT ? (void *)&w : (void *)&dw);
158 * Encode one strip in tiff file.
160 * @param s Tiff context
161 * @param src input buffer
162 * @param dst output buffer
163 * @param n size of input buffer
164 * @param compr compression method
165 * @return number of output bytes. If an output error is encountered, -1 is returned
167 static int encode_strip(TiffEncoderContext *s, const int8_t *src,
168 uint8_t *dst, int n, int compr)
173 case TIFF_ADOBE_DEFLATE:
175 unsigned long zlen = s->buf_size - (*s->buf - s->buf_start);
176 if (compress(dst, &zlen, src, n) != Z_OK) {
177 av_log(s->avctx, AV_LOG_ERROR, "Compressing failed\n");
184 if (check_size(s, n))
189 return ff_rle_encode(dst, s->buf_size - (*s->buf - s->buf_start),
190 src, 1, n, 2, 0xff, -1, 0);
192 return ff_lzw_encode(s->lzws, src, n);
198 static void pack_yuv(TiffEncoderContext *s, uint8_t *dst, int lnum)
200 AVFrame *p = &s->picture;
202 int w = (s->width - 1) / s->subsampling[0] + 1;
203 uint8_t *pu = &p->data[1][lnum / s->subsampling[1] * p->linesize[1]];
204 uint8_t *pv = &p->data[2][lnum / s->subsampling[1] * p->linesize[2]];
205 if (s->width % s->subsampling[0] || s->height % s->subsampling[1]) {
206 for (i = 0; i < w; i++) {
207 for (j = 0; j < s->subsampling[1]; j++)
208 for (k = 0; k < s->subsampling[0]; k++)
209 *dst++ = p->data[0][FFMIN(lnum + j, s->height-1) * p->linesize[0] +
210 FFMIN(i * s->subsampling[0] + k, s->width-1)];
215 for (i = 0; i < w; i++) {
216 for (j = 0; j < s->subsampling[1]; j++)
217 for (k = 0; k < s->subsampling[0]; k++)
218 *dst++ = p->data[0][(lnum + j) * p->linesize[0] +
219 i * s->subsampling[0] + k];
226 static av_cold int encode_init(AVCodecContext *avctx)
228 TiffEncoderContext *s = avctx->priv_data;
230 avctx->coded_frame = &s->picture;
231 avctx->coded_frame->pict_type = AV_PICTURE_TYPE_I;
232 avctx->coded_frame->key_frame = 1;
238 static int encode_frame(AVCodecContext *avctx, AVPacket *pkt,
239 const AVFrame *pict, int *got_packet)
241 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(avctx->pix_fmt);
242 TiffEncoderContext *s = avctx->priv_data;
243 AVFrame *const p = &s->picture;
249 uint32_t res[2] = { s->dpi, 1 }; // image resolution (72/1)
252 int is_yuv = 0, alpha = 0;
253 int shift_h, shift_v;
257 s->width = avctx->width;
258 s->height = avctx->height;
259 s->subsampling[0] = 1;
260 s->subsampling[1] = 1;
262 avctx->bits_per_coded_sample =
263 s->bpp = av_get_bits_per_pixel(desc);
264 s->bpp_tab_size = desc->nb_components;
266 switch (avctx->pix_fmt) {
267 case AV_PIX_FMT_RGBA64LE:
268 case AV_PIX_FMT_RGBA:
270 case AV_PIX_FMT_RGB48LE:
271 case AV_PIX_FMT_RGB24:
272 s->photometric_interpretation = 2;
274 case AV_PIX_FMT_GRAY8:
275 avctx->bits_per_coded_sample = 0x28;
276 case AV_PIX_FMT_GRAY8A:
277 alpha = avctx->pix_fmt == AV_PIX_FMT_GRAY8A;
278 case AV_PIX_FMT_GRAY16LE:
279 case AV_PIX_FMT_MONOBLACK:
280 s->photometric_interpretation = 1;
282 case AV_PIX_FMT_PAL8:
283 s->photometric_interpretation = 3;
285 case AV_PIX_FMT_MONOWHITE:
286 s->photometric_interpretation = 0;
288 case AV_PIX_FMT_YUV420P:
289 case AV_PIX_FMT_YUV422P:
290 case AV_PIX_FMT_YUV440P:
291 case AV_PIX_FMT_YUV444P:
292 case AV_PIX_FMT_YUV410P:
293 case AV_PIX_FMT_YUV411P:
294 av_pix_fmt_get_chroma_sub_sample(avctx->pix_fmt, &shift_h, &shift_v);
295 s->photometric_interpretation = 6;
296 s->subsampling[0] = 1 << shift_h;
297 s->subsampling[1] = 1 << shift_v;
301 av_log(s->avctx, AV_LOG_ERROR,
302 "This colors format is not supported\n");
306 for (i = 0; i < s->bpp_tab_size; i++)
307 bpp_tab[i] = desc->comp[i].depth_minus1 + 1;
309 if (s->compr == TIFF_DEFLATE ||
310 s->compr == TIFF_ADOBE_DEFLATE ||
311 s->compr == TIFF_LZW)
312 // best choice for DEFLATE
315 // suggest size of strip
316 s->rps = FFMAX(8192 / (((s->width * s->bpp) >> 3) + 1), 1);
318 s->rps = ((s->rps - 1) / s->subsampling[1] + 1) * s->subsampling[1];
320 strips = (s->height - 1) / s->rps + 1;
322 if ((ret = ff_alloc_packet2(avctx, pkt,
323 avctx->width * avctx->height * s->bpp * 2 +
324 avctx->height * 4 + FF_MIN_BUFFER_SIZE)) < 0)
327 s->buf_start = pkt->data;
329 s->buf_size = pkt->size;
331 if (check_size(s, 8))
335 bytestream_put_le16(&ptr, 0x4949);
336 bytestream_put_le16(&ptr, 42);
339 bytestream_put_le32(&ptr, 0);
341 av_fast_padded_mallocz(&s->strip_sizes , &s->strip_sizes_size , sizeof(s->strip_sizes [0]) * strips);
342 av_fast_padded_mallocz(&s->strip_offsets, &s->strip_offsets_size, sizeof(s->strip_offsets[0]) * strips);
344 if (!s->strip_sizes || !s->strip_offsets) {
345 ret = AVERROR(ENOMEM);
349 bytes_per_row = (((s->width - 1) / s->subsampling[0] + 1) * s->bpp *
350 s->subsampling[0] * s->subsampling[1] + 7) >> 3;
352 av_fast_padded_malloc(&s->yuv_line, &s->yuv_line_size, bytes_per_row);
353 if (s->yuv_line == NULL) {
354 av_log(s->avctx, AV_LOG_ERROR, "Not enough memory\n");
355 ret = AVERROR(ENOMEM);
361 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
366 zlen = bytes_per_row * s->rps;
367 zbuf = av_malloc(zlen);
369 ret = AVERROR(ENOMEM);
372 s->strip_offsets[0] = ptr - pkt->data;
374 for (j = 0; j < s->rps; j++) {
376 pack_yuv(s, s->yuv_line, j);
377 memcpy(zbuf + zn, s->yuv_line, bytes_per_row);
378 j += s->subsampling[1] - 1;
380 memcpy(zbuf + j * bytes_per_row,
381 p->data[0] + j * p->linesize[0], bytes_per_row);
384 ret = encode_strip(s, zbuf, ptr, zn, s->compr);
387 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
391 s->strip_sizes[0] = ptr - pkt->data - s->strip_offsets[0];
395 if (s->compr == TIFF_LZW) {
396 s->lzws = av_malloc(ff_lzw_encode_state_size);
398 ret = AVERROR(ENOMEM);
402 for (i = 0; i < s->height; i++) {
403 if (s->strip_sizes[i / s->rps] == 0) {
404 if (s->compr == TIFF_LZW) {
405 ff_lzw_encode_init(s->lzws, ptr,
406 s->buf_size - (*s->buf - s->buf_start),
407 12, FF_LZW_TIFF, put_bits);
409 s->strip_offsets[i / s->rps] = ptr - pkt->data;
412 pack_yuv(s, s->yuv_line, i);
413 ret = encode_strip(s, s->yuv_line, ptr, bytes_per_row, s->compr);
414 i += s->subsampling[1] - 1;
416 ret = encode_strip(s, p->data[0] + i * p->linesize[0],
417 ptr, bytes_per_row, s->compr);
419 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
422 s->strip_sizes[i / s->rps] += ret;
424 if (s->compr == TIFF_LZW &&
425 (i == s->height - 1 || i % s->rps == s->rps - 1)) {
426 ret = ff_lzw_encode_flush(s->lzws, flush_put_bits);
427 s->strip_sizes[(i / s->rps)] += ret;
431 if (s->compr == TIFF_LZW)
437 add_entry1(s, TIFF_SUBFILE, TIFF_LONG, 0);
438 add_entry1(s, TIFF_WIDTH, TIFF_LONG, s->width);
439 add_entry1(s, TIFF_HEIGHT, TIFF_LONG, s->height);
442 add_entry(s, TIFF_BPP, TIFF_SHORT, s->bpp_tab_size, bpp_tab);
444 add_entry1(s, TIFF_COMPR, TIFF_SHORT, s->compr);
445 add_entry1(s, TIFF_INVERT, TIFF_SHORT, s->photometric_interpretation);
446 add_entry(s, TIFF_STRIP_OFFS, TIFF_LONG, strips, s->strip_offsets);
449 add_entry1(s, TIFF_SAMPLES_PER_PIXEL, TIFF_SHORT, s->bpp_tab_size);
451 add_entry1(s, TIFF_ROWSPERSTRIP, TIFF_LONG, s->rps);
452 add_entry(s, TIFF_STRIP_SIZE, TIFF_LONG, strips, s->strip_sizes);
453 add_entry(s, TIFF_XRES, TIFF_RATIONAL, 1, res);
454 add_entry(s, TIFF_YRES, TIFF_RATIONAL, 1, res);
455 add_entry1(s, TIFF_RES_UNIT, TIFF_SHORT, 2);
457 if (!(avctx->flags & CODEC_FLAG_BITEXACT))
458 add_entry(s, TIFF_SOFTWARE_NAME, TIFF_STRING,
459 strlen(LIBAVCODEC_IDENT) + 1, LIBAVCODEC_IDENT);
461 if (avctx->pix_fmt == AV_PIX_FMT_PAL8) {
462 uint16_t pal[256 * 3];
463 for (i = 0; i < 256; i++) {
464 uint32_t rgb = *(uint32_t *) (p->data[1] + i * 4);
465 pal[i] = ((rgb >> 16) & 0xff) * 257;
466 pal[i + 256] = ((rgb >> 8) & 0xff) * 257;
467 pal[i + 512] = (rgb & 0xff) * 257;
469 add_entry(s, TIFF_PAL, TIFF_SHORT, 256 * 3, pal);
472 add_entry1(s,TIFF_EXTRASAMPLES, TIFF_SHORT, 2);
474 /** according to CCIR Recommendation 601.1 */
475 uint32_t refbw[12] = { 15, 1, 235, 1, 128, 1, 240, 1, 128, 1, 240, 1 };
476 add_entry(s, TIFF_YCBCR_SUBSAMPLING, TIFF_SHORT, 2, s->subsampling);
477 if (avctx->chroma_sample_location == AVCHROMA_LOC_TOPLEFT)
478 add_entry1(s, TIFF_YCBCR_POSITIONING, TIFF_SHORT, 2);
479 add_entry(s, TIFF_REFERENCE_BW, TIFF_RATIONAL, 6, refbw);
481 // write offset to dir
482 bytestream_put_le32(&offset, ptr - pkt->data);
484 if (check_size(s, 6 + s->num_entries * 12)) {
485 ret = AVERROR(EINVAL);
488 bytestream_put_le16(&ptr, s->num_entries); // write tag count
489 bytestream_put_buffer(&ptr, s->entries, s->num_entries * 12);
490 bytestream_put_le32(&ptr, 0);
492 pkt->size = ptr - pkt->data;
493 pkt->flags |= AV_PKT_FLAG_KEY;
497 return ret < 0 ? ret : 0;
500 static av_cold int encode_close(AVCodecContext *avctx)
502 TiffEncoderContext *s = avctx->priv_data;
504 av_freep(&s->strip_sizes);
505 av_freep(&s->strip_offsets);
506 av_freep(&s->yuv_line);
511 #define OFFSET(x) offsetof(TiffEncoderContext, x)
512 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
513 static const AVOption options[] = {
514 {"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},
515 { "compression_algo", NULL, OFFSET(compr), AV_OPT_TYPE_INT, { .i64 = TIFF_PACKBITS }, TIFF_RAW, TIFF_DEFLATE, VE, "compression_algo" },
516 { "packbits", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = TIFF_PACKBITS }, 0, 0, VE, "compression_algo" },
517 { "raw", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = TIFF_RAW }, 0, 0, VE, "compression_algo" },
518 { "lzw", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = TIFF_LZW }, 0, 0, VE, "compression_algo" },
520 { "deflate", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = TIFF_DEFLATE }, 0, 0, VE, "compression_algo" },
525 static const AVClass tiffenc_class = {
526 .class_name = "TIFF encoder",
527 .item_name = av_default_item_name,
529 .version = LIBAVUTIL_VERSION_INT,
532 AVCodec ff_tiff_encoder = {
534 .long_name = NULL_IF_CONFIG_SMALL("TIFF image"),
535 .type = AVMEDIA_TYPE_VIDEO,
536 .id = AV_CODEC_ID_TIFF,
537 .priv_data_size = sizeof(TiffEncoderContext),
539 .encode2 = encode_frame,
540 .close = encode_close,
541 .pix_fmts = (const enum AVPixelFormat[]) {
542 AV_PIX_FMT_RGB24, AV_PIX_FMT_PAL8, AV_PIX_FMT_GRAY8,
543 AV_PIX_FMT_GRAY8A, AV_PIX_FMT_GRAY16LE,
544 AV_PIX_FMT_MONOBLACK, AV_PIX_FMT_MONOWHITE,
545 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P,
546 AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_RGB48LE,
547 AV_PIX_FMT_RGBA, AV_PIX_FMT_RGBA64LE,
550 .priv_class = &tiffenc_class,