Add RLE encoding support, patch by Bobby Bingham, uhmmmm gmail com.
[ffmpeg.git] / libavcodec / targaenc.c
1 /*
2  * Targa (.tga) image encoder
3  * Copyright (c) 2007 Bobby Bingham
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 #include "avcodec.h"
23
24 /**
25  * Count up to 127 consecutive pixels which are either all the same or
26  * all differ from the previous and next pixels.
27  * @param start Pointer to the first pixel
28  * @param len Maximum number of pixels
29  * @param bpp Bytes per pixel
30  * @param same 1 if searching for identical pixel values.  0 for differing
31  * @return Number of matching consecutive pixels found
32  */
33 static int count_pixels(uint8_t *start, int len, int bpp, int same)
34 {
35     uint8_t *pos;
36     int count = 1;
37
38     for(pos = start + bpp; count < FFMIN(128, len); pos += bpp, count ++) {
39         if(same != !memcmp(pos-bpp, pos, bpp)) {
40             if(!same) {
41                 /* if bpp == 1, then 0 1 1 0 is more efficiently encoded as a single
42                  * raw block of pixels.  for larger bpp, RLE is as good or better */
43                 if(bpp == 1 && count + 1 < FFMIN(128, len) && *pos != *(pos+1))
44                     continue;
45
46                 /* if RLE can encode the next block better than as a raw block,
47                  * back up and leave _all_ the identical pixels for RLE */
48                 count --;
49             }
50             break;
51         }
52     }
53
54     return count;
55 }
56
57 /**
58  * RLE compress the image, with maximum size of out_size
59  * @param outbuf Output buffer
60  * @param out_size Maximum output size
61  * @param pic Image to compress
62  * @param bpp Bytes per pixel
63  * @param w Image width
64  * @param h Image height
65  * @return Size of output in bytes, or -1 if larger than out_size
66  */
67 static int targa_encode_rle(uint8_t *outbuf, int out_size, AVFrame *pic,
68                             int bpp, int w, int h)
69 {
70     int count, x, y;
71     uint8_t *ptr, *line, *out;
72
73     out = outbuf;
74     line = pic->data[0];
75
76     for(y = 0; y < h; y ++) {
77         ptr = line;
78
79         for(x = 0; x < w; x += count) {
80             /* see if we can encode the next set of pixels with RLE */
81             if((count = count_pixels(ptr, w-x, bpp, 1)) > 1) {
82                 if(out + bpp + 1 > outbuf + out_size) return -1;
83                 *out++ = 0x80 | (count - 1);
84                 memcpy(out, ptr, bpp);
85                 out += bpp;
86             } else {
87                 /* fall back on uncompressed */
88                 count = count_pixels(ptr, w-x, bpp, 0);
89                 *out++ = count - 1;
90
91                 if(out + bpp*count > outbuf + out_size) return -1;
92                 memcpy(out, ptr, bpp * count);
93                 out += bpp * count;
94             }
95             ptr += count * bpp;
96         }
97
98         line += pic->linesize[0];
99     }
100
101     return out - outbuf;
102 }
103
104 static int targa_encode_normal(uint8_t *outbuf, AVFrame *pic, int bpp, int w, int h)
105 {
106     int i, n = bpp * w;
107     uint8_t *out = outbuf;
108     uint8_t *ptr = pic->data[0];
109
110     for(i=0; i < h; i++) {
111         memcpy(out, ptr, n);
112         out += n;
113         ptr += pic->linesize[0];
114     }
115
116     return out - outbuf;
117 }
118
119 static int targa_encode_frame(AVCodecContext *avctx,
120                               unsigned char *outbuf,
121                               int buf_size, void *data){
122     AVFrame *p = data;
123     int bpp, picsize, datasize;
124     uint8_t *out;
125
126     if(avctx->width > 0xffff || avctx->height > 0xffff) {
127         av_log(avctx, AV_LOG_ERROR, "image dimensions too large\n");
128         return -1;
129     }
130     picsize = avpicture_get_size(avctx->pix_fmt, avctx->width, avctx->height);
131     if(buf_size < picsize + 45) {
132         av_log(avctx, AV_LOG_ERROR, "encoded frame too large\n");
133         return -1;
134     }
135
136     p->pict_type= FF_I_TYPE;
137     p->key_frame= 1;
138
139     /* zero out the header and only set applicable fields */
140     memset(outbuf, 0, 11);
141     AV_WL16(outbuf+12, avctx->width);
142     AV_WL16(outbuf+14, avctx->height);
143     outbuf[17] = 0x20;           /* origin is top-left. no alpha */
144
145     /* TODO: support alpha channel */
146     switch(avctx->pix_fmt) {
147     case PIX_FMT_GRAY8:
148         outbuf[2] = 3;           /* uncompressed grayscale image */
149         outbuf[16] = 8;          /* bpp */
150         break;
151     case PIX_FMT_RGB555:
152         outbuf[2] = 2;           /* uncompresses true-color image */
153         outbuf[16] = 16;         /* bpp */
154         break;
155     case PIX_FMT_BGR24:
156         outbuf[2] = 2;           /* uncompressed true-color image */
157         outbuf[16] = 24;         /* bpp */
158         break;
159     default:
160         return -1;
161     }
162     bpp = outbuf[16] >> 3;
163
164     out = outbuf + 18;  /* skip past the header we just output */
165
166     /* try RLE compression */
167     datasize = targa_encode_rle(out, picsize, p, bpp, avctx->width, avctx->height);
168
169     /* if that worked well, mark the picture as RLE compressed */
170     if(datasize >= 0)
171         outbuf[2] |= 8;
172
173     /* if RLE didn't make it smaller, go back to no compression */
174     else datasize = targa_encode_normal(out, p, bpp, avctx->width, avctx->height);
175
176     out += datasize;
177
178     /* The standard recommends including this section, even if we don't use
179      * any of the features it affords. TODO: take advantage of the pixel
180      * aspect ratio and encoder ID fields available? */
181     memcpy(out, "\0\0\0\0\0\0\0\0TRUEVISION-XFILE.", 26);
182
183     return out + 26 - outbuf;
184 }
185
186 static int targa_encode_init(AVCodecContext *avctx)
187 {
188     return 0;
189 }
190
191 AVCodec targa_encoder = {
192     .name = "targa",
193     .type = CODEC_TYPE_VIDEO,
194     .id = CODEC_ID_TARGA,
195     .priv_data_size = 0,
196     .init = targa_encode_init,
197     .encode = targa_encode_frame,
198     .pix_fmts= (enum PixelFormat[]){PIX_FMT_BGR24, PIX_FMT_RGB555, PIX_FMT_GRAY8, -1},
199 };