AVBPrint

Files
file	bprint.h

Macros
#define	FF_PAD_STRUCTURE(name, size, ...)
	Define a structure with extra padding to a fixed size This helps ensuring binary compatibility with future versions. More...

Functions
void	av_bprint_init_for_buffer (AVBPrint *buf, char *buffer, unsigned size)
	Init a print buffer using a pre-existing buffer. More...
void	av_bprintf (AVBPrint *buf, const char *fmt,...) av_printf_format(2
	Append a formatted string to a print buffer. More...
void void	av_vbprintf (AVBPrint *buf, const char *fmt, va_list vl_arg)
	Append a formatted string to a print buffer. More...
void	av_bprint_chars (AVBPrint *buf, char c, unsigned n)
	Append char c n times to a print buffer. More...
void	av_bprint_append_data (AVBPrint *buf, const char *data, unsigned size)
	Append data to a print buffer. More...
void	av_bprint_strftime (AVBPrint *buf, const char *fmt, const struct tm *tm)
	Append a formatted date and time to a print buffer. More...
void	av_bprint_get_buffer (AVBPrint *buf, unsigned size, unsigned char **mem, unsigned *actual_size)
	Allocate bytes in the buffer for external use. More...
void	av_bprint_clear (AVBPrint *buf)
	Reset the string to "" but keep internal allocated data. More...
static int	av_bprint_is_complete (const AVBPrint *buf)
	Test if the print buffer is complete (not truncated). More...
int	av_bprint_finalize (AVBPrint *buf, char **ret_str)
	Finalize a print buffer. More...
void	av_bprint_escape (AVBPrint *dstbuf, const char *src, const char *special_chars, enum AVEscapeMode mode, int flags)
	Escape the content in src and append it to dstbuf. More...

Variables
unsigned	size_init
unsigned unsigned	size_max

Detailed Description

A buffer to print data progressively

Macro Definition Documentation

FF_PAD_STRUCTURE

#define FF_PAD_STRUCTURE	(		name,
			size,
			...
	)

Value:

struct ff_pad_helper_##name { __VA_ARGS__ }; \
typedef struct name { \
    __VA_ARGS__ \
    char reserved_padding[size - sizeof(struct ff_pad_helper_##name)]; \
} name;

Define a structure with extra padding to a fixed size This helps ensuring binary compatibility with future versions.

Definition at line 48 of file bprint.h.

Function Documentation

av_bprint_init_for_buffer()

void av_bprint_init_for_buffer	(	AVBPrint *	buf,
		char *	buffer,
		unsigned	size
	)

Init a print buffer using a pre-existing buffer.

The buffer will not be reallocated.

Parameters

buf	buffer structure to init
buffer	byte buffer to use for the string data
size	size of buffer

Definition at line 85 of file bprint.c.

Referenced by av_channel_description(), av_channel_layout_describe(), av_channel_name(), av_get_channel_layout_string(), avcodec_string(), avfilter_graph_dump(), http_connect(), and main().

av_bprintf()

void av_bprintf	(	AVBPrint *	buf,
		const char *	fmt,
			...
	)

Append a formatted string to a print buffer.

av_vbprintf()

void void av_vbprintf	(	AVBPrint *	buf,
		const char *	fmt,
		va_list	vl_arg
	)

Append a formatted string to a print buffer.

Definition at line 117 of file bprint.c.

Referenced by avio_vprintf(), format_line(), srt_print(), and webvtt_print().

av_bprint_chars()

void av_bprint_chars	(	AVBPrint *	buf,
		char	c,
		unsigned	n
	)

Append char c n times to a print buffer.

Definition at line 140 of file bprint.c.

Referenced by av_bprint_escape(), av_bprint_utf8(), avcodec_string(), avfilter_graph_dump_to_buf(), c_escape_str(), choose_channel_layouts(), csv_escape_str(), decode_string(), expand_filename_template(), expand_text(), ff_ass_bprint_text_event(), ff_htmlmarkup_to_ass(), ff_id3v2_parse_priv_dict(), ff_smil_extract_next_text_chunk(), ff_subtitles_read_text_chunk(), flat_escape_key_str(), flat_escape_value_str(), get_line(), handle_open_brace(), ini_escape_str(), json_escape_str(), main(), make_command_flags_str(), microdvd_decode_frame(), mov_text_new_line_cb(), mpl2_event_to_ass(), parse_string(), print_link_prop(), read_line(), rt_event_to_ass(), sami_paragraph_to_ass(), subviewer_event_to_ass(), try_describe_ambisonic(), ttml_write_header_content(), webvtt_event_to_ass(), write_frame(), and writer_print_data().

av_bprint_append_data()

void av_bprint_append_data	(	AVBPrint *	buf,
		const char *	data,
		unsigned	size
	)

Append data to a print buffer.

param buf bprint buffer to use param data pointer to data param size size of data

Definition at line 158 of file bprint.c.

Referenced by av_dict_get_string(), av_opt_serialize(), av_strireplace(), avio_read_to_bprint(), bprint_escaped_path(), ff_vk_print_shader(), gen_sub_text(), is_image(), libaribb24_handle_regions(), mov_text_text_cb(), read_line_to_bprint_escaped(), read_string_to_bprint(), replace_int_data_in_filename(), replace_str_data_in_filename(), srt_text_cb(), text_to_ass(), ttml_text_cb(), validate_string(), and webvtt_text_cb().

av_bprint_strftime()

void av_bprint_strftime	(	AVBPrint *	buf,
		const char *	fmt,
		const struct tm *	tm
	)

Append a formatted date and time to a print buffer.

param buf bprint buffer to use param fmt date and time format string, see strftime() param tm broken-down time structure to translate

Note

due to poor design of the standard strftime function, it may produce poor results if the format string expands to a very long text and the bprint buffer is near the limit stated by the size_max option.

Definition at line 176 of file bprint.c.

Referenced by draw_text(), func_pts(), func_strftime(), and main().

av_bprint_get_buffer()

void av_bprint_get_buffer	(	AVBPrint *	buf,
		unsigned	size,
		unsigned char **	mem,
		unsigned *	actual_size
	)

Allocate bytes in the buffer for external use.

Parameters

[in]	buf	buffer structure
[in]	size	required size
[out]	mem	pointer to the memory area
[out]	actual_size	size of the memory area after allocation; can be larger or smaller than size

Definition at line 218 of file bprint.c.

Referenced by decode_zbuf().

av_bprint_clear()

void av_bprint_clear

(

AVBPrint *

buf

)

Reset the string to "" but keep internal allocated data.

Definition at line 227 of file bprint.c.

Referenced by add_event(), capture_screen(), compact_print_section_header(), configure_output_audio_filter(), default_print_section_header(), draw_text(), encode_frame(), encode_sample_description(), expand_text(), ff_subtitles_read_text_chunk(), flat_print_section_header(), flat_print_str(), flush_decoder(), get_bprint_line(), get_line(), hls_delete_old_segments(), ini_print_section_header(), ini_print_str(), json_print_item_str(), main(), microdvd_init(), mov_text_encode_frame(), mov_text_style_start(), new_output_stream(), parse_file(), parse_psfile(), read_dialogue(), read_line(), read_string_to_bprint_overwrite(), realtext_read_header(), sami_paragraph_to_ass(), sami_read_header(), ttml_encode_frame(), ttml_write_header_content(), webvtt_encode_frame(), and xml_print_str().

av_bprint_is_complete()

static int av_bprint_is_complete ( const AVBPrint *  buf )

inlinestatic

Test if the print buffer is complete (not truncated).

It may have been truncated due to a memory allocation failure or the size_max limit (compare size and size_max if necessary).

Definition at line 215 of file bprint.h.

Referenced by av_bprint_alloc(), av_escape(), av_strireplace(), avcodec_string(), avio_read_to_bprint(), avio_vprintf(), bprint_to_avdict(), bprint_to_extradata(), capture_screen(), choose_pix_fmts(), configure_output_audio_filter(), create_ass_text(), dashenc_delete_segment_file(), draw_text(), encode_frame(), encode_sample_description(), expand_text(), ff_bprint_to_codecpar_extradata(), ff_htmlmarkup_to_ass(), fits_read_packet(), func_strftime(), gen_sub_ass(), gen_sub_text(), get_line(), hls_delete_old_segments(), http_connect(), icecast_open(), init_report(), libaribb24_handle_regions(), main(), mov_text_encode_frame(), parse_string(), read_string_to_bprint_overwrite(), replace_int_data_in_filename(), replace_str_data_in_filename(), rstrip_spaces_buf(), rtmp_open(), ttml_encode_frame(), ttml_text_cb(), ttml_write_header_content(), webvtt_encode_frame(), and write_frame().

av_bprint_finalize()

int av_bprint_finalize	(	AVBPrint *	buf,
		char **	ret_str
	)

Finalize a print buffer.

The print buffer can no longer be used afterwards, but the len and size fields are still valid.

• [out] ret_str if not NULL, used to return a permanent copy of the buffer contents, or NULL if memory allocation fails; if NULL, the buffer is discarded and freed

  Returns

  0 for success or error code (probably AVERROR(ENOMEM))

Definition at line 235 of file bprint.c.

Referenced by ass_read_header(), av_dict_get_string(), av_escape(), av_log_default_callback(), av_log_format_line2(), av_opt_serialize(), av_strireplace(), avio_vprintf(), bprint_to_avdict(), bprint_to_extradata(), bsf_list_item_name(), close_decoder(), compact_print_str(), concat_parse_script(), configure_output_audio_filter(), configure_output_video_filter(), create_ass_text(), dashenc_delete_segment_file(), decode_frame_common(), decode_iccp_chunk(), decode_text_chunk(), decode_zbuf(), disp_tree(), dump_curves(), ff_bprint_to_codecpar_extradata(), ff_id3v2_parse_priv_dict(), ff_imf_parse_cpl(), ff_jni_exception_get_summary(), ff_vk_print_shader(), ffprobe_show_program_version(), file_read(), fits_read_packet(), flat_print_str(), free_pipeline(), ftp_status(), func_strftime(), gen_sub_ass(), gen_sub_text(), gif_read_header(), hls_delete_old_segments(), icecast_open(), ini_print_str(), init_report(), jacosub_decode_frame(), jacosub_read_header(), json_print_int(), json_print_item_str(), json_print_section_header(), lavfi_read_header(), libaribb24_handle_regions(), lrc_read_header(), main(), microdvd_decode_frame(), mov_read_kind(), mov_text_decode_frame(), mov_text_encode_close(), mpl2_decode_frame(), mpsub_read_header(), new_output_stream(), parse_assetmap(), parse_file(), parse_manifest(), parse_psfile(), print_dovi_metadata(), print_report(), read_header(), realtext_decode_frame(), realtext_read_header(), replace_int_data_in_filename(), replace_str_data_in_filename(), rtmp_close(), rtmp_open(), sami_close(), sami_read_header(), show_frame(), show_packet(), show_stream(), show_subtitle(), srt_decode_frame(), srt_encode_close(), srt_read_header(), subviewer_decode_frame(), subviewer_read_header(), text_decode_frame(), tlog_ref(), tonemap_opencl_init(), ttml_encode_close(), ttml_text_cb(), uninit(), validate_string(), video_refresh(), webvtt_decode_frame(), webvtt_encode_close(), webvtt_read_header(), write_frame(), writer_close(), writer_print_data(), writer_print_integers(), and xml_print_str().

av_bprint_escape()

void av_bprint_escape	(	AVBPrint *	dstbuf,
		const char *	src,
		const char *	special_chars,
		enum AVEscapeMode	mode,
		int	flags
	)

Escape the content in src and append it to dstbuf.

Parameters

dstbuf	already inited destination bprint buffer
src	string containing the text to escape
special_chars	string containing the special characters which need to be escaped, can be NULL
mode	escape mode to employ, see AV_ESCAPE_MODE_* macros. Any unknown value for mode will be considered equivalent to AV_ESCAPE_MODE_BACKSLASH, but this behaviour can change without notice.
flags	flags which control how to escape, see AV_ESCAPE_FLAG_* macros

Definition at line 263 of file bprint.c.

Referenced by av_dict_get_string(), av_escape(), av_opt_serialize(), ttml_encode_frame(), ttml_text_cb(), ttml_write_region(), and xml_print_str().

Variable Documentation

size_init

unsigned size_init

Definition at line 141 of file bprint.h.

Referenced by av_bprint_init().

size_max

unsigned unsigned size_max

Definition at line 141 of file bprint.h.

Referenced by av_bprint_init().