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 * TIFF image encoder 24 * @file libavcodec/tiffenc.c 25 * @author Bartlomiej Wolowiec 26 */ 27#include "avcodec.h" 28#if CONFIG_ZLIB 29#include <zlib.h> 30#endif 31#include "bytestream.h" 32#include "tiff.h" 33#include "rle.h" 34#include "lzw.h" 35 36#define TIFF_MAX_ENTRY 32 37 38/** sizes of various TIFF field types (string size = 1)*/ 39static const uint8_t type_sizes2[6] = { 40 0, 1, 1, 2, 4, 8 41}; 42 43typedef struct TiffEncoderContext { 44 AVCodecContext *avctx; 45 AVFrame picture; 46 47 int width; ///< picture width 48 int height; ///< picture height 49 unsigned int bpp; ///< bits per pixel 50 int compr; ///< compression level 51 int bpp_tab_size; ///< bpp_tab size 52 int photometric_interpretation; ///< photometric interpretation 53 int strips; ///< number of strips 54 int rps; ///< row per strip 55 uint8_t entries[TIFF_MAX_ENTRY*12]; ///< entires in header 56 int num_entries; ///< number of entires 57 uint8_t **buf; ///< actual position in buffer 58 uint8_t *buf_start; ///< pointer to first byte in buffer 59 int buf_size; ///< buffer size 60 uint16_t subsampling[2]; ///< YUV subsampling factors 61 struct LZWEncodeState *lzws; ///< LZW Encode state 62} TiffEncoderContext; 63 64 65/** 66 * Check free space in buffer 67 * @param s Tiff context 68 * @param need Needed bytes 69 * @return 0 - ok, 1 - no free space 70 */ 71inline static int check_size(TiffEncoderContext * s, uint64_t need) 72{ 73 if (s->buf_size < *s->buf - s->buf_start + need) { 74 *s->buf = s->buf_start + s->buf_size + 1; 75 av_log(s->avctx, AV_LOG_ERROR, "Buffer is too small\n"); 76 return 1; 77 } 78 return 0; 79} 80 81/** 82 * Put n values to buffer 83 * 84 * @param p Pointer to pointer to output buffer 85 * @param n Number of values 86 * @param val Pointer to values 87 * @param type Type of values 88 * @param flip =0 - normal copy, >0 - flip 89 */ 90static void tnput(uint8_t ** p, int n, const uint8_t * val, enum TiffTypes type, 91 int flip) 92{ 93 int i; 94#ifdef WORDS_BIGENDIAN 95 flip ^= ((int[]) {0, 0, 0, 1, 3, 3})[type]; 96#endif 97 for (i = 0; i < n * type_sizes2[type]; i++) 98 *(*p)++ = val[i ^ flip]; 99} 100 101/** 102 * Add entry to directory in tiff header. 103 * @param s Tiff context 104 * @param tag Tag that identifies the entry 105 * @param type Entry type 106 * @param count The number of values 107 * @param ptr_val Pointer to values 108 */ 109static void add_entry(TiffEncoderContext * s, 110 enum TiffTags tag, enum TiffTypes type, int count, 111 const void *ptr_val) 112{ 113 uint8_t *entries_ptr = s->entries + 12 * s->num_entries; 114 115 assert(s->num_entries < TIFF_MAX_ENTRY); 116 117 bytestream_put_le16(&entries_ptr, tag); 118 bytestream_put_le16(&entries_ptr, type); 119 bytestream_put_le32(&entries_ptr, count); 120 121 if (type_sizes[type] * count <= 4) { 122 tnput(&entries_ptr, count, ptr_val, type, 0); 123 } else { 124 bytestream_put_le32(&entries_ptr, *s->buf - s->buf_start); 125 check_size(s, count * type_sizes2[type]); 126 tnput(s->buf, count, ptr_val, type, 0); 127 } 128 129 s->num_entries++; 130} 131 132static void add_entry1(TiffEncoderContext * s, 133 enum TiffTags tag, enum TiffTypes type, int val){ 134 uint16_t w = val; 135 uint32_t dw= val; 136 add_entry(s, tag, type, 1, type == TIFF_SHORT ? (void *)&w : (void *)&dw); 137} 138 139/** 140 * Encode one strip in tiff file 141 * 142 * @param s Tiff context 143 * @param src Input buffer 144 * @param dst Output buffer 145 * @param n Size of input buffer 146 * @param compr Compression method 147 * @return Number of output bytes. If an output error is encountered, -1 returned 148 */ 149static int encode_strip(TiffEncoderContext * s, const int8_t * src, 150 uint8_t * dst, int n, int compr) 151{ 152 153 switch (compr) { 154#if CONFIG_ZLIB 155 case TIFF_DEFLATE: 156 case TIFF_ADOBE_DEFLATE: 157 { 158 unsigned long zlen = s->buf_size - (*s->buf - s->buf_start); 159 if (compress(dst, &zlen, src, n) != Z_OK) { 160 av_log(s->avctx, AV_LOG_ERROR, "Compressing failed\n"); 161 return -1; 162 } 163 return zlen; 164 } 165#endif 166 case TIFF_RAW: 167 if (check_size(s, n)) 168 return -1; 169 memcpy(dst, src, n); 170 return n; 171 case TIFF_PACKBITS: 172 return ff_rle_encode(dst, s->buf_size - (*s->buf - s->buf_start), src, 1, n, 2, 0xff, -1, 0); 173 case TIFF_LZW: 174 return ff_lzw_encode(s->lzws, src, n); 175 default: 176 return -1; 177 } 178} 179 180static void pack_yuv(TiffEncoderContext * s, uint8_t * dst, int lnum) 181{ 182 AVFrame *p = &s->picture; 183 int i, j, k; 184 int w = (s->width - 1) / s->subsampling[0] + 1; 185 uint8_t *pu = &p->data[1][lnum / s->subsampling[1] * p->linesize[1]]; 186 uint8_t *pv = &p->data[2][lnum / s->subsampling[1] * p->linesize[2]]; 187 for (i = 0; i < w; i++){ 188 for (j = 0; j < s->subsampling[1]; j++) 189 for (k = 0; k < s->subsampling[0]; k++) 190 *dst++ = p->data[0][(lnum + j) * p->linesize[0] + 191 i * s->subsampling[0] + k]; 192 *dst++ = *pu++; 193 *dst++ = *pv++; 194 } 195} 196 197static int encode_frame(AVCodecContext * avctx, unsigned char *buf, 198 int buf_size, void *data) 199{ 200 TiffEncoderContext *s = avctx->priv_data; 201 AVFrame *pict = data; 202 AVFrame *const p = (AVFrame *) & s->picture; 203 int i; 204 int n; 205 uint8_t *ptr = buf; 206 uint8_t *offset; 207 uint32_t strips; 208 uint32_t *strip_sizes = NULL; 209 uint32_t *strip_offsets = NULL; 210 int bytes_per_row; 211 uint32_t res[2] = { 72, 1 }; // image resolution (72/1) 212 static const uint16_t bpp_tab[] = { 8, 8, 8, 8 }; 213 int ret = -1; 214 int is_yuv = 0; 215 uint8_t *yuv_line = NULL; 216 int shift_h, shift_v; 217 218 s->buf_start = buf; 219 s->buf = &ptr; 220 s->buf_size = buf_size; 221 222 *p = *pict; 223 p->pict_type = FF_I_TYPE; 224 p->key_frame = 1; 225 avctx->coded_frame= &s->picture; 226 227 s->compr = TIFF_PACKBITS; 228 if (avctx->compression_level == 0) { 229 s->compr = TIFF_RAW; 230 } else if(avctx->compression_level == 2) { 231 s->compr = TIFF_LZW; 232#if CONFIG_ZLIB 233 } else if ((avctx->compression_level >= 3)) { 234 s->compr = TIFF_DEFLATE; 235#endif 236 } 237 238 s->width = avctx->width; 239 s->height = avctx->height; 240 s->subsampling[0] = 1; 241 s->subsampling[1] = 1; 242 243 switch (avctx->pix_fmt) { 244 case PIX_FMT_RGB24: 245 s->bpp = 24; 246 s->photometric_interpretation = 2; 247 break; 248 case PIX_FMT_GRAY8: 249 s->bpp = 8; 250 s->photometric_interpretation = 1; 251 break; 252 case PIX_FMT_PAL8: 253 s->bpp = 8; 254 s->photometric_interpretation = 3; 255 break; 256 case PIX_FMT_MONOBLACK: 257 s->bpp = 1; 258 s->photometric_interpretation = 1; 259 break; 260 case PIX_FMT_MONOWHITE: 261 s->bpp = 1; 262 s->photometric_interpretation = 0; 263 break; 264 case PIX_FMT_YUV420P: 265 case PIX_FMT_YUV422P: 266 case PIX_FMT_YUV444P: 267 case PIX_FMT_YUV410P: 268 case PIX_FMT_YUV411P: 269 s->photometric_interpretation = 6; 270 avcodec_get_chroma_sub_sample(avctx->pix_fmt, 271 &shift_h, &shift_v); 272 s->bpp = 8 + (16 >> (shift_h + shift_v)); 273 s->subsampling[0] = 1 << shift_h; 274 s->subsampling[1] = 1 << shift_v; 275 s->bpp_tab_size = 3; 276 is_yuv = 1; 277 break; 278 default: 279 av_log(s->avctx, AV_LOG_ERROR, 280 "This colors format is not supported\n"); 281 return -1; 282 } 283 if (!is_yuv) 284 s->bpp_tab_size = (s->bpp >> 3); 285 286 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE || s->compr == TIFF_LZW) 287 //best choose for DEFLATE 288 s->rps = s->height; 289 else 290 s->rps = FFMAX(8192 / (((s->width * s->bpp) >> 3) + 1), 1); // suggest size of strip 291 s->rps = ((s->rps - 1) / s->subsampling[1] + 1) * s->subsampling[1]; // round rps up 292 293 strips = (s->height - 1) / s->rps + 1; 294 295 if (check_size(s, 8)) 296 goto fail; 297 298 // write header 299 bytestream_put_le16(&ptr, 0x4949); 300 bytestream_put_le16(&ptr, 42); 301 302 offset = ptr; 303 bytestream_put_le32(&ptr, 0); 304 305 strip_sizes = av_mallocz(sizeof(*strip_sizes) * strips); 306 strip_offsets = av_mallocz(sizeof(*strip_offsets) * strips); 307 308 bytes_per_row = (((s->width - 1)/s->subsampling[0] + 1) * s->bpp 309 * s->subsampling[0] * s->subsampling[1] + 7) >> 3; 310 if (is_yuv){ 311 yuv_line = av_malloc(bytes_per_row); 312 if (yuv_line == NULL){ 313 av_log(s->avctx, AV_LOG_ERROR, "Not enough memory\n"); 314 goto fail; 315 } 316 } 317 318#if CONFIG_ZLIB 319 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) { 320 uint8_t *zbuf; 321 int zlen, zn; 322 int j; 323 324 zlen = bytes_per_row * s->rps; 325 zbuf = av_malloc(zlen); 326 strip_offsets[0] = ptr - buf; 327 zn = 0; 328 for (j = 0; j < s->rps; j++) { 329 if (is_yuv){ 330 pack_yuv(s, yuv_line, j); 331 memcpy(zbuf + zn, yuv_line, bytes_per_row); 332 j += s->subsampling[1] - 1; 333 } 334 else 335 memcpy(zbuf + j * bytes_per_row, 336 p->data[0] + j * p->linesize[0], bytes_per_row); 337 zn += bytes_per_row; 338 } 339 n = encode_strip(s, zbuf, ptr, zn, s->compr); 340 av_free(zbuf); 341 if (n<0) { 342 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n"); 343 goto fail; 344 } 345 ptr += n; 346 strip_sizes[0] = ptr - buf - strip_offsets[0]; 347 } else 348#endif 349 { 350 if(s->compr == TIFF_LZW) 351 s->lzws = av_malloc(ff_lzw_encode_state_size); 352 for (i = 0; i < s->height; i++) { 353 if (strip_sizes[i / s->rps] == 0) { 354 if(s->compr == TIFF_LZW){ 355 ff_lzw_encode_init(s->lzws, ptr, s->buf_size - (*s->buf - s->buf_start), 12); 356 } 357 strip_offsets[i / s->rps] = ptr - buf; 358 } 359 if (is_yuv){ 360 pack_yuv(s, yuv_line, i); 361 n = encode_strip(s, yuv_line, ptr, bytes_per_row, s->compr); 362 i += s->subsampling[1] - 1; 363 } 364 else 365 n = encode_strip(s, p->data[0] + i * p->linesize[0], 366 ptr, bytes_per_row, s->compr); 367 if (n < 0) { 368 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n"); 369 goto fail; 370 } 371 strip_sizes[i / s->rps] += n; 372 ptr += n; 373 if(s->compr == TIFF_LZW && (i==s->height-1 || i%s->rps == s->rps-1)){ 374 int ret; 375 ret = ff_lzw_encode_flush(s->lzws); 376 strip_sizes[(i / s->rps )] += ret ; 377 ptr += ret; 378 } 379 } 380 if(s->compr == TIFF_LZW) 381 av_free(s->lzws); 382 } 383 384 s->num_entries = 0; 385 386 add_entry1(s,TIFF_SUBFILE, TIFF_LONG, 0); 387 add_entry1(s,TIFF_WIDTH, TIFF_LONG, s->width); 388 add_entry1(s,TIFF_HEIGHT, TIFF_LONG, s->height); 389 390 if (s->bpp_tab_size) 391 add_entry(s, TIFF_BPP, TIFF_SHORT, s->bpp_tab_size, bpp_tab); 392 393 add_entry1(s,TIFF_COMPR, TIFF_SHORT, s->compr); 394 add_entry1(s,TIFF_INVERT, TIFF_SHORT, s->photometric_interpretation); 395 add_entry(s, TIFF_STRIP_OFFS, TIFF_LONG, strips, strip_offsets); 396 397 if (s->bpp_tab_size) 398 add_entry1(s,TIFF_SAMPLES_PER_PIXEL, TIFF_SHORT, s->bpp_tab_size); 399 400 add_entry1(s,TIFF_ROWSPERSTRIP, TIFF_LONG, s->rps); 401 add_entry(s, TIFF_STRIP_SIZE, TIFF_LONG, strips, strip_sizes); 402 add_entry(s, TIFF_XRES, TIFF_RATIONAL, 1, res); 403 add_entry(s, TIFF_YRES, TIFF_RATIONAL, 1, res); 404 add_entry1(s,TIFF_RES_UNIT, TIFF_SHORT, 2); 405 406 if(!(avctx->flags & CODEC_FLAG_BITEXACT)) 407 add_entry(s, TIFF_SOFTWARE_NAME, TIFF_STRING, 408 strlen(LIBAVCODEC_IDENT) + 1, LIBAVCODEC_IDENT); 409 410 if (avctx->pix_fmt == PIX_FMT_PAL8) { 411 uint16_t pal[256 * 3]; 412 for (i = 0; i < 256; i++) { 413 uint32_t rgb = *(uint32_t *) (p->data[1] + i * 4); 414 pal[i] = ((rgb >> 16) & 0xff) * 257; 415 pal[i + 256] = ((rgb >> 8 ) & 0xff) * 257; 416 pal[i + 512] = ( rgb & 0xff) * 257; 417 } 418 add_entry(s, TIFF_PAL, TIFF_SHORT, 256 * 3, pal); 419 } 420 if (is_yuv){ 421 /** according to CCIR Recommendation 601.1 */ 422 uint32_t refbw[12] = {15, 1, 235, 1, 128, 1, 240, 1, 128, 1, 240, 1}; 423 add_entry(s, TIFF_YCBCR_SUBSAMPLING, TIFF_SHORT, 2, s->subsampling); 424 add_entry(s, TIFF_REFERENCE_BW, TIFF_RATIONAL, 6, refbw); 425 } 426 bytestream_put_le32(&offset, ptr - buf); // write offset to dir 427 428 if (check_size(s, 6 + s->num_entries * 12)) 429 goto fail; 430 bytestream_put_le16(&ptr, s->num_entries); // write tag count 431 bytestream_put_buffer(&ptr, s->entries, s->num_entries * 12); 432 bytestream_put_le32(&ptr, 0); 433 434 ret = ptr - buf; 435 436fail: 437 av_free(strip_sizes); 438 av_free(strip_offsets); 439 av_free(yuv_line); 440 return ret; 441} 442 443AVCodec tiff_encoder = { 444 "tiff", 445 CODEC_TYPE_VIDEO, 446 CODEC_ID_TIFF, 447 sizeof(TiffEncoderContext), 448 NULL, 449 encode_frame, 450 NULL, 451 NULL, 452 0, 453 NULL, 454 .pix_fmts = 455 (enum PixelFormat[]) {PIX_FMT_RGB24, PIX_FMT_PAL8, PIX_FMT_GRAY8, 456 PIX_FMT_MONOBLACK, PIX_FMT_MONOWHITE, 457 PIX_FMT_YUV420P, PIX_FMT_YUV422P, 458 PIX_FMT_YUV444P, PIX_FMT_YUV410P, 459 PIX_FMT_YUV411P, 460 PIX_FMT_NONE}, 461 .long_name = NULL_IF_CONFIG_SMALL("TIFF image"), 462}; 463