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