FFmpeg
Macros | Functions | Variables
cmdutils.c File Reference
#include <string.h>
#include <stdint.h>
#include <stdlib.h>
#include <errno.h>
#include <math.h>
#include "config.h"
#include "compat/va_copy.h"
#include "libavformat/avformat.h"
#include "libswscale/swscale.h"
#include "libswscale/version.h"
#include "libswresample/swresample.h"
#include "libavutil/avassert.h"
#include "libavutil/avstring.h"
#include "libavutil/channel_layout.h"
#include "libavutil/display.h"
#include "libavutil/mathematics.h"
#include "libavutil/imgutils.h"
#include "libavutil/libm.h"
#include "libavutil/parseutils.h"
#include "libavutil/eval.h"
#include "libavutil/dict.h"
#include "libavutil/opt.h"
#include "cmdutils.h"
#include "opt_common.h"

Go to the source code of this file.

Macros

#define FLAGS   (o->type == AV_OPT_TYPE_FLAGS && (arg[0]=='-' || arg[0]=='+')) ? AV_DICT_APPEND : 0
 
#define GET_ARG(arg)
 

Functions

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...
 
void init_dynload (void)
 Initialize dynamic library loading. More...
 
void register_exit (void(*cb)(int ret))
 Register a program-specific cleanup routine. More...
 
void exit_program (int ret)
 Wraps exit with a program-specific cleanup routine. 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...
 
static const OptionDeffind_option (const OptionDef *po, const char *name)
 
static void prepare_app_arguments (int *argc_ptr, char ***argv_ptr)
 
static int write_option (void *optctx, const OptionDef *po, const char *opt, const char *arg)
 
int parse_option (void *optctx, const char *opt, const char *arg, const OptionDef *options)
 Parse one given option. More...
 
void parse_options (void *optctx, int argc, char **argv, const OptionDef *options, void(*parse_arg_function)(void *, const char *))
 
int parse_optgroup (void *optctx, OptionGroup *g)
 Parse an options group and write results into optctx. 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...
 
static void dump_argument (FILE *report_file, const char *a)
 
static void check_options (const OptionDef *po)
 
void parse_loglevel (int argc, char **argv, const OptionDef *options)
 Find the '-loglevel' option in the command line args and apply it. More...
 
static const AVOptionopt_find (void *obj, const char *name, const char *unit, int opt_flags, int search_flags)
 
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...
 
static int match_group_separator (const OptionGroupDef *groups, int nb_groups, const char *opt)
 
static void finish_group (OptionParseContext *octx, int group_idx, const char *arg)
 
static void add_opt (OptionParseContext *octx, const OptionDef *opt, const char *key, const char *val)
 
static void init_parse_context (OptionParseContext *octx, const OptionGroupDef *groups, int nb_groups)
 
void uninit_parse_context (OptionParseContext *octx)
 Free all allocated memory in an OptionParseContext. 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 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...
 
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...
 
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 * 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 *ptr, 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

AVDictionarysws_dict
 
AVDictionaryswr_opts
 
AVDictionaryformat_opts
 
AVDictionarycodec_opts
 
int hide_banner = 0
 
static void(* program_exit )(int ret)
 

Macro Definition Documentation

◆ FLAGS

#define FLAGS   (o->type == AV_OPT_TYPE_FLAGS && (arg[0]=='-' || arg[0]=='+')) ? AV_DICT_APPEND : 0

Definition at line 504 of file cmdutils.c.

◆ GET_ARG

#define GET_ARG (   arg)
Value:
do { \
arg = argv[optindex++]; \
if (!arg) { \
av_log(NULL, AV_LOG_ERROR, "Missing argument for option '%s'.\n", opt);\
return AVERROR(EINVAL); \
} \
} while (0)

Function Documentation

◆ uninit_opts()

void uninit_opts ( void  )

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

Definition at line 61 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 69 of file cmdutils.c.

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

◆ init_dynload()

void init_dynload ( void  )

Initialize dynamic library loading.

Definition at line 74 of file cmdutils.c.

Referenced by main().

◆ register_exit()

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

Register a program-specific cleanup routine.

Definition at line 85 of file cmdutils.c.

Referenced by main().

◆ exit_program()

void exit_program ( int  ret)

◆ 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 98 of file cmdutils.c.

Referenced by opt_height(), opt_show_mode(), opt_show_optional_fields(), opt_streamid(), opt_vsync(), opt_width(), 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 119 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 131 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 160 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().

◆ find_option()

static const OptionDef* find_option ( const OptionDef po,
const char *  name 
)
static

Definition at line 173 of file cmdutils.c.

Referenced by locate_option(), parse_option(), and split_commandline().

◆ prepare_app_arguments()

static void prepare_app_arguments ( int argc_ptr,
char ***  argv_ptr 
)
inlinestatic

Definition at line 242 of file cmdutils.c.

Referenced by parse_options(), and split_commandline().

◆ write_option()

static int write_option ( void *  optctx,
const OptionDef po,
const char *  opt,
const char *  arg 
)
static

Definition at line 248 of file cmdutils.c.

Referenced by parse_optgroup(), and parse_option().

◆ parse_option()

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

◆ parse_options()

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

Definition at line 342 of file cmdutils.c.

Referenced by main().

◆ 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 373 of file cmdutils.c.

◆ 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 406 of file cmdutils.c.

Referenced by parse_loglevel(), and show_banner().

◆ dump_argument()

static void dump_argument ( FILE *  report_file,
const char *  a 
)
static

Definition at line 432 of file cmdutils.c.

Referenced by parse_loglevel().

◆ check_options()

static void check_options ( const OptionDef po)
static

Definition at line 456 of file cmdutils.c.

Referenced by parse_loglevel().

◆ 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 465 of file cmdutils.c.

Referenced by main().

◆ opt_find()

static const AVOption* opt_find ( void *  obj,
const char *  name,
const char *  unit,
int  opt_flags,
int  search_flags 
)
static

Definition at line 495 of file cmdutils.c.

Referenced by opt_default().

◆ 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 505 of file cmdutils.c.

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

◆ match_group_separator()

static int match_group_separator ( const OptionGroupDef groups,
int  nb_groups,
const char *  opt 
)
static

Definition at line 577 of file cmdutils.c.

Referenced by split_commandline().

◆ finish_group()

static void finish_group ( OptionParseContext octx,
int  group_idx,
const char *  arg 
)
static

Definition at line 597 of file cmdutils.c.

Referenced by split_commandline().

◆ add_opt()

static void add_opt ( OptionParseContext octx,
const OptionDef opt,
const char *  key,
const char *  val 
)
static

Definition at line 625 of file cmdutils.c.

Referenced by split_commandline().

◆ init_parse_context()

static void init_parse_context ( OptionParseContext octx,
const OptionGroupDef groups,
int  nb_groups 
)
static

Definition at line 637 of file cmdutils.c.

Referenced by split_commandline().

◆ uninit_parse_context()

void uninit_parse_context ( OptionParseContext octx)

Free all allocated memory in an OptionParseContext.

Definition at line 657 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 682 of file cmdutils.c.

◆ 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 788 of file cmdutils.c.

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

◆ 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 798 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 809 of file cmdutils.c.

Referenced by opt_preset().

◆ 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 859 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 867 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 925 of file cmdutils.c.

Referenced by open_input_file(), and read_thread().

◆ 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 945 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 964 of file cmdutils.c.

◆ get_rotation()

double get_rotation ( int32_t displaymatrix)

Definition at line 976 of file cmdutils.c.

Referenced by configure_input_video_filter().

Variable Documentation

◆ sws_dict

AVDictionary* sws_dict

Definition at line 55 of file cmdutils.c.

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

◆ swr_opts

AVDictionary* swr_opts

Definition at line 56 of file cmdutils.c.

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

◆ format_opts

AVDictionary* format_opts

◆ codec_opts

AVDictionary * codec_opts

◆ hide_banner

int hide_banner = 0

Definition at line 59 of file cmdutils.c.

Referenced by parse_loglevel(), and show_banner().

◆ program_exit

void(* program_exit) (int ret)
static

Definition at line 83 of file cmdutils.c.

Referenced by exit_program(), and register_exit().

AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
arg
const char * arg
Definition: jacosubdec.c:67
NULL
#define NULL
Definition: coverity.c:32