Add DXVA2 HEVC HWAccel
[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     enum TiffPhotometric 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 int 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         if (check_size(s, count * type_sizes2[type]))
131             return AVERROR_INVALIDDATA;
132         tnput(s->buf, count, ptr_val, type, 0);
133     }
134
135     s->num_entries++;
136     return 0;
137 }
138
139 static int add_entry1(TiffEncoderContext *s,
140                       enum TiffTags tag, enum TiffTypes type, int val)
141 {
142     uint16_t w  = val;
143     uint32_t dw = val;
144     return add_entry(s, tag, type, 1,
145                      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     switch (compr) {
162 #if CONFIG_ZLIB
163     case TIFF_DEFLATE:
164     case TIFF_ADOBE_DEFLATE:
165     {
166         unsigned long zlen = s->buf_size - (*s->buf - s->buf_start);
167         if (compress(dst, &zlen, src, n) != Z_OK) {
168             av_log(s->avctx, AV_LOG_ERROR, "Compressing failed\n");
169             return -1;
170         }
171         return zlen;
172     }
173 #endif
174     case TIFF_RAW:
175         if (check_size(s, n))
176             return -1;
177         memcpy(dst, src, n);
178         return n;
179     case TIFF_PACKBITS:
180         return ff_rle_encode(dst, s->buf_size - (*s->buf - s->buf_start),
181                              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, const AVFrame *p,
190                      uint8_t *dst, int lnum)
191 {
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     for (i = 0; i < w; i++) {
197         for (j = 0; j < s->subsampling[1]; j++)
198             for (k = 0; k < s->subsampling[0]; k++)
199                 *dst++ = p->data[0][(lnum + j) * p->linesize[0] +
200                                     i * s->subsampling[0] + k];
201         *dst++ = *pu++;
202         *dst++ = *pv++;
203     }
204 }
205
206 #define ADD_ENTRY(s, tag, type, count, ptr_val)         \
207     do {                                                \
208         ret = add_entry(s, tag, type, count, ptr_val);  \
209         if (ret < 0)                                    \
210             goto fail;                                  \
211     } while(0);
212
213 #define ADD_ENTRY1(s, tag, type, val)           \
214     do {                                        \
215         ret = add_entry1(s, tag, type, val);    \
216         if (ret < 0)                            \
217             goto fail;                          \
218     } while(0);
219
220 static int encode_frame(AVCodecContext *avctx, AVPacket *pkt,
221                         const AVFrame *pict, int *got_packet)
222 {
223     TiffEncoderContext *s = avctx->priv_data;
224     const AVFrame *const p = pict;
225     int i;
226     uint8_t *ptr;
227     uint8_t *offset;
228     uint32_t strips;
229     uint32_t *strip_sizes   = NULL;
230     uint32_t *strip_offsets = NULL;
231     int bytes_per_row;
232     uint32_t res[2]    = { 72, 1 };     // image resolution (72/1)
233     uint16_t bpp_tab[] = { 8, 8, 8, 8 };
234     int ret = 0;
235     int is_yuv = 0;
236     uint8_t *yuv_line = NULL;
237     int shift_h, shift_v;
238     int packet_size;
239     const AVPixFmtDescriptor *pfd;
240
241     s->avctx = avctx;
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 AV_PIX_FMT_RGBA64LE:
250     case AV_PIX_FMT_RGB48LE:
251     case AV_PIX_FMT_GRAY16LE:
252     case AV_PIX_FMT_RGBA:
253     case AV_PIX_FMT_RGB24:
254     case AV_PIX_FMT_GRAY8:
255     case AV_PIX_FMT_PAL8:
256         pfd    = av_pix_fmt_desc_get(avctx->pix_fmt);
257         s->bpp = av_get_bits_per_pixel(pfd);
258         if (pfd->flags & AV_PIX_FMT_FLAG_PAL)
259             s->photometric_interpretation = TIFF_PHOTOMETRIC_PALETTE;
260         else if (pfd->flags & AV_PIX_FMT_FLAG_RGB)
261             s->photometric_interpretation = TIFF_PHOTOMETRIC_RGB;
262         else
263             s->photometric_interpretation = TIFF_PHOTOMETRIC_BLACK_IS_ZERO;
264         s->bpp_tab_size = pfd->nb_components;
265         for (i = 0; i < s->bpp_tab_size; i++)
266             bpp_tab[i] = s->bpp / s->bpp_tab_size;
267         break;
268     case AV_PIX_FMT_MONOBLACK:
269         s->bpp                        = 1;
270         s->photometric_interpretation = TIFF_PHOTOMETRIC_BLACK_IS_ZERO;
271         s->bpp_tab_size               = 0;
272         break;
273     case AV_PIX_FMT_MONOWHITE:
274         s->bpp                        = 1;
275         s->photometric_interpretation = TIFF_PHOTOMETRIC_WHITE_IS_ZERO;
276         s->bpp_tab_size               = 0;
277         break;
278     case AV_PIX_FMT_YUV420P:
279     case AV_PIX_FMT_YUV422P:
280     case AV_PIX_FMT_YUV444P:
281     case AV_PIX_FMT_YUV410P:
282     case AV_PIX_FMT_YUV411P:
283         av_pix_fmt_get_chroma_sub_sample(avctx->pix_fmt, &shift_h, &shift_v);
284         s->photometric_interpretation = TIFF_PHOTOMETRIC_YCBCR;
285         s->bpp                        = 8 + (16 >> (shift_h + shift_v));
286         s->subsampling[0]             = 1 << shift_h;
287         s->subsampling[1]             = 1 << shift_v;
288         s->bpp_tab_size               = 3;
289         is_yuv                        = 1;
290         break;
291     default:
292         av_log(s->avctx, AV_LOG_ERROR,
293                "This colors format is not supported\n");
294         return -1;
295     }
296
297     if (s->compr == TIFF_DEFLATE       ||
298         s->compr == TIFF_ADOBE_DEFLATE ||
299         s->compr == TIFF_LZW)
300         // best choice for DEFLATE
301         s->rps = s->height;
302     else
303         // suggest size of strip
304         s->rps = FFMAX(8192 / (((s->width * s->bpp) >> 3) + 1), 1);
305     // round rps up
306     s->rps = ((s->rps - 1) / s->subsampling[1] + 1) * s->subsampling[1];
307
308     strips = (s->height - 1) / s->rps + 1;
309
310     packet_size = avctx->height * ((avctx->width * s->bpp + 7) >> 3) * 2 +
311                   avctx->height * 4 + FF_MIN_BUFFER_SIZE;
312
313     if (!pkt->data &&
314         (ret = av_new_packet(pkt, packet_size)) < 0) {
315         av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
316         return ret;
317     }
318     ptr          = pkt->data;
319     s->buf_start = pkt->data;
320     s->buf       = &ptr;
321     s->buf_size  = pkt->size;
322
323     if (check_size(s, 8)) {
324         ret = AVERROR(EINVAL);
325         goto fail;
326     }
327
328     // write header
329     bytestream_put_le16(&ptr, 0x4949);
330     bytestream_put_le16(&ptr, 42);
331
332     offset = ptr;
333     bytestream_put_le32(&ptr, 0);
334
335     strip_sizes   = av_mallocz_array(strips, sizeof(*strip_sizes));
336     strip_offsets = av_mallocz_array(strips, sizeof(*strip_offsets));
337     if (!strip_sizes || !strip_offsets) {
338         ret = AVERROR(ENOMEM);
339         goto fail;
340     }
341
342     bytes_per_row = (((s->width - 1) / s->subsampling[0] + 1) * s->bpp *
343                      s->subsampling[0] * s->subsampling[1] + 7) >> 3;
344     if (is_yuv) {
345         yuv_line = av_malloc(bytes_per_row);
346         if (!yuv_line) {
347             av_log(s->avctx, AV_LOG_ERROR, "Not enough memory\n");
348             ret = AVERROR(ENOMEM);
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         if (!zbuf) {
362             ret = AVERROR(ENOMEM);
363             goto fail;
364         }
365         strip_offsets[0] = ptr - pkt->data;
366         zn               = 0;
367         for (j = 0; j < s->rps; j++) {
368             if (is_yuv) {
369                 pack_yuv(s, p, yuv_line, j);
370                 memcpy(zbuf + zn, yuv_line, bytes_per_row);
371                 j += s->subsampling[1] - 1;
372             } else
373                 memcpy(zbuf + j * bytes_per_row,
374                        p->data[0] + j * p->linesize[0], bytes_per_row);
375             zn += bytes_per_row;
376         }
377         ret = encode_strip(s, zbuf, ptr, zn, s->compr);
378         av_free(zbuf);
379         if (ret < 0) {
380             av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
381             goto fail;
382         }
383         ptr           += ret;
384         strip_sizes[0] = ptr - pkt->data - strip_offsets[0];
385     } else
386 #endif
387     if (s->compr == TIFF_LZW) {
388         s->lzws = av_malloc(ff_lzw_encode_state_size);
389         if (!s->lzws) {
390             ret = AVERROR(ENOMEM);
391             goto fail;
392         }
393     }
394     for (i = 0; i < s->height; i++) {
395         if (strip_sizes[i / s->rps] == 0) {
396             if (s->compr == TIFF_LZW) {
397                 ff_lzw_encode_init(s->lzws, ptr,
398                                    s->buf_size - (*s->buf - s->buf_start),
399                                    12, FF_LZW_TIFF, put_bits);
400             }
401             strip_offsets[i / s->rps] = ptr - pkt->data;
402         }
403         if (is_yuv) {
404             pack_yuv(s, p, yuv_line, i);
405             ret = encode_strip(s, yuv_line, ptr, bytes_per_row, s->compr);
406             i  += s->subsampling[1] - 1;
407         } else
408             ret = encode_strip(s, p->data[0] + i * p->linesize[0],
409                                ptr, bytes_per_row, s->compr);
410         if (ret < 0) {
411             av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
412             goto fail;
413         }
414         strip_sizes[i / s->rps] += ret;
415         ptr                     += ret;
416         if (s->compr == TIFF_LZW &&
417             (i == s->height - 1 || i % s->rps == s->rps - 1)) {
418             ret = ff_lzw_encode_flush(s->lzws, flush_put_bits);
419             strip_sizes[(i / s->rps)] += ret;
420             ptr                       += ret;
421         }
422     }
423     if (s->compr == TIFF_LZW)
424         av_free(s->lzws);
425
426     s->num_entries = 0;
427
428     ADD_ENTRY1(s, TIFF_SUBFILE, TIFF_LONG, 0);
429     ADD_ENTRY1(s, TIFF_WIDTH,   TIFF_LONG, s->width);
430     ADD_ENTRY1(s, TIFF_HEIGHT,  TIFF_LONG, s->height);
431
432     if (s->bpp_tab_size)
433         ADD_ENTRY(s, TIFF_BPP, TIFF_SHORT, s->bpp_tab_size, bpp_tab);
434
435     ADD_ENTRY1(s, TIFF_COMPR,       TIFF_SHORT, s->compr);
436     ADD_ENTRY1(s, TIFF_PHOTOMETRIC, TIFF_SHORT, s->photometric_interpretation);
437     ADD_ENTRY(s,  TIFF_STRIP_OFFS,  TIFF_LONG,  strips, strip_offsets);
438
439     if (s->bpp_tab_size)
440         ADD_ENTRY1(s, TIFF_SAMPLES_PER_PIXEL, TIFF_SHORT, s->bpp_tab_size);
441
442     ADD_ENTRY1(s, TIFF_ROWSPERSTRIP, TIFF_LONG,     s->rps);
443     ADD_ENTRY(s,  TIFF_STRIP_SIZE,   TIFF_LONG,     strips, strip_sizes);
444     ADD_ENTRY(s,  TIFF_XRES,         TIFF_RATIONAL, 1,      res);
445     ADD_ENTRY(s,  TIFF_YRES,         TIFF_RATIONAL, 1,      res);
446     ADD_ENTRY1(s, TIFF_RES_UNIT,     TIFF_SHORT,    2);
447
448     if (!(avctx->flags & CODEC_FLAG_BITEXACT))
449         ADD_ENTRY(s, TIFF_SOFTWARE_NAME, TIFF_STRING,
450                   strlen(LIBAVCODEC_IDENT) + 1, LIBAVCODEC_IDENT);
451
452     if (avctx->pix_fmt == AV_PIX_FMT_PAL8) {
453         uint16_t pal[256 * 3];
454         for (i = 0; i < 256; i++) {
455             uint32_t rgb = *(uint32_t *) (p->data[1] + i * 4);
456             pal[i]       = ((rgb >> 16) & 0xff) * 257;
457             pal[i + 256] = ((rgb >>  8) & 0xff) * 257;
458             pal[i + 512] =  (rgb        & 0xff) * 257;
459         }
460         ADD_ENTRY(s, TIFF_PAL, TIFF_SHORT, 256 * 3, pal);
461     }
462     if (is_yuv) {
463         /** according to CCIR Recommendation 601.1 */
464         uint32_t refbw[12] = { 15, 1, 235, 1, 128, 1, 240, 1, 128, 1, 240, 1 };
465         ADD_ENTRY(s, TIFF_YCBCR_SUBSAMPLING, TIFF_SHORT,    2, s->subsampling);
466         ADD_ENTRY(s, TIFF_REFERENCE_BW,      TIFF_RATIONAL, 6, refbw);
467     }
468     // write offset to dir
469     bytestream_put_le32(&offset, ptr - pkt->data);
470
471     if (check_size(s, 6 + s->num_entries * 12)) {
472         ret = AVERROR(EINVAL);
473         goto fail;
474     }
475     bytestream_put_le16(&ptr, s->num_entries);  // write tag count
476     bytestream_put_buffer(&ptr, s->entries, s->num_entries * 12);
477     bytestream_put_le32(&ptr, 0);
478
479     pkt->size   = ptr - pkt->data;
480     pkt->flags |= AV_PKT_FLAG_KEY;
481     *got_packet = 1;
482
483 fail:
484     av_free(strip_sizes);
485     av_free(strip_offsets);
486     av_free(yuv_line);
487     return ret;
488 }
489
490 static av_cold int encode_init(AVCodecContext *avctx)
491 {
492     avctx->coded_frame = av_frame_alloc();
493     if (!avctx->coded_frame)
494         return AVERROR(ENOMEM);
495
496     avctx->coded_frame->pict_type = AV_PICTURE_TYPE_I;
497     avctx->coded_frame->key_frame = 1;
498
499     return 0;
500 }
501
502 static av_cold int encode_close(AVCodecContext *avctx)
503 {
504     av_frame_free(&avctx->coded_frame);
505     return 0;
506 }
507
508 #define OFFSET(x) offsetof(TiffEncoderContext, x)
509 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
510 static const AVOption options[] = {
511     { "compression_algo", NULL, OFFSET(compr), AV_OPT_TYPE_INT,   { .i64 = TIFF_PACKBITS }, TIFF_RAW, TIFF_DEFLATE, VE, "compression_algo" },
512     { "packbits",         NULL, 0,             AV_OPT_TYPE_CONST, { .i64 = TIFF_PACKBITS }, 0,        0,            VE, "compression_algo" },
513     { "raw",              NULL, 0,             AV_OPT_TYPE_CONST, { .i64 = TIFF_RAW      }, 0,        0,            VE, "compression_algo" },
514     { "lzw",              NULL, 0,             AV_OPT_TYPE_CONST, { .i64 = TIFF_LZW      }, 0,        0,            VE, "compression_algo" },
515 #if CONFIG_ZLIB
516     { "deflate",          NULL, 0,             AV_OPT_TYPE_CONST, { .i64 = TIFF_DEFLATE  }, 0,        0,            VE, "compression_algo" },
517 #endif
518     { NULL },
519 };
520
521 static const AVClass tiffenc_class = {
522     .class_name = "TIFF encoder",
523     .item_name  = av_default_item_name,
524     .option     = options,
525     .version    = LIBAVUTIL_VERSION_INT,
526 };
527
528 AVCodec ff_tiff_encoder = {
529     .name           = "tiff",
530     .long_name      = NULL_IF_CONFIG_SMALL("TIFF image"),
531     .type           = AVMEDIA_TYPE_VIDEO,
532     .id             = AV_CODEC_ID_TIFF,
533     .priv_data_size = sizeof(TiffEncoderContext),
534     .init           = encode_init,
535     .close          = encode_close,
536     .encode2        = encode_frame,
537     .pix_fmts       = (const enum AVPixelFormat[]) {
538         AV_PIX_FMT_RGB24, AV_PIX_FMT_RGB48LE, AV_PIX_FMT_PAL8,
539         AV_PIX_FMT_RGBA, AV_PIX_FMT_RGBA64LE,
540         AV_PIX_FMT_GRAY8, AV_PIX_FMT_GRAY16LE,
541         AV_PIX_FMT_MONOBLACK, AV_PIX_FMT_MONOWHITE,
542         AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV444P,
543         AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P,
544         AV_PIX_FMT_NONE
545     },
546     .priv_class     = &tiffenc_class,
547 };