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 Libav.
   6  *
   7  * Libav 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  * Libav 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 Libav; 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 #include "libavutil/pixdesc.h"
  31
  32 #include "avcodec.h"
  33 #include "config.h"
  34 #if CONFIG_ZLIB
  35 #include <zlib.h>
  36 #endif
  37 #include "bytestream.h"
  38 #include "tiff.h"
  39 #include "rle.h"
  40 #include "lzw.h"
  41 #include "put_bits.h"
  42
  43 #define TIFF_MAX_ENTRY 32
  44
  45 /** sizes of various TIFF field types (string size = 1)*/
  46 static const uint8_t type_sizes2[6] = {
  47     0, 1, 1, 2, 4, 8
  48 };
  49
  50 typedef struct TiffEncoderContext {
  51     AVClass *class;                     ///< for private options
  52     AVCodecContext *avctx;
  53     AVFrame picture;
  54
  55     int width;                          ///< picture width
  56     int height;                         ///< picture height
  57     unsigned int bpp;                   ///< bits per pixel
  58     int compr;                          ///< compression level
  59     int bpp_tab_size;                   ///< bpp_tab size
  60     int photometric_interpretation;     ///< photometric interpretation
  61     int strips;                         ///< number of strips
  62     int rps;                            ///< row per strip
  63     uint8_t entries[TIFF_MAX_ENTRY*12]; ///< entires in header
  64     int num_entries;                    ///< number of entires
  65     uint8_t **buf;                      ///< actual position in buffer
  66     uint8_t *buf_start;                 ///< pointer to first byte in buffer
  67     int buf_size;                       ///< buffer size
  68     uint16_t subsampling[2];            ///< YUV subsampling factors
  69     struct LZWEncodeState *lzws;        ///< LZW Encode state
  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 static inline 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, AVPacket *pkt,
 206                         const AVFrame *pict, int *got_packet)
 207 {
 208     TiffEncoderContext *s = avctx->priv_data;
 209     AVFrame *const p = &s->picture;
 210     int i;
 211     uint8_t *ptr;
 212     uint8_t *offset;
 213     uint32_t strips;
 214     uint32_t *strip_sizes = NULL;
 215     uint32_t *strip_offsets = NULL;
 216     int bytes_per_row;
 217     uint32_t res[2] = { 72, 1 };        // image resolution (72/1)
 218     uint16_t bpp_tab[] = { 8, 8, 8, 8 };
 219     int ret;
 220     int is_yuv = 0;
 221     uint8_t *yuv_line = NULL;
 222     int shift_h, shift_v;
 223     const AVPixFmtDescriptor* pfd;
 224
 225     s->avctx = avctx;
 226
 227     *p = *pict;
 228     p->pict_type = AV_PICTURE_TYPE_I;
 229     p->key_frame = 1;
 230     avctx->coded_frame= &s->picture;
 231
 232     s->width = avctx->width;
 233     s->height = avctx->height;
 234     s->subsampling[0] = 1;
 235     s->subsampling[1] = 1;
 236
 237     switch (avctx->pix_fmt) {
 238     case AV_PIX_FMT_RGB48LE:
 239     case AV_PIX_FMT_GRAY16LE:
 240     case AV_PIX_FMT_RGB24:
 241     case AV_PIX_FMT_GRAY8:
 242     case AV_PIX_FMT_PAL8:
 243         pfd = av_pix_fmt_desc_get(avctx->pix_fmt);
 244         s->bpp = av_get_bits_per_pixel(pfd);
 245         if (pfd->flags & PIX_FMT_PAL) {
 246             s->photometric_interpretation = 3;
 247         } else if (pfd->flags & PIX_FMT_RGB) {
 248             s->photometric_interpretation = 2;
 249         } else {
 250             s->photometric_interpretation = 1;
 251         }
 252         s->bpp_tab_size = pfd->nb_components;
 253         for (i = 0; i < s->bpp_tab_size; i++) {
 254             bpp_tab[i] = s->bpp / s->bpp_tab_size;
 255         }
 256         break;
 257     case AV_PIX_FMT_MONOBLACK:
 258         s->bpp = 1;
 259         s->photometric_interpretation = 1;
 260         s->bpp_tab_size = 0;
 261         break;
 262     case AV_PIX_FMT_MONOWHITE:
 263         s->bpp = 1;
 264         s->photometric_interpretation = 0;
 265         s->bpp_tab_size = 0;
 266         break;
 267     case AV_PIX_FMT_YUV420P:
 268     case AV_PIX_FMT_YUV422P:
 269     case AV_PIX_FMT_YUV444P:
 270     case AV_PIX_FMT_YUV410P:
 271     case AV_PIX_FMT_YUV411P:
 272         s->photometric_interpretation = 6;
 273         av_pix_fmt_get_chroma_sub_sample(avctx->pix_fmt,
 274                                          &shift_h, &shift_v);
 275         s->bpp = 8 + (16 >> (shift_h + shift_v));
 276         s->subsampling[0] = 1 << shift_h;
 277         s->subsampling[1] = 1 << shift_v;
 278         s->bpp_tab_size = 3;
 279         is_yuv = 1;
 280         break;
 281     default:
 282         av_log(s->avctx, AV_LOG_ERROR,
 283                "This colors format is not supported\n");
 284         return -1;
 285     }
 286
 287     if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE || s->compr == TIFF_LZW)
 288         //best choose for DEFLATE
 289         s->rps = s->height;
 290     else
 291         s->rps = FFMAX(8192 / (((s->width * s->bpp) >> 3) + 1), 1);     // suggest size of strip
 292     s->rps = ((s->rps - 1) / s->subsampling[1] + 1) * s->subsampling[1]; // round rps up
 293
 294     strips = (s->height - 1) / s->rps + 1;
 295
 296     if (!pkt->data &&
 297         (ret = av_new_packet(pkt, avctx->width * avctx->height * s->bpp * 2 +
 298                                   avctx->height * 4 + FF_MIN_BUFFER_SIZE)) < 0) {
 299         av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
 300         return ret;
 301     }
 302     ptr          = pkt->data;
 303     s->buf_start = pkt->data;
 304     s->buf       = &ptr;
 305     s->buf_size  = pkt->size;
 306
 307     if (check_size(s, 8))
 308         goto fail;
 309
 310     // write header
 311     bytestream_put_le16(&ptr, 0x4949);
 312     bytestream_put_le16(&ptr, 42);
 313
 314     offset = ptr;
 315     bytestream_put_le32(&ptr, 0);
 316
 317     strip_sizes = av_mallocz(sizeof(*strip_sizes) * strips);
 318     strip_offsets = av_mallocz(sizeof(*strip_offsets) * strips);
 319     if (!strip_sizes || !strip_offsets) {
 320         ret = AVERROR(ENOMEM);
 321         goto fail;
 322     }
 323
 324     bytes_per_row = (((s->width - 1)/s->subsampling[0] + 1) * s->bpp
 325                     * s->subsampling[0] * s->subsampling[1] + 7) >> 3;
 326     if (is_yuv){
 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");
 330             ret = AVERROR(ENOMEM);
 331             goto fail;
 332         }
 333     }
 334
 335 #if CONFIG_ZLIB
 336     if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
 337         uint8_t *zbuf;
 338         int zlen, zn;
 339         int j;
 340
 341         zlen = bytes_per_row * s->rps;
 342         zbuf = av_malloc(zlen);
 343         if (!zbuf) {
 344             ret = AVERROR(ENOMEM);
 345             goto fail;
 346         }
 347         strip_offsets[0] = ptr - pkt->data;
 348         zn = 0;
 349         for (j = 0; j < s->rps; j++) {
 350             if (is_yuv){
 351                 pack_yuv(s, yuv_line, j);
 352                 memcpy(zbuf + zn, yuv_line, bytes_per_row);
 353                 j += s->subsampling[1] - 1;
 354             }
 355             else
 356                 memcpy(zbuf + j * bytes_per_row,
 357                        p->data[0] + j * p->linesize[0], bytes_per_row);
 358             zn += bytes_per_row;
 359         }
 360         ret = encode_strip(s, zbuf, ptr, zn, s->compr);
 361         av_free(zbuf);
 362         if (ret < 0) {
 363             av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
 364             goto fail;
 365         }
 366         ptr += ret;
 367         strip_sizes[0] = ptr - pkt->data - strip_offsets[0];
 368     } else
 369 #endif
 370     {
 371         if (s->compr == TIFF_LZW) {
 372             s->lzws = av_malloc(ff_lzw_encode_state_size);
 373             if (!s->lzws) {
 374                 ret = AVERROR(ENOMEM);
 375                 goto fail;
 376             }
 377         }
 378         for (i = 0; i < s->height; i++) {
 379             if (strip_sizes[i / s->rps] == 0) {
 380                 if(s->compr == TIFF_LZW){
 381                     ff_lzw_encode_init(s->lzws, ptr, s->buf_size - (*s->buf - s->buf_start),
 382                                        12, FF_LZW_TIFF, put_bits);
 383                 }
 384                 strip_offsets[i / s->rps] = ptr - pkt->data;
 385             }
 386             if (is_yuv){
 387                  pack_yuv(s, yuv_line, i);
 388                  ret = encode_strip(s, yuv_line, ptr, bytes_per_row, s->compr);
 389                  i += s->subsampling[1] - 1;
 390             }
 391             else
 392                 ret = encode_strip(s, p->data[0] + i * p->linesize[0],
 393                         ptr, bytes_per_row, s->compr);
 394             if (ret < 0) {
 395                 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
 396                 goto fail;
 397             }
 398             strip_sizes[i / s->rps] += ret;
 399             ptr += ret;
 400             if(s->compr == TIFF_LZW && (i==s->height-1 || i%s->rps == s->rps-1)){
 401                 ret = ff_lzw_encode_flush(s->lzws, flush_put_bits);
 402                 strip_sizes[(i / s->rps )] += ret ;
 403                 ptr += ret;
 404             }
 405         }
 406         if(s->compr == TIFF_LZW)
 407             av_free(s->lzws);
 408     }
 409
 410     s->num_entries = 0;
 411
 412     add_entry1(s,TIFF_SUBFILE,           TIFF_LONG,             0);
 413     add_entry1(s,TIFF_WIDTH,             TIFF_LONG,             s->width);
 414     add_entry1(s,TIFF_HEIGHT,            TIFF_LONG,             s->height);
 415
 416     if (s->bpp_tab_size)
 417     add_entry(s, TIFF_BPP,               TIFF_SHORT,    s->bpp_tab_size, bpp_tab);
 418
 419     add_entry1(s,TIFF_COMPR,             TIFF_SHORT,            s->compr);
 420     add_entry1(s,TIFF_INVERT,            TIFF_SHORT,            s->photometric_interpretation);
 421     add_entry(s, TIFF_STRIP_OFFS,        TIFF_LONG,     strips, strip_offsets);
 422
 423     if (s->bpp_tab_size)
 424     add_entry1(s,TIFF_SAMPLES_PER_PIXEL, TIFF_SHORT,            s->bpp_tab_size);
 425
 426     add_entry1(s,TIFF_ROWSPERSTRIP,      TIFF_LONG,             s->rps);
 427     add_entry(s, TIFF_STRIP_SIZE,        TIFF_LONG,     strips, strip_sizes);
 428     add_entry(s, TIFF_XRES,              TIFF_RATIONAL, 1,      res);
 429     add_entry(s, TIFF_YRES,              TIFF_RATIONAL, 1,      res);
 430     add_entry1(s,TIFF_RES_UNIT,          TIFF_SHORT,            2);
 431
 432     if(!(avctx->flags & CODEC_FLAG_BITEXACT))
 433     add_entry(s, TIFF_SOFTWARE_NAME,     TIFF_STRING,
 434               strlen(LIBAVCODEC_IDENT) + 1, LIBAVCODEC_IDENT);
 435
 436     if (avctx->pix_fmt == AV_PIX_FMT_PAL8) {
 437         uint16_t pal[256 * 3];
 438         for (i = 0; i < 256; i++) {
 439             uint32_t rgb = *(uint32_t *) (p->data[1] + i * 4);
 440             pal[i]       = ((rgb >> 16) & 0xff) * 257;
 441             pal[i + 256] = ((rgb >> 8 ) & 0xff) * 257;
 442             pal[i + 512] = ( rgb        & 0xff) * 257;
 443         }
 444         add_entry(s, TIFF_PAL, TIFF_SHORT, 256 * 3, pal);
 445     }
 446     if (is_yuv){
 447         /** according to CCIR Recommendation 601.1 */
 448         uint32_t refbw[12] = {15, 1, 235, 1, 128, 1, 240, 1, 128, 1, 240, 1};
 449         add_entry(s, TIFF_YCBCR_SUBSAMPLING, TIFF_SHORT,    2, s->subsampling);
 450         add_entry(s, TIFF_REFERENCE_BW,      TIFF_RATIONAL, 6, refbw);
 451     }
 452     bytestream_put_le32(&offset, ptr - pkt->data);    // write offset to dir
 453
 454     if (check_size(s, 6 + s->num_entries * 12)) {
 455         ret = AVERROR(EINVAL);
 456         goto fail;
 457     }
 458     bytestream_put_le16(&ptr, s->num_entries);  // write tag count
 459     bytestream_put_buffer(&ptr, s->entries, s->num_entries * 12);
 460     bytestream_put_le32(&ptr, 0);
 461
 462     pkt->size   = ptr - pkt->data;
 463     pkt->flags |= AV_PKT_FLAG_KEY;
 464     *got_packet = 1;
 465
 466 fail:
 467     av_free(strip_sizes);
 468     av_free(strip_offsets);
 469     av_free(yuv_line);
 470     return ret;
 471 }
 472
 473 #define OFFSET(x) offsetof(TiffEncoderContext, x)
 474 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
 475 static const AVOption options[] = {
 476     { "compression_algo", NULL, OFFSET(compr), AV_OPT_TYPE_INT, {.i64 = TIFF_PACKBITS}, TIFF_RAW, TIFF_DEFLATE, VE, "compression_algo" },
 477     { "packbits", NULL, 0, AV_OPT_TYPE_CONST, {.i64 = TIFF_PACKBITS}, 0, 0, VE, "compression_algo" },
 478     { "raw",      NULL, 0, AV_OPT_TYPE_CONST, {.i64 = TIFF_RAW},      0, 0, VE, "compression_algo" },
 479     { "lzw",      NULL, 0, AV_OPT_TYPE_CONST, {.i64 = TIFF_LZW},      0, 0, VE, "compression_algo" },
 480 #if CONFIG_ZLIB
 481     { "deflate",  NULL, 0, AV_OPT_TYPE_CONST, {.i64 = TIFF_DEFLATE},  0, 0, VE, "compression_algo" },
 482 #endif
 483     { NULL },
 484 };
 485
 486 static const AVClass tiffenc_class = {
 487     .class_name = "TIFF encoder",
 488     .item_name  = av_default_item_name,
 489     .option     = options,
 490     .version    = LIBAVUTIL_VERSION_INT,
 491 };
 492
 493 AVCodec ff_tiff_encoder = {
 494     .name           = "tiff",
 495     .type           = AVMEDIA_TYPE_VIDEO,
 496     .id             = AV_CODEC_ID_TIFF,
 497     .priv_data_size = sizeof(TiffEncoderContext),
 498     .encode2        = encode_frame,
 499     .pix_fmts       = (const enum AVPixelFormat[]) {
 500         AV_PIX_FMT_RGB24, AV_PIX_FMT_RGB48LE, AV_PIX_FMT_PAL8,
 501         AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY16LE,
 502         AV_PIX_FMT_MONOBLACK, AV_PIX_FMT_MONOWHITE,
 503         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV444P,
 504         AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P,
 505         AV_PIX_FMT_NONE
 506     },
 507     .long_name      = NULL_IF_CONFIG_SMALL("TIFF image"),
 508     .priv_class     = &tiffenc_class,
 509 };