3 * Copyright (c) 2007 Bartlomiej Wolowiec
5 * This file is part of FFmpeg.
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.
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.
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
25 * @author Bartlomiej Wolowiec
32 #include "libavutil/opt.h"
33 #include "bytestream.h"
39 #define TIFF_MAX_ENTRY 32
41 /** sizes of various TIFF field types (string size = 1)*/
42 static const uint8_t type_sizes2[6] = {
46 typedef struct TiffEncoderContext {
47 AVCodecContext *avctx;
50 int width; ///< picture width
51 int height; ///< picture height
52 unsigned int bpp; ///< bits per pixel
53 int compr; ///< compression level
54 int bpp_tab_size; ///< bpp_tab size
55 int photometric_interpretation; ///< photometric interpretation
56 int strips; ///< number of strips
57 int rps; ///< row per strip
58 uint8_t entries[TIFF_MAX_ENTRY*12]; ///< entires in header
59 int num_entries; ///< number of entires
60 uint8_t **buf; ///< actual position in buffer
61 uint8_t *buf_start; ///< pointer to first byte in buffer
62 int buf_size; ///< buffer size
63 uint16_t subsampling[2]; ///< YUV subsampling factors
64 struct LZWEncodeState *lzws; ///< LZW Encode state
65 uint32_t dpi; ///< image resolution in DPI
70 * Check free space in buffer
71 * @param s Tiff context
72 * @param need Needed bytes
73 * @return 0 - ok, 1 - no free space
75 inline static int check_size(TiffEncoderContext * s, uint64_t need)
77 if (s->buf_size < *s->buf - s->buf_start + need) {
78 *s->buf = s->buf_start + s->buf_size + 1;
79 av_log(s->avctx, AV_LOG_ERROR, "Buffer is too small\n");
86 * Put n values to buffer
88 * @param p Pointer to pointer to output buffer
89 * @param n Number of values
90 * @param val Pointer to values
91 * @param type Type of values
92 * @param flip =0 - normal copy, >0 - flip
94 static void tnput(uint8_t ** p, int n, const uint8_t * val, enum TiffTypes type,
99 flip ^= ((int[]) {0, 0, 0, 1, 3, 3})[type];
101 for (i = 0; i < n * type_sizes2[type]; i++)
102 *(*p)++ = val[i ^ flip];
106 * Add entry to directory in tiff header.
107 * @param s Tiff context
108 * @param tag Tag that identifies the entry
109 * @param type Entry type
110 * @param count The number of values
111 * @param ptr_val Pointer to values
113 static void add_entry(TiffEncoderContext * s,
114 enum TiffTags tag, enum TiffTypes type, int count,
117 uint8_t *entries_ptr = s->entries + 12 * s->num_entries;
119 assert(s->num_entries < TIFF_MAX_ENTRY);
121 bytestream_put_le16(&entries_ptr, tag);
122 bytestream_put_le16(&entries_ptr, type);
123 bytestream_put_le32(&entries_ptr, count);
125 if (type_sizes[type] * count <= 4) {
126 tnput(&entries_ptr, count, ptr_val, type, 0);
128 bytestream_put_le32(&entries_ptr, *s->buf - s->buf_start);
129 check_size(s, count * type_sizes2[type]);
130 tnput(s->buf, count, ptr_val, type, 0);
136 static void add_entry1(TiffEncoderContext * s,
137 enum TiffTags tag, enum TiffTypes type, int val){
140 add_entry(s, tag, type, 1, type == TIFF_SHORT ? (void *)&w : (void *)&dw);
144 * Encode one strip in tiff file
146 * @param s Tiff context
147 * @param src Input buffer
148 * @param dst Output buffer
149 * @param n Size of input buffer
150 * @param compr Compression method
151 * @return Number of output bytes. If an output error is encountered, -1 returned
153 static int encode_strip(TiffEncoderContext * s, const int8_t * src,
154 uint8_t * dst, int n, int compr)
160 case TIFF_ADOBE_DEFLATE:
162 unsigned long zlen = s->buf_size - (*s->buf - s->buf_start);
163 if (compress(dst, &zlen, src, n) != Z_OK) {
164 av_log(s->avctx, AV_LOG_ERROR, "Compressing failed\n");
171 if (check_size(s, n))
176 return ff_rle_encode(dst, s->buf_size - (*s->buf - s->buf_start), src, 1, n, 2, 0xff, -1, 0);
178 return ff_lzw_encode(s->lzws, src, n);
184 static void pack_yuv(TiffEncoderContext * s, uint8_t * dst, int lnum)
186 AVFrame *p = &s->picture;
188 int w = (s->width - 1) / s->subsampling[0] + 1;
189 uint8_t *pu = &p->data[1][lnum / s->subsampling[1] * p->linesize[1]];
190 uint8_t *pv = &p->data[2][lnum / s->subsampling[1] * p->linesize[2]];
191 for (i = 0; i < w; i++){
192 for (j = 0; j < s->subsampling[1]; j++)
193 for (k = 0; k < s->subsampling[0]; k++)
194 *dst++ = p->data[0][(lnum + j) * p->linesize[0] +
195 i * s->subsampling[0] + k];
201 static int encode_frame(AVCodecContext * avctx, unsigned char *buf,
202 int buf_size, void *data)
204 TiffEncoderContext *s = avctx->priv_data;
205 AVFrame *pict = data;
206 AVFrame *const p = (AVFrame *) & s->picture;
212 uint32_t *strip_sizes = NULL;
213 uint32_t *strip_offsets = NULL;
215 uint32_t res[2] = { s->dpi, 1 }; // image resolution (72/1)
216 uint16_t bpp_tab[] = { 8, 8, 8, 8 };
219 uint8_t *yuv_line = NULL;
220 int shift_h, shift_v;
224 s->buf_size = buf_size;
227 p->pict_type = AV_PICTURE_TYPE_I;
229 avctx->coded_frame= &s->picture;
231 s->compr = TIFF_PACKBITS;
232 if (avctx->compression_level == 0) {
234 } else if(avctx->compression_level == 2) {
237 } else if ((avctx->compression_level >= 3)) {
238 s->compr = TIFF_DEFLATE;
242 s->width = avctx->width;
243 s->height = avctx->height;
244 s->subsampling[0] = 1;
245 s->subsampling[1] = 1;
247 switch (avctx->pix_fmt) {
250 s->photometric_interpretation = 2;
254 s->photometric_interpretation = 1;
258 s->photometric_interpretation = 3;
260 case PIX_FMT_MONOBLACK:
261 case PIX_FMT_MONOWHITE:
263 s->photometric_interpretation = avctx->pix_fmt == PIX_FMT_MONOBLACK;
266 case PIX_FMT_YUV420P:
267 case PIX_FMT_YUV422P:
268 case PIX_FMT_YUV444P:
269 case PIX_FMT_YUV410P:
270 case PIX_FMT_YUV411P:
271 s->photometric_interpretation = 6;
272 avcodec_get_chroma_sub_sample(avctx->pix_fmt,
274 s->bpp = 8 + (16 >> (shift_h + shift_v));
275 s->subsampling[0] = 1 << shift_h;
276 s->subsampling[1] = 1 << shift_v;
281 av_log(s->avctx, AV_LOG_ERROR,
282 "This colors format is not supported\n");
286 s->bpp_tab_size = ((s->bpp + 7) >> 3);
288 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE || s->compr == TIFF_LZW)
289 //best choose for DEFLATE
292 s->rps = FFMAX(8192 / (((s->width * s->bpp) >> 3) + 1), 1); // suggest size of strip
293 s->rps = ((s->rps - 1) / s->subsampling[1] + 1) * s->subsampling[1]; // round rps up
295 strips = (s->height - 1) / s->rps + 1;
297 if (check_size(s, 8))
301 bytestream_put_le16(&ptr, 0x4949);
302 bytestream_put_le16(&ptr, 42);
305 bytestream_put_le32(&ptr, 0);
307 strip_sizes = av_mallocz(sizeof(*strip_sizes) * strips);
308 strip_offsets = av_mallocz(sizeof(*strip_offsets) * strips);
310 bytes_per_row = (((s->width - 1)/s->subsampling[0] + 1) * s->bpp
311 * s->subsampling[0] * s->subsampling[1] + 7) >> 3;
313 yuv_line = av_malloc(bytes_per_row);
314 if (yuv_line == NULL){
315 av_log(s->avctx, AV_LOG_ERROR, "Not enough memory\n");
321 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
326 zlen = bytes_per_row * s->rps;
327 zbuf = av_malloc(zlen);
328 strip_offsets[0] = ptr - buf;
330 for (j = 0; j < s->rps; j++) {
332 pack_yuv(s, yuv_line, j);
333 memcpy(zbuf + zn, yuv_line, bytes_per_row);
334 j += s->subsampling[1] - 1;
337 memcpy(zbuf + j * bytes_per_row,
338 p->data[0] + j * p->linesize[0], bytes_per_row);
341 n = encode_strip(s, zbuf, ptr, zn, s->compr);
344 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
348 strip_sizes[0] = ptr - buf - strip_offsets[0];
352 if(s->compr == TIFF_LZW)
353 s->lzws = av_malloc(ff_lzw_encode_state_size);
354 for (i = 0; i < s->height; i++) {
355 if (strip_sizes[i / s->rps] == 0) {
356 if(s->compr == TIFF_LZW){
357 ff_lzw_encode_init(s->lzws, ptr, s->buf_size - (*s->buf - s->buf_start),
358 12, FF_LZW_TIFF, put_bits);
360 strip_offsets[i / s->rps] = ptr - buf;
363 pack_yuv(s, yuv_line, i);
364 n = encode_strip(s, yuv_line, ptr, bytes_per_row, s->compr);
365 i += s->subsampling[1] - 1;
368 n = encode_strip(s, p->data[0] + i * p->linesize[0],
369 ptr, bytes_per_row, s->compr);
371 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
374 strip_sizes[i / s->rps] += n;
376 if(s->compr == TIFF_LZW && (i==s->height-1 || i%s->rps == s->rps-1)){
378 ret = ff_lzw_encode_flush(s->lzws, flush_put_bits);
379 strip_sizes[(i / s->rps )] += ret ;
383 if(s->compr == TIFF_LZW)
389 add_entry1(s,TIFF_SUBFILE, TIFF_LONG, 0);
390 add_entry1(s,TIFF_WIDTH, TIFF_LONG, s->width);
391 add_entry1(s,TIFF_HEIGHT, TIFF_LONG, s->height);
394 add_entry(s, TIFF_BPP, TIFF_SHORT, s->bpp_tab_size, bpp_tab);
396 add_entry1(s,TIFF_COMPR, TIFF_SHORT, s->compr);
397 add_entry1(s,TIFF_INVERT, TIFF_SHORT, s->photometric_interpretation);
398 add_entry(s, TIFF_STRIP_OFFS, TIFF_LONG, strips, strip_offsets);
401 add_entry1(s,TIFF_SAMPLES_PER_PIXEL, TIFF_SHORT, s->bpp_tab_size);
403 add_entry1(s,TIFF_ROWSPERSTRIP, TIFF_LONG, s->rps);
404 add_entry(s, TIFF_STRIP_SIZE, TIFF_LONG, strips, strip_sizes);
405 add_entry(s, TIFF_XRES, TIFF_RATIONAL, 1, res);
406 add_entry(s, TIFF_YRES, TIFF_RATIONAL, 1, res);
407 add_entry1(s,TIFF_RES_UNIT, TIFF_SHORT, 2);
409 if(!(avctx->flags & CODEC_FLAG_BITEXACT))
410 add_entry(s, TIFF_SOFTWARE_NAME, TIFF_STRING,
411 strlen(LIBAVCODEC_IDENT) + 1, LIBAVCODEC_IDENT);
413 if (avctx->pix_fmt == PIX_FMT_PAL8) {
414 uint16_t pal[256 * 3];
415 for (i = 0; i < 256; i++) {
416 uint32_t rgb = *(uint32_t *) (p->data[1] + i * 4);
417 pal[i] = ((rgb >> 16) & 0xff) * 257;
418 pal[i + 256] = ((rgb >> 8 ) & 0xff) * 257;
419 pal[i + 512] = ( rgb & 0xff) * 257;
421 add_entry(s, TIFF_PAL, TIFF_SHORT, 256 * 3, pal);
424 /** according to CCIR Recommendation 601.1 */
425 uint32_t refbw[12] = {15, 1, 235, 1, 128, 1, 240, 1, 128, 1, 240, 1};
426 add_entry(s, TIFF_YCBCR_SUBSAMPLING, TIFF_SHORT, 2, s->subsampling);
427 add_entry(s, TIFF_REFERENCE_BW, TIFF_RATIONAL, 6, refbw);
429 bytestream_put_le32(&offset, ptr - buf); // write offset to dir
431 if (check_size(s, 6 + s->num_entries * 12))
433 bytestream_put_le16(&ptr, s->num_entries); // write tag count
434 bytestream_put_buffer(&ptr, s->entries, s->num_entries * 12);
435 bytestream_put_le32(&ptr, 0);
440 av_free(strip_sizes);
441 av_free(strip_offsets);
446 static const AVOption options[]={
447 {"dpi", "set the image resolution (in dpi)", offsetof(TiffEncoderContext, dpi), FF_OPT_TYPE_INT, {.dbl = 72}, 1, 0x10000, AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_ENCODING_PARAM},
450 static const AVClass class = { "tiff", av_default_item_name, options, LIBAVUTIL_VERSION_INT };
452 AVCodec ff_tiff_encoder = {
454 .type = AVMEDIA_TYPE_VIDEO,
456 .priv_data_size = sizeof(TiffEncoderContext),
457 .encode = encode_frame,
459 (const enum PixelFormat[]) {PIX_FMT_RGB24, PIX_FMT_PAL8, PIX_FMT_GRAY8,
460 PIX_FMT_MONOBLACK, PIX_FMT_MONOWHITE,
461 PIX_FMT_YUV420P, PIX_FMT_YUV422P,
462 PIX_FMT_YUV444P, PIX_FMT_YUV410P,
465 .long_name = NULL_IF_CONFIG_SMALL("TIFF image"),