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)*/ 48static const uint8_t type_sizes2[14] = { 49 0, 1, 1, 2, 4, 8, 1, 1, 2, 4, 8, 4, 8, 4 50}; 51 52typedef 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 enum TiffPhotometric 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 */ 87static 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 */ 106static 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 */ 126static 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 148static 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 */ 166static 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 197static 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 225static 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 int packet_size; 242 243 s->width = avctx->width; 244 s->height = avctx->height; 245 s->subsampling[0] = 1; 246 s->subsampling[1] = 1; 247 248 avctx->bits_per_coded_sample = 249 s->bpp = av_get_bits_per_pixel(desc); 250 s->bpp_tab_size = desc->nb_components; 251 252 switch (avctx->pix_fmt) { 253 case AV_PIX_FMT_RGBA64LE: 254 case AV_PIX_FMT_RGBA: 255 alpha = 1; 256 case AV_PIX_FMT_RGB48LE: 257 case AV_PIX_FMT_RGB24: 258 s->photometric_interpretation = TIFF_PHOTOMETRIC_RGB; 259 break; 260 case AV_PIX_FMT_GRAY8: 261 avctx->bits_per_coded_sample = 0x28; 262 case AV_PIX_FMT_GRAY8A: 263 alpha = avctx->pix_fmt == AV_PIX_FMT_GRAY8A; 264 case AV_PIX_FMT_GRAY16LE: 265 case AV_PIX_FMT_MONOBLACK: 266 s->photometric_interpretation = TIFF_PHOTOMETRIC_BLACK_IS_ZERO; 267 break; 268 case AV_PIX_FMT_PAL8: 269 s->photometric_interpretation = TIFF_PHOTOMETRIC_PALETTE; 270 break; 271 case AV_PIX_FMT_MONOWHITE: 272 s->photometric_interpretation = TIFF_PHOTOMETRIC_WHITE_IS_ZERO; 273 break; 274 case AV_PIX_FMT_YUV420P: 275 case AV_PIX_FMT_YUV422P: 276 case AV_PIX_FMT_YUV440P: 277 case AV_PIX_FMT_YUV444P: 278 case AV_PIX_FMT_YUV410P: 279 case AV_PIX_FMT_YUV411P: 280 av_pix_fmt_get_chroma_sub_sample(avctx->pix_fmt, &shift_h, &shift_v); 281 s->photometric_interpretation = TIFF_PHOTOMETRIC_YCBCR; 282 s->subsampling[0] = 1 << shift_h; 283 s->subsampling[1] = 1 << shift_v; 284 is_yuv = 1; 285 break; 286 default: 287 av_log(s->avctx, AV_LOG_ERROR, 288 "This colors format is not supported\n"); 289 return -1; 290 } 291 292 for (i = 0; i < s->bpp_tab_size; i++) 293 bpp_tab[i] = desc->comp[i].depth_minus1 + 1; 294 295 if (s->compr == TIFF_DEFLATE || 296 s->compr == TIFF_ADOBE_DEFLATE || 297 s->compr == TIFF_LZW) 298 // best choice for DEFLATE 299 s->rps = s->height; 300 else 301 // suggest size of strip 302 s->rps = FFMAX(8192 / (((s->width * s->bpp) >> 3) + 1), 1); 303 // round rps up 304 s->rps = ((s->rps - 1) / s->subsampling[1] + 1) * s->subsampling[1]; 305 306 strips = (s->height - 1) / s->rps + 1; 307 308 packet_size = avctx->height * ((avctx->width * s->bpp + 7) >> 3) * 2 + 309 avctx->height * 4 + FF_MIN_BUFFER_SIZE; 310 311 if ((ret = ff_alloc_packet2(avctx, pkt, packet_size)) < 0) 312 return ret; 313 ptr = pkt->data; 314 s->buf_start = pkt->data; 315 s->buf = &ptr; 316 s->buf_size = pkt->size; 317 318 if (check_size(s, 8)) 319 goto fail; 320 321 // write header 322 bytestream_put_le16(&ptr, 0x4949); 323 bytestream_put_le16(&ptr, 42); 324 325 offset = ptr; 326 bytestream_put_le32(&ptr, 0); 327 328 av_fast_padded_mallocz(&s->strip_sizes , &s->strip_sizes_size , sizeof(s->strip_sizes [0]) * strips); 329 av_fast_padded_mallocz(&s->strip_offsets, &s->strip_offsets_size, sizeof(s->strip_offsets[0]) * strips); 330 331 if (!s->strip_sizes || !s->strip_offsets) { 332 ret = AVERROR(ENOMEM); 333 goto fail; 334 } 335 336 bytes_per_row = (((s->width - 1) / s->subsampling[0] + 1) * s->bpp * 337 s->subsampling[0] * s->subsampling[1] + 7) >> 3; 338 if (is_yuv) { 339 av_fast_padded_malloc(&s->yuv_line, &s->yuv_line_size, bytes_per_row); 340 if (s->yuv_line == NULL) { 341 av_log(s->avctx, AV_LOG_ERROR, "Not enough memory\n"); 342 ret = AVERROR(ENOMEM); 343 goto fail; 344 } 345 } 346 347#if CONFIG_ZLIB 348 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) { 349 uint8_t *zbuf; 350 int zlen, zn; 351 int j; 352 353 zlen = bytes_per_row * s->rps; 354 zbuf = av_malloc(zlen); 355 if (!zbuf) { 356 ret = AVERROR(ENOMEM); 357 goto fail; 358 } 359 s->strip_offsets[0] = ptr - pkt->data; 360 zn = 0; 361 for (j = 0; j < s->rps; j++) { 362 if (is_yuv) { 363 pack_yuv(s, p, s->yuv_line, j); 364 memcpy(zbuf + zn, s->yuv_line, bytes_per_row); 365 j += s->subsampling[1] - 1; 366 } else 367 memcpy(zbuf + j * bytes_per_row, 368 p->data[0] + j * p->linesize[0], bytes_per_row); 369 zn += bytes_per_row; 370 } 371 ret = encode_strip(s, zbuf, ptr, zn, s->compr); 372 av_free(zbuf); 373 if (ret < 0) { 374 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n"); 375 goto fail; 376 } 377 ptr += ret; 378 s->strip_sizes[0] = ptr - pkt->data - s->strip_offsets[0]; 379 } else 380#endif 381 { 382 if (s->compr == TIFF_LZW) { 383 s->lzws = av_malloc(ff_lzw_encode_state_size); 384 if (!s->lzws) { 385 ret = AVERROR(ENOMEM); 386 goto fail; 387 } 388 } 389 for (i = 0; i < s->height; i++) { 390 if (s->strip_sizes[i / s->rps] == 0) { 391 if (s->compr == TIFF_LZW) { 392 ff_lzw_encode_init(s->lzws, ptr, 393 s->buf_size - (*s->buf - s->buf_start), 394 12, FF_LZW_TIFF, put_bits); 395 } 396 s->strip_offsets[i / s->rps] = ptr - pkt->data; 397 } 398 if (is_yuv) { 399 pack_yuv(s, p, s->yuv_line, i); 400 ret = encode_strip(s, s->yuv_line, ptr, bytes_per_row, s->compr); 401 i += s->subsampling[1] - 1; 402 } else 403 ret = encode_strip(s, p->data[0] + i * p->linesize[0], 404 ptr, bytes_per_row, s->compr); 405 if (ret < 0) { 406 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n"); 407 goto fail; 408 } 409 s->strip_sizes[i / s->rps] += ret; 410 ptr += ret; 411 if (s->compr == TIFF_LZW && 412 (i == s->height - 1 || i % s->rps == s->rps - 1)) { 413 ret = ff_lzw_encode_flush(s->lzws, flush_put_bits); 414 s->strip_sizes[(i / s->rps)] += ret; 415 ptr += ret; 416 } 417 } 418 if (s->compr == TIFF_LZW) 419 av_free(s->lzws); 420 } 421 422 s->num_entries = 0; 423 424 add_entry1(s, TIFF_SUBFILE, TIFF_LONG, 0); 425 add_entry1(s, TIFF_WIDTH, TIFF_LONG, s->width); 426 add_entry1(s, TIFF_HEIGHT, TIFF_LONG, s->height); 427 428 if (s->bpp_tab_size) 429 add_entry(s, TIFF_BPP, TIFF_SHORT, s->bpp_tab_size, bpp_tab); 430 431 add_entry1(s, TIFF_COMPR, TIFF_SHORT, s->compr); 432 add_entry1(s, TIFF_PHOTOMETRIC, TIFF_SHORT, s->photometric_interpretation); 433 add_entry(s, TIFF_STRIP_OFFS, TIFF_LONG, strips, s->strip_offsets); 434 435 if (s->bpp_tab_size) 436 add_entry1(s, TIFF_SAMPLES_PER_PIXEL, TIFF_SHORT, s->bpp_tab_size); 437 438 add_entry1(s, TIFF_ROWSPERSTRIP, TIFF_LONG, s->rps); 439 add_entry(s, TIFF_STRIP_SIZE, TIFF_LONG, strips, s->strip_sizes); 440 add_entry(s, TIFF_XRES, TIFF_RATIONAL, 1, res); 441 if (avctx->sample_aspect_ratio.num > 0 && 442 avctx->sample_aspect_ratio.den > 0) { 443 AVRational y = av_mul_q(av_make_q(s->dpi, 1), 444 avctx->sample_aspect_ratio); 445 res[0] = y.num; 446 res[1] = y.den; 447 } 448 add_entry(s, TIFF_YRES, TIFF_RATIONAL, 1, res); 449 add_entry1(s, TIFF_RES_UNIT, TIFF_SHORT, 2); 450 451 if (!(avctx->flags & CODEC_FLAG_BITEXACT)) 452 add_entry(s, TIFF_SOFTWARE_NAME, TIFF_STRING, 453 strlen(LIBAVCODEC_IDENT) + 1, LIBAVCODEC_IDENT); 454 455 if (avctx->pix_fmt == AV_PIX_FMT_PAL8) { 456 uint16_t pal[256 * 3]; 457 for (i = 0; i < 256; i++) { 458 uint32_t rgb = *(uint32_t *) (p->data[1] + i * 4); 459 pal[i] = ((rgb >> 16) & 0xff) * 257; 460 pal[i + 256] = ((rgb >> 8) & 0xff) * 257; 461 pal[i + 512] = (rgb & 0xff) * 257; 462 } 463 add_entry(s, TIFF_PAL, TIFF_SHORT, 256 * 3, pal); 464 } 465 if (alpha) 466 add_entry1(s,TIFF_EXTRASAMPLES, TIFF_SHORT, 2); 467 if (is_yuv) { 468 /** according to CCIR Recommendation 601.1 */ 469 uint32_t refbw[12] = { 15, 1, 235, 1, 128, 1, 240, 1, 128, 1, 240, 1 }; 470 add_entry(s, TIFF_YCBCR_SUBSAMPLING, TIFF_SHORT, 2, s->subsampling); 471 if (avctx->chroma_sample_location == AVCHROMA_LOC_TOPLEFT) 472 add_entry1(s, TIFF_YCBCR_POSITIONING, TIFF_SHORT, 2); 473 add_entry(s, TIFF_REFERENCE_BW, TIFF_RATIONAL, 6, refbw); 474 } 475 // write offset to dir 476 bytestream_put_le32(&offset, ptr - pkt->data); 477 478 if (check_size(s, 6 + s->num_entries * 12)) { 479 ret = AVERROR(EINVAL); 480 goto fail; 481 } 482 bytestream_put_le16(&ptr, s->num_entries); // write tag count 483 bytestream_put_buffer(&ptr, s->entries, s->num_entries * 12); 484 bytestream_put_le32(&ptr, 0); 485 486 pkt->size = ptr - pkt->data; 487 pkt->flags |= AV_PKT_FLAG_KEY; 488 *got_packet = 1; 489 490fail: 491 return ret < 0 ? ret : 0; 492} 493 494static av_cold int encode_init(AVCodecContext *avctx) 495{ 496 TiffEncoderContext *s = avctx->priv_data; 497 498 avctx->coded_frame = av_frame_alloc(); 499 if (!avctx->coded_frame) 500 return AVERROR(ENOMEM); 501 502 avctx->coded_frame->pict_type = AV_PICTURE_TYPE_I; 503 avctx->coded_frame->key_frame = 1; 504 s->avctx = avctx; 505 506 return 0; 507} 508 509static av_cold int encode_close(AVCodecContext *avctx) 510{ 511 TiffEncoderContext *s = avctx->priv_data; 512 513 av_frame_free(&avctx->coded_frame); 514 av_freep(&s->strip_sizes); 515 av_freep(&s->strip_offsets); 516 av_freep(&s->yuv_line); 517 518 return 0; 519} 520 521#define OFFSET(x) offsetof(TiffEncoderContext, x) 522#define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM 523static const AVOption options[] = { 524 {"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}, 525 { "compression_algo", NULL, OFFSET(compr), AV_OPT_TYPE_INT, { .i64 = TIFF_PACKBITS }, TIFF_RAW, TIFF_DEFLATE, VE, "compression_algo" }, 526 { "packbits", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = TIFF_PACKBITS }, 0, 0, VE, "compression_algo" }, 527 { "raw", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = TIFF_RAW }, 0, 0, VE, "compression_algo" }, 528 { "lzw", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = TIFF_LZW }, 0, 0, VE, "compression_algo" }, 529#if CONFIG_ZLIB 530 { "deflate", NULL, 0, AV_OPT_TYPE_CONST, { .i64 = TIFF_DEFLATE }, 0, 0, VE, "compression_algo" }, 531#endif 532 { NULL }, 533}; 534 535static const AVClass tiffenc_class = { 536 .class_name = "TIFF encoder", 537 .item_name = av_default_item_name, 538 .option = options, 539 .version = LIBAVUTIL_VERSION_INT, 540}; 541 542AVCodec ff_tiff_encoder = { 543 .name = "tiff", 544 .long_name = NULL_IF_CONFIG_SMALL("TIFF image"), 545 .type = AVMEDIA_TYPE_VIDEO, 546 .id = AV_CODEC_ID_TIFF, 547 .priv_data_size = sizeof(TiffEncoderContext), 548 .init = encode_init, 549 .close = encode_close, 550 .capabilities = CODEC_CAP_FRAME_THREADS | CODEC_CAP_INTRA_ONLY, 551 .encode2 = encode_frame, 552 .pix_fmts = (const enum AVPixelFormat[]) { 553 AV_PIX_FMT_RGB24, AV_PIX_FMT_PAL8, AV_PIX_FMT_GRAY8, 554 AV_PIX_FMT_GRAY8A, AV_PIX_FMT_GRAY16LE, 555 AV_PIX_FMT_MONOBLACK, AV_PIX_FMT_MONOWHITE, 556 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P, 557 AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_RGB48LE, 558 AV_PIX_FMT_RGBA, AV_PIX_FMT_RGBA64LE, 559 AV_PIX_FMT_NONE 560 }, 561 .priv_class = &tiffenc_class, 562}; 563