FFmpeg
anm.c
Go to the documentation of this file.
1 /*
2  * Deluxe Paint Animation decoder
3  * Copyright (c) 2009 Peter Ross
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  * Deluxe Paint Animation decoder
25  */
26 
27 #include "avcodec.h"
28 #include "bytestream.h"
29 #include "internal.h"
30 
31 typedef struct AnmContext {
34 } AnmContext;
35 
37 {
38  AnmContext *s = avctx->priv_data;
39  GetByteContext gb;
40  int i;
41 
42  if (avctx->extradata_size < 16 * 8 + 4 * 256)
43  return AVERROR_INVALIDDATA;
44 
45  avctx->pix_fmt = AV_PIX_FMT_PAL8;
46 
47  s->frame = av_frame_alloc();
48  if (!s->frame)
49  return AVERROR(ENOMEM);
50 
51  bytestream2_init(&gb, avctx->extradata, avctx->extradata_size);
52  bytestream2_skipu(&gb, 16 * 8);
53  for (i = 0; i < 256; i++)
54  s->palette[i] = (0xFFU << 24) | bytestream2_get_le32u(&gb);
55 
56  return 0;
57 }
58 
59 /**
60  * Perform decode operation
61  * @param dst pointer to destination image buffer
62  * @param dst_end pointer to end of destination image buffer
63  * @param gb GetByteContext (optional, see below)
64  * @param pixel Fill color (optional, see below)
65  * @param count Pixel count
66  * @param x Pointer to x-axis counter
67  * @param width Image width
68  * @param linesize Destination image buffer linesize
69  * @return non-zero if destination buffer is exhausted
70  *
71  * a copy operation is achieved when 'gb' is set
72  * a fill operation is achieved when 'gb' is null and pixel is >= 0
73  * a skip operation is achieved when 'gb' is null and pixel is < 0
74  */
75 static inline int op(uint8_t **dst, const uint8_t *dst_end,
76  GetByteContext *gb,
77  int pixel, int count,
78  int *x, int width, int linesize)
79 {
80  int remaining = width - *x;
81  while(count > 0) {
82  int striplen = FFMIN(count, remaining);
83  if (gb) {
84  if (bytestream2_get_bytes_left(gb) < striplen)
85  goto exhausted;
86  bytestream2_get_bufferu(gb, *dst, striplen);
87  } else if (pixel >= 0)
88  memset(*dst, pixel, striplen);
89  *dst += striplen;
90  remaining -= striplen;
91  count -= striplen;
92  if (remaining <= 0) {
93  *dst += linesize - width;
94  remaining = width;
95  }
96  if (linesize > 0) {
97  if (*dst >= dst_end) goto exhausted;
98  } else {
99  if (*dst <= dst_end) goto exhausted;
100  }
101  }
102  *x = width - remaining;
103  return 0;
104 
105 exhausted:
106  *x = width - remaining;
107  return 1;
108 }
109 
110 static int decode_frame(AVCodecContext *avctx,
111  void *data, int *got_frame,
112  AVPacket *avpkt)
113 {
114  AnmContext *s = avctx->priv_data;
115  const int buf_size = avpkt->size;
116  uint8_t *dst, *dst_end;
117  GetByteContext gb;
118  int count, ret, x = 0;
119 
120  if (buf_size < 7)
121  return AVERROR_INVALIDDATA;
122 
123  if ((ret = ff_reget_buffer(avctx, s->frame, 0)) < 0)
124  return ret;
125  dst = s->frame->data[0];
126  dst_end = s->frame->data[0] + s->frame->linesize[0]*avctx->height;
127 
128  bytestream2_init(&gb, avpkt->data, buf_size);
129 
130  if (bytestream2_get_byte(&gb) != 0x42) {
131  avpriv_request_sample(avctx, "Unknown record type");
132  return AVERROR_INVALIDDATA;
133  }
134  if (bytestream2_get_byte(&gb)) {
135  avpriv_request_sample(avctx, "Padding bytes");
136  return AVERROR_PATCHWELCOME;
137  }
138  bytestream2_skip(&gb, 2);
139 
140  do {
141  /* if statements are ordered by probability */
142 #define OP(gb, pixel, count) \
143  op(&dst, dst_end, (gb), (pixel), (count), &x, avctx->width, s->frame->linesize[0])
144 
145  int type = bytestream2_get_byte(&gb);
146  count = type & 0x7F;
147  type >>= 7;
148  if (count) {
149  if (OP(type ? NULL : &gb, -1, count)) break;
150  } else if (!type) {
151  int pixel;
152  count = bytestream2_get_byte(&gb); /* count==0 gives nop */
153  pixel = bytestream2_get_byte(&gb);
154  if (OP(NULL, pixel, count)) break;
155  } else {
156  int pixel;
157  type = bytestream2_get_le16(&gb);
158  count = type & 0x3FFF;
159  type >>= 14;
160  if (!count) {
161  if (type == 0)
162  break; // stop
163  if (type == 2) {
164  avpriv_request_sample(avctx, "Unknown opcode");
165  return AVERROR_PATCHWELCOME;
166  }
167  continue;
168  }
169  pixel = type == 3 ? bytestream2_get_byte(&gb) : -1;
170  if (type == 1) count += 0x4000;
171  if (OP(type == 2 ? &gb : NULL, pixel, count)) break;
172  }
173  } while (bytestream2_get_bytes_left(&gb) > 0);
174 
175  memcpy(s->frame->data[1], s->palette, AVPALETTE_SIZE);
176 
177  *got_frame = 1;
178  if ((ret = av_frame_ref(data, s->frame)) < 0)
179  return ret;
180 
181  return buf_size;
182 }
183 
185 {
186  AnmContext *s = avctx->priv_data;
187 
188  av_frame_free(&s->frame);
189  return 0;
190 }
191 
193  .name = "anm",
194  .long_name = NULL_IF_CONFIG_SMALL("Deluxe Paint Animation"),
195  .type = AVMEDIA_TYPE_VIDEO,
196  .id = AV_CODEC_ID_ANM,
197  .priv_data_size = sizeof(AnmContext),
198  .init = decode_init,
199  .close = decode_end,
200  .decode = decode_frame,
201  .capabilities = AV_CODEC_CAP_DR1,
202  .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE,
203 };
#define NULL
Definition: coverity.c:32
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
Definition: anm.c:31
This structure describes decoded (raw) audio or video data.
Definition: frame.h:314
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:100
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
#define avpriv_request_sample(...)
int size
Definition: packet.h:364
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:741
static av_always_inline void bytestream2_init(GetByteContext *g, const uint8_t *buf, int buf_size)
Definition: bytestream.h:137
GLint GLenum type
Definition: opengl_enc.c:104
AVCodec.
Definition: codec.h:190
static void decode(AVCodecContext *dec_ctx, AVPacket *pkt, AVFrame *frame, FILE *outfile)
Definition: decode_audio.c:71
static av_always_inline unsigned int bytestream2_get_bufferu(GetByteContext *g, uint8_t *dst, unsigned int size)
Definition: bytestream.h:277
#define OP(gb, pixel, count)
#define FF_CODEC_CAP_INIT_THREADSAFE
The codec does not modify any global variables in the init function, allowing to call the init functi...
Definition: internal.h:40
uint8_t
#define av_cold
Definition: attributes.h:88
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:190
8 bits with AV_PIX_FMT_RGB32 palette
Definition: pixfmt.h:77
#define AVPALETTE_SIZE
Definition: pixfmt.h:32
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:443
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:632
uint8_t * data
Definition: packet.h:363
static av_always_inline void bytestream2_skipu(GetByteContext *g, unsigned int size)
Definition: bytestream.h:174
static av_always_inline int bytestream2_get_bytes_left(GetByteContext *g)
Definition: bytestream.h:158
static av_always_inline void bytestream2_skip(GetByteContext *g, unsigned int size)
Definition: bytestream.h:168
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:203
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:153
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:1986
const char * name
Name of the codec implementation.
Definition: codec.h:197
GLsizei count
Definition: opengl_enc.c:108
#define FFMIN(a, b)
Definition: common.h:96
#define width
AVCodec ff_anm_decoder
Definition: anm.c:192
AVFrame * frame
Definition: anm.c:32
#define s(width, name)
Definition: cbs_vp9.c:257
static av_cold int decode_init(AVCodecContext *avctx)
Definition: anm.c:36
int palette[AVPALETTE_COUNT]
Definition: anm.c:33
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:62
Libavcodec external API header.
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:345
static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
Definition: anm.c:110
main external API structure.
Definition: avcodec.h:531
int extradata_size
Definition: avcodec.h:633
uint8_t pixel
Definition: tiny_ssim.c:42
#define AVPALETTE_COUNT
Definition: pixfmt.h:33
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:328
static int op(uint8_t **dst, const uint8_t *dst_end, GetByteContext *gb, int pixel, int count, int *x, int width, int linesize)
Perform decode operation.
Definition: anm.c:75
common internal api header.
static av_cold int decode_end(AVCodecContext *avctx)
Definition: anm.c:184
void * priv_data
Definition: avcodec.h:558
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
This structure stores compressed data.
Definition: packet.h:340
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() for allocating buffers and supports custom allocators.
Definition: codec.h:50
int i
Definition: input.c:407