03427068cdfd15ffe9c4cd67ba8cc76cef5aefed
[ffmpeg.git] / libavcodec / rpza.c
1 /*
2  * Quicktime Video (RPZA) Video Decoder
3  * Copyright (C) 2003 the ffmpeg project
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 RPZA Video Decoder by Roberto Togni
25  * For more information about the RPZA format, visit:
26  *   http://www.pcisys.net/~melanson/codecs/
27  *
28  * The RPZA decoder outputs RGB555 colorspace data.
29  *
30  * Note that this decoder reads big endian RGB555 pixel values from the
31  * bytestream, arranges them in the host's endian order, and outputs
32  * them to the final rendered map in the same host endian order. This is
33  * intended behavior as the libavcodec documentation states that RGB555
34  * pixels shall be stored in native CPU endianness.
35  */
36
37 #include <stdint.h>
38 #include <stdio.h>
39 #include <stdlib.h>
40 #include <string.h>
41
42 #include "libavutil/internal.h"
43 #include "avcodec.h"
44 #include "bytestream.h"
45 #include "internal.h"
46
47 typedef struct RpzaContext {
48
49     AVCodecContext *avctx;
50     AVFrame *frame;
51
52     GetByteContext gb;
53 } RpzaContext;
54
55 #define ADVANCE_BLOCK() \
56 { \
57     pixel_ptr += 4; \
58     if (pixel_ptr >= width) \
59     { \
60         pixel_ptr = 0; \
61         row_ptr += stride * 4; \
62     } \
63     total_blocks--; \
64     if (total_blocks < 0) \
65     { \
66         av_log(s->avctx, AV_LOG_ERROR, "warning: block counter just went negative (this should not happen)\n"); \
67         return; \
68     } \
69 }
70
71 static void rpza_decode_stream(RpzaContext *s)
72 {
73     int width = s->avctx->width;
74     int stride = s->frame->linesize[0] / 2;
75     int row_inc = stride - 4;
76     int chunk_size;
77     uint8_t opcode;
78     int n_blocks;
79     uint16_t colorA = 0, colorB;
80     uint16_t color4[4];
81     uint8_t index, idx;
82     uint16_t ta, tb;
83     uint16_t *pixels = (uint16_t *)s->frame->data[0];
84
85     int row_ptr = 0;
86     int pixel_ptr = 0;
87     int block_ptr;
88     int pixel_x, pixel_y;
89     int total_blocks;
90
91     /* First byte is always 0xe1. Warn if it's different */
92     if (bytestream2_peek_byte(&s->gb) != 0xe1)
93         av_log(s->avctx, AV_LOG_ERROR, "First chunk byte is 0x%02x instead of 0xe1\n",
94                bytestream2_peek_byte(&s->gb));
95
96     /* Get chunk size, ingnoring first byte */
97     chunk_size = bytestream2_get_be32(&s->gb) & 0x00FFFFFF;
98
99     /* If length mismatch use size from MOV file and try to decode anyway */
100     if (chunk_size != bytestream2_get_bytes_left(&s->gb) - 4)
101         av_log(s->avctx, AV_LOG_WARNING, "MOV chunk size != encoded chunk size\n");
102
103     /* Number of 4x4 blocks in frame. */
104     total_blocks = ((s->avctx->width + 3) / 4) * ((s->avctx->height + 3) / 4);
105
106     /* Process chunk data */
107     while (bytestream2_get_bytes_left(&s->gb)) {
108         opcode = bytestream2_get_byte(&s->gb); /* Get opcode */
109
110         n_blocks = (opcode & 0x1f) + 1; /* Extract block counter from opcode */
111
112         /* If opcode MSbit is 0, we need more data to decide what to do */
113         if ((opcode & 0x80) == 0) {
114             colorA = (opcode << 8) | bytestream2_get_byte(&s->gb);
115             opcode = 0;
116             if ((bytestream2_peek_byte(&s->gb) & 0x80) != 0) {
117                 /* Must behave as opcode 110xxxxx, using colorA computed
118                  * above. Use fake opcode 0x20 to enter switch block at
119                  * the right place */
120                 opcode = 0x20;
121                 n_blocks = 1;
122             }
123         }
124
125         switch (opcode & 0xe0) {
126
127         /* Skip blocks */
128         case 0x80:
129             while (n_blocks--) {
130               ADVANCE_BLOCK();
131             }
132             break;
133
134         /* Fill blocks with one color */
135         case 0xa0:
136             colorA = bytestream2_get_be16(&s->gb);
137             while (n_blocks--) {
138                 block_ptr = row_ptr + pixel_ptr;
139                 for (pixel_y = 0; pixel_y < 4; pixel_y++) {
140                     for (pixel_x = 0; pixel_x < 4; pixel_x++){
141                         pixels[block_ptr] = colorA;
142                         block_ptr++;
143                     }
144                     block_ptr += row_inc;
145                 }
146                 ADVANCE_BLOCK();
147             }
148             break;
149
150         /* Fill blocks with 4 colors */
151         case 0xc0:
152             colorA = bytestream2_get_be16(&s->gb);
153         case 0x20:
154             colorB = bytestream2_get_be16(&s->gb);
155
156             /* sort out the colors */
157             color4[0] = colorB;
158             color4[1] = 0;
159             color4[2] = 0;
160             color4[3] = colorA;
161
162             /* red components */
163             ta = (colorA >> 10) & 0x1F;
164             tb = (colorB >> 10) & 0x1F;
165             color4[1] |= ((11 * ta + 21 * tb) >> 5) << 10;
166             color4[2] |= ((21 * ta + 11 * tb) >> 5) << 10;
167
168             /* green components */
169             ta = (colorA >> 5) & 0x1F;
170             tb = (colorB >> 5) & 0x1F;
171             color4[1] |= ((11 * ta + 21 * tb) >> 5) << 5;
172             color4[2] |= ((21 * ta + 11 * tb) >> 5) << 5;
173
174             /* blue components */
175             ta = colorA & 0x1F;
176             tb = colorB & 0x1F;
177             color4[1] |= ((11 * ta + 21 * tb) >> 5);
178             color4[2] |= ((21 * ta + 11 * tb) >> 5);
179
180             if (bytestream2_get_bytes_left(&s->gb) < n_blocks * 4)
181                 return;
182             while (n_blocks--) {
183                 block_ptr = row_ptr + pixel_ptr;
184                 for (pixel_y = 0; pixel_y < 4; pixel_y++) {
185                     index = bytestream2_get_byteu(&s->gb);
186                     for (pixel_x = 0; pixel_x < 4; pixel_x++){
187                         idx = (index >> (2 * (3 - pixel_x))) & 0x03;
188                         pixels[block_ptr] = color4[idx];
189                         block_ptr++;
190                     }
191                     block_ptr += row_inc;
192                 }
193                 ADVANCE_BLOCK();
194             }
195             break;
196
197         /* Fill block with 16 colors */
198         case 0x00:
199             if (bytestream2_get_bytes_left(&s->gb) < 30)
200                 return;
201             block_ptr = row_ptr + pixel_ptr;
202             for (pixel_y = 0; pixel_y < 4; pixel_y++) {
203                 for (pixel_x = 0; pixel_x < 4; pixel_x++){
204                     /* We already have color of upper left pixel */
205                     if ((pixel_y != 0) || (pixel_x != 0))
206                         colorA = bytestream2_get_be16u(&s->gb);
207                     pixels[block_ptr] = colorA;
208                     block_ptr++;
209                 }
210                 block_ptr += row_inc;
211             }
212             ADVANCE_BLOCK();
213             break;
214
215         /* Unknown opcode */
216         default:
217             av_log(s->avctx, AV_LOG_ERROR, "Unknown opcode %d in rpza chunk."
218                  " Skip remaining %d bytes of chunk data.\n", opcode,
219                  bytestream2_get_bytes_left(&s->gb));
220             return;
221         } /* Opcode switch */
222     }
223 }
224
225 static av_cold int rpza_decode_init(AVCodecContext *avctx)
226 {
227     RpzaContext *s = avctx->priv_data;
228
229     s->avctx = avctx;
230     avctx->pix_fmt = AV_PIX_FMT_RGB555;
231
232     s->frame = av_frame_alloc();
233     if (!s->frame)
234         return AVERROR(ENOMEM);
235
236     return 0;
237 }
238
239 static int rpza_decode_frame(AVCodecContext *avctx,
240                              void *data, int *got_frame,
241                              AVPacket *avpkt)
242 {
243     RpzaContext *s = avctx->priv_data;
244     int ret;
245
246     bytestream2_init(&s->gb, avpkt->data, avpkt->size);
247
248     if ((ret = ff_reget_buffer(avctx, s->frame)) < 0) {
249         av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
250         return ret;
251     }
252
253     rpza_decode_stream(s);
254
255     if ((ret = av_frame_ref(data, s->frame)) < 0)
256         return ret;
257
258     *got_frame      = 1;
259
260     /* always report that the buffer was completely consumed */
261     return avpkt->size;
262 }
263
264 static av_cold int rpza_decode_end(AVCodecContext *avctx)
265 {
266     RpzaContext *s = avctx->priv_data;
267
268     av_frame_free(&s->frame);
269
270     return 0;
271 }
272
273 AVCodec ff_rpza_decoder = {
274     .name           = "rpza",
275     .long_name      = NULL_IF_CONFIG_SMALL("QuickTime video (RPZA)"),
276     .type           = AVMEDIA_TYPE_VIDEO,
277     .id             = AV_CODEC_ID_RPZA,
278     .priv_data_size = sizeof(RpzaContext),
279     .init           = rpza_decode_init,
280     .close          = rpza_decode_end,
281     .decode         = rpza_decode_frame,
282     .capabilities   = CODEC_CAP_DR1,
283 };