FFmpeg
arbc.c
Go to the documentation of this file.
1 /*
2  * Gryphon's Anim Compressor decoder
3  * Copyright (c) 2019 Paul B Mahol
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 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 
26 #include "libavutil/imgutils.h"
27 #include "libavutil/internal.h"
28 #include "libavutil/intreadwrite.h"
29 
30 #include "avcodec.h"
31 #include "bytestream.h"
32 #include "internal.h"
33 
34 typedef struct ARBCContext {
36 
38 } ARBCContext;
39 
40 static int fill_tile4(AVCodecContext *avctx, int color, AVFrame *frame)
41 {
42  ARBCContext *s = avctx->priv_data;
43  GetByteContext *gb = &s->gb;
44  int nb_tiles = bytestream2_get_le16(gb);
45  int h = avctx->height - 1;
46  int pixels_overwritten = 0;
47 
48  if ((avctx->width / 4 + 1) * (avctx->height / 4 + 1) < nb_tiles)
49  return 0;
50 
51  for (int i = 0; i < nb_tiles; i++) {
52  int y = bytestream2_get_byte(gb);
53  int x = bytestream2_get_byte(gb);
54  uint16_t mask = bytestream2_get_le16(gb);
55  int start_y = y * 4, start_x = x * 4;
56  int end_y = start_y + 4, end_x = start_x + 4;
57 
58  for (int j = start_y; j < end_y; j++) {
59  for (int k = start_x; k < end_x; k++) {
60  if (mask & 0x8000) {
61  if (j >= avctx->height || k >= avctx->width) {
62  mask = mask << 1;
63  continue;
64  }
65  AV_WB24(&frame->data[0][frame->linesize[0] * (h - j) + 3 * k], color);
66  pixels_overwritten ++;
67  }
68  mask = mask << 1;
69  }
70  }
71  }
72  return pixels_overwritten;
73 }
74 
75 static int fill_tileX(AVCodecContext *avctx, int tile_width, int tile_height,
76  int color, AVFrame *frame)
77 {
78  ARBCContext *s = avctx->priv_data;
79  GetByteContext *gb = &s->gb;
80  const int step_h = tile_height / 4;
81  const int step_w = tile_width / 4;
82  int nb_tiles = bytestream2_get_le16(gb);
83  int h = avctx->height - 1;
84  int pixels_overwritten = 0;
85 
86  if ((avctx->width / tile_width + 1) * (avctx->height / tile_height + 1) < nb_tiles)
87  return 0;
88 
89  for (int i = 0; i < nb_tiles; i++) {
90  int y = bytestream2_get_byte(gb);
91  int x = bytestream2_get_byte(gb);
92  uint16_t mask = bytestream2_get_le16(gb);
93  int start_y = y * tile_height, start_x = x * tile_width;
94  int end_y = start_y + tile_height, end_x = start_x + tile_width;
95 
96  if (start_x >= avctx->width || start_y >= avctx->height)
97  continue;
98 
99  for (int j = start_y; j < end_y; j += step_h) {
100  for (int k = start_x; k < end_x; k += step_w) {
101  if (mask & 0x8000U) {
102  for (int m = 0; m < step_h; m++) {
103  for (int n = 0; n < step_w; n++) {
104  if (j + m >= avctx->height || k + n >= avctx->width)
105  continue;
106  AV_WB24(&frame->data[0][frame->linesize[0] * (h - (j + m)) + 3 * (k + n)], color);
107  }
108  }
109  pixels_overwritten += FFMIN(step_h, avctx->height - j) * FFMIN(step_w, avctx->width - k);
110  }
111  mask = mask << 1;
112  }
113  }
114  }
115  return pixels_overwritten;
116 }
117 
118 static int decode_frame(AVCodecContext *avctx, void *data,
119  int *got_frame, AVPacket *avpkt)
120 {
121  ARBCContext *s = avctx->priv_data;
122  AVFrame *frame = data;
123  int ret, nb_segments;
124  int prev_pixels = avctx->width * avctx->height;
125 
126  if (avpkt->size < 10)
127  return AVERROR_INVALIDDATA;
128 
129  bytestream2_init(&s->gb, avpkt->data, avpkt->size);
130  bytestream2_skip(&s->gb, 8);
131  nb_segments = bytestream2_get_le16(&s->gb);
132  if (nb_segments == 0)
133  return avpkt->size;
134 
135  if (7 * nb_segments > bytestream2_get_bytes_left(&s->gb))
136  return AVERROR_INVALIDDATA;
137 
138  if ((ret = ff_get_buffer(avctx, frame, AV_GET_BUFFER_FLAG_REF)) < 0)
139  return ret;
140 
141  if (s->prev_frame->data[0]) {
142  ret = av_frame_copy(frame, s->prev_frame);
143  if (ret < 0)
144  return ret;
145  }
146 
147  for (int i = 0; i < nb_segments; i++) {
148  int resolution_flag;
149  int fill;
150 
151  if (bytestream2_get_bytes_left(&s->gb) <= 0)
152  return AVERROR_INVALIDDATA;
153 
154  fill = bytestream2_get_byte(&s->gb) << 16;
155  bytestream2_skip(&s->gb, 1);
156  fill |= bytestream2_get_byte(&s->gb) << 8;
157  bytestream2_skip(&s->gb, 1);
158  fill |= bytestream2_get_byte(&s->gb) << 0;
159  bytestream2_skip(&s->gb, 1);
160  resolution_flag = bytestream2_get_byte(&s->gb);
161 
162  if (resolution_flag & 0x10)
163  prev_pixels -= fill_tileX(avctx, 1024, 1024, fill, frame);
164  if (resolution_flag & 0x08)
165  prev_pixels -= fill_tileX(avctx, 256, 256, fill, frame);
166  if (resolution_flag & 0x04)
167  prev_pixels -= fill_tileX(avctx, 64, 64, fill, frame);
168  if (resolution_flag & 0x02)
169  prev_pixels -= fill_tileX(avctx, 16, 16, fill, frame);
170  if (resolution_flag & 0x01)
171  prev_pixels -= fill_tile4(avctx, fill, frame);
172  }
173 
174  av_frame_unref(s->prev_frame);
175  if ((ret = av_frame_ref(s->prev_frame, frame)) < 0)
176  return ret;
177 
178  frame->pict_type = prev_pixels <= 0 ? AV_PICTURE_TYPE_I : AV_PICTURE_TYPE_P;
179  frame->key_frame = prev_pixels <= 0;
180  *got_frame = 1;
181 
182  return avpkt->size;
183 }
184 
186 {
187  ARBCContext *s = avctx->priv_data;
188 
189  avctx->pix_fmt = AV_PIX_FMT_RGB24;
190 
191  s->prev_frame = av_frame_alloc();
192  if (!s->prev_frame)
193  return AVERROR(ENOMEM);
194 
195  return 0;
196 }
197 
198 static void decode_flush(AVCodecContext *avctx)
199 {
200  ARBCContext *s = avctx->priv_data;
201 
202  av_frame_unref(s->prev_frame);
203 }
204 
206 {
207  ARBCContext *s = avctx->priv_data;
208 
209  av_frame_free(&s->prev_frame);
210 
211  return 0;
212 }
213 
215  .name = "arbc",
216  .long_name = NULL_IF_CONFIG_SMALL("Gryphon's Anim Compressor"),
217  .type = AVMEDIA_TYPE_VIDEO,
218  .id = AV_CODEC_ID_ARBC,
219  .priv_data_size = sizeof(ARBCContext),
220  .init = decode_init,
221  .decode = decode_frame,
222  .flush = decode_flush,
223  .close = decode_close,
224  .capabilities = AV_CODEC_CAP_DR1,
226 };
fill_tileX
static int fill_tileX(AVCodecContext *avctx, int tile_width, int tile_height, int color, AVFrame *frame)
Definition: arbc.c:75
AVCodec
AVCodec.
Definition: codec.h:197
FF_CODEC_CAP_INIT_THREADSAFE
#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:42
init
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:31
AVERROR
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
color
Definition: vf_paletteuse.c:583
GetByteContext
Definition: bytestream.h:33
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:112
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
internal.h
AVPacket::data
uint8_t * data
Definition: packet.h:373
data
const char data[16]
Definition: mxf.c:143
decode_init
static av_cold int decode_init(AVCodecContext *avctx)
Definition: arbc.c:185
AV_CODEC_ID_ARBC
@ AV_CODEC_ID_ARBC
Definition: codec_id.h:292
decode_close
static av_cold int decode_close(AVCodecContext *avctx)
Definition: arbc.c:205
bytestream2_skip
static av_always_inline void bytestream2_skip(GetByteContext *g, unsigned int size)
Definition: bytestream.h:168
ARBCContext::gb
GetByteContext gb
Definition: arbc.c:35
av_frame_alloc
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:99
av_cold
#define av_cold
Definition: attributes.h:90
mask
static const uint16_t mask[17]
Definition: lzw.c:38
decode
static void decode(AVCodecContext *dec_ctx, AVPacket *pkt, AVFrame *frame, FILE *outfile)
Definition: decode_audio.c:71
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:257
AV_GET_BUFFER_FLAG_REF
#define AV_GET_BUFFER_FLAG_REF
The decoder will keep a reference to the frame and may reuse it later.
Definition: avcodec.h:357
ff_arbc_decoder
const AVCodec ff_arbc_decoder
Definition: arbc.c:214
flush
static void flush(AVCodecContext *avctx)
Definition: aacdec_template.c:593
AV_PICTURE_TYPE_I
@ AV_PICTURE_TYPE_I
Intra.
Definition: avutil.h:274
bytestream2_get_bytes_left
static av_always_inline int bytestream2_get_bytes_left(GetByteContext *g)
Definition: bytestream.h:158
ff_get_buffer
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: decode.c:1648
AV_PIX_FMT_RGB24
@ AV_PIX_FMT_RGB24
packed RGB 8:8:8, 24bpp, RGBRGB...
Definition: pixfmt.h:68
AV_CODEC_CAP_DR1
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() or get_encode_buffer() for allocating buffers and supports custom allocators.
Definition: codec.h:52
AVPacket::size
int size
Definition: packet.h:374
NULL_IF_CONFIG_SMALL
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
Definition: internal.h:116
av_frame_ref
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:327
av_frame_copy
int av_frame_copy(AVFrame *dst, const AVFrame *src)
Copy the frame data from src to dst.
Definition: frame.c:678
AV_WB24
#define AV_WB24(p, d)
Definition: intreadwrite.h:450
ARBCContext
Definition: arbc.c:34
i
int i
Definition: input.c:406
FF_CODEC_CAP_INIT_CLEANUP
#define FF_CODEC_CAP_INIT_CLEANUP
The codec allows calling the close function for deallocation even if the init function returned a fai...
Definition: internal.h:50
internal.h
FFMIN
#define FFMIN(a, b)
Definition: macros.h:49
av_frame_unref
void av_frame_unref(AVFrame *frame)
Unreference all the buffers referenced by frame and reset the frame fields.
Definition: frame.c:437
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:204
AVCodecContext::height
int height
Definition: avcodec.h:552
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:589
avcodec.h
ret
ret
Definition: filter_design.txt:187
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
AVCodecContext
main external API structure.
Definition: avcodec.h:379
AV_PICTURE_TYPE_P
@ AV_PICTURE_TYPE_P
Predicted.
Definition: avutil.h:275
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
decode_frame
static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
Definition: arbc.c:118
fill_tile4
static int fill_tile4(AVCodecContext *avctx, int color, AVFrame *frame)
Definition: arbc.c:40
AVPacket
This structure stores compressed data.
Definition: packet.h:350
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:406
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:552
bytestream.h
imgutils.h
bytestream2_init
static av_always_inline void bytestream2_init(GetByteContext *g, const uint8_t *buf, int buf_size)
Definition: bytestream.h:137
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
decode_flush
static void decode_flush(AVCodecContext *avctx)
Definition: arbc.c:198
h
h
Definition: vp9dsp_template.c:2038
ARBCContext::prev_frame
AVFrame * prev_frame
Definition: arbc.c:37