FFmpeg
kgv1dec.c
Go to the documentation of this file.
1 /*
2  * Kega Game Video (KGV1) decoder
3  * Copyright (c) 2010 Daniel Verkamp
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  * Kega Game Video decoder
25  */
26 
27 #include "libavutil/common.h"
28 #include "libavutil/intreadwrite.h"
29 #include "libavutil/imgutils.h"
30 #include "avcodec.h"
31 #include "internal.h"
32 
33 typedef struct KgvContext {
34  uint16_t *frame_buffer;
35  uint16_t *last_frame_buffer;
36 } KgvContext;
37 
38 static void decode_flush(AVCodecContext *avctx)
39 {
40  KgvContext * const c = avctx->priv_data;
41 
42  av_freep(&c->frame_buffer);
43  av_freep(&c->last_frame_buffer);
44 }
45 
46 static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame,
47  AVPacket *avpkt)
48 {
49  AVFrame *frame = data;
50  const uint8_t *buf = avpkt->data;
51  const uint8_t *buf_end = buf + avpkt->size;
52  KgvContext * const c = avctx->priv_data;
53  int offsets[8];
54  uint8_t *out, *prev;
55  int outcnt = 0, maxcnt;
56  int w, h, i, res;
57 
58  if (avpkt->size < 2)
59  return AVERROR_INVALIDDATA;
60 
61  w = (buf[0] + 1) * 8;
62  h = (buf[1] + 1) * 8;
63  buf += 2;
64 
65  if (avpkt->size < 2 + w*h / 513)
66  return AVERROR_INVALIDDATA;
67 
68  if (w != avctx->width || h != avctx->height) {
69  av_freep(&c->frame_buffer);
70  av_freep(&c->last_frame_buffer);
71  if ((res = ff_set_dimensions(avctx, w, h)) < 0)
72  return res;
73  }
74 
75  if (!c->frame_buffer) {
76  c->frame_buffer = av_mallocz(avctx->width * avctx->height * 2);
77  c->last_frame_buffer = av_mallocz(avctx->width * avctx->height * 2);
78  if (!c->frame_buffer || !c->last_frame_buffer) {
79  decode_flush(avctx);
80  return AVERROR(ENOMEM);
81  }
82  }
83 
84  maxcnt = w * h;
85 
86  if ((res = ff_get_buffer(avctx, frame, 0)) < 0)
87  return res;
88  out = (uint8_t*)c->frame_buffer;
89  prev = (uint8_t*)c->last_frame_buffer;
90 
91  for (i = 0; i < 8; i++)
92  offsets[i] = -1;
93 
94  while (outcnt < maxcnt && buf_end - 2 >= buf) {
95  int code = AV_RL16(buf);
96  buf += 2;
97 
98  if (!(code & 0x8000)) {
99  AV_WN16A(&out[2 * outcnt], code); // rgb555 pixel coded directly
100  outcnt++;
101  } else {
102  int count;
103 
104  if ((code & 0x6000) == 0x6000) {
105  // copy from previous frame
106  int oidx = (code >> 10) & 7;
107  int start;
108 
109  count = (code & 0x3FF) + 3;
110 
111  if (offsets[oidx] < 0) {
112  if (buf_end - 3 < buf)
113  break;
114  offsets[oidx] = AV_RL24(buf);
115  buf += 3;
116  }
117 
118  start = (outcnt + offsets[oidx]) % maxcnt;
119 
120  if (maxcnt - start < count || maxcnt - outcnt < count)
121  break;
122 
123  if (!prev) {
124  av_log(avctx, AV_LOG_ERROR,
125  "Frame reference does not exist\n");
126  break;
127  }
128 
129  memcpy(out + 2 * outcnt, prev + 2 * start, 2 * count);
130  } else {
131  // copy from earlier in this frame
132  int offset = (code & 0x1FFF) + 1;
133 
134  if (!(code & 0x6000)) {
135  count = 2;
136  } else if ((code & 0x6000) == 0x2000) {
137  count = 3;
138  } else {
139  if (buf_end - 1 < buf)
140  break;
141  count = 4 + *buf++;
142  }
143 
144  if (outcnt < offset || maxcnt - outcnt < count)
145  break;
146 
147  av_memcpy_backptr(out + 2 * outcnt, 2 * offset, 2 * count);
148  }
149  outcnt += count;
150  }
151  }
152 
153  if (outcnt - maxcnt)
154  av_log(avctx, AV_LOG_DEBUG, "frame finished with %d diff\n", outcnt - maxcnt);
155 
156  av_image_copy_plane(frame->data[0], frame->linesize[0],
157  (const uint8_t*)c->frame_buffer, avctx->width * 2,
158  avctx->width * 2, avctx->height);
159  FFSWAP(uint16_t *, c->frame_buffer, c->last_frame_buffer);
160 
161  *got_frame = 1;
162 
163  return avpkt->size;
164 }
165 
167 {
168  avctx->pix_fmt = AV_PIX_FMT_RGB555;
169 
170  return 0;
171 }
172 
174 {
175  decode_flush(avctx);
176  return 0;
177 }
178 
180  .name = "kgv1",
181  .long_name = NULL_IF_CONFIG_SMALL("Kega Game Video"),
182  .type = AVMEDIA_TYPE_VIDEO,
183  .id = AV_CODEC_ID_KGV1,
184  .priv_data_size = sizeof(KgvContext),
185  .init = decode_init,
186  .close = decode_end,
187  .decode = decode_frame,
188  .flush = decode_flush,
189  .capabilities = AV_CODEC_CAP_DR1,
190  .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE,
191 };
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
out
FILE * out
Definition: movenc.c:54
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
w
uint8_t w
Definition: llviddspenc.c:38
internal.h
AVPacket::data
uint8_t * data
Definition: packet.h:373
data
const char data[16]
Definition: mxf.c:143
av_image_copy_plane
void av_image_copy_plane(uint8_t *dst, int dst_linesize, const uint8_t *src, int src_linesize, int bytewidth, int height)
Copy image plane from src to dst.
Definition: imgutils.c:374
KgvContext
Definition: kgv1dec.c:33
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
av_cold
#define av_cold
Definition: attributes.h:90
av_memcpy_backptr
void av_memcpy_backptr(uint8_t *dst, int back, int cnt)
Overlapping memcpy() implementation.
Definition: mem.c:452
decode
static void decode(AVCodecContext *dec_ctx, AVPacket *pkt, AVFrame *frame, FILE *outfile)
Definition: decode_audio.c:71
intreadwrite.h
offsets
static const int offsets[]
Definition: hevc_pel.c:34
AV_LOG_DEBUG
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:201
AV_RL16
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_RL16
Definition: bytestream.h:94
AV_WN16A
#define AV_WN16A(p, v)
Definition: intreadwrite.h:534
flush
static void flush(AVCodecContext *avctx)
Definition: aacdec_template.c:593
decode_flush
static void decode_flush(AVCodecContext *avctx)
Definition: kgv1dec.c:38
c
Undefined Behavior In the C some operations are like signed integer dereferencing freed accessing outside allocated Undefined Behavior must not occur in a C it is not safe even if the output of undefined operations is unused The unsafety may seem nit picking but Optimizing compilers have in fact optimized code on the assumption that no undefined Behavior occurs Optimizing code based on wrong assumptions can and has in some cases lead to effects beyond the output of computations The signed integer overflow problem in speed critical code Code which is highly optimized and works with signed integers sometimes has the problem that often the output of the computation does not c
Definition: undefined.txt:32
ff_get_buffer
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: decode.c:1648
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:117
AV_RL24
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_RL24
Definition: bytestream.h:93
offset
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf offset
Definition: writing_filters.txt:86
ff_kgv1_decoder
const AVCodec ff_kgv1_decoder
Definition: kgv1dec.c:179
i
int i
Definition: input.c:406
code
and forward the test the status of outputs and forward it to the corresponding return FFERROR_NOT_READY If the filters stores internally one or a few frame for some it can consider them to be part of the FIFO and delay acknowledging a status change accordingly Example code
Definition: filter_design.txt:178
decode_frame
static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
Definition: kgv1dec.c:46
common.h
AV_PIX_FMT_RGB555
#define AV_PIX_FMT_RGB555
Definition: pixfmt.h:377
AV_CODEC_ID_KGV1
@ AV_CODEC_ID_KGV1
Definition: codec_id.h:188
av_mallocz
void * av_mallocz(size_t size)
Allocate a memory block with alignment suitable for all memory accesses (including vectors if availab...
Definition: mem.c:261
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:204
decode_init
static av_cold int decode_init(AVCodecContext *avctx)
Definition: kgv1dec.c:166
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
FFSWAP
#define FFSWAP(type, a, b)
Definition: macros.h:52
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
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
ff_set_dimensions
int ff_set_dimensions(AVCodecContext *s, int width, int height)
Check that the provided frame dimensions are valid and set them on the codec context.
Definition: utils.c:86
KgvContext::frame_buffer
uint16_t * frame_buffer
Definition: kgv1dec.c:34
KgvContext::last_frame_buffer
uint16_t * last_frame_buffer
Definition: kgv1dec.c:35
AVPacket
This structure stores compressed data.
Definition: packet.h:350
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:406
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:35
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:552
imgutils.h
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
h
h
Definition: vp9dsp_template.c:2038
decode_end
static av_cold int decode_end(AVCodecContext *avctx)
Definition: kgv1dec.c:173