TIFF-LZW encoding support by (Bartlomiej Wolowiec b.wolowiec students mimuw edu pl)
[libav.git] / libavcodec / tiffenc.c
CommitLineData
716222db
MN
1/*
2 * TIFF image encoder
3 * Copyright (c) 2007 Bartlomiej Wolowiec
4 *
5 * This file is part of FFmpeg.
6 *
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.
11 *
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.
16 *
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
20 *
21 */
22
ee5c8a9b
DB
23/**
24 * TIFF image encoder
25 * @file tiffenc.c
26 * @author Bartlomiej Wolowiec
27 */
716222db
MN
28#include "avcodec.h"
29#ifdef CONFIG_ZLIB
30#include <zlib.h>
31#endif
32#include "bytestream.h"
33#include "tiff.h"
34#include "rle.h"
efd2afc2 35#include "lzw.h"
716222db
MN
36
37#define TIFF_MAX_ENTRY 32
38
39/** sizes of various TIFF field types (string size = 1)*/
40static const uint8_t type_sizes2[6] = {
41 0, 1, 1, 2, 4, 8
42};
43
44typedef struct TiffEncoderContext {
45 AVCodecContext *avctx;
46 AVFrame picture;
47
48 int width; ///< picture width
49 int height; ///< picture height
50 unsigned int bpp; ///< bits per pixel
51 int compr; ///< compression level
52 int bpp_tab_size; ///< bpp_tab size
e780e99e 53 int photometric_interpretation; ///< photometric interpretation
716222db
MN
54 int strips; ///< number of strips
55 int rps; ///< row per strip
56 uint8_t entries[TIFF_MAX_ENTRY*12]; ///< entires in header
57 int num_entries; ///< number of entires
58 uint8_t **buf; ///< actual position in buffer
59 uint8_t *buf_start; ///< pointer to first byte in buffer
60 int buf_size; ///< buffer size
f4d47d6b 61 uint16_t subsampling[2]; ///< YUV subsampling factors
efd2afc2 62 struct LZWEncodeState *lzws; ///< LZW Encode state
716222db
MN
63} TiffEncoderContext;
64
65
66/**
67 * Check free space in buffer
68 * @param s Tiff context
69 * @param need Needed bytes
70 * @return 0 - ok, 1 - no free space
71 */
72inline static int check_size(TiffEncoderContext * s, uint64_t need)
73{
74 if (s->buf_size < *s->buf - s->buf_start + need) {
75 *s->buf = s->buf_start + s->buf_size + 1;
76 av_log(s->avctx, AV_LOG_ERROR, "Buffer is too small\n");
77 return 1;
78 }
79 return 0;
80}
81
82/**
83 * Put n values to buffer
84 *
85 * @param p Pointer to pointer to output buffer
86 * @param n Number of values
87 * @param val Pointer to values
88 * @param type Type of values
89 * @param flip =0 - normal copy, >0 - flip
90 */
91static void tnput(uint8_t ** p, int n, const uint8_t * val, enum TiffTypes type,
92 int flip)
93{
94 int i;
95#ifdef WORDS_BIGENDIAN
96 flip ^= ((int[]) {0, 0, 0, 1, 3, 3})[type];
97#endif
98 for (i = 0; i < n * type_sizes2[type]; i++)
99 *(*p)++ = val[i ^ flip];
100}
101
102/**
103 * Add entry to directory in tiff header.
104 * @param s Tiff context
105 * @param tag Tag that identifies the entry
106 * @param type Entry type
107 * @param count The number of values
108 * @param ptr_val Pointer to values
109 */
110static void add_entry(TiffEncoderContext * s,
111 enum TiffTags tag, enum TiffTypes type, int count,
112 const void *ptr_val)
113{
114 uint8_t *entries_ptr = s->entries + 12 * s->num_entries;
115
116 assert(s->num_entries < TIFF_MAX_ENTRY);
117
118 bytestream_put_le16(&entries_ptr, tag);
119 bytestream_put_le16(&entries_ptr, type);
120 bytestream_put_le32(&entries_ptr, count);
121
122 if (type_sizes[type] * count <= 4) {
123 tnput(&entries_ptr, count, ptr_val, type, 0);
124 } else {
125 bytestream_put_le32(&entries_ptr, *s->buf - s->buf_start);
126 check_size(s, count * type_sizes2[type]);
127 tnput(s->buf, count, ptr_val, type, 0);
128 }
129
130 s->num_entries++;
131}
132
0a7a33d2
MN
133static void add_entry1(TiffEncoderContext * s,
134 enum TiffTags tag, enum TiffTypes type, int val){
135 uint16_t w = val;
136 uint32_t dw= val;
137 add_entry(s, tag, type, 1, type == TIFF_SHORT ? &w : &dw);
138}
139
716222db
MN
140/**
141 * Encode one strip in tiff file
142 *
143 * @param s Tiff context
144 * @param src Input buffer
145 * @param dst Output buffer
146 * @param n Size of input buffer
147 * @param compr Compression method
148 * @return Number of output bytes. If an output error is encountered, -1 returned
149 */
150static int encode_strip(TiffEncoderContext * s, const int8_t * src,
151 uint8_t * dst, int n, int compr)
152{
153
154 switch (compr) {
155#ifdef CONFIG_ZLIB
156 case TIFF_DEFLATE:
157 case TIFF_ADOBE_DEFLATE:
158 {
159 unsigned long zlen = s->buf_size - (*s->buf - s->buf_start);
160 if (compress(dst, &zlen, src, n) != Z_OK) {
161 av_log(s->avctx, AV_LOG_ERROR, "Compressing failed\n");
162 return -1;
163 }
164 return zlen;
165 }
166#endif
167 case TIFF_RAW:
168 if (check_size(s, n))
169 return -1;
170 memcpy(dst, src, n);
171 return n;
172 case TIFF_PACKBITS:
173 return ff_rle_encode(dst, s->buf_size - (*s->buf - s->buf_start), src, 1, n, 2, 0xff, -1, 0);
efd2afc2
MN
174 case TIFF_LZW:
175 return ff_lzw_encode(s->lzws, src, n);
716222db
MN
176 default:
177 return -1;
178 }
179}
180
f4d47d6b
KN
181static void pack_yuv(TiffEncoderContext * s, uint8_t * dst, int lnum)
182{
183 AVFrame *p = &s->picture;
184 int i, j, k;
185 int w = (s->width - 1) / s->subsampling[0] + 1;
186 uint8_t *pu = &p->data[1][lnum / s->subsampling[1] * p->linesize[1]];
187 uint8_t *pv = &p->data[2][lnum / s->subsampling[1] * p->linesize[2]];
188 for (i = 0; i < w; i++){
189 for (j = 0; j < s->subsampling[1]; j++)
190 for (k = 0; k < s->subsampling[0]; k++)
191 *dst++ = p->data[0][(lnum + j) * p->linesize[0] +
192 i * s->subsampling[0] + k];
193 *dst++ = *pu++;
194 *dst++ = *pv++;
195 }
196}
197
716222db
MN
198static int encode_frame(AVCodecContext * avctx, unsigned char *buf,
199 int buf_size, void *data)
200{
201 TiffEncoderContext *s = avctx->priv_data;
202 AVFrame *pict = data;
203 AVFrame *const p = (AVFrame *) & s->picture;
204 int i;
205 int n;
206 uint8_t *ptr = buf;
207 uint8_t *offset;
208 uint32_t strips;
209 uint32_t *strip_sizes = NULL;
210 uint32_t *strip_offsets = NULL;
211 int bytes_per_row;
212 uint32_t res[2] = { 72, 1 }; // image resolution (72/1)
213 static const uint16_t bpp_tab[] = { 8, 8, 8, 8 };
214 int ret = -1;
f4d47d6b
KN
215 int is_yuv = 0;
216 uint8_t *yuv_line = NULL;
217 int shift_h, shift_v;
716222db
MN
218
219 s->buf_start = buf;
220 s->buf = &ptr;
221 s->buf_size = buf_size;
222
223 *p = *pict;
224 p->pict_type = FF_I_TYPE;
225 p->key_frame = 1;
226
227 s->compr = TIFF_PACKBITS;
228 if (avctx->compression_level == 0) {
229 s->compr = TIFF_RAW;
efd2afc2
MN
230 } else if(avctx->compression_level == 2) {
231 s->compr = TIFF_LZW;
716222db 232#ifdef CONFIG_ZLIB
efd2afc2 233 } else if ((avctx->compression_level >= 3)) {
716222db
MN
234 s->compr = TIFF_DEFLATE;
235#endif
236 }
237
238 s->width = avctx->width;
239 s->height = avctx->height;
f4d47d6b
KN
240 s->subsampling[0] = 1;
241 s->subsampling[1] = 1;
716222db
MN
242
243 switch (avctx->pix_fmt) {
244 case PIX_FMT_RGB24:
245 s->bpp = 24;
e780e99e 246 s->photometric_interpretation = 2;
716222db
MN
247 break;
248 case PIX_FMT_GRAY8:
249 s->bpp = 8;
e780e99e 250 s->photometric_interpretation = 1;
716222db
MN
251 break;
252 case PIX_FMT_PAL8:
253 s->bpp = 8;
e780e99e 254 s->photometric_interpretation = 3;
716222db
MN
255 break;
256 case PIX_FMT_MONOBLACK:
257 s->bpp = 1;
e780e99e 258 s->photometric_interpretation = 1;
716222db
MN
259 break;
260 case PIX_FMT_MONOWHITE:
261 s->bpp = 1;
e780e99e 262 s->photometric_interpretation = 0;
716222db 263 break;
f4d47d6b
KN
264 case PIX_FMT_YUV420P:
265 case PIX_FMT_YUV422P:
266 case PIX_FMT_YUV444P:
267 case PIX_FMT_YUV410P:
268 case PIX_FMT_YUV411P:
269 s->photometric_interpretation = 6;
270 avcodec_get_chroma_sub_sample(avctx->pix_fmt,
271 &shift_h, &shift_v);
272 s->bpp = 8 + (16 >> (shift_h + shift_v));
273 s->subsampling[0] = 1 << shift_h;
274 s->subsampling[1] = 1 << shift_v;
275 s->bpp_tab_size = 3;
276 is_yuv = 1;
277 break;
716222db
MN
278 default:
279 av_log(s->avctx, AV_LOG_ERROR,
280 "This colors format is not supported\n");
281 return -1;
282 }
f4d47d6b 283 if (!is_yuv)
716222db
MN
284 s->bpp_tab_size = (s->bpp >> 3);
285
efd2afc2 286 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE || s->compr == TIFF_LZW)
716222db
MN
287 //best choose for DEFLATE
288 s->rps = s->height;
289 else
290 s->rps = FFMAX(8192 / (((s->width * s->bpp) >> 3) + 1), 1); // suggest size of strip
f4d47d6b 291 s->rps = ((s->rps - 1) / s->subsampling[1] + 1) * s->subsampling[1]; // round rps up
716222db
MN
292
293 strips = (s->height - 1) / s->rps + 1;
294
295 if (check_size(s, 8))
296 goto fail;
297
298 // write header
299 bytestream_put_le16(&ptr, 0x4949);
300 bytestream_put_le16(&ptr, 42);
301
302 offset = ptr;
303 bytestream_put_le32(&ptr, 0);
304
305 strip_sizes = av_mallocz(sizeof(*strip_sizes) * strips);
306 strip_offsets = av_mallocz(sizeof(*strip_offsets) * strips);
307
f4d47d6b
KN
308 bytes_per_row = (((s->width - 1)/s->subsampling[0] + 1) * s->bpp
309 * s->subsampling[0] * s->subsampling[1] + 7) >> 3;
310 if (is_yuv){
311 yuv_line = av_malloc(bytes_per_row);
312 if (yuv_line == NULL){
313 av_log(s->avctx, AV_LOG_ERROR, "Not enough memory\n");
314 goto fail;
315 }
316 }
716222db
MN
317
318#ifdef CONFIG_ZLIB
319 if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
320 uint8_t *zbuf;
321 int zlen, zn;
322 int j;
323
324 zlen = bytes_per_row * s->rps;
325 zbuf = av_malloc(zlen);
326 strip_offsets[0] = ptr - buf;
327 zn = 0;
328 for (j = 0; j < s->rps; j++) {
f4d47d6b
KN
329 if (is_yuv){
330 pack_yuv(s, yuv_line, j);
331 memcpy(zbuf + zn, yuv_line, bytes_per_row);
332 j += s->subsampling[1] - 1;
333 }
334 else
716222db
MN
335 memcpy(zbuf + j * bytes_per_row,
336 p->data[0] + j * p->linesize[0], bytes_per_row);
337 zn += bytes_per_row;
338 }
339 n = encode_strip(s, zbuf, ptr, zn, s->compr);
340 av_free(zbuf);
341 if (n<0) {
342 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
343 goto fail;
344 }
345 ptr += n;
346 strip_sizes[0] = ptr - buf - strip_offsets[0];
347 } else
348#endif
349 {
efd2afc2
MN
350 if(s->compr == TIFF_LZW)
351 s->lzws = av_malloc(ff_lzw_encode_state_size);
716222db
MN
352 for (i = 0; i < s->height; i++) {
353 if (strip_sizes[i / s->rps] == 0) {
efd2afc2
MN
354 if(s->compr == TIFF_LZW){
355 ff_lzw_encode_init(s->lzws, ptr, s->buf_size - (*s->buf - s->buf_start), 12);
356 }
716222db
MN
357 strip_offsets[i / s->rps] = ptr - buf;
358 }
f4d47d6b
KN
359 if (is_yuv){
360 pack_yuv(s, yuv_line, i);
361 n = encode_strip(s, yuv_line, ptr, bytes_per_row, s->compr);
362 i += s->subsampling[1] - 1;
363 }
364 else
365 n = encode_strip(s, p->data[0] + i * p->linesize[0],
366 ptr, bytes_per_row, s->compr);
367 if (n < 0) {
716222db
MN
368 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
369 goto fail;
370 }
371 strip_sizes[i / s->rps] += n;
372 ptr += n;
efd2afc2
MN
373 if(s->compr == TIFF_LZW && (i==s->height-1 || i%s->rps == s->rps-1)){
374 int ret;
375 ret = ff_lzw_encode_flush(s->lzws);
376 strip_sizes[(i / s->rps )] += ret ;
377 ptr += ret;
378 }
716222db 379 }
efd2afc2
MN
380 if(s->compr == TIFF_LZW)
381 av_free(s->lzws);
716222db
MN
382 }
383
384 s->num_entries = 0;
385
0a7a33d2
MN
386 add_entry1(s,TIFF_SUBFILE, TIFF_LONG, 0);
387 add_entry1(s,TIFF_WIDTH, TIFF_LONG, s->width);
388 add_entry1(s,TIFF_HEIGHT, TIFF_LONG, s->height);
716222db
MN
389
390 if (s->bpp_tab_size)
391 add_entry(s, TIFF_BPP, TIFF_SHORT, s->bpp_tab_size, bpp_tab);
392
0a7a33d2 393 add_entry1(s,TIFF_COMPR, TIFF_SHORT, s->compr);
e780e99e 394 add_entry1(s,TIFF_INVERT, TIFF_SHORT, s->photometric_interpretation);
716222db
MN
395 add_entry(s, TIFF_STRIP_OFFS, TIFF_LONG, strips, strip_offsets);
396
397 if (s->bpp_tab_size)
0a7a33d2 398 add_entry1(s,TIFF_SAMPLES_PER_PIXEL, TIFF_SHORT, s->bpp_tab_size);
716222db 399
0a7a33d2 400 add_entry1(s,TIFF_ROWSPERSTRIP, TIFF_LONG, s->rps);
716222db
MN
401 add_entry(s, TIFF_STRIP_SIZE, TIFF_LONG, strips, strip_sizes);
402 add_entry(s, TIFF_XRES, TIFF_RATIONAL, 1, res);
403 add_entry(s, TIFF_YRES, TIFF_RATIONAL, 1, res);
0a7a33d2 404 add_entry1(s,TIFF_RES_UNIT, TIFF_SHORT, 2);
716222db
MN
405 add_entry(s, TIFF_SOFTWARE_NAME, TIFF_STRING,
406 strlen(LIBAVCODEC_IDENT) + 1, LIBAVCODEC_IDENT);
407
408 if (avctx->pix_fmt == PIX_FMT_PAL8) {
409 uint16_t pal[256 * 3];
410 for (i = 0; i < 256; i++) {
411 uint32_t rgb = *(uint32_t *) (p->data[1] + i * 4);
412 pal[i] = ((rgb >> 16) & 0xff) * 257;
413 pal[i + 256] = ((rgb >> 8 ) & 0xff) * 257;
414 pal[i + 512] = ( rgb & 0xff) * 257;
415 }
416 add_entry(s, TIFF_PAL, TIFF_SHORT, 256 * 3, pal);
417 }
f4d47d6b
KN
418 if (is_yuv){
419 /** according to CCIR Recommendation 601.1 */
420 uint32_t refbw[12] = {15, 1, 235, 1, 128, 1, 240, 1, 128, 1, 240, 1};
421 add_entry(s, TIFF_YCBCR_SUBSAMPLING, TIFF_SHORT, 2, s->subsampling);
422 add_entry(s, TIFF_REFERENCE_BW, TIFF_RATIONAL, 6, refbw);
423 }
716222db
MN
424 bytestream_put_le32(&offset, ptr - buf); // write offset to dir
425
426 if (check_size(s, 6 + s->num_entries * 12))
427 goto fail;
428 bytestream_put_le16(&ptr, s->num_entries); // write tag count
429 bytestream_put_buffer(&ptr, s->entries, s->num_entries * 12);
430 bytestream_put_le32(&ptr, 0);
431
432 ret = ptr - buf;
433
434fail:
435 av_free(strip_sizes);
436 av_free(strip_offsets);
f4d47d6b 437 av_free(yuv_line);
716222db
MN
438 return ret;
439}
440
441AVCodec tiff_encoder = {
442 "tiff",
443 CODEC_TYPE_VIDEO,
444 CODEC_ID_TIFF,
445 sizeof(TiffEncoderContext),
446 NULL,
447 encode_frame,
448 NULL,
449 NULL,
450 0,
451 NULL,
452 .pix_fmts =
453 (enum PixelFormat[]) {PIX_FMT_RGB24, PIX_FMT_PAL8, PIX_FMT_GRAY8,
454 PIX_FMT_MONOBLACK, PIX_FMT_MONOWHITE,
f4d47d6b
KN
455 PIX_FMT_YUV420P, PIX_FMT_YUV422P,
456 PIX_FMT_YUV444P, PIX_FMT_YUV410P,
457 PIX_FMT_YUV411P
716222db
MN
458 -1}
459
460};