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
28 #include "libavutil/log.h"
29 #include "libavutil/opt.h"
36 #include "libavutil/opt.h"
37 #include "bytestream.h"
43 #define TIFF_MAX_ENTRY 32
45 /** sizes of various TIFF field types (string size = 1)*/
46 static const uint8_t type_sizes2[6] = {
50 typedef struct TiffEncoderContext {
51 AVClass *class; ///< for private options
52 AVCodecContext *avctx;
55 int width; ///< picture width
56 int height; ///< picture height
57 unsigned int bpp; ///< bits per pixel
58 int compr; ///< compression level
59 int bpp_tab_size; ///< bpp_tab size
60 int photometric_interpretation; ///< photometric interpretation
61 int strips; ///< number of strips
62 int rps; ///< row per strip
63 uint8_t entries[TIFF_MAX_ENTRY*12]; ///< entires in header
64 int num_entries; ///< number of entires
65 uint8_t **buf; ///< actual position in buffer
66 uint8_t *buf_start; ///< pointer to first byte in buffer
67 int buf_size; ///< buffer size
68 uint16_t subsampling[2]; ///< YUV subsampling factors
69 struct LZWEncodeState *lzws; ///< LZW Encode state
70 uint32_t dpi; ///< image resolution in DPI
75 * Check free space in buffer
76 * @param s Tiff context
77 * @param need Needed bytes
78 * @return 0 - ok, 1 - no free space
80 inline static int check_size(TiffEncoderContext * s, uint64_t need)
82 if (s->buf_size < *s->buf - s->buf_start + need) {
83 *s->buf = s->buf_start + s->buf_size + 1;
84 av_log(s->avctx, AV_LOG_ERROR, "Buffer is too small\n");
91 * Put n values to buffer
93 * @param p Pointer to pointer to output buffer
94 * @param n Number of values
95 * @param val Pointer to values
96 * @param type Type of values
97 * @param flip =0 - normal copy, >0 - flip
99 static void tnput(uint8_t ** p, int n, const uint8_t * val, enum TiffTypes type,
104 flip ^= ((int[]) {0, 0, 0, 1, 3, 3})[type];
106 for (i = 0; i < n * type_sizes2[type]; i++)
107 *(*p)++ = val[i ^ flip];
111 * Add entry to directory in tiff header.
112 * @param s Tiff context
113 * @param tag Tag that identifies the entry
114 * @param type Entry type
115 * @param count The number of values
116 * @param ptr_val Pointer to values
118 static void add_entry(TiffEncoderContext * s,
119 enum TiffTags tag, enum TiffTypes type, int count,
122 uint8_t *entries_ptr = s->entries + 12 * s->num_entries;
124 assert(s->num_entries < TIFF_MAX_ENTRY);
126 bytestream_put_le16(&entries_ptr, tag);
127 bytestream_put_le16(&entries_ptr, type);
128 bytestream_put_le32(&entries_ptr, count);
130 if (type_sizes[type] * count <= 4) {
131 tnput(&entries_ptr, count, ptr_val, type, 0);
133 bytestream_put_le32(&entries_ptr, *s->buf - s->buf_start);
134 check_size(s, count * type_sizes2[type]);
135 tnput(s->buf, count, ptr_val, type, 0);
141 static void add_entry1(TiffEncoderContext * s,
142 enum TiffTags tag, enum TiffTypes type, int val){
145 add_entry(s, tag, type, 1, type == TIFF_SHORT ? (void *)&w : (void *)&dw);
149 * Encode one strip in tiff file
151 * @param s Tiff context
152 * @param src Input buffer
153 * @param dst Output buffer
154 * @param n Size of input buffer
155 * @param compr Compression method
156 * @return Number of output bytes. If an output error is encountered, -1 returned
158 static int encode_strip(TiffEncoderContext * s, const int8_t * src,
159 uint8_t * dst, int n, int compr)
165 case TIFF_ADOBE_DEFLATE:
167 unsigned long zlen = s->buf_size - (*s->buf - s->buf_start);
168 if (compress(dst, &zlen, src, n) != Z_OK) {
169 av_log(s->avctx, AV_LOG_ERROR, "Compressing failed\n");
176 if (check_size(s, n))
181 return ff_rle_encode(dst, s->buf_size - (*s->buf - s->buf_start), src, 1, n, 2, 0xff, -1, 0);
183 return ff_lzw_encode(s->lzws, src, n);
189 static void pack_yuv(TiffEncoderContext * s, uint8_t * dst, int lnum)
191 AVFrame *p = &s->picture;
193 int w = (s->width - 1) / s->subsampling[0] + 1;
194 uint8_t *pu = &p->data[1][lnum / s->subsampling[1] * p->linesize[1]];
195 uint8_t *pv = &p->data[2][lnum / s->subsampling[1] * p->linesize[2]];
196 for (i = 0; i < w; i++){
197 for (j = 0; j < s->subsampling[1]; j++)
198 for (k = 0; k < s->subsampling[0]; k++)
199 *dst++ = p->data[0][(lnum + j) * p->linesize[0] +
200 i * s->subsampling[0] + k];
206 static int encode_frame(AVCodecContext * avctx, AVPacket *pkt,
207 const AVFrame *pict, int *got_packet)
209 TiffEncoderContext *s = avctx->priv_data;
210 AVFrame *const p = &s->picture;
215 uint32_t *strip_sizes = NULL;
216 uint32_t *strip_offsets = NULL;
218 uint32_t res[2] = { s->dpi, 1 }; // image resolution (72/1)
219 uint16_t bpp_tab[] = { 8, 8, 8, 8 };
222 uint8_t *yuv_line = NULL;
223 int shift_h, shift_v;
228 p->pict_type = AV_PICTURE_TYPE_I;
230 avctx->coded_frame= &s->picture;
232 s->width = avctx->width;
233 s->height = avctx->height;
234 s->subsampling[0] = 1;
235 s->subsampling[1] = 1;
237 switch (avctx->pix_fmt) {
238 case PIX_FMT_RGBA64LE:
240 s->photometric_interpretation = 2;
246 case PIX_FMT_RGB48LE:
248 s->photometric_interpretation = 2;
256 s->photometric_interpretation = 2;
260 s->photometric_interpretation = 2;
264 s->photometric_interpretation = 1;
268 s->photometric_interpretation = 3;
270 case PIX_FMT_MONOBLACK:
271 case PIX_FMT_MONOWHITE:
273 s->photometric_interpretation = avctx->pix_fmt == PIX_FMT_MONOBLACK;
276 case PIX_FMT_YUV420P:
277 case PIX_FMT_YUV422P:
278 case PIX_FMT_YUV444P:
279 case PIX_FMT_YUV410P:
280 case PIX_FMT_YUV411P:
281 s->photometric_interpretation = 6;
282 avcodec_get_chroma_sub_sample(avctx->pix_fmt,
284 s->bpp = 8 + (16 >> (shift_h + shift_v));
285 s->subsampling[0] = 1 << shift_h;
286 s->subsampling[1] = 1 << shift_v;
291 av_log(s->avctx, AV_LOG_ERROR,
292 "This colors format is not supported\n");
296 s->bpp_tab_size = (s->bpp >= 48) ? ((s->bpp + 7) >> 4):((s->bpp + 7) >> 3);
298 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE || s->compr == TIFF_LZW)
299 //best choose for DEFLATE
302 s->rps = FFMAX(8192 / (((s->width * s->bpp) >> 3) + 1), 1); // suggest size of strip
303 s->rps = ((s->rps - 1) / s->subsampling[1] + 1) * s->subsampling[1]; // round rps up
305 strips = (s->height - 1) / s->rps + 1;
307 if ((ret = ff_alloc_packet2(avctx, pkt, avctx->width * avctx->height * s->bpp * 2 +
308 avctx->height * 4 + FF_MIN_BUFFER_SIZE)) < 0)
311 s->buf_start = pkt->data;
313 s->buf_size = pkt->size;
315 if (check_size(s, 8))
319 bytestream_put_le16(&ptr, 0x4949);
320 bytestream_put_le16(&ptr, 42);
323 bytestream_put_le32(&ptr, 0);
325 strip_sizes = av_mallocz(sizeof(*strip_sizes) * strips);
326 strip_offsets = av_mallocz(sizeof(*strip_offsets) * strips);
328 bytes_per_row = (((s->width - 1)/s->subsampling[0] + 1) * s->bpp
329 * s->subsampling[0] * s->subsampling[1] + 7) >> 3;
331 yuv_line = av_malloc(bytes_per_row);
332 if (yuv_line == NULL){
333 av_log(s->avctx, AV_LOG_ERROR, "Not enough memory\n");
339 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
344 zlen = bytes_per_row * s->rps;
345 zbuf = av_malloc(zlen);
346 strip_offsets[0] = ptr - pkt->data;
348 for (j = 0; j < s->rps; j++) {
350 pack_yuv(s, yuv_line, j);
351 memcpy(zbuf + zn, yuv_line, bytes_per_row);
352 j += s->subsampling[1] - 1;
355 memcpy(zbuf + j * bytes_per_row,
356 p->data[0] + j * p->linesize[0], bytes_per_row);
359 ret = encode_strip(s, zbuf, ptr, zn, s->compr);
362 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
366 strip_sizes[0] = ptr - pkt->data - strip_offsets[0];
370 if(s->compr == TIFF_LZW)
371 s->lzws = av_malloc(ff_lzw_encode_state_size);
372 for (i = 0; i < s->height; i++) {
373 if (strip_sizes[i / s->rps] == 0) {
374 if(s->compr == TIFF_LZW){
375 ff_lzw_encode_init(s->lzws, ptr, s->buf_size - (*s->buf - s->buf_start),
376 12, FF_LZW_TIFF, put_bits);
378 strip_offsets[i / s->rps] = ptr - pkt->data;
381 pack_yuv(s, yuv_line, i);
382 ret = encode_strip(s, yuv_line, ptr, bytes_per_row, s->compr);
383 i += s->subsampling[1] - 1;
386 ret = encode_strip(s, p->data[0] + i * p->linesize[0],
387 ptr, bytes_per_row, s->compr);
389 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
392 strip_sizes[i / s->rps] += ret;
394 if(s->compr == TIFF_LZW && (i==s->height-1 || i%s->rps == s->rps-1)){
395 ret = ff_lzw_encode_flush(s->lzws, flush_put_bits);
396 strip_sizes[(i / s->rps )] += ret ;
400 if(s->compr == TIFF_LZW)
406 add_entry1(s,TIFF_SUBFILE, TIFF_LONG, 0);
407 add_entry1(s,TIFF_WIDTH, TIFF_LONG, s->width);
408 add_entry1(s,TIFF_HEIGHT, TIFF_LONG, s->height);
411 add_entry(s, TIFF_BPP, TIFF_SHORT, s->bpp_tab_size, bpp_tab);
413 add_entry1(s,TIFF_COMPR, TIFF_SHORT, s->compr);
414 add_entry1(s,TIFF_INVERT, TIFF_SHORT, s->photometric_interpretation);
415 add_entry(s, TIFF_STRIP_OFFS, TIFF_LONG, strips, strip_offsets);
418 add_entry1(s,TIFF_SAMPLES_PER_PIXEL, TIFF_SHORT, s->bpp_tab_size);
420 add_entry1(s,TIFF_ROWSPERSTRIP, TIFF_LONG, s->rps);
421 add_entry(s, TIFF_STRIP_SIZE, TIFF_LONG, strips, strip_sizes);
422 add_entry(s, TIFF_XRES, TIFF_RATIONAL, 1, res);
423 add_entry(s, TIFF_YRES, TIFF_RATIONAL, 1, res);
424 add_entry1(s,TIFF_RES_UNIT, TIFF_SHORT, 2);
426 if(!(avctx->flags & CODEC_FLAG_BITEXACT))
427 add_entry(s, TIFF_SOFTWARE_NAME, TIFF_STRING,
428 strlen(LIBAVCODEC_IDENT) + 1, LIBAVCODEC_IDENT);
430 if (avctx->pix_fmt == PIX_FMT_PAL8) {
431 uint16_t pal[256 * 3];
432 for (i = 0; i < 256; i++) {
433 uint32_t rgb = *(uint32_t *) (p->data[1] + i * 4);
434 pal[i] = ((rgb >> 16) & 0xff) * 257;
435 pal[i + 256] = ((rgb >> 8 ) & 0xff) * 257;
436 pal[i + 512] = ( rgb & 0xff) * 257;
438 add_entry(s, TIFF_PAL, TIFF_SHORT, 256 * 3, pal);
441 /** according to CCIR Recommendation 601.1 */
442 uint32_t refbw[12] = {15, 1, 235, 1, 128, 1, 240, 1, 128, 1, 240, 1};
443 add_entry(s, TIFF_YCBCR_SUBSAMPLING, TIFF_SHORT, 2, s->subsampling);
444 add_entry(s, TIFF_REFERENCE_BW, TIFF_RATIONAL, 6, refbw);
446 bytestream_put_le32(&offset, ptr - pkt->data); // write offset to dir
448 if (check_size(s, 6 + s->num_entries * 12)) {
449 ret = AVERROR(EINVAL);
452 bytestream_put_le16(&ptr, s->num_entries); // write tag count
453 bytestream_put_buffer(&ptr, s->entries, s->num_entries * 12);
454 bytestream_put_le32(&ptr, 0);
456 pkt->size = ptr - pkt->data;
457 pkt->flags |= AV_PKT_FLAG_KEY;
461 av_free(strip_sizes);
462 av_free(strip_offsets);
464 return ret < 0 ? ret : 0;
467 #define OFFSET(x) offsetof(TiffEncoderContext, x)
468 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
469 static const AVOption options[] = {
470 {"dpi", "set the image resolution (in dpi)", OFFSET(dpi), AV_OPT_TYPE_INT, {.dbl = 72}, 1, 0x10000, AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_ENCODING_PARAM},
471 { "compression_algo", NULL, OFFSET(compr), AV_OPT_TYPE_INT, {TIFF_PACKBITS}, TIFF_RAW, TIFF_DEFLATE, VE, "compression_algo" },
472 { "packbits", NULL, 0, AV_OPT_TYPE_CONST, {TIFF_PACKBITS}, 0, 0, VE, "compression_algo" },
473 { "raw", NULL, 0, AV_OPT_TYPE_CONST, {TIFF_RAW}, 0, 0, VE, "compression_algo" },
474 { "lzw", NULL, 0, AV_OPT_TYPE_CONST, {TIFF_LZW}, 0, 0, VE, "compression_algo" },
476 { "deflate", NULL, 0, AV_OPT_TYPE_CONST, {TIFF_DEFLATE}, 0, 0, VE, "compression_algo" },
481 static const AVClass tiffenc_class = {
482 .class_name = "TIFF encoder",
483 .item_name = av_default_item_name,
485 .version = LIBAVUTIL_VERSION_INT,
488 AVCodec ff_tiff_encoder = {
490 .type = AVMEDIA_TYPE_VIDEO,
492 .priv_data_size = sizeof(TiffEncoderContext),
493 .encode2 = encode_frame,
495 (const enum PixelFormat[]) {PIX_FMT_RGB24, PIX_FMT_PAL8, PIX_FMT_GRAY8,
496 PIX_FMT_MONOBLACK, PIX_FMT_MONOWHITE,
497 PIX_FMT_YUV420P, PIX_FMT_YUV422P,
498 PIX_FMT_YUV444P, PIX_FMT_YUV410P,
499 PIX_FMT_YUV411P, PIX_FMT_RGB48LE,
500 PIX_FMT_RGBA, PIX_FMT_RGBA64LE, PIX_FMT_NONE},
501 .long_name = NULL_IF_CONFIG_SMALL("TIFF image"),
502 .priv_class = &tiffenc_class,