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 "codec_internal.h"
46 #include "internal.h"
47 
48 typedef struct RpzaContext {
49 
52 
54 } RpzaContext;
55 
56 #define CHECK_BLOCK() \
57  if (total_blocks < 1) { \
58  av_log(s->avctx, AV_LOG_ERROR, \
59  "Block counter just went negative (this should not happen)\n"); \
60  return AVERROR_INVALIDDATA; \
61  } \
62 
63 #define ADVANCE_BLOCK() \
64  { \
65  pixel_ptr += 4; \
66  if (pixel_ptr >= width) \
67  { \
68  pixel_ptr = 0; \
69  row_ptr += stride * 4; \
70  } \
71  total_blocks--; \
72  }
73 
75 {
76  int width = s->avctx->width;
77  int stride, row_inc, ret;
78  int chunk_size;
79  uint16_t colorA = 0, colorB;
80  uint16_t color4[4];
81  uint16_t ta, tb;
82  uint16_t *pixels;
83 
84  int row_ptr = 0;
85  int pixel_ptr = 0;
86  int block_ptr;
87  int pixel_x, pixel_y;
88  int total_blocks;
89 
90  /* First byte is always 0xe1. Warn if it's different */
91  if (bytestream2_peek_byte(&s->gb) != 0xe1)
92  av_log(s->avctx, AV_LOG_ERROR, "First chunk byte is 0x%02x instead of 0xe1\n",
93  bytestream2_peek_byte(&s->gb));
94 
95  /* Get chunk size, ignoring first byte */
96  chunk_size = bytestream2_get_be32(&s->gb) & 0x00FFFFFF;
97 
98  /* If length mismatch use size from MOV file and try to decode anyway */
99  if (chunk_size != bytestream2_get_bytes_left(&s->gb) + 4)
100  av_log(s->avctx, AV_LOG_WARNING,
101  "MOV chunk size %d != encoded chunk size %d\n",
102  chunk_size,
103  bytestream2_get_bytes_left(&s->gb) + 4
104  );
105 
106  /* Number of 4x4 blocks in frame. */
107  total_blocks = ((s->avctx->width + 3) / 4) * ((s->avctx->height + 3) / 4);
108 
109  if (total_blocks / 32 > bytestream2_get_bytes_left(&s->gb))
110  return AVERROR_INVALIDDATA;
111 
112  if ((ret = ff_reget_buffer(s->avctx, s->frame, 0)) < 0)
113  return ret;
114  pixels = (uint16_t *)s->frame->data[0];
115  stride = s->frame->linesize[0] / 2;
116  row_inc = stride - 4;
117 
118  /* Process chunk data */
119  while (bytestream2_get_bytes_left(&s->gb)) {
120  uint8_t opcode = bytestream2_get_byte(&s->gb); /* Get opcode */
121 
122  int n_blocks = (opcode & 0x1f) + 1; /* Extract block counter from opcode */
123 
124  /* If opcode MSbit is 0, we need more data to decide what to do */
125  if ((opcode & 0x80) == 0) {
126  colorA = (opcode << 8) | bytestream2_get_byte(&s->gb);
127  opcode = 0;
128  if ((bytestream2_peek_byte(&s->gb) & 0x80) != 0) {
129  /* Must behave as opcode 110xxxxx, using colorA computed
130  * above. Use fake opcode 0x20 to enter switch block at
131  * the right place */
132  opcode = 0x20;
133  n_blocks = 1;
134  }
135  }
136 
137  n_blocks = FFMIN(n_blocks, total_blocks);
138 
139  switch (opcode & 0xe0) {
140 
141  /* Skip blocks */
142  case 0x80:
143  while (n_blocks--) {
144  CHECK_BLOCK();
145  ADVANCE_BLOCK();
146  }
147  break;
148 
149  /* Fill blocks with one color */
150  case 0xa0:
151  colorA = bytestream2_get_be16(&s->gb);
152  while (n_blocks--) {
153  CHECK_BLOCK();
154  block_ptr = row_ptr + pixel_ptr;
155  for (pixel_y = 0; pixel_y < 4; pixel_y++) {
156  for (pixel_x = 0; pixel_x < 4; pixel_x++){
157  pixels[block_ptr] = colorA;
158  block_ptr++;
159  }
160  block_ptr += row_inc;
161  }
162  ADVANCE_BLOCK();
163  }
164  break;
165 
166  /* Fill blocks with 4 colors */
167  case 0xc0:
168  colorA = bytestream2_get_be16(&s->gb);
169  case 0x20:
170  colorB = bytestream2_get_be16(&s->gb);
171 
172  /* sort out the colors */
173  color4[0] = colorB;
174  color4[1] = 0;
175  color4[2] = 0;
176  color4[3] = colorA;
177 
178  /* red components */
179  ta = (colorA >> 10) & 0x1F;
180  tb = (colorB >> 10) & 0x1F;
181  color4[1] |= ((11 * ta + 21 * tb) >> 5) << 10;
182  color4[2] |= ((21 * ta + 11 * tb) >> 5) << 10;
183 
184  /* green components */
185  ta = (colorA >> 5) & 0x1F;
186  tb = (colorB >> 5) & 0x1F;
187  color4[1] |= ((11 * ta + 21 * tb) >> 5) << 5;
188  color4[2] |= ((21 * ta + 11 * tb) >> 5) << 5;
189 
190  /* blue components */
191  ta = colorA & 0x1F;
192  tb = colorB & 0x1F;
193  color4[1] |= ((11 * ta + 21 * tb) >> 5);
194  color4[2] |= ((21 * ta + 11 * tb) >> 5);
195 
196  if (bytestream2_get_bytes_left(&s->gb) < n_blocks * 4)
197  return AVERROR_INVALIDDATA;
198  while (n_blocks--) {
199  CHECK_BLOCK();
200  block_ptr = row_ptr + pixel_ptr;
201  for (pixel_y = 0; pixel_y < 4; pixel_y++) {
202  uint8_t index = bytestream2_get_byteu(&s->gb);
203  for (pixel_x = 0; pixel_x < 4; pixel_x++){
204  uint8_t idx = (index >> (2 * (3 - pixel_x))) & 0x03;
205  pixels[block_ptr] = color4[idx];
206  block_ptr++;
207  }
208  block_ptr += row_inc;
209  }
210  ADVANCE_BLOCK();
211  }
212  break;
213 
214  /* Fill block with 16 colors */
215  case 0x00:
216  if (bytestream2_get_bytes_left(&s->gb) < 30)
217  return AVERROR_INVALIDDATA;
218  CHECK_BLOCK();
219  block_ptr = row_ptr + pixel_ptr;
220  for (pixel_y = 0; pixel_y < 4; pixel_y++) {
221  for (pixel_x = 0; pixel_x < 4; pixel_x++){
222  /* We already have color of upper left pixel */
223  if ((pixel_y != 0) || (pixel_x != 0))
224  colorA = bytestream2_get_be16u(&s->gb);
225  pixels[block_ptr] = colorA;
226  block_ptr++;
227  }
228  block_ptr += row_inc;
229  }
230  ADVANCE_BLOCK();
231  break;
232 
233  /* Unknown opcode */
234  default:
235  av_log(s->avctx, AV_LOG_ERROR, "Unknown opcode %d in rpza chunk."
236  " Skip remaining %d bytes of chunk data.\n", opcode,
238  return AVERROR_INVALIDDATA;
239  } /* Opcode switch */
240  }
241 
242  return 0;
243 }
244 
246 {
247  RpzaContext *s = avctx->priv_data;
248 
249  s->avctx = avctx;
250  avctx->pix_fmt = AV_PIX_FMT_RGB555;
251 
252  s->frame = av_frame_alloc();
253  if (!s->frame)
254  return AVERROR(ENOMEM);
255 
256  return 0;
257 }
258 
259 static int rpza_decode_frame(AVCodecContext *avctx, AVFrame *rframe,
260  int *got_frame, AVPacket *avpkt)
261 {
262  RpzaContext *s = avctx->priv_data;
263  int ret;
264 
265  bytestream2_init(&s->gb, avpkt->data, avpkt->size);
266 
268  if (ret < 0)
269  return ret;
270 
271  if ((ret = av_frame_ref(rframe, 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  .p.name = "rpza",
291  .p.long_name = NULL_IF_CONFIG_SMALL("QuickTime video (RPZA)"),
292  .p.type = AVMEDIA_TYPE_VIDEO,
293  .p.id = AV_CODEC_ID_RPZA,
294  .priv_data_size = sizeof(RpzaContext),
296  .close = rpza_decode_end,
298  .p.capabilities = AV_CODEC_CAP_DR1,
299 };
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:186
AVERROR
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
GetByteContext
Definition: bytestream.h:33
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:116
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:325
internal.h
AVPacket::data
uint8_t * data
Definition: packet.h:374
RpzaContext
Definition: rpza.c:48
FFCodec
Definition: codec_internal.h:118
ff_rpza_decoder
const FFCodec ff_rpza_decoder
Definition: rpza.c:289
init
static int init
Definition: av_tx.c:47
rpza_decode_end
static av_cold int rpza_decode_end(AVCodecContext *avctx)
Definition: rpza.c:280
FFCodec::p
AVCodec p
The public AVCodec.
Definition: codec_internal.h:122
rpza_decode_frame
static int rpza_decode_frame(AVCodecContext *avctx, AVFrame *rframe, int *got_frame, AVPacket *avpkt)
Definition: rpza.c:259
av_frame_alloc
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:104
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
av_cold
#define av_cold
Definition: attributes.h:90
width
#define width
FF_CODEC_DECODE_CB
#define FF_CODEC_DECODE_CB(func)
Definition: codec_internal.h:260
s
#define s(width, name)
Definition: cbs_vp9.c:256
rpza_decode_stream
static int rpza_decode_stream(RpzaContext *s)
Definition: rpza.c:74
RpzaContext::frame
AVFrame * frame
Definition: rpza.c:51
index
int index
Definition: gxfenc.c:89
bytestream2_get_bytes_left
static av_always_inline int bytestream2_get_bytes_left(GetByteContext *g)
Definition: bytestream.h:158
RpzaContext::gb
GetByteContext gb
Definition: rpza.c:53
AV_CODEC_CAP_DR1
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() or get_encode_buffer() for allocating buffers and supports custom allocators.
Definition: codec.h:52
AVPacket::size
int size
Definition: packet.h:375
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:117
av_frame_ref
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:353
codec_internal.h
ADVANCE_BLOCK
#define ADVANCE_BLOCK()
Definition: rpza.c:63
CHECK_BLOCK
#define CHECK_BLOCK()
Definition: rpza.c:56
internal.h
AV_PIX_FMT_RGB555
#define AV_PIX_FMT_RGB555
Definition: pixfmt.h:396
FFMIN
#define FFMIN(a, b)
Definition: macros.h:49
tb
#define tb
Definition: regdef.h:68
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:211
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:608
avcodec.h
stride
#define stride
Definition: h264pred_template.c:537
ff_reget_buffer
int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Identical in function to ff_get_buffer(), except it reuses the existing buffer if available.
Definition: decode.c:1580
ret
ret
Definition: filter_design.txt:187
RpzaContext::avctx
AVCodecContext * avctx
Definition: rpza.c:50
AVCodecContext
main external API structure.
Definition: avcodec.h:398
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
AV_CODEC_ID_RPZA
@ AV_CODEC_ID_RPZA
Definition: codec_id.h:92
rpza_decode_init
static av_cold int rpza_decode_init(AVCodecContext *avctx)
Definition: rpza.c:245
AVPacket
This structure stores compressed data.
Definition: packet.h:351
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:425
bytestream.h
bytestream2_init
static av_always_inline void bytestream2_init(GetByteContext *g, const uint8_t *buf, int buf_size)
Definition: bytestream.h:137
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
ta
#define ta
Definition: regdef.h:67
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61