git.sesse.net Git - ffmpeg/blob - libavcodec/tiffenc.c

   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 "libavutil/log.h"
  29 #include "libavutil/opt.h"
  30
  31 #include "avcodec.h"
  32 #if CONFIG_ZLIB
  33 #include <zlib.h>
  34 #endif
  35 #include "libavutil/opt.h"
  36 #include "bytestream.h"
  37 #include "tiff.h"
  38 #include "rle.h"
  39 #include "lzw.h"
  40 #include "put_bits.h"
  41
  42 #define TIFF_MAX_ENTRY 32
  43
  44 /** sizes of various TIFF field types (string size = 1)*/
  45 static const uint8_t type_sizes2[6] = {
  46     0, 1, 1, 2, 4, 8
  47 };
  48
  49 typedef struct TiffEncoderContext {
  50     AVClass *class;                     ///< for private options
  51     AVCodecContext *avctx;
  52     AVFrame picture;
  53
  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
  70 } TiffEncoderContext;
  71
  72
  73 /**
  74  * Check free space in buffer
  75  * @param s Tiff context
  76  * @param need Needed bytes
  77  * @return 0 - ok, 1 - no free space
  78  */
  79 inline static int check_size(TiffEncoderContext * s, uint64_t need)
  80 {
  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");
  84         return 1;
  85     }
  86     return 0;
  87 }
  88
  89 /**
  90  * Put n values to buffer
  91  *
  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
  97  */
  98 static void tnput(uint8_t ** p, int n, const uint8_t * val, enum TiffTypes type,
  99                   int flip)
 100 {
 101     int i;
 102 #if HAVE_BIGENDIAN
 103     flip ^= ((int[]) {0, 0, 0, 1, 3, 3})[type];
 104 #endif
 105     for (i = 0; i < n * type_sizes2[type]; i++)
 106         *(*p)++ = val[i ^ flip];
 107 }
 108
 109 /**
 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
 116  */
 117 static void add_entry(TiffEncoderContext * s,
 118                       enum TiffTags tag, enum TiffTypes type, int count,
 119                       const void *ptr_val)
 120 {
 121     uint8_t *entries_ptr = s->entries + 12 * s->num_entries;
 122
 123     assert(s->num_entries < TIFF_MAX_ENTRY);
 124
 125     bytestream_put_le16(&entries_ptr, tag);
 126     bytestream_put_le16(&entries_ptr, type);
 127     bytestream_put_le32(&entries_ptr, count);
 128
 129     if (type_sizes[type] * count <= 4) {
 130         tnput(&entries_ptr, count, ptr_val, type, 0);
 131     } else {
 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);
 135     }
 136
 137     s->num_entries++;
 138 }
 139
 140 static void add_entry1(TiffEncoderContext * s,
 141                        enum TiffTags tag, enum TiffTypes type, int val){
 142     uint16_t w = val;
 143     uint32_t dw= val;
 144     add_entry(s, tag, type, 1, type == TIFF_SHORT ? (void *)&w : (void *)&dw);
 145 }
 146
 147 /**
 148  * Encode one strip in tiff file
 149  *
 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
 156  */
 157 static int encode_strip(TiffEncoderContext * s, const int8_t * src,
 158                         uint8_t * dst, int n, int compr)
 159 {
 160
 161     switch (compr) {
 162 #if CONFIG_ZLIB
 163     case TIFF_DEFLATE:
 164     case TIFF_ADOBE_DEFLATE:
 165         {
 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");
 169                 return -1;
 170             }
 171             return zlen;
 172         }
 173 #endif
 174     case TIFF_RAW:
 175         if (check_size(s, n))
 176             return -1;
 177         memcpy(dst, src, n);
 178         return n;
 179     case TIFF_PACKBITS:
 180         return ff_rle_encode(dst, s->buf_size - (*s->buf - s->buf_start), src, 1, n, 2, 0xff, -1, 0);
 181     case TIFF_LZW:
 182         return ff_lzw_encode(s->lzws, src, n);
 183     default:
 184         return -1;
 185     }
 186 }
 187
 188 static void pack_yuv(TiffEncoderContext * s, uint8_t * dst, int lnum)
 189 {
 190     AVFrame *p = &s->picture;
 191     int i, j, k;
 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];
 200         *dst++ = *pu++;
 201         *dst++ = *pv++;
 202     }
 203 }
 204
 205 static int encode_frame(AVCodecContext * avctx, unsigned char *buf,
 206                         int buf_size, void *data)
 207 {
 208     TiffEncoderContext *s = avctx->priv_data;
 209     AVFrame *pict = data;
 210     AVFrame *const p = (AVFrame *) & s->picture;
 211     int i;
 212     int n;
 213     uint8_t *ptr = buf;
 214     uint8_t *offset;
 215     uint32_t strips;
 216     uint32_t *strip_sizes = NULL;
 217     uint32_t *strip_offsets = NULL;
 218     int bytes_per_row;
 219     uint32_t res[2] = { s->dpi, 1 };        // image resolution (72/1)
 220     uint16_t bpp_tab[] = { 8, 8, 8, 8 };
 221     int ret = -1;
 222     int is_yuv = 0;
 223     uint8_t *yuv_line = NULL;
 224     int shift_h, shift_v;
 225
 226     s->avctx = avctx;
 227     s->buf_start = buf;
 228     s->buf = &ptr;
 229     s->buf_size = buf_size;
 230
 231     *p = *pict;
 232     p->pict_type = AV_PICTURE_TYPE_I;
 233     p->key_frame = 1;
 234     avctx->coded_frame= &s->picture;
 235
 236 #if FF_API_TIFFENC_COMPLEVEL
 237     if (avctx->compression_level != FF_COMPRESSION_DEFAULT)
 238         av_log(avctx, AV_LOG_WARNING, "Using compression_level to set compression "
 239                "algorithm is deprecated. Please use the compression_algo private "
 240                "option instead.\n");
 241     if (avctx->compression_level == 0) {
 242         s->compr = TIFF_RAW;
 243     } else if(avctx->compression_level == 2) {
 244         s->compr = TIFF_LZW;
 245 #if CONFIG_ZLIB
 246     } else if ((avctx->compression_level >= 3)) {
 247         s->compr = TIFF_DEFLATE;
 248 #endif
 249     }
 250 #endif
 251
 252     s->width = avctx->width;
 253     s->height = avctx->height;
 254     s->subsampling[0] = 1;
 255     s->subsampling[1] = 1;
 256
 257     switch (avctx->pix_fmt) {
 258     case PIX_FMT_RGB48LE:
 259         s->bpp = 48;
 260         s->photometric_interpretation = 2;
 261         bpp_tab[0] = 16;
 262         bpp_tab[1] = 16;
 263         bpp_tab[2] = 16;
 264         bpp_tab[3] = 16;
 265         break;
 266     case PIX_FMT_RGBA:
 267         s->bpp = 32;
 268         s->photometric_interpretation = 2;
 269         break;
 270     case PIX_FMT_RGB24:
 271         s->bpp = 24;
 272         s->photometric_interpretation = 2;
 273         break;
 274     case PIX_FMT_GRAY8:
 275         s->bpp = 8;
 276         s->photometric_interpretation = 1;
 277         break;
 278     case PIX_FMT_PAL8:
 279         s->bpp = 8;
 280         s->photometric_interpretation = 3;
 281         break;
 282     case PIX_FMT_MONOBLACK:
 283     case PIX_FMT_MONOWHITE:
 284         s->bpp = 1;
 285         s->photometric_interpretation = avctx->pix_fmt == PIX_FMT_MONOBLACK;
 286         bpp_tab[0] = 1;
 287         break;
 288     case PIX_FMT_YUV420P:
 289     case PIX_FMT_YUV422P:
 290     case PIX_FMT_YUV444P:
 291     case PIX_FMT_YUV410P:
 292     case PIX_FMT_YUV411P:
 293         s->photometric_interpretation = 6;
 294         avcodec_get_chroma_sub_sample(avctx->pix_fmt,
 295                 &shift_h, &shift_v);
 296         s->bpp = 8 + (16 >> (shift_h + shift_v));
 297         s->subsampling[0] = 1 << shift_h;
 298         s->subsampling[1] = 1 << shift_v;
 299         s->bpp_tab_size = 3;
 300         is_yuv = 1;
 301         break;
 302     default:
 303         av_log(s->avctx, AV_LOG_ERROR,
 304                "This colors format is not supported\n");
 305         return -1;
 306     }
 307     if (!is_yuv)
 308         s->bpp_tab_size = (s->bpp >= 48) ? ((s->bpp + 7) >> 4):((s->bpp + 7) >> 3);
 309
 310     if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE || s->compr == TIFF_LZW)
 311         //best choose for DEFLATE
 312         s->rps = s->height;
 313     else
 314         s->rps = FFMAX(8192 / (((s->width * s->bpp) >> 3) + 1), 1);     // suggest size of strip
 315     s->rps = ((s->rps - 1) / s->subsampling[1] + 1) * s->subsampling[1]; // round rps up
 316
 317     strips = (s->height - 1) / s->rps + 1;
 318
 319     if (check_size(s, 8))
 320         goto fail;
 321
 322     // write header
 323     bytestream_put_le16(&ptr, 0x4949);
 324     bytestream_put_le16(&ptr, 42);
 325
 326     offset = ptr;
 327     bytestream_put_le32(&ptr, 0);
 328
 329     strip_sizes = av_mallocz(sizeof(*strip_sizes) * strips);
 330     strip_offsets = av_mallocz(sizeof(*strip_offsets) * strips);
 331
 332     bytes_per_row = (((s->width - 1)/s->subsampling[0] + 1) * s->bpp
 333                     * s->subsampling[0] * s->subsampling[1] + 7) >> 3;
 334     if (is_yuv){
 335         yuv_line = av_malloc(bytes_per_row);
 336         if (yuv_line == NULL){
 337             av_log(s->avctx, AV_LOG_ERROR, "Not enough memory\n");
 338             goto fail;
 339         }
 340     }
 341
 342 #if CONFIG_ZLIB
 343     if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
 344         uint8_t *zbuf;
 345         int zlen, zn;
 346         int j;
 347
 348         zlen = bytes_per_row * s->rps;
 349         zbuf = av_malloc(zlen);
 350         strip_offsets[0] = ptr - buf;
 351         zn = 0;
 352         for (j = 0; j < s->rps; j++) {
 353             if (is_yuv){
 354                 pack_yuv(s, yuv_line, j);
 355                 memcpy(zbuf + zn, yuv_line, bytes_per_row);
 356                 j += s->subsampling[1] - 1;
 357             }
 358             else
 359                 memcpy(zbuf + j * bytes_per_row,
 360                        p->data[0] + j * p->linesize[0], bytes_per_row);
 361             zn += bytes_per_row;
 362         }
 363         n = encode_strip(s, zbuf, ptr, zn, s->compr);
 364         av_free(zbuf);
 365         if (n<0) {
 366             av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
 367             goto fail;
 368         }
 369         ptr += n;
 370         strip_sizes[0] = ptr - buf - strip_offsets[0];
 371     } else
 372 #endif
 373     {
 374         if(s->compr == TIFF_LZW)
 375             s->lzws = av_malloc(ff_lzw_encode_state_size);
 376         for (i = 0; i < s->height; i++) {
 377             if (strip_sizes[i / s->rps] == 0) {
 378                 if(s->compr == TIFF_LZW){
 379                     ff_lzw_encode_init(s->lzws, ptr, s->buf_size - (*s->buf - s->buf_start),
 380                                        12, FF_LZW_TIFF, put_bits);
 381                 }
 382                 strip_offsets[i / s->rps] = ptr - buf;
 383             }
 384             if (is_yuv){
 385                  pack_yuv(s, yuv_line, i);
 386                  n = encode_strip(s, yuv_line, ptr, bytes_per_row, s->compr);
 387                  i += s->subsampling[1] - 1;
 388             }
 389             else
 390                 n = encode_strip(s, p->data[0] + i * p->linesize[0],
 391                         ptr, bytes_per_row, s->compr);
 392             if (n < 0) {
 393                 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
 394                 goto fail;
 395             }
 396             strip_sizes[i / s->rps] += n;
 397             ptr += n;
 398             if(s->compr == TIFF_LZW && (i==s->height-1 || i%s->rps == s->rps-1)){
 399                 int ret;
 400                 ret = ff_lzw_encode_flush(s->lzws, flush_put_bits);
 401                 strip_sizes[(i / s->rps )] += ret ;
 402                 ptr += ret;
 403             }
 404         }
 405         if(s->compr == TIFF_LZW)
 406             av_free(s->lzws);
 407     }
 408
 409     s->num_entries = 0;
 410
 411     add_entry1(s,TIFF_SUBFILE,           TIFF_LONG,             0);
 412     add_entry1(s,TIFF_WIDTH,             TIFF_LONG,             s->width);
 413     add_entry1(s,TIFF_HEIGHT,            TIFF_LONG,             s->height);
 414
 415     if (s->bpp_tab_size)
 416     add_entry(s, TIFF_BPP,               TIFF_SHORT,    s->bpp_tab_size, bpp_tab);
 417
 418     add_entry1(s,TIFF_COMPR,             TIFF_SHORT,            s->compr);
 419     add_entry1(s,TIFF_INVERT,            TIFF_SHORT,            s->photometric_interpretation);
 420     add_entry(s, TIFF_STRIP_OFFS,        TIFF_LONG,     strips, strip_offsets);
 421
 422     if (s->bpp_tab_size)
 423     add_entry1(s,TIFF_SAMPLES_PER_PIXEL, TIFF_SHORT,            s->bpp_tab_size);
 424
 425     add_entry1(s,TIFF_ROWSPERSTRIP,      TIFF_LONG,             s->rps);
 426     add_entry(s, TIFF_STRIP_SIZE,        TIFF_LONG,     strips, strip_sizes);
 427     add_entry(s, TIFF_XRES,              TIFF_RATIONAL, 1,      res);
 428     add_entry(s, TIFF_YRES,              TIFF_RATIONAL, 1,      res);
 429     add_entry1(s,TIFF_RES_UNIT,          TIFF_SHORT,            2);
 430
 431     if(!(avctx->flags & CODEC_FLAG_BITEXACT))
 432     add_entry(s, TIFF_SOFTWARE_NAME,     TIFF_STRING,
 433               strlen(LIBAVCODEC_IDENT) + 1, LIBAVCODEC_IDENT);
 434
 435     if (avctx->pix_fmt == PIX_FMT_PAL8) {
 436         uint16_t pal[256 * 3];
 437         for (i = 0; i < 256; i++) {
 438             uint32_t rgb = *(uint32_t *) (p->data[1] + i * 4);
 439             pal[i]       = ((rgb >> 16) & 0xff) * 257;
 440             pal[i + 256] = ((rgb >> 8 ) & 0xff) * 257;
 441             pal[i + 512] = ( rgb        & 0xff) * 257;
 442         }
 443         add_entry(s, TIFF_PAL, TIFF_SHORT, 256 * 3, pal);
 444     }
 445     if (is_yuv){
 446         /** according to CCIR Recommendation 601.1 */
 447         uint32_t refbw[12] = {15, 1, 235, 1, 128, 1, 240, 1, 128, 1, 240, 1};
 448         add_entry(s, TIFF_YCBCR_SUBSAMPLING, TIFF_SHORT,    2, s->subsampling);
 449         add_entry(s, TIFF_REFERENCE_BW,      TIFF_RATIONAL, 6, refbw);
 450     }
 451     bytestream_put_le32(&offset, ptr - buf);    // write offset to dir
 452
 453     if (check_size(s, 6 + s->num_entries * 12))
 454         goto fail;
 455     bytestream_put_le16(&ptr, s->num_entries);  // write tag count
 456     bytestream_put_buffer(&ptr, s->entries, s->num_entries * 12);
 457     bytestream_put_le32(&ptr, 0);
 458
 459     ret = ptr - buf;
 460
 461 fail:
 462     av_free(strip_sizes);
 463     av_free(strip_offsets);
 464     av_free(yuv_line);
 465     return ret;
 466 }
 467
 468 #define OFFSET(x) offsetof(TiffEncoderContext, x)
 469 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
 470 static const AVOption options[] = {
 471     {"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},
 472     { "compression_algo", NULL, OFFSET(compr), AV_OPT_TYPE_INT, {TIFF_PACKBITS}, TIFF_RAW, TIFF_DEFLATE, VE, "compression_algo" },
 473     { "packbits", NULL, 0, AV_OPT_TYPE_CONST, {TIFF_PACKBITS}, 0, 0, VE, "compression_algo" },
 474     { "raw",      NULL, 0, AV_OPT_TYPE_CONST, {TIFF_RAW},      0, 0, VE, "compression_algo" },
 475     { "lzw",      NULL, 0, AV_OPT_TYPE_CONST, {TIFF_LZW},      0, 0, VE, "compression_algo" },
 476 #if CONFIG_ZLIB
 477     { "deflate",  NULL, 0, AV_OPT_TYPE_CONST, {TIFF_DEFLATE},  0, 0, VE, "compression_algo" },
 478 #endif
 479     { NULL },
 480 };
 481
 482 static const AVClass tiffenc_class = {
 483     .class_name = "TIFF encoder",
 484     .item_name  = av_default_item_name,
 485     .option     = options,
 486     .version    = LIBAVUTIL_VERSION_INT,
 487 };
 488
 489 AVCodec ff_tiff_encoder = {
 490     .name           = "tiff",
 491     .type           = AVMEDIA_TYPE_VIDEO,
 492     .id             = CODEC_ID_TIFF,
 493     .priv_data_size = sizeof(TiffEncoderContext),
 494     .encode         = encode_frame,
 495     .pix_fmts =
 496         (const enum PixelFormat[]) {PIX_FMT_RGB24, PIX_FMT_PAL8, PIX_FMT_GRAY8,
 497                               PIX_FMT_MONOBLACK, PIX_FMT_MONOWHITE,
 498                               PIX_FMT_YUV420P, PIX_FMT_YUV422P,
 499                               PIX_FMT_YUV444P, PIX_FMT_YUV410P,
 500                               PIX_FMT_YUV411P, PIX_FMT_RGB48LE,
 501                               PIX_FMT_RGBA, PIX_FMT_NONE},
 502     .long_name = NULL_IF_CONFIG_SMALL("TIFF image"),
 503     .priv_class     = &tiffenc_class,
 504 };