2 * Deluxe Paint Animation decoder
3 * Copyright (c) 2009 Peter Ross
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
24 * Deluxe Paint Animation decoder
28 #include "bytestream.h"
30 typedef struct AnmContext {
32 int palette[AVPALETTE_COUNT];
34 int x; ///< x coordinate position
37 static av_cold int decode_init(AVCodecContext *avctx)
39 AnmContext *s = avctx->priv_data;
42 avctx->pix_fmt = AV_PIX_FMT_PAL8;
44 avcodec_get_frame_defaults(&s->frame);
45 s->frame.reference = 3;
46 bytestream2_init(&s->gb, avctx->extradata, avctx->extradata_size);
47 if (bytestream2_get_bytes_left(&s->gb) < 16 * 8 + 4 * 256)
48 return AVERROR_INVALIDDATA;
50 bytestream2_skipu(&s->gb, 16 * 8);
51 for (i = 0; i < 256; i++)
52 s->palette[i] = bytestream2_get_le32u(&s->gb);
58 * Perform decode operation
59 * @param dst pointer to destination image buffer
60 * @param dst_end pointer to end of destination image buffer
61 * @param gb GetByteContext (optional, see below)
62 * @param pixel Fill color (optional, see below)
63 * @param count Pixel count
64 * @param x Pointer to x-axis counter
65 * @param width Image width
66 * @param linesize Destination image buffer linesize
67 * @return non-zero if destination buffer is exhausted
69 * a copy operation is achieved when 'gb' is set
70 * a fill operation is achieved when 'gb' is null and pixel is >= 0
71 * a skip operation is achieved when 'gb' is null and pixel is < 0
73 static inline int op(uint8_t **dst, const uint8_t *dst_end,
76 int *x, int width, int linesize)
78 int remaining = width - *x;
80 int striplen = FFMIN(count, remaining);
82 if (bytestream2_get_bytes_left(gb) < striplen)
84 bytestream2_get_bufferu(gb, *dst, striplen);
85 } else if (pixel >= 0)
86 memset(*dst, pixel, striplen);
88 remaining -= striplen;
91 *dst += linesize - width;
95 if (*dst >= dst_end) goto exhausted;
97 if (*dst <= dst_end) goto exhausted;
100 *x = width - remaining;
104 *x = width - remaining;
108 static int decode_frame(AVCodecContext *avctx,
109 void *data, int *got_frame,
112 AnmContext *s = avctx->priv_data;
113 const int buf_size = avpkt->size;
114 uint8_t *dst, *dst_end;
117 if ((ret = avctx->reget_buffer(avctx, &s->frame)) < 0){
118 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
121 dst = s->frame.data[0];
122 dst_end = s->frame.data[0] + s->frame.linesize[0]*avctx->height;
124 bytestream2_init(&s->gb, avpkt->data, buf_size);
126 if (bytestream2_get_byte(&s->gb) != 0x42) {
127 av_log_ask_for_sample(avctx, "unknown record type\n");
128 return AVERROR_INVALIDDATA;
130 if (bytestream2_get_byte(&s->gb)) {
131 av_log_ask_for_sample(avctx, "padding bytes not supported\n");
132 return AVERROR_PATCHWELCOME;
134 bytestream2_skip(&s->gb, 2);
138 /* if statements are ordered by probability */
139 #define OP(gb, pixel, count) \
140 op(&dst, dst_end, (gb), (pixel), (count), &s->x, avctx->width, s->frame.linesize[0])
142 int type = bytestream2_get_byte(&s->gb);
146 if (OP(type ? NULL : &s->gb, -1, count)) break;
149 count = bytestream2_get_byte(&s->gb); /* count==0 gives nop */
150 pixel = bytestream2_get_byte(&s->gb);
151 if (OP(NULL, pixel, count)) break;
154 type = bytestream2_get_le16(&s->gb);
155 count = type & 0x3FFF;
161 av_log_ask_for_sample(avctx, "unknown opcode");
162 return AVERROR_PATCHWELCOME;
166 pixel = type == 3 ? bytestream2_get_byte(&s->gb) : -1;
167 if (type == 1) count += 0x4000;
168 if (OP(type == 2 ? &s->gb : NULL, pixel, count)) break;
170 } while (bytestream2_get_bytes_left(&s->gb) > 0);
172 memcpy(s->frame.data[1], s->palette, AVPALETTE_SIZE);
175 *(AVFrame*)data = s->frame;
179 static av_cold int decode_end(AVCodecContext *avctx)
181 AnmContext *s = avctx->priv_data;
182 if (s->frame.data[0])
183 avctx->release_buffer(avctx, &s->frame);
187 AVCodec ff_anm_decoder = {
189 .type = AVMEDIA_TYPE_VIDEO,
190 .id = AV_CODEC_ID_ANM,
191 .priv_data_size = sizeof(AnmContext),
194 .decode = decode_frame,
195 .capabilities = CODEC_CAP_DR1,
196 .long_name = NULL_IF_CONFIG_SMALL("Deluxe Paint Animation"),