RepoMirrors
/
ffmpeg
mirror of https://git.ffmpeg.org/ffmpeg.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

avcodec/bitstream_template: Basic documentation for read_vlc_multi() 

Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
This commit is contained in:
Michael Niedermayer 2023-10-22 16:58:53 +02:00
parent 52a9764260
commit ffac64a270
No known key found for this signature in database
GPG Key ID: B18E8928B3948D64
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
libavcodec/bitstream_template.h
View File

@ -520,7 +520,20 @@ static inline int BS_FUNC(read_vlc)(BSCTX *bc, const VLCElem *table,
return code;
}
static inline int BS_FUNC(read_vlc_multi)(BSCTX *bc, uint8_t *dst,
/**
* Parse a vlc / vlc_multi code.
* @param bits is the number of bits which will be read at once, must be
* identical to nb_bits in vlc_init()
* @param max_depth is the number of times bits bits must be read to completely
* read the longest vlc code
* = (max_vlc_length + bits - 1) / bits
* @param dst the parsed symbol(s) will be stored here. Up to 8 bytes are written
* @returns number of symbols parsed
* If the vlc code is invalid and max_depth=1, then no bits will be removed.
* If the vlc code is invalid and max_depth>1, then the number of bits removed
* is undefined.
*/
static inline int BS_FUNC(read_vlc_multi)(BSCTX *bc, uint8_t dst[8],
const VLC_MULTI_ELEM *const Jtable,
const VLCElem *const table,
const int bits, const int max_depth)