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