FFmpeg
midivid.c
Go to the documentation of this file.
1 /*
2  * MidiVid 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/imgutils.h"
24 #include "libavutil/internal.h"
25 #include "libavutil/mem.h"
26 
27 #define BITSTREAM_READER_LE
28 #include "avcodec.h"
29 #include "get_bits.h"
30 #include "bytestream.h"
31 #include "codec_internal.h"
32 #include "decode.h"
33 
34 typedef struct MidiVidContext {
36 
37  uint8_t *uncompressed;
38  unsigned int uncompressed_size;
39  uint8_t *skip;
40 
43 
45 {
46  GetByteContext *gb = &s->gb;
48  GetByteContext idx9;
49  uint16_t nb_vectors, intra_flag;
50  const uint8_t *vec;
51  const uint8_t *mask_start;
52  uint8_t *skip;
53  uint32_t mask_size;
54  int idx9bits = 0;
55  int idx9val = 0;
56  uint32_t nb_blocks;
57 
58  nb_vectors = bytestream2_get_le16(gb);
59  intra_flag = !!bytestream2_get_le16(gb);
60  if (intra_flag) {
61  nb_blocks = (avctx->width / 2) * (avctx->height / 2);
62  } else {
63  int ret, skip_linesize, padding;
64 
65  nb_blocks = bytestream2_get_le32(gb);
66  skip_linesize = avctx->width >> 1;
67  mask_start = gb->buffer_start + bytestream2_tell(gb);
68  mask_size = (FFALIGN(avctx->width, 32) >> 2) * (avctx->height >> 2) >> 3;
69  padding = (FFALIGN(avctx->width, 32) - avctx->width) >> 2;
70 
71  if (bytestream2_get_bytes_left(gb) < mask_size)
72  return AVERROR_INVALIDDATA;
73 
74  ret = init_get_bits8(&mask, mask_start, mask_size);
75  if (ret < 0)
76  return ret;
77  bytestream2_skip(gb, mask_size);
78  skip = s->skip;
79 
80  for (int y = 0; y < avctx->height >> 2; y++) {
81  for (int x = 0; x < avctx->width >> 2; x++) {
82  int flag = !get_bits1(&mask);
83 
84  skip[(y*2) *skip_linesize + x*2 ] = flag;
85  skip[(y*2) *skip_linesize + x*2+1] = flag;
86  skip[(y*2+1)*skip_linesize + x*2 ] = flag;
87  skip[(y*2+1)*skip_linesize + x*2+1] = flag;
88  }
89  skip_bits_long(&mask, padding);
90  }
91  }
92 
93  vec = gb->buffer_start + bytestream2_tell(gb);
94  if (bytestream2_get_bytes_left(gb) < nb_vectors * 12)
95  return AVERROR_INVALIDDATA;
96  bytestream2_skip(gb, nb_vectors * 12);
97  if (nb_vectors > 256) {
98  if (bytestream2_get_bytes_left(gb) < (nb_blocks + 7 * !intra_flag) / 8)
99  return AVERROR_INVALIDDATA;
100  bytestream2_init(&idx9, gb->buffer_start + bytestream2_tell(gb), (nb_blocks + 7 * !intra_flag) / 8);
101  bytestream2_skip(gb, (nb_blocks + 7 * !intra_flag) / 8);
102  }
103 
104  skip = s->skip;
105 
106  for (int y = avctx->height - 2; y >= 0; y -= 2) {
107  uint8_t *dsty = frame->data[0] + y * frame->linesize[0];
108  uint8_t *dstu = frame->data[1] + y * frame->linesize[1];
109  uint8_t *dstv = frame->data[2] + y * frame->linesize[2];
110 
111  for (int x = 0; x < avctx->width; x += 2) {
112  int idx;
113 
114  if (!intra_flag && *skip++)
115  continue;
116  if (bytestream2_get_bytes_left(gb) <= 0)
117  return AVERROR_INVALIDDATA;
118  if (nb_vectors <= 256) {
119  idx = bytestream2_get_byte(gb);
120  } else {
121  if (idx9bits == 0) {
122  idx9val = bytestream2_get_byte(&idx9);
123  idx9bits = 8;
124  }
125  idx9bits--;
126  idx = bytestream2_get_byte(gb) | (((idx9val >> (7 - idx9bits)) & 1) << 8);
127  }
128  if (idx >= nb_vectors)
129  return AVERROR_INVALIDDATA;
130 
131  dsty[x +frame->linesize[0]] = vec[idx * 12 + 0];
132  dsty[x+1+frame->linesize[0]] = vec[idx * 12 + 3];
133  dsty[x] = vec[idx * 12 + 6];
134  dsty[x+1] = vec[idx * 12 + 9];
135 
136  dstu[x +frame->linesize[1]] = vec[idx * 12 + 1];
137  dstu[x+1+frame->linesize[1]] = vec[idx * 12 + 4];
138  dstu[x] = vec[idx * 12 + 7];
139  dstu[x+1] = vec[idx * 12 +10];
140 
141  dstv[x +frame->linesize[2]] = vec[idx * 12 + 2];
142  dstv[x+1+frame->linesize[2]] = vec[idx * 12 + 5];
143  dstv[x] = vec[idx * 12 + 8];
144  dstv[x+1] = vec[idx * 12 +11];
145  }
146  }
147 
148  return intra_flag;
149 }
150 
151 static ptrdiff_t lzss_uncompress(MidiVidContext *s, GetByteContext *gb, uint8_t *dst, unsigned int size)
152 {
153  uint8_t *dst_start = dst;
154  uint8_t *dst_end = dst + size;
155 
156  for (;bytestream2_get_bytes_left(gb) >= 3;) {
157  int op = bytestream2_get_le16(gb);
158 
159  for (int i = 0; i < 16; i++) {
160  if (op & 1) {
161  int s0 = bytestream2_get_byte(gb);
162  int s1 = bytestream2_get_byte(gb);
163  int offset = ((s0 & 0xF0) << 4) | s1;
164  int length = (s0 & 0xF) + 3;
165 
166  if (dst + length > dst_end ||
167  dst - offset < dst_start)
168  return AVERROR_INVALIDDATA;
169  if (offset > 0) {
170  for (int j = 0; j < length; j++) {
171  dst[j] = dst[j - offset];
172  }
173  }
174  dst += length;
175  } else {
176  if (dst >= dst_end)
177  return AVERROR_INVALIDDATA;
178  *dst++ = bytestream2_get_byte(gb);
179  }
180  op >>= 1;
181  }
182  }
183 
184  return dst - dst_start;
185 }
186 
187 static int decode_frame(AVCodecContext *avctx, AVFrame *rframe,
188  int *got_frame, AVPacket *avpkt)
189 {
190  MidiVidContext *s = avctx->priv_data;
191  GetByteContext *gb = &s->gb;
192  AVFrame *frame = s->frame;
193  int ret, key, uncompressed;
194 
195  if (avpkt->size <= 13)
196  return AVERROR_INVALIDDATA;
197 
198  bytestream2_init(gb, avpkt->data, avpkt->size);
199  bytestream2_skip(gb, 8);
200  uncompressed = bytestream2_get_le32(gb);
201 
202  if (!uncompressed) {
203  av_fast_padded_malloc(&s->uncompressed, &s->uncompressed_size, 16LL * (avpkt->size - 12));
204  if (!s->uncompressed)
205  return AVERROR(ENOMEM);
206 
207  ret = lzss_uncompress(s, gb, s->uncompressed, s->uncompressed_size);
208  if (ret < 0)
209  return ret;
210  bytestream2_init(gb, s->uncompressed, ret);
211  }
212 
213  if ((ret = ff_reget_buffer(avctx, s->frame, 0)) < 0)
214  return ret;
215 
216  ret = decode_mvdv(s, avctx, frame);
217 
218  if (ret < 0)
219  return ret;
220  key = ret;
221 
222  if ((ret = av_frame_ref(rframe, s->frame)) < 0)
223  return ret;
224 
225  frame->pict_type = key ? AV_PICTURE_TYPE_I : AV_PICTURE_TYPE_P;
226  if (key)
227  frame->flags |= AV_FRAME_FLAG_KEY;
228  else
229  frame->flags &= ~AV_FRAME_FLAG_KEY;
230  *got_frame = 1;
231 
232  return avpkt->size;
233 }
234 
236 {
237  MidiVidContext *s = avctx->priv_data;
238  int ret = av_image_check_size(avctx->width, avctx->height, 0, avctx);
239 
240  if (avctx->width & 3 || avctx->height & 3)
242 
243  if (ret < 0) {
244  av_log(avctx, AV_LOG_ERROR, "Invalid image size %dx%d.\n",
245  avctx->width, avctx->height);
246  return ret;
247  }
248 
249  avctx->pix_fmt = AV_PIX_FMT_YUV444P;
250 
251  s->frame = av_frame_alloc();
252  if (!s->frame)
253  return AVERROR(ENOMEM);
254  s->skip = av_calloc(avctx->width >> 1, avctx->height >> 1);
255  if (!s->skip)
256  return AVERROR(ENOMEM);
257 
258  return 0;
259 }
260 
262 {
263  MidiVidContext *s = avctx->priv_data;
264 
265  av_frame_unref(s->frame);
266 }
267 
269 {
270  MidiVidContext *s = avctx->priv_data;
271 
272  av_frame_free(&s->frame);
273  av_freep(&s->uncompressed);
274  av_freep(&s->skip);
275 
276  return 0;
277 }
278 
280  .p.name = "mvdv",
281  CODEC_LONG_NAME("MidiVid VQ"),
282  .p.type = AVMEDIA_TYPE_VIDEO,
283  .p.id = AV_CODEC_ID_MVDV,
284  .priv_data_size = sizeof(MidiVidContext),
285  .init = decode_init,
287  .flush = decode_flush,
288  .close = decode_close,
289  .p.capabilities = AV_CODEC_CAP_DR1,
290  .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
291 };
skip_bits_long
static void skip_bits_long(GetBitContext *s, int n)
Skips the specified number of bits.
Definition: get_bits.h:276
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
GetByteContext::buffer_start
const uint8_t * buffer_start
Definition: bytestream.h:34
bytestream2_get_bytes_left
static av_always_inline int bytestream2_get_bytes_left(const GetByteContext *g)
Definition: bytestream.h:158
GetByteContext
Definition: bytestream.h:33
bytestream2_tell
static av_always_inline int bytestream2_tell(const GetByteContext *g)
Definition: bytestream.h:192
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
decode_flush
static av_cold void decode_flush(AVCodecContext *avctx)
Definition: midivid.c:261
FFCodec
Definition: codec_internal.h:127
MidiVidContext
Definition: midivid.c:34
MidiVidContext::uncompressed
uint8_t * uncompressed
Definition: midivid.c:37
decode_close
static av_cold int decode_close(AVCodecContext *avctx)
Definition: midivid.c:268
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
GetBitContext
Definition: get_bits.h:109
MidiVidContext::frame
AVFrame * frame
Definition: midivid.c:41
av_frame_alloc
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:52
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:210
av_cold
#define av_cold
Definition: attributes.h:90
init_get_bits8
static int init_get_bits8(GetBitContext *s, const uint8_t *buffer, int byte_size)
Initialize GetBitContext.
Definition: get_bits.h:539
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
s
#define s(width, name)
Definition: cbs_vp9.c:198
op
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:76
decode.h
get_bits.h
key
const char * key
Definition: hwcontext_opencl.c:189
CODEC_LONG_NAME
#define CODEC_LONG_NAME(str)
Definition: codec_internal.h:331
MidiVidContext::gb
GetByteContext gb
Definition: midivid.c:35
AV_CODEC_ID_MVDV
@ AV_CODEC_ID_MVDV
Definition: codec_id.h:302
MidiVidContext::skip
uint8_t * skip
Definition: midivid.c:39
AV_PICTURE_TYPE_I
@ AV_PICTURE_TYPE_I
Intra.
Definition: avutil.h:278
get_bits1
static unsigned int get_bits1(GetBitContext *s)
Definition: get_bits.h:386
init
int(* init)(AVBSFContext *ctx)
Definition: dts2pts.c:368
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
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:278
codec_internal.h
dst
uint8_t ptrdiff_t const uint8_t ptrdiff_t int intptr_t intptr_t int int16_t * dst
Definition: dsp.h:87
size
int size
Definition: twinvq_data.h:10344
lzss_uncompress
static ptrdiff_t lzss_uncompress(MidiVidContext *s, GetByteContext *gb, uint8_t *dst, unsigned int size)
Definition: midivid.c:151
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
attributes.h
decode_frame
static int decode_frame(AVCodecContext *avctx, AVFrame *rframe, int *got_frame, AVPacket *avpkt)
Definition: midivid.c:187
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:256
internal.h
av_fast_padded_malloc
void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size)
Same behaviour av_fast_malloc but the buffer has additional AV_INPUT_BUFFER_PADDING_SIZE at the end w...
Definition: utils.c:53
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
av_calloc
void * av_calloc(size_t nmemb, size_t size)
Definition: mem.c:264
avcodec.h
ff_reget_buffer
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:1840
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
flag
#define flag(name)
Definition: cbs_av1.c:496
decode_mvdv
static int decode_mvdv(MidiVidContext *s, AVCodecContext *avctx, AVFrame *frame)
Definition: midivid.c:44
AVCodecContext
main external API structure.
Definition: avcodec.h:431
AV_PIX_FMT_YUV444P
@ AV_PIX_FMT_YUV444P
planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
Definition: pixfmt.h:78
AV_PICTURE_TYPE_P
@ AV_PICTURE_TYPE_P
Predicted.
Definition: avutil.h:279
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:200
mem.h
decode_init
static av_cold int decode_init(AVCodecContext *avctx)
Definition: midivid.c:235
FFALIGN
#define FFALIGN(x, a)
Definition: macros.h:78
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:458
AVPacket
This structure stores compressed data.
Definition: packet.h:535
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:35
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:592
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
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
ff_mvdv_decoder
const FFCodec ff_mvdv_decoder
Definition: midivid.c:279
av_image_check_size
int av_image_check_size(unsigned int w, unsigned int h, int log_offset, void *log_ctx)
Check if the given dimension of an image is valid, meaning that all bytes of the image can be address...
Definition: imgutils.c:318
MidiVidContext::uncompressed_size
unsigned int uncompressed_size
Definition: midivid.c:38
skip
static void BS_FUNC() skip(BSCTX *bc, unsigned int n)
Skip n bits in the buffer.
Definition: bitstream_template.h:383