internal.h File Reference

common internal API header More...

#include <limits.h>
#include <stdint.h>
#include <stddef.h>
#include <assert.h>
#include "config.h"
#include "attributes.h"
#include "timer.h"
#include "cpu.h"
#include "dict.h"
#include "version.h"
#include "libm.h"

Go to the source code of this file.

Macros
#define	NDEBUG
#define	av_export
#define	FF_DISABLE_DEPRECATION_WARNINGS
#define	FF_ENABLE_DEPRECATION_WARNINGS
#define	FF_MEMORY_POISON   0x2a
#define	MAKE_ACCESSORS(str, name, type, field)
#define	E1(x)   x
#define	AV_CHECK_OFFSET(s, m, o)
#define	LOCAL_ALIGNED_A(a, t, v, s, o,...)
#define	LOCAL_ALIGNED_D(a, t, v, s, o,...)
#define	LOCAL_ALIGNED(a, t, v,...)   E1(LOCAL_ALIGNED_A(a, t, v, __VA_ARGS__,,))
#define	LOCAL_ALIGNED_8(t, v,...)   LOCAL_ALIGNED(8, t, v, __VA_ARGS__)
#define	LOCAL_ALIGNED_16(t, v,...)   LOCAL_ALIGNED(16, t, v, __VA_ARGS__)
#define	LOCAL_ALIGNED_32(t, v,...)   LOCAL_ALIGNED(32, t, v, __VA_ARGS__)
#define	FF_ALLOC_OR_GOTO(ctx, p, size, label)
#define	FF_ALLOCZ_OR_GOTO(ctx, p, size, label)
#define	FF_ALLOC_ARRAY_OR_GOTO(ctx, p, nelem, elsize, label)
#define	FF_ALLOCZ_ARRAY_OR_GOTO(ctx, p, nelem, elsize, label)
#define	NULL_IF_CONFIG_SMALL(x)   x
	Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.
#define	ONLY_IF_THREADS_ENABLED(x)   NULL
	Define a function with only the non-default version specified.
#define	PTRDIFF_SPECIFIER   "td"
#define	SIZE_SPECIFIER   "zu"

Functions
void	avpriv_report_missing_feature (void *avc, const char *msg,...) av_printf_format(2
	Log a generic warning message about a missing feature.
void void	avpriv_request_sample (void *avc, const char *msg,...) av_printf_format(2
	Log a generic warning message about a missing feature.
int	avpriv_open (const char *filename, int flags,...)
	A wrapper for open() setting O_CLOEXEC.
uint64_t	ff_get_channel_layout (const char *name, int compat)

Detailed Description

common internal API header

Definition in file internal.h.

Macro Definition Documentation

#define NDEBUG

Definition at line 30 of file internal.h.

#define av_export

Definition at line 63 of file internal.h.

#define FF_DISABLE_DEPRECATION_WARNINGS

Definition at line 78 of file internal.h.

Referenced by ac3_decode_init(), asf_parse_packet(), av_dup_packet(), av_free_packet(), av_grow_packet(), av_init_packet(), av_new_packet(), av_packet_from_data(), av_packet_merge_side_data(), avcodec_default_get_buffer2(), avcodec_encode_audio2(), avcodec_encode_video2(), avfilter_graph_alloc_filter(), copy_packet_data(), dca_decode_frame(), dca_decode_init(), ff_aac_ac3_parse(), ff_alloc_packet2(), ff_filter_alloc(), ff_insert_inpad(), ff_insert_outpad(), ff_interleave_add_packet(), ff_MPV_encode_init(), ff_thread_release_buffer(), get_buffer_internal(), init_muxer(), mlp_parse(), mmap_read_frame(), mxg_read_packet(), parse_packet(), read_restart_header(), rm_assemble_video_frame(), str_read_packet(), submit_packet(), thread_get_buffer_internal(), update_context_from_user(), vdpau_h264_end_frame(), and yop_read_packet().

#define FF_ENABLE_DEPRECATION_WARNINGS

Definition at line 79 of file internal.h.

Referenced by ac3_decode_init(), asf_parse_packet(), av_dup_packet(), av_free_packet(), av_grow_packet(), av_init_packet(), av_new_packet(), av_packet_from_data(), av_packet_merge_side_data(), avcodec_default_get_buffer2(), avcodec_encode_audio2(), avcodec_encode_video2(), avfilter_graph_alloc_filter(), copy_packet_data(), dca_decode_frame(), dca_decode_init(), ff_aac_ac3_parse(), ff_alloc_packet2(), ff_filter_alloc(), ff_insert_inpad(), ff_insert_outpad(), ff_interleave_add_packet(), ff_MPV_encode_init(), ff_thread_release_buffer(), get_buffer_internal(), init_muxer(), mlp_parse(), mmap_read_frame(), mxg_read_packet(), parse_packet(), read_restart_header(), rm_assemble_video_frame(), str_read_packet(), submit_packet(), thread_get_buffer_internal(), update_context_from_user(), vdpau_h264_end_frame(), and yop_read_packet().

#define FF_MEMORY_POISON   0x2a

Definition at line 86 of file internal.h.

Referenced by av_dynarray2_add(), av_malloc(), and pool_release_buffer().

#define MAKE_ACCESSORS	(		str,
			name,
			type,
			field
	)

Value:

type av_##name##_get_##field(const str *s) { return s->field; } \
    void av_##name##_set_##field(str *s, type v) { s->field = v; }

Definition at line 88 of file internal.h.

#define E1

(

x

)

x

Definition at line 94 of file internal.h.

#define AV_CHECK_OFFSET	(		s,
			m,
			o
	)

Value:

struct check_##o {    \
        int x_##o[offsetof(s, m) == o? 1: -1];         \
    }

Definition at line 99 of file internal.h.

#define LOCAL_ALIGNED_A	(		a,
			t,
			v,
			s,
			o,
			...
	)

Value:

uint8_t la_##v[sizeof(t s o) + (a)];                \
    t (*v) o = (void *)FFALIGN((uintptr_t)la_##v, a)

Definition at line 103 of file internal.h.

#define LOCAL_ALIGNED_D	(		a,
			t,
			v,
			s,
			o,
			...
	)

Value:

DECLARE_ALIGNED(a, t, la_##v) s o;                  \
    t (*v) o = la_##v

Definition at line 107 of file internal.h.

#define LOCAL_ALIGNED	(		a,
			t,
			v,
			...
	)		E1(LOCAL_ALIGNED_A(a, t, v, __VA_ARGS__,,))

Definition at line 111 of file internal.h.

Referenced by do_hybrid_window(), and ff_lpc_calc_coefs().

#define LOCAL_ALIGNED_8	(		t,
			v,
			...
	)		LOCAL_ALIGNED(8, t, v, __VA_ARGS__)

Definition at line 116 of file internal.h.

Referenced by apply_obmc(), dv_encode_video_segment(), and h264_filter_mb_fast_internal().

#define LOCAL_ALIGNED_16	(		t,
			v,
			...
	)		LOCAL_ALIGNED(16, t, v, __VA_ARGS__)

Definition at line 122 of file internal.h.

Referenced by apply_channel_coupling(), bink_decode_plane(), binkb_decode_plane(), bit8x8_c(), count_mantissa_bits(), dca_subsubframe(), dct_max8x8_c(), dct_quantize_refine(), dct_quantize_TMPL(), dct_sad8x8_c(), decode_slice_alpha(), decode_slice_chroma(), decode_slice_luma(), dnxhd_calc_bits_thread(), dv_decode_video_segment(), dv_init_enc_block(), ff_check_alignment(), h263_skip_b_part(), imc_decode_frame(), mpc7_decode_init(), quant_psnr8x8_c(), rd8x8_c(), rv34_decode_inter_macroblock(), rv34_output_i16x16(), sbr_hf_assemble(), and sbr_hf_inverse_filter().

#define LOCAL_ALIGNED_32	(		t,
			v,
			...
	)		LOCAL_ALIGNED(32, t, v, __VA_ARGS__)

Definition at line 128 of file internal.h.

Referenced by intra_recon().

#define FF_ALLOC_OR_GOTO	(		ctx,
			p,
			size,
			label
	)

Value:

{\
    p = av_malloc(size);\
    if (p == NULL && (size) != 0) {\
        av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
        goto label;\
    }\
}

Definition at line 131 of file internal.h.

Referenced by adpcm_encode_init(), allocate_buffers(), allocate_sample_buffers(), ape_decode_init(), ff_h264_context_init(), ff_iir_filter_init_coeffs(), ff_snow_common_init_after_header(), init_context_frame(), init_mdct_win(), and sws_init_context().

#define FF_ALLOCZ_OR_GOTO	(		ctx,
			p,
			size,
			label
	)

Value:

{\
    p = av_mallocz(size);\
    if (p == NULL && (size) != 0) {\
        av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
        goto label;\
    }\
}

Definition at line 140 of file internal.h.

Referenced by alloc_buffers(), allocate_buffers(), allocate_sample_buffers(), dnxhd_encode_init(), dnxhd_init_qmat(), dnxhd_init_rc(), dnxhd_init_vlc(), ff_h264_alloc_tables(), ff_h264_context_init(), ff_iir_filter_init_coeffs(), ff_MPV_common_init(), ff_MPV_encode_init(), frame_size_alloc(), init_context_frame(), init_duplicate_context(), and sws_init_context().

#define FF_ALLOC_ARRAY_OR_GOTO	(		ctx,
			p,
			nelem,
			elsize,
			label
	)

Value:

{\
    p = av_malloc_array(nelem, elsize);\
    if (p == NULL) {\
        av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
        goto label;\
    }\
}

Definition at line 149 of file internal.h.

Referenced by initFilter(), and mca().

#define FF_ALLOCZ_ARRAY_OR_GOTO	(		ctx,
			p,
			nelem,
			elsize,
			label
	)

Value:

{\
    p = av_mallocz_array(nelem, elsize);\
    if (p == NULL) {\
        av_log(ctx, AV_LOG_ERROR, "Cannot allocate memory.\n");\
        goto label;\
    }\
}

Definition at line 158 of file internal.h.

Referenced by ff_snow_common_init_after_header(), initFilter(), and mca().

#define NULL_IF_CONFIG_SMALL

(

x

)

x

Return NULL if CONFIG_SMALL is true, otherwise the argument without modification.

Used to disable the definition of strings (for example AVCodec long_names).

Definition at line 182 of file internal.h.

Referenced by mpeg12_class().

#define ONLY_IF_THREADS_ENABLED

(

x

)

NULL

Define a function with only the non-default version specified.

On systems with ELF shared libraries, all symbols exported from FFmpeg libraries are tagged with the name and major version of the library to which they belong. If a function is moved from one library to another, a wrapper must be retained in the original location to preserve binary compatibility.

Functions defined with this macro will never be used to resolve symbols by the build-time linker.

Parameters

type	return type of function
name	name of function
args	argument list of function
ver	version tag to assign function Return NULL if a threading library has not been enabled. Used to disable threading functions in AVCodec definitions when not needed.

Definition at line 221 of file internal.h.

#define PTRDIFF_SPECIFIER   "td"

Definition at line 250 of file internal.h.

Referenced by decode_chunks(), decode_slice(), encode_dvd_subtitles(), ff_mjpeg_decode_frame(), ff_mjpeg_find_marker(), ff_vorbis_comment(), flac_parse(), load_input_picture(), parse_packed_headers(), wma_decode_superframe(), zmbv_decode_xor_16(), zmbv_decode_xor_32(), and zmbv_decode_xor_8().

#define SIZE_SPECIFIER   "zu"

Definition at line 251 of file internal.h.

Referenced by ape_read_header(), dump_enc_cfg(), get_http_header_data(), get_tcp_server_response(), jpeg2000_decode_packet(), queue_frames(), read_data_packet(), read_geobtag(), and vpx_init().

Function Documentation

void avpriv_report_missing_feature	(	void *	avc,
		const char *	msg,
			...
	)

Log a generic warning message about a missing feature.

Parameters

[in]	avc	a pointer to an arbitrary struct of which the first field is a pointer to an AVClass struct
[in]	msg	string containing the name of the missing feature

Referenced by aac_adtstoasc_filter(), amr_decode_fix_avctx(), amrnb_decode_frame(), amrnb_decode_init(), amrwb_decode_init(), atrac3p_decode_frame(), cpia_decode_frame(), decode_audio_specific_config(), decode_eld_specific_config(), decode_frame(), decode_ga_specific_config(), decode_gop_header(), decode_group3_2d_line(), decode_header(), decode_init(), decode_seq_header(), decode_subframe(), decode_tones_info(), ff_hevc_decode_nal_sps(), ff_ivi_decode_frame(), ff_jpegls_decode_picture(), ff_mjpeg_decode_sof(), ff_spdif_read_packet(), ff_vc1_parse_frame_header_adv(), g2m_load_cursor(), handle_id3(), ogg_replace_stream(), old_codec37(), old_codec47(), parse_adts_frame_header(), parse_MP4SLDescrTag(), read_frame_header(), read_sbr_extension(), rpl_read_header(), rso_read_header(), tiff_decode_tag(), vp6_parse_header(), vqa_decode_init(), and xwd_decode_frame().

void void avpriv_request_sample	(	void *	avc,
		const char *	msg,
			...
	)

Log a generic warning message about a missing feature.

Additionally request that a sample showcasing the feature be uploaded.

Parameters

[in]	avc	a pointer to an arbitrary struct of which the first field is a pointer to an AVClass struct
[in]	msg	string containing the name of the missing feature

Referenced by aac_decode_er_frame(), alac_decode_init(), amrwb_decode_frame(), ape_decode_init(), ast_read_header(), avi_extract_stream_metadata(), avr_read_header(), cdxl_decode_frame(), cine_read_header(), cinepak_decode(), compute_band_indexes(), cook_decode_init(), dca_decode_frame(), dca_exss_parse_header(), dca_subframe_footer(), dca_subframe_header(), decode_audio_block(), decode_band_hdr(), decode_bytes(), decode_cdlms(), decode_channel_transform(), decode_eld_specific_config(), decode_frame(), decode_frame_headers(), decode_ga_specific_config(), decode_ics(), decode_init(), decode_mvc2(), decode_nop(), decode_packet(), decode_scalefactors(), decode_sgirle8(), decode_subframe(), decode_wmv9(), decode_yuv_frame(), determine_bitrate(), dsf_read_header(), dxtory_decode_v2_410(), dxtory_decode_v2_420(), dxtory_decode_v2_444(), dxtory_decode_v2_565(), dxtory_decode_v2_rgb(), dxva2_mpeg2_decode_slice(), ea_read_packet(), epaf_read_header(), execute_code(), exif_add_metadata(), ff_adx_decode_header(), ff_eac3_parse_header(), ff_h264_decode_seq_parameter_set(), ff_h264_decode_slice_header(), ff_jpegls_decode_lse(), ff_mjpeg_decode_sof(), ff_opus_parse_extradata(), ff_parse_mpeg2_descriptor(), ff_spdif_read_packet(), fill_coding_method_array(), flashsv_decode_frame(), flic_decode_init(), flv_set_audio_codec(), flv_set_video_codec(), g2m_decode_frame(), get_cox(), get_packet_header(), get_siz(), get_sot(), iff_read_header(), imc_decode_init(), jp2_find_codestream(), jpeg2000_decode_packet(), jpeg2000_decode_packets(), lag_decode_zero_run_line(), latm_decode_audio_specific_config(), lvf_read_header(), mimic_decode_frame(), mov_read_mdhd(), mpc7_decode_init(), mpc8_decode_init(), mtv_read_header(), mv_read_header(), mxf_parse_structural_metadata(), mxf_read_packet_old(), mxf_read_primer_pack(), nist_read_header(), oma_read_header(), paf_video_decode(), parse_dsd_prop(), parse_fmtp(), parse_MP4SLDescrTag(), parse_setup_header(), parse_video_var(), pix_decode_frame(), process_audio_header_eacs(), process_audio_header_elements(), process_ea_header(), process_frame_obj(), ptx_decode_frame(), qt_rtp_parse_packet(), read_block_data(), read_frame(), read_header(), read_major_sync(), read_restart_header(), read_sbr_extension(), read_stream_mux_config(), read_table(), rm_read_audio_stream_info(), rpl_read_header(), rsd_read_header(), rso_read_header(), rv10_decode_init(), rv10_decode_picture_header(), save_bits(), save_subtitle_set(), scan_file(), smc_decode_stream(), smjpeg_read_header(), spdif_get_offset_and_codec(), spdif_header_dts(), spdif_header_truehd(), sunrast_decode_frame(), synth_superframe(), tiff_unpack_fax(), tm2_read_header(), truemotion1_decode_header(), truespeech_decode_init(), unsupported(), vc1_decode_init(), vcr1_decode_init(), vp7_decode_frame_header(), vp8_decode_frame_header(), vqa_decode_init(), wsaud_read_header(), xa_decode(), xan_wc3_copy_pixel_run(), xmv_read_header(), xwd_decode_frame(), xwma_read_header(), and zero12v_decode_init().

int avpriv_open	(	const char *	filename,
		int	flags,
			...
	)

A wrapper for open() setting O_CLOEXEC.

Definition at line 71 of file file_open.c.

Referenced by audio_open(), av_file_map(), av_fopen_utf8(), bktr_init(), dv1394_read_header(), fbdev_read_header(), fbdev_write_header(), ff_fbdev_get_device_list(), and read_random().

uint64_t ff_get_channel_layout	(	const char *	name,
		int	compat
	)

Definition at line 159 of file channel_layout.c.

Referenced by av_get_channel_layout(), and av_opt_set().