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"
35 #include "libavutil/opt.h"
36 #include "bytestream.h"
42 #define TIFF_MAX_ENTRY 32
44 /** sizes of various TIFF field types (string size = 1)*/
45 static const uint8_t type_sizes2[6] = {
49 typedef struct TiffEncoderContext {
50 AVClass *class; ///< for private options
51 AVCodecContext *avctx;
54 int width; ///< picture width
55 int height; ///< picture height
56 unsigned int bpp; ///< bits per pixel
57 int compr; ///< compression level
58 int bpp_tab_size; ///< bpp_tab size
59 int photometric_interpretation; ///< photometric interpretation
60 int strips; ///< number of strips
61 int rps; ///< row per strip
62 uint8_t entries[TIFF_MAX_ENTRY*12]; ///< entires in header
63 int num_entries; ///< number of entires
64 uint8_t **buf; ///< actual position in buffer
65 uint8_t *buf_start; ///< pointer to first byte in buffer
66 int buf_size; ///< buffer size
67 uint16_t subsampling[2]; ///< YUV subsampling factors
68 struct LZWEncodeState *lzws; ///< LZW Encode state
69 uint32_t dpi; ///< image resolution in DPI
74 * Check free space in buffer
75 * @param s Tiff context
76 * @param need Needed bytes
77 * @return 0 - ok, 1 - no free space
79 inline static int check_size(TiffEncoderContext * s, uint64_t need)
81 if (s->buf_size < *s->buf - s->buf_start + need) {
82 *s->buf = s->buf_start + s->buf_size + 1;
83 av_log(s->avctx, AV_LOG_ERROR, "Buffer is too small\n");
90 * Put n values to buffer
92 * @param p Pointer to pointer to output buffer
93 * @param n Number of values
94 * @param val Pointer to values
95 * @param type Type of values
96 * @param flip =0 - normal copy, >0 - flip
98 static void tnput(uint8_t ** p, int n, const uint8_t * val, enum TiffTypes type,
103 flip ^= ((int[]) {0, 0, 0, 1, 3, 3})[type];
105 for (i = 0; i < n * type_sizes2[type]; i++)
106 *(*p)++ = val[i ^ flip];
110 * Add entry to directory in tiff header.
111 * @param s Tiff context
112 * @param tag Tag that identifies the entry
113 * @param type Entry type
114 * @param count The number of values
115 * @param ptr_val Pointer to values
117 static void add_entry(TiffEncoderContext * s,
118 enum TiffTags tag, enum TiffTypes type, int count,
121 uint8_t *entries_ptr = s->entries + 12 * s->num_entries;
123 assert(s->num_entries < TIFF_MAX_ENTRY);
125 bytestream_put_le16(&entries_ptr, tag);
126 bytestream_put_le16(&entries_ptr, type);
127 bytestream_put_le32(&entries_ptr, count);
129 if (type_sizes[type] * count <= 4) {
130 tnput(&entries_ptr, count, ptr_val, type, 0);
132 bytestream_put_le32(&entries_ptr, *s->buf - s->buf_start);
133 check_size(s, count * type_sizes2[type]);
134 tnput(s->buf, count, ptr_val, type, 0);
140 static void add_entry1(TiffEncoderContext * s,
141 enum TiffTags tag, enum TiffTypes type, int val){
144 add_entry(s, tag, type, 1, type == TIFF_SHORT ? (void *)&w : (void *)&dw);
148 * Encode one strip in tiff file
150 * @param s Tiff context
151 * @param src Input buffer
152 * @param dst Output buffer
153 * @param n Size of input buffer
154 * @param compr Compression method
155 * @return Number of output bytes. If an output error is encountered, -1 returned
157 static int encode_strip(TiffEncoderContext * s, const int8_t * src,
158 uint8_t * dst, int n, int compr)
164 case TIFF_ADOBE_DEFLATE:
166 unsigned long zlen = s->buf_size - (*s->buf - s->buf_start);
167 if (compress(dst, &zlen, src, n) != Z_OK) {
168 av_log(s->avctx, AV_LOG_ERROR, "Compressing failed\n");
175 if (check_size(s, n))
180 return ff_rle_encode(dst, s->buf_size - (*s->buf - s->buf_start), src, 1, n, 2, 0xff, -1, 0);
182 return ff_lzw_encode(s->lzws, src, n);
188 static void pack_yuv(TiffEncoderContext * s, uint8_t * dst, int lnum)
190 AVFrame *p = &s->picture;
192 int w = (s->width - 1) / s->subsampling[0] + 1;
193 uint8_t *pu = &p->data[1][lnum / s->subsampling[1] * p->linesize[1]];
194 uint8_t *pv = &p->data[2][lnum / s->subsampling[1] * p->linesize[2]];
195 for (i = 0; i < w; i++){
196 for (j = 0; j < s->subsampling[1]; j++)
197 for (k = 0; k < s->subsampling[0]; k++)
198 *dst++ = p->data[0][(lnum + j) * p->linesize[0] +
199 i * s->subsampling[0] + k];
205 static int encode_frame(AVCodecContext * avctx, unsigned char *buf,
206 int buf_size, void *data)
208 TiffEncoderContext *s = avctx->priv_data;
209 AVFrame *pict = data;
210 AVFrame *const p = (AVFrame *) & s->picture;
216 uint32_t *strip_sizes = NULL;
217 uint32_t *strip_offsets = NULL;
219 uint32_t res[2] = { s->dpi, 1 }; // image resolution (72/1)
220 uint16_t bpp_tab[] = { 8, 8, 8, 8 };
223 uint8_t *yuv_line = NULL;
224 int shift_h, shift_v;
229 s->buf_size = buf_size;
232 p->pict_type = AV_PICTURE_TYPE_I;
234 avctx->coded_frame= &s->picture;
236 s->width = avctx->width;
237 s->height = avctx->height;
238 s->subsampling[0] = 1;
239 s->subsampling[1] = 1;
241 switch (avctx->pix_fmt) {
242 case PIX_FMT_RGBA64LE:
244 s->photometric_interpretation = 2;
250 case PIX_FMT_RGB48LE:
252 s->photometric_interpretation = 2;
260 s->photometric_interpretation = 2;
264 s->photometric_interpretation = 2;
268 s->photometric_interpretation = 1;
272 s->photometric_interpretation = 3;
274 case PIX_FMT_MONOBLACK:
275 case PIX_FMT_MONOWHITE:
277 s->photometric_interpretation = avctx->pix_fmt == PIX_FMT_MONOBLACK;
280 case PIX_FMT_YUV420P:
281 case PIX_FMT_YUV422P:
282 case PIX_FMT_YUV444P:
283 case PIX_FMT_YUV410P:
284 case PIX_FMT_YUV411P:
285 s->photometric_interpretation = 6;
286 avcodec_get_chroma_sub_sample(avctx->pix_fmt,
288 s->bpp = 8 + (16 >> (shift_h + shift_v));
289 s->subsampling[0] = 1 << shift_h;
290 s->subsampling[1] = 1 << shift_v;
295 av_log(s->avctx, AV_LOG_ERROR,
296 "This colors format is not supported\n");
300 s->bpp_tab_size = (s->bpp >= 48) ? ((s->bpp + 7) >> 4):((s->bpp + 7) >> 3);
302 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE || s->compr == TIFF_LZW)
303 //best choose for DEFLATE
306 s->rps = FFMAX(8192 / (((s->width * s->bpp) >> 3) + 1), 1); // suggest size of strip
307 s->rps = ((s->rps - 1) / s->subsampling[1] + 1) * s->subsampling[1]; // round rps up
309 strips = (s->height - 1) / s->rps + 1;
311 if (check_size(s, 8))
315 bytestream_put_le16(&ptr, 0x4949);
316 bytestream_put_le16(&ptr, 42);
319 bytestream_put_le32(&ptr, 0);
321 strip_sizes = av_mallocz(sizeof(*strip_sizes) * strips);
322 strip_offsets = av_mallocz(sizeof(*strip_offsets) * strips);
324 bytes_per_row = (((s->width - 1)/s->subsampling[0] + 1) * s->bpp
325 * s->subsampling[0] * s->subsampling[1] + 7) >> 3;
327 yuv_line = av_malloc(bytes_per_row);
328 if (yuv_line == NULL){
329 av_log(s->avctx, AV_LOG_ERROR, "Not enough memory\n");
335 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
340 zlen = bytes_per_row * s->rps;
341 zbuf = av_malloc(zlen);
342 strip_offsets[0] = ptr - buf;
344 for (j = 0; j < s->rps; j++) {
346 pack_yuv(s, yuv_line, j);
347 memcpy(zbuf + zn, yuv_line, bytes_per_row);
348 j += s->subsampling[1] - 1;
351 memcpy(zbuf + j * bytes_per_row,
352 p->data[0] + j * p->linesize[0], bytes_per_row);
355 n = encode_strip(s, zbuf, ptr, zn, s->compr);
358 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
362 strip_sizes[0] = ptr - buf - strip_offsets[0];
366 if(s->compr == TIFF_LZW)
367 s->lzws = av_malloc(ff_lzw_encode_state_size);
368 for (i = 0; i < s->height; i++) {
369 if (strip_sizes[i / s->rps] == 0) {
370 if(s->compr == TIFF_LZW){
371 ff_lzw_encode_init(s->lzws, ptr, s->buf_size - (*s->buf - s->buf_start),
372 12, FF_LZW_TIFF, put_bits);
374 strip_offsets[i / s->rps] = ptr - buf;
377 pack_yuv(s, yuv_line, i);
378 n = encode_strip(s, yuv_line, ptr, bytes_per_row, s->compr);
379 i += s->subsampling[1] - 1;
382 n = encode_strip(s, p->data[0] + i * p->linesize[0],
383 ptr, bytes_per_row, s->compr);
385 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
388 strip_sizes[i / s->rps] += n;
390 if(s->compr == TIFF_LZW && (i==s->height-1 || i%s->rps == s->rps-1)){
392 ret = ff_lzw_encode_flush(s->lzws, flush_put_bits);
393 strip_sizes[(i / s->rps )] += ret ;
397 if(s->compr == TIFF_LZW)
403 add_entry1(s,TIFF_SUBFILE, TIFF_LONG, 0);
404 add_entry1(s,TIFF_WIDTH, TIFF_LONG, s->width);
405 add_entry1(s,TIFF_HEIGHT, TIFF_LONG, s->height);
408 add_entry(s, TIFF_BPP, TIFF_SHORT, s->bpp_tab_size, bpp_tab);
410 add_entry1(s,TIFF_COMPR, TIFF_SHORT, s->compr);
411 add_entry1(s,TIFF_INVERT, TIFF_SHORT, s->photometric_interpretation);
412 add_entry(s, TIFF_STRIP_OFFS, TIFF_LONG, strips, strip_offsets);
415 add_entry1(s,TIFF_SAMPLES_PER_PIXEL, TIFF_SHORT, s->bpp_tab_size);
417 add_entry1(s,TIFF_ROWSPERSTRIP, TIFF_LONG, s->rps);
418 add_entry(s, TIFF_STRIP_SIZE, TIFF_LONG, strips, strip_sizes);
419 add_entry(s, TIFF_XRES, TIFF_RATIONAL, 1, res);
420 add_entry(s, TIFF_YRES, TIFF_RATIONAL, 1, res);
421 add_entry1(s,TIFF_RES_UNIT, TIFF_SHORT, 2);
423 if(!(avctx->flags & CODEC_FLAG_BITEXACT))
424 add_entry(s, TIFF_SOFTWARE_NAME, TIFF_STRING,
425 strlen(LIBAVCODEC_IDENT) + 1, LIBAVCODEC_IDENT);
427 if (avctx->pix_fmt == PIX_FMT_PAL8) {
428 uint16_t pal[256 * 3];
429 for (i = 0; i < 256; i++) {
430 uint32_t rgb = *(uint32_t *) (p->data[1] + i * 4);
431 pal[i] = ((rgb >> 16) & 0xff) * 257;
432 pal[i + 256] = ((rgb >> 8 ) & 0xff) * 257;
433 pal[i + 512] = ( rgb & 0xff) * 257;
435 add_entry(s, TIFF_PAL, TIFF_SHORT, 256 * 3, pal);
438 /** according to CCIR Recommendation 601.1 */
439 uint32_t refbw[12] = {15, 1, 235, 1, 128, 1, 240, 1, 128, 1, 240, 1};
440 add_entry(s, TIFF_YCBCR_SUBSAMPLING, TIFF_SHORT, 2, s->subsampling);
441 add_entry(s, TIFF_REFERENCE_BW, TIFF_RATIONAL, 6, refbw);
443 bytestream_put_le32(&offset, ptr - buf); // write offset to dir
445 if (check_size(s, 6 + s->num_entries * 12))
447 bytestream_put_le16(&ptr, s->num_entries); // write tag count
448 bytestream_put_buffer(&ptr, s->entries, s->num_entries * 12);
449 bytestream_put_le32(&ptr, 0);
454 av_free(strip_sizes);
455 av_free(strip_offsets);
460 #define OFFSET(x) offsetof(TiffEncoderContext, x)
461 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
462 static const AVOption options[] = {
463 {"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},
464 { "compression_algo", NULL, OFFSET(compr), AV_OPT_TYPE_INT, {TIFF_PACKBITS}, TIFF_RAW, TIFF_DEFLATE, VE, "compression_algo" },
465 { "packbits", NULL, 0, AV_OPT_TYPE_CONST, {TIFF_PACKBITS}, 0, 0, VE, "compression_algo" },
466 { "raw", NULL, 0, AV_OPT_TYPE_CONST, {TIFF_RAW}, 0, 0, VE, "compression_algo" },
467 { "lzw", NULL, 0, AV_OPT_TYPE_CONST, {TIFF_LZW}, 0, 0, VE, "compression_algo" },
469 { "deflate", NULL, 0, AV_OPT_TYPE_CONST, {TIFF_DEFLATE}, 0, 0, VE, "compression_algo" },
474 static const AVClass tiffenc_class = {
475 .class_name = "TIFF encoder",
476 .item_name = av_default_item_name,
478 .version = LIBAVUTIL_VERSION_INT,
481 AVCodec ff_tiff_encoder = {
483 .type = AVMEDIA_TYPE_VIDEO,
485 .priv_data_size = sizeof(TiffEncoderContext),
486 .encode = encode_frame,
488 (const enum PixelFormat[]) {PIX_FMT_RGB24, PIX_FMT_PAL8, PIX_FMT_GRAY8,
489 PIX_FMT_MONOBLACK, PIX_FMT_MONOWHITE,
490 PIX_FMT_YUV420P, PIX_FMT_YUV422P,
491 PIX_FMT_YUV444P, PIX_FMT_YUV410P,
492 PIX_FMT_YUV411P, PIX_FMT_RGB48LE,
493 PIX_FMT_RGBA, PIX_FMT_RGBA64LE, PIX_FMT_NONE},
494 .long_name = NULL_IF_CONFIG_SMALL("TIFF image"),
495 .priv_class = &tiffenc_class,