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 {
48 AVCodecContext *avctx;
51 int width; ///< picture width
52 int height; ///< picture height
53 unsigned int bpp; ///< bits per pixel
54 int compr; ///< compression level
55 int bpp_tab_size; ///< bpp_tab size
56 int photometric_interpretation; ///< photometric interpretation
57 int strips; ///< number of strips
58 int rps; ///< row per strip
59 uint8_t entries[TIFF_MAX_ENTRY*12]; ///< entires in header
60 int num_entries; ///< number of entires
61 uint8_t **buf; ///< actual position in buffer
62 uint8_t *buf_start; ///< pointer to first byte in buffer
63 int buf_size; ///< buffer size
64 uint16_t subsampling[2]; ///< YUV subsampling factors
65 struct LZWEncodeState *lzws; ///< LZW Encode state
66 uint32_t dpi; ///< image resolution in DPI
71 * Check free space in buffer
72 * @param s Tiff context
73 * @param need Needed bytes
74 * @return 0 - ok, 1 - no free space
76 inline static int check_size(TiffEncoderContext * s, uint64_t need)
78 if (s->buf_size < *s->buf - s->buf_start + need) {
79 *s->buf = s->buf_start + s->buf_size + 1;
80 av_log(s->avctx, AV_LOG_ERROR, "Buffer is too small\n");
87 * Put n values to buffer
89 * @param p Pointer to pointer to output buffer
90 * @param n Number of values
91 * @param val Pointer to values
92 * @param type Type of values
93 * @param flip =0 - normal copy, >0 - flip
95 static void tnput(uint8_t ** p, int n, const uint8_t * val, enum TiffTypes type,
100 flip ^= ((int[]) {0, 0, 0, 1, 3, 3})[type];
102 for (i = 0; i < n * type_sizes2[type]; i++)
103 *(*p)++ = val[i ^ flip];
107 * Add entry to directory in tiff header.
108 * @param s Tiff context
109 * @param tag Tag that identifies the entry
110 * @param type Entry type
111 * @param count The number of values
112 * @param ptr_val Pointer to values
114 static void add_entry(TiffEncoderContext * s,
115 enum TiffTags tag, enum TiffTypes type, int count,
118 uint8_t *entries_ptr = s->entries + 12 * s->num_entries;
120 assert(s->num_entries < TIFF_MAX_ENTRY);
122 bytestream_put_le16(&entries_ptr, tag);
123 bytestream_put_le16(&entries_ptr, type);
124 bytestream_put_le32(&entries_ptr, count);
126 if (type_sizes[type] * count <= 4) {
127 tnput(&entries_ptr, count, ptr_val, type, 0);
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);
137 static void add_entry1(TiffEncoderContext * s,
138 enum TiffTags tag, enum TiffTypes type, int val){
141 add_entry(s, tag, type, 1, type == TIFF_SHORT ? (void *)&w : (void *)&dw);
145 * Encode one strip in tiff file
147 * @param s Tiff context
148 * @param src Input buffer
149 * @param dst Output buffer
150 * @param n Size of input buffer
151 * @param compr Compression method
152 * @return Number of output bytes. If an output error is encountered, -1 returned
154 static int encode_strip(TiffEncoderContext * s, const int8_t * src,
155 uint8_t * dst, int n, int compr)
161 case TIFF_ADOBE_DEFLATE:
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");
172 if (check_size(s, n))
177 return ff_rle_encode(dst, s->buf_size - (*s->buf - s->buf_start), src, 1, n, 2, 0xff, -1, 0);
179 return ff_lzw_encode(s->lzws, src, n);
185 static void pack_yuv(TiffEncoderContext * s, uint8_t * dst, int lnum)
187 AVFrame *p = &s->picture;
189 int w = (s->width - 1) / s->subsampling[0] + 1;
190 uint8_t *pu = &p->data[1][lnum / s->subsampling[1] * p->linesize[1]];
191 uint8_t *pv = &p->data[2][lnum / s->subsampling[1] * p->linesize[2]];
192 for (i = 0; i < w; i++){
193 for (j = 0; j < s->subsampling[1]; j++)
194 for (k = 0; k < s->subsampling[0]; k++)
195 *dst++ = p->data[0][(lnum + j) * p->linesize[0] +
196 i * s->subsampling[0] + k];
202 static int encode_frame(AVCodecContext * avctx, unsigned char *buf,
203 int buf_size, void *data)
205 TiffEncoderContext *s = avctx->priv_data;
206 AVFrame *pict = data;
207 AVFrame *const p = (AVFrame *) & s->picture;
213 uint32_t *strip_sizes = NULL;
214 uint32_t *strip_offsets = NULL;
216 uint32_t res[2] = { s->dpi, 1 }; // image resolution (72/1)
217 uint16_t bpp_tab[] = { 8, 8, 8, 8 };
220 uint8_t *yuv_line = NULL;
221 int shift_h, shift_v;
226 s->buf_size = buf_size;
229 p->pict_type = AV_PICTURE_TYPE_I;
231 avctx->coded_frame= &s->picture;
233 s->compr = TIFF_PACKBITS;
234 if (avctx->compression_level == 0) {
236 } else if(avctx->compression_level == 2) {
239 } else if ((avctx->compression_level >= 3)) {
240 s->compr = TIFF_DEFLATE;
244 s->width = avctx->width;
245 s->height = avctx->height;
246 s->subsampling[0] = 1;
247 s->subsampling[1] = 1;
249 switch (avctx->pix_fmt) {
250 case PIX_FMT_RGB48LE:
252 s->photometric_interpretation = 2;
260 s->photometric_interpretation = 2;
264 s->photometric_interpretation = 1;
268 s->photometric_interpretation = 3;
270 case PIX_FMT_MONOBLACK:
271 case PIX_FMT_MONOWHITE:
273 s->photometric_interpretation = avctx->pix_fmt == PIX_FMT_MONOBLACK;
276 case PIX_FMT_YUV420P:
277 case PIX_FMT_YUV422P:
278 case PIX_FMT_YUV444P:
279 case PIX_FMT_YUV410P:
280 case PIX_FMT_YUV411P:
281 s->photometric_interpretation = 6;
282 avcodec_get_chroma_sub_sample(avctx->pix_fmt,
284 s->bpp = 8 + (16 >> (shift_h + shift_v));
285 s->subsampling[0] = 1 << shift_h;
286 s->subsampling[1] = 1 << shift_v;
291 av_log(s->avctx, AV_LOG_ERROR,
292 "This colors format is not supported\n");
296 s->bpp_tab_size = (s->bpp >= 48) ? ((s->bpp + 7) >> 4):((s->bpp + 7) >> 3);
298 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE || s->compr == TIFF_LZW)
299 //best choose for DEFLATE
302 s->rps = FFMAX(8192 / (((s->width * s->bpp) >> 3) + 1), 1); // suggest size of strip
303 s->rps = ((s->rps - 1) / s->subsampling[1] + 1) * s->subsampling[1]; // round rps up
305 strips = (s->height - 1) / s->rps + 1;
307 if (check_size(s, 8))
311 bytestream_put_le16(&ptr, 0x4949);
312 bytestream_put_le16(&ptr, 42);
315 bytestream_put_le32(&ptr, 0);
317 strip_sizes = av_mallocz(sizeof(*strip_sizes) * strips);
318 strip_offsets = av_mallocz(sizeof(*strip_offsets) * strips);
320 bytes_per_row = (((s->width - 1)/s->subsampling[0] + 1) * s->bpp
321 * s->subsampling[0] * s->subsampling[1] + 7) >> 3;
323 yuv_line = av_malloc(bytes_per_row);
324 if (yuv_line == NULL){
325 av_log(s->avctx, AV_LOG_ERROR, "Not enough memory\n");
331 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
336 zlen = bytes_per_row * s->rps;
337 zbuf = av_malloc(zlen);
338 strip_offsets[0] = ptr - buf;
340 for (j = 0; j < s->rps; j++) {
342 pack_yuv(s, yuv_line, j);
343 memcpy(zbuf + zn, yuv_line, bytes_per_row);
344 j += s->subsampling[1] - 1;
347 memcpy(zbuf + j * bytes_per_row,
348 p->data[0] + j * p->linesize[0], bytes_per_row);
351 n = encode_strip(s, zbuf, ptr, zn, s->compr);
354 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
358 strip_sizes[0] = ptr - buf - strip_offsets[0];
362 if(s->compr == TIFF_LZW)
363 s->lzws = av_malloc(ff_lzw_encode_state_size);
364 for (i = 0; i < s->height; i++) {
365 if (strip_sizes[i / s->rps] == 0) {
366 if(s->compr == TIFF_LZW){
367 ff_lzw_encode_init(s->lzws, ptr, s->buf_size - (*s->buf - s->buf_start),
368 12, FF_LZW_TIFF, put_bits);
370 strip_offsets[i / s->rps] = ptr - buf;
373 pack_yuv(s, yuv_line, i);
374 n = encode_strip(s, yuv_line, ptr, bytes_per_row, s->compr);
375 i += s->subsampling[1] - 1;
378 n = encode_strip(s, p->data[0] + i * p->linesize[0],
379 ptr, bytes_per_row, s->compr);
381 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
384 strip_sizes[i / s->rps] += n;
386 if(s->compr == TIFF_LZW && (i==s->height-1 || i%s->rps == s->rps-1)){
388 ret = ff_lzw_encode_flush(s->lzws, flush_put_bits);
389 strip_sizes[(i / s->rps )] += ret ;
393 if(s->compr == TIFF_LZW)
399 add_entry1(s,TIFF_SUBFILE, TIFF_LONG, 0);
400 add_entry1(s,TIFF_WIDTH, TIFF_LONG, s->width);
401 add_entry1(s,TIFF_HEIGHT, TIFF_LONG, s->height);
404 add_entry(s, TIFF_BPP, TIFF_SHORT, s->bpp_tab_size, bpp_tab);
406 add_entry1(s,TIFF_COMPR, TIFF_SHORT, s->compr);
407 add_entry1(s,TIFF_INVERT, TIFF_SHORT, s->photometric_interpretation);
408 add_entry(s, TIFF_STRIP_OFFS, TIFF_LONG, strips, strip_offsets);
411 add_entry1(s,TIFF_SAMPLES_PER_PIXEL, TIFF_SHORT, s->bpp_tab_size);
413 add_entry1(s,TIFF_ROWSPERSTRIP, TIFF_LONG, s->rps);
414 add_entry(s, TIFF_STRIP_SIZE, TIFF_LONG, strips, strip_sizes);
415 add_entry(s, TIFF_XRES, TIFF_RATIONAL, 1, res);
416 add_entry(s, TIFF_YRES, TIFF_RATIONAL, 1, res);
417 add_entry1(s,TIFF_RES_UNIT, TIFF_SHORT, 2);
419 if(!(avctx->flags & CODEC_FLAG_BITEXACT))
420 add_entry(s, TIFF_SOFTWARE_NAME, TIFF_STRING,
421 strlen(LIBAVCODEC_IDENT) + 1, LIBAVCODEC_IDENT);
423 if (avctx->pix_fmt == PIX_FMT_PAL8) {
424 uint16_t pal[256 * 3];
425 for (i = 0; i < 256; i++) {
426 uint32_t rgb = *(uint32_t *) (p->data[1] + i * 4);
427 pal[i] = ((rgb >> 16) & 0xff) * 257;
428 pal[i + 256] = ((rgb >> 8 ) & 0xff) * 257;
429 pal[i + 512] = ( rgb & 0xff) * 257;
431 add_entry(s, TIFF_PAL, TIFF_SHORT, 256 * 3, pal);
434 /** according to CCIR Recommendation 601.1 */
435 uint32_t refbw[12] = {15, 1, 235, 1, 128, 1, 240, 1, 128, 1, 240, 1};
436 add_entry(s, TIFF_YCBCR_SUBSAMPLING, TIFF_SHORT, 2, s->subsampling);
437 add_entry(s, TIFF_REFERENCE_BW, TIFF_RATIONAL, 6, refbw);
439 bytestream_put_le32(&offset, ptr - buf); // write offset to dir
441 if (check_size(s, 6 + s->num_entries * 12))
443 bytestream_put_le16(&ptr, s->num_entries); // write tag count
444 bytestream_put_buffer(&ptr, s->entries, s->num_entries * 12);
445 bytestream_put_le32(&ptr, 0);
450 av_free(strip_sizes);
451 av_free(strip_offsets);
456 static const AVOption options[]={
457 {"dpi", "set the image resolution (in dpi)", offsetof(TiffEncoderContext, dpi), AV_OPT_TYPE_INT, {.dbl = 72}, 1, 0x10000, AV_OPT_FLAG_VIDEO_PARAM|AV_OPT_FLAG_ENCODING_PARAM},
460 static const AVClass class = { "tiff", av_default_item_name, options, LIBAVUTIL_VERSION_INT };
462 AVCodec ff_tiff_encoder = {
464 .type = AVMEDIA_TYPE_VIDEO,
466 .priv_data_size = sizeof(TiffEncoderContext),
467 .encode = encode_frame,
469 (const enum PixelFormat[]) {PIX_FMT_RGB24, PIX_FMT_PAL8, PIX_FMT_GRAY8,
470 PIX_FMT_MONOBLACK, PIX_FMT_MONOWHITE,
471 PIX_FMT_YUV420P, PIX_FMT_YUV422P,
472 PIX_FMT_YUV444P, PIX_FMT_YUV410P,
473 PIX_FMT_YUV411P, PIX_FMT_RGB48LE,
475 .long_name = NULL_IF_CONFIG_SMALL("TIFF image"),