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