indeo: Do not reference mismatched tiles
[ffmpeg.git] / 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 "config.h"
29 #if CONFIG_ZLIB
30 #include <zlib.h>
31 #endif
32
33 #include "libavutil/log.h"
34 #include "libavutil/opt.h"
35 #include "libavutil/pixdesc.h"
36 #include "avcodec.h"
37 #include "bytestream.h"
38 #include "lzw.h"
39 #include "put_bits.h"
40 #include "rle.h"
41 #include "tiff.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];   ///< entries in header
64     int num_entries;                        ///< number of entries
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  * Check free space in buffer
74  * @param s Tiff context
75  * @param need Needed bytes
76  * @return 0 - ok, 1 - no free space
77  */
78 static inline int check_size(TiffEncoderContext *s, uint64_t need)
79 {
80     if (s->buf_size < *s->buf - s->buf_start + need) {
81         *s->buf = s->buf_start + s->buf_size + 1;
82         av_log(s->avctx, AV_LOG_ERROR, "Buffer is too small\n");
83         return 1;
84     }
85     return 0;
86 }
87
88 /**
89  * Put n values to buffer
90  *
91  * @param p Pointer to pointer to output buffer
92  * @param n Number of values
93  * @param val Pointer to values
94  * @param type Type of values
95  * @param flip =0 - normal copy, >0 - flip
96  */
97 static void tnput(uint8_t **p, int n, const uint8_t *val, enum TiffTypes type,
98                   int flip)
99 {
100     int i;
101 #if HAVE_BIGENDIAN
102     flip ^= ((int[]) { 0, 0, 0, 1, 3, 3 })[type];
103 #endif
104     for (i = 0; i < n * type_sizes2[type]; i++)
105         *(*p)++ = val[i ^ flip];
106 }
107
108 /**
109  * Add entry to directory in tiff header.
110  * @param s Tiff context
111  * @param tag Tag that identifies the entry
112  * @param type Entry type
113  * @param count The number of values
114  * @param ptr_val Pointer to values
115  */
116 static void add_entry(TiffEncoderContext *s, enum TiffTags tag,
117                       enum TiffTypes type, int count, const void *ptr_val)
118 {
119     uint8_t *entries_ptr = s->entries + 12 * s->num_entries;
120
121     assert(s->num_entries < TIFF_MAX_ENTRY);
122
123     bytestream_put_le16(&entries_ptr, tag);
124     bytestream_put_le16(&entries_ptr, type);
125     bytestream_put_le32(&entries_ptr, count);
126
127     if (type_sizes[type] * count <= 4) {
128         tnput(&entries_ptr, count, ptr_val, type, 0);
129     } else {
130         bytestream_put_le32(&entries_ptr, *s->buf - s->buf_start);
131         check_size(s, count * type_sizes2[type]);
132         tnput(s->buf, count, ptr_val, type, 0);
133     }
134
135     s->num_entries++;
136 }
137
138 static void add_entry1(TiffEncoderContext *s,
139                        enum TiffTags tag, enum TiffTypes type, int val)
140 {
141     uint16_t w  = val;
142     uint32_t dw = val;
143     add_entry(s, tag, type, 1, type == TIFF_SHORT ? (void *)&w : (void *)&dw);
144 }
145
146 /**
147  * Encode one strip in tiff file
148  *
149  * @param s Tiff context
150  * @param src Input buffer
151  * @param dst Output buffer
152  * @param n Size of input buffer
153  * @param compr Compression method
154  * @return Number of output bytes. If an output error is encountered, -1 returned
155  */
156 static int encode_strip(TiffEncoderContext *s, const int8_t *src,
157                         uint8_t *dst, int n, int compr)
158 {
159     switch (compr) {
160 #if CONFIG_ZLIB
161     case TIFF_DEFLATE:
162     case TIFF_ADOBE_DEFLATE:
163     {
164         unsigned long zlen = s->buf_size - (*s->buf - s->buf_start);
165         if (compress(dst, &zlen, src, n) != Z_OK) {
166             av_log(s->avctx, AV_LOG_ERROR, "Compressing failed\n");
167             return -1;
168         }
169         return zlen;
170     }
171 #endif
172     case TIFF_RAW:
173         if (check_size(s, n))
174             return -1;
175         memcpy(dst, src, n);
176         return n;
177     case TIFF_PACKBITS:
178         return ff_rle_encode(dst, s->buf_size - (*s->buf - s->buf_start),
179                              src, 1, n, 2, 0xff, -1, 0);
180     case TIFF_LZW:
181         return ff_lzw_encode(s->lzws, src, n);
182     default:
183         return -1;
184     }
185 }
186
187 static void pack_yuv(TiffEncoderContext *s, uint8_t *dst, int lnum)
188 {
189     AVFrame *p = &s->picture;
190     int i, j, k;
191     int w       = (s->width - 1) / s->subsampling[0] + 1;
192     uint8_t *pu = &p->data[1][lnum / s->subsampling[1] * p->linesize[1]];
193     uint8_t *pv = &p->data[2][lnum / s->subsampling[1] * p->linesize[2]];
194     for (i = 0; i < w; i++) {
195         for (j = 0; j < s->subsampling[1]; j++)
196             for (k = 0; k < s->subsampling[0]; k++)
197                 *dst++ = p->data[0][(lnum + j) * p->linesize[0] +
198                                     i * s->subsampling[0] + k];
199         *dst++ = *pu++;
200         *dst++ = *pv++;
201     }
202 }
203
204 static int encode_frame(AVCodecContext *avctx, AVPacket *pkt,
205                         const AVFrame *pict, int *got_packet)
206 {
207     TiffEncoderContext *s = avctx->priv_data;
208     AVFrame *const p = &s->picture;
209     int i;
210     uint8_t *ptr;
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]    = { 72, 1 };     // image resolution (72/1)
217     uint16_t bpp_tab[] = { 8, 8, 8, 8 };
218     int ret;
219     int is_yuv = 0;
220     uint8_t *yuv_line = NULL;
221     int shift_h, shift_v;
222     const AVPixFmtDescriptor *pfd;
223
224     s->avctx = avctx;
225
226     *p                 = *pict;
227     p->pict_type       = AV_PICTURE_TYPE_I;
228     p->key_frame       = 1;
229     avctx->coded_frame = &s->picture;
230
231     s->width          = avctx->width;
232     s->height         = avctx->height;
233     s->subsampling[0] = 1;
234     s->subsampling[1] = 1;
235
236     switch (avctx->pix_fmt) {
237     case AV_PIX_FMT_RGB48LE:
238     case AV_PIX_FMT_GRAY16LE:
239     case AV_PIX_FMT_RGB24:
240     case AV_PIX_FMT_GRAY8:
241     case AV_PIX_FMT_PAL8:
242         pfd    = av_pix_fmt_desc_get(avctx->pix_fmt);
243         s->bpp = av_get_bits_per_pixel(pfd);
244         if (pfd->flags & AV_PIX_FMT_FLAG_PAL)
245             s->photometric_interpretation = 3;
246         else if (pfd->flags & AV_PIX_FMT_FLAG_RGB)
247             s->photometric_interpretation = 2;
248         else
249             s->photometric_interpretation = 1;
250         s->bpp_tab_size = pfd->nb_components;
251         for (i = 0; i < s->bpp_tab_size; i++)
252             bpp_tab[i] = s->bpp / s->bpp_tab_size;
253         break;
254     case AV_PIX_FMT_MONOBLACK:
255         s->bpp                        = 1;
256         s->photometric_interpretation = 1;
257         s->bpp_tab_size               = 0;
258         break;
259     case AV_PIX_FMT_MONOWHITE:
260         s->bpp                        = 1;
261         s->photometric_interpretation = 0;
262         s->bpp_tab_size               = 0;
263         break;
264     case AV_PIX_FMT_YUV420P:
265     case AV_PIX_FMT_YUV422P:
266     case AV_PIX_FMT_YUV444P:
267     case AV_PIX_FMT_YUV410P:
268     case AV_PIX_FMT_YUV411P:
269         av_pix_fmt_get_chroma_sub_sample(avctx->pix_fmt, &shift_h, &shift_v);
270         s->photometric_interpretation = 6;
271         s->bpp                        = 8 + (16 >> (shift_h + shift_v));
272         s->subsampling[0]             = 1 << shift_h;
273         s->subsampling[1]             = 1 << shift_v;
274         s->bpp_tab_size               = 3;
275         is_yuv                        = 1;
276         break;
277     default:
278         av_log(s->avctx, AV_LOG_ERROR,
279                "This colors format is not supported\n");
280         return -1;
281     }
282
283     if (s->compr == TIFF_DEFLATE       ||
284         s->compr == TIFF_ADOBE_DEFLATE ||
285         s->compr == TIFF_LZW)
286         // best choice for DEFLATE
287         s->rps = s->height;
288     else
289         // suggest size of strip
290         s->rps = FFMAX(8192 / (((s->width * s->bpp) >> 3) + 1), 1);
291     // round rps up
292     s->rps = ((s->rps - 1) / s->subsampling[1] + 1) * s->subsampling[1];
293
294     strips = (s->height - 1) / s->rps + 1;
295
296     if (!pkt->data &&
297         (ret = av_new_packet(pkt,
298                              avctx->width * avctx->height * s->bpp * 2 +
299                              avctx->height * 4 + FF_MIN_BUFFER_SIZE)) < 0) {
300         av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
301         return ret;
302     }
303     ptr          = pkt->data;
304     s->buf_start = pkt->data;
305     s->buf       = &ptr;
306     s->buf_size  = pkt->size;
307
308     if (check_size(s, 8))
309         goto fail;
310
311     // write header
312     bytestream_put_le16(&ptr, 0x4949);
313     bytestream_put_le16(&ptr, 42);
314
315     offset = ptr;
316     bytestream_put_le32(&ptr, 0);
317
318     strip_sizes   = av_mallocz(sizeof(*strip_sizes)   * strips);
319     strip_offsets = av_mallocz(sizeof(*strip_offsets) * strips);
320     if (!strip_sizes || !strip_offsets) {
321         ret = AVERROR(ENOMEM);
322         goto fail;
323     }
324
325     bytes_per_row = (((s->width - 1) / s->subsampling[0] + 1) * s->bpp *
326                      s->subsampling[0] * s->subsampling[1] + 7) >> 3;
327     if (is_yuv) {
328         yuv_line = av_malloc(bytes_per_row);
329         if (yuv_line == NULL) {
330             av_log(s->avctx, AV_LOG_ERROR, "Not enough memory\n");
331             ret = AVERROR(ENOMEM);
332             goto fail;
333         }
334     }
335
336 #if CONFIG_ZLIB
337     if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
338         uint8_t *zbuf;
339         int zlen, zn;
340         int j;
341
342         zlen = bytes_per_row * s->rps;
343         zbuf = av_malloc(zlen);
344         if (!zbuf) {
345             ret = AVERROR(ENOMEM);
346             goto fail;
347         }
348         strip_offsets[0] = ptr - pkt->data;
349         zn               = 0;
350         for (j = 0; j < s->rps; j++) {
351             if (is_yuv) {
352                 pack_yuv(s, yuv_line, j);
353                 memcpy(zbuf + zn, yuv_line, bytes_per_row);
354                 j += s->subsampling[1] - 1;
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     if (s->compr == TIFF_LZW) {
371         s->lzws = av_malloc(ff_lzw_encode_state_size);
372         if (!s->lzws) {
373             ret = AVERROR(ENOMEM);
374             goto fail;
375         }
376     }
377     for (i = 0; i < s->height; i++) {
378         if (strip_sizes[i / s->rps] == 0) {
379             if (s->compr == TIFF_LZW) {
380                 ff_lzw_encode_init(s->lzws, ptr,
381                                    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         } else
391             ret = encode_strip(s, p->data[0] + i * p->linesize[0],
392                                ptr, bytes_per_row, s->compr);
393         if (ret < 0) {
394             av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
395             goto fail;
396         }
397         strip_sizes[i / s->rps] += ret;
398         ptr                     += ret;
399         if (s->compr == TIFF_LZW &&
400             (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     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 == AV_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     // write offset to dir
452     bytestream_put_le32(&offset, ptr - pkt->data);
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     .long_name      = NULL_IF_CONFIG_SMALL("TIFF image"),
496     .type           = AVMEDIA_TYPE_VIDEO,
497     .id             = AV_CODEC_ID_TIFF,
498     .priv_data_size = sizeof(TiffEncoderContext),
499     .encode2        = encode_frame,
500     .pix_fmts       = (const enum AVPixelFormat[]) {
501         AV_PIX_FMT_RGB24, AV_PIX_FMT_RGB48LE, AV_PIX_FMT_PAL8,
502         AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY16LE,
503         AV_PIX_FMT_MONOBLACK, AV_PIX_FMT_MONOWHITE,
504         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV444P,
505         AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P,
506         AV_PIX_FMT_NONE
507     },
508     .priv_class     = &tiffenc_class,
509 };