3 * Copyright (c) 2007 Bartlomiej Wolowiec
5 * This file is part of Libav.
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.
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.
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
25 * @author Bartlomiej Wolowiec
28 #include "libavutil/log.h"
29 #include "libavutil/opt.h"
35 #include "bytestream.h"
41 #define TIFF_MAX_ENTRY 32
43 /** sizes of various TIFF field types (string size = 1)*/
44 static const uint8_t type_sizes2[6] = {
48 typedef struct TiffEncoderContext {
49 AVClass *class; ///< for private options
50 AVCodecContext *avctx;
53 int width; ///< picture width
54 int height; ///< picture height
55 unsigned int bpp; ///< bits per pixel
56 int compr; ///< compression level
57 int bpp_tab_size; ///< bpp_tab size
58 int photometric_interpretation; ///< photometric interpretation
59 int strips; ///< number of strips
60 int rps; ///< row per strip
61 uint8_t entries[TIFF_MAX_ENTRY*12]; ///< entires in header
62 int num_entries; ///< number of entires
63 uint8_t **buf; ///< actual position in buffer
64 uint8_t *buf_start; ///< pointer to first byte in buffer
65 int buf_size; ///< buffer size
66 uint16_t subsampling[2]; ///< YUV subsampling factors
67 struct LZWEncodeState *lzws; ///< LZW Encode state
72 * Check free space in buffer
73 * @param s Tiff context
74 * @param need Needed bytes
75 * @return 0 - ok, 1 - no free space
77 inline static int check_size(TiffEncoderContext * s, uint64_t need)
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");
88 * Put n values to buffer
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
96 static void tnput(uint8_t ** p, int n, const uint8_t * val, enum TiffTypes type,
101 flip ^= ((int[]) {0, 0, 0, 1, 3, 3})[type];
103 for (i = 0; i < n * type_sizes2[type]; i++)
104 *(*p)++ = val[i ^ flip];
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
115 static void add_entry(TiffEncoderContext * s,
116 enum TiffTags tag, enum TiffTypes type, int count,
119 uint8_t *entries_ptr = s->entries + 12 * s->num_entries;
121 assert(s->num_entries < TIFF_MAX_ENTRY);
123 bytestream_put_le16(&entries_ptr, tag);
124 bytestream_put_le16(&entries_ptr, type);
125 bytestream_put_le32(&entries_ptr, count);
127 if (type_sizes[type] * count <= 4) {
128 tnput(&entries_ptr, count, ptr_val, type, 0);
130 bytestream_put_le32(&entries_ptr, *s->buf - s->buf_start);
131 check_size(s, count * type_sizes2[type]);
132 tnput(s->buf, count, ptr_val, type, 0);
138 static void add_entry1(TiffEncoderContext * s,
139 enum TiffTags tag, enum TiffTypes type, int val){
142 add_entry(s, tag, type, 1, type == TIFF_SHORT ? (void *)&w : (void *)&dw);
146 * Encode one strip in tiff file
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
155 static int encode_strip(TiffEncoderContext * s, const int8_t * src,
156 uint8_t * dst, int n, int compr)
162 case TIFF_ADOBE_DEFLATE:
164 unsigned long zlen = s->buf_size - (*s->buf - s->buf_start);
165 if (compress(dst, &zlen, src, n) != Z_OK) {
166 av_log(s->avctx, AV_LOG_ERROR, "Compressing failed\n");
173 if (check_size(s, n))
178 return ff_rle_encode(dst, s->buf_size - (*s->buf - s->buf_start), src, 1, n, 2, 0xff, -1, 0);
180 return ff_lzw_encode(s->lzws, src, n);
186 static void pack_yuv(TiffEncoderContext * s, uint8_t * dst, int lnum)
188 AVFrame *p = &s->picture;
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];
203 static int encode_frame(AVCodecContext * avctx, unsigned char *buf,
204 int buf_size, void *data)
206 TiffEncoderContext *s = avctx->priv_data;
207 AVFrame *pict = data;
208 AVFrame *const p = (AVFrame *) & s->picture;
214 uint32_t *strip_sizes = NULL;
215 uint32_t *strip_offsets = NULL;
217 uint32_t res[2] = { 72, 1 }; // image resolution (72/1)
218 static const uint16_t bpp_tab[] = { 8, 8, 8, 8 };
221 uint8_t *yuv_line = NULL;
222 int shift_h, shift_v;
227 s->buf_size = buf_size;
230 p->pict_type = AV_PICTURE_TYPE_I;
232 avctx->coded_frame= &s->picture;
234 s->width = avctx->width;
235 s->height = avctx->height;
236 s->subsampling[0] = 1;
237 s->subsampling[1] = 1;
239 switch (avctx->pix_fmt) {
242 s->photometric_interpretation = 2;
246 s->photometric_interpretation = 1;
250 s->photometric_interpretation = 3;
252 case PIX_FMT_MONOBLACK:
254 s->photometric_interpretation = 1;
256 case PIX_FMT_MONOWHITE:
258 s->photometric_interpretation = 0;
260 case PIX_FMT_YUV420P:
261 case PIX_FMT_YUV422P:
262 case PIX_FMT_YUV444P:
263 case PIX_FMT_YUV410P:
264 case PIX_FMT_YUV411P:
265 s->photometric_interpretation = 6;
266 avcodec_get_chroma_sub_sample(avctx->pix_fmt,
268 s->bpp = 8 + (16 >> (shift_h + shift_v));
269 s->subsampling[0] = 1 << shift_h;
270 s->subsampling[1] = 1 << shift_v;
275 av_log(s->avctx, AV_LOG_ERROR,
276 "This colors format is not supported\n");
280 s->bpp_tab_size = (s->bpp >> 3);
282 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE || s->compr == TIFF_LZW)
283 //best choose for DEFLATE
286 s->rps = FFMAX(8192 / (((s->width * s->bpp) >> 3) + 1), 1); // suggest size of strip
287 s->rps = ((s->rps - 1) / s->subsampling[1] + 1) * s->subsampling[1]; // round rps up
289 strips = (s->height - 1) / s->rps + 1;
291 if (check_size(s, 8))
295 bytestream_put_le16(&ptr, 0x4949);
296 bytestream_put_le16(&ptr, 42);
299 bytestream_put_le32(&ptr, 0);
301 strip_sizes = av_mallocz(sizeof(*strip_sizes) * strips);
302 strip_offsets = av_mallocz(sizeof(*strip_offsets) * strips);
304 bytes_per_row = (((s->width - 1)/s->subsampling[0] + 1) * s->bpp
305 * s->subsampling[0] * s->subsampling[1] + 7) >> 3;
307 yuv_line = av_malloc(bytes_per_row);
308 if (yuv_line == NULL){
309 av_log(s->avctx, AV_LOG_ERROR, "Not enough memory\n");
315 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
320 zlen = bytes_per_row * s->rps;
321 zbuf = av_malloc(zlen);
322 strip_offsets[0] = ptr - buf;
324 for (j = 0; j < s->rps; j++) {
326 pack_yuv(s, yuv_line, j);
327 memcpy(zbuf + zn, yuv_line, bytes_per_row);
328 j += s->subsampling[1] - 1;
331 memcpy(zbuf + j * bytes_per_row,
332 p->data[0] + j * p->linesize[0], bytes_per_row);
335 n = encode_strip(s, zbuf, ptr, zn, s->compr);
338 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
342 strip_sizes[0] = ptr - buf - strip_offsets[0];
346 if(s->compr == TIFF_LZW)
347 s->lzws = av_malloc(ff_lzw_encode_state_size);
348 for (i = 0; i < s->height; i++) {
349 if (strip_sizes[i / s->rps] == 0) {
350 if(s->compr == TIFF_LZW){
351 ff_lzw_encode_init(s->lzws, ptr, s->buf_size - (*s->buf - s->buf_start),
352 12, FF_LZW_TIFF, put_bits);
354 strip_offsets[i / s->rps] = ptr - buf;
357 pack_yuv(s, yuv_line, i);
358 n = encode_strip(s, yuv_line, ptr, bytes_per_row, s->compr);
359 i += s->subsampling[1] - 1;
362 n = encode_strip(s, p->data[0] + i * p->linesize[0],
363 ptr, bytes_per_row, s->compr);
365 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
368 strip_sizes[i / s->rps] += n;
370 if(s->compr == TIFF_LZW && (i==s->height-1 || i%s->rps == s->rps-1)){
372 ret = ff_lzw_encode_flush(s->lzws, flush_put_bits);
373 strip_sizes[(i / s->rps )] += ret ;
377 if(s->compr == TIFF_LZW)
383 add_entry1(s,TIFF_SUBFILE, TIFF_LONG, 0);
384 add_entry1(s,TIFF_WIDTH, TIFF_LONG, s->width);
385 add_entry1(s,TIFF_HEIGHT, TIFF_LONG, s->height);
388 add_entry(s, TIFF_BPP, TIFF_SHORT, s->bpp_tab_size, bpp_tab);
390 add_entry1(s,TIFF_COMPR, TIFF_SHORT, s->compr);
391 add_entry1(s,TIFF_INVERT, TIFF_SHORT, s->photometric_interpretation);
392 add_entry(s, TIFF_STRIP_OFFS, TIFF_LONG, strips, strip_offsets);
395 add_entry1(s,TIFF_SAMPLES_PER_PIXEL, TIFF_SHORT, s->bpp_tab_size);
397 add_entry1(s,TIFF_ROWSPERSTRIP, TIFF_LONG, s->rps);
398 add_entry(s, TIFF_STRIP_SIZE, TIFF_LONG, strips, strip_sizes);
399 add_entry(s, TIFF_XRES, TIFF_RATIONAL, 1, res);
400 add_entry(s, TIFF_YRES, TIFF_RATIONAL, 1, res);
401 add_entry1(s,TIFF_RES_UNIT, TIFF_SHORT, 2);
403 if(!(avctx->flags & CODEC_FLAG_BITEXACT))
404 add_entry(s, TIFF_SOFTWARE_NAME, TIFF_STRING,
405 strlen(LIBAVCODEC_IDENT) + 1, LIBAVCODEC_IDENT);
407 if (avctx->pix_fmt == PIX_FMT_PAL8) {
408 uint16_t pal[256 * 3];
409 for (i = 0; i < 256; i++) {
410 uint32_t rgb = *(uint32_t *) (p->data[1] + i * 4);
411 pal[i] = ((rgb >> 16) & 0xff) * 257;
412 pal[i + 256] = ((rgb >> 8 ) & 0xff) * 257;
413 pal[i + 512] = ( rgb & 0xff) * 257;
415 add_entry(s, TIFF_PAL, TIFF_SHORT, 256 * 3, pal);
418 /** according to CCIR Recommendation 601.1 */
419 uint32_t refbw[12] = {15, 1, 235, 1, 128, 1, 240, 1, 128, 1, 240, 1};
420 add_entry(s, TIFF_YCBCR_SUBSAMPLING, TIFF_SHORT, 2, s->subsampling);
421 add_entry(s, TIFF_REFERENCE_BW, TIFF_RATIONAL, 6, refbw);
423 bytestream_put_le32(&offset, ptr - buf); // write offset to dir
425 if (check_size(s, 6 + s->num_entries * 12))
427 bytestream_put_le16(&ptr, s->num_entries); // write tag count
428 bytestream_put_buffer(&ptr, s->entries, s->num_entries * 12);
429 bytestream_put_le32(&ptr, 0);
434 av_free(strip_sizes);
435 av_free(strip_offsets);
440 #define OFFSET(x) offsetof(TiffEncoderContext, x)
441 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
442 static const AVOption options[] = {
443 { "compression_algo", NULL, OFFSET(compr), AV_OPT_TYPE_INT, {TIFF_PACKBITS}, TIFF_RAW, TIFF_DEFLATE, VE, "compression_algo" },
444 { "packbits", NULL, 0, AV_OPT_TYPE_CONST, {TIFF_PACKBITS}, 0, 0, VE, "compression_algo" },
445 { "raw", NULL, 0, AV_OPT_TYPE_CONST, {TIFF_RAW}, 0, 0, VE, "compression_algo" },
446 { "lzw", NULL, 0, AV_OPT_TYPE_CONST, {TIFF_LZW}, 0, 0, VE, "compression_algo" },
448 { "deflate", NULL, 0, AV_OPT_TYPE_CONST, {TIFF_DEFLATE}, 0, 0, VE, "compression_algo" },
453 static const AVClass tiffenc_class = {
454 .class_name = "TIFF encoder",
455 .item_name = av_default_item_name,
457 .version = LIBAVUTIL_VERSION_INT,
460 AVCodec ff_tiff_encoder = {
462 .type = AVMEDIA_TYPE_VIDEO,
464 .priv_data_size = sizeof(TiffEncoderContext),
465 .encode = encode_frame,
467 (const enum PixelFormat[]) {PIX_FMT_RGB24, PIX_FMT_PAL8, PIX_FMT_GRAY8,
468 PIX_FMT_MONOBLACK, PIX_FMT_MONOWHITE,
469 PIX_FMT_YUV420P, PIX_FMT_YUV422P,
470 PIX_FMT_YUV444P, PIX_FMT_YUV410P,
473 .long_name = NULL_IF_CONFIG_SMALL("TIFF image"),
474 .priv_class = &tiffenc_class,