2 * Packed Animation File video and audio 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"
23 #include "libavutil/intreadwrite.h"
25 #include "libavcodec/paf.h"
27 #include "bytestream.h"
28 #include "copy_block.h"
32 static const uint8_t block_sequences[16][8] = {
33 { 0, 0, 0, 0, 0, 0, 0, 0 },
34 { 2, 0, 0, 0, 0, 0, 0, 0 },
35 { 5, 7, 0, 0, 0, 0, 0, 0 },
36 { 5, 0, 0, 0, 0, 0, 0, 0 },
37 { 6, 0, 0, 0, 0, 0, 0, 0 },
38 { 5, 7, 5, 7, 0, 0, 0, 0 },
39 { 5, 7, 5, 0, 0, 0, 0, 0 },
40 { 5, 7, 6, 0, 0, 0, 0, 0 },
41 { 5, 5, 0, 0, 0, 0, 0, 0 },
42 { 3, 0, 0, 0, 0, 0, 0, 0 },
43 { 6, 6, 0, 0, 0, 0, 0, 0 },
44 { 2, 4, 0, 0, 0, 0, 0, 0 },
45 { 2, 4, 5, 7, 0, 0, 0, 0 },
46 { 2, 4, 5, 0, 0, 0, 0, 0 },
47 { 2, 4, 6, 0, 0, 0, 0, 0 },
48 { 2, 4, 5, 7, 5, 7, 0, 0 },
51 typedef struct PAFVideoDecContext {
66 static av_cold int paf_video_close(AVCodecContext *avctx)
68 PAFVideoDecContext *c = avctx->priv_data;
71 av_frame_free(&c->pic);
73 for (i = 0; i < 4; i++)
74 av_freep(&c->frame[i]);
79 static av_cold int paf_video_init(AVCodecContext *avctx)
81 PAFVideoDecContext *c = avctx->priv_data;
84 c->width = avctx->width;
85 c->height = avctx->height;
87 if (avctx->height & 3 || avctx->width & 3) {
88 av_log(avctx, AV_LOG_ERROR,
89 "width %d and height %d must be multiplie of 4.\n",
90 avctx->width, avctx->height);
91 return AVERROR_INVALIDDATA;
94 avctx->pix_fmt = AV_PIX_FMT_PAL8;
96 c->pic = av_frame_alloc();
98 return AVERROR(ENOMEM);
100 c->frame_size = avctx->width * FFALIGN(avctx->height, 256);
101 c->video_size = avctx->width * avctx->height;
102 for (i = 0; i < 4; i++) {
103 c->frame[i] = av_mallocz(c->frame_size);
105 paf_video_close(avctx);
106 return AVERROR(ENOMEM);
113 static void read4x4block(PAFVideoDecContext *c, uint8_t *dst, int width)
117 for (i = 0; i < 4; i++) {
118 bytestream2_get_buffer(&c->gb, dst, 4);
123 static void copy_color_mask(uint8_t *dst, int width, uint8_t mask, uint8_t color)
127 for (i = 0; i < 4; i++) {
128 if (mask & (1 << 7 - i))
130 if (mask & (1 << 3 - i))
131 dst[width + i] = color;
135 static void copy_src_mask(uint8_t *dst, int width, uint8_t mask, const uint8_t *src)
139 for (i = 0; i < 4; i++) {
140 if (mask & (1 << 7 - i))
142 if (mask & (1 << 3 - i))
143 dst[width + i] = src[width + i];
147 static void set_src_position(PAFVideoDecContext *c,
149 const uint8_t **pend)
151 int val = bytestream2_get_be16(&c->gb);
152 int page = val >> 14;
153 int x = (val & 0x7F);
154 int y = ((val >> 7) & 0x7F);
156 *p = c->frame[page] + x * 2 + y * 2 * c->width;
157 *pend = c->frame[page] + c->frame_size;
160 static int decode_0(PAFVideoDecContext *c, uint8_t *pkt, uint8_t code)
162 uint32_t opcode_size, offset;
163 uint8_t *dst, *dend, mask = 0, color = 0;
164 const uint8_t *src, *send, *opcodes;
167 i = bytestream2_get_byte(&c->gb);
172 align = bytestream2_tell(&c->gb) & 3;
174 bytestream2_skip(&c->gb, 4 - align);
178 val = bytestream2_get_be16(&c->gb);
180 x = (val & 0x7F) * 2;
181 y = ((val >> 7) & 0x7F) * 2;
182 dst = c->frame[page] + x + y * c->width;
183 dend = c->frame[page] + c->frame_size;
184 offset = (x & 0x7F) * 2;
185 j = bytestream2_get_le16(&c->gb) + offset;
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 return AVERROR_INVALIDDATA;
205 copy_block4(dst, src, c->width, c->width, 4);
210 } while (i < c->video_size / 16);
212 opcode_size = bytestream2_get_le16(&c->gb);
213 bytestream2_skip(&c->gb, 2);
215 if (bytestream2_get_bytes_left(&c->gb) < opcode_size)
216 return AVERROR_INVALIDDATA;
218 opcodes = pkt + bytestream2_tell(&c->gb);
219 bytestream2_skipu(&c->gb, opcode_size);
221 dst = c->frame[c->current_frame];
223 for (i = 0; i < c->height; i += 4, dst += c->width * 3)
224 for (j = 0; j < c->width; j += 4, dst += 4) {
226 if (op > opcode_size)
227 return AVERROR_INVALIDDATA;
229 opcode = opcodes[op] & 15;
232 opcode = opcodes[op] >> 4;
235 while (block_sequences[opcode][k]) {
236 offset = c->width * 2;
237 code = block_sequences[opcode][k++];
243 color = bytestream2_get_byte(&c->gb);
245 mask = bytestream2_get_byte(&c->gb);
246 copy_color_mask(dst + offset, c->width, mask, color);
251 set_src_position(c, &src, &send);
253 if (src + offset + c->width + 4 > send)
254 return AVERROR_INVALIDDATA;
255 mask = bytestream2_get_byte(&c->gb);
256 copy_src_mask(dst + offset, c->width, mask, src + offset);
265 static int paf_video_decode(AVCodecContext *avctx, void *data,
266 int *got_frame, AVPacket *pkt)
268 PAFVideoDecContext *c = avctx->priv_data;
269 uint8_t code, *dst, *end;
272 if ((ret = ff_reget_buffer(avctx, c->pic)) < 0)
275 bytestream2_init(&c->gb, pkt->data, pkt->size);
277 code = bytestream2_get_byte(&c->gb);
278 if (code & 0x20) { // frame is keyframe
279 for (i = 0; i < 4; i++)
280 memset(c->frame[i], 0, c->frame_size);
282 memset(c->pic->data[1], 0, AVPALETTE_SIZE);
283 c->current_frame = 0;
284 c->pic->key_frame = 1;
285 c->pic->pict_type = AV_PICTURE_TYPE_I;
287 c->pic->key_frame = 0;
288 c->pic->pict_type = AV_PICTURE_TYPE_P;
291 if (code & 0x40) { // palette update
292 uint32_t *out = (uint32_t *)c->pic->data[1];
295 index = bytestream2_get_byte(&c->gb);
296 count = bytestream2_get_byte(&c->gb) + 1;
298 if (index + count > 256)
299 return AVERROR_INVALIDDATA;
300 if (bytestream2_get_bytes_left(&c->gb) < 3 * count)
301 return AVERROR_INVALIDDATA;
304 for (i = 0; i < count; i++) {
307 r = bytestream2_get_byteu(&c->gb);
309 g = bytestream2_get_byteu(&c->gb);
311 b = bytestream2_get_byteu(&c->gb);
313 *out++ = (0xFFU << 24) | (r << 16) | (g << 8) | b;
315 c->pic->palette_has_changed = 1;
318 switch (code & 0x0F) {
320 /* Block-based motion compensation using 4x4 blocks with either
321 * horizontal or vertical vectors; might incorporate VQ as well. */
322 if ((ret = decode_0(c, pkt->data, code)) < 0)
326 /* Uncompressed data. This mode specifies that (width * height) bytes
327 * should be copied directly from the encoded buffer into the output. */
328 dst = c->frame[c->current_frame];
329 // possibly chunk length data
330 bytestream2_skip(&c->gb, 2);
331 if (bytestream2_get_bytes_left(&c->gb) < c->video_size)
332 return AVERROR_INVALIDDATA;
333 bytestream2_get_bufferu(&c->gb, dst, c->video_size);
336 /* Copy reference frame: Consume the next byte in the stream as the
337 * reference frame (which should be 0, 1, 2, or 3, and should not be
338 * the same as the current frame number). */
339 frame = bytestream2_get_byte(&c->gb);
341 return AVERROR_INVALIDDATA;
342 if (frame != c->current_frame)
343 memcpy(c->frame[c->current_frame], c->frame[frame], c->frame_size);
346 /* Run length encoding.*/
347 dst = c->frame[c->current_frame];
348 end = dst + c->video_size;
350 bytestream2_skip(&c->gb, 2);
356 if (bytestream2_get_bytes_left(&c->gb) < 2)
357 return AVERROR_INVALIDDATA;
359 code = bytestream2_get_byteu(&c->gb);
360 count = FFABS(code) + 1;
362 if (dst + count > end)
363 return AVERROR_INVALIDDATA;
365 memset(dst, bytestream2_get_byteu(&c->gb), count);
367 bytestream2_get_buffer(&c->gb, dst, count);
372 avpriv_request_sample(avctx, "unknown/invalid code");
373 return AVERROR_INVALIDDATA;
376 av_image_copy_plane(c->pic->data[0], c->pic->linesize[0],
377 c->frame[c->current_frame], c->width,
378 c->width, c->height);
380 c->current_frame = (c->current_frame + 1) & 3;
381 if ((ret = av_frame_ref(data, c->pic)) < 0)
389 static av_cold int paf_audio_init(AVCodecContext *avctx)
391 if (avctx->channels != 2) {
392 av_log(avctx, AV_LOG_ERROR, "invalid number of channels\n");
393 return AVERROR_INVALIDDATA;
396 avctx->channel_layout = AV_CH_LAYOUT_STEREO;
397 avctx->sample_fmt = AV_SAMPLE_FMT_S16;
402 static int paf_audio_decode(AVCodecContext *avctx, void *data,
403 int *got_frame, AVPacket *pkt)
405 AVFrame *frame = data;
406 int16_t *output_samples;
407 const uint8_t *src = pkt->data;
408 int frames, ret, i, j;
411 frames = pkt->size / PAF_SOUND_FRAME_SIZE;
413 return AVERROR_INVALIDDATA;
415 frame->nb_samples = PAF_SOUND_SAMPLES * frames;
416 if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
419 output_samples = (int16_t *)frame->data[0];
420 // codebook of 256 16-bit samples and 8-bit indices to it
421 for (j = 0; j < frames; j++) {
422 for (i = 0; i < 256; i++)
423 cb[i] = sign_extend(AV_RL16(src + i * 2), 16);
426 for (i = 0; i < PAF_SOUND_SAMPLES * 2; i++)
427 *output_samples++ = cb[*src++];
434 #if CONFIG_PAF_VIDEO_DECODER
435 AVCodec ff_paf_video_decoder = {
437 .long_name = NULL_IF_CONFIG_SMALL("Amazing Studio Packed Animation File Video"),
438 .type = AVMEDIA_TYPE_VIDEO,
439 .id = AV_CODEC_ID_PAF_VIDEO,
440 .priv_data_size = sizeof(PAFVideoDecContext),
441 .init = paf_video_init,
442 .close = paf_video_close,
443 .decode = paf_video_decode,
444 .capabilities = CODEC_CAP_DR1,
448 #if CONFIG_PAF_AUDIO_DECODER
449 AVCodec ff_paf_audio_decoder = {
451 .long_name = NULL_IF_CONFIG_SMALL("Amazing Studio Packed Animation File Audio"),
452 .type = AVMEDIA_TYPE_AUDIO,
453 .id = AV_CODEC_ID_PAF_AUDIO,
454 .init = paf_audio_init,
455 .decode = paf_audio_decode,
456 .capabilities = CODEC_CAP_DR1,