targa: support 2-way and 4-way interleaved files
[ffmpeg.git] / libavcodec / targa.c
1 /*
2  * Targa (.tga) image decoder
3  * Copyright (c) 2006 Konstantin Shishkov
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 "libavutil/intreadwrite.h"
23 #include "libavutil/imgutils.h"
24 #include "avcodec.h"
25 #include "bytestream.h"
26 #include "targa.h"
27
28 typedef struct TargaContext {
29     AVFrame picture;
30     GetByteContext gb;
31
32     int color_type;
33     int compression_type;
34 } TargaContext;
35
36 static uint8_t *advance_line(uint8_t *start, uint8_t *line,
37                              int stride, int *y, int h, int interleave)
38 {
39     *y += interleave;
40
41     if (*y < h) {
42         return line + interleave * stride;
43     } else {
44         *y = (*y + 1) & (interleave - 1);
45         if (*y) {
46             return start + *y * stride;
47         } else {
48             return NULL;
49         }
50     }
51 }
52
53 static int targa_decode_rle(AVCodecContext *avctx, TargaContext *s,
54                             uint8_t *start, int w, int h, int stride,
55                             int bpp, int interleave)
56 {
57     int x, y;
58     int depth = (bpp + 1) >> 3;
59     int type, count;
60     uint8_t *line = start;
61     uint8_t *dst  = line;
62
63     x = y = count = 0;
64     while (dst) {
65         if (bytestream2_get_bytes_left(&s->gb) <= 0) {
66             av_log(avctx, AV_LOG_ERROR,
67                    "Ran ouf of data before end-of-image\n");
68             return AVERROR_INVALIDDATA;
69         }
70         type  = bytestream2_get_byteu(&s->gb);
71         count = (type & 0x7F) + 1;
72         type &= 0x80;
73         if (!type) {
74             do {
75                 int n  = FFMIN(count, w - x);
76                 bytestream2_get_buffer(&s->gb, dst, n * depth);
77                 count -= n;
78                 dst   += n * depth;
79                 x     += n;
80                 if (x == w) {
81                     x    = 0;
82                     dst = line = advance_line(start, line, stride, &y, h, interleave);
83                 }
84             } while (dst && count > 0);
85         } else {
86             uint8_t tmp[4];
87             bytestream2_get_buffer(&s->gb, tmp, depth);
88             do {
89                 int n  = FFMIN(count, w - x);
90                 count -= n;
91                 x     += n;
92                 do {
93                     memcpy(dst, tmp, depth);
94                     dst += depth;
95                 } while (--n);
96                 if (x == w) {
97                     x    = 0;
98                     dst = line = advance_line(start, line, stride, &y, h, interleave);
99                 }
100             } while (dst && count > 0);
101         }
102     }
103
104     if(count) {
105         av_log(avctx, AV_LOG_ERROR, "Packet went out of bounds\n");
106         return AVERROR_INVALIDDATA;
107     }
108
109     return 0;
110 }
111
112 static int decode_frame(AVCodecContext *avctx,
113                         void *data, int *data_size,
114                         AVPacket *avpkt)
115 {
116     TargaContext * const s = avctx->priv_data;
117     AVFrame *picture = data;
118     AVFrame * const p = &s->picture;
119     uint8_t *dst;
120     int stride;
121     int idlen, pal, compr, y, w, h, bpp, flags;
122     int first_clr, colors, csize;
123     int interleave;
124
125     bytestream2_init(&s->gb, avpkt->data, avpkt->size);
126
127     /* parse image header */
128     idlen     = bytestream2_get_byte(&s->gb);
129     pal       = bytestream2_get_byte(&s->gb);
130     compr     = bytestream2_get_byte(&s->gb);
131     first_clr = bytestream2_get_le16(&s->gb);
132     colors    = bytestream2_get_le16(&s->gb);
133     csize     = bytestream2_get_byte(&s->gb);
134     bytestream2_skip(&s->gb, 4); /* 2: x, 2: y */
135     w         = bytestream2_get_le16(&s->gb);
136     h         = bytestream2_get_le16(&s->gb);
137     bpp       = bytestream2_get_byte(&s->gb);
138
139     if (bytestream2_get_bytes_left(&s->gb) <= idlen) {
140         av_log(avctx, AV_LOG_ERROR,
141                 "Not enough data to read header\n");
142         return AVERROR_INVALIDDATA;
143     }
144
145     flags     = bytestream2_get_byte(&s->gb);
146
147     if (!pal && (first_clr || colors || csize)) {
148         av_log(avctx, AV_LOG_WARNING, "File without colormap has colormap information set.\n");
149         // specification says we should ignore those value in this case
150         first_clr = colors = csize = 0;
151     }
152
153     // skip identifier if any
154     bytestream2_skip(&s->gb, idlen);
155
156     switch(bpp){
157     case 8:
158         avctx->pix_fmt = ((compr & (~TGA_RLE)) == TGA_BW) ? AV_PIX_FMT_GRAY8 : AV_PIX_FMT_PAL8;
159         break;
160     case 15:
161     case 16:
162         avctx->pix_fmt = AV_PIX_FMT_RGB555LE;
163         break;
164     case 24:
165         avctx->pix_fmt = AV_PIX_FMT_BGR24;
166         break;
167     case 32:
168         avctx->pix_fmt = AV_PIX_FMT_BGRA;
169         break;
170     default:
171         av_log(avctx, AV_LOG_ERROR, "Bit depth %i is not supported\n", bpp);
172         return -1;
173     }
174
175     if(s->picture.data[0])
176         avctx->release_buffer(avctx, &s->picture);
177
178     if(av_image_check_size(w, h, 0, avctx))
179         return -1;
180     if(w != avctx->width || h != avctx->height)
181         avcodec_set_dimensions(avctx, w, h);
182     if(avctx->get_buffer(avctx, p) < 0){
183         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
184         return -1;
185     }
186     if(flags & TGA_TOPTOBOTTOM) {
187         dst = p->data[0];
188         stride = p->linesize[0];
189     }else{ //image is upside-down
190         dst = p->data[0] + p->linesize[0] * (h - 1);
191         stride = -p->linesize[0];
192     }
193
194     interleave = flags & TGA_INTERLEAVE2 ? 2 :
195                  flags & TGA_INTERLEAVE4 ? 4 : 1;
196
197     if(colors){
198         int pal_size, pal_sample_size;
199         if((colors + first_clr) > 256){
200             av_log(avctx, AV_LOG_ERROR, "Incorrect palette: %i colors with offset %i\n", colors, first_clr);
201             return -1;
202         }
203         switch (csize) {
204         case 32: pal_sample_size = 4; break;
205         case 24: pal_sample_size = 3; break;
206         case 16:
207         case 15: pal_sample_size = 2; break;
208         default:
209             av_log(avctx, AV_LOG_ERROR, "Palette entry size %i bits is not supported\n", csize);
210             return -1;
211         }
212         pal_size = colors * pal_sample_size;
213         if(avctx->pix_fmt != AV_PIX_FMT_PAL8)//should not occur but skip palette anyway
214             bytestream2_skip(&s->gb, pal_size);
215         else{
216             int t;
217             uint32_t *pal = ((uint32_t *)p->data[1]) + first_clr;
218
219             if (bytestream2_get_bytes_left(&s->gb) < pal_size) {
220                 av_log(avctx, AV_LOG_ERROR,
221                        "Not enough data to read palette\n");
222                 return AVERROR_INVALIDDATA;
223             }
224             switch (pal_sample_size) {
225             case 4:
226                 for (t = 0; t < colors; t++)
227                     *pal++ = bytestream2_get_le32u(&s->gb);
228                 break;
229             case 3:
230                 /* RGB24 */
231                 for (t = 0; t < colors; t++)
232                     *pal++ = (0xffU<<24) | bytestream2_get_le24u(&s->gb);
233                 break;
234             case 2:
235                 /* RGB555 */
236                 for (t = 0; t < colors; t++) {
237                     uint32_t v = bytestream2_get_le16u(&s->gb);
238                     v = ((v & 0x7C00) <<  9) |
239                         ((v & 0x03E0) <<  6) |
240                         ((v & 0x001F) <<  3);
241                     /* left bit replication */
242                     v |= (v & 0xE0E0E0U) >> 5;
243                     *pal++ = (0xffU<<24) | v;
244                 }
245                 break;
246             }
247             p->palette_has_changed = 1;
248         }
249     }
250     if ((compr & (~TGA_RLE)) == TGA_NODATA) {
251         memset(p->data[0], 0, p->linesize[0] * h);
252     } else {
253         if(compr & TGA_RLE){
254             int res = targa_decode_rle(avctx, s, dst, w, h, stride, bpp, interleave);
255             if (res < 0)
256                 return res;
257         } else {
258             size_t img_size = w * ((bpp + 1) >> 3);
259             uint8_t *line;
260             if (bytestream2_get_bytes_left(&s->gb) < img_size * h) {
261                 av_log(avctx, AV_LOG_ERROR,
262                        "Not enough data available for image\n");
263                 return AVERROR_INVALIDDATA;
264             }
265
266             line = dst;
267             y = 0;
268             do {
269                 bytestream2_get_bufferu(&s->gb, line, img_size);
270                 line = advance_line(dst, line, stride, &y, h, interleave);
271             } while (line);
272         }
273     }
274     if(flags & TGA_RIGHTTOLEFT) { // right-to-left, needs horizontal flip
275         int x;
276         for(y = 0; y < h; y++){
277             void *line = &p->data[0][y * p->linesize[0]];
278             for(x = 0; x < w >> 1; x++){
279                 switch(bpp){
280                 case 32:
281                     FFSWAP(uint32_t, ((uint32_t *)line)[x], ((uint32_t *)line)[w - x - 1]);
282                     break;
283                 case 24:
284                     FFSWAP(uint8_t, ((uint8_t *)line)[3 * x    ], ((uint8_t *)line)[3 * w - 3 * x - 3]);
285                     FFSWAP(uint8_t, ((uint8_t *)line)[3 * x + 1], ((uint8_t *)line)[3 * w - 3 * x - 2]);
286                     FFSWAP(uint8_t, ((uint8_t *)line)[3 * x + 2], ((uint8_t *)line)[3 * w - 3 * x - 1]);
287                     break;
288                 case 16:
289                     FFSWAP(uint16_t, ((uint16_t *)line)[x], ((uint16_t *)line)[w - x - 1]);
290                     break;
291                 case 8:
292                     FFSWAP(uint8_t, ((uint8_t *)line)[x], ((uint8_t *)line)[w - x - 1]);
293                 }
294             }
295         }
296     }
297
298     *picture   = s->picture;
299     *data_size = sizeof(AVPicture);
300
301     return avpkt->size;
302 }
303
304 static av_cold int targa_init(AVCodecContext *avctx){
305     TargaContext *s = avctx->priv_data;
306
307     avcodec_get_frame_defaults(&s->picture);
308     avctx->coded_frame = &s->picture;
309
310     return 0;
311 }
312
313 static av_cold int targa_end(AVCodecContext *avctx){
314     TargaContext *s = avctx->priv_data;
315
316     if(s->picture.data[0])
317         avctx->release_buffer(avctx, &s->picture);
318
319     return 0;
320 }
321
322 AVCodec ff_targa_decoder = {
323     .name           = "targa",
324     .type           = AVMEDIA_TYPE_VIDEO,
325     .id             = AV_CODEC_ID_TARGA,
326     .priv_data_size = sizeof(TargaContext),
327     .init           = targa_init,
328     .close          = targa_end,
329     .decode         = decode_frame,
330     .capabilities   = CODEC_CAP_DR1,
331     .long_name      = NULL_IF_CONFIG_SMALL("Truevision Targa image"),
332 };