FFmpeg
Data Structures | Macros | Functions | Variables
cmdutils.h File Reference
#include <stdint.h>
#include "config.h"
#include "libavcodec/avcodec.h"
#include "libavfilter/avfilter.h"
#include "libavformat/avformat.h"
#include "libswscale/swscale.h"

Go to the source code of this file.

Data Structures

struct  SpecifierOpt
 
struct  OptionDef
 
struct  Option
 An option extracted from the commandline. More...
 
struct  OptionGroupDef
 
struct  OptionGroup
 
struct  OptionGroupList
 A list of option groups that all have the same group type (e.g. More...
 
struct  OptionParseContext
 

Macros

#define HAS_ARG   0x0001
 
#define OPT_BOOL   0x0002
 
#define OPT_EXPERT   0x0004
 
#define OPT_STRING   0x0008
 
#define OPT_VIDEO   0x0010
 
#define OPT_AUDIO   0x0020
 
#define OPT_INT   0x0080
 
#define OPT_FLOAT   0x0100
 
#define OPT_SUBTITLE   0x0200
 
#define OPT_INT64   0x0400
 
#define OPT_EXIT   0x0800
 
#define OPT_DATA   0x1000
 
#define OPT_PERFILE
 
#define OPT_OFFSET   0x4000 /* option is specified as an offset in a passed optctx */
 
#define OPT_SPEC
 
#define OPT_TIME   0x10000
 
#define OPT_DOUBLE   0x20000
 
#define OPT_INPUT   0x40000
 
#define OPT_OUTPUT   0x80000
 
#define GROW_ARRAY(array, nb_elems)   array = grow_array(array, sizeof(*array), &nb_elems, nb_elems + 1)
 
#define ALLOC_ARRAY_ELEM(array, nb_elems)   allocate_array_elem(&array, sizeof(*array[0]), &nb_elems)
 
#define GET_PIX_FMT_NAME(pix_fmt)   const char *name = av_get_pix_fmt_name(pix_fmt);
 
#define GET_CODEC_NAME(id)   const char *name = avcodec_descriptor_get(id)->name;
 
#define GET_SAMPLE_FMT_NAME(sample_fmt)   const char *name = av_get_sample_fmt_name(sample_fmt)
 
#define GET_SAMPLE_RATE_NAME(rate)
 

Functions

void register_exit (void(*cb)(int ret))
 Register a program-specific cleanup routine. More...
 
void exit_program (int ret) av_noreturn
 Wraps exit with a program-specific cleanup routine. More...
 
void init_dynload (void)
 Initialize dynamic library loading. More...
 
void uninit_opts (void)
 Uninitialize the cmdutils option system, in particular free the *_opts contexts and their contents. More...
 
void log_callback_help (void *ptr, int level, const char *fmt, va_list vl)
 Trivial log callback. More...
 
int opt_default (void *optctx, const char *opt, const char *arg)
 Fallback for options that are not explicitly handled, these will be parsed through AVOptions. More...
 
int opt_timelimit (void *optctx, const char *opt, const char *arg)
 Limit the execution time. More...
 
double parse_number_or_die (const char *context, const char *numstr, int type, double min, double max)
 Parse a string and return its corresponding value as a double. More...
 
int64_t parse_time_or_die (const char *context, const char *timestr, int is_duration)
 Parse a string specifying a time and return its corresponding value as a number of microseconds. More...
 
void show_help_options (const OptionDef *options, const char *msg, int req_flags, int rej_flags, int alt_flags)
 Print help for all options matching specified flags. More...
 
void show_help_children (const AVClass *class, int flags)
 Show help for all options with given flags in class and all its children. More...
 
void show_help_default (const char *opt, const char *arg)
 Per-fftool specific help handler. More...
 
void parse_options (void *optctx, int argc, char **argv, const OptionDef *options, void(*parse_arg_function)(void *optctx, const char *))
 Parse the command line arguments. More...
 
int parse_option (void *optctx, const char *opt, const char *arg, const OptionDef *options)
 Parse one given option. More...
 
int parse_optgroup (void *optctx, OptionGroup *g)
 Parse an options group and write results into optctx. More...
 
int split_commandline (OptionParseContext *octx, int argc, char *argv[], const OptionDef *options, const OptionGroupDef *groups, int nb_groups)
 Split the commandline into an intermediate form convenient for further processing. More...
 
void uninit_parse_context (OptionParseContext *octx)
 Free all allocated memory in an OptionParseContext. More...
 
void parse_loglevel (int argc, char **argv, const OptionDef *options)
 Find the '-loglevel' option in the command line args and apply it. More...
 
int locate_option (int argc, char **argv, const OptionDef *options, const char *optname)
 Return index of option opt in argv or 0 if not found. More...
 
int check_stream_specifier (AVFormatContext *s, AVStream *st, const char *spec)
 Check if the given stream matches a stream specifier. More...
 
AVDictionaryfilter_codec_opts (AVDictionary *opts, enum AVCodecID codec_id, AVFormatContext *s, AVStream *st, const AVCodec *codec)
 Filter out options for given codec. More...
 
AVDictionary ** setup_find_stream_info_opts (AVFormatContext *s, AVDictionary *codec_opts)
 Setup AVCodecContext options for avformat_find_stream_info(). More...
 
void print_error (const char *filename, int err)
 Print an error message to stderr, indicating filename and a human readable description of the error code err. More...
 
void show_banner (int argc, char **argv, const OptionDef *options)
 Print the program banner to stderr. More...
 
int read_yesno (void)
 Return a positive value if a line read from standard input starts with [yY], otherwise return 0. More...
 
FILE * get_preset_file (char *filename, size_t filename_size, const char *preset_name, int is_path, const char *codec_name)
 Get a file corresponding to a preset file. More...
 
void * grow_array (void *array, int elem_size, int *size, int new_size)
 Realloc array to hold new_size elements of elem_size. More...
 
void * allocate_array_elem (void *array, size_t elem_size, int *nb_elems)
 Atomically add a new element to an array of pointers, i.e. More...
 
double get_rotation (int32_t *displaymatrix)
 

Variables

const char program_name []
 program name, defined by the program for show_version(). More...
 
const int program_birth_year
 program birth year, defined by the program for show_banner() More...
 
AVDictionarysws_dict
 
AVDictionaryswr_opts
 
AVDictionaryformat_opts
 
AVDictionarycodec_opts
 
int hide_banner
 

Macro Definition Documentation

◆ HAS_ARG

#define HAS_ARG   0x0001

Definition at line 138 of file cmdutils.h.

◆ OPT_BOOL

#define OPT_BOOL   0x0002

Definition at line 139 of file cmdutils.h.

◆ OPT_EXPERT

#define OPT_EXPERT   0x0004

Definition at line 140 of file cmdutils.h.

◆ OPT_STRING

#define OPT_STRING   0x0008

Definition at line 141 of file cmdutils.h.

◆ OPT_VIDEO

#define OPT_VIDEO   0x0010

Definition at line 142 of file cmdutils.h.

◆ OPT_AUDIO

#define OPT_AUDIO   0x0020

Definition at line 143 of file cmdutils.h.

◆ OPT_INT

#define OPT_INT   0x0080

Definition at line 144 of file cmdutils.h.

◆ OPT_FLOAT

#define OPT_FLOAT   0x0100

Definition at line 145 of file cmdutils.h.

◆ OPT_SUBTITLE

#define OPT_SUBTITLE   0x0200

Definition at line 146 of file cmdutils.h.

◆ OPT_INT64

#define OPT_INT64   0x0400

Definition at line 147 of file cmdutils.h.

◆ OPT_EXIT

#define OPT_EXIT   0x0800

Definition at line 148 of file cmdutils.h.

◆ OPT_DATA

#define OPT_DATA   0x1000

Definition at line 149 of file cmdutils.h.

◆ OPT_PERFILE

#define OPT_PERFILE
Value:
0x2000 /* the option is per-file (currently ffmpeg-only).
implied by OPT_OFFSET or OPT_SPEC */

Definition at line 150 of file cmdutils.h.

◆ OPT_OFFSET

#define OPT_OFFSET   0x4000 /* option is specified as an offset in a passed optctx */

Definition at line 151 of file cmdutils.h.

◆ OPT_SPEC

#define OPT_SPEC
Value:
0x8000 /* option is to be stored in an array of SpecifierOpt.
Implies OPT_OFFSET. Next element after the offset is
an int containing element count in the array. */

Definition at line 152 of file cmdutils.h.

◆ OPT_TIME

#define OPT_TIME   0x10000

Definition at line 153 of file cmdutils.h.

◆ OPT_DOUBLE

#define OPT_DOUBLE   0x20000

Definition at line 154 of file cmdutils.h.

◆ OPT_INPUT

#define OPT_INPUT   0x40000

Definition at line 155 of file cmdutils.h.

◆ OPT_OUTPUT

#define OPT_OUTPUT   0x80000

Definition at line 156 of file cmdutils.h.

◆ GROW_ARRAY

#define GROW_ARRAY (   array,
  nb_elems 
)    array = grow_array(array, sizeof(*array), &nb_elems, nb_elems + 1)

Definition at line 431 of file cmdutils.h.

◆ ALLOC_ARRAY_ELEM

#define ALLOC_ARRAY_ELEM (   array,
  nb_elems 
)    allocate_array_elem(&array, sizeof(*array[0]), &nb_elems)

Definition at line 434 of file cmdutils.h.

◆ GET_PIX_FMT_NAME

#define GET_PIX_FMT_NAME (   pix_fmt)    const char *name = av_get_pix_fmt_name(pix_fmt);

Definition at line 437 of file cmdutils.h.

◆ GET_CODEC_NAME

#define GET_CODEC_NAME (   id)    const char *name = avcodec_descriptor_get(id)->name;

Definition at line 440 of file cmdutils.h.

◆ GET_SAMPLE_FMT_NAME

#define GET_SAMPLE_FMT_NAME (   sample_fmt)    const char *name = av_get_sample_fmt_name(sample_fmt)

Definition at line 443 of file cmdutils.h.

◆ GET_SAMPLE_RATE_NAME

#define GET_SAMPLE_RATE_NAME (   rate)
Value:
char name[16];\
snprintf(name, sizeof(name), "%d", rate);

Definition at line 446 of file cmdutils.h.

Function Documentation

◆ register_exit()

void register_exit ( void(*)(int ret cb)

Register a program-specific cleanup routine.

Definition at line 88 of file cmdutils.c.

Referenced by main().

◆ exit_program()

void exit_program ( int  ret)

Wraps exit with a program-specific cleanup routine.

Definition at line 93 of file cmdutils.c.

Referenced by abort_codec_experimental(), add_input_streams(), allocate_array_elem(), assert_avoptions(), assert_file_overwrite(), check_decode_result(), check_filter_outputs(), check_streamcopy_filters(), choose_pix_fmts(), configure_output_filter(), copy_metadata(), describe_filter_link(), do_audio_out(), do_streamcopy(), do_subtitle_out(), do_video_out(), dump_attachment(), filter_codec_opts(), find_codec_or_die(), flush_encoders(), get_codecs_sorted(), get_line(), get_ost_filters(), grow_array(), init_input_filter(), init_output_filter(), init_output_stream(), init_output_stream_streamcopy(), init_output_stream_wrapper(), init_parse_context(), init_report(), init_simple_filtergraph(), main(), new_audio_stream(), new_data_stream(), new_output_stream(), new_subtitle_stream(), new_unknown_stream(), new_video_stream(), of_write_packet(), open_input_file(), open_output_file(), opt_init_hw_device(), opt_input_file(), opt_loglevel(), opt_map(), opt_map_channel(), opt_max_alloc(), opt_output_file(), opt_preset(), opt_streamid(), opt_target(), opt_vstats(), output_packet(), parse_and_set_vsync(), parse_forced_key_frames(), parse_matrix_coeffs(), parse_meta_type(), parse_number_or_die(), parse_options(), parse_time_or_die(), print_sdp(), process_input(), process_input_packet(), set_encoder_id(), setup_find_stream_info_opts(), transcode(), transcode_subtitles(), update_video_stats(), and write_option().

◆ init_dynload()

void init_dynload ( void  )

Initialize dynamic library loading.

Definition at line 77 of file cmdutils.c.

Referenced by main().

◆ uninit_opts()

void uninit_opts ( void  )

Uninitialize the cmdutils option system, in particular free the *_opts contexts and their contents.

Definition at line 64 of file cmdutils.c.

Referenced by do_exit(), ffmpeg_cleanup(), main(), and uninit_parse_context().

◆ log_callback_help()

void log_callback_help ( void *  ptr,
int  level,
const char *  fmt,
va_list  vl 
)

Trivial log callback.

Only suitable for opt_help and similar since it lacks prefix handling.

Definition at line 72 of file cmdutils.c.

Referenced by show_buildconf(), show_help(), show_help_default(), and show_version().

◆ opt_default()

int opt_default ( void *  optctx,
const char *  opt,
const char *  arg 
)

Fallback for options that are not explicitly handled, these will be parsed through AVOptions.

Definition at line 510 of file cmdutils.c.

Referenced by opt_default_new(), opt_target(), parse_option(), and split_commandline().

◆ opt_timelimit()

int opt_timelimit ( void *  optctx,
const char *  opt,
const char *  arg 
)

Limit the execution time.

◆ parse_number_or_die()

double parse_number_or_die ( const char *  context,
const char *  numstr,
int  type,
double  min,
double  max 
)

Parse a string and return its corresponding value as a double.

Exit from the application if the string cannot be correctly parsed or the corresponding value is invalid.

Parameters
contextthe context of the value to be set (e.g. the corresponding command line option name)
numstrthe string to be parsed
typethe type (OPT_INT64 or OPT_FLOAT) as which the string should be parsed
minthe minimum valid accepted value
maxthe maximum valid accepted value

Definition at line 101 of file cmdutils.c.

Referenced by opt_height(), opt_show_mode(), opt_show_optional_fields(), opt_streamid(), opt_width(), parse_and_set_vsync(), and write_option().

◆ parse_time_or_die()

int64_t parse_time_or_die ( const char *  context,
const char *  timestr,
int  is_duration 
)

Parse a string specifying a time and return its corresponding value as a number of microseconds.

Exit from the application if the string cannot be correctly parsed.

Parameters
contextthe context of the value to be set (e.g. the corresponding command line option name)
timestrthe string to be parsed
is_durationa flag which tells how to interpret timestr, if not zero timestr is interpreted as a duration, otherwise as a date
See also
av_parse_time()

Definition at line 122 of file cmdutils.c.

Referenced by opt_duration(), opt_recording_timestamp(), opt_seek(), opt_stats_period(), parse_forced_key_frames(), and write_option().

◆ show_help_options()

void show_help_options ( const OptionDef options,
const char *  msg,
int  req_flags,
int  rej_flags,
int  alt_flags 
)

Print help for all options matching specified flags.

Parameters
optionsa list of options
msgtitle of this group. Only printed if at least one option matches.
req_flagsprint only options which have all those flags set.
rej_flagsdon't print options which have any of those flags set.
alt_flagsprint only options that have at least one of those flags set

Definition at line 134 of file cmdutils.c.

Referenced by show_help_default().

◆ show_help_children()

void show_help_children ( const AVClass class,
int  flags 
)

Show help for all options with given flags in class and all its children.

Definition at line 163 of file cmdutils.c.

Referenced by print_codec(), show_help_bsf(), show_help_children(), show_help_default(), show_help_demuxer(), show_help_muxer(), and show_help_protocol().

◆ show_help_default()

void show_help_default ( const char *  opt,
const char *  arg 
)

Per-fftool specific help handler.

Implemented in each fftool, called by show_help().

Definition at line 3336 of file ffmpeg_opt.c.

Referenced by show_help().

◆ parse_options()

void parse_options ( void *  optctx,
int  argc,
char **  argv,
const OptionDef options,
void(*)(void *optctx, const char *)  parse_arg_function 
)

Parse the command line arguments.

Parameters
optctxan opaque options context
argcnumber of command line arguments
argvvalues of command line arguments
optionsArray with the definitions required to interpret every option of the form: -option_name [argument]
parse_arg_functionName of the function called to process every argument without a leading option name flag. NULL if such arguments do not have to be processed.

◆ parse_option()

int parse_option ( void *  optctx,
const char *  opt,
const char *  arg,
const OptionDef options 
)

◆ parse_optgroup()

int parse_optgroup ( void *  optctx,
OptionGroup g 
)

Parse an options group and write results into optctx.

Parameters
optctxan app-specific options context. NULL for global options group

Definition at line 376 of file cmdutils.c.

◆ split_commandline()

int split_commandline ( OptionParseContext octx,
int  argc,
char *  argv[],
const OptionDef options,
const OptionGroupDef groups,
int  nb_groups 
)

Split the commandline into an intermediate form convenient for further processing.

The commandline is assumed to be composed of options which either belong to a group (those with OPT_SPEC, OPT_OFFSET or OPT_PERFILE) or are global (everything else).

A group (defined by an OptionGroupDef struct) is a sequence of options terminated by either a group separator option (e.g. -i) or a parameter that is not an option (doesn't start with -). A group without a separator option must always be first in the supplied groups list.

All options within the same group are stored in one OptionGroup struct in an OptionGroupList, all groups with the same group definition are stored in one OptionGroupList in OptionParseContext.groups. The order of group lists is the same as the order of group definitions.

Definition at line 687 of file cmdutils.c.

◆ uninit_parse_context()

void uninit_parse_context ( OptionParseContext octx)

Free all allocated memory in an OptionParseContext.

Definition at line 662 of file cmdutils.c.

◆ parse_loglevel()

void parse_loglevel ( int  argc,
char **  argv,
const OptionDef options 
)

Find the '-loglevel' option in the command line args and apply it.

Definition at line 468 of file cmdutils.c.

Referenced by main().

◆ locate_option()

int locate_option ( int  argc,
char **  argv,
const OptionDef options,
const char *  optname 
)

Return index of option opt in argv or 0 if not found.

Definition at line 409 of file cmdutils.c.

Referenced by parse_loglevel(), and show_banner().

◆ check_stream_specifier()

int check_stream_specifier ( AVFormatContext s,
AVStream st,
const char *  spec 
)

Check if the given stream matches a stream specifier.

Parameters
sCorresponding format context.
stStream from s to be checked.
specA stream specifier of the [v|a|s|d]:[<stream index>] form.
Returns
1 if the stream matches, 0 if it doesn't, <0 on error

Definition at line 886 of file cmdutils.c.

Referenced by copy_metadata(), filter_codec_opts(), init_input_filter(), open_input_file(), open_output_file(), and opt_map().

◆ filter_codec_opts()

AVDictionary* filter_codec_opts ( AVDictionary opts,
enum AVCodecID  codec_id,
AVFormatContext s,
AVStream st,
const AVCodec codec 
)

Filter out options for given codec.

Create a new options dictionary containing only the options from opts which apply to the codec with ID codec_id.

Parameters
optsdictionary to place options in
codec_idID of the codec that should be filtered for
sCorresponding format context.
stA stream from s for which the options should be filtered.
codecThe particular codec for which the options should be filtered. If null, the default one is looked up according to the codec id.
Returns
a pointer to the created dictionary

Definition at line 894 of file cmdutils.c.

Referenced by add_input_streams(), new_output_stream(), open_input_file(), setup_find_stream_info_opts(), and stream_component_open().

◆ setup_find_stream_info_opts()

AVDictionary** setup_find_stream_info_opts ( AVFormatContext s,
AVDictionary codec_opts 
)

Setup AVCodecContext options for avformat_find_stream_info().

Create an array of dictionaries, one dictionary for each stream contained in s. Each dictionary will contain the options from codec_opts which can be applied to the corresponding stream codec context.

Returns
pointer to the created array of dictionaries. Calls exit() on failure.

Definition at line 952 of file cmdutils.c.

Referenced by open_input_file(), and read_thread().

◆ print_error()

void print_error ( const char *  filename,
int  err 
)

Print an error message to stderr, indicating filename and a human readable description of the error code err.

If strerror_r() is not available the use of this function in a multithreaded application may be unsafe.

See also
av_strerror()

Definition at line 793 of file cmdutils.c.

Referenced by of_write_packet(), open_input_file(), open_output_file(), process_input(), and read_thread().

◆ show_banner()

void show_banner ( int  argc,
char **  argv,
const OptionDef options 
)

Print the program banner to stderr.

The banner contents depend on the current version of the repository and of the libav* libraries used by the program.

Definition at line 237 of file opt_common.c.

Referenced by main().

◆ read_yesno()

int read_yesno ( void  )

Return a positive value if a line read from standard input starts with [yY], otherwise return 0.

Definition at line 803 of file cmdutils.c.

Referenced by assert_file_overwrite().

◆ get_preset_file()

FILE* get_preset_file ( char *  filename,
size_t  filename_size,
const char *  preset_name,
int  is_path,
const char *  codec_name 
)

Get a file corresponding to a preset file.

If is_path is non-zero, look for the file in the path preset_name. Otherwise search for a file named arg.ffpreset in the directories $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined at configuration time or in a "ffpresets" folder along the executable on win32, in that order. If no such file is found and codec_name is defined, then search for a file named codec_name-preset_name.avpreset in the above-mentioned directories.

Parameters
filenamebuffer where the name of the found filename is written
filename_sizesize in bytes of the filename buffer
preset_namename of the preset to search
is_pathtell if preset_name is a filename path
codec_namename of the codec for which to look for the preset, may be NULL

Definition at line 814 of file cmdutils.c.

Referenced by opt_preset().

◆ grow_array()

void* grow_array ( void *  array,
int  elem_size,
int size,
int  new_size 
)

Realloc array to hold new_size elements of elem_size.

Calls exit() on failure.

Parameters
arrayarray to reallocate
elem_sizesize in bytes of each element
sizenew element count will be written here
new_sizenumber of elements to place in reallocated array
Returns
reallocated array

Definition at line 972 of file cmdutils.c.

Referenced by opt_streamid(), and write_option().

◆ allocate_array_elem()

void* allocate_array_elem ( void *  array,
size_t  elem_size,
int nb_elems 
)

Atomically add a new element to an array of pointers, i.e.

allocate a new entry, reallocate the array of pointers and make the new last member of this array point to the newly allocated buffer. Calls exit() on failure.

Parameters
arrayarray of pointers to reallocate
elem_sizesize of the new element to allocate
nb_elemspointer to the number of elements of the array array; *nb_elems will be incremented by one by this function.
Returns
pointer to the newly allocated entry

Definition at line 991 of file cmdutils.c.

◆ get_rotation()

double get_rotation ( int32_t displaymatrix)

Definition at line 1003 of file cmdutils.c.

Referenced by configure_input_video_filter().

Variable Documentation

◆ program_name

const char program_name[]

program name, defined by the program for show_version().

Definition at line 110 of file ffmpeg.c.

Referenced by expand_filename_template(), init_report(), main(), print_program_info(), show_help_default(), show_license(), show_usage(), and usage().

◆ program_birth_year

const int program_birth_year

program birth year, defined by the program for show_banner()

Definition at line 111 of file ffmpeg.c.

Referenced by ffprobe_show_program_version(), and print_program_info().

◆ sws_dict

AVDictionary* sws_dict

Definition at line 58 of file cmdutils.c.

Referenced by finish_group(), opt_default(), and uninit_opts().

◆ swr_opts

AVDictionary* swr_opts

Definition at line 59 of file cmdutils.c.

Referenced by finish_group(), opt_default(), and uninit_opts().

◆ format_opts

AVDictionary* format_opts

◆ codec_opts

AVDictionary * codec_opts

Definition at line 49 of file cmdutils.h.

◆ hide_banner

int hide_banner

Definition at line 62 of file cmdutils.c.

Referenced by parse_loglevel(), and show_banner().

name
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 just let it vf default minimum maximum flags name is the option name
Definition: writing_filters.txt:88