Merge commit 'b5f92f9603c2b46c37b20134e9e2338805844f0f' into release/1.1
[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 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  * 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 <stdio.h>
38 #include <stdlib.h>
39 #include <string.h>
40
41 #include "libavutil/common.h"
42 #include "libavutil/internal.h"
43 #include "libavutil/intreadwrite.h"
44 #include "libavutil/common.h"
45 #include "avcodec.h"
46
47 typedef struct RpzaContext {
48
49     AVCodecContext *avctx;
50     AVFrame frame;
51
52     const unsigned char *buf;
53     int size;
54
55 } RpzaContext;
56
57 #define ADVANCE_BLOCK() \
58 { \
59     pixel_ptr += 4; \
60     if (pixel_ptr >= width) \
61     { \
62         pixel_ptr = 0; \
63         row_ptr += stride * 4; \
64     } \
65     total_blocks--; \
66     if (total_blocks < 0) \
67     { \
68         av_log(s->avctx, AV_LOG_ERROR, "warning: block counter just went negative (this should not happen)\n"); \
69         return; \
70     } \
71 }
72
73 static void rpza_decode_stream(RpzaContext *s)
74 {
75     int width = s->avctx->width;
76     int stride = s->frame.linesize[0] / 2;
77     int row_inc = stride - 4;
78     int stream_ptr = 0;
79     int chunk_size;
80     unsigned char opcode;
81     int n_blocks;
82     unsigned short colorA = 0, colorB;
83     unsigned short color4[4];
84     unsigned char index, idx;
85     unsigned short ta, tb;
86     unsigned short *pixels = (unsigned short *)s->frame.data[0];
87
88     int row_ptr = 0;
89     int pixel_ptr = -4;
90     int block_ptr;
91     int pixel_x, pixel_y;
92     int total_blocks;
93
94     /* First byte is always 0xe1. Warn if it's different */
95     if (s->buf[stream_ptr] != 0xe1)
96         av_log(s->avctx, AV_LOG_ERROR, "First chunk byte is 0x%02x instead of 0xe1\n",
97             s->buf[stream_ptr]);
98
99     /* Get chunk size, ingnoring first byte */
100     chunk_size = AV_RB32(&s->buf[stream_ptr]) & 0x00FFFFFF;
101     stream_ptr += 4;
102
103     /* If length mismatch use size from MOV file and try to decode anyway */
104     if (chunk_size != s->size)
105         av_log(s->avctx, AV_LOG_ERROR, "MOV chunk size != encoded chunk size; using MOV chunk size\n");
106
107     chunk_size = s->size;
108
109     /* Number of 4x4 blocks in frame. */
110     total_blocks = ((s->avctx->width + 3) / 4) * ((s->avctx->height + 3) / 4);
111
112     /* Process chunk data */
113     while (stream_ptr < chunk_size) {
114         opcode = s->buf[stream_ptr++]; /* Get opcode */
115
116         n_blocks = (opcode & 0x1f) + 1; /* Extract block counter from opcode */
117
118         /* If opcode MSbit is 0, we need more data to decide what to do */
119         if ((opcode & 0x80) == 0) {
120             colorA = (opcode << 8) | (s->buf[stream_ptr++]);
121             opcode = 0;
122             if ((s->buf[stream_ptr] & 0x80) != 0) {
123                 /* Must behave as opcode 110xxxxx, using colorA computed
124                  * above. Use fake opcode 0x20 to enter switch block at
125                  * the right place */
126                 opcode = 0x20;
127                 n_blocks = 1;
128             }
129         }
130
131         n_blocks = FFMIN(n_blocks, total_blocks);
132
133         switch (opcode & 0xe0) {
134
135         /* Skip blocks */
136         case 0x80:
137             while (n_blocks--) {
138               ADVANCE_BLOCK();
139             }
140             break;
141
142         /* Fill blocks with one color */
143         case 0xa0:
144             colorA = AV_RB16 (&s->buf[stream_ptr]);
145             stream_ptr += 2;
146             while (n_blocks--) {
147                 ADVANCE_BLOCK()
148                 block_ptr = row_ptr + pixel_ptr;
149                 for (pixel_y = 0; pixel_y < 4; pixel_y++) {
150                     for (pixel_x = 0; pixel_x < 4; pixel_x++){
151                         pixels[block_ptr] = colorA;
152                         block_ptr++;
153                     }
154                     block_ptr += row_inc;
155                 }
156             }
157             break;
158
159         /* Fill blocks with 4 colors */
160         case 0xc0:
161             colorA = AV_RB16 (&s->buf[stream_ptr]);
162             stream_ptr += 2;
163         case 0x20:
164             colorB = AV_RB16 (&s->buf[stream_ptr]);
165             stream_ptr += 2;
166
167             /* sort out the colors */
168             color4[0] = colorB;
169             color4[1] = 0;
170             color4[2] = 0;
171             color4[3] = colorA;
172
173             /* red components */
174             ta = (colorA >> 10) & 0x1F;
175             tb = (colorB >> 10) & 0x1F;
176             color4[1] |= ((11 * ta + 21 * tb) >> 5) << 10;
177             color4[2] |= ((21 * ta + 11 * tb) >> 5) << 10;
178
179             /* green components */
180             ta = (colorA >> 5) & 0x1F;
181             tb = (colorB >> 5) & 0x1F;
182             color4[1] |= ((11 * ta + 21 * tb) >> 5) << 5;
183             color4[2] |= ((21 * ta + 11 * tb) >> 5) << 5;
184
185             /* blue components */
186             ta = colorA & 0x1F;
187             tb = colorB & 0x1F;
188             color4[1] |= ((11 * ta + 21 * tb) >> 5);
189             color4[2] |= ((21 * ta + 11 * tb) >> 5);
190
191             if (s->size - stream_ptr < n_blocks * 4)
192                 return;
193             while (n_blocks--) {
194                 ADVANCE_BLOCK();
195                 block_ptr = row_ptr + pixel_ptr;
196                 for (pixel_y = 0; pixel_y < 4; pixel_y++) {
197                     index = s->buf[stream_ptr++];
198                     for (pixel_x = 0; pixel_x < 4; pixel_x++){
199                         idx = (index >> (2 * (3 - pixel_x))) & 0x03;
200                         pixels[block_ptr] = color4[idx];
201                         block_ptr++;
202                     }
203                     block_ptr += row_inc;
204                 }
205             }
206             break;
207
208         /* Fill block with 16 colors */
209         case 0x00:
210             if (s->size - stream_ptr < 30)
211                 return;
212             ADVANCE_BLOCK();
213             block_ptr = row_ptr + pixel_ptr;
214             for (pixel_y = 0; pixel_y < 4; pixel_y++) {
215                 for (pixel_x = 0; pixel_x < 4; pixel_x++){
216                     /* We already have color of upper left pixel */
217                     if ((pixel_y != 0) || (pixel_x !=0)) {
218                         colorA = AV_RB16 (&s->buf[stream_ptr]);
219                         stream_ptr += 2;
220                     }
221                     pixels[block_ptr] = colorA;
222                     block_ptr++;
223                 }
224                 block_ptr += row_inc;
225             }
226             break;
227
228         /* Unknown opcode */
229         default:
230             av_log(s->avctx, AV_LOG_ERROR, "Unknown opcode %d in rpza chunk."
231                  " Skip remaining %d bytes of chunk data.\n", opcode,
232                  chunk_size - stream_ptr);
233             return;
234         } /* Opcode switch */
235     }
236 }
237
238 static av_cold int rpza_decode_init(AVCodecContext *avctx)
239 {
240     RpzaContext *s = avctx->priv_data;
241
242     s->avctx = avctx;
243     avctx->pix_fmt = AV_PIX_FMT_RGB555;
244
245     avcodec_get_frame_defaults(&s->frame);
246     s->frame.data[0] = NULL;
247
248     return 0;
249 }
250
251 static int rpza_decode_frame(AVCodecContext *avctx,
252                              void *data, int *got_frame,
253                              AVPacket *avpkt)
254 {
255     const uint8_t *buf = avpkt->data;
256     int buf_size = avpkt->size;
257     RpzaContext *s = avctx->priv_data;
258
259     s->buf = buf;
260     s->size = buf_size;
261
262     s->frame.reference = 3;
263     s->frame.buffer_hints = FF_BUFFER_HINTS_VALID | FF_BUFFER_HINTS_PRESERVE | FF_BUFFER_HINTS_REUSABLE;
264     if (avctx->reget_buffer(avctx, &s->frame)) {
265         av_log(avctx, AV_LOG_ERROR, "reget_buffer() failed\n");
266         return -1;
267     }
268
269     rpza_decode_stream(s);
270
271     *got_frame      = 1;
272     *(AVFrame*)data = s->frame;
273
274     /* always report that the buffer was completely consumed */
275     return buf_size;
276 }
277
278 static av_cold int rpza_decode_end(AVCodecContext *avctx)
279 {
280     RpzaContext *s = avctx->priv_data;
281
282     if (s->frame.data[0])
283         avctx->release_buffer(avctx, &s->frame);
284
285     return 0;
286 }
287
288 AVCodec ff_rpza_decoder = {
289     .name           = "rpza",
290     .type           = AVMEDIA_TYPE_VIDEO,
291     .id             = AV_CODEC_ID_RPZA,
292     .priv_data_size = sizeof(RpzaContext),
293     .init           = rpza_decode_init,
294     .close          = rpza_decode_end,
295     .decode         = rpza_decode_frame,
296     .capabilities   = CODEC_CAP_DR1,
297     .long_name      = NULL_IF_CONFIG_SMALL("QuickTime video (RPZA)"),
298 };