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