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 "libavutil/attributes.h"
23 #include "libavutil/internal.h"
24 #include "libavutil/intreadwrite.h"
25 
26 #include "avcodec.h"
27 #include "bytestream.h"
28 #include "codec_internal.h"
29 #include "decode.h"
30 
31 typedef struct ARBCContext {
33 
35 } ARBCContext;
36 
37 static int fill_tile4(AVCodecContext *avctx, int color, AVFrame *frame)
38 {
39  ARBCContext *s = avctx->priv_data;
40  GetByteContext *gb = &s->gb;
41  int nb_tiles = bytestream2_get_le16(gb);
42  int h = avctx->height - 1;
43  int pixels_overwritten = 0;
44 
45  if ((avctx->width / 4 + 1) * (avctx->height / 4 + 1) < nb_tiles)
46  return 0;
47 
48  for (int i = 0; i < nb_tiles; i++) {
49  int y = bytestream2_get_byte(gb);
50  int x = bytestream2_get_byte(gb);
51  uint16_t mask = bytestream2_get_le16(gb);
52  int start_y = y * 4, start_x = x * 4;
53  int end_y = start_y + 4, end_x = start_x + 4;
54 
55  for (int j = start_y; j < end_y; j++) {
56  for (int k = start_x; k < end_x; k++) {
57  if (mask & 0x8000) {
58  if (j >= avctx->height || k >= avctx->width) {
59  mask = mask << 1;
60  continue;
61  }
62  AV_WB24(&frame->data[0][frame->linesize[0] * (h - j) + 3 * k], color);
63  pixels_overwritten ++;
64  }
65  mask = mask << 1;
66  }
67  }
68  }
69  return pixels_overwritten;
70 }
71 
72 static int fill_tileX(AVCodecContext *avctx, int tile_width, int tile_height,
73  int color, AVFrame *frame)
74 {
75  ARBCContext *s = avctx->priv_data;
76  GetByteContext *gb = &s->gb;
77  const int step_h = tile_height / 4;
78  const int step_w = tile_width / 4;
79  int nb_tiles = bytestream2_get_le16(gb);
80  int h = avctx->height - 1;
81  int pixels_overwritten = 0;
82 
83  if ((avctx->width / tile_width + 1) * (avctx->height / tile_height + 1) < nb_tiles)
84  return 0;
85 
86  for (int i = 0; i < nb_tiles; i++) {
87  int y = bytestream2_get_byte(gb);
88  int x = bytestream2_get_byte(gb);
89  uint16_t mask = bytestream2_get_le16(gb);
90  int start_y = y * tile_height, start_x = x * tile_width;
91  int end_y = start_y + tile_height, end_x = start_x + tile_width;
92 
93  if (start_x >= avctx->width || start_y >= avctx->height)
94  continue;
95 
96  for (int j = start_y; j < end_y; j += step_h) {
97  for (int k = start_x; k < end_x; k += step_w) {
98  if (mask & 0x8000U) {
99  for (int m = 0; m < step_h; m++) {
100  for (int n = 0; n < step_w; n++) {
101  if (j + m >= avctx->height || k + n >= avctx->width)
102  continue;
103  AV_WB24(&frame->data[0][frame->linesize[0] * (h - (j + m)) + 3 * (k + n)], color);
104  }
105  }
106  pixels_overwritten += FFMIN(step_h, avctx->height - j) * FFMIN(step_w, avctx->width - k);
107  }
108  mask = mask << 1;
109  }
110  }
111  }
112  return pixels_overwritten;
113 }
114 
116  int *got_frame, AVPacket *avpkt)
117 {
118  ARBCContext *s = avctx->priv_data;
119  int ret, nb_segments;
120  int prev_pixels = avctx->width * avctx->height;
121 
122  if (avpkt->size < 10)
123  return AVERROR_INVALIDDATA;
124 
125  bytestream2_init(&s->gb, avpkt->data, avpkt->size);
126  bytestream2_skip(&s->gb, 8);
127  nb_segments = bytestream2_get_le16(&s->gb);
128  if (nb_segments == 0)
129  return avpkt->size;
130 
131  if (7 * nb_segments > bytestream2_get_bytes_left(&s->gb))
132  return AVERROR_INVALIDDATA;
133 
134  if ((ret = ff_get_buffer(avctx, frame, AV_GET_BUFFER_FLAG_REF)) < 0)
135  return ret;
136 
137  if (s->prev_frame->data[0]) {
138  ret = av_frame_copy(frame, s->prev_frame);
139  if (ret < 0)
140  return ret;
141  }
142 
143  for (int i = 0; i < nb_segments; i++) {
144  int resolution_flag;
145  int fill;
146 
147  if (bytestream2_get_bytes_left(&s->gb) <= 0)
148  return AVERROR_INVALIDDATA;
149 
150  fill = bytestream2_get_byte(&s->gb) << 16;
151  bytestream2_skip(&s->gb, 1);
152  fill |= bytestream2_get_byte(&s->gb) << 8;
153  bytestream2_skip(&s->gb, 1);
154  fill |= bytestream2_get_byte(&s->gb) << 0;
155  bytestream2_skip(&s->gb, 1);
156  resolution_flag = bytestream2_get_byte(&s->gb);
157 
158  if (resolution_flag & 0x10)
159  prev_pixels -= fill_tileX(avctx, 1024, 1024, fill, frame);
160  if (resolution_flag & 0x08)
161  prev_pixels -= fill_tileX(avctx, 256, 256, fill, frame);
162  if (resolution_flag & 0x04)
163  prev_pixels -= fill_tileX(avctx, 64, 64, fill, frame);
164  if (resolution_flag & 0x02)
165  prev_pixels -= fill_tileX(avctx, 16, 16, fill, frame);
166  if (resolution_flag & 0x01)
167  prev_pixels -= fill_tile4(avctx, fill, frame);
168  }
169 
170  if ((ret = av_frame_replace(s->prev_frame, frame)) < 0)
171  return ret;
172 
173  frame->pict_type = prev_pixels <= 0 ? AV_PICTURE_TYPE_I : AV_PICTURE_TYPE_P;
174  if (prev_pixels <= 0)
175  frame->flags |= AV_FRAME_FLAG_KEY;
176  else
177  frame->flags &= ~AV_FRAME_FLAG_KEY;
178  *got_frame = 1;
179 
180  return avpkt->size;
181 }
182 
184 {
185  ARBCContext *s = avctx->priv_data;
186 
187  avctx->pix_fmt = AV_PIX_FMT_RGB24;
188 
189  s->prev_frame = av_frame_alloc();
190  if (!s->prev_frame)
191  return AVERROR(ENOMEM);
192 
193  return 0;
194 }
195 
197 {
198  ARBCContext *s = avctx->priv_data;
199 
200  av_frame_unref(s->prev_frame);
201 }
202 
204 {
205  ARBCContext *s = avctx->priv_data;
206 
207  av_frame_free(&s->prev_frame);
208 
209  return 0;
210 }
211 
213  .p.name = "arbc",
214  CODEC_LONG_NAME("Gryphon's Anim Compressor"),
215  .p.type = AVMEDIA_TYPE_VIDEO,
216  .p.id = AV_CODEC_ID_ARBC,
217  .priv_data_size = sizeof(ARBCContext),
218  .init = decode_init,
220  .flush = decode_flush,
221  .close = decode_close,
222  .p.capabilities = AV_CODEC_CAP_DR1,
223  .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
224 };
fill_tileX
static int fill_tileX(AVCodecContext *avctx, int tile_width, int tile_height, int color, AVFrame *frame)
Definition: arbc.c:72
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: codec_internal.h:42
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
bytestream2_get_bytes_left
static av_always_inline int bytestream2_get_bytes_left(const GetByteContext *g)
Definition: bytestream.h:158
color
Definition: vf_paletteuse.c:513
GetByteContext
Definition: bytestream.h:33
mask
int mask
Definition: mediacodecdec_common.c:154
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:64
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:427
AVPacket::data
uint8_t * data
Definition: packet.h:558
ff_arbc_decoder
const FFCodec ff_arbc_decoder
Definition: arbc.c:212
decode_init
static av_cold int decode_init(AVCodecContext *avctx)
Definition: arbc.c:183
FFCodec
Definition: codec_internal.h:127
AV_CODEC_ID_ARBC
@ AV_CODEC_ID_ARBC
Definition: codec_id.h:297
decode_close
static av_cold int decode_close(AVCodecContext *avctx)
Definition: arbc.c:203
bytestream2_skip
static av_always_inline void bytestream2_skip(GetByteContext *g, unsigned int size)
Definition: bytestream.h:168
FFCodec::p
AVCodec p
The public AVCodec.
Definition: codec_internal.h:131
ARBCContext::gb
GetByteContext gb
Definition: arbc.c:32
av_frame_alloc
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:52
av_cold
#define av_cold
Definition: attributes.h:100
AV_FRAME_FLAG_KEY
#define AV_FRAME_FLAG_KEY
A flag to mark frames that are keyframes.
Definition: frame.h:642
FF_CODEC_DECODE_CB
#define FF_CODEC_DECODE_CB(func)
Definition: codec_internal.h:346
intreadwrite.h
s
#define s(width, name)
Definition: cbs_vp9.c:198
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:411
decode_frame
static int decode_frame(AVCodecContext *avctx, AVFrame *frame, int *got_frame, AVPacket *avpkt)
Definition: arbc.c:115
decode.h
CODEC_LONG_NAME
#define CODEC_LONG_NAME(str)
Definition: codec_internal.h:331
AV_PICTURE_TYPE_I
@ AV_PICTURE_TYPE_I
Intra.
Definition: avutil.h:278
ff_get_buffer
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: decode.c:1720
init
int(* init)(AVBSFContext *ctx)
Definition: dts2pts.c:368
AV_PIX_FMT_RGB24
@ AV_PIX_FMT_RGB24
packed RGB 8:8:8, 24bpp, RGBRGB...
Definition: pixfmt.h:75
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:559
codec_internal.h
av_frame_copy
int av_frame_copy(AVFrame *dst, const AVFrame *src)
Copy the frame data from src to dst.
Definition: frame.c:711
AV_WB24
#define AV_WB24(p, d)
Definition: intreadwrite.h:446
attributes.h
ARBCContext
Definition: arbc.c:31
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:256
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:496
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:179
AVCodecContext::height
int height
Definition: avcodec.h:592
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:631
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:265
av_frame_replace
int av_frame_replace(AVFrame *dst, const AVFrame *src)
Ensure the destination frame refers to the same data described by the source frame,...
Definition: frame.c:376
AVCodecContext
main external API structure.
Definition: avcodec.h:431
AV_PICTURE_TYPE_P
@ AV_PICTURE_TYPE_P
Predicted.
Definition: avutil.h:279
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:200
fill_tile4
static int fill_tile4(AVCodecContext *avctx, int color, AVFrame *frame)
Definition: arbc.c:37
AVPacket
This structure stores compressed data.
Definition: packet.h:535
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:458
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:592
bytestream.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
h
h
Definition: vp9dsp_template.c:2070
decode_flush
static av_cold void decode_flush(AVCodecContext *avctx)
Definition: arbc.c:196
ARBCContext::prev_frame
AVFrame * prev_frame
Definition: arbc.c:34