2 * Packed Animation File video decoder
3 * Copyright (c) 2012 Paul B Mahol
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
22 #include "libavutil/imgutils.h"
25 #include "bytestream.h"
26 #include "copy_block.h"
30 static const uint8_t block_sequences[16][8] = {
31 { 0, 0, 0, 0, 0, 0, 0, 0 },
32 { 2, 0, 0, 0, 0, 0, 0, 0 },
33 { 5, 7, 0, 0, 0, 0, 0, 0 },
34 { 5, 0, 0, 0, 0, 0, 0, 0 },
35 { 6, 0, 0, 0, 0, 0, 0, 0 },
36 { 5, 7, 5, 7, 0, 0, 0, 0 },
37 { 5, 7, 5, 0, 0, 0, 0, 0 },
38 { 5, 7, 6, 0, 0, 0, 0, 0 },
39 { 5, 5, 0, 0, 0, 0, 0, 0 },
40 { 3, 0, 0, 0, 0, 0, 0, 0 },
41 { 6, 6, 0, 0, 0, 0, 0, 0 },
42 { 2, 4, 0, 0, 0, 0, 0, 0 },
43 { 2, 4, 5, 7, 0, 0, 0, 0 },
44 { 2, 4, 5, 0, 0, 0, 0, 0 },
45 { 2, 4, 6, 0, 0, 0, 0, 0 },
46 { 2, 4, 5, 7, 5, 7, 0, 0 },
49 typedef struct PAFVideoDecContext {
64 static av_cold int paf_video_close(AVCodecContext *avctx)
66 PAFVideoDecContext *c = avctx->priv_data;
69 av_frame_free(&c->pic);
71 for (i = 0; i < 4; i++)
72 av_freep(&c->frame[i]);
77 static av_cold int paf_video_init(AVCodecContext *avctx)
79 PAFVideoDecContext *c = avctx->priv_data;
82 c->width = avctx->width;
83 c->height = avctx->height;
85 if (avctx->height & 3 || avctx->width & 3) {
86 av_log(avctx, AV_LOG_ERROR,
87 "width %d and height %d must be multiplie of 4.\n",
88 avctx->width, avctx->height);
89 return AVERROR_INVALIDDATA;
92 avctx->pix_fmt = AV_PIX_FMT_PAL8;
94 c->pic = av_frame_alloc();
96 return AVERROR(ENOMEM);
98 c->frame_size = avctx->width * FFALIGN(avctx->height, 256);
99 c->video_size = avctx->width * avctx->height;
100 for (i = 0; i < 4; i++) {
101 c->frame[i] = av_mallocz(c->frame_size);
103 paf_video_close(avctx);
104 return AVERROR(ENOMEM);
111 static void read4x4block(PAFVideoDecContext *c, uint8_t *dst, int width)
115 for (i = 0; i < 4; i++) {
116 bytestream2_get_buffer(&c->gb, dst, 4);
121 static void copy_color_mask(uint8_t *dst, int width, uint8_t mask, uint8_t color)
125 for (i = 0; i < 4; i++) {
126 if (mask & (1 << 7 - i))
128 if (mask & (1 << 3 - i))
129 dst[width + i] = color;
133 static void copy_src_mask(uint8_t *dst, int width, uint8_t mask, const uint8_t *src)
137 for (i = 0; i < 4; i++) {
138 if (mask & (1 << 7 - i))
140 if (mask & (1 << 3 - i))
141 dst[width + i] = src[width + i];
145 static void set_src_position(PAFVideoDecContext *c,
147 const uint8_t **pend)
149 int val = bytestream2_get_be16(&c->gb);
150 int page = val >> 14;
151 int x = (val & 0x7F);
152 int y = ((val >> 7) & 0x7F);
154 *p = c->frame[page] + x * 2 + y * 2 * c->width;
155 *pend = c->frame[page] + c->frame_size;
158 static int decode_0(PAFVideoDecContext *c, uint8_t *pkt, uint8_t code)
160 uint32_t opcode_size, offset;
161 uint8_t *dst, *dend, mask = 0, color = 0;
162 const uint8_t *src, *send, *opcodes;
165 i = bytestream2_get_byte(&c->gb);
170 align = bytestream2_tell(&c->gb) & 3;
172 bytestream2_skip(&c->gb, 4 - align);
176 val = bytestream2_get_be16(&c->gb);
178 x = (val & 0x7F) * 2;
179 y = ((val >> 7) & 0x7F) * 2;
180 dst = c->frame[page] + x + y * c->width;
181 dend = c->frame[page] + c->frame_size;
182 offset = (x & 0x7F) * 2;
183 j = bytestream2_get_le16(&c->gb) + offset;
184 if (bytestream2_get_bytes_left(&c->gb) < (j - offset) * 16)
185 return AVERROR_INVALIDDATA;
188 if (dst + 3 * c->width + 4 > dend)
189 return AVERROR_INVALIDDATA;
190 read4x4block(c, dst, c->width);
191 if ((offset & 0x3F) == 0)
194 } while (offset < j);
198 dst = c->frame[c->current_frame];
199 dend = c->frame[c->current_frame] + c->frame_size;
201 set_src_position(c, &src, &send);
202 if ((src + 3 * c->width + 4 > send) ||
203 (dst + 3 * c->width + 4 > dend) ||
204 bytestream2_get_bytes_left(&c->gb) < 4)
205 return AVERROR_INVALIDDATA;
206 copy_block4(dst, src, c->width, c->width, 4);
211 } while (i < c->video_size / 16);
213 opcode_size = bytestream2_get_le16(&c->gb);
214 bytestream2_skip(&c->gb, 2);
216 if (bytestream2_get_bytes_left(&c->gb) < opcode_size)
217 return AVERROR_INVALIDDATA;
219 opcodes = pkt + bytestream2_tell(&c->gb);
220 bytestream2_skipu(&c->gb, opcode_size);
222 dst = c->frame[c->current_frame];
224 for (i = 0; i < c->height; i += 4, dst += c->width * 3)
225 for (j = 0; j < c->width; j += 4, dst += 4) {
227 if (op > opcode_size)
228 return AVERROR_INVALIDDATA;
230 opcode = opcodes[op] & 15;
233 opcode = opcodes[op] >> 4;
236 while (block_sequences[opcode][k]) {
237 offset = c->width * 2;
238 code = block_sequences[opcode][k++];
244 color = bytestream2_get_byte(&c->gb);
246 mask = bytestream2_get_byte(&c->gb);
247 copy_color_mask(dst + offset, c->width, mask, color);
252 set_src_position(c, &src, &send);
254 if (src + offset + c->width + 4 > send)
255 return AVERROR_INVALIDDATA;
256 mask = bytestream2_get_byte(&c->gb);
257 copy_src_mask(dst + offset, c->width, mask, src + offset);
266 static int paf_video_decode(AVCodecContext *avctx, void *data,
267 int *got_frame, AVPacket *pkt)
269 PAFVideoDecContext *c = avctx->priv_data;
270 uint8_t code, *dst, *end;
274 return AVERROR_INVALIDDATA;
276 bytestream2_init(&c->gb, pkt->data, pkt->size);
278 code = bytestream2_get_byte(&c->gb);
279 if ((code & 0xF) > 4 || (code & 0xF) == 3) {
280 avpriv_request_sample(avctx, "unknown/invalid code");
281 return AVERROR_INVALIDDATA;
284 if ((ret = ff_reget_buffer(avctx, c->pic)) < 0)
287 if (code & 0x20) { // frame is keyframe
288 for (i = 0; i < 4; i++)
289 memset(c->frame[i], 0, c->frame_size);
291 memset(c->pic->data[1], 0, AVPALETTE_SIZE);
292 c->current_frame = 0;
293 c->pic->key_frame = 1;
294 c->pic->pict_type = AV_PICTURE_TYPE_I;
296 c->pic->key_frame = 0;
297 c->pic->pict_type = AV_PICTURE_TYPE_P;
300 if (code & 0x40) { // palette update
301 uint32_t *out = (uint32_t *)c->pic->data[1];
304 index = bytestream2_get_byte(&c->gb);
305 count = bytestream2_get_byte(&c->gb) + 1;
307 if (index + count > 256)
308 return AVERROR_INVALIDDATA;
309 if (bytestream2_get_bytes_left(&c->gb) < 3 * count)
310 return AVERROR_INVALIDDATA;
313 for (i = 0; i < count; i++) {
316 r = bytestream2_get_byteu(&c->gb);
318 g = bytestream2_get_byteu(&c->gb);
320 b = bytestream2_get_byteu(&c->gb);
322 *out++ = (0xFFU << 24) | (r << 16) | (g << 8) | b;
324 c->pic->palette_has_changed = 1;
327 switch (code & 0x0F) {
329 /* Block-based motion compensation using 4x4 blocks with either
330 * horizontal or vertical vectors; might incorporate VQ as well. */
331 if ((ret = decode_0(c, pkt->data, code)) < 0)
335 /* Uncompressed data. This mode specifies that (width * height) bytes
336 * should be copied directly from the encoded buffer into the output. */
337 dst = c->frame[c->current_frame];
338 // possibly chunk length data
339 bytestream2_skip(&c->gb, 2);
340 if (bytestream2_get_bytes_left(&c->gb) < c->video_size)
341 return AVERROR_INVALIDDATA;
342 bytestream2_get_bufferu(&c->gb, dst, c->video_size);
345 /* Copy reference frame: Consume the next byte in the stream as the
346 * reference frame (which should be 0, 1, 2, or 3, and should not be
347 * the same as the current frame number). */
348 frame = bytestream2_get_byte(&c->gb);
350 return AVERROR_INVALIDDATA;
351 if (frame != c->current_frame)
352 memcpy(c->frame[c->current_frame], c->frame[frame], c->frame_size);
355 /* Run length encoding.*/
356 dst = c->frame[c->current_frame];
357 end = dst + c->video_size;
359 bytestream2_skip(&c->gb, 2);
365 if (bytestream2_get_bytes_left(&c->gb) < 2)
366 return AVERROR_INVALIDDATA;
368 code = bytestream2_get_byteu(&c->gb);
369 count = FFABS(code) + 1;
371 if (dst + count > end)
372 return AVERROR_INVALIDDATA;
374 memset(dst, bytestream2_get_byteu(&c->gb), count);
376 bytestream2_get_buffer(&c->gb, dst, count);
384 av_image_copy_plane(c->pic->data[0], c->pic->linesize[0],
385 c->frame[c->current_frame], c->width,
386 c->width, c->height);
388 c->current_frame = (c->current_frame + 1) & 3;
389 if ((ret = av_frame_ref(data, c->pic)) < 0)
397 AVCodec ff_paf_video_decoder = {
399 .long_name = NULL_IF_CONFIG_SMALL("Amazing Studio Packed Animation File Video"),
400 .type = AVMEDIA_TYPE_VIDEO,
401 .id = AV_CODEC_ID_PAF_VIDEO,
402 .priv_data_size = sizeof(PAFVideoDecContext),
403 .init = paf_video_init,
404 .close = paf_video_close,
405 .decode = paf_video_decode,
406 .capabilities = AV_CODEC_CAP_DR1,