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