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/imgutils.h"
  29 #include "libavutil/log.h"
  30 #include "libavutil/opt.h"
  31
  32 #include "avcodec.h"
  33 #include "internal.h"
  34 #if CONFIG_ZLIB
  35 #include <zlib.h>
  36 #endif
  37 #include "libavutil/opt.h"
  38 #include "bytestream.h"
  39 #include "tiff.h"
  40 #include "rle.h"
  41 #include "lzw.h"
  42 #include "put_bits.h"
  43
  44 #define TIFF_MAX_ENTRY 32
  45
  46 /** sizes of various TIFF field types (string size = 1)*/
  47 static const uint8_t type_sizes2[6] = {
  48     0, 1, 1, 2, 4, 8
  49 };
  50
  51 typedef struct TiffEncoderContext {
  52     AVClass *class;                     ///< for private options
  53     AVCodecContext *avctx;
  54     AVFrame picture;
  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     int photometric_interpretation;     ///< photometric interpretation
  62     int strips;                         ///< number of strips
  63     int rps;                            ///< row per strip
  64     uint8_t entries[TIFF_MAX_ENTRY*12]; ///< entires in header
  65     int num_entries;                    ///< number of entires
  66     uint8_t **buf;                      ///< actual position in buffer
  67     uint8_t *buf_start;                 ///< pointer to first byte in buffer
  68     int buf_size;                       ///< buffer size
  69     uint16_t subsampling[2];            ///< YUV subsampling factors
  70     struct LZWEncodeState *lzws;        ///< LZW Encode state
  71     uint32_t dpi;                       ///< image resolution in DPI
  72 } TiffEncoderContext;
  73
  74
  75 /**
  76  * Check free space in buffer
  77  * @param s Tiff context
  78  * @param need Needed bytes
  79  * @return 0 - ok, 1 - no free space
  80  */
  81 static inline int check_size(TiffEncoderContext * s, uint64_t need)
  82 {
  83     if (s->buf_size < *s->buf - s->buf_start + need) {
  84         *s->buf = s->buf_start + s->buf_size + 1;
  85         av_log(s->avctx, AV_LOG_ERROR, "Buffer is too small\n");
  86         return 1;
  87     }
  88     return 0;
  89 }
  90
  91 /**
  92  * Put n values to buffer
  93  *
  94  * @param p Pointer to pointer to output buffer
  95  * @param n Number of values
  96  * @param val Pointer to values
  97  * @param type Type of values
  98  * @param flip =0 - normal copy, >0 - flip
  99  */
 100 static void tnput(uint8_t ** p, int n, const uint8_t * val, enum TiffTypes type,
 101                   int flip)
 102 {
 103     int i;
 104 #if HAVE_BIGENDIAN
 105     flip ^= ((int[]) {0, 0, 0, 1, 3, 3})[type];
 106 #endif
 107     for (i = 0; i < n * type_sizes2[type]; i++)
 108         *(*p)++ = val[i ^ flip];
 109 }
 110
 111 /**
 112  * Add entry to directory in tiff header.
 113  * @param s Tiff context
 114  * @param tag Tag that identifies the entry
 115  * @param type Entry type
 116  * @param count The number of values
 117  * @param ptr_val Pointer to values
 118  */
 119 static void add_entry(TiffEncoderContext * s,
 120                       enum TiffTags tag, enum TiffTypes type, int count,
 121                       const void *ptr_val)
 122 {
 123     uint8_t *entries_ptr = s->entries + 12 * s->num_entries;
 124
 125     av_assert0(s->num_entries < TIFF_MAX_ENTRY);
 126
 127     bytestream_put_le16(&entries_ptr, tag);
 128     bytestream_put_le16(&entries_ptr, type);
 129     bytestream_put_le32(&entries_ptr, count);
 130
 131     if (type_sizes[type] * count <= 4) {
 132         tnput(&entries_ptr, count, ptr_val, type, 0);
 133     } else {
 134         bytestream_put_le32(&entries_ptr, *s->buf - s->buf_start);
 135         check_size(s, count * type_sizes2[type]);
 136         tnput(s->buf, count, ptr_val, type, 0);
 137     }
 138
 139     s->num_entries++;
 140 }
 141
 142 static void add_entry1(TiffEncoderContext * s,
 143                        enum TiffTags tag, enum TiffTypes type, int val){
 144     uint16_t w = val;
 145     uint32_t dw= val;
 146     add_entry(s, tag, type, 1, type == TIFF_SHORT ? (void *)&w : (void *)&dw);
 147 }
 148
 149 /**
 150  * Encode one strip in tiff file
 151  *
 152  * @param s Tiff context
 153  * @param src Input buffer
 154  * @param dst Output buffer
 155  * @param n Size of input buffer
 156  * @param compr Compression method
 157  * @return Number of output bytes. If an output error is encountered, -1 returned
 158  */
 159 static int encode_strip(TiffEncoderContext * s, const int8_t * src,
 160                         uint8_t * dst, int n, int compr)
 161 {
 162
 163     switch (compr) {
 164 #if CONFIG_ZLIB
 165     case TIFF_DEFLATE:
 166     case TIFF_ADOBE_DEFLATE:
 167         {
 168             unsigned long zlen = s->buf_size - (*s->buf - s->buf_start);
 169             if (compress(dst, &zlen, src, n) != Z_OK) {
 170                 av_log(s->avctx, AV_LOG_ERROR, "Compressing failed\n");
 171                 return -1;
 172             }
 173             return zlen;
 174         }
 175 #endif
 176     case TIFF_RAW:
 177         if (check_size(s, n))
 178             return -1;
 179         memcpy(dst, src, n);
 180         return n;
 181     case TIFF_PACKBITS:
 182         return ff_rle_encode(dst, s->buf_size - (*s->buf - s->buf_start), src, 1, n, 2, 0xff, -1, 0);
 183     case TIFF_LZW:
 184         return ff_lzw_encode(s->lzws, src, n);
 185     default:
 186         return -1;
 187     }
 188 }
 189
 190 static void pack_yuv(TiffEncoderContext * s, uint8_t * dst, int lnum)
 191 {
 192     AVFrame *p = &s->picture;
 193     int i, j, k;
 194     int w = (s->width - 1) / s->subsampling[0] + 1;
 195     uint8_t *pu = &p->data[1][lnum / s->subsampling[1] * p->linesize[1]];
 196     uint8_t *pv = &p->data[2][lnum / s->subsampling[1] * p->linesize[2]];
 197     if(s->width % s->subsampling[0] || s->height % s->subsampling[1]){
 198         for (i = 0; i < w; i++){
 199             for (j = 0; j < s->subsampling[1]; j++)
 200                 for (k = 0; k < s->subsampling[0]; k++)
 201                     *dst++ = p->data[0][FFMIN(lnum + j, s->height-1) * p->linesize[0] +
 202                                         FFMIN(i * s->subsampling[0] + k, s->width-1)];
 203             *dst++ = *pu++;
 204             *dst++ = *pv++;
 205         }
 206     }else{
 207         for (i = 0; i < w; i++){
 208             for (j = 0; j < s->subsampling[1]; j++)
 209                 for (k = 0; k < s->subsampling[0]; k++)
 210                     *dst++ = p->data[0][(lnum + j) * p->linesize[0] +
 211                                         i * s->subsampling[0] + k];
 212             *dst++ = *pu++;
 213             *dst++ = *pv++;
 214         }
 215     }
 216 }
 217
 218 static av_cold int encode_init(AVCodecContext *avctx)
 219 {
 220     TiffEncoderContext *s = avctx->priv_data;
 221
 222     avctx->coded_frame= &s->picture;
 223     avctx->coded_frame->pict_type = AV_PICTURE_TYPE_I;
 224     avctx->coded_frame->key_frame = 1;
 225     s->avctx = avctx;
 226
 227     return 0;
 228 }
 229
 230 static int encode_frame(AVCodecContext * avctx, AVPacket *pkt,
 231                         const AVFrame *pict, int *got_packet)
 232 {
 233     TiffEncoderContext *s = avctx->priv_data;
 234     AVFrame *const p = &s->picture;
 235     int i;
 236     uint8_t *ptr;
 237     uint8_t *offset;
 238     uint32_t strips;
 239     uint32_t *strip_sizes = NULL;
 240     uint32_t *strip_offsets = NULL;
 241     int bytes_per_row;
 242     uint32_t res[2] = { s->dpi, 1 };        // image resolution (72/1)
 243     uint16_t bpp_tab[4];
 244     int ret = -1;
 245     int is_yuv = 0;
 246     uint8_t *yuv_line = NULL;
 247     int shift_h, shift_v;
 248
 249     *p = *pict;
 250
 251     s->width = avctx->width;
 252     s->height = avctx->height;
 253     s->subsampling[0] = 1;
 254     s->subsampling[1] = 1;
 255
 256     avctx->bits_per_coded_sample =
 257     s->bpp = av_get_bits_per_pixel(&av_pix_fmt_descriptors[avctx->pix_fmt]);
 258
 259     switch (avctx->pix_fmt) {
 260     case PIX_FMT_RGBA64LE:
 261     case PIX_FMT_RGB48LE:
 262     case PIX_FMT_RGBA:
 263     case PIX_FMT_RGB24:
 264         s->photometric_interpretation = 2;
 265         break;
 266     case PIX_FMT_GRAY8:
 267         avctx->bits_per_coded_sample = 0x28;
 268     case PIX_FMT_GRAY8A:
 269     case PIX_FMT_GRAY16LE:
 270         s->photometric_interpretation = 1;
 271         break;
 272     case PIX_FMT_PAL8:
 273         s->photometric_interpretation = 3;
 274         break;
 275     case PIX_FMT_MONOBLACK:
 276     case PIX_FMT_MONOWHITE:
 277         s->photometric_interpretation = avctx->pix_fmt == PIX_FMT_MONOBLACK;
 278         break;
 279     case PIX_FMT_YUV420P:
 280     case PIX_FMT_YUV422P:
 281     case PIX_FMT_YUV440P:
 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,
 287                 &shift_h, &shift_v);
 288         s->subsampling[0] = 1 << shift_h;
 289         s->subsampling[1] = 1 << shift_v;
 290         is_yuv = 1;
 291         break;
 292     default:
 293         av_log(s->avctx, AV_LOG_ERROR,
 294                "This colors format is not supported\n");
 295         return -1;
 296     }
 297
 298     s->bpp_tab_size = av_pix_fmt_descriptors[avctx->pix_fmt].nb_components;
 299     for (i = 0; i < s->bpp_tab_size; i++)
 300         bpp_tab[i] = av_pix_fmt_descriptors[avctx->pix_fmt].comp[i].depth_minus1 + 1;
 301
 302     if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE || s->compr == TIFF_LZW)
 303         //best choose for DEFLATE
 304         s->rps = s->height;
 305     else
 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
 308
 309     strips = (s->height - 1) / s->rps + 1;
 310
 311     if ((ret = ff_alloc_packet2(avctx, pkt, avctx->width * avctx->height * s->bpp * 2 +
 312                                   avctx->height * 4 + FF_MIN_BUFFER_SIZE)) < 0)
 313         return ret;
 314     ptr          = pkt->data;
 315     s->buf_start = pkt->data;
 316     s->buf       = &ptr;
 317     s->buf_size  = pkt->size;
 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 - pkt->data;
 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         ret = encode_strip(s, zbuf, ptr, zn, s->compr);
 364         av_free(zbuf);
 365         if (ret < 0) {
 366             av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
 367             goto fail;
 368         }
 369         ptr += ret;
 370         strip_sizes[0] = ptr - pkt->data - 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 - pkt->data;
 383             }
 384             if (is_yuv){
 385                  pack_yuv(s, yuv_line, i);
 386                  ret = encode_strip(s, yuv_line, ptr, bytes_per_row, s->compr);
 387                  i += s->subsampling[1] - 1;
 388             }
 389             else
 390                 ret = encode_strip(s, p->data[0] + i * p->linesize[0],
 391                         ptr, bytes_per_row, s->compr);
 392             if (ret < 0) {
 393                 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
 394                 goto fail;
 395             }
 396             strip_sizes[i / s->rps] += ret;
 397             ptr += ret;
 398             if(s->compr == TIFF_LZW && (i==s->height-1 || i%s->rps == s->rps-1)){
 399                 ret = ff_lzw_encode_flush(s->lzws, flush_put_bits);
 400                 strip_sizes[(i / s->rps )] += ret ;
 401                 ptr += ret;
 402             }
 403         }
 404         if(s->compr == TIFF_LZW)
 405             av_free(s->lzws);
 406     }
 407
 408     s->num_entries = 0;
 409
 410     add_entry1(s,TIFF_SUBFILE,           TIFF_LONG,             0);
 411     add_entry1(s,TIFF_WIDTH,             TIFF_LONG,             s->width);
 412     add_entry1(s,TIFF_HEIGHT,            TIFF_LONG,             s->height);
 413
 414     if (s->bpp_tab_size)
 415     add_entry(s, TIFF_BPP,               TIFF_SHORT,    s->bpp_tab_size, bpp_tab);
 416
 417     add_entry1(s,TIFF_COMPR,             TIFF_SHORT,            s->compr);
 418     add_entry1(s,TIFF_INVERT,            TIFF_SHORT,            s->photometric_interpretation);
 419     add_entry(s, TIFF_STRIP_OFFS,        TIFF_LONG,     strips, strip_offsets);
 420
 421     if (s->bpp_tab_size)
 422     add_entry1(s,TIFF_SAMPLES_PER_PIXEL, TIFF_SHORT,            s->bpp_tab_size);
 423
 424     add_entry1(s,TIFF_ROWSPERSTRIP,      TIFF_LONG,             s->rps);
 425     add_entry(s, TIFF_STRIP_SIZE,        TIFF_LONG,     strips, strip_sizes);
 426     add_entry(s, TIFF_XRES,              TIFF_RATIONAL, 1,      res);
 427     add_entry(s, TIFF_YRES,              TIFF_RATIONAL, 1,      res);
 428     add_entry1(s,TIFF_RES_UNIT,          TIFF_SHORT,            2);
 429
 430     if(!(avctx->flags & CODEC_FLAG_BITEXACT))
 431     add_entry(s, TIFF_SOFTWARE_NAME,     TIFF_STRING,
 432               strlen(LIBAVCODEC_IDENT) + 1, LIBAVCODEC_IDENT);
 433
 434     if (avctx->pix_fmt == PIX_FMT_PAL8) {
 435         uint16_t pal[256 * 3];
 436         for (i = 0; i < 256; i++) {
 437             uint32_t rgb = *(uint32_t *) (p->data[1] + i * 4);
 438             pal[i]       = ((rgb >> 16) & 0xff) * 257;
 439             pal[i + 256] = ((rgb >> 8 ) & 0xff) * 257;
 440             pal[i + 512] = ( rgb        & 0xff) * 257;
 441         }
 442         add_entry(s, TIFF_PAL, TIFF_SHORT, 256 * 3, pal);
 443     }
 444     if (is_yuv){
 445         /** according to CCIR Recommendation 601.1 */
 446         uint32_t refbw[12] = {15, 1, 235, 1, 128, 1, 240, 1, 128, 1, 240, 1};
 447         add_entry(s, TIFF_YCBCR_SUBSAMPLING, TIFF_SHORT,    2, s->subsampling);
 448         add_entry(s, TIFF_REFERENCE_BW,      TIFF_RATIONAL, 6, refbw);
 449     }
 450     bytestream_put_le32(&offset, ptr - pkt->data);    // write offset to dir
 451
 452     if (check_size(s, 6 + s->num_entries * 12)) {
 453         ret = AVERROR(EINVAL);
 454         goto fail;
 455     }
 456     bytestream_put_le16(&ptr, s->num_entries);  // write tag count
 457     bytestream_put_buffer(&ptr, s->entries, s->num_entries * 12);
 458     bytestream_put_le32(&ptr, 0);
 459
 460     pkt->size   = ptr - pkt->data;
 461     pkt->flags |= AV_PKT_FLAG_KEY;
 462     *got_packet = 1;
 463
 464 fail:
 465     av_free(strip_sizes);
 466     av_free(strip_offsets);
 467     av_free(yuv_line);
 468     return ret < 0 ? ret : 0;
 469 }
 470
 471 #define OFFSET(x) offsetof(TiffEncoderContext, x)
 472 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
 473 static const AVOption options[] = {
 474     {"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},
 475     { "compression_algo", NULL, OFFSET(compr), AV_OPT_TYPE_INT, {TIFF_PACKBITS}, TIFF_RAW, TIFF_DEFLATE, VE, "compression_algo" },
 476     { "packbits", NULL, 0, AV_OPT_TYPE_CONST, {TIFF_PACKBITS}, 0, 0, VE, "compression_algo" },
 477     { "raw",      NULL, 0, AV_OPT_TYPE_CONST, {TIFF_RAW},      0, 0, VE, "compression_algo" },
 478     { "lzw",      NULL, 0, AV_OPT_TYPE_CONST, {TIFF_LZW},      0, 0, VE, "compression_algo" },
 479 #if CONFIG_ZLIB
 480     { "deflate",  NULL, 0, AV_OPT_TYPE_CONST, {TIFF_DEFLATE},  0, 0, VE, "compression_algo" },
 481 #endif
 482     { NULL },
 483 };
 484
 485 static const AVClass tiffenc_class = {
 486     .class_name = "TIFF encoder",
 487     .item_name  = av_default_item_name,
 488     .option     = options,
 489     .version    = LIBAVUTIL_VERSION_INT,
 490 };
 491
 492 AVCodec ff_tiff_encoder = {
 493     .name           = "tiff",
 494     .type           = AVMEDIA_TYPE_VIDEO,
 495     .id             = CODEC_ID_TIFF,
 496     .priv_data_size = sizeof(TiffEncoderContext),
 497     .init           = encode_init,
 498     .encode2        = encode_frame,
 499     .pix_fmts       = (const enum PixelFormat[]) {
 500         PIX_FMT_RGB24, PIX_FMT_PAL8, PIX_FMT_GRAY8, PIX_FMT_GRAY8A, PIX_FMT_GRAY16LE,
 501         PIX_FMT_MONOBLACK, PIX_FMT_MONOWHITE,
 502         PIX_FMT_YUV420P, PIX_FMT_YUV422P, PIX_FMT_YUV440P, PIX_FMT_YUV444P,
 503         PIX_FMT_YUV410P, PIX_FMT_YUV411P, PIX_FMT_RGB48LE,
 504         PIX_FMT_RGBA, PIX_FMT_RGBA64LE,
 505         PIX_FMT_NONE
 506     },
 507     .long_name      = NULL_IF_CONFIG_SMALL("TIFF image"),
 508     .priv_class     = &tiffenc_class,
 509 };