FFmpeg: AVTextFormatContext Struct Reference

FFmpeg

#include <avtextformat.h>

Data Fields
const AVClass *	class
	class of the formatter More...

const AVTextFormatter *	formatter
	the AVTextFormatter of which this is an instance More...

AVTextWriterContext *	writer
	the AVTextWriterContext More...

char *	name
	name of this formatter instance More...

void *	priv
	private data for use by the filter More...

const AVTextFormatSection *	sections
	array containing all sections More...

int	nb_sections
	number of sections More...

int	level
	current level, starting from 0 More...

unsigned int	nb_item [SECTION_MAX_NB_LEVELS]
	number of the item printed in the given section, starting from 0 More...

unsigned int	nb_item_type [SECTION_MAX_NB_LEVELS][SECTION_MAX_NB_SECTIONS]

const AVTextFormatSection *	section [SECTION_MAX_NB_LEVELS]
	section per each level More...

AVBPrint	section_pbuf [SECTION_MAX_NB_LEVELS]
	generic print buffer dedicated to each section, used by various formatters More...

int(*	is_key_selected )(struct AVTextFormatContext tctx, const char key)
	Callback to discard certain elements based upon the key used. More...

int	show_optional_fields

int	show_value_unit

int	use_value_prefix

int	use_byte_value_binary_prefix

int	use_value_sexagesimal_format

struct AVHashContext *	hash

int	string_validation

char *	string_validation_replacement

unsigned int	string_validation_utf8_flags

Detailed Description

Definition at line 110 of file avtextformat.h.

Field Documentation

◆ class

const AVClass* AVTextFormatContext::class

class of the formatter

Definition at line 111 of file avtextformat.h.

Referenced by avtext_context_open().

◆ formatter

const AVTextFormatter* AVTextFormatContext::formatter

the AVTextFormatter of which this is an instance

Definition at line 112 of file avtextformat.h.

Referenced by avtext_context_close(), avtext_context_open(), avtext_print_integer(), avtext_print_section_footer(), avtext_print_section_header(), avtext_print_string(), init_graphprint(), probe_file(), and textcontext_get_formatter_name().

◆ writer

AVTextWriterContext* AVTextFormatContext::writer

the AVTextWriterContext

Definition at line 113 of file avtextformat.h.

Referenced by avtext_context_open(), writer_printf(), writer_put_str(), and writer_w8().

◆ name

char* AVTextFormatContext::name

name of this formatter instance

Definition at line 115 of file avtextformat.h.

◆ priv

void* AVTextFormatContext::priv

private data for use by the filter

Definition at line 116 of file avtextformat.h.

Referenced by av_diagram_init(), avtext_context_close(), avtext_context_open(), compact_init(), compact_print_int(), compact_print_section_footer(), compact_print_section_header(), compact_print_str(), default_print_int(), default_print_section_footer(), default_print_section_header(), default_print_str(), flat_init(), flat_print_section_header(), flat_print_str(), has_link_pair(), ini_print_section_header(), json_init(), json_print_int(), json_print_section_footer(), json_print_section_header(), json_print_str(), mermaid_init(), mermaid_init_html(), mermaid_print_section_footer(), mermaid_print_section_header(), mermaid_print_value(), mermaid_uninit(), xml_init(), xml_print_section_footer(), xml_print_section_header(), and xml_print_value().

◆ sections

const AVTextFormatSection* AVTextFormatContext::sections

array containing all sections

Definition at line 118 of file avtextformat.h.

Referenced by avtext_context_open(), and avtext_print_section_header().

◆ nb_sections

int AVTextFormatContext::nb_sections

number of sections

Definition at line 119 of file avtextformat.h.

Referenced by avtext_context_open(), and avtext_print_section_header().

◆ level

int AVTextFormatContext::level

◆ nb_item

unsigned int AVTextFormatContext::nb_item[SECTION_MAX_NB_LEVELS]

number of the item printed in the given section, starting from 0

Definition at line 124 of file avtextformat.h.

Referenced by avtext_print_integer(), avtext_print_section_footer(), avtext_print_section_header(), avtext_print_string(), compact_print_int(), compact_print_section_header(), compact_print_str(), flat_print_section_header(), ini_print_section_header(), json_print_int(), json_print_section_header(), json_print_str(), xml_print_section_header(), and xml_print_value().

◆ nb_item_type

unsigned int AVTextFormatContext::nb_item_type[SECTION_MAX_NB_LEVELS][SECTION_MAX_NB_SECTIONS]

Definition at line 125 of file avtextformat.h.

Referenced by avtext_print_section_footer(), avtext_print_section_header(), flat_print_section_header(), and ini_print_section_header().

◆ section

const AVTextFormatSection* AVTextFormatContext::section[SECTION_MAX_NB_LEVELS]

section per each level

Definition at line 128 of file avtextformat.h.

Referenced by avtext_print_section_footer(), avtext_print_section_header(), avtext_print_string(), flat_print_section_header(), ini_print_section_header(), is_key_selected_callback(), and tf_get_section().

◆ section_pbuf

AVBPrint AVTextFormatContext::section_pbuf[SECTION_MAX_NB_LEVELS]

generic print buffer dedicated to each section, used by various formatters

Definition at line 129 of file avtextformat.h.

Referenced by avtext_context_close(), avtext_context_open(), compact_print_int(), compact_print_section_header(), compact_print_str(), default_print_int(), default_print_section_header(), default_print_str(), flat_print_int(), flat_print_section_header(), flat_print_str(), ini_print_section_header(), mermaid_print_section_footer(), mermaid_print_section_header(), mermaid_print_value(), and mermaid_subgraph_complete_start().

◆ is_key_selected

int(* AVTextFormatContext::is_key_selected) (struct AVTextFormatContext *tctx, const char *key)

Callback to discard certain elements based upon the key used.

It is called before any element with a key is printed. If this callback is unset, all elements are printed.

Return values

1	if the element is supposed to be printed
0	if the element is supposed to be discarded

Definition at line 140 of file avtextformat.h.

Referenced by avtext_context_open(), avtext_print_integer(), and avtext_print_string().

◆ show_optional_fields

int AVTextFormatContext::show_optional_fields

Definition at line 142 of file avtextformat.h.

Referenced by avtext_context_open(), avtext_print_integer(), avtext_print_string(), and init_graphprint().

◆ show_value_unit

int AVTextFormatContext::show_value_unit

Definition at line 143 of file avtextformat.h.

Referenced by avtext_context_open(), init_graphprint(), print_link(), value_string(), and xml_init().

◆ use_value_prefix

int AVTextFormatContext::use_value_prefix

Definition at line 144 of file avtextformat.h.

Referenced by avtext_context_open(), value_string(), and xml_init().

◆ use_byte_value_binary_prefix

int AVTextFormatContext::use_byte_value_binary_prefix

Definition at line 145 of file avtextformat.h.

Referenced by avtext_context_open(), and value_string().

◆ use_value_sexagesimal_format

int AVTextFormatContext::use_value_sexagesimal_format

Definition at line 146 of file avtextformat.h.

Referenced by avtext_context_open(), and value_string().

◆ hash

struct AVHashContext* AVTextFormatContext::hash

Definition at line 148 of file avtextformat.h.

Referenced by avtext_context_close(), avtext_context_open(), and avtext_print_data_hash().

◆ string_validation

int AVTextFormatContext::string_validation

Definition at line 150 of file avtextformat.h.

Referenced by validate_string().

◆ string_validation_replacement

char* AVTextFormatContext::string_validation_replacement

Definition at line 151 of file avtextformat.h.

Referenced by avtext_context_open(), and validate_string().

◆ string_validation_utf8_flags

unsigned int AVTextFormatContext::string_validation_utf8_flags

Definition at line 152 of file avtextformat.h.

Referenced by avtext_context_open(), main(), and validate_string().

The documentation for this struct was generated from the following file:

fftools/textformat/avtextformat.h