2 * BRender PIX (.pix) image decoder
3 * Copyright (c) 2012 Aleksi Nurmi
5 * This file is part of FFmpeg.
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.
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.
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
23 * Tested against samples from I-War / Independence War and Defiance.
24 * If the PIX file does not contain a palette, the
25 * palette_has_changed property of the AVFrame is set to 0.
28 #include "libavutil/imgutils.h"
30 #include "bytestream.h"
33 typedef struct BRPixContext {
37 typedef struct BRPixHeader {
39 unsigned int width, height;
42 static av_cold int brpix_init(AVCodecContext *avctx)
44 BRPixContext *s = avctx->priv_data;
46 avcodec_get_frame_defaults(&s->frame);
47 avctx->coded_frame = &s->frame;
52 static int brpix_decode_header(BRPixHeader *out, GetByteContext *pgb)
54 unsigned int header_len = bytestream2_get_be32(pgb);
56 out->format = bytestream2_get_byte(pgb);
57 bytestream2_skip(pgb, 2);
58 out->width = bytestream2_get_be16(pgb);
59 out->height = bytestream2_get_be16(pgb);
61 // the header is at least 11 bytes long; we read the first 7
62 if (header_len < 11) {
66 // skip the rest of the header
67 bytestream2_skip(pgb, header_len-7);
72 static int brpix_decode_frame(AVCodecContext *avctx,
73 void *data, int *got_frame,
76 BRPixContext *s = avctx->priv_data;
77 AVFrame *frame_out = data;
82 unsigned int bytes_pp;
84 unsigned int magic[4];
85 unsigned int chunk_type;
86 unsigned int data_len;
89 bytestream2_init(&gb, avpkt->data, avpkt->size);
91 magic[0] = bytestream2_get_be32(&gb);
92 magic[1] = bytestream2_get_be32(&gb);
93 magic[2] = bytestream2_get_be32(&gb);
94 magic[3] = bytestream2_get_be32(&gb);
96 if (magic[0] != 0x12 ||
100 av_log(avctx, AV_LOG_ERROR, "Not a BRender PIX file\n");
101 return AVERROR_INVALIDDATA;
104 chunk_type = bytestream2_get_be32(&gb);
105 if (chunk_type != 0x3 && chunk_type != 0x3d) {
106 av_log(avctx, AV_LOG_ERROR, "Invalid chunk type %d\n", chunk_type);
107 return AVERROR_INVALIDDATA;
110 ret = brpix_decode_header(&hdr, &gb);
112 av_log(avctx, AV_LOG_ERROR, "Invalid header length\n");
113 return AVERROR_INVALIDDATA;
115 switch (hdr.format) {
117 avctx->pix_fmt = AV_PIX_FMT_PAL8;
121 avctx->pix_fmt = AV_PIX_FMT_RGB555BE;
125 avctx->pix_fmt = AV_PIX_FMT_RGB565BE;
129 avctx->pix_fmt = AV_PIX_FMT_RGB24;
133 avctx->pix_fmt = AV_PIX_FMT_0RGB;
137 avctx->pix_fmt = AV_PIX_FMT_GRAY8A;
141 av_log(avctx, AV_LOG_ERROR, "Format %d is not supported\n",
143 return AVERROR_PATCHWELCOME;
146 if (s->frame.data[0])
147 avctx->release_buffer(avctx, &s->frame);
149 if (av_image_check_size(hdr.width, hdr.height, 0, avctx) < 0)
150 return AVERROR_INVALIDDATA;
152 if (hdr.width != avctx->width || hdr.height != avctx->height)
153 avcodec_set_dimensions(avctx, hdr.width, hdr.height);
155 if ((ret = ff_get_buffer(avctx, &s->frame)) < 0) {
156 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
160 chunk_type = bytestream2_get_be32(&gb);
162 if (avctx->pix_fmt == AV_PIX_FMT_PAL8 &&
163 (chunk_type == 0x3 || chunk_type == 0x3d)) {
165 uint32_t *pal_out = (uint32_t *)s->frame.data[1];
168 ret = brpix_decode_header(&palhdr, &gb);
170 av_log(avctx, AV_LOG_ERROR, "Invalid palette header length\n");
171 return AVERROR_INVALIDDATA;
173 if (palhdr.format != 7) {
174 av_log(avctx, AV_LOG_ERROR, "Palette is not in 0RGB format\n");
175 return AVERROR_INVALIDDATA;
178 chunk_type = bytestream2_get_be32(&gb);
179 data_len = bytestream2_get_be32(&gb);
180 bytestream2_skip(&gb, 8);
181 if (chunk_type != 0x21 || data_len != 1032 ||
182 bytestream2_get_bytes_left(&gb) < 1032) {
183 av_log(avctx, AV_LOG_ERROR, "Invalid palette data\n");
184 return AVERROR_INVALIDDATA;
186 // convert 0RGB to machine endian format (ARGB32)
187 for (i = 0; i < 256; ++i) {
188 bytestream2_skipu(&gb, 1);
189 *pal_out++ = (0xFFU << 24) | bytestream2_get_be24u(&gb);
191 bytestream2_skip(&gb, 8);
193 s->frame.palette_has_changed = 1;
195 chunk_type = bytestream2_get_be32(&gb);
196 } else if (avctx->pix_fmt == AV_PIX_FMT_PAL8) {
197 uint32_t *pal_out = (uint32_t *)s->frame.data[1];
200 for (i = 0; i < 256; ++i) {
201 *pal_out++ = (0xFFU << 24) | (i * 0x010101);
203 s->frame.palette_has_changed = 1;
206 data_len = bytestream2_get_be32(&gb);
207 bytestream2_skip(&gb, 8);
209 // read the image data to the buffer
211 unsigned int bytes_per_scanline = bytes_pp * hdr.width;
212 unsigned int bytes_left = bytestream2_get_bytes_left(&gb);
214 if (chunk_type != 0x21 || data_len != bytes_left ||
215 bytes_left / bytes_per_scanline < hdr.height)
217 av_log(avctx, AV_LOG_ERROR, "Invalid image data\n");
218 return AVERROR_INVALIDDATA;
221 av_image_copy_plane(s->frame.data[0], s->frame.linesize[0],
222 avpkt->data + bytestream2_tell(&gb),
224 bytes_per_scanline, hdr.height);
227 *frame_out = s->frame;
233 static av_cold int brpix_end(AVCodecContext *avctx)
235 BRPixContext *s = avctx->priv_data;
238 avctx->release_buffer(avctx, &s->frame);
243 AVCodec ff_brender_pix_decoder = {
244 .name = "brender_pix",
245 .type = AVMEDIA_TYPE_VIDEO,
246 .id = AV_CODEC_ID_BRENDER_PIX,
247 .priv_data_size = sizeof(BRPixContext),
250 .decode = brpix_decode_frame,
251 .capabilities = CODEC_CAP_DR1,
252 .long_name = NULL_IF_CONFIG_SMALL("BRender PIX image"),