Make tiff-in-mov QuickTime-compatible for more colour-spaces.
[ffmpeg.git] / 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 #include "internal.h"
33 #if CONFIG_ZLIB
34 #include <zlib.h>
35 #endif
36 #include "libavutil/opt.h"
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     uint32_t dpi;                       ///< image resolution in DPI
71 } TiffEncoderContext;
72
73
74 /**
75  * Check free space in buffer
76  * @param s Tiff context
77  * @param need Needed bytes
78  * @return 0 - ok, 1 - no free space
79  */
80 static inline int check_size(TiffEncoderContext * s, uint64_t need)
81 {
82     if (s->buf_size < *s->buf - s->buf_start + need) {
83         *s->buf = s->buf_start + s->buf_size + 1;
84         av_log(s->avctx, AV_LOG_ERROR, "Buffer is too small\n");
85         return 1;
86     }
87     return 0;
88 }
89
90 /**
91  * Put n values to buffer
92  *
93  * @param p Pointer to pointer to output buffer
94  * @param n Number of values
95  * @param val Pointer to values
96  * @param type Type of values
97  * @param flip =0 - normal copy, >0 - flip
98  */
99 static void tnput(uint8_t ** p, int n, const uint8_t * val, enum TiffTypes type,
100                   int flip)
101 {
102     int i;
103 #if HAVE_BIGENDIAN
104     flip ^= ((int[]) {0, 0, 0, 1, 3, 3})[type];
105 #endif
106     for (i = 0; i < n * type_sizes2[type]; i++)
107         *(*p)++ = val[i ^ flip];
108 }
109
110 /**
111  * Add entry to directory in tiff header.
112  * @param s Tiff context
113  * @param tag Tag that identifies the entry
114  * @param type Entry type
115  * @param count The number of values
116  * @param ptr_val Pointer to values
117  */
118 static void add_entry(TiffEncoderContext * s,
119                       enum TiffTags tag, enum TiffTypes type, int count,
120                       const void *ptr_val)
121 {
122     uint8_t *entries_ptr = s->entries + 12 * s->num_entries;
123
124     assert(s->num_entries < TIFF_MAX_ENTRY);
125
126     bytestream_put_le16(&entries_ptr, tag);
127     bytestream_put_le16(&entries_ptr, type);
128     bytestream_put_le32(&entries_ptr, count);
129
130     if (type_sizes[type] * count <= 4) {
131         tnput(&entries_ptr, count, ptr_val, type, 0);
132     } else {
133         bytestream_put_le32(&entries_ptr, *s->buf - s->buf_start);
134         check_size(s, count * type_sizes2[type]);
135         tnput(s->buf, count, ptr_val, type, 0);
136     }
137
138     s->num_entries++;
139 }
140
141 static void add_entry1(TiffEncoderContext * s,
142                        enum TiffTags tag, enum TiffTypes type, int val){
143     uint16_t w = val;
144     uint32_t dw= val;
145     add_entry(s, tag, type, 1, type == TIFF_SHORT ? (void *)&w : (void *)&dw);
146 }
147
148 /**
149  * Encode one strip in tiff file
150  *
151  * @param s Tiff context
152  * @param src Input buffer
153  * @param dst Output buffer
154  * @param n Size of input buffer
155  * @param compr Compression method
156  * @return Number of output bytes. If an output error is encountered, -1 returned
157  */
158 static int encode_strip(TiffEncoderContext * s, const int8_t * src,
159                         uint8_t * dst, int n, int compr)
160 {
161
162     switch (compr) {
163 #if CONFIG_ZLIB
164     case TIFF_DEFLATE:
165     case TIFF_ADOBE_DEFLATE:
166         {
167             unsigned long zlen = s->buf_size - (*s->buf - s->buf_start);
168             if (compress(dst, &zlen, src, n) != Z_OK) {
169                 av_log(s->avctx, AV_LOG_ERROR, "Compressing failed\n");
170                 return -1;
171             }
172             return zlen;
173         }
174 #endif
175     case TIFF_RAW:
176         if (check_size(s, n))
177             return -1;
178         memcpy(dst, src, n);
179         return n;
180     case TIFF_PACKBITS:
181         return ff_rle_encode(dst, s->buf_size - (*s->buf - s->buf_start), src, 1, n, 2, 0xff, -1, 0);
182     case TIFF_LZW:
183         return ff_lzw_encode(s->lzws, src, n);
184     default:
185         return -1;
186     }
187 }
188
189 static void pack_yuv(TiffEncoderContext * s, uint8_t * dst, int lnum)
190 {
191     AVFrame *p = &s->picture;
192     int i, j, k;
193     int w = (s->width - 1) / s->subsampling[0] + 1;
194     uint8_t *pu = &p->data[1][lnum / s->subsampling[1] * p->linesize[1]];
195     uint8_t *pv = &p->data[2][lnum / s->subsampling[1] * p->linesize[2]];
196     for (i = 0; i < w; i++){
197         for (j = 0; j < s->subsampling[1]; j++)
198             for (k = 0; k < s->subsampling[0]; k++)
199                 *dst++ = p->data[0][(lnum + j) * p->linesize[0] +
200                                     i * s->subsampling[0] + k];
201         *dst++ = *pu++;
202         *dst++ = *pv++;
203     }
204 }
205
206 static int encode_frame(AVCodecContext * avctx, AVPacket *pkt,
207                         const AVFrame *pict, int *got_packet)
208 {
209     TiffEncoderContext *s = avctx->priv_data;
210     AVFrame *const p = &s->picture;
211     int i;
212     uint8_t *ptr;
213     uint8_t *offset;
214     uint32_t strips;
215     uint32_t *strip_sizes = NULL;
216     uint32_t *strip_offsets = NULL;
217     int bytes_per_row;
218     uint32_t res[2] = { s->dpi, 1 };        // image resolution (72/1)
219     uint16_t bpp_tab[] = { 8, 8, 8, 8 };
220     int ret = -1;
221     int is_yuv = 0;
222     uint8_t *yuv_line = NULL;
223     int shift_h, shift_v;
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 PIX_FMT_RGBA64LE:
239         s->bpp = 64;
240         s->photometric_interpretation = 2;
241         bpp_tab[0] = 16;
242         bpp_tab[1] = 16;
243         bpp_tab[2] = 16;
244         bpp_tab[3] = 16;
245         break;
246     case PIX_FMT_RGB48LE:
247         s->bpp = 48;
248         s->photometric_interpretation = 2;
249         bpp_tab[0] = 16;
250         bpp_tab[1] = 16;
251         bpp_tab[2] = 16;
252         bpp_tab[3] = 16;
253         break;
254     case PIX_FMT_RGBA:
255         avctx->bits_per_coded_sample =
256         s->bpp = 32;
257         s->photometric_interpretation = 2;
258         break;
259     case PIX_FMT_RGB24:
260         avctx->bits_per_coded_sample =
261         s->bpp = 24;
262         s->photometric_interpretation = 2;
263         break;
264     case PIX_FMT_GRAY8:
265         avctx->bits_per_coded_sample = 0x28;
266         s->bpp = 8;
267         s->photometric_interpretation = 1;
268         break;
269     case PIX_FMT_PAL8:
270         avctx->bits_per_coded_sample =
271         s->bpp = 8;
272         s->photometric_interpretation = 3;
273         break;
274     case PIX_FMT_MONOBLACK:
275     case PIX_FMT_MONOWHITE:
276         avctx->bits_per_coded_sample =
277         s->bpp = 1;
278         s->photometric_interpretation = avctx->pix_fmt == PIX_FMT_MONOBLACK;
279         bpp_tab[0] = 1;
280         break;
281     case PIX_FMT_YUV420P:
282     case PIX_FMT_YUV422P:
283     case PIX_FMT_YUV444P:
284     case PIX_FMT_YUV410P:
285     case PIX_FMT_YUV411P:
286         s->photometric_interpretation = 6;
287         avcodec_get_chroma_sub_sample(avctx->pix_fmt,
288                 &shift_h, &shift_v);
289         s->bpp = 8 + (16 >> (shift_h + shift_v));
290         s->subsampling[0] = 1 << shift_h;
291         s->subsampling[1] = 1 << shift_v;
292         s->bpp_tab_size = 3;
293         is_yuv = 1;
294         break;
295     default:
296         av_log(s->avctx, AV_LOG_ERROR,
297                "This colors format is not supported\n");
298         return -1;
299     }
300     if (!is_yuv)
301         s->bpp_tab_size = (s->bpp >= 48) ? ((s->bpp + 7) >> 4):((s->bpp + 7) >> 3);
302
303     if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE || s->compr == TIFF_LZW)
304         //best choose for DEFLATE
305         s->rps = s->height;
306     else
307         s->rps = FFMAX(8192 / (((s->width * s->bpp) >> 3) + 1), 1);     // suggest size of strip
308     s->rps = ((s->rps - 1) / s->subsampling[1] + 1) * s->subsampling[1]; // round rps up
309
310     strips = (s->height - 1) / s->rps + 1;
311
312     if ((ret = ff_alloc_packet2(avctx, pkt, avctx->width * avctx->height * s->bpp * 2 +
313                                   avctx->height * 4 + FF_MIN_BUFFER_SIZE)) < 0)
314         return ret;
315     ptr          = pkt->data;
316     s->buf_start = pkt->data;
317     s->buf       = &ptr;
318     s->buf_size  = pkt->size;
319
320     if (check_size(s, 8))
321         goto fail;
322
323     // write header
324     bytestream_put_le16(&ptr, 0x4949);
325     bytestream_put_le16(&ptr, 42);
326
327     offset = ptr;
328     bytestream_put_le32(&ptr, 0);
329
330     strip_sizes = av_mallocz(sizeof(*strip_sizes) * strips);
331     strip_offsets = av_mallocz(sizeof(*strip_offsets) * strips);
332
333     bytes_per_row = (((s->width - 1)/s->subsampling[0] + 1) * s->bpp
334                     * s->subsampling[0] * s->subsampling[1] + 7) >> 3;
335     if (is_yuv){
336         yuv_line = av_malloc(bytes_per_row);
337         if (yuv_line == NULL){
338             av_log(s->avctx, AV_LOG_ERROR, "Not enough memory\n");
339             goto fail;
340         }
341     }
342
343 #if CONFIG_ZLIB
344     if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
345         uint8_t *zbuf;
346         int zlen, zn;
347         int j;
348
349         zlen = bytes_per_row * s->rps;
350         zbuf = av_malloc(zlen);
351         strip_offsets[0] = ptr - pkt->data;
352         zn = 0;
353         for (j = 0; j < s->rps; j++) {
354             if (is_yuv){
355                 pack_yuv(s, yuv_line, j);
356                 memcpy(zbuf + zn, yuv_line, bytes_per_row);
357                 j += s->subsampling[1] - 1;
358             }
359             else
360                 memcpy(zbuf + j * bytes_per_row,
361                        p->data[0] + j * p->linesize[0], bytes_per_row);
362             zn += bytes_per_row;
363         }
364         ret = encode_strip(s, zbuf, ptr, zn, s->compr);
365         av_free(zbuf);
366         if (ret < 0) {
367             av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
368             goto fail;
369         }
370         ptr += ret;
371         strip_sizes[0] = ptr - pkt->data - strip_offsets[0];
372     } else
373 #endif
374     {
375         if(s->compr == TIFF_LZW)
376             s->lzws = av_malloc(ff_lzw_encode_state_size);
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, s->buf_size - (*s->buf - s->buf_start),
381                                        12, FF_LZW_TIFF, put_bits);
382                 }
383                 strip_offsets[i / s->rps] = ptr - pkt->data;
384             }
385             if (is_yuv){
386                  pack_yuv(s, yuv_line, i);
387                  ret = encode_strip(s, yuv_line, ptr, bytes_per_row, s->compr);
388                  i += s->subsampling[1] - 1;
389             }
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 && (i==s->height-1 || i%s->rps == s->rps-1)){
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 - pkt->data);    // write offset to dir
452
453     if (check_size(s, 6 + s->num_entries * 12)) {
454         ret = AVERROR(EINVAL);
455         goto fail;
456     }
457     bytestream_put_le16(&ptr, s->num_entries);  // write tag count
458     bytestream_put_buffer(&ptr, s->entries, s->num_entries * 12);
459     bytestream_put_le32(&ptr, 0);
460
461     pkt->size   = ptr - pkt->data;
462     pkt->flags |= AV_PKT_FLAG_KEY;
463     *got_packet = 1;
464
465 fail:
466     av_free(strip_sizes);
467     av_free(strip_offsets);
468     av_free(yuv_line);
469     return ret < 0 ? ret : 0;
470 }
471
472 #define OFFSET(x) offsetof(TiffEncoderContext, x)
473 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
474 static const AVOption options[] = {
475     {"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},
476     { "compression_algo", NULL, OFFSET(compr), AV_OPT_TYPE_INT, {TIFF_PACKBITS}, TIFF_RAW, TIFF_DEFLATE, VE, "compression_algo" },
477     { "packbits", NULL, 0, AV_OPT_TYPE_CONST, {TIFF_PACKBITS}, 0, 0, VE, "compression_algo" },
478     { "raw",      NULL, 0, AV_OPT_TYPE_CONST, {TIFF_RAW},      0, 0, VE, "compression_algo" },
479     { "lzw",      NULL, 0, AV_OPT_TYPE_CONST, {TIFF_LZW},      0, 0, VE, "compression_algo" },
480 #if CONFIG_ZLIB
481     { "deflate",  NULL, 0, AV_OPT_TYPE_CONST, {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             = CODEC_ID_TIFF,
497     .priv_data_size = sizeof(TiffEncoderContext),
498     .encode2        = encode_frame,
499     .pix_fmts       = (const enum PixelFormat[]) {
500         PIX_FMT_RGB24, PIX_FMT_PAL8, PIX_FMT_GRAY8,
501         PIX_FMT_MONOBLACK, PIX_FMT_MONOWHITE,
502         PIX_FMT_YUV420P, PIX_FMT_YUV422P, 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 };