FFmpeg
wcmv.c
Go to the documentation of this file.
1 /*
2  * WinCAM Motion Video decoder
3  *
4  * Copyright (c) 2018 Paul B Mahol
5  *
6  * This file is part of FFmpeg.
7  *
8  * FFmpeg is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * FFmpeg is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with FFmpeg; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22 
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 
27 #include "libavutil/imgutils.h"
28 
29 #include "avcodec.h"
30 #include "bytestream.h"
31 #include "codec_internal.h"
32 #include "internal.h"
33 #include "zlib_wrapper.h"
34 
35 #include <zlib.h>
36 
37 typedef struct WCMVContext {
38  int bpp;
41  uint8_t block_data[65536*8];
42 } WCMVContext;
43 
45  int *got_frame, AVPacket *avpkt)
46 {
47  WCMVContext *s = avctx->priv_data;
48  z_stream *const zstream = &s->zstream.zstream;
49  int skip, blocks, zret, ret, intra = 0, flags = 0, bpp = s->bpp;
50  GetByteContext gb;
51  uint8_t *dst;
52 
53  ret = inflateReset(zstream);
54  if (ret != Z_OK) {
55  av_log(avctx, AV_LOG_ERROR, "Inflate reset error: %d\n", ret);
56  return AVERROR_EXTERNAL;
57  }
58 
59  bytestream2_init(&gb, avpkt->data, avpkt->size);
60  blocks = bytestream2_get_le16(&gb);
61  if (!blocks)
63 
64  if ((ret = ff_reget_buffer(avctx, s->prev_frame, flags)) < 0)
65  return ret;
66 
67  if (blocks > 5) {
68  GetByteContext bgb;
69  int x = 0, size;
70 
71  if (blocks * 8 >= 0xFFFF)
72  size = bytestream2_get_le24(&gb);
73  else if (blocks * 8 >= 0xFF)
74  size = bytestream2_get_le16(&gb);
75  else
76  size = bytestream2_get_byte(&gb);
77 
78  skip = bytestream2_tell(&gb);
79  if (size > avpkt->size - skip)
80  return AVERROR_INVALIDDATA;
81 
82  zstream->next_in = avpkt->data + skip;
83  zstream->avail_in = size;
84  zstream->next_out = s->block_data;
85  zstream->avail_out = sizeof(s->block_data);
86 
87  zret = inflate(zstream, Z_FINISH);
88  if (zret != Z_STREAM_END) {
89  av_log(avctx, AV_LOG_ERROR,
90  "Inflate failed with return code: %d.\n", zret);
91  return AVERROR_INVALIDDATA;
92  }
93 
94  ret = inflateReset(zstream);
95  if (ret != Z_OK) {
96  av_log(avctx, AV_LOG_ERROR, "Inflate reset error: %d\n", ret);
97  return AVERROR_EXTERNAL;
98  }
99 
100  bytestream2_skip(&gb, size);
101  bytestream2_init(&bgb, s->block_data, blocks * 8);
102 
103  for (int i = 0; i < blocks; i++) {
104  int w, h;
105 
106  bytestream2_skip(&bgb, 4);
107  w = bytestream2_get_le16(&bgb);
108  h = bytestream2_get_le16(&bgb);
109  if (x + bpp * (int64_t)w * h > INT_MAX)
110  return AVERROR_INVALIDDATA;
111  x += bpp * w * h;
112  }
113 
114  if (x >= 0xFFFF)
115  bytestream2_skip(&gb, 3);
116  else if (x >= 0xFF)
117  bytestream2_skip(&gb, 2);
118  else
119  bytestream2_skip(&gb, 1);
120 
121  skip = bytestream2_tell(&gb);
122 
123  zstream->next_in = avpkt->data + skip;
124  zstream->avail_in = avpkt->size - skip;
125 
126  bytestream2_init(&gb, s->block_data, blocks * 8);
127  } else if (blocks) {
128  int x = 0;
129 
130  bytestream2_seek(&gb, 2, SEEK_SET);
131 
132  for (int i = 0; i < blocks; i++) {
133  int w, h;
134 
135  bytestream2_skip(&gb, 4);
136  w = bytestream2_get_le16(&gb);
137  h = bytestream2_get_le16(&gb);
138  if (x + bpp * (int64_t)w * h > INT_MAX)
139  return AVERROR_INVALIDDATA;
140  x += bpp * w * h;
141  }
142 
143  if (x >= 0xFFFF)
144  bytestream2_skip(&gb, 3);
145  else if (x >= 0xFF)
146  bytestream2_skip(&gb, 2);
147  else
148  bytestream2_skip(&gb, 1);
149 
150  skip = bytestream2_tell(&gb);
151 
152  zstream->next_in = avpkt->data + skip;
153  zstream->avail_in = avpkt->size - skip;
154 
155  bytestream2_seek(&gb, 2, SEEK_SET);
156  }
157 
158  if (bytestream2_get_bytes_left(&gb) < 8LL * blocks)
159  return AVERROR_INVALIDDATA;
160 
161  if (!avctx->frame_number) {
162  ptrdiff_t linesize[4] = { s->prev_frame->linesize[0], 0, 0, 0 };
163  av_image_fill_black(s->prev_frame->data, linesize, avctx->pix_fmt, 0,
164  avctx->width, avctx->height);
165  }
166 
167  for (int block = 0; block < blocks; block++) {
168  int x, y, w, h;
169 
170  x = bytestream2_get_le16(&gb);
171  y = bytestream2_get_le16(&gb);
172  w = bytestream2_get_le16(&gb);
173  h = bytestream2_get_le16(&gb);
174 
175  if (blocks == 1 && x == 0 && y == 0 && w == avctx->width && h == avctx->height)
176  intra = 1;
177 
178  if (x + w > avctx->width || y + h > avctx->height)
179  return AVERROR_INVALIDDATA;
180 
181  if (w > avctx->width || h > avctx->height)
182  return AVERROR_INVALIDDATA;
183 
184  dst = s->prev_frame->data[0] + (avctx->height - y - 1) * s->prev_frame->linesize[0] + x * bpp;
185  for (int i = 0; i < h; i++) {
186  zstream->next_out = dst;
187  zstream->avail_out = w * bpp;
188 
189  zret = inflate(zstream, Z_SYNC_FLUSH);
190  if (zret != Z_OK && zret != Z_STREAM_END) {
191  av_log(avctx, AV_LOG_ERROR,
192  "Inflate failed with return code: %d.\n", zret);
193  return AVERROR_INVALIDDATA;
194  }
195 
196  dst -= s->prev_frame->linesize[0];
197  }
198  }
199 
200  s->prev_frame->key_frame = intra;
201  s->prev_frame->pict_type = intra ? AV_PICTURE_TYPE_I : AV_PICTURE_TYPE_P;
202 
203  if ((ret = av_frame_ref(frame, s->prev_frame)) < 0)
204  return ret;
205 
206  *got_frame = 1;
207 
208  return avpkt->size;
209 }
210 
212 {
213  WCMVContext *s = avctx->priv_data;
214 
215  switch (avctx->bits_per_coded_sample) {
216  case 16: avctx->pix_fmt = AV_PIX_FMT_RGB565LE; break;
217  case 24: avctx->pix_fmt = AV_PIX_FMT_BGR24; break;
218  case 32: avctx->pix_fmt = AV_PIX_FMT_BGRA; break;
219  default: av_log(avctx, AV_LOG_ERROR, "Unsupported bits_per_coded_sample: %d\n",
220  avctx->bits_per_coded_sample);
221  return AVERROR_PATCHWELCOME;
222  }
223 
224  s->bpp = avctx->bits_per_coded_sample >> 3;
225 
226  s->prev_frame = av_frame_alloc();
227  if (!s->prev_frame)
228  return AVERROR(ENOMEM);
229 
230  return ff_inflate_init(&s->zstream, avctx);
231 }
232 
234 {
235  WCMVContext *s = avctx->priv_data;
236 
237  av_frame_free(&s->prev_frame);
238  ff_inflate_end(&s->zstream);
239 
240  return 0;
241 }
242 
244  .p.name = "wcmv",
245  .p.long_name = NULL_IF_CONFIG_SMALL("WinCAM Motion Video"),
246  .p.type = AVMEDIA_TYPE_VIDEO,
247  .p.id = AV_CODEC_ID_WCMV,
248  .priv_data_size = sizeof(WCMVContext),
249  .init = decode_init,
250  .close = decode_close,
252  .p.capabilities = AV_CODEC_CAP_DR1,
253  .caps_internal = FF_CODEC_CAP_INIT_CLEANUP,
254 };
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:41
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
Definition: bytestream.h:33
WCMVContext
Definition: wcmv.c:37
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:116
bytestream2_seek
static av_always_inline int bytestream2_seek(GetByteContext *g, int offset, int whence)
Definition: bytestream.h:212
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:325
w
uint8_t w
Definition: llviddspenc.c:38
internal.h
AVPacket::data
uint8_t * data
Definition: packet.h:374
FFCodec
Definition: codec_internal.h:118
WCMVContext::prev_frame
AVFrame * prev_frame
Definition: wcmv.c:40
AV_PIX_FMT_BGR24
@ AV_PIX_FMT_BGR24
packed RGB 8:8:8, 24bpp, BGRBGR...
Definition: pixfmt.h:69
AV_PIX_FMT_BGRA
@ AV_PIX_FMT_BGRA
packed BGRA 8:8:8:8, 32bpp, BGRABGRA...
Definition: pixfmt.h:95
init
static int init
Definition: av_tx.c:47
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:122
inflate
static void inflate(uint8_t *dst, const uint8_t *p1, int width, int threshold, const uint8_t *coordinates[], int coord, int maxc)
Definition: vf_neighbor.c:195
av_frame_alloc
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:104
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
zlib_wrapper.h
av_cold
#define av_cold
Definition: attributes.h:90
FF_CODEC_DECODE_CB
#define FF_CODEC_DECODE_CB(func)
Definition: codec_internal.h:260
s
#define s(width, name)
Definition: cbs_vp9.c:256
WCMVContext::block_data
uint8_t block_data[65536 *8]
Definition: wcmv.c:41
decode_frame
static int decode_frame(AVCodecContext *avctx, AVFrame *frame, int *got_frame, AVPacket *avpkt)
Definition: wcmv.c:44
AV_PIX_FMT_RGB565LE
@ AV_PIX_FMT_RGB565LE
packed RGB 5:6:5, 16bpp, (msb) 5R 6G 5B(lsb), little-endian
Definition: pixfmt.h:106
AVERROR_PATCHWELCOME
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:64
ff_wcmv_decoder
const FFCodec ff_wcmv_decoder
Definition: wcmv.c:243
AV_PICTURE_TYPE_I
@ AV_PICTURE_TYPE_I
Intra.
Definition: avutil.h:274
av_image_fill_black
int av_image_fill_black(uint8_t *dst_data[4], const ptrdiff_t dst_linesize[4], enum AVPixelFormat pix_fmt, enum AVColorRange range, int width, int height)
Overwrite the image data with black.
Definition: imgutils.c:582
bytestream2_get_bytes_left
static av_always_inline int bytestream2_get_bytes_left(GetByteContext *g)
Definition: bytestream.h:158
bytestream2_tell
static av_always_inline int bytestream2_tell(GetByteContext *g)
Definition: bytestream.h:192
AV_CODEC_ID_WCMV
@ AV_CODEC_ID_WCMV
Definition: codec_id.h:289
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:375
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
WCMVContext::zstream
FFZStream zstream
Definition: wcmv.c:39
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:353
codec_internal.h
for
for(k=2;k<=8;++k)
Definition: h264pred_template.c:425
size
int size
Definition: twinvq_data.h:10344
AVERROR_EXTERNAL
#define AVERROR_EXTERNAL
Generic error in an external library.
Definition: error.h:59
AVCodecContext::bits_per_coded_sample
int bits_per_coded_sample
bits per sample/pixel from the demuxer (needed for huffyuv).
Definition: avcodec.h:1450
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:269
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:211
ff_inflate_end
void ff_inflate_end(FFZStream *zstream)
Wrapper around inflateEnd().
AVCodecContext::height
int height
Definition: avcodec.h:571
AVCodecContext::pix_fmt
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:608
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:1580
ret
ret
Definition: filter_design.txt:187
WCMVContext::bpp
int bpp
Definition: wcmv.c:38
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
FF_REGET_BUFFER_FLAG_READONLY
#define FF_REGET_BUFFER_FLAG_READONLY
the returned buffer does not need to be writable
Definition: internal.h:222
AVCodecContext
main external API structure.
Definition: avcodec.h:398
AV_PICTURE_TYPE_P
@ AV_PICTURE_TYPE_P
Predicted.
Definition: avutil.h:275
AVMEDIA_TYPE_VIDEO
@ AVMEDIA_TYPE_VIDEO
Definition: avutil.h:201
FFZStream
Definition: zlib_wrapper.h:27
AVCodecContext::frame_number
int frame_number
Frame counter, set by libavcodec.
Definition: avcodec.h:1046
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:425
AVPacket
This structure stores compressed data.
Definition: packet.h:351
ff_inflate_init
int ff_inflate_init(FFZStream *zstream, void *logctx)
Wrapper around inflateInit().
AVCodecContext::width
int width
picture width / height.
Definition: avcodec.h:571
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
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
block
The exact code depends on how similar the blocks are and how related they are to the block
Definition: filter_design.txt:207
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
decode_close
static av_cold int decode_close(AVCodecContext *avctx)
Definition: wcmv.c:233
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:61
h
h
Definition: vp9dsp_template.c:2038
decode_init
static av_cold int decode_init(AVCodecContext *avctx)
Definition: wcmv.c:211