tiffenc: use av_assert()
[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     av_assert0(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     if(s->width % s->subsampling[0] || s->height % s->subsampling[1]){
197         for (i = 0; i < w; i++){
198             for (j = 0; j < s->subsampling[1]; j++)
199                 for (k = 0; k < s->subsampling[0]; k++)
200                     *dst++ = p->data[0][FFMIN(lnum + j, s->height-1) * p->linesize[0] +
201                                         FFMIN(i * s->subsampling[0] + k, s->width-1)];
202             *dst++ = *pu++;
203             *dst++ = *pv++;
204         }
205     }else{
206         for (i = 0; i < w; i++){
207             for (j = 0; j < s->subsampling[1]; j++)
208                 for (k = 0; k < s->subsampling[0]; k++)
209                     *dst++ = p->data[0][(lnum + j) * p->linesize[0] +
210                                         i * s->subsampling[0] + k];
211             *dst++ = *pu++;
212             *dst++ = *pv++;
213         }
214     }
215 }
216
217 static int encode_frame(AVCodecContext * avctx, AVPacket *pkt,
218                         const AVFrame *pict, int *got_packet)
219 {
220     TiffEncoderContext *s = avctx->priv_data;
221     AVFrame *const p = &s->picture;
222     int i;
223     uint8_t *ptr;
224     uint8_t *offset;
225     uint32_t strips;
226     uint32_t *strip_sizes = NULL;
227     uint32_t *strip_offsets = NULL;
228     int bytes_per_row;
229     uint32_t res[2] = { s->dpi, 1 };        // image resolution (72/1)
230     uint16_t bpp_tab[] = { 8, 8, 8, 8 };
231     int ret = -1;
232     int is_yuv = 0;
233     uint8_t *yuv_line = NULL;
234     int shift_h, shift_v;
235
236     s->avctx = avctx;
237
238     *p = *pict;
239     p->pict_type = AV_PICTURE_TYPE_I;
240     p->key_frame = 1;
241     avctx->coded_frame= &s->picture;
242
243     s->width = avctx->width;
244     s->height = avctx->height;
245     s->subsampling[0] = 1;
246     s->subsampling[1] = 1;
247
248     switch (avctx->pix_fmt) {
249     case PIX_FMT_RGBA64LE:
250         s->bpp = 64;
251         s->photometric_interpretation = 2;
252         bpp_tab[0] = 16;
253         bpp_tab[1] = 16;
254         bpp_tab[2] = 16;
255         bpp_tab[3] = 16;
256         break;
257     case PIX_FMT_RGB48LE:
258         s->bpp = 48;
259         s->photometric_interpretation = 2;
260         bpp_tab[0] = 16;
261         bpp_tab[1] = 16;
262         bpp_tab[2] = 16;
263         bpp_tab[3] = 16;
264         break;
265     case PIX_FMT_RGBA:
266         avctx->bits_per_coded_sample =
267         s->bpp = 32;
268         s->photometric_interpretation = 2;
269         break;
270     case PIX_FMT_RGB24:
271         avctx->bits_per_coded_sample =
272         s->bpp = 24;
273         s->photometric_interpretation = 2;
274         break;
275     case PIX_FMT_GRAY8:
276         avctx->bits_per_coded_sample = 0x28;
277         s->bpp = 8;
278         s->photometric_interpretation = 1;
279         break;
280     case PIX_FMT_PAL8:
281         avctx->bits_per_coded_sample =
282         s->bpp = 8;
283         s->photometric_interpretation = 3;
284         break;
285     case PIX_FMT_MONOBLACK:
286     case PIX_FMT_MONOWHITE:
287         avctx->bits_per_coded_sample =
288         s->bpp = 1;
289         s->photometric_interpretation = avctx->pix_fmt == PIX_FMT_MONOBLACK;
290         bpp_tab[0] = 1;
291         break;
292     case PIX_FMT_YUV420P:
293     case PIX_FMT_YUV422P:
294     case PIX_FMT_YUV444P:
295     case PIX_FMT_YUV410P:
296     case PIX_FMT_YUV411P:
297         s->photometric_interpretation = 6;
298         avcodec_get_chroma_sub_sample(avctx->pix_fmt,
299                 &shift_h, &shift_v);
300         s->bpp = 8 + (16 >> (shift_h + shift_v));
301         s->subsampling[0] = 1 << shift_h;
302         s->subsampling[1] = 1 << shift_v;
303         s->bpp_tab_size = 3;
304         is_yuv = 1;
305         break;
306     default:
307         av_log(s->avctx, AV_LOG_ERROR,
308                "This colors format is not supported\n");
309         return -1;
310     }
311     if (!is_yuv)
312         s->bpp_tab_size = (s->bpp >= 48) ? ((s->bpp + 7) >> 4):((s->bpp + 7) >> 3);
313
314     if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE || s->compr == TIFF_LZW)
315         //best choose for DEFLATE
316         s->rps = s->height;
317     else
318         s->rps = FFMAX(8192 / (((s->width * s->bpp) >> 3) + 1), 1);     // suggest size of strip
319     s->rps = ((s->rps - 1) / s->subsampling[1] + 1) * s->subsampling[1]; // round rps up
320
321     strips = (s->height - 1) / s->rps + 1;
322
323     if ((ret = ff_alloc_packet2(avctx, pkt, avctx->width * avctx->height * s->bpp * 2 +
324                                   avctx->height * 4 + FF_MIN_BUFFER_SIZE)) < 0)
325         return ret;
326     ptr          = pkt->data;
327     s->buf_start = pkt->data;
328     s->buf       = &ptr;
329     s->buf_size  = pkt->size;
330
331     if (check_size(s, 8))
332         goto fail;
333
334     // write header
335     bytestream_put_le16(&ptr, 0x4949);
336     bytestream_put_le16(&ptr, 42);
337
338     offset = ptr;
339     bytestream_put_le32(&ptr, 0);
340
341     strip_sizes = av_mallocz(sizeof(*strip_sizes) * strips);
342     strip_offsets = av_mallocz(sizeof(*strip_offsets) * strips);
343
344     bytes_per_row = (((s->width - 1)/s->subsampling[0] + 1) * s->bpp
345                     * s->subsampling[0] * s->subsampling[1] + 7) >> 3;
346     if (is_yuv){
347         yuv_line = av_malloc(bytes_per_row);
348         if (yuv_line == NULL){
349             av_log(s->avctx, AV_LOG_ERROR, "Not enough memory\n");
350             goto fail;
351         }
352     }
353
354 #if CONFIG_ZLIB
355     if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
356         uint8_t *zbuf;
357         int zlen, zn;
358         int j;
359
360         zlen = bytes_per_row * s->rps;
361         zbuf = av_malloc(zlen);
362         strip_offsets[0] = ptr - pkt->data;
363         zn = 0;
364         for (j = 0; j < s->rps; j++) {
365             if (is_yuv){
366                 pack_yuv(s, yuv_line, j);
367                 memcpy(zbuf + zn, yuv_line, bytes_per_row);
368                 j += s->subsampling[1] - 1;
369             }
370             else
371                 memcpy(zbuf + j * bytes_per_row,
372                        p->data[0] + j * p->linesize[0], bytes_per_row);
373             zn += bytes_per_row;
374         }
375         ret = encode_strip(s, zbuf, ptr, zn, s->compr);
376         av_free(zbuf);
377         if (ret < 0) {
378             av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
379             goto fail;
380         }
381         ptr += ret;
382         strip_sizes[0] = ptr - pkt->data - strip_offsets[0];
383     } else
384 #endif
385     {
386         if(s->compr == TIFF_LZW)
387             s->lzws = av_malloc(ff_lzw_encode_state_size);
388         for (i = 0; i < s->height; i++) {
389             if (strip_sizes[i / s->rps] == 0) {
390                 if(s->compr == TIFF_LZW){
391                     ff_lzw_encode_init(s->lzws, ptr, s->buf_size - (*s->buf - s->buf_start),
392                                        12, FF_LZW_TIFF, put_bits);
393                 }
394                 strip_offsets[i / s->rps] = ptr - pkt->data;
395             }
396             if (is_yuv){
397                  pack_yuv(s, yuv_line, i);
398                  ret = encode_strip(s, yuv_line, ptr, bytes_per_row, s->compr);
399                  i += s->subsampling[1] - 1;
400             }
401             else
402                 ret = encode_strip(s, p->data[0] + i * p->linesize[0],
403                         ptr, bytes_per_row, s->compr);
404             if (ret < 0) {
405                 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
406                 goto fail;
407             }
408             strip_sizes[i / s->rps] += ret;
409             ptr += ret;
410             if(s->compr == TIFF_LZW && (i==s->height-1 || i%s->rps == s->rps-1)){
411                 ret = ff_lzw_encode_flush(s->lzws, flush_put_bits);
412                 strip_sizes[(i / s->rps )] += ret ;
413                 ptr += ret;
414             }
415         }
416         if(s->compr == TIFF_LZW)
417             av_free(s->lzws);
418     }
419
420     s->num_entries = 0;
421
422     add_entry1(s,TIFF_SUBFILE,           TIFF_LONG,             0);
423     add_entry1(s,TIFF_WIDTH,             TIFF_LONG,             s->width);
424     add_entry1(s,TIFF_HEIGHT,            TIFF_LONG,             s->height);
425
426     if (s->bpp_tab_size)
427     add_entry(s, TIFF_BPP,               TIFF_SHORT,    s->bpp_tab_size, bpp_tab);
428
429     add_entry1(s,TIFF_COMPR,             TIFF_SHORT,            s->compr);
430     add_entry1(s,TIFF_INVERT,            TIFF_SHORT,            s->photometric_interpretation);
431     add_entry(s, TIFF_STRIP_OFFS,        TIFF_LONG,     strips, strip_offsets);
432
433     if (s->bpp_tab_size)
434     add_entry1(s,TIFF_SAMPLES_PER_PIXEL, TIFF_SHORT,            s->bpp_tab_size);
435
436     add_entry1(s,TIFF_ROWSPERSTRIP,      TIFF_LONG,             s->rps);
437     add_entry(s, TIFF_STRIP_SIZE,        TIFF_LONG,     strips, strip_sizes);
438     add_entry(s, TIFF_XRES,              TIFF_RATIONAL, 1,      res);
439     add_entry(s, TIFF_YRES,              TIFF_RATIONAL, 1,      res);
440     add_entry1(s,TIFF_RES_UNIT,          TIFF_SHORT,            2);
441
442     if(!(avctx->flags & CODEC_FLAG_BITEXACT))
443     add_entry(s, TIFF_SOFTWARE_NAME,     TIFF_STRING,
444               strlen(LIBAVCODEC_IDENT) + 1, LIBAVCODEC_IDENT);
445
446     if (avctx->pix_fmt == PIX_FMT_PAL8) {
447         uint16_t pal[256 * 3];
448         for (i = 0; i < 256; i++) {
449             uint32_t rgb = *(uint32_t *) (p->data[1] + i * 4);
450             pal[i]       = ((rgb >> 16) & 0xff) * 257;
451             pal[i + 256] = ((rgb >> 8 ) & 0xff) * 257;
452             pal[i + 512] = ( rgb        & 0xff) * 257;
453         }
454         add_entry(s, TIFF_PAL, TIFF_SHORT, 256 * 3, pal);
455     }
456     if (is_yuv){
457         /** according to CCIR Recommendation 601.1 */
458         uint32_t refbw[12] = {15, 1, 235, 1, 128, 1, 240, 1, 128, 1, 240, 1};
459         add_entry(s, TIFF_YCBCR_SUBSAMPLING, TIFF_SHORT,    2, s->subsampling);
460         add_entry(s, TIFF_REFERENCE_BW,      TIFF_RATIONAL, 6, refbw);
461     }
462     bytestream_put_le32(&offset, ptr - pkt->data);    // write offset to dir
463
464     if (check_size(s, 6 + s->num_entries * 12)) {
465         ret = AVERROR(EINVAL);
466         goto fail;
467     }
468     bytestream_put_le16(&ptr, s->num_entries);  // write tag count
469     bytestream_put_buffer(&ptr, s->entries, s->num_entries * 12);
470     bytestream_put_le32(&ptr, 0);
471
472     pkt->size   = ptr - pkt->data;
473     pkt->flags |= AV_PKT_FLAG_KEY;
474     *got_packet = 1;
475
476 fail:
477     av_free(strip_sizes);
478     av_free(strip_offsets);
479     av_free(yuv_line);
480     return ret < 0 ? ret : 0;
481 }
482
483 #define OFFSET(x) offsetof(TiffEncoderContext, x)
484 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
485 static const AVOption options[] = {
486     {"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},
487     { "compression_algo", NULL, OFFSET(compr), AV_OPT_TYPE_INT, {TIFF_PACKBITS}, TIFF_RAW, TIFF_DEFLATE, VE, "compression_algo" },
488     { "packbits", NULL, 0, AV_OPT_TYPE_CONST, {TIFF_PACKBITS}, 0, 0, VE, "compression_algo" },
489     { "raw",      NULL, 0, AV_OPT_TYPE_CONST, {TIFF_RAW},      0, 0, VE, "compression_algo" },
490     { "lzw",      NULL, 0, AV_OPT_TYPE_CONST, {TIFF_LZW},      0, 0, VE, "compression_algo" },
491 #if CONFIG_ZLIB
492     { "deflate",  NULL, 0, AV_OPT_TYPE_CONST, {TIFF_DEFLATE},  0, 0, VE, "compression_algo" },
493 #endif
494     { NULL },
495 };
496
497 static const AVClass tiffenc_class = {
498     .class_name = "TIFF encoder",
499     .item_name  = av_default_item_name,
500     .option     = options,
501     .version    = LIBAVUTIL_VERSION_INT,
502 };
503
504 AVCodec ff_tiff_encoder = {
505     .name           = "tiff",
506     .type           = AVMEDIA_TYPE_VIDEO,
507     .id             = CODEC_ID_TIFF,
508     .priv_data_size = sizeof(TiffEncoderContext),
509     .encode2        = encode_frame,
510     .pix_fmts       = (const enum PixelFormat[]) {
511         PIX_FMT_RGB24, PIX_FMT_PAL8, PIX_FMT_GRAY8,
512         PIX_FMT_MONOBLACK, PIX_FMT_MONOWHITE,
513         PIX_FMT_YUV420P, PIX_FMT_YUV422P, PIX_FMT_YUV444P,
514         PIX_FMT_YUV410P, PIX_FMT_YUV411P, PIX_FMT_RGB48LE,
515         PIX_FMT_RGBA, PIX_FMT_RGBA64LE,
516         PIX_FMT_NONE
517     },
518     .long_name      = NULL_IF_CONFIG_SMALL("TIFF image"),
519     .priv_class     = &tiffenc_class,
520 };