FFmpeg
mvha.c
Go to the documentation of this file.
1 /*
2  * MidiVid Archive codec
3  *
4  * Copyright (c) 2019 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 #define CACHED_BITSTREAM_READER !ARCH_X86_32
28 #include "libavutil/intreadwrite.h"
29 
30 #include "avcodec.h"
31 #include "bytestream.h"
32 #include "get_bits.h"
33 #include "internal.h"
34 #include "lossless_videodsp.h"
35 
36 #include <zlib.h>
37 
38 typedef struct MVHAContext {
41 
42  uint8_t symb[256];
43  uint32_t prob[256];
45 
46  z_stream zstream;
48 } MVHAContext;
49 
50 typedef struct Node {
51  int16_t sym;
52  int16_t n0;
53  int16_t l, r;
54  uint32_t count;
55 } Node;
56 
57 static void get_tree_codes(uint32_t *bits, int16_t *lens, uint8_t *xlat,
58  Node *nodes, int node,
59  uint32_t pfx, int pl, int *pos)
60 {
61  int s;
62 
63  s = nodes[node].sym;
64  if (s != -1) {
65  bits[*pos] = (~pfx) & ((1ULL << FFMAX(pl, 1)) - 1);
66  lens[*pos] = FFMAX(pl, 1);
67  xlat[*pos] = s + (pl == 0);
68  (*pos)++;
69  } else {
70  pfx <<= 1;
71  pl++;
72  get_tree_codes(bits, lens, xlat, nodes, nodes[node].l, pfx, pl,
73  pos);
74  pfx |= 1;
75  get_tree_codes(bits, lens, xlat, nodes, nodes[node].r, pfx, pl,
76  pos);
77  }
78 }
79 
80 static int build_vlc(AVCodecContext *avctx, VLC *vlc)
81 {
82  MVHAContext *s = avctx->priv_data;
83  Node nodes[512];
84  uint32_t bits[256];
85  int16_t lens[256];
86  uint8_t xlat[256];
87  int cur_node, i, j, pos = 0;
88 
89  ff_free_vlc(vlc);
90 
91  for (i = 0; i < s->nb_symbols; i++) {
92  nodes[i].count = s->prob[i];
93  nodes[i].sym = s->symb[i];
94  nodes[i].n0 = -2;
95  nodes[i].l = i;
96  nodes[i].r = i;
97  }
98 
99  cur_node = s->nb_symbols;
100  j = 0;
101  do {
102  for (i = 0; ; i++) {
103  int new_node = j;
104  int first_node = cur_node;
105  int second_node = cur_node;
106  unsigned nd, st;
107 
108  nodes[cur_node].count = -1;
109 
110  do {
111  int val = nodes[new_node].count;
112  if (val && (val < nodes[first_node].count)) {
113  if (val >= nodes[second_node].count) {
114  first_node = new_node;
115  } else {
116  first_node = second_node;
117  second_node = new_node;
118  }
119  }
120  new_node += 1;
121  } while (new_node != cur_node);
122 
123  if (first_node == cur_node)
124  break;
125 
126  nd = nodes[second_node].count;
127  st = nodes[first_node].count;
128  nodes[second_node].count = 0;
129  nodes[first_node].count = 0;
130  if (nd >= UINT32_MAX - st) {
131  av_log(avctx, AV_LOG_ERROR, "count overflow\n");
132  return AVERROR_INVALIDDATA;
133  }
134  nodes[cur_node].count = nd + st;
135  nodes[cur_node].sym = -1;
136  nodes[cur_node].n0 = cur_node;
137  nodes[cur_node].l = first_node;
138  nodes[cur_node].r = second_node;
139  cur_node++;
140  }
141  j++;
142  } while (cur_node - s->nb_symbols == j);
143 
144  get_tree_codes(bits, lens, xlat, nodes, cur_node - 1, 0, 0, &pos);
145 
146  return ff_init_vlc_sparse(vlc, 12, pos, lens, 2, 2, bits, 4, 4, xlat, 1, 1, 0);
147 }
148 
149 static int decode_frame(AVCodecContext *avctx,
150  void *data, int *got_frame,
151  AVPacket *avpkt)
152 {
153  MVHAContext *s = avctx->priv_data;
154  AVFrame *frame = data;
155  uint32_t type, size;
156  int ret;
157 
158  if (avpkt->size <= 8)
159  return AVERROR_INVALIDDATA;
160 
161  type = AV_RB32(avpkt->data);
162  size = AV_RL32(avpkt->data + 4);
163 
164  if (size < 1 || size >= avpkt->size)
165  return AVERROR_INVALIDDATA;
166 
167  if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
168  return ret;
169 
170  if (type == MKTAG('L','Z','Y','V')) {
171  ret = inflateReset(&s->zstream);
172  if (ret != Z_OK) {
173  av_log(avctx, AV_LOG_ERROR, "Inflate reset error: %d\n", ret);
174  return AVERROR_EXTERNAL;
175  }
176 
177  s->zstream.next_in = avpkt->data + 8;
178  s->zstream.avail_in = avpkt->size - 8;
179 
180  for (int p = 0; p < 3; p++) {
181  for (int y = 0; y < avctx->height; y++) {
182  s->zstream.next_out = frame->data[p] + (avctx->height - y - 1) * frame->linesize[p];
183  s->zstream.avail_out = avctx->width >> (p > 0);
184 
185  ret = inflate(&s->zstream, Z_SYNC_FLUSH);
186  if (ret != Z_OK && ret != Z_STREAM_END) {
187  av_log(avctx, AV_LOG_ERROR, "Inflate error: %d\n", ret);
188  return AVERROR_EXTERNAL;
189  }
190  }
191  }
192  } else if (type == MKTAG('H','U','F','Y')) {
193  GetBitContext *gb = &s->gb;
194  int first_symbol, symbol;
195 
196  ret = init_get_bits8(gb, avpkt->data + 8, avpkt->size - 8);
197  if (ret < 0)
198  return ret;
199 
200  skip_bits(gb, 24);
201 
202  first_symbol = get_bits(gb, 8);
203  s->nb_symbols = get_bits(gb, 8) + 1;
204 
205  symbol = first_symbol;
206  for (int i = 0; i < s->nb_symbols; symbol++) {
207  int prob;
208 
209  if (get_bits_left(gb) < 4)
210  return AVERROR_INVALIDDATA;
211 
212  if (get_bits1(gb)) {
213  prob = get_bits(gb, 12);
214  } else {
215  prob = get_bits(gb, 3);
216  }
217 
218  if (prob) {
219  s->symb[i] = symbol;
220  s->prob[i] = prob;
221  i++;
222  }
223  }
224 
225  ret = build_vlc(avctx, &s->vlc);
226  if (ret < 0)
227  return ret;
228 
229  for (int p = 0; p < 3; p++) {
230  int width = avctx->width >> (p > 0);
231  ptrdiff_t stride = frame->linesize[p];
232  uint8_t *dst;
233 
234  dst = frame->data[p] + (avctx->height - 1) * frame->linesize[p];
235  for (int y = 0; y < avctx->height; y++) {
236  if (get_bits_left(gb) < width)
237  return AVERROR_INVALIDDATA;
238  for (int x = 0; x < width; x++) {
239  int v = get_vlc2(gb, s->vlc.table, s->vlc.bits, 3);
240 
241  if (v < 0)
242  return AVERROR_INVALIDDATA;
243 
244  dst[x] = v;
245  }
246  dst -= stride;
247  }
248  }
249  } else {
250  return AVERROR_INVALIDDATA;
251  }
252 
253  for (int p = 0; p < 3; p++) {
254  int left, lefttop;
255  int width = avctx->width >> (p > 0);
256  ptrdiff_t stride = frame->linesize[p];
257  uint8_t *dst;
258 
259  dst = frame->data[p] + (avctx->height - 1) * frame->linesize[p];
260  s->llviddsp.add_left_pred(dst, dst, width, 0);
261  if (avctx->height > 1) {
262  dst -= stride;
263  lefttop = left = dst[0];
264  for (int y = 1; y < avctx->height; y++) {
265  s->llviddsp.add_median_pred(dst, dst + stride, dst, width, &left, &lefttop);
266  lefttop = left = dst[0];
267  dst -= stride;
268  }
269  }
270  }
271 
272  frame->pict_type = AV_PICTURE_TYPE_I;
273  frame->key_frame = 1;
274  *got_frame = 1;
275 
276  return avpkt->size;
277 }
278 
280 {
281  MVHAContext *s = avctx->priv_data;
282  int zret;
283 
284  avctx->pix_fmt = AV_PIX_FMT_YUV422P;
285 
286  s->zstream.zalloc = Z_NULL;
287  s->zstream.zfree = Z_NULL;
288  s->zstream.opaque = Z_NULL;
289  zret = inflateInit(&s->zstream);
290  if (zret != Z_OK) {
291  av_log(avctx, AV_LOG_ERROR, "Inflate init error: %d\n", zret);
292  return AVERROR_EXTERNAL;
293  }
294 
296 
297  return 0;
298 }
299 
301 {
302  MVHAContext *s = avctx->priv_data;
303 
304  inflateEnd(&s->zstream);
305  ff_free_vlc(&s->vlc);
306 
307  return 0;
308 }
309 
311  .name = "mvha",
312  .long_name = NULL_IF_CONFIG_SMALL("MidiVid Archive Codec"),
313  .type = AVMEDIA_TYPE_VIDEO,
314  .id = AV_CODEC_ID_MVHA,
315  .priv_data_size = sizeof(MVHAContext),
316  .init = decode_init,
317  .close = decode_close,
318  .decode = decode_frame,
319  .capabilities = AV_CODEC_CAP_DR1,
320  .caps_internal = FF_CODEC_CAP_INIT_THREADSAFE |
322 };
#define FF_CODEC_CAP_INIT_CLEANUP
The codec allows calling the close function for deallocation even if the init function returned a fai...
Definition: internal.h:48
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
int(* add_left_pred)(uint8_t *dst, const uint8_t *src, ptrdiff_t w, int left)
VLC vlc
Definition: mvha.c:44
This structure describes decoded (raw) audio or video data.
Definition: frame.h:308
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:100
static unsigned int get_bits(GetBitContext *s, int n)
Read 1-25 bits.
Definition: get_bits.h:379
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
int ff_init_vlc_sparse(VLC *vlc_arg, int nb_bits, int nb_codes, const void *bits, int bits_wrap, int bits_size, const void *codes, int codes_wrap, int codes_size, const void *symbols, int symbols_wrap, int symbols_size, int flags)
Definition: bitstream.c:273
int size
Definition: packet.h:364
z_stream zstream
Definition: mvha.c:46
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:736
GLint GLenum type
Definition: opengl_enc.c:104
uint8_t symb[256]
Definition: mvha.c:42
AVCodec.
Definition: codec.h:190
static void decode(AVCodecContext *dec_ctx, AVPacket *pkt, AVFrame *frame, FILE *outfile)
Definition: decode_audio.c:71
Definition: agm.c:913
#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:40
uint8_t
#define av_cold
Definition: attributes.h:88
LLVidDSPContext llviddsp
Definition: mvha.c:47
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_WL32 unsigned int_TMPL AV_WL24 unsigned int_TMPL AV_WL16 uint64_t_TMPL AV_WB64 unsigned int_TMPL AV_RB32
Definition: bytestream.h:87
uint8_t * data
Definition: packet.h:363
void(* add_median_pred)(uint8_t *dst, const uint8_t *top, const uint8_t *diff, ptrdiff_t w, int *left, int *left_top)
bitstream reader API header.
ptrdiff_t size
Definition: opengl_enc.c:100
static av_cold int decode_close(AVCodecContext *avctx)
Definition: mvha.c:300
#define av_log(a,...)
static int get_bits_left(GetBitContext *gb)
Definition: get_bits.h:849
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:194
GetBitContext gb
Definition: mvha.c:39
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:153
const char * r
Definition: vf_curves.c:114
unsigned int pos
Definition: spdifenc.c:410
const char * name
Name of the codec implementation.
Definition: codec.h:197
uint8_t bits
Definition: vp3data.h:202
GLsizei count
Definition: opengl_enc.c:108
#define FFMAX(a, b)
Definition: common.h:94
AVCodec ff_mvha_decoder
Definition: mvha.c:310
Definition: vlc.h:26
planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
Definition: pixfmt.h:70
int16_t r
Definition: mvha.c:53
static void get_tree_codes(uint32_t *bits, int16_t *lens, uint8_t *xlat, Node *nodes, int node, uint32_t pfx, int pl, int *pos)
Definition: mvha.c:57
enum AVPictureType pict_type
Picture type of the frame.
Definition: frame.h:391
int nb_symbols
Definition: mvha.c:40
int16_t l
Definition: mvha.c:53
#define width
int width
picture width / height.
Definition: avcodec.h:699
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
#define s(width, name)
Definition: cbs_vp9.c:257
static av_always_inline int get_vlc2(GetBitContext *s, VLC_TYPE(*table)[2], int bits, int max_depth)
Parse a vlc code.
Definition: get_bits.h:797
int bits
Definition: vlc.h:27
Libavcodec external API header.
static int decode_frame(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
Definition: mvha.c:149
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:339
static int init_get_bits8(GetBitContext *s, const uint8_t *buffer, int byte_size)
Initialize GetBitContext.
Definition: get_bits.h:677
main external API structure.
Definition: avcodec.h:526
static int build_vlc(AVCodecContext *avctx, VLC *vlc)
Definition: mvha.c:80
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: decode.c:1854
Tag MUST be and< 10hcoeff half pel interpolation filter coefficients, hcoeff[0] are the 2 middle coefficients[1] are the next outer ones and so on, resulting in a filter like:...eff[2], hcoeff[1], hcoeff[0], hcoeff[0], hcoeff[1], hcoeff[2]...the sign of the coefficients is not explicitly stored but alternates after each coeff and coeff[0] is positive, so...,+,-,+,-,+,+,-,+,-,+,...hcoeff[0] is not explicitly stored but found by subtracting the sum of all stored coefficients with signs from 32 hcoeff[0]=32-hcoeff[1]-hcoeff[2]-...a good choice for hcoeff and htaps is htaps=6 hcoeff={40,-10, 2}an alternative which requires more computations at both encoder and decoder side and may or may not be better is htaps=8 hcoeff={42,-14, 6,-2}ref_frames minimum of the number of available reference frames and max_ref_frames for example the first frame after a key frame always has ref_frames=1spatial_decomposition_type wavelet type 0 is a 9/7 symmetric compact integer wavelet 1 is a 5/3 symmetric compact integer wavelet others are reserved stored as delta from last, last is reset to 0 if always_reset||keyframeqlog quality(logarithmic quantizer scale) stored as delta from last, last is reset to 0 if always_reset||keyframemv_scale stored as delta from last, last is reset to 0 if always_reset||keyframe FIXME check that everything works fine if this changes between framesqbias dequantization bias stored as delta from last, last is reset to 0 if always_reset||keyframeblock_max_depth maximum depth of the block tree stored as delta from last, last is reset to 0 if always_reset||keyframequant_table quantization tableHighlevel bitstream structure:==============================--------------------------------------------|Header|--------------------------------------------|------------------------------------|||Block0||||split?||||yes no||||.........intra?||||:Block01:yes no||||:Block02:.................||||:Block03::y DC::ref index:||||:Block04::cb DC::motion x:||||.........:cr DC::motion y:||||.................|||------------------------------------||------------------------------------|||Block1|||...|--------------------------------------------|------------------------------------|||Y subbands||Cb subbands||Cr subbands||||------||------||------|||||LL0||HL0||||LL0||HL0||||LL0||HL0|||||------||------||------||||------||------||------|||||LH0||HH0||||LH0||HH0||||LH0||HH0|||||------||------||------||||------||------||------|||||HL1||LH1||||HL1||LH1||||HL1||LH1|||||------||------||------||||------||------||------|||||HH1||HL2||||HH1||HL2||||HH1||HL2|||||...||...||...|||------------------------------------|--------------------------------------------Decoding process:=================------------|||Subbands|------------||||------------|Intra DC||||LL0 subband prediction------------|\Dequantization-------------------\||Reference frames|\IDWT|--------------|Motion\|||Frame 0||Frame 1||Compensation.OBMC v-------|--------------|--------------.\------> Frame n output Frame Frame<----------------------------------/|...|-------------------Range Coder:============Binary Range Coder:-------------------The implemented range coder is an adapted version based upon"Range encoding: an algorithm for removing redundancy from a digitised message."by G.N.N.Martin.The symbols encoded by the Snow range coder are bits(0|1).The associated probabilities are not fix but change depending on the symbol mix seen so far.bit seen|new state---------+-----------------------------------------------0|256-state_transition_table[256-old_state];1|state_transition_table[old_state];state_transition_table={0, 0, 0, 0, 0, 0, 0, 0, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 190, 191, 192, 194, 194, 195, 196, 197, 198, 199, 200, 201, 202, 202, 204, 205, 206, 207, 208, 209, 209, 210, 211, 212, 213, 215, 215, 216, 217, 218, 219, 220, 220, 222, 223, 224, 225, 226, 227, 227, 229, 229, 230, 231, 232, 234, 234, 235, 236, 237, 238, 239, 240, 241, 242, 243, 244, 245, 246, 247, 248, 248, 0, 0, 0, 0, 0, 0, 0};FIXME Range Coding of integers:-------------------------FIXME Neighboring Blocks:===================left and top are set to the respective blocks unless they are outside of the image in which case they are set to the Null block top-left is set to the top left block unless it is outside of the image in which case it is set to the left block if this block has no larger parent block or it is at the left side of its parent block and the top right block is not outside of the image then the top right block is used for top-right else the top-left block is used Null block y, cb, cr are 128 level, ref, mx and my are 0 Motion Vector Prediction:=========================1.the motion vectors of all the neighboring blocks are scaled to compensate for the difference of reference frames scaled_mv=(mv *(256 *(current_reference+1)/(mv.reference+1))+128)> the median of the scaled left
Definition: snow.txt:206
void ff_llviddsp_init(LLVidDSPContext *c)
static unsigned int get_bits1(GetBitContext *s)
Definition: get_bits.h:498
static void skip_bits(GetBitContext *s, int n)
Definition: get_bits.h:467
int16_t n0
Definition: huffman.h:34
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:198
int16_t sym
Definition: huffman.h:33
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:322
GLint GLenum GLboolean GLsizei stride
Definition: opengl_enc.c:104
common internal api header.
void * priv_data
Definition: avcodec.h:553
VLC_TYPE(* table)[2]
code, bits
Definition: vlc.h:28
int key_frame
1 -> keyframe, 0-> not
Definition: frame.h:386
uint32_t count
Definition: huffman.h:35
#define stride
#define MKTAG(a, b, c, d)
Definition: common.h:406
#define AVERROR_EXTERNAL
Generic error in an external library.
Definition: error.h:57
uint64_t_TMPL AV_WL64 unsigned int_TMPL AV_RL32
Definition: bytestream.h:87
static double val(void *priv, double ch)
Definition: aeval.c:76
This structure stores compressed data.
Definition: packet.h:340
uint32_t prob[256]
Definition: mvha.c:43
void ff_free_vlc(VLC *vlc)
Definition: bitstream.c:361
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() for allocating buffers and supports custom allocators.
Definition: codec.h:50
for(j=16;j >0;--j)
int i
Definition: input.c:407
static av_cold int decode_init(AVCodecContext *avctx)
Definition: mvha.c:279