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 "macros.h"
#include "pixfmt.h"
#include "version.h"
#include "libm.h"

Macros
#define	NDEBUG

#define	av_export_avutil

#define	FF_DISABLE_DEPRECATION_WARNINGS

#define	FF_ENABLE_DEPRECATION_WARNINGS

#define	FF_MEMORY_POISON 0x2a

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

#define	AV_CHECK_OFFSET(s, m, o)

#define	FF_ALLOC_TYPED_ARRAY(p, nelem) (p = av_malloc_array(nelem, sizeof(*p)))

#define	FF_ALLOCZ_TYPED_ARRAY(p, nelem) (p = av_mallocz_array(nelem, sizeof(*p)))

#define	NULL_IF_CONFIG_SMALL(x) x
	Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. More...

#define	ONLY_IF_THREADS_ENABLED(x) NULL
	Define a function with only the non-default version specified. More...

#define	PTRDIFF_SPECIFIER "td"

#define	SIZE_SPECIFIER "zu"

#define	ff_dlog(ctx, ...) do { if (0) av_log(ctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)

#define	SUINT unsigned

#define	SUINT32 uint32_t

#define	FF_PSEUDOPAL AV_PIX_FMT_FLAG_PSEUDOPAL

Functions
void	avpriv_report_missing_feature (void avc, const char msg,...) av_printf_format(2
	Log a generic warning message about a missing feature. More...

void void	avpriv_request_sample (void avc, const char msg,...) av_printf_format(2
	Log a generic warning message about a missing feature. More...

static av_always_inline av_const int64_t	ff_rint64_clip (double a, int64_t amin, int64_t amax)
	Clip and convert a double value into the long long amin-amax range. More...

av_warn_unused_result int	avpriv_open (const char *filename, int flags,...)
	A wrapper for open() setting O_CLOEXEC. More...

int	avpriv_tempfile (const char prefix, char filename, int log_offset, void log_ctx)
	Wrapper to work around the lack of mkstemp() on mingw. More...

int	avpriv_set_systematic_pal2 (uint32_t pal[256], enum AVPixelFormat pix_fmt)

static av_always_inline av_const int	avpriv_mirror (int x, int w)

void	ff_check_pixfmt_descriptors (void)

int	avpriv_dict_set_timestamp (AVDictionary *dict, const char key, int64_t timestamp)
	Set a dictionary value to an ISO-8601 compliant timestamp string. More...

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_avutil

Definition at line 68 of file internal.h.

#define FF_DISABLE_DEPRECATION_WARNINGS

Definition at line 83 of file internal.h.

Referenced by alac_encode_init(), av_codec_iterate(), av_frame_get_qp_table(), av_frame_set_qp_table(), av_frame_unref(), av_init_packet(), av_opt_child_class_iterate(), av_opt_child_next(), av_packet_copy_props(), av_packet_free_side_data(), av_packet_from_data(), av_packet_rescale_ts(), av_parser_init(), av_stream_get_codec_timebase(), av_write_image_line(), avcodec_close(), avcodec_copy_context(), avcodec_find_best_pix_fmt_of_list(), avcodec_open2(), avfilter_get_by_name(), avformat_alloc_output_context2(), avformat_find_stream_info(), avformat_new_stream(), avformat_open_input(), avformat_transfer_internal_stream_timing_info(), avpriv_set_pts_info(), bmp_encode_frame(), compute_pkt_fields(), copy_context_reset(), copy_frame(), cuvid_output_frame(), decode_dvd_subtitles(), decode_frame(), decode_simple_internal(), display_end_segment(), dnxhd_encode_init(), dnxhd_encode_picture(), dnxhd_load_picture(), do_swap(), dump_stream_format(), dvvideo_encode_frame(), encode_dvd_subtitles(), encode_frame(), encode_init(), encode_init_ls(), encode_picture_ls(), encode_thread(), ff_compute_frame_duration(), ff_decode_frame_props(), ff_format_set_url(), ff_mp4_read_dec_config_descr(), ff_mpeg1_init_uni_ac_vlc(), ff_mpv_encode_init(), ff_mpv_encode_picture(), ff_qsv_encode(), ff_stream_add_bitstream_filter(), ff_stream_encode_params_copy(), ff_thread_can_start_frame(), ff_thread_release_buffer(), ffat_decode(), ffmal_copy_frame(), find_decoder(), find_fps(), find_smallest_bounding_rectangle(), flac_encode_frame(), flac_encode_init(), flashsv_encode_frame(), frame_copy_props(), frame_end(), frame_worker_thread(), free_stream(), get_frame_defaults(), gif_decode_frame(), init_muxer(), init_video_param(), io_open_default(), j2kenc_init(), libdav1d_receive_frame(), libkvazaar_encode(), libx265_encode_frame(), ljpeg_encode_bgr(), ljpeg_encode_init(), ljpeg_encode_yuv(), main(), match_stream_specifier(), matroska_parse_frame(), mediacodec_wrap_hw_buffer(), mediacodec_wrap_sw_buffer(), mkv_write_packet_internal(), mov_parse_stsd_data(), mov_read_dac3(), mov_read_dec3(), mov_write_tmcd_tag(), mov_write_video_tag(), mpeg_decode_gop(), pam_encode_init(), pcx_encode_init(), png_enc_init(), pnm_encode_init(), process_output_surface(), qsv_decode(), qtrle_encode_frame(), raw_encode_init(), read_frame_internal(), save_subtitle_set(), segment_mux_init(), set_codec_from_probe_data(), srt_write_packet(), storeframe(), submit_packet(), sunrast_encode_init(), svc_decode_frame(), svc_encode_init(), svq1_encode_frame(), targa_encode_frame(), targa_encode_init(), teletext_decode_frame(), thread_get_buffer_internal(), update_context_from_thread(), update_context_from_user(), update_stream_avctx(), utvideo_encode_frame(), utvideo_encode_init(), v410_encode_frame(), v4l2_read_packet(), vp9_decode_frame(), vpx_init(), wrap_timestamp(), X264_frame(), X264_init(), XAVS_frame(), XAVS_init(), xsub_encode(), xvid_encode_frame(), xvid_encode_init(), and yuv4_write_header().

#define FF_ENABLE_DEPRECATION_WARNINGS

Definition at line 84 of file internal.h.

Referenced by alac_encode_init(), av_bitstream_filter_filter(), av_copy_packet(), av_frame_get_qp_table(), av_frame_set_qp_table(), av_frame_unref(), av_free_packet(), av_init_packet(), av_opt_child_class_iterate(), av_opt_child_class_next(), av_packet_copy_props(), av_packet_rescale_ts(), av_parser_init(), av_picture_copy(), av_picture_pad(), av_stream_get_codec_timebase(), avcodec_close(), avcodec_copy_context(), avcodec_open2(), avcodec_register_all(), avfilter_get_by_name(), avformat_alloc_output_context2(), avformat_find_stream_info(), avformat_new_stream(), avformat_open_input(), avformat_transfer_internal_stream_timing_info(), avpriv_set_pts_info(), bmp_encode_frame(), compute_pkt_fields(), copy_context_reset(), copy_frame(), cuvid_output_frame(), decode_dvd_subtitles(), decode_frame(), decode_simple_internal(), display_end_segment(), dnxhd_encode_init(), dnxhd_encode_picture(), dnxhd_load_picture(), do_swap(), dump_stream_format(), dvvideo_encode_frame(), encode_dvd_subtitles(), encode_frame(), encode_init(), encode_init_ls(), encode_picture_ls(), encode_thread(), ff_compute_frame_duration(), ff_decode_frame_props(), ff_format_set_url(), ff_mp4_read_dec_config_descr(), ff_mpeg1_init_uni_ac_vlc(), ff_mpv_encode_init(), ff_mpv_encode_picture(), ff_qsv_encode(), ff_stream_add_bitstream_filter(), ff_stream_encode_params_copy(), ff_thread_can_start_frame(), ff_thread_get_format(), ff_thread_release_buffer(), ffat_decode(), ffmal_copy_frame(), find_decoder(), find_fps(), find_smallest_bounding_rectangle(), flac_encode_frame(), flac_encode_init(), flashsv_encode_frame(), frame_copy_props(), frame_end(), frame_worker_thread(), free_stream(), get_frame_defaults(), gif_decode_frame(), init_muxer(), init_video_param(), io_open_default(), j2kenc_init(), libdav1d_receive_frame(), libkvazaar_encode(), libx265_encode_frame(), ljpeg_encode_bgr(), ljpeg_encode_init(), ljpeg_encode_yuv(), main(), match_stream_specifier(), matroska_parse_frame(), mediacodec_wrap_hw_buffer(), mediacodec_wrap_sw_buffer(), mkv_write_packet_internal(), mov_parse_stsd_data(), mov_read_dac3(), mov_read_dec3(), mov_write_tmcd_tag(), mov_write_video_tag(), mpeg_decode_gop(), pam_encode_init(), pcx_encode_init(), png_enc_init(), pnm_encode_init(), process_output_surface(), qsv_decode(), qtrle_encode_frame(), raw_encode_init(), read_frame_internal(), save_subtitle_set(), segment_mux_init(), set_codec_from_probe_data(), srt_write_packet(), storeframe(), submit_packet(), sunrast_encode_init(), svc_decode_frame(), svc_encode_init(), svq1_encode_frame(), targa_encode_frame(), targa_encode_init(), teletext_decode_frame(), thread_get_buffer_internal(), update_context_from_thread(), update_context_from_user(), update_stream_avctx(), utvideo_encode_frame(), utvideo_encode_init(), v410_encode_frame(), v4l2_read_packet(), vp9_decode_frame(), vpx_init(), wrap_timestamp(), X264_frame(), X264_init(), XAVS_frame(), XAVS_init(), xsub_encode(), xvid_encode_frame(), xvid_encode_init(), and yuv4_write_header().

#define FF_MEMORY_POISON 0x2a

Definition at line 88 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; }

type

GLint GLenum type

Definition: opengl_enc.c:104

field

it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this field

Definition: writing_filters.txt:78

void

typedef void(APIENTRY *FF_PFNGLACTIVETEXTUREPROC)(GLenum texture)

s

#define s(width, name)

Definition: cbs_vp9.c:257

convert_header.str

string str

Definition: convert_header.py:20

name

const char * name

Definition: opengl_enc.c:102

Definition at line 90 of file internal.h.

Referenced by av_alloc_vdpaucontext(), avpriv_find_pix_fmt(), and wrap_timestamp().

#define AV_CHECK_OFFSET	(	s,
		m,
		o
	)

Value:

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

Definition at line 97 of file internal.h.

#define FF_ALLOC_TYPED_ARRAY	(	p,
		nelem
	)	(p = av_malloc_array(nelem, sizeof(*p)))

Definition at line 102 of file internal.h.

Referenced by adpcm_encode_frame(), adpcm_encode_init(), allocate_buffers(), allocate_sample_buffers(), init_context_frame(), init_mdct_win(), initFilter(), mxf_read_index_entry_array(), and sws_init_context().

#define FF_ALLOCZ_TYPED_ARRAY	(	p,
		nelem
	)	(p = av_mallocz_array(nelem, sizeof(*p)))

#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 115 of file internal.h.

Referenced by a64multi_encode_frame(), ac3_eac3_probe(), activate(), amr_read_packet(), aptx_close(), aptx_decode_frame(), ass_decode_frame(), ass_encode_frame(), check_size(), config_output(), cyuv_decode_frame(), decode_end(), decode_flush(), decode_frame(), eightsvx_decode_close(), encode_frame(), encode_init(), encode_superframe(), ff_argo_asf_fill_stream(), ff_mpeg1_init_uni_ac_vlc(), ff_rtsp_open_transport_ctx(), ff_sp5x_process_packet(), ff_speedhq_mb_y_order_to_mb(), ff_vp8_decode_init(), filter_frame(), flashsv_decode_frame(), flush(), force_one_stream(), g726_reset(), gate(), get_aspect_ratio(), gsm_flush(), hash_free(), init(), libgsm_flush(), mlp_encode_close(), mlp_thd_probe(), mmf_read_packet(), mvc_decode_frame(), nvenc_old_init(), ogg_free(), plot_spectrum_column(), png_dec_end(), pnm_decode_frame(), pnm_encode_init(), predictor_calc_error(), process_command(), read_access_unit(), read_huffman_tree(), request_frame(), set_spdif(), srt_decode_frame(), srt_encode_close(), swf_deinit(), uninit(), v408_decode_frame(), v408_encode_frame(), and vpx_free().

#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 154 of file internal.h.

Referenced by ff_vp8_decode_init(), png_dec_end(), and read_huffman_tree().

#define PTRDIFF_SPECIFIER "td"

#define SIZE_SPECIFIER "zu"

Definition at line 191 of file internal.h.

Referenced by aom_encode(), aom_init(), ape_read_header(), apply_cropping(), av1_decode_frame(), avgblur_opencl_filter_frame(), cbs_av1_read_unit(), cbs_av1_split_fragment(), cbs_vp9_split_fragment(), cbs_write_unit_data(), convolution_opencl_filter_frame(), dnxhd_decode_header(), draw_items(), dump_enc_cfg(), dump_spherical(), epic_jb_decode_tile(), ff_h264_decode_picture_parameter_set(), ff_hevc_decode_nal_pps(), ff_hevc_decode_nal_sps(), ff_hevc_decode_nal_vps(), get_http_header_data(), get_tcp_server_response(), hap_compress_frame(), hq_decode_frame(), hqa_decode_frame(), http_write_reply(), jpeg2000_decode_packet(), main(), neighbor_opencl_filter_frame(), opencl_mem_flags_for_mapping(), parse_multipart_header(), program_opencl_run(), queue_frames(), read_data_packet(), read_geobtag(), storeframe(), sup_write_packet(), unsharp_opencl_filter_frame(), and vpx_init().

#define ff_dlog	(	ctx,
		...
	)	do { if (0) av_log(ctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)

Definition at line 197 of file internal.h.

#define SUINT unsigned

Definition at line 206 of file internal.h.

#define SUINT32 uint32_t

Definition at line 207 of file internal.h.

#define FF_PSEUDOPAL AV_PIX_FMT_FLAG_PSEUDOPAL

Definition at line 297 of file internal.h.

Referenced by activate(), av_image_alloc(), av_image_fill_plane_sizes(), av_image_get_buffer_size(), calc_cropping_offsets(), config_props(), decode_frame(), ff_draw_init(), ff_frame_pool_get(), ff_frame_pool_video_init(), filter_frame(), image_copy(), raw_decode(), raw_init_decoder(), validate_avframe_allocation(), and video_get_buffer().

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(), add_conv_layer(), alac_decode_frame(), alac_decode_init(), amrnb_decode_frame(), amrnb_decode_init(), amrwb_decode_init(), atrac3p_decode_frame(), avi_write_header(), bmp_decode_frame(), cfhd_decode(), check_modelinput_inlink(), codec2_read_header(), cpia_decode_frame(), decode_audio_specific_config_gb(), decode_block(), decode_eld_specific_config(), decode_element(), decode_extension_payload(), decode_frame(), decode_ga_specific_config(), decode_gop_header(), decode_group3_2d_line(), decode_header(), decode_ics(), decode_idat_chunk(), decode_seq_header(), decode_subframe(), decode_tones_info(), dvbsub_parse_object_segment(), execute_model_native(), execute_model_tf(), ff_dnn_execute_model_ov(), ff_get_wav_header(), ff_h264_decode_picture_parameter_set(), ff_hevc_encode_nal_vps(), ff_ivi_decode_frame(), ff_jpegls_decode_picture(), ff_mjpeg_decode_sof(), ff_mjpeg_decode_sos(), ff_proc_from_dnn_to_frame(), ff_proc_from_frame_to_dnn(), ff_rtp_send_vc2hq(), ff_rtsp_open_transport_ctx(), ff_rv10_encode_picture_header(), ff_spdif_read_packet(), ff_vc1_parse_frame_header_adv(), g2m_decode_frame(), g2m_load_cursor(), g723_1_encode_init(), get_packet_header(), h264_handle_packet(), handle_id3(), hevc_handle_packet(), jpeg_parse_packet(), libopenjpeg_decode_frame(), matroska_read_header(), mpc8_read_header(), mpegaudio_parse(), ogg_replace_stream(), old_codec37(), old_codec47(), parse_adts_frame_header(), parse_bit_alloc(), parse_channel(), parse_decoder_init(), parse_fmtp_config(), parse_MP4SLDescrTag(), parse_packed_headers(), pixfmt_from_pixmap_format(), read_frame_header(), read_header(), rpl_read_header(), rso_read_header(), rso_write_header(), s337m_get_offset_and_codec(), set_option(), shorten_decode_frame(), spdif_write_header(), svq3_decode_slice_header(), tak_decode_frame(), tiff_decode_tag(), txd_decode_frame(), v4l2_check_b_frame_support(), vfw_read_header(), vp5_parse_header(), vp6_parse_header(), vp9_handle_packet(), vqa_decode_init(), wv_read_block_header(), xcbgrab_read_header(), xiph_handle_packet(), 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

static av_always_inline av_const int64_t ff_rint64_clip	(	double	a,
		int64_t	amin,
		int64_t	amax
	)

static

Clip and convert a double value into the long long amin-amax range.

This function is needed because conversion of floating point to integers when it does not fit in the integer's representation does not necessarily saturate correctly (usually converted to a cvttsd2si on x86) which saturates numbers

INT64_MAX to INT64_MIN. The standard marks such conversions as undefined

behavior, allowing this sort of mathematically bogus conversions. This provides a safe alternative that is slower obviously but assures safety and better mathematical behavior.

Parameters

a	value to clip
amin	minimum value of the clip range
amax	maximum value of the clip range

Returns: clipped value

Definition at line 224 of file internal.h.

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

A wrapper for open() setting O_CLOEXEC.

Definition at line 66 of file file_open.c.

Referenced by av_file_map(), av_fopen_utf8(), bktr_init(), fbdev_read_header(), fbdev_write_header(), ff_fbdev_get_device_list(), ff_oss_audio_open(), ff_rint64_clip(), file_move(), and read_random().

int avpriv_tempfile	(	const char *	prefix,
		char **	filename,
		int	log_offset,
		void *	log_ctx
	)

Wrapper to work around the lack of mkstemp() on mingw.

Also, tries to create file in /tmp first, if possible. *prefix can be a character constant; *filename will be allocated internally.

Returns: file descriptor of opened file (or negative value corresponding to an AVERROR code on error) and opened file name in **filename.

Note: On very old libcs it is necessary to set a secure umask before calling this, av_tempfile() can't call umask itself as it is used in libraries and could interfere with the calling application.

Definition at line 110 of file file_open.c.

Referenced by av_tempfile(), cache_open(), ff_rint64_clip(), and xvid_encode_init().

int avpriv_set_systematic_pal2	(	uint32_t	pal[256],
		enum AVPixelFormat	pix_fmt
	)

Definition at line 176 of file imgutils.c.

Referenced by av_image_alloc(), bmp_encode_frame(), ff_frame_pool_get(), ff_rint64_clip(), gif_encode_init(), pcx_encode_frame(), raw_init_decoder(), scale_frame(), video_get_buffer(), and xwd_encode_frame().

static av_always_inline av_const int avpriv_mirror	(	int	x,
		int	w
	)

static

void ff_check_pixfmt_descriptors ( void )

Definition at line 2628 of file pixdesc.c.

Referenced by avpriv_mirror(), and main().

int avpriv_dict_set_timestamp	(	AVDictionary **	dict,
		const char *	key,
		int64_t	timestamp
	)

Set a dictionary value to an ISO-8601 compliant timestamp string.

Parameters

dict	pointer to a pointer to a dictionary struct. If dict is NULL a dictionary struct is allocated and put in dict.
key	metadata key
timestamp	unix timestamp in microseconds

Returns: <0 on error

Definition at line 258 of file dict.c.

Referenced by avpriv_mirror(), ff_standardize_creation_time(), matroska_metadata_creation_time(), mov_metadata_creation_time(), and parse_header().

Macros

Functions

Detailed Description

Macro Definition Documentation

Function Documentation