vlc.h File Reference

#include <stdint.h>

Go to the source code of this file.

Data Structures
struct	VLC
struct	RL_VLC_ELEM

Macros
#define	VLC_TYPE   int16_t
#define	init_vlc(vlc, nb_bits, nb_codes, bits, bits_wrap, bits_size, codes, codes_wrap, codes_size, flags)
#define	INIT_VLC_INPUT_LE   2
#define	INIT_VLC_OUTPUT_LE   8
#define	INIT_VLC_LE   (INIT_VLC_INPUT_LE | INIT_VLC_OUTPUT_LE)
#define	INIT_VLC_USE_NEW_STATIC   4
#define	INIT_VLC_STATIC_OVERLONG   (1 | INIT_VLC_USE_NEW_STATIC)
#define	INIT_CUSTOM_VLC_SPARSE_STATIC(vlc, bits, a, b, c, d, e, f, g, h, i, j, flags, static_size)
#define	INIT_VLC_SPARSE_STATIC(vlc, bits, a, b, c, d, e, f, g, h, i, j, static_size)
#define	INIT_LE_VLC_SPARSE_STATIC(vlc, bits, a, b, c, d, e, f, g, h, i, j, static_size)
#define	INIT_CUSTOM_VLC_STATIC(vlc, bits, a, b, c, d, e, f, g, flags, static_size)
#define	INIT_VLC_STATIC(vlc, bits, a, b, c, d, e, f, g, static_size)   INIT_VLC_SPARSE_STATIC(vlc, bits, a, b, c, d, e, f, g, NULL, 0, 0, static_size)
#define	INIT_LE_VLC_STATIC(vlc, bits, a, b, c, d, e, f, g, static_size)   INIT_LE_VLC_SPARSE_STATIC(vlc, bits, a, b, c, d, e, f, g, NULL, 0, 0, static_size)
#define	INIT_VLC_STATIC_FROM_LENGTHS(vlc, bits, nb_codes, lens, len_wrap, symbols, symbols_wrap, symbols_size, offset, flags, static_size)

Functions
int	ff_init_vlc_sparse (VLC *vlc, 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)
int	ff_init_vlc_from_lengths (VLC *vlc, int nb_bits, int nb_codes, const int8_t *lens, int lens_wrap, const void *symbols, int symbols_wrap, int symbols_size, int offset, int flags, void *logctx)
	Build VLC decoding tables suitable for use with get_vlc2() More...
void	ff_free_vlc (VLC *vlc)

Macro Definition Documentation

VLC_TYPE

#define VLC_TYPE   int16_t

Definition at line 24 of file vlc.h.

init_vlc

#define init_vlc	(		vlc,
			nb_bits,
			nb_codes,
			bits,
			bits_wrap,
			bits_size,
			codes,
			codes_wrap,
			codes_size,
			flags
	)

Value:

    ff_init_vlc_sparse(vlc, nb_bits, nb_codes,          \
                       bits, bits_wrap, bits_size,      \
                       codes, codes_wrap, codes_size,   \
                       NULL, 0, 0, flags)

Definition at line 38 of file vlc.h.

INIT_VLC_INPUT_LE

#define INIT_VLC_INPUT_LE   2

Definition at line 91 of file vlc.h.

INIT_VLC_OUTPUT_LE

#define INIT_VLC_OUTPUT_LE   8

Definition at line 93 of file vlc.h.

INIT_VLC_LE

#define INIT_VLC_LE   (INIT_VLC_INPUT_LE | INIT_VLC_OUTPUT_LE)

Definition at line 94 of file vlc.h.

INIT_VLC_USE_NEW_STATIC

#define INIT_VLC_USE_NEW_STATIC   4

Definition at line 95 of file vlc.h.

INIT_VLC_STATIC_OVERLONG

#define INIT_VLC_STATIC_OVERLONG   (1 | INIT_VLC_USE_NEW_STATIC)

Definition at line 96 of file vlc.h.

INIT_CUSTOM_VLC_SPARSE_STATIC

#define INIT_CUSTOM_VLC_SPARSE_STATIC	(		vlc,
			bits,
			a,
			b,
			c,
			d,
			e,
			f,
			g,
			h,
			i,
			j,
			flags,
			static_size
	)

Value:

    do {                                                                   \
        static VLC_TYPE table[static_size][2];                             \
        (vlc)->table           = table;                                    \
        (vlc)->table_allocated = static_size;                              \
        ff_init_vlc_sparse(vlc, bits, a, b, c, d, e, f, g, h, i, j,        \
                           flags | INIT_VLC_USE_NEW_STATIC);               \
    } while (0)

Definition at line 98 of file vlc.h.

INIT_VLC_SPARSE_STATIC

#define INIT_VLC_SPARSE_STATIC	(		vlc,
			bits,
			a,
			b,
			c,
			d,
			e,
			f,
			g,
			h,
			i,
			j,
			static_size
	)

Value:

    INIT_CUSTOM_VLC_SPARSE_STATIC(vlc, bits, a, b, c, d, e, f, g,          \
                                  h, i, j, 0, static_size)

Definition at line 108 of file vlc.h.

INIT_LE_VLC_SPARSE_STATIC

#define INIT_LE_VLC_SPARSE_STATIC	(		vlc,
			bits,
			a,
			b,
			c,
			d,
			e,
			f,
			g,
			h,
			i,
			j,
			static_size
	)

Value:

    INIT_CUSTOM_VLC_SPARSE_STATIC(vlc, bits, a, b, c, d, e, f, g,          \
                                  h, i, j, INIT_VLC_LE, static_size)

Definition at line 112 of file vlc.h.

INIT_CUSTOM_VLC_STATIC

#define INIT_CUSTOM_VLC_STATIC	(		vlc,
			bits,
			a,
			b,
			c,
			d,
			e,
			f,
			g,
			flags,
			static_size
	)

Value:

    INIT_CUSTOM_VLC_SPARSE_STATIC(vlc, bits, a, b, c, d, e, f, g,          \
                                  NULL, 0, 0, flags, static_size)

Definition at line 116 of file vlc.h.

INIT_VLC_STATIC

#define INIT_VLC_STATIC	(		vlc,
			bits,
			a,
			b,
			c,
			d,
			e,
			f,
			g,
			static_size
	)		INIT_VLC_SPARSE_STATIC(vlc, bits, a, b, c, d, e, f, g, NULL, 0, 0, static_size)

Definition at line 120 of file vlc.h.

INIT_LE_VLC_STATIC

#define INIT_LE_VLC_STATIC	(		vlc,
			bits,
			a,
			b,
			c,
			d,
			e,
			f,
			g,
			static_size
	)		INIT_LE_VLC_SPARSE_STATIC(vlc, bits, a, b, c, d, e, f, g, NULL, 0, 0, static_size)

Definition at line 123 of file vlc.h.

INIT_VLC_STATIC_FROM_LENGTHS

#define INIT_VLC_STATIC_FROM_LENGTHS	(		vlc,
			bits,
			nb_codes,
			lens,
			len_wrap,
			symbols,
			symbols_wrap,
			symbols_size,
			offset,
			flags,
			static_size
	)

Value:

    do {                                                                   \
        static VLC_TYPE table[static_size][2];                             \
        (vlc)->table           = table;                                    \
        (vlc)->table_allocated = static_size;                              \
        ff_init_vlc_from_lengths(vlc, bits, nb_codes, lens, len_wrap,      \
                                 symbols, symbols_wrap, symbols_size,      \
                                 offset, flags | INIT_VLC_USE_NEW_STATIC,  \
                                 NULL);                                    \
    } while (0)

Definition at line 126 of file vlc.h.

Function Documentation

ff_init_vlc_sparse()

int ff_init_vlc_sparse	(	VLC *	vlc,
		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 at line 323 of file bitstream.c.

Referenced by aac_static_table_init(), build_huff(), build_huff_tree(), build_vlc(), ccitt_unpack_init(), generate_joint_tables(), huf_build_dec_table(), init_ralf_vlc(), read_hufftable(), and rv34_gen_vlc().

ff_init_vlc_from_lengths()

int ff_init_vlc_from_lengths	(	VLC *	vlc,
		int	nb_bits,
		int	nb_codes,
		const int8_t *	lens,
		int	lens_wrap,
		const void *	symbols,
		int	symbols_wrap,
		int	symbols_size,
		int	offset,
		int	flags,
		void *	logctx
	)

Build VLC decoding tables suitable for use with get_vlc2()

This function takes lengths and symbols and calculates the codes from them. For this the input lengths and symbols have to be sorted according to "left nodes in the corresponding tree first".

Parameters

[in,out]	vlc	The VLC to be initialized; table and table_allocated must have been set when initializing a static VLC, otherwise this will be treated as uninitialized.
[in]	nb_bits	The number of bits to use for the VLC table; higher values take up more memory and cache, but allow to read codes with fewer reads.
[in]	nb_codes	The number of provided length and (if supplied) symbol entries.
[in]	lens	The lengths of the codes. Entries > 0 correspond to valid codes; entries == 0 will be skipped and entries with len < 0 indicate that the tree is incomplete and has an open end of length -len at this position.
[in]	lens_wrap	Stride (in bytes) of the lengths.
[in]	symbols	The symbols, i.e. what is returned from get_vlc2() when the corresponding code is encountered. May be NULL, then 0, 1, 2, 3, 4,... will be used.
[in]	symbols_wrap	Stride (in bytes) of the symbols.
[in]	symbols_size	Size of the symbols. 1 and 2 are supported.
[in]	offset	An offset to apply to all the valid symbols.
[in]	flags	A combination of the INIT_VLC_* flags; notice that INIT_VLC_INPUT_LE is pointless and ignored.

Definition at line 381 of file bitstream.c.

Referenced by atrac3_init_static_data(), atrac9_init_vlc(), build_canonical_huff(), build_huff(), build_vlc(), clv_init_static(), ff_mjpeg_build_vlc(), huff_build(), imc_init_static(), mobiclip_init_static(), mp_decode_frame(), mpc7_init_static(), mpeg4_init_static(), mpegaudiodec_common_init_static(), mss4_init_vlc(), on2avc_decode_init(), qdmc_init_static_data(), read_code_table(), rv10_build_vlc(), rv40_init_table(), rv40_init_tables(), smacker_decode_header_tree(), smka_decode_frame(), tm2_build_huff_table(), tscc2_init_vlc(), vp3_decode_init(), wma_decode_init(), and x8_init_vlc().

ff_free_vlc()

void ff_free_vlc

(

VLC *

vlc

)

Definition at line 431 of file bitstream.c.

Referenced by build_huff(), build_vlc(), cfhd_close(), cook_decode_close(), decode_argb_frame(), decode_close(), decode_end(), decode_plane(), decode_plane10(), decode_rgb24_frame(), decode_rle(), decode_yuv_frame(), dnxhd_decode_close(), dnxhd_init_vlc(), ff_ivi_dec_huff_desc(), ff_ivi_decode_close(), ff_mjpeg_decode_dht(), ff_mjpeg_decode_end(), ff_wma_end(), fraps2_decode_plane(), generate_joint_tables(), hq_hqa_decode_close(), hqx_decode_close(), huf_build_dec_table(), huff_build(), image_ctx_free(), init_default_huffman_tables(), ivi_free_buffers(), jpg_free_context(), magy_decode_end(), mp_decode_frame(), on2avc_free_vlcs(), photocd_decode_close(), read_huffman_code_normal(), read_huffman_tables(), read_hufftable(), read_old_huffman_tables(), smacker_decode_header_tree(), smka_decode_frame(), tm2_free_codes(), vorbis_free(), vp3_decode_end(), vp6_build_huff_tree(), and vp6_decode_free_context().