x86: proresdsp: improve SIGNEXTEND macro comments
[ffmpeg.git] / libavcodec / tiffenc.c
1 /*
2  * TIFF image encoder
3  * Copyright (c) 2007 Bartlomiej Wolowiec
4  *
5  * This file is part of Libav.
6  *
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.
11  *
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.
16  *
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
20  */
21
22 /**
23  * @file
24  * TIFF image encoder
25  * @author Bartlomiej Wolowiec
26  */
27
28 #include "libavutil/log.h"
29 #include "libavutil/opt.h"
30
31 #include "avcodec.h"
32 #if CONFIG_ZLIB
33 #include <zlib.h>
34 #endif
35 #include "bytestream.h"
36 #include "tiff.h"
37 #include "rle.h"
38 #include "lzw.h"
39 #include "put_bits.h"
40
41 #define TIFF_MAX_ENTRY 32
42
43 /** sizes of various TIFF field types (string size = 1)*/
44 static const uint8_t type_sizes2[6] = {
45     0, 1, 1, 2, 4, 8
46 };
47
48 typedef struct TiffEncoderContext {
49     AVClass *class;                     ///< for private options
50     AVCodecContext *avctx;
51     AVFrame picture;
52
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
68 } TiffEncoderContext;
69
70
71 /**
72  * Check free space in buffer
73  * @param s Tiff context
74  * @param need Needed bytes
75  * @return 0 - ok, 1 - no free space
76  */
77 static inline int check_size(TiffEncoderContext * s, uint64_t need)
78 {
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");
82         return 1;
83     }
84     return 0;
85 }
86
87 /**
88  * Put n values to buffer
89  *
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
95  */
96 static void tnput(uint8_t ** p, int n, const uint8_t * val, enum TiffTypes type,
97                   int flip)
98 {
99     int i;
100 #if HAVE_BIGENDIAN
101     flip ^= ((int[]) {0, 0, 0, 1, 3, 3})[type];
102 #endif
103     for (i = 0; i < n * type_sizes2[type]; i++)
104         *(*p)++ = val[i ^ flip];
105 }
106
107 /**
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
114  */
115 static void add_entry(TiffEncoderContext * s,
116                       enum TiffTags tag, enum TiffTypes type, int count,
117                       const void *ptr_val)
118 {
119     uint8_t *entries_ptr = s->entries + 12 * s->num_entries;
120
121     assert(s->num_entries < TIFF_MAX_ENTRY);
122
123     bytestream_put_le16(&entries_ptr, tag);
124     bytestream_put_le16(&entries_ptr, type);
125     bytestream_put_le32(&entries_ptr, count);
126
127     if (type_sizes[type] * count <= 4) {
128         tnput(&entries_ptr, count, ptr_val, type, 0);
129     } else {
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);
133     }
134
135     s->num_entries++;
136 }
137
138 static void add_entry1(TiffEncoderContext * s,
139                        enum TiffTags tag, enum TiffTypes type, int val){
140     uint16_t w = val;
141     uint32_t dw= val;
142     add_entry(s, tag, type, 1, type == TIFF_SHORT ? (void *)&w : (void *)&dw);
143 }
144
145 /**
146  * Encode one strip in tiff file
147  *
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
154  */
155 static int encode_strip(TiffEncoderContext * s, const int8_t * src,
156                         uint8_t * dst, int n, int compr)
157 {
158
159     switch (compr) {
160 #if CONFIG_ZLIB
161     case TIFF_DEFLATE:
162     case TIFF_ADOBE_DEFLATE:
163         {
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");
167                 return -1;
168             }
169             return zlen;
170         }
171 #endif
172     case TIFF_RAW:
173         if (check_size(s, n))
174             return -1;
175         memcpy(dst, src, n);
176         return n;
177     case TIFF_PACKBITS:
178         return ff_rle_encode(dst, s->buf_size - (*s->buf - s->buf_start), src, 1, n, 2, 0xff, -1, 0);
179     case TIFF_LZW:
180         return ff_lzw_encode(s->lzws, src, n);
181     default:
182         return -1;
183     }
184 }
185
186 static void pack_yuv(TiffEncoderContext * s, uint8_t * dst, int lnum)
187 {
188     AVFrame *p = &s->picture;
189     int i, j, k;
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];
198         *dst++ = *pu++;
199         *dst++ = *pv++;
200     }
201 }
202
203 static int encode_frame(AVCodecContext * avctx, AVPacket *pkt,
204                         const AVFrame *pict, int *got_packet)
205 {
206     TiffEncoderContext *s = avctx->priv_data;
207     AVFrame *const p = &s->picture;
208     int i;
209     uint8_t *ptr;
210     uint8_t *offset;
211     uint32_t strips;
212     uint32_t *strip_sizes = NULL;
213     uint32_t *strip_offsets = NULL;
214     int bytes_per_row;
215     uint32_t res[2] = { 72, 1 };        // image resolution (72/1)
216     static const uint16_t bpp_tab[] = { 8, 8, 8, 8 };
217     int ret;
218     int is_yuv = 0;
219     uint8_t *yuv_line = NULL;
220     int shift_h, shift_v;
221
222     s->avctx = avctx;
223
224     *p = *pict;
225     p->pict_type = AV_PICTURE_TYPE_I;
226     p->key_frame = 1;
227     avctx->coded_frame= &s->picture;
228
229     s->width = avctx->width;
230     s->height = avctx->height;
231     s->subsampling[0] = 1;
232     s->subsampling[1] = 1;
233
234     switch (avctx->pix_fmt) {
235     case PIX_FMT_RGB24:
236         s->bpp = 24;
237         s->photometric_interpretation = 2;
238         break;
239     case PIX_FMT_GRAY8:
240         s->bpp = 8;
241         s->photometric_interpretation = 1;
242         break;
243     case PIX_FMT_PAL8:
244         s->bpp = 8;
245         s->photometric_interpretation = 3;
246         break;
247     case PIX_FMT_MONOBLACK:
248         s->bpp = 1;
249         s->photometric_interpretation = 1;
250         break;
251     case PIX_FMT_MONOWHITE:
252         s->bpp = 1;
253         s->photometric_interpretation = 0;
254         break;
255     case PIX_FMT_YUV420P:
256     case PIX_FMT_YUV422P:
257     case PIX_FMT_YUV444P:
258     case PIX_FMT_YUV410P:
259     case PIX_FMT_YUV411P:
260         s->photometric_interpretation = 6;
261         avcodec_get_chroma_sub_sample(avctx->pix_fmt,
262                 &shift_h, &shift_v);
263         s->bpp = 8 + (16 >> (shift_h + shift_v));
264         s->subsampling[0] = 1 << shift_h;
265         s->subsampling[1] = 1 << shift_v;
266         s->bpp_tab_size = 3;
267         is_yuv = 1;
268         break;
269     default:
270         av_log(s->avctx, AV_LOG_ERROR,
271                "This colors format is not supported\n");
272         return -1;
273     }
274     if (!is_yuv)
275         s->bpp_tab_size = (s->bpp >> 3);
276
277     if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE || s->compr == TIFF_LZW)
278         //best choose for DEFLATE
279         s->rps = s->height;
280     else
281         s->rps = FFMAX(8192 / (((s->width * s->bpp) >> 3) + 1), 1);     // suggest size of strip
282     s->rps = ((s->rps - 1) / s->subsampling[1] + 1) * s->subsampling[1]; // round rps up
283
284     strips = (s->height - 1) / s->rps + 1;
285
286     if (!pkt->data &&
287         (ret = av_new_packet(pkt, avctx->width * avctx->height * s->bpp * 2 +
288                                   avctx->height * 4 + FF_MIN_BUFFER_SIZE)) < 0) {
289         av_log(avctx, AV_LOG_ERROR, "Error getting output packet.\n");
290         return ret;
291     }
292     ptr          = pkt->data;
293     s->buf_start = pkt->data;
294     s->buf       = &ptr;
295     s->buf_size  = pkt->size;
296
297     if (check_size(s, 8))
298         goto fail;
299
300     // write header
301     bytestream_put_le16(&ptr, 0x4949);
302     bytestream_put_le16(&ptr, 42);
303
304     offset = ptr;
305     bytestream_put_le32(&ptr, 0);
306
307     strip_sizes = av_mallocz(sizeof(*strip_sizes) * strips);
308     strip_offsets = av_mallocz(sizeof(*strip_offsets) * strips);
309
310     bytes_per_row = (((s->width - 1)/s->subsampling[0] + 1) * s->bpp
311                     * s->subsampling[0] * s->subsampling[1] + 7) >> 3;
312     if (is_yuv){
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");
316             goto fail;
317         }
318     }
319
320 #if CONFIG_ZLIB
321     if (s->compr == TIFF_DEFLATE || s->compr == TIFF_ADOBE_DEFLATE) {
322         uint8_t *zbuf;
323         int zlen, zn;
324         int j;
325
326         zlen = bytes_per_row * s->rps;
327         zbuf = av_malloc(zlen);
328         strip_offsets[0] = ptr - pkt->data;
329         zn = 0;
330         for (j = 0; j < s->rps; j++) {
331             if (is_yuv){
332                 pack_yuv(s, yuv_line, j);
333                 memcpy(zbuf + zn, yuv_line, bytes_per_row);
334                 j += s->subsampling[1] - 1;
335             }
336             else
337                 memcpy(zbuf + j * bytes_per_row,
338                        p->data[0] + j * p->linesize[0], bytes_per_row);
339             zn += bytes_per_row;
340         }
341         ret = encode_strip(s, zbuf, ptr, zn, s->compr);
342         av_free(zbuf);
343         if (ret < 0) {
344             av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
345             goto fail;
346         }
347         ptr += ret;
348         strip_sizes[0] = ptr - pkt->data - strip_offsets[0];
349     } else
350 #endif
351     {
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);
359                 }
360                 strip_offsets[i / s->rps] = ptr - pkt->data;
361             }
362             if (is_yuv){
363                  pack_yuv(s, yuv_line, i);
364                  ret = encode_strip(s, yuv_line, ptr, bytes_per_row, s->compr);
365                  i += s->subsampling[1] - 1;
366             }
367             else
368                 ret = encode_strip(s, p->data[0] + i * p->linesize[0],
369                         ptr, bytes_per_row, s->compr);
370             if (ret < 0) {
371                 av_log(s->avctx, AV_LOG_ERROR, "Encode strip failed\n");
372                 goto fail;
373             }
374             strip_sizes[i / s->rps] += ret;
375             ptr += ret;
376             if(s->compr == TIFF_LZW && (i==s->height-1 || i%s->rps == s->rps-1)){
377                 ret = ff_lzw_encode_flush(s->lzws, flush_put_bits);
378                 strip_sizes[(i / s->rps )] += ret ;
379                 ptr += ret;
380             }
381         }
382         if(s->compr == TIFF_LZW)
383             av_free(s->lzws);
384     }
385
386     s->num_entries = 0;
387
388     add_entry1(s,TIFF_SUBFILE,           TIFF_LONG,             0);
389     add_entry1(s,TIFF_WIDTH,             TIFF_LONG,             s->width);
390     add_entry1(s,TIFF_HEIGHT,            TIFF_LONG,             s->height);
391
392     if (s->bpp_tab_size)
393     add_entry(s, TIFF_BPP,               TIFF_SHORT,    s->bpp_tab_size, bpp_tab);
394
395     add_entry1(s,TIFF_COMPR,             TIFF_SHORT,            s->compr);
396     add_entry1(s,TIFF_INVERT,            TIFF_SHORT,            s->photometric_interpretation);
397     add_entry(s, TIFF_STRIP_OFFS,        TIFF_LONG,     strips, strip_offsets);
398
399     if (s->bpp_tab_size)
400     add_entry1(s,TIFF_SAMPLES_PER_PIXEL, TIFF_SHORT,            s->bpp_tab_size);
401
402     add_entry1(s,TIFF_ROWSPERSTRIP,      TIFF_LONG,             s->rps);
403     add_entry(s, TIFF_STRIP_SIZE,        TIFF_LONG,     strips, strip_sizes);
404     add_entry(s, TIFF_XRES,              TIFF_RATIONAL, 1,      res);
405     add_entry(s, TIFF_YRES,              TIFF_RATIONAL, 1,      res);
406     add_entry1(s,TIFF_RES_UNIT,          TIFF_SHORT,            2);
407
408     if(!(avctx->flags & CODEC_FLAG_BITEXACT))
409     add_entry(s, TIFF_SOFTWARE_NAME,     TIFF_STRING,
410               strlen(LIBAVCODEC_IDENT) + 1, LIBAVCODEC_IDENT);
411
412     if (avctx->pix_fmt == PIX_FMT_PAL8) {
413         uint16_t pal[256 * 3];
414         for (i = 0; i < 256; i++) {
415             uint32_t rgb = *(uint32_t *) (p->data[1] + i * 4);
416             pal[i]       = ((rgb >> 16) & 0xff) * 257;
417             pal[i + 256] = ((rgb >> 8 ) & 0xff) * 257;
418             pal[i + 512] = ( rgb        & 0xff) * 257;
419         }
420         add_entry(s, TIFF_PAL, TIFF_SHORT, 256 * 3, pal);
421     }
422     if (is_yuv){
423         /** according to CCIR Recommendation 601.1 */
424         uint32_t refbw[12] = {15, 1, 235, 1, 128, 1, 240, 1, 128, 1, 240, 1};
425         add_entry(s, TIFF_YCBCR_SUBSAMPLING, TIFF_SHORT,    2, s->subsampling);
426         add_entry(s, TIFF_REFERENCE_BW,      TIFF_RATIONAL, 6, refbw);
427     }
428     bytestream_put_le32(&offset, ptr - pkt->data);    // write offset to dir
429
430     if (check_size(s, 6 + s->num_entries * 12)) {
431         ret = AVERROR(EINVAL);
432         goto fail;
433     }
434     bytestream_put_le16(&ptr, s->num_entries);  // write tag count
435     bytestream_put_buffer(&ptr, s->entries, s->num_entries * 12);
436     bytestream_put_le32(&ptr, 0);
437
438     pkt->size   = ptr - pkt->data;
439     pkt->flags |= AV_PKT_FLAG_KEY;
440     *got_packet = 1;
441
442 fail:
443     av_free(strip_sizes);
444     av_free(strip_offsets);
445     av_free(yuv_line);
446     return ret;
447 }
448
449 #define OFFSET(x) offsetof(TiffEncoderContext, x)
450 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
451 static const AVOption options[] = {
452     { "compression_algo", NULL, OFFSET(compr), AV_OPT_TYPE_INT, {TIFF_PACKBITS}, TIFF_RAW, TIFF_DEFLATE, VE, "compression_algo" },
453     { "packbits", NULL, 0, AV_OPT_TYPE_CONST, {TIFF_PACKBITS}, 0, 0, VE, "compression_algo" },
454     { "raw",      NULL, 0, AV_OPT_TYPE_CONST, {TIFF_RAW},      0, 0, VE, "compression_algo" },
455     { "lzw",      NULL, 0, AV_OPT_TYPE_CONST, {TIFF_LZW},      0, 0, VE, "compression_algo" },
456 #if CONFIG_ZLIB
457     { "deflate",  NULL, 0, AV_OPT_TYPE_CONST, {TIFF_DEFLATE},  0, 0, VE, "compression_algo" },
458 #endif
459     { NULL },
460 };
461
462 static const AVClass tiffenc_class = {
463     .class_name = "TIFF encoder",
464     .item_name  = av_default_item_name,
465     .option     = options,
466     .version    = LIBAVUTIL_VERSION_INT,
467 };
468
469 AVCodec ff_tiff_encoder = {
470     .name           = "tiff",
471     .type           = AVMEDIA_TYPE_VIDEO,
472     .id             = CODEC_ID_TIFF,
473     .priv_data_size = sizeof(TiffEncoderContext),
474     .encode2        = encode_frame,
475     .pix_fmts       = (const enum PixelFormat[]) {
476         PIX_FMT_RGB24, PIX_FMT_PAL8, PIX_FMT_GRAY8,
477         PIX_FMT_MONOBLACK, PIX_FMT_MONOWHITE,
478         PIX_FMT_YUV420P, PIX_FMT_YUV422P, PIX_FMT_YUV444P,
479         PIX_FMT_YUV410P, PIX_FMT_YUV411P,
480         PIX_FMT_NONE
481     },
482     .long_name      = NULL_IF_CONFIG_SMALL("TIFF image"),
483     .priv_class     = &tiffenc_class,
484 };