gpac_help.c File Reference

#include <gpac/filters.h>
#include "gpac.h"
#include <gpac/modules/video_out.h>
#include <gpac/modules/audio_out.h>
#include <gpac/modules/compositor_ext.h>
#include <gpac/modules/hardcoded_proto.h>
#include <gpac/modules/font.h>
#include <gpac/network.h>
#include <gpac/color.h>

Include dependency graph for gpac_help.c:

Data Structures
struct	FilterCategory
struct	__jsenum_info
struct	FMTHandler
struct	PROTOHandler

Macros
#define	SEP_LIST   3
#define	GPAC_DEFER_H   "- defer: print defer mode help\n"
#define	PAD_LEN   30

Functions
void	gpac_filter_help (void)
void	gpac_modules_help (char *mod_name)
void	gpac_alias_help (GF_SysArgMode argmode)
void	gpac_core_help (GF_SysArgMode mode, Bool for_logs)
void	gpac_usage (GF_SysArgMode argmode)
void	gpac_defer_help ()
void	gpac_config_help ()
void	gpac_credentials_help (GF_SysArgMode argmode)
void	gpac_load_suggested_filter_args ()
void	gpac_suggest_arg (char *aname)
Bool	gpac_suggest_filter (char *fname, Bool is_help, Bool filter_only)
static void	gpac_suggest_filter_arg (GF_Config *opts, const char *argname, u32 atype)
void	gpac_check_session_args ()
static void	dump_caps (u32 nb_caps, const GF_FilterCapability *caps)
static void	print_filter_arg (const GF_FilterArgs *a, u32 gen_doc)
static void	print_filter_single_opt (const GF_FilterRegister *reg, char *optname, GF_Filter *filter_inst)
static FilterCategory *	get_filter_class (GF_ClassTypeHint hint)
static void	print_filter (const GF_FilterRegister *reg, GF_SysArgMode argmode, GF_Filter *filter_inst, char *inst_name)
static Bool	strstr_nocase (const char *text, const char *subtext, u32 subtext_len)
static Bool	jsinfo_enum (void *cbck, char *item_name, char *item_path, GF_FileEnumInfo *file_info)
static Bool	jsinfo_dir_enum (void *cbck, char *item_name, char *item_path, GF_FileEnumInfo *file_info)
static void	patch_mkdocs_yml ()
Bool	print_filters (int argc, char **argv, GF_SysArgMode argmode)
void	check_prop_def (char *pname)
void	dump_all_props (char *pname)
void	dump_all_colors (void)
void	dump_all_audio_cicp (void)
void	dump_all_codecs (GF_SysArgMode argmode)
static const char *	get_best_mime (char *ext)
static void	push_ext_mime (GF_List *all_fmts, const char *exts, Bool is_output, const GF_FilterRegister *reg, const char *mime)
void	dump_all_formats (GF_SysArgMode argmode)
void	dump_all_proto_schemes (GF_SysArgMode argmode)
void	write_core_options ()
void	write_file_extensions ()
void	write_filters_options ()
static void	gpac_lang_set_key (GF_Config *cfg, const char *sec_name, const char *key_name, const char *key_val)
int	gpac_make_lang (char *filename)
static GFINLINE void	push_arg (char *_arg, Bool _dup)
static Bool	gpac_expand_alias_arg (char *param, char *prefix, char *suffix, int arg_idx, int argc, char **argv, char *alias_name)
static Bool	check_param_extension (char *szArg, int arg_idx, int argc, char **argv, char *alias_name)
Bool	gpac_expand_alias (int o_argc, char **o_argv)
void	parse_sep_set (const char *arg, Bool *override_seps)

Variables
FILE *	helpout
u32	gen_doc
u32	help_flags
u32	list_filters
GF_FilterSession *	session
char	separator_set [7]
const char *	auto_gen_md_warning
u32	print_filter_info
int	alias_argc
char **	alias_argv
GF_List *	args_used
GF_List *	args_alloc
u32	compositor_mode
GF_List *	filter_classes = NULL
const char *	gpac_doc
const char *	gpac_alias
static GF_GPACArg	gpac_args []
static const char *	gpac_defer
static GF_GPACArg	gpac_defer_args []
static const char *	gpac_config
static const char *	gpac_credentials
static Bool	lang_updated = GF_FALSE

---

Data Structure Documentation

FilterCategory

struct FilterCategory

Data Fields
GF_ClassTypeHint	type
const char *	name
GF_List *	filter_names
GF_List *	filter_descs

__jsenum_info

struct __jsenum_info

Data Fields
GF_FilterSession *	session
GF_SysArgMode	argmode
Bool	print_filter_info
const char *	path
char *	js_dir

FMTHandler

struct FMTHandler

Data Fields
char *	ext
char *	mime
GF_List *	demuxers
GF_List *	muxers
Bool	meta_only

PROTOHandler

struct PROTOHandler

Data Fields
char *	proto
GF_List *	in
GF_List *	out

Macro Definition Documentation

SEP_LIST

#define SEP_LIST   3

GPAC_DEFER_H

#define GPAC_DEFER_H   "- defer: print defer mode help\n"

PAD_LEN

#define PAD_LEN   30

Function Documentation

gpac_filter_help()

void gpac_filter_help

(

void

)

Here is the call graph for this function:

Here is the caller graph for this function:

gpac_modules_help()

void gpac_modules_help

(

char *

mod_name

)

Here is the call graph for this function:

Here is the caller graph for this function:

gpac_alias_help()

void gpac_alias_help

(

GF_SysArgMode

argmode

)

Here is the call graph for this function:

Here is the caller graph for this function:

gpac_core_help()

void gpac_core_help	(	GF_SysArgMode	mode,
		Bool	for_logs
	)

Here is the call graph for this function:

Here is the caller graph for this function:

gpac_usage()

void gpac_usage

(

GF_SysArgMode

argmode

)

Here is the call graph for this function:

Here is the caller graph for this function:

gpac_defer_help()

void gpac_defer_help

(

void

)

Here is the call graph for this function:

Here is the caller graph for this function:

gpac_config_help()

void gpac_config_help

(

void

)

Here is the call graph for this function:

Here is the caller graph for this function:

gpac_credentials_help()

void gpac_credentials_help

(

GF_SysArgMode

argmode

)

Here is the call graph for this function:

Here is the caller graph for this function:

gpac_load_suggested_filter_args()

void gpac_load_suggested_filter_args

(

void

)

Here is the call graph for this function:

Here is the caller graph for this function:

gpac_suggest_arg()

void gpac_suggest_arg

(

char *

aname

)

Here is the call graph for this function:

Here is the caller graph for this function:

gpac_suggest_filter()

Bool gpac_suggest_filter	(	char *	fname,
		Bool	is_help,
		Bool	filter_only
	)

Here is the call graph for this function:

Here is the caller graph for this function:

gpac_suggest_filter_arg()

static void gpac_suggest_filter_arg ( GF_Config *  opts, const char *  argname, u32  atype  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

gpac_check_session_args()

void gpac_check_session_args

(

void

)

Here is the call graph for this function:

dump_caps()

static void dump_caps ( u32  nb_caps, const GF_FilterCapability *  caps  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

print_filter_arg()

static void print_filter_arg ( const GF_FilterArgs *  a, u32  gen_doc  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

print_filter_single_opt()

static void print_filter_single_opt ( const GF_FilterRegister *  reg, char *  optname, GF_Filter *  filter_inst  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

get_filter_class()

static FilterCategory * get_filter_class ( GF_ClassTypeHint  hint )

static

Here is the call graph for this function:

Here is the caller graph for this function:

print_filter()

static void print_filter ( const GF_FilterRegister *  reg, GF_SysArgMode  argmode, GF_Filter *  filter_inst, char *  inst_name  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

strstr_nocase()

static Bool strstr_nocase ( const char *  text, const char *  subtext, u32  subtext_len  )

static

Here is the caller graph for this function:

jsinfo_enum()

static Bool jsinfo_enum ( void *  cbck, char *  item_name, char *  item_path, GF_FileEnumInfo *  file_info  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

jsinfo_dir_enum()

static Bool jsinfo_dir_enum ( void *  cbck, char *  item_name, char *  item_path, GF_FileEnumInfo *  file_info  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

patch_mkdocs_yml()

static void patch_mkdocs_yml ( )

static

Here is the call graph for this function:

Here is the caller graph for this function:

print_filters()

Bool print_filters	(	int	argc,
		char **	argv,
		GF_SysArgMode	argmode
	)

Here is the call graph for this function:

check_prop_def()

void check_prop_def

(

char *

pname

)

Here is the call graph for this function:

Here is the caller graph for this function:

dump_all_props()

void dump_all_props

(

char *

pname

)

Here is the call graph for this function:

Here is the caller graph for this function:

dump_all_colors()

void dump_all_colors

(

void

)

Here is the call graph for this function:

Here is the caller graph for this function:

dump_all_audio_cicp()

void dump_all_audio_cicp

(

void

)

Here is the call graph for this function:

Here is the caller graph for this function:

dump_all_codecs()

void dump_all_codecs

(

GF_SysArgMode

argmode

)

Here is the call graph for this function:

get_best_mime()

static const char * get_best_mime ( char *  ext )

static

Here is the caller graph for this function:

push_ext_mime()

static void push_ext_mime ( GF_List *  all_fmts, const char *  exts, Bool  is_output, const GF_FilterRegister *  reg, const char *  mime  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

dump_all_formats()

void dump_all_formats

(

GF_SysArgMode

argmode

)

Here is the call graph for this function:

dump_all_proto_schemes()

void dump_all_proto_schemes

(

GF_SysArgMode

argmode

)

Here is the call graph for this function:

write_core_options()

void write_core_options

(

void

)

Here is the call graph for this function:

write_file_extensions()

void write_file_extensions

(

void

)

Here is the call graph for this function:

write_filters_options()

void write_filters_options

(

void

)

Here is the call graph for this function:

gpac_lang_set_key()

static void gpac_lang_set_key ( GF_Config *  cfg, const char *  sec_name, const char *  key_name, const char *  key_val  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

gpac_make_lang()

int gpac_make_lang

(

char *

filename

)

Here is the call graph for this function:

Here is the caller graph for this function:

push_arg()

static GFINLINE void push_arg ( char *  _arg, Bool  _dup  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

gpac_expand_alias_arg()

static Bool gpac_expand_alias_arg ( char *  param, char *  prefix, char *  suffix, int  arg_idx, int  argc, char **  argv, char *  alias_name  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

check_param_extension()

static Bool check_param_extension ( char *  szArg, int  arg_idx, int  argc, char **  argv, char *  alias_name  )

static

Here is the call graph for this function:

Here is the caller graph for this function:

gpac_expand_alias()

Bool gpac_expand_alias	(	int	o_argc,
		char **	o_argv
	)

Here is the call graph for this function:

Here is the caller graph for this function:

parse_sep_set()

void parse_sep_set	(	const char *	arg,
		Bool *	override_seps
	)

Here is the caller graph for this function:

Variable Documentation

helpout

FILE* helpout

extern

gen_doc

u32 gen_doc

extern

help_flags

u32 help_flags

extern

list_filters

u32 list_filters

extern

separator_set

char separator_set[7]

extern

auto_gen_md_warning

const char* auto_gen_md_warning

extern

print_filter_info

u32 print_filter_info

extern

alias_argc

int alias_argc

extern

alias_argv

char** alias_argv

extern

args_used

GF_List* args_used

extern

args_alloc

GF_List* args_alloc

extern

compositor_mode

u32 compositor_mode

extern

filter_classes

GF_List* filter_classes = NULL

gpac_doc

const char* gpac_doc

gpac_alias

const char* gpac_alias

gpac_args

GF_GPACArg gpac_args[]

static

gpac_defer

const char* gpac_defer

static

Initial value:

=
{
"# Defer test mode\n"
"This mode can be used to test loading filters one by one and asking for link resolution explicitly.\n"
"This is mostly used to reproduce how sessions are build in more complex applications.\n"
"\n"
"The options `rl`, `pi`, `pl` and `pd` allow addressing a filter by index `F` in a list.\n"
"- if the option is suffixed with an `x` (e.g. `rlx=`), `F=0` means the last filter in the list of filters in the session\n"
"- otherwise, `F=0` means the last filter declared before the option\n"
"\n"
"The relink options `-rl` and `-rlx` always flush the session (run until no more tasks are scheduled).\n"
"The last run can be omitted.\n"
"\n"
"EX gpac -dl -np -i SRC reframer -g -rl -g inspect -g -rl\n"
"This will load SRC and reframer, print the graph (no connection), relink SRC, print the graph (connection to reframer), insert inspect, print the graph (no connection), relink reframer and run. No play event is sent here.\n"
"EX gpac -dl -np -i SRC reframer inspect:deep -g -rl=2 -g -rl -se\n"
"This will load SRC, reframer and inspect, print the graph (no connection), relink SRC, print the graph (connection to reframer), print the graph (no connection), relink reframer, send play and run.\n"
"\n"
"Linking can be done once filters are loaded, using the syntax `@F@SRC` or `@@F@SRC`:\n"
"- `@F` indicates the destination filter using a 0-based index `F` starting from the last laoded filter, e.g. `@0` indicates the last loaded filter.\n"
"- `@@F` indicates the target filter using a 0-based index `F` starting from the first laoded filter, e.g. `@@1` indicates the second loaded filter.\n"
"- `@SRC`or `@@SRC`: same syntax as link directives\n"
"Sources MUST be set before relinking outputs using [-rl]().\n"
"EX gpac -dl -i SRC F1 F2 [...] @1@2 @0@2\n"
"This will set SRC as source to F1 and SRC as source to F2 after loading all filters.\n"
"\n"
"The following options are used in defer mode:\n\n",
}

gpac_defer_args

GF_GPACArg gpac_defer_args[]

static

Initial value:

=
{
        GF_DEF_ARG("dl", NULL, "enable defer linking mode for step-by-step graph building tests", NULL, NULL, GF_ARG_BOOL, GF_ARG_HINT_EXPERT),
        GF_DEF_ARG("np", NULL, "prevent play event from sinks", NULL, NULL, GF_ARG_BOOL, GF_ARG_HINT_EXPERT),
        GF_DEF_ARG("rl[=F]", NULL, "relink outputs of filter `F` (default 1)", NULL, NULL, GF_ARG_STRING, GF_ARG_HINT_EXPERT),
        GF_DEF_ARG("wl[=F]", NULL, "same as `-rl` but does not flush session)", NULL, NULL, GF_ARG_STRING, GF_ARG_HINT_EXPERT),
        GF_DEF_ARG("pi=[+|-][F[:i]]", NULL, "print PID properties (all or of index `i`) of filter `F` (default 0)\n"
        "- if prefixed with `-`: only list PIDs\n"
        "- if prefixed with `+`: also print PID info", NULL, NULL, GF_ARG_STRING, GF_ARG_HINT_EXPERT),
        GF_DEF_ARG("pl=[+][F[:i]]@NAME", NULL, "probe filter chain from filter `F` (default 0) to the given filter `NAME`:\n"
                "- if prefixed with `+`: print all known chains and their priorities", NULL, NULL, GF_ARG_STRING, GF_ARG_HINT_EXPERT),
        GF_DEF_ARG("pd=[F[:i]]", NULL, "print possible PID destinations (all or of index `i`) of filter `F` (default 0)", NULL, NULL, GF_ARG_STRING, GF_ARG_HINT_EXPERT),
        GF_DEF_ARG("f", NULL, "flush session until no more tasks", NULL, NULL, GF_ARG_BOOL, GF_ARG_HINT_EXPERT),
        GF_DEF_ARG("g", NULL, "print graph", NULL, NULL, GF_ARG_BOOL, GF_ARG_HINT_EXPERT),
        GF_DEF_ARG("s", NULL, "print stats", NULL, NULL, GF_ARG_BOOL, GF_ARG_HINT_EXPERT),
        GF_DEF_ARG("se", NULL, "send PLAY event from sinks (only done once)", NULL, NULL, GF_ARG_BOOL, GF_ARG_HINT_EXPERT),
        GF_DEF_ARG("m", NULL, "print message", NULL, NULL, GF_ARG_STRING, GF_ARG_HINT_EXPERT),
        {0}
}

gpac_config

const char* gpac_config

static

gpac_credentials

const char* gpac_credentials

static

lang_updated

Bool lang_updated = GF_FALSE

static