#include <limits.h>
#include <stdarg.h>
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include "libavutil/mem.h"
#include "libavutil/avassert.h"
#include "libavutil/bprint.h"
#include "libavutil/error.h"
#include "libavutil/hash.h"
#include "libavutil/intreadwrite.h"
#include "libavutil/macros.h"
#include "libavutil/opt.h"
#include "avtextformat.h"

Data Structures
struct	unit_value

Macros
#define	SECTION_ID_NONE (-1)

#define	SHOW_OPTIONAL_FIELDS_AUTO (-1)

#define	SHOW_OPTIONAL_FIELDS_NEVER 0

#define	SHOW_OPTIONAL_FIELDS_ALWAYS 1

#define	OFFSET(x) offsetof(AVTextFormatContext, x)

Functions
static const char *	textcontext_get_formatter_name (void *p)

static void *	textcontext_child_next (void obj, void prev)

static void	bprint_bytes (AVBPrint bp, const uint8_t ubuf, size_t ubuf_size)

int	avtext_context_close (AVTextFormatContext **ptctx)

int	avtext_context_open (AVTextFormatContext *ptctx, const AVTextFormatter formatter, AVTextWriterContext writer_context, const char args, const AVTextFormatSection sections, int nb_sections, AVTextFormatOptions options, char show_data_hash)

void	avtext_print_section_header (AVTextFormatContext tctx, const void data, int section_id)

void	avtext_print_section_footer (AVTextFormatContext *tctx)

void	avtext_print_integer (AVTextFormatContext tctx, const char key, int64_t val, int flags)

static int	validate_string (AVTextFormatContext tctx, char dstp, const char src)

static char *	value_string (const AVTextFormatContext tctx, char buf, int buf_size, struct unit_value uv)

void	avtext_print_unit_integer (AVTextFormatContext tctx, const char key, int64_t val, const char *unit)

int	avtext_print_string (AVTextFormatContext tctx, const char key, const char *val, int flags)

void	avtext_print_rational (AVTextFormatContext tctx, const char key, AVRational q, char sep)

void	avtext_print_time (AVTextFormatContext tctx, const char key, int64_t ts, const AVRational *time_base, int is_duration)

void	avtext_print_ts (AVTextFormatContext tctx, const char key, int64_t ts, int is_duration)

void	avtext_print_data (AVTextFormatContext tctx, const char key, const uint8_t *data, int size)

void	avtext_print_data_hash (AVTextFormatContext tctx, const char key, const uint8_t *data, int size)

void	avtext_print_integers (AVTextFormatContext tctx, const char key, uint8_t data, int size, const char format, int columns, int bytes, int offset_add)

static const char *	writercontext_get_writer_name (void *p)

static void *	writercontext_child_next (void obj, void prev)

int	avtextwriter_context_close (AVTextWriterContext **pwctx)

int	avtextwriter_context_open (AVTextWriterContext *pwctx, const AVTextWriter writer)

const AVTextFormatter *	avtext_get_formatter_by_name (const char *name)

Variables
struct {
double bin_val

double dec_val

char bin_str [4]

char dec_str [4]

}	si_prefixes []

static const AVOption	textcontext_options []

static const AVClass	textcontext_class

static const char	unit_second_str [] = "s"

static const char	unit_hertz_str [] = "Hz"

static const char	unit_byte_str [] = "byte"

static const char	unit_bit_per_second_str [] = "bit/s"

static const AVClass	textwriter_class

static const AVTextFormatter *const	registered_formatters []

Macro Definition Documentation

◆ SECTION_ID_NONE

#define SECTION_ID_NONE (-1)

Definition at line 37 of file avtextformat.c.

◆ SHOW_OPTIONAL_FIELDS_AUTO

#define SHOW_OPTIONAL_FIELDS_AUTO (-1)

Definition at line 39 of file avtextformat.c.

◆ SHOW_OPTIONAL_FIELDS_NEVER

#define SHOW_OPTIONAL_FIELDS_NEVER 0

Definition at line 40 of file avtextformat.c.

◆ SHOW_OPTIONAL_FIELDS_ALWAYS

#define SHOW_OPTIONAL_FIELDS_ALWAYS 1

Definition at line 41 of file avtextformat.c.

◆ OFFSET

#define OFFSET ( x ) offsetof(AVTextFormatContext, x)

Definition at line 63 of file avtextformat.c.

Function Documentation

◆ textcontext_get_formatter_name()

static const char* textcontext_get_formatter_name ( void * p )

static

Definition at line 57 of file avtextformat.c.

◆ textcontext_child_next()

static void* textcontext_child_next	(	void *	obj,
		void *	prev
	)

static

Definition at line 78 of file avtextformat.c.

◆ bprint_bytes()

static void bprint_bytes	(	AVBPrint *	bp,
		const uint8_t *	ubuf,
		size_t	ubuf_size
	)

static

Definition at line 94 of file avtextformat.c.

Referenced by avtext_context_open(), and validate_string().

◆ avtext_context_close()

int avtext_context_close ( AVTextFormatContext ** ptctx )

Definition at line 101 of file avtextformat.c.

Referenced by avtext_context_open(), init_graphprint(), main(), and uninit_graphprint().

◆ avtext_context_open()

int avtext_context_open	(	AVTextFormatContext **	ptctx,
		const AVTextFormatter *	formatter,
		AVTextWriterContext *	writer_context,
		const char *	args,
		const AVTextFormatSection *	sections,
		int	nb_sections,
		AVTextFormatOptions	options,
		char *	show_data_hash
	)

Definition at line 126 of file avtextformat.c.

Referenced by init_graphprint(), and main().

◆ avtext_print_section_header()

void avtext_print_section_header	(	AVTextFormatContext *	tctx,
		const void *	data,
		int	section_id
	)

Definition at line 251 of file avtextformat.c.

Referenced by ffprobe_show_library_versions(), ffprobe_show_pixel_formats(), ffprobe_show_program_version(), main(), print_dispositions(), print_dovi_metadata(), print_film_grain_params(), print_filter(), print_filtergraph(), print_filtergraph_single(), print_filtergraphs_priv(), print_frame_side_data(), print_hwframescontext(), print_iamf_audio_element_params(), print_iamf_mix_presentation_params(), print_iamf_param_definition(), print_iamf_submix_params(), print_pkt_side_data(), print_section_header_id(), print_stream_group_params(), print_streams(), print_tile_grid_params(), probe_file(), show_chapters(), show_error(), show_format(), show_frame(), show_log(), show_packet(), show_program(), show_programs(), show_stream(), show_stream_group(), show_stream_groups(), show_streams(), show_subtitle(), and show_tags().

◆ avtext_print_section_footer()

void avtext_print_section_footer ( AVTextFormatContext * tctx )

◆ avtext_print_integer()

void avtext_print_integer	(	AVTextFormatContext *	tctx,
		const char *	key,
		int64_t	val,
		int	flags
	)

Definition at line 290 of file avtextformat.c.

Referenced by avtext_print_ts().

◆ validate_string()

static int validate_string	(	AVTextFormatContext *	tctx,
		char **	dstp,
		const char *	src
	)

inlinestatic

Definition at line 314 of file avtextformat.c.

Referenced by avtext_print_string().

◆ value_string()

static char* value_string	(	const AVTextFormatContext *	tctx,
		char *	buf,
		int	buf_size,
		struct unit_value	uv
	)

static

Definition at line 380 of file avtextformat.c.

Referenced by avtext_print_time(), and avtext_print_unit_integer().

◆ avtext_print_unit_integer()

void avtext_print_unit_integer	(	AVTextFormatContext *	tctx,
		const char *	key,
		int64_t	val,
		const char *	unit
	)

Definition at line 436 of file avtextformat.c.

◆ avtext_print_string()

int avtext_print_string	(	AVTextFormatContext *	tctx,
		const char *	key,
		const char *	val,
		int	flags
	)

Definition at line 446 of file avtextformat.c.

Referenced by avtext_print_data(), avtext_print_data_hash(), avtext_print_integers(), avtext_print_rational(), avtext_print_time(), avtext_print_ts(), and avtext_print_unit_integer().

◆ avtext_print_rational()

void avtext_print_rational	(	AVTextFormatContext *	tctx,
		const char *	key,
		AVRational	q,
		char	sep
	)

Definition at line 488 of file avtextformat.c.

◆ avtext_print_time()

void avtext_print_time	(	AVTextFormatContext *	tctx,
		const char *	key,
		int64_t	ts,
		const AVRational *	time_base,
		int	is_duration
	)

Definition at line 495 of file avtextformat.c.

◆ avtext_print_ts()

void avtext_print_ts	(	AVTextFormatContext *	tctx,
		const char *	key,
		int64_t	ts,
		int	is_duration
	)

Definition at line 511 of file avtextformat.c.

◆ avtext_print_data()

void avtext_print_data	(	AVTextFormatContext *	tctx,
		const char *	key,
		const uint8_t *	data,
		int	size
	)

Definition at line 519 of file avtextformat.c.

Referenced by print_pkt_side_data(), show_packet(), and show_stream().

◆ avtext_print_data_hash()

void avtext_print_data_hash	(	AVTextFormatContext *	tctx,
		const char *	key,
		const uint8_t *	data,
		int	size
	)

Definition at line 548 of file avtextformat.c.

Referenced by print_pkt_side_data(), show_packet(), and show_stream().

◆ avtext_print_integers()

void avtext_print_integers	(	AVTextFormatContext *	tctx,
		const char *	key,
		uint8_t *	data,
		int	size,
		const char *	format,
		int	columns,
		int	bytes,
		int	offset_add
	)

Definition at line 564 of file avtextformat.c.

Referenced by print_displaymatrix().

◆ writercontext_get_writer_name()

static const char* writercontext_get_writer_name ( void * p )

static

Definition at line 592 of file avtextformat.c.

◆ writercontext_child_next()

static void* writercontext_child_next	(	void *	obj,
		void *	prev
	)

static

Definition at line 598 of file avtextformat.c.

◆ avtextwriter_context_close()

int avtextwriter_context_close ( AVTextWriterContext ** pwctx )

Definition at line 614 of file avtextformat.c.

Referenced by avtextwriter_context_open(), avtextwriter_create_file(), init_graphprint(), main(), and uninit_graphprint().

◆ avtextwriter_context_open()

int avtextwriter_context_open	(	AVTextWriterContext **	pwctx,
		const AVTextWriter *	writer
	)

Definition at line 634 of file avtextformat.c.

Referenced by avtextwriter_create_avio(), avtextwriter_create_buffer(), avtextwriter_create_file(), and avtextwriter_create_stdout().

◆ avtext_get_formatter_by_name()

const AVTextFormatter* avtext_get_formatter_by_name ( const char * name )

Definition at line 692 of file avtextformat.c.

Referenced by init_graphprint(), and main().

Variable Documentation

◆ bin_val

double bin_val

Definition at line 44 of file avtextformat.c.

◆ dec_val

double dec_val

Definition at line 45 of file avtextformat.c.

◆ bin_str

char bin_str[4]

Definition at line 46 of file avtextformat.c.

◆ dec_str

char dec_str[4]

Definition at line 47 of file avtextformat.c.

◆ si_prefixes

const { ... } si_prefixes[]

Initial value:

= {
    { 1.0, 1.0, "", "" },
    { 1.024e3, 1e3, "Ki", "K" },
    { 1.048576e6, 1e6, "Mi", "M" },
    { 1.073741824e9, 1e9, "Gi", "G" },
    { 1.099511627776e12, 1e12, "Ti", "T" },
    { 1.125899906842624e15, 1e15, "Pi", "P" },
}

Referenced by value_string().

◆ textcontext_options

const AVOption textcontext_options[]

static

Initial value:

= {
    { "string_validation", "set string validation mode",
      OFFSET(string_validation), AV_OPT_TYPE_INT, { .i64 = AV_TEXTFORMAT_STRING_VALIDATION_REPLACE }, 0, AV_TEXTFORMAT_STRING_VALIDATION_NB - 1, .unit = "sv" },
    { "sv", "set string validation mode",
      OFFSET(string_validation), AV_OPT_TYPE_INT, { .i64 = AV_TEXTFORMAT_STRING_VALIDATION_REPLACE }, 0, AV_TEXTFORMAT_STRING_VALIDATION_NB - 1, .unit = "sv" },
        { "ignore",  NULL, 0, AV_OPT_TYPE_CONST,  { .i64 = AV_TEXTFORMAT_STRING_VALIDATION_IGNORE },  .unit = "sv" },
        { "replace", NULL, 0, AV_OPT_TYPE_CONST,  { .i64 = AV_TEXTFORMAT_STRING_VALIDATION_REPLACE }, .unit = "sv" },
        { "fail",    NULL, 0, AV_OPT_TYPE_CONST,  { .i64 = AV_TEXTFORMAT_STRING_VALIDATION_FAIL },    .unit = "sv" },
    { "string_validation_replacement", "set string validation replacement string", OFFSET(string_validation_replacement), AV_OPT_TYPE_STRING, { .str = "" } },
    { "svr", "set string validation replacement string", OFFSET(string_validation_replacement), AV_OPT_TYPE_STRING, { .str = "\xEF\xBF\xBD" } },
    { NULL }
}

Definition at line 65 of file avtextformat.c.

◆ textcontext_class

const AVClass textcontext_class

static

Initial value:

= {
    .class_name = "AVTextContext",
    .item_name  = textcontext_get_formatter_name,
    .option     = textcontext_options,
    .version    = LIBAVUTIL_VERSION_INT,
    .child_next = textcontext_child_next,
}

Definition at line 86 of file avtextformat.c.

Referenced by avtext_context_open().

◆ unit_second_str

const char unit_second_str[] = "s"

static

Definition at line 245 of file avtextformat.c.

Referenced by avtext_print_time(), and value_string().

◆ unit_hertz_str

const char unit_hertz_str[] = "Hz"

static

Definition at line 246 of file avtextformat.c.

◆ unit_byte_str

const char unit_byte_str[] = "byte"

static

Definition at line 247 of file avtextformat.c.

Referenced by value_string().

◆ unit_bit_per_second_str

const char unit_bit_per_second_str[] = "bit/s"

static

Definition at line 248 of file avtextformat.c.

◆ textwriter_class

const AVClass textwriter_class

static

Initial value:

= {
    .class_name = "AVTextWriterContext",
    .item_name  = writercontext_get_writer_name,
    .version    = LIBAVUTIL_VERSION_INT,
    .child_next = writercontext_child_next,
}

Definition at line 606 of file avtextformat.c.

Referenced by avtextwriter_context_open().

◆ registered_formatters

const AVTextFormatter* const registered_formatters[]

static

Initial value:

=
{
    &avtextformatter_default,
    &avtextformatter_compact,
    &avtextformatter_csv,
    &avtextformatter_flat,
    &avtextformatter_ini,
    &avtextformatter_json,
    &avtextformatter_xml,
    &avtextformatter_mermaid,
    &avtextformatter_mermaidhtml,
    NULL
}

Definition at line 678 of file avtextformat.c.

Referenced by avtext_get_formatter_by_name().

Data Structures

Macros

Functions

Variables

Macro Definition Documentation

◆ SECTION_ID_NONE

◆ SHOW_OPTIONAL_FIELDS_AUTO

◆ SHOW_OPTIONAL_FIELDS_NEVER

◆ SHOW_OPTIONAL_FIELDS_ALWAYS

◆ OFFSET

Function Documentation

◆ textcontext_get_formatter_name()

◆ textcontext_child_next()

◆ bprint_bytes()

◆ avtext_context_close()

◆ avtext_context_open()

◆ avtext_print_section_header()

◆ avtext_print_section_footer()

◆ avtext_print_integer()

◆ validate_string()

◆ value_string()

◆ avtext_print_unit_integer()

◆ avtext_print_string()

◆ avtext_print_rational()

◆ avtext_print_time()

◆ avtext_print_ts()

◆ avtext_print_data()

◆ avtext_print_data_hash()

◆ avtext_print_integers()

◆ writercontext_get_writer_name()

◆ writercontext_child_next()

◆ avtextwriter_context_close()

◆ avtextwriter_context_open()

◆ avtext_get_formatter_by_name()

Variable Documentation

◆ bin_val

◆ dec_val

◆ bin_str

◆ dec_str

◆ si_prefixes

◆ textcontext_options

◆ textcontext_class

◆ unit_second_str

◆ unit_hertz_str

◆ unit_byte_str

◆ unit_bit_per_second_str

◆ textwriter_class

◆ registered_formatters