FFmpeg
rpza.c
Go to the documentation of this file.
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 <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 
51 
53 } RpzaContext;
54 
55 #define CHECK_BLOCK() \
56  if (total_blocks < 1) { \
57  av_log(s->avctx, AV_LOG_ERROR, \
58  "Block counter just went negative (this should not happen)\n"); \
59  return AVERROR_INVALIDDATA; \
60  } \
61 
62 #define ADVANCE_BLOCK() \
63  { \
64  pixel_ptr += 4; \
65  if (pixel_ptr >= width) \
66  { \
67  pixel_ptr = 0; \
68  row_ptr += stride * 4; \
69  } \
70  total_blocks--; \
71  }
72 
74 {
75  int width = s->avctx->width;
76  int stride, row_inc, ret;
77  int chunk_size;
78  uint16_t colorA = 0, colorB;
79  uint16_t color4[4];
80  uint16_t ta, tb;
81  uint16_t *pixels;
82 
83  int row_ptr = 0;
84  int pixel_ptr = 0;
85  int block_ptr;
86  int pixel_x, pixel_y;
87  int total_blocks;
88 
89  /* First byte is always 0xe1. Warn if it's different */
90  if (bytestream2_peek_byte(&s->gb) != 0xe1)
91  av_log(s->avctx, AV_LOG_ERROR, "First chunk byte is 0x%02x instead of 0xe1\n",
92  bytestream2_peek_byte(&s->gb));
93 
94  /* Get chunk size, ignoring first byte */
95  chunk_size = bytestream2_get_be32(&s->gb) & 0x00FFFFFF;
96 
97  /* If length mismatch use size from MOV file and try to decode anyway */
98  if (chunk_size != bytestream2_get_bytes_left(&s->gb) + 4)
100  "MOV chunk size %d != encoded chunk size %d\n",
101  chunk_size,
103  );
104 
105  /* Number of 4x4 blocks in frame. */
106  total_blocks = ((s->avctx->width + 3) / 4) * ((s->avctx->height + 3) / 4);
107 
108  if (total_blocks / 32 > bytestream2_get_bytes_left(&s->gb))
109  return AVERROR_INVALIDDATA;
110 
111  if ((ret = ff_reget_buffer(s->avctx, s->frame)) < 0)
112  return ret;
113  pixels = (uint16_t *)s->frame->data[0];
114  stride = s->frame->linesize[0] / 2;
115  row_inc = stride - 4;
116 
117  /* Process chunk data */
118  while (bytestream2_get_bytes_left(&s->gb)) {
119  uint8_t opcode = bytestream2_get_byte(&s->gb); /* Get opcode */
120 
121  int n_blocks = (opcode & 0x1f) + 1; /* Extract block counter from opcode */
122 
123  /* If opcode MSbit is 0, we need more data to decide what to do */
124  if ((opcode & 0x80) == 0) {
125  colorA = (opcode << 8) | bytestream2_get_byte(&s->gb);
126  opcode = 0;
127  if ((bytestream2_peek_byte(&s->gb) & 0x80) != 0) {
128  /* Must behave as opcode 110xxxxx, using colorA computed
129  * above. Use fake opcode 0x20 to enter switch block at
130  * the right place */
131  opcode = 0x20;
132  n_blocks = 1;
133  }
134  }
135 
136  n_blocks = FFMIN(n_blocks, total_blocks);
137 
138  switch (opcode & 0xe0) {
139 
140  /* Skip blocks */
141  case 0x80:
142  while (n_blocks--) {
143  CHECK_BLOCK();
144  ADVANCE_BLOCK();
145  }
146  break;
147 
148  /* Fill blocks with one color */
149  case 0xa0:
150  colorA = bytestream2_get_be16(&s->gb);
151  while (n_blocks--) {
152  CHECK_BLOCK();
153  block_ptr = row_ptr + pixel_ptr;
154  for (pixel_y = 0; pixel_y < 4; pixel_y++) {
155  for (pixel_x = 0; pixel_x < 4; pixel_x++){
156  pixels[block_ptr] = colorA;
157  block_ptr++;
158  }
159  block_ptr += row_inc;
160  }
161  ADVANCE_BLOCK();
162  }
163  break;
164 
165  /* Fill blocks with 4 colors */
166  case 0xc0:
167  colorA = bytestream2_get_be16(&s->gb);
168  case 0x20:
169  colorB = bytestream2_get_be16(&s->gb);
170 
171  /* sort out the colors */
172  color4[0] = colorB;
173  color4[1] = 0;
174  color4[2] = 0;
175  color4[3] = colorA;
176 
177  /* red components */
178  ta = (colorA >> 10) & 0x1F;
179  tb = (colorB >> 10) & 0x1F;
180  color4[1] |= ((11 * ta + 21 * tb) >> 5) << 10;
181  color4[2] |= ((21 * ta + 11 * tb) >> 5) << 10;
182 
183  /* green components */
184  ta = (colorA >> 5) & 0x1F;
185  tb = (colorB >> 5) & 0x1F;
186  color4[1] |= ((11 * ta + 21 * tb) >> 5) << 5;
187  color4[2] |= ((21 * ta + 11 * tb) >> 5) << 5;
188 
189  /* blue components */
190  ta = colorA & 0x1F;
191  tb = colorB & 0x1F;
192  color4[1] |= ((11 * ta + 21 * tb) >> 5);
193  color4[2] |= ((21 * ta + 11 * tb) >> 5);
194 
195  if (bytestream2_get_bytes_left(&s->gb) < n_blocks * 4)
196  return AVERROR_INVALIDDATA;
197  while (n_blocks--) {
198  CHECK_BLOCK();
199  block_ptr = row_ptr + pixel_ptr;
200  for (pixel_y = 0; pixel_y < 4; pixel_y++) {
201  uint8_t index = bytestream2_get_byteu(&s->gb);
202  for (pixel_x = 0; pixel_x < 4; pixel_x++){
203  uint8_t idx = (index >> (2 * (3 - pixel_x))) & 0x03;
204  pixels[block_ptr] = color4[idx];
205  block_ptr++;
206  }
207  block_ptr += row_inc;
208  }
209  ADVANCE_BLOCK();
210  }
211  break;
212 
213  /* Fill block with 16 colors */
214  case 0x00:
215  if (bytestream2_get_bytes_left(&s->gb) < 30)
216  return AVERROR_INVALIDDATA;
217  CHECK_BLOCK();
218  block_ptr = row_ptr + pixel_ptr;
219  for (pixel_y = 0; pixel_y < 4; pixel_y++) {
220  for (pixel_x = 0; pixel_x < 4; pixel_x++){
221  /* We already have color of upper left pixel */
222  if ((pixel_y != 0) || (pixel_x != 0))
223  colorA = bytestream2_get_be16u(&s->gb);
224  pixels[block_ptr] = colorA;
225  block_ptr++;
226  }
227  block_ptr += row_inc;
228  }
229  ADVANCE_BLOCK();
230  break;
231 
232  /* Unknown opcode */
233  default:
234  av_log(s->avctx, AV_LOG_ERROR, "Unknown opcode %d in rpza chunk."
235  " Skip remaining %d bytes of chunk data.\n", opcode,
237  return AVERROR_INVALIDDATA;
238  } /* Opcode switch */
239  }
240 
241  return 0;
242 }
243 
245 {
246  RpzaContext *s = avctx->priv_data;
247 
248  s->avctx = avctx;
249  avctx->pix_fmt = AV_PIX_FMT_RGB555;
250 
251  s->frame = av_frame_alloc();
252  if (!s->frame)
253  return AVERROR(ENOMEM);
254 
255  return 0;
256 }
257 
259  void *data, int *got_frame,
260  AVPacket *avpkt)
261 {
262  RpzaContext *s = avctx->priv_data;
263  int ret;
264 
265  bytestream2_init(&s->gb, avpkt->data, avpkt->size);
266 
267  ret = rpza_decode_stream(s);
268  if (ret < 0)
269  return ret;
270 
271  if ((ret = av_frame_ref(data, s->frame)) < 0)
272  return ret;
273 
274  *got_frame = 1;
275 
276  /* always report that the buffer was completely consumed */
277  return avpkt->size;
278 }
279 
281 {
282  RpzaContext *s = avctx->priv_data;
283 
284  av_frame_free(&s->frame);
285 
286  return 0;
287 }
288 
290  .name = "rpza",
291  .long_name = NULL_IF_CONFIG_SMALL("QuickTime video (RPZA)"),
292  .type = AVMEDIA_TYPE_VIDEO,
293  .id = AV_CODEC_ID_RPZA,
294  .priv_data_size = sizeof(RpzaContext),
296  .close = rpza_decode_end,
298  .capabilities = AV_CODEC_CAP_DR1,
299 };
static int rpza_decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
Definition: rpza.c:258
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
This structure describes decoded (raw) audio or video data.
Definition: frame.h:268
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:100
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
#define ta
Definition: regdef.h:67
int size
Definition: avcodec.h:1478
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:1775
static av_always_inline void bytestream2_init(GetByteContext *g, const uint8_t *buf, int buf_size)
Definition: bytestream.h:133
AVCodec.
Definition: avcodec.h:3477
static void decode(AVCodecContext *dec_ctx, AVPacket *pkt, AVFrame *frame, FILE *outfile)
Definition: decode_audio.c:42
int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame)
Identical in function to av_frame_make_writable(), except it uses ff_get_buffer() to allocate the buf...
Definition: decode.c:2011
uint8_t
#define av_cold
Definition: attributes.h:82
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:189
int av_frame_ref(AVFrame *dst, const AVFrame *src)
Set up a new reference to the data described by the source frame.
Definition: frame.c:443
AVCodec ff_rpza_decoder
Definition: rpza.c:289
uint8_t * data
Definition: avcodec.h:1477
#define av_log(a,...)
static av_cold int rpza_decode_end(AVCodecContext *avctx)
Definition: rpza.c:280
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
GetByteContext gb
Definition: rpza.c:52
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:202
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
static av_always_inline unsigned int bytestream2_get_bytes_left(GetByteContext *g)
Definition: bytestream.h:154
const char * name
Name of the codec implementation.
Definition: avcodec.h:3484
common internal API header
#define FFMIN(a, b)
Definition: common.h:96
#define width
int width
picture width / height.
Definition: avcodec.h:1738
static int rpza_decode_stream(RpzaContext *s)
Definition: rpza.c:73
#define s(width, name)
Definition: cbs_vp9.c:257
static av_cold int rpza_decode_init(AVCodecContext *avctx)
Definition: rpza.c:244
Libavcodec external API header.
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:299
main external API structure.
Definition: avcodec.h:1565
int index
Definition: gxfenc.c:89
AVFrame * frame
Definition: rpza.c:50
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:282
common internal api header.
AVCodecContext * avctx
Definition: rpza.c:49
#define CHECK_BLOCK()
Definition: rpza.c:55
#define AV_PIX_FMT_RGB555
Definition: pixfmt.h:375
void * priv_data
Definition: avcodec.h:1592
int pixels
Definition: avisynth_c.h:390
#define ADVANCE_BLOCK()
Definition: rpza.c:62
#define stride
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later.That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another.Frame references ownership and permissions
This structure stores compressed data.
Definition: avcodec.h:1454
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() for allocating buffers and supports custom allocators.
Definition: avcodec.h:981
#define tb
Definition: regdef.h:68