Don't include common.h from avutil.h
[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 "libavutil/log.h"
29 #include "libavutil/opt.h"
30
31 #include "avcodec.h"
32 #include "config.h"
33 #if CONFIG_ZLIB
34 #include <zlib.h>
35 #endif
36 #include "bytestream.h"
37 #include "tiff.h"
38 #include "rle.h"
39 #include "lzw.h"
40 #include "put_bits.h"
41
42 #define TIFF_MAX_ENTRY 32
43
44 /** sizes of various TIFF field types (string size = 1)*/
45 static const uint8_t type_sizes2[6] = {
46     0, 1, 1, 2, 4, 8
47 };
48
49 typedef struct TiffEncoderContext {
50     AVClass *class;                     ///< for private options
51     AVCodecContext *avctx;
52     AVFrame picture;
53
54     int width;                          ///< picture width
55     int height;                         ///< picture height
56     unsigned int bpp;                   ///< bits per pixel
57     int compr;                          ///< compression level
58     int bpp_tab_size;                   ///< bpp_tab size
59     int photometric_interpretation;     ///< photometric interpretation
60     int strips;                         ///< number of strips
61     int rps;                            ///< row per strip
62     uint8_t entries[TIFF_MAX_ENTRY*12]; ///< entires in header
63     int num_entries;                    ///< number of entires
64     uint8_t **buf;                      ///< actual position in buffer
65     uint8_t *buf_start;                 ///< pointer to first byte in buffer
66     int buf_size;                       ///< buffer size
67     uint16_t subsampling[2];            ///< YUV subsampling factors
68     struct LZWEncodeState *lzws;        ///< LZW Encode state
69 } TiffEncoderContext;
70
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,
117                       enum TiffTags tag, enum TiffTypes type, int count,
118                       const void *ptr_val)
119 {
120     uint8_t *entries_ptr = s->entries + 12 * s->num_entries;
121
122     assert(s->num_entries < TIFF_MAX_ENTRY);
123
124     bytestream_put_le16(&entries_ptr, tag);
125     bytestream_put_le16(&entries_ptr, type);
126     bytestream_put_le32(&entries_ptr, count);
127
128     if (type_sizes[type] * count <= 4) {
129         tnput(&entries_ptr, count, ptr_val, type, 0);
130     } else {
131         bytestream_put_le32(&entries_ptr, *s->buf - s->buf_start);
132         check_size(s, count * type_sizes2[type]);
133         tnput(s->buf, count, ptr_val, type, 0);
134     }
135
136     s->num_entries++;
137 }
138
139 static void add_entry1(TiffEncoderContext * s,
140                        enum TiffTags tag, enum TiffTypes type, int val){
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
160     switch (compr) {
161 #if CONFIG_ZLIB
162     case TIFF_DEFLATE:
163     case TIFF_ADOBE_DEFLATE:
164         {
165             unsigned long zlen = s->buf_size - (*s->buf - s->buf_start);
166             if (compress(dst, &zlen, src, n) != Z_OK) {
167                 av_log(s->avctx, AV_LOG_ERROR, "Compressing failed\n");
168                 return -1;
169             }
170             return zlen;
171         }
172 #endif
173     case TIFF_RAW:
174         if (check_size(s, n))
175             return -1;
176         memcpy(dst, src, n);
177         return n;
178     case TIFF_PACKBITS:
179         return ff_rle_encode(dst, s->buf_size - (*s->buf - s->buf_start), 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     static const 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
223     s->avctx = avctx;
224
225     *p = *pict;
226     p->pict_type = AV_PICTURE_TYPE_I;
227     p->key_frame = 1;
228     avctx->coded_frame= &s->picture;
229
230     s->width = avctx->width;
231     s->height = avctx->height;
232     s->subsampling[0] = 1;
233     s->subsampling[1] = 1;
234
235     switch (avctx->pix_fmt) {
236     case PIX_FMT_RGB24:
237         s->bpp = 24;
238         s->photometric_interpretation = 2;
239         break;
240     case PIX_FMT_GRAY8:
241         s->bpp = 8;
242         s->photometric_interpretation = 1;
243         break;
244     case PIX_FMT_PAL8:
245         s->bpp = 8;
246         s->photometric_interpretation = 3;
247         break;
248     case PIX_FMT_MONOBLACK:
249         s->bpp = 1;
250         s->photometric_interpretation = 1;
251         break;
252     case PIX_FMT_MONOWHITE:
253         s->bpp = 1;
254         s->photometric_interpretation = 0;
255         break;
256     case PIX_FMT_YUV420P:
257     case PIX_FMT_YUV422P:
258     case PIX_FMT_YUV444P:
259     case PIX_FMT_YUV410P:
260     case PIX_FMT_YUV411P:
261         s->photometric_interpretation = 6;
262         avcodec_get_chroma_sub_sample(avctx->pix_fmt,
263                 &shift_h, &shift_v);
264         s->bpp = 8 + (16 >> (shift_h + shift_v));
265         s->subsampling[0] = 1 << shift_h;
266         s->subsampling[1] = 1 << shift_v;
267         s->bpp_tab_size = 3;
268         is_yuv = 1;
269         break;
270     default:
271         av_log(s->avctx, AV_LOG_ERROR,
272                "This colors format is not supported\n");
273         return -1;
274     }
275     if (!is_yuv)
276         s->bpp_tab_size = (s->bpp >> 3);
277
278     if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE || s->compr == TIFF_LZW)
279         //best choose for DEFLATE
280         s->rps = s->height;
281     else
282         s->rps = FFMAX(8192 / (((s->width * s->bpp) >> 3) + 1), 1);     // suggest size of strip
283     s->rps = ((s->rps - 1) / s->subsampling[1] + 1) * s->subsampling[1]; // round rps up
284
285     strips = (s->height - 1) / s->rps + 1;
286
287     if (!pkt->data &&
288         (ret = av_new_packet(pkt, avctx->width * avctx->height * s->bpp * 2 +
289                                   avctx->height * 4 + FF_MIN_BUFFER_SIZE)) < 0) {
290         av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
291         return ret;
292     }
293     ptr          = pkt->data;
294     s->buf_start = pkt->data;
295     s->buf       = &ptr;
296     s->buf_size  = pkt->size;
297
298     if (check_size(s, 8))
299         goto fail;
300
301     // write header
302     bytestream_put_le16(&ptr, 0x4949);
303     bytestream_put_le16(&ptr, 42);
304
305     offset = ptr;
306     bytestream_put_le32(&ptr, 0);
307
308     strip_sizes = av_mallocz(sizeof(*strip_sizes) * strips);
309     strip_offsets = av_mallocz(sizeof(*strip_offsets) * strips);
310
311     bytes_per_row = (((s->width - 1)/s->subsampling[0] + 1) * s->bpp
312                     * s->subsampling[0] * s->subsampling[1] + 7) >> 3;
313     if (is_yuv){
314         yuv_line = av_malloc(bytes_per_row);
315         if (yuv_line == NULL){
316             av_log(s->avctx, AV_LOG_ERROR, "Not enough memory\n");
317             goto fail;
318         }
319     }
320
321 #if CONFIG_ZLIB
322     if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
323         uint8_t *zbuf;
324         int zlen, zn;
325         int j;
326
327         zlen = bytes_per_row * s->rps;
328         zbuf = av_malloc(zlen);
329         strip_offsets[0] = ptr - pkt->data;
330         zn = 0;
331         for (j = 0; j < s->rps; j++) {
332             if (is_yuv){
333                 pack_yuv(s, yuv_line, j);
334                 memcpy(zbuf + zn, yuv_line, bytes_per_row);
335                 j += s->subsampling[1] - 1;
336             }
337             else
338                 memcpy(zbuf + j * bytes_per_row,
339                        p->data[0] + j * p->linesize[0], bytes_per_row);
340             zn += bytes_per_row;
341         }
342         ret = encode_strip(s, zbuf, ptr, zn, s->compr);
343         av_free(zbuf);
344         if (ret < 0) {
345             av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
346             goto fail;
347         }
348         ptr += ret;
349         strip_sizes[0] = ptr - pkt->data - strip_offsets[0];
350     } else
351 #endif
352     {
353         if(s->compr == TIFF_LZW)
354             s->lzws = av_malloc(ff_lzw_encode_state_size);
355         for (i = 0; i < s->height; i++) {
356             if (strip_sizes[i / s->rps] == 0) {
357                 if(s->compr == TIFF_LZW){
358                     ff_lzw_encode_init(s->lzws, ptr, s->buf_size - (*s->buf - s->buf_start),
359                                        12, FF_LZW_TIFF, put_bits);
360                 }
361                 strip_offsets[i / s->rps] = ptr - pkt->data;
362             }
363             if (is_yuv){
364                  pack_yuv(s, yuv_line, i);
365                  ret = encode_strip(s, yuv_line, ptr, bytes_per_row, s->compr);
366                  i += s->subsampling[1] - 1;
367             }
368             else
369                 ret = encode_strip(s, p->data[0] + i * p->linesize[0],
370                         ptr, bytes_per_row, s->compr);
371             if (ret < 0) {
372                 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
373                 goto fail;
374             }
375             strip_sizes[i / s->rps] += ret;
376             ptr += ret;
377             if(s->compr == TIFF_LZW && (i==s->height-1 || i%s->rps == s->rps-1)){
378                 ret = ff_lzw_encode_flush(s->lzws, flush_put_bits);
379                 strip_sizes[(i / s->rps )] += ret ;
380                 ptr += ret;
381             }
382         }
383         if(s->compr == TIFF_LZW)
384             av_free(s->lzws);
385     }
386
387     s->num_entries = 0;
388
389     add_entry1(s,TIFF_SUBFILE,           TIFF_LONG,             0);
390     add_entry1(s,TIFF_WIDTH,             TIFF_LONG,             s->width);
391     add_entry1(s,TIFF_HEIGHT,            TIFF_LONG,             s->height);
392
393     if (s->bpp_tab_size)
394     add_entry(s, TIFF_BPP,               TIFF_SHORT,    s->bpp_tab_size, bpp_tab);
395
396     add_entry1(s,TIFF_COMPR,             TIFF_SHORT,            s->compr);
397     add_entry1(s,TIFF_INVERT,            TIFF_SHORT,            s->photometric_interpretation);
398     add_entry(s, TIFF_STRIP_OFFS,        TIFF_LONG,     strips, strip_offsets);
399
400     if (s->bpp_tab_size)
401     add_entry1(s,TIFF_SAMPLES_PER_PIXEL, TIFF_SHORT,            s->bpp_tab_size);
402
403     add_entry1(s,TIFF_ROWSPERSTRIP,      TIFF_LONG,             s->rps);
404     add_entry(s, TIFF_STRIP_SIZE,        TIFF_LONG,     strips, strip_sizes);
405     add_entry(s, TIFF_XRES,              TIFF_RATIONAL, 1,      res);
406     add_entry(s, TIFF_YRES,              TIFF_RATIONAL, 1,      res);
407     add_entry1(s,TIFF_RES_UNIT,          TIFF_SHORT,            2);
408
409     if(!(avctx->flags & CODEC_FLAG_BITEXACT))
410     add_entry(s, TIFF_SOFTWARE_NAME,     TIFF_STRING,
411               strlen(LIBAVCODEC_IDENT) + 1, LIBAVCODEC_IDENT);
412
413     if (avctx->pix_fmt == PIX_FMT_PAL8) {
414         uint16_t pal[256 * 3];
415         for (i = 0; i < 256; i++) {
416             uint32_t rgb = *(uint32_t *) (p->data[1] + i * 4);
417             pal[i]       = ((rgb >> 16) & 0xff) * 257;
418             pal[i + 256] = ((rgb >> 8 ) & 0xff) * 257;
419             pal[i + 512] = ( rgb        & 0xff) * 257;
420         }
421         add_entry(s, TIFF_PAL, TIFF_SHORT, 256 * 3, pal);
422     }
423     if (is_yuv){
424         /** according to CCIR Recommendation 601.1 */
425         uint32_t refbw[12] = {15, 1, 235, 1, 128, 1, 240, 1, 128, 1, 240, 1};
426         add_entry(s, TIFF_YCBCR_SUBSAMPLING, TIFF_SHORT,    2, s->subsampling);
427         add_entry(s, TIFF_REFERENCE_BW,      TIFF_RATIONAL, 6, refbw);
428     }
429     bytestream_put_le32(&offset, ptr - pkt->data);    // write offset to dir
430
431     if (check_size(s, 6 + s->num_entries * 12)) {
432         ret = AVERROR(EINVAL);
433         goto fail;
434     }
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     pkt->size   = ptr - pkt->data;
440     pkt->flags |= AV_PKT_FLAG_KEY;
441     *got_packet = 1;
442
443 fail:
444     av_free(strip_sizes);
445     av_free(strip_offsets);
446     av_free(yuv_line);
447     return ret;
448 }
449
450 #define OFFSET(x) offsetof(TiffEncoderContext, x)
451 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
452 static const AVOption options[] = {
453     { "compression_algo", NULL, OFFSET(compr), AV_OPT_TYPE_INT, {TIFF_PACKBITS}, TIFF_RAW, TIFF_DEFLATE, VE, "compression_algo" },
454     { "packbits", NULL, 0, AV_OPT_TYPE_CONST, {TIFF_PACKBITS}, 0, 0, VE, "compression_algo" },
455     { "raw",      NULL, 0, AV_OPT_TYPE_CONST, {TIFF_RAW},      0, 0, VE, "compression_algo" },
456     { "lzw",      NULL, 0, AV_OPT_TYPE_CONST, {TIFF_LZW},      0, 0, VE, "compression_algo" },
457 #if CONFIG_ZLIB
458     { "deflate",  NULL, 0, AV_OPT_TYPE_CONST, {TIFF_DEFLATE},  0, 0, VE, "compression_algo" },
459 #endif
460     { NULL },
461 };
462
463 static const AVClass tiffenc_class = {
464     .class_name = "TIFF encoder",
465     .item_name  = av_default_item_name,
466     .option     = options,
467     .version    = LIBAVUTIL_VERSION_INT,
468 };
469
470 AVCodec ff_tiff_encoder = {
471     .name           = "tiff",
472     .type           = AVMEDIA_TYPE_VIDEO,
473     .id             = AV_CODEC_ID_TIFF,
474     .priv_data_size = sizeof(TiffEncoderContext),
475     .encode2        = encode_frame,
476     .pix_fmts       = (const enum PixelFormat[]) {
477         PIX_FMT_RGB24, PIX_FMT_PAL8, PIX_FMT_GRAY8,
478         PIX_FMT_MONOBLACK, PIX_FMT_MONOWHITE,
479         PIX_FMT_YUV420P, PIX_FMT_YUV422P, PIX_FMT_YUV444P,
480         PIX_FMT_YUV410P, PIX_FMT_YUV411P,
481         PIX_FMT_NONE
482     },
483     .long_name      = NULL_IF_CONFIG_SMALL("TIFF image"),
484     .priv_class     = &tiffenc_class,
485 };