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