Remove explicit filename from Doxygen @file commands.
[ffmpeg.git] / libavcodec / iff.c
1 /*
2  * IFF PBM/ILBM bitmap decoder
3  * Copyright (c) 2010 Peter Ross <pross@xvid.org>
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 /**
23  * @file
24  * IFF PBM/ILBM bitmap decoder
25  */
26
27 #include "bytestream.h"
28 #include "avcodec.h"
29 #include "get_bits.h"
30 #include "iff.h"
31
32 typedef struct {
33     AVFrame frame;
34     int planesize;
35     uint8_t * planebuf;
36 } IffContext;
37
38 /**
39  * Convert CMAP buffer (stored in extradata) to lavc palette format
40  */
41 int ff_cmap_read_palette(AVCodecContext *avctx, uint32_t *pal)
42 {
43     int count, i;
44
45     if (avctx->bits_per_coded_sample > 8) {
46         av_log(avctx, AV_LOG_ERROR, "bit_per_coded_sample > 8 not supported\n");
47         return AVERROR_INVALIDDATA;
48     }
49
50     count = 1 << avctx->bits_per_coded_sample;
51     if (avctx->extradata_size < count * 3) {
52         av_log(avctx, AV_LOG_ERROR, "palette data underflow\n");
53         return AVERROR_INVALIDDATA;
54     }
55     for (i=0; i < count; i++) {
56         pal[i] = 0xFF000000 | AV_RB24( avctx->extradata + i*3 );
57     }
58     return 0;
59 }
60
61 static av_cold int decode_init(AVCodecContext *avctx)
62 {
63     IffContext *s = avctx->priv_data;
64     int err;
65
66     if (avctx->bits_per_coded_sample <= 8) {
67         avctx->pix_fmt = PIX_FMT_PAL8;
68     } else if (avctx->bits_per_coded_sample <= 32) {
69         avctx->pix_fmt = PIX_FMT_BGR32;
70     } else {
71         return AVERROR_INVALIDDATA;
72     }
73
74     s->planesize = avctx->width / 8;
75     s->planebuf = av_malloc(s->planesize + FF_INPUT_BUFFER_PADDING_SIZE);
76     if (!s->planebuf)
77         return AVERROR(ENOMEM);
78
79     s->frame.reference = 1;
80     if ((err = avctx->get_buffer(avctx, &s->frame) < 0)) {
81         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
82         return err;
83     }
84
85     return avctx->bits_per_coded_sample <= 8 ?
86        ff_cmap_read_palette(avctx, (uint32_t*)s->frame.data[1]) : 0;
87 }
88
89 /**
90  * Decode interleaved plane buffer
91  * @param dst Destination buffer
92  * @param buf Source buffer
93  * @param buf_size
94  * @param bps bits_per_coded_sample
95  * @param plane plane number to decode as
96  */
97 #define DECLARE_DECODEPLANE(suffix, type) \
98 static void decodeplane##suffix(void *dst, const uint8_t *const buf, int buf_size, int bps, int plane) \
99 { \
100     GetBitContext gb; \
101     int i, b; \
102     init_get_bits(&gb, buf, buf_size * 8); \
103     for(i = 0; i < (buf_size * 8 + bps - 1) / bps; i++) { \
104         for (b = 0; b < bps; b++) { \
105             ((type *)dst)[ i*bps + b ] |= get_bits1(&gb) << plane; \
106         } \
107     } \
108 }
109 DECLARE_DECODEPLANE(8, uint8_t)
110 DECLARE_DECODEPLANE(32, uint32_t)
111
112 static int decode_frame_ilbm(AVCodecContext *avctx,
113                             void *data, int *data_size,
114                             AVPacket *avpkt)
115 {
116     IffContext *s = avctx->priv_data;
117     const uint8_t *buf = avpkt->data;
118     int buf_size = avpkt->size;
119     const uint8_t *buf_end = buf+buf_size;
120     int y, plane;
121
122     if (avctx->reget_buffer(avctx, &s->frame) < 0){
123         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
124         return -1;
125     }
126
127     for(y = 0; y < avctx->height; y++ ) {
128         uint8_t *row = &s->frame.data[0][ y*s->frame.linesize[0] ];
129         memset(row, 0, avctx->pix_fmt == PIX_FMT_PAL8 ? avctx->width : (avctx->width * 4));
130         for (plane = 0; plane < avctx->bits_per_coded_sample && buf < buf_end; plane++) {
131             if (avctx->pix_fmt == PIX_FMT_PAL8) {
132                 decodeplane8(row, buf, FFMIN(s->planesize, buf_end - buf), avctx->bits_per_coded_sample, plane);
133             } else { // PIX_FMT_BGR32
134                 decodeplane32(row, buf, FFMIN(s->planesize, buf_end - buf), avctx->bits_per_coded_sample, plane);
135             }
136             buf += s->planesize;
137         }
138     }
139
140     *data_size = sizeof(AVFrame);
141     *(AVFrame*)data = s->frame;
142     return buf_size;
143 }
144
145 static int decode_frame_byterun1(AVCodecContext *avctx,
146                             void *data, int *data_size,
147                             AVPacket *avpkt)
148 {
149     IffContext *s = avctx->priv_data;
150     const uint8_t *buf = avpkt->data;
151     int buf_size = avpkt->size;
152     const uint8_t *buf_end = buf+buf_size;
153     int y, plane, x;
154
155     if (avctx->reget_buffer(avctx, &s->frame) < 0){
156         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
157         return -1;
158     }
159
160     for(y = 0; y < avctx->height ; y++ ) {
161         uint8_t *row = &s->frame.data[0][ y*s->frame.linesize[0] ];
162         if (avctx->codec_tag == MKTAG('I','L','B','M')) { //interleaved
163             memset(row, 0, avctx->pix_fmt == PIX_FMT_PAL8 ? avctx->width : (avctx->width * 4));
164             for (plane = 0; plane < avctx->bits_per_coded_sample; plane++) {
165                 for(x = 0; x < s->planesize && buf < buf_end; ) {
166                     int8_t value = *buf++;
167                     int length;
168                     if (value >= 0) {
169                         length = value + 1;
170                         memcpy(s->planebuf + x, buf, FFMIN3(length, s->planesize - x, buf_end - buf));
171                         buf += length;
172                     } else if (value > -128) {
173                         length = -value + 1;
174                         memset(s->planebuf + x, *buf++, FFMIN(length, s->planesize - x));
175                     } else { //noop
176                         continue;
177                     }
178                     x += length;
179                 }
180                 if (avctx->pix_fmt == PIX_FMT_PAL8) {
181                     decodeplane8(row, s->planebuf, s->planesize, avctx->bits_per_coded_sample, plane);
182                 } else { //PIX_FMT_BGR32
183                     decodeplane32(row, s->planebuf, s->planesize, avctx->bits_per_coded_sample, plane);
184                 }
185             }
186         } else {
187             for(x = 0; x < avctx->width && buf < buf_end; ) {
188                 int8_t value = *buf++;
189                 int length;
190                 if (value >= 0) {
191                     length = value + 1;
192                     memcpy(row + x, buf, FFMIN3(length, buf_end - buf, avctx->width - x));
193                     buf += length;
194                 } else if (value > -128) {
195                     length = -value + 1;
196                     memset(row + x, *buf++, FFMIN(length, avctx->width - x));
197                 } else { //noop
198                     continue;
199                 }
200                 x += length;
201             }
202         }
203     }
204
205     *data_size = sizeof(AVFrame);
206     *(AVFrame*)data = s->frame;
207     return buf_size;
208 }
209
210 static av_cold int decode_end(AVCodecContext *avctx)
211 {
212     IffContext *s = avctx->priv_data;
213     if (s->frame.data[0])
214         avctx->release_buffer(avctx, &s->frame);
215     av_freep(&s->planebuf);
216     return 0;
217 }
218
219 AVCodec iff_ilbm_decoder = {
220     "iff_ilbm",
221     AVMEDIA_TYPE_VIDEO,
222     CODEC_ID_IFF_ILBM,
223     sizeof(IffContext),
224     decode_init,
225     NULL,
226     decode_end,
227     decode_frame_ilbm,
228     CODEC_CAP_DR1,
229     .long_name = NULL_IF_CONFIG_SMALL("IFF ILBM"),
230 };
231
232 AVCodec iff_byterun1_decoder = {
233     "iff_byterun1",
234     AVMEDIA_TYPE_VIDEO,
235     CODEC_ID_IFF_BYTERUN1,
236     sizeof(IffContext),
237     decode_init,
238     NULL,
239     decode_end,
240     decode_frame_byterun1,
241     CODEC_CAP_DR1,
242     .long_name = NULL_IF_CONFIG_SMALL("IFF ByteRun1"),
243 };