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