x86: proresdsp: improve SIGNEXTEND macro comments
[ffmpeg.git] / libavcodec / 8bps.c
1 /*
2  * Quicktime Planar RGB (8BPS) Video Decoder
3  * Copyright (C) 2003 Roberto Togni
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  * QT 8BPS Video Decoder by Roberto Togni
25  * For more information about the 8BPS format, visit:
26  *   http://www.pcisys.net/~melanson/codecs/
27  *
28  * Supports: PAL8 (RGB 8bpp, paletted)
29  *         : BGR24 (RGB 24bpp) (can also output it as RGB32)
30  *         : RGB32 (RGB 32bpp, 4th plane is probably alpha and it's ignored)
31  *
32  */
33
34 #include <stdio.h>
35 #include <stdlib.h>
36
37 #include "libavutil/intreadwrite.h"
38 #include "avcodec.h"
39
40
41 static const enum PixelFormat pixfmt_rgb24[] = {
42     PIX_FMT_BGR24, PIX_FMT_RGB32, PIX_FMT_NONE };
43
44 /*
45  * Decoder context
46  */
47 typedef struct EightBpsContext {
48     AVCodecContext *avctx;
49     AVFrame pic;
50
51     unsigned char planes;
52     unsigned char planemap[4];
53
54     uint32_t pal[256];
55 } EightBpsContext;
56
57
58 /*
59  *
60  * Decode a frame
61  *
62  */
63 static int decode_frame(AVCodecContext *avctx, void *data,
64                         int *data_size, AVPacket *avpkt)
65 {
66     const uint8_t *buf = avpkt->data;
67     int buf_size       = avpkt->size;
68     EightBpsContext * const c = avctx->priv_data;
69     const unsigned char *encoded = buf;
70     unsigned char *pixptr, *pixptr_end;
71     unsigned int height = avctx->height; // Real image height
72     unsigned int dlen, p, row;
73     const unsigned char *lp, *dp;
74     unsigned char count;
75     unsigned int px_inc;
76     unsigned int planes     = c->planes;
77     unsigned char *planemap = c->planemap;
78
79     if (c->pic.data[0])
80         avctx->release_buffer(avctx, &c->pic);
81
82     c->pic.reference    = 0;
83     c->pic.buffer_hints = FF_BUFFER_HINTS_VALID;
84     if (avctx->get_buffer(avctx, &c->pic) < 0){
85         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
86         return -1;
87     }
88
89     /* Set data pointer after line lengths */
90     dp = encoded + planes * (height << 1);
91
92     /* Ignore alpha plane, don't know what to do with it */
93     if (planes == 4)
94         planes--;
95
96     px_inc = planes + (avctx->pix_fmt == PIX_FMT_RGB32);
97
98     for (p = 0; p < planes; p++) {
99         /* Lines length pointer for this plane */
100         lp = encoded + p * (height << 1);
101
102         /* Decode a plane */
103         for (row = 0; row < height; row++) {
104             pixptr = c->pic.data[0] + row * c->pic.linesize[0] + planemap[p];
105             pixptr_end = pixptr + c->pic.linesize[0];
106             dlen = av_be2ne16(*(const unsigned short *)(lp + row * 2));
107             /* Decode a row of this plane */
108             while (dlen > 0) {
109                 if (dp + 1 >= buf + buf_size)
110                     return -1;
111                 if ((count = *dp++) <= 127) {
112                     count++;
113                     dlen -= count + 1;
114                     if (pixptr + count * px_inc > pixptr_end)
115                         break;
116                     if (dp + count > buf + buf_size)
117                         return -1;
118                     while (count--) {
119                         *pixptr = *dp++;
120                         pixptr += px_inc;
121                     }
122                 } else {
123                     count = 257 - count;
124                     if (pixptr + count * px_inc > pixptr_end)
125                         break;
126                     while (count--) {
127                         *pixptr = *dp;
128                         pixptr += px_inc;
129                     }
130                     dp++;
131                     dlen -= 2;
132                 }
133             }
134         }
135     }
136
137     if (avctx->bits_per_coded_sample <= 8) {
138         const uint8_t *pal = av_packet_get_side_data(avpkt,
139                                                      AV_PKT_DATA_PALETTE,
140                                                      NULL);
141         if (pal) {
142             c->pic.palette_has_changed = 1;
143             memcpy(c->pal, pal, AVPALETTE_SIZE);
144         }
145
146         memcpy (c->pic.data[1], c->pal, AVPALETTE_SIZE);
147     }
148
149     *data_size = sizeof(AVFrame);
150     *(AVFrame*)data = c->pic;
151
152     /* always report that the buffer was completely consumed */
153     return buf_size;
154 }
155
156
157 /*
158  *
159  * Init 8BPS decoder
160  *
161  */
162 static av_cold int decode_init(AVCodecContext *avctx)
163 {
164     EightBpsContext * const c = avctx->priv_data;
165
166     c->avctx       = avctx;
167     c->pic.data[0] = NULL;
168
169     switch (avctx->bits_per_coded_sample) {
170     case 8:
171         avctx->pix_fmt = PIX_FMT_PAL8;
172         c->planes      = 1;
173         c->planemap[0] = 0; // 1st plane is palette indexes
174         break;
175     case 24:
176         avctx->pix_fmt = avctx->get_format(avctx, pixfmt_rgb24);
177         c->planes      = 3;
178         c->planemap[0] = 2; // 1st plane is red
179         c->planemap[1] = 1; // 2nd plane is green
180         c->planemap[2] = 0; // 3rd plane is blue
181         break;
182     case 32:
183         avctx->pix_fmt = PIX_FMT_RGB32;
184         c->planes      = 4;
185 #if HAVE_BIGENDIAN
186         c->planemap[0] = 1; // 1st plane is red
187         c->planemap[1] = 2; // 2nd plane is green
188         c->planemap[2] = 3; // 3rd plane is blue
189         c->planemap[3] = 0; // 4th plane is alpha???
190 #else
191         c->planemap[0] = 2; // 1st plane is red
192         c->planemap[1] = 1; // 2nd plane is green
193         c->planemap[2] = 0; // 3rd plane is blue
194         c->planemap[3] = 3; // 4th plane is alpha???
195 #endif
196         break;
197     default:
198         av_log(avctx, AV_LOG_ERROR, "Error: Unsupported color depth: %u.\n",
199                avctx->bits_per_coded_sample);
200         return -1;
201     }
202
203     return 0;
204 }
205
206
207
208
209 /*
210  *
211  * Uninit 8BPS decoder
212  *
213  */
214 static av_cold int decode_end(AVCodecContext *avctx)
215 {
216     EightBpsContext * const c = avctx->priv_data;
217
218     if (c->pic.data[0])
219         avctx->release_buffer(avctx, &c->pic);
220
221     return 0;
222 }
223
224
225
226 AVCodec ff_eightbps_decoder = {
227     .name           = "8bps",
228     .type           = AVMEDIA_TYPE_VIDEO,
229     .id             = CODEC_ID_8BPS,
230     .priv_data_size = sizeof(EightBpsContext),
231     .init           = decode_init,
232     .close          = decode_end,
233     .decode         = decode_frame,
234     .capabilities   = CODEC_CAP_DR1,
235     .long_name      = NULL_IF_CONFIG_SMALL("QuickTime 8BPS video"),
236 };