FFmpeg
cmdutils.h
Go to the documentation of this file.
1 /*
2  * Various utilities for command line tools
3  * copyright (c) 2003 Fabrice Bellard
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 #ifndef FFTOOLS_CMDUTILS_H
23 #define FFTOOLS_CMDUTILS_H
24 
25 #include <stdint.h>
26 
27 #include "config.h"
28 #include "libavcodec/avcodec.h"
29 #include "libavfilter/avfilter.h"
30 #include "libavformat/avformat.h"
31 #include "libswscale/swscale.h"
32 
33 #ifdef _WIN32
34 #undef main /* We don't want SDL to override our main() */
35 #endif
36 
37 /**
38  * program name, defined by the program for show_version().
39  */
40 extern const char program_name[];
41 
42 /**
43  * program birth year, defined by the program for show_banner()
44  */
45 extern const int program_birth_year;
46 
49 extern AVDictionary *sws_dict;
50 extern AVDictionary *swr_opts;
52 extern int hide_banner;
53 extern int cpu_count;
54 
55 /**
56  * Register a program-specific cleanup routine.
57  */
58 void register_exit(void (*cb)(int ret));
59 
60 /**
61  * Wraps exit with a program-specific cleanup routine.
62  */
63 void exit_program(int ret) av_noreturn;
64 
65 /**
66  * Initialize dynamic library loading
67  */
68 void init_dynload(void);
69 
70 /**
71  * Initialize the cmdutils option system, in particular
72  * allocate the *_opts contexts.
73  */
74 void init_opts(void);
75 /**
76  * Uninitialize the cmdutils option system, in particular
77  * free the *_opts contexts and their contents.
78  */
79 void uninit_opts(void);
80 
81 /**
82  * Trivial log callback.
83  * Only suitable for opt_help and similar since it lacks prefix handling.
84  */
85 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
86 
87 /**
88  * Override the cpuflags.
89  */
90 int opt_cpuflags(void *optctx, const char *opt, const char *arg);
91 
92 /**
93  * Override the cpucount.
94  */
95 int opt_cpucount(void *optctx, const char *opt, const char *arg);
96 
97 /**
98  * Fallback for options that are not explicitly handled, these will be
99  * parsed through AVOptions.
100  */
101 int opt_default(void *optctx, const char *opt, const char *arg);
102 
103 /**
104  * Set the libav* libraries log level.
105  */
106 int opt_loglevel(void *optctx, const char *opt, const char *arg);
107 
108 int opt_report(void *optctx, const char *opt, const char *arg);
109 
110 int opt_max_alloc(void *optctx, const char *opt, const char *arg);
111 
112 int opt_codec_debug(void *optctx, const char *opt, const char *arg);
113 
114 /**
115  * Limit the execution time.
116  */
117 int opt_timelimit(void *optctx, const char *opt, const char *arg);
118 
119 /**
120  * Parse a string and return its corresponding value as a double.
121  * Exit from the application if the string cannot be correctly
122  * parsed or the corresponding value is invalid.
123  *
124  * @param context the context of the value to be set (e.g. the
125  * corresponding command line option name)
126  * @param numstr the string to be parsed
127  * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
128  * string should be parsed
129  * @param min the minimum valid accepted value
130  * @param max the maximum valid accepted value
131  */
132 double parse_number_or_die(const char *context, const char *numstr, int type,
133  double min, double max);
134 
135 /**
136  * Parse a string specifying a time and return its corresponding
137  * value as a number of microseconds. Exit from the application if
138  * the string cannot be correctly parsed.
139  *
140  * @param context the context of the value to be set (e.g. the
141  * corresponding command line option name)
142  * @param timestr the string to be parsed
143  * @param is_duration a flag which tells how to interpret timestr, if
144  * not zero timestr is interpreted as a duration, otherwise as a
145  * date
146  *
147  * @see av_parse_time()
148  */
149 int64_t parse_time_or_die(const char *context, const char *timestr,
150  int is_duration);
151 
152 typedef struct SpecifierOpt {
153  char *specifier; /**< stream/chapter/program/... specifier */
154  union {
155  uint8_t *str;
156  int i;
157  int64_t i64;
158  uint64_t ui64;
159  float f;
160  double dbl;
161  } u;
162 } SpecifierOpt;
163 
164 typedef struct OptionDef {
165  const char *name;
166  int flags;
167 #define HAS_ARG 0x0001
168 #define OPT_BOOL 0x0002
169 #define OPT_EXPERT 0x0004
170 #define OPT_STRING 0x0008
171 #define OPT_VIDEO 0x0010
172 #define OPT_AUDIO 0x0020
173 #define OPT_INT 0x0080
174 #define OPT_FLOAT 0x0100
175 #define OPT_SUBTITLE 0x0200
176 #define OPT_INT64 0x0400
177 #define OPT_EXIT 0x0800
178 #define OPT_DATA 0x1000
179 #define OPT_PERFILE 0x2000 /* the option is per-file (currently ffmpeg-only).
180  implied by OPT_OFFSET or OPT_SPEC */
181 #define OPT_OFFSET 0x4000 /* option is specified as an offset in a passed optctx */
182 #define OPT_SPEC 0x8000 /* option is to be stored in an array of SpecifierOpt.
183  Implies OPT_OFFSET. Next element after the offset is
184  an int containing element count in the array. */
185 #define OPT_TIME 0x10000
186 #define OPT_DOUBLE 0x20000
187 #define OPT_INPUT 0x40000
188 #define OPT_OUTPUT 0x80000
189  union {
190  void *dst_ptr;
191  int (*func_arg)(void *, const char *, const char *);
192  size_t off;
193  } u;
194  const char *help;
195  const char *argname;
196 } OptionDef;
197 
198 /**
199  * Print help for all options matching specified flags.
200  *
201  * @param options a list of options
202  * @param msg title of this group. Only printed if at least one option matches.
203  * @param req_flags print only options which have all those flags set.
204  * @param rej_flags don't print options which have any of those flags set.
205  * @param alt_flags print only options that have at least one of those flags set
206  */
207 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
208  int rej_flags, int alt_flags);
209 
210 #if CONFIG_AVDEVICE
211 #define CMDUTILS_COMMON_OPTIONS_AVDEVICE \
212  { "sources" , OPT_EXIT | HAS_ARG, { .func_arg = show_sources }, \
213  "list sources of the input device", "device" }, \
214  { "sinks" , OPT_EXIT | HAS_ARG, { .func_arg = show_sinks }, \
215  "list sinks of the output device", "device" }, \
216 
217 #else
218 #define CMDUTILS_COMMON_OPTIONS_AVDEVICE
219 #endif
220 
221 #define CMDUTILS_COMMON_OPTIONS \
222  { "L", OPT_EXIT, { .func_arg = show_license }, "show license" }, \
223  { "h", OPT_EXIT, { .func_arg = show_help }, "show help", "topic" }, \
224  { "?", OPT_EXIT, { .func_arg = show_help }, "show help", "topic" }, \
225  { "help", OPT_EXIT, { .func_arg = show_help }, "show help", "topic" }, \
226  { "-help", OPT_EXIT, { .func_arg = show_help }, "show help", "topic" }, \
227  { "version", OPT_EXIT, { .func_arg = show_version }, "show version" }, \
228  { "buildconf", OPT_EXIT, { .func_arg = show_buildconf }, "show build configuration" }, \
229  { "formats", OPT_EXIT, { .func_arg = show_formats }, "show available formats" }, \
230  { "muxers", OPT_EXIT, { .func_arg = show_muxers }, "show available muxers" }, \
231  { "demuxers", OPT_EXIT, { .func_arg = show_demuxers }, "show available demuxers" }, \
232  { "devices", OPT_EXIT, { .func_arg = show_devices }, "show available devices" }, \
233  { "codecs", OPT_EXIT, { .func_arg = show_codecs }, "show available codecs" }, \
234  { "decoders", OPT_EXIT, { .func_arg = show_decoders }, "show available decoders" }, \
235  { "encoders", OPT_EXIT, { .func_arg = show_encoders }, "show available encoders" }, \
236  { "bsfs", OPT_EXIT, { .func_arg = show_bsfs }, "show available bit stream filters" }, \
237  { "protocols", OPT_EXIT, { .func_arg = show_protocols }, "show available protocols" }, \
238  { "filters", OPT_EXIT, { .func_arg = show_filters }, "show available filters" }, \
239  { "pix_fmts", OPT_EXIT, { .func_arg = show_pix_fmts }, "show available pixel formats" }, \
240  { "layouts", OPT_EXIT, { .func_arg = show_layouts }, "show standard channel layouts" }, \
241  { "sample_fmts", OPT_EXIT, { .func_arg = show_sample_fmts }, "show available audio sample formats" }, \
242  { "colors", OPT_EXIT, { .func_arg = show_colors }, "show available color names" }, \
243  { "loglevel", HAS_ARG, { .func_arg = opt_loglevel }, "set logging level", "loglevel" }, \
244  { "v", HAS_ARG, { .func_arg = opt_loglevel }, "set logging level", "loglevel" }, \
245  { "report", 0, { .func_arg = opt_report }, "generate a report" }, \
246  { "max_alloc", HAS_ARG, { .func_arg = opt_max_alloc }, "set maximum size of a single allocated block", "bytes" }, \
247  { "cpuflags", HAS_ARG | OPT_EXPERT, { .func_arg = opt_cpuflags }, "force specific cpu flags", "flags" }, \
248  { "cpucount", HAS_ARG | OPT_EXPERT, { .func_arg = opt_cpucount }, "force specific cpu count", "count" }, \
249  { "hide_banner", OPT_BOOL | OPT_EXPERT, {&hide_banner}, "do not show program banner", "hide_banner" }, \
250  CMDUTILS_COMMON_OPTIONS_AVDEVICE \
251 
252 /**
253  * Show help for all options with given flags in class and all its
254  * children.
255  */
256 void show_help_children(const AVClass *class, int flags);
257 
258 /**
259  * Per-fftool specific help handler. Implemented in each
260  * fftool, called by show_help().
261  */
262 void show_help_default(const char *opt, const char *arg);
263 
264 /**
265  * Generic -h handler common to all fftools.
266  */
267 int show_help(void *optctx, const char *opt, const char *arg);
268 
269 /**
270  * Parse the command line arguments.
271  *
272  * @param optctx an opaque options context
273  * @param argc number of command line arguments
274  * @param argv values of command line arguments
275  * @param options Array with the definitions required to interpret every
276  * option of the form: -option_name [argument]
277  * @param parse_arg_function Name of the function called to process every
278  * argument without a leading option name flag. NULL if such arguments do
279  * not have to be processed.
280  */
281 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
282  void (* parse_arg_function)(void *optctx, const char*));
283 
284 /**
285  * Parse one given option.
286  *
287  * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
288  */
289 int parse_option(void *optctx, const char *opt, const char *arg,
290  const OptionDef *options);
291 
292 /**
293  * An option extracted from the commandline.
294  * Cannot use AVDictionary because of options like -map which can be
295  * used multiple times.
296  */
297 typedef struct Option {
298  const OptionDef *opt;
299  const char *key;
300  const char *val;
301 } Option;
302 
303 typedef struct OptionGroupDef {
304  /**< group name */
305  const char *name;
306  /**
307  * Option to be used as group separator. Can be NULL for groups which
308  * are terminated by a non-option argument (e.g. ffmpeg output files)
309  */
310  const char *sep;
311  /**
312  * Option flags that must be set on each option that is
313  * applied to this group
314  */
315  int flags;
317 
318 typedef struct OptionGroup {
320  const char *arg;
321 
323  int nb_opts;
324 
330 } OptionGroup;
331 
332 /**
333  * A list of option groups that all have the same group type
334  * (e.g. input files or output files)
335  */
336 typedef struct OptionGroupList {
338 
342 
343 typedef struct OptionParseContext {
345 
348 
349  /* parsing state */
352 
353 /**
354  * Parse an options group and write results into optctx.
355  *
356  * @param optctx an app-specific options context. NULL for global options group
357  */
358 int parse_optgroup(void *optctx, OptionGroup *g);
359 
360 /**
361  * Split the commandline into an intermediate form convenient for further
362  * processing.
363  *
364  * The commandline is assumed to be composed of options which either belong to a
365  * group (those with OPT_SPEC, OPT_OFFSET or OPT_PERFILE) or are global
366  * (everything else).
367  *
368  * A group (defined by an OptionGroupDef struct) is a sequence of options
369  * terminated by either a group separator option (e.g. -i) or a parameter that
370  * is not an option (doesn't start with -). A group without a separator option
371  * must always be first in the supplied groups list.
372  *
373  * All options within the same group are stored in one OptionGroup struct in an
374  * OptionGroupList, all groups with the same group definition are stored in one
375  * OptionGroupList in OptionParseContext.groups. The order of group lists is the
376  * same as the order of group definitions.
377  */
378 int split_commandline(OptionParseContext *octx, int argc, char *argv[],
379  const OptionDef *options,
380  const OptionGroupDef *groups, int nb_groups);
381 
382 /**
383  * Free all allocated memory in an OptionParseContext.
384  */
386 
387 /**
388  * Find the '-loglevel' option in the command line args and apply it.
389  */
390 void parse_loglevel(int argc, char **argv, const OptionDef *options);
391 
392 /**
393  * Return index of option opt in argv or 0 if not found.
394  */
395 int locate_option(int argc, char **argv, const OptionDef *options,
396  const char *optname);
397 
398 /**
399  * Check if the given stream matches a stream specifier.
400  *
401  * @param s Corresponding format context.
402  * @param st Stream from s to be checked.
403  * @param spec A stream specifier of the [v|a|s|d]:[<stream index>] form.
404  *
405  * @return 1 if the stream matches, 0 if it doesn't, <0 on error
406  */
407 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
408 
409 /**
410  * Filter out options for given codec.
411  *
412  * Create a new options dictionary containing only the options from
413  * opts which apply to the codec with ID codec_id.
414  *
415  * @param opts dictionary to place options in
416  * @param codec_id ID of the codec that should be filtered for
417  * @param s Corresponding format context.
418  * @param st A stream from s for which the options should be filtered.
419  * @param codec The particular codec for which the options should be filtered.
420  * If null, the default one is looked up according to the codec id.
421  * @return a pointer to the created dictionary
422  */
424  AVFormatContext *s, AVStream *st, const AVCodec *codec);
425 
426 /**
427  * Setup AVCodecContext options for avformat_find_stream_info().
428  *
429  * Create an array of dictionaries, one dictionary for each stream
430  * contained in s.
431  * Each dictionary will contain the options from codec_opts which can
432  * be applied to the corresponding stream codec context.
433  *
434  * @return pointer to the created array of dictionaries, NULL if it
435  * cannot be created
436  */
439 
440 /**
441  * Print an error message to stderr, indicating filename and a human
442  * readable description of the error code err.
443  *
444  * If strerror_r() is not available the use of this function in a
445  * multithreaded application may be unsafe.
446  *
447  * @see av_strerror()
448  */
449 void print_error(const char *filename, int err);
450 
451 /**
452  * Print the program banner to stderr. The banner contents depend on the
453  * current version of the repository and of the libav* libraries used by
454  * the program.
455  */
456 void show_banner(int argc, char **argv, const OptionDef *options);
457 
458 /**
459  * Print the version of the program to stdout. The version message
460  * depends on the current versions of the repository and of the libav*
461  * libraries.
462  * This option processing function does not utilize the arguments.
463  */
464 int show_version(void *optctx, const char *opt, const char *arg);
465 
466 /**
467  * Print the build configuration of the program to stdout. The contents
468  * depend on the definition of FFMPEG_CONFIGURATION.
469  * This option processing function does not utilize the arguments.
470  */
471 int show_buildconf(void *optctx, const char *opt, const char *arg);
472 
473 /**
474  * Print the license of the program to stdout. The license depends on
475  * the license of the libraries compiled into the program.
476  * This option processing function does not utilize the arguments.
477  */
478 int show_license(void *optctx, const char *opt, const char *arg);
479 
480 /**
481  * Print a listing containing all the formats supported by the
482  * program (including devices).
483  * This option processing function does not utilize the arguments.
484  */
485 int show_formats(void *optctx, const char *opt, const char *arg);
486 
487 /**
488  * Print a listing containing all the muxers supported by the
489  * program (including devices).
490  * This option processing function does not utilize the arguments.
491  */
492 int show_muxers(void *optctx, const char *opt, const char *arg);
493 
494 /**
495  * Print a listing containing all the demuxer supported by the
496  * program (including devices).
497  * This option processing function does not utilize the arguments.
498  */
499 int show_demuxers(void *optctx, const char *opt, const char *arg);
500 
501 /**
502  * Print a listing containing all the devices supported by the
503  * program.
504  * This option processing function does not utilize the arguments.
505  */
506 int show_devices(void *optctx, const char *opt, const char *arg);
507 
508 #if CONFIG_AVDEVICE
509 /**
510  * Print a listing containing autodetected sinks of the output device.
511  * Device name with options may be passed as an argument to limit results.
512  */
513 int show_sinks(void *optctx, const char *opt, const char *arg);
514 
515 /**
516  * Print a listing containing autodetected sources of the input device.
517  * Device name with options may be passed as an argument to limit results.
518  */
519 int show_sources(void *optctx, const char *opt, const char *arg);
520 #endif
521 
522 /**
523  * Print a listing containing all the codecs supported by the
524  * program.
525  * This option processing function does not utilize the arguments.
526  */
527 int show_codecs(void *optctx, const char *opt, const char *arg);
528 
529 /**
530  * Print a listing containing all the decoders supported by the
531  * program.
532  */
533 int show_decoders(void *optctx, const char *opt, const char *arg);
534 
535 /**
536  * Print a listing containing all the encoders supported by the
537  * program.
538  */
539 int show_encoders(void *optctx, const char *opt, const char *arg);
540 
541 /**
542  * Print a listing containing all the filters supported by the
543  * program.
544  * This option processing function does not utilize the arguments.
545  */
546 int show_filters(void *optctx, const char *opt, const char *arg);
547 
548 /**
549  * Print a listing containing all the bit stream filters supported by the
550  * program.
551  * This option processing function does not utilize the arguments.
552  */
553 int show_bsfs(void *optctx, const char *opt, const char *arg);
554 
555 /**
556  * Print a listing containing all the protocols supported by the
557  * program.
558  * This option processing function does not utilize the arguments.
559  */
560 int show_protocols(void *optctx, const char *opt, const char *arg);
561 
562 /**
563  * Print a listing containing all the pixel formats supported by the
564  * program.
565  * This option processing function does not utilize the arguments.
566  */
567 int show_pix_fmts(void *optctx, const char *opt, const char *arg);
568 
569 /**
570  * Print a listing containing all the standard channel layouts supported by
571  * the program.
572  * This option processing function does not utilize the arguments.
573  */
574 int show_layouts(void *optctx, const char *opt, const char *arg);
575 
576 /**
577  * Print a listing containing all the sample formats supported by the
578  * program.
579  */
580 int show_sample_fmts(void *optctx, const char *opt, const char *arg);
581 
582 /**
583  * Print a listing containing all the color names and values recognized
584  * by the program.
585  */
586 int show_colors(void *optctx, const char *opt, const char *arg);
587 
588 /**
589  * Return a positive value if a line read from standard input
590  * starts with [yY], otherwise return 0.
591  */
592 int read_yesno(void);
593 
594 /**
595  * Get a file corresponding to a preset file.
596  *
597  * If is_path is non-zero, look for the file in the path preset_name.
598  * Otherwise search for a file named arg.ffpreset in the directories
599  * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
600  * at configuration time or in a "ffpresets" folder along the executable
601  * on win32, in that order. If no such file is found and
602  * codec_name is defined, then search for a file named
603  * codec_name-preset_name.avpreset in the above-mentioned directories.
604  *
605  * @param filename buffer where the name of the found filename is written
606  * @param filename_size size in bytes of the filename buffer
607  * @param preset_name name of the preset to search
608  * @param is_path tell if preset_name is a filename path
609  * @param codec_name name of the codec for which to look for the
610  * preset, may be NULL
611  */
612 FILE *get_preset_file(char *filename, size_t filename_size,
613  const char *preset_name, int is_path, const char *codec_name);
614 
615 /**
616  * Realloc array to hold new_size elements of elem_size.
617  * Calls exit() on failure.
618  *
619  * @param array array to reallocate
620  * @param elem_size size in bytes of each element
621  * @param size new element count will be written here
622  * @param new_size number of elements to place in reallocated array
623  * @return reallocated array
624  */
625 void *grow_array(void *array, int elem_size, int *size, int new_size);
626 
627 #define media_type_string av_get_media_type_string
628 
629 #define GROW_ARRAY(array, nb_elems)\
630  array = grow_array(array, sizeof(*array), &nb_elems, nb_elems + 1)
631 
632 #define GET_PIX_FMT_NAME(pix_fmt)\
633  const char *name = av_get_pix_fmt_name(pix_fmt);
634 
635 #define GET_CODEC_NAME(id)\
636  const char *name = avcodec_descriptor_get(id)->name;
637 
638 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
639  const char *name = av_get_sample_fmt_name(sample_fmt)
640 
641 #define GET_SAMPLE_RATE_NAME(rate)\
642  char name[16];\
643  snprintf(name, sizeof(name), "%d", rate);
644 
645 #define GET_CH_LAYOUT_NAME(ch_layout)\
646  char name[16];\
647  snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
648 
649 #define GET_CH_LAYOUT_DESC(ch_layout)\
650  char name[128];\
651  av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
652 
653 double get_rotation(AVStream *st);
654 
655 #endif /* FFTOOLS_CMDUTILS_H */
AVCodec
AVCodec.
Definition: codec.h:197
OptionGroup::group_def
const OptionGroupDef * group_def
Definition: cmdutils.h:316
setup_find_stream_info_opts
AVDictionary ** setup_find_stream_info_opts(AVFormatContext *s, AVDictionary *codec_opts)
Setup AVCodecContext options for avformat_find_stream_info().
Definition: cmdutils.c:2178
show_help_default
void show_help_default(const char *opt, const char *arg)
Per-fftool specific help handler.
Definition: ffmpeg_opt.c:3234
level
uint8_t level
Definition: svq3.c:204
OptionDef::off
size_t off
Definition: cmdutils.h:189
cb
static double cb(void *priv, double x, double y)
Definition: vf_geq.c:215
SpecifierOpt::ui64
uint64_t ui64
Definition: cmdutils.h:158
program_name
const char program_name[]
program name, defined by the program for show_version().
Definition: ffmpeg.c:109
sws_dict
AVDictionary * sws_dict
Definition: cmdutils.c:69
OptionGroupList::groups
OptionGroup * groups
Definition: cmdutils.h:336
OptionDef::dst_ptr
void * dst_ptr
Definition: cmdutils.h:187
OptionGroupList::nb_groups
int nb_groups
Definition: cmdutils.h:337
codec_opts
AVDictionary * codec_opts
Definition: cmdutils.h:51
opt_timelimit
int opt_timelimit(void *optctx, const char *opt, const char *arg)
Limit the execution time.
Definition: cmdutils.c:1089
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.
Definition: cmdutils.c:164
OptionGroup::swr_opts
AVDictionary * swr_opts
Definition: cmdutils.h:326
av_noreturn
#define av_noreturn
Definition: attributes.h:170
max
#define max(a, b)
Definition: cuda_runtime.h:33
AVDictionary
Definition: dict.c:30
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.
Definition: cmdutils.c:2062
OptionDef
Definition: cmdutils.h:164
SpecifierOpt::i
int i
Definition: cmdutils.h:156
OptionGroupList
A list of option groups that all have the same group type (e.g.
Definition: cmdutils.h:333
OptionParseContext
Definition: cmdutils.h:340
cpu_count
int cpu_count
Definition: cmdutils.c:76
Option
An option extracted from the commandline.
Definition: cmdutils.h:294
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.
Definition: cmdutils.c:143
type
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 type
Definition: writing_filters.txt:86
OptionGroup::nb_opts
int nb_opts
Definition: cmdutils.h:320
OptionGroupList::group_def
const OptionGroupDef * group_def
Definition: cmdutils.h:334
OptionDef::help
const char * help
Definition: cmdutils.h:191
show_layouts
int show_layouts(void *optctx, const char *opt, const char *arg)
Print a listing containing all the standard channel layouts supported by the program.
Definition: cmdutils.c:1795
OptionGroupDef
Definition: cmdutils.h:300
avcodec_opts
AVCodecContext * avcodec_opts[AVMEDIA_TYPE_NB]
OptionGroup::codec_opts
AVDictionary * codec_opts
Definition: cmdutils.h:322
OptionGroupDef::flags
int flags
Option flags that must be set on each option that is applied to this group.
Definition: cmdutils.h:312
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.
Definition: cmdutils.c:2198
SpecifierOpt::specifier
char * specifier
stream/chapter/program/...
Definition: cmdutils.h:153
s
#define s(width, name)
Definition: cbs_vp9.c:257
OptionDef::argname
const char * argname
Definition: cmdutils.h:192
uninit_opts
void uninit_opts(void)
Uninitialize the cmdutils option system, in particular free the *_opts contexts and their contents.
Definition: cmdutils.c:89
g
const char * g
Definition: vf_curves.c:117
Option::key
const char * key
Definition: cmdutils.h:296
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 c...
Definition: cmdutils.c:1102
AVMEDIA_TYPE_NB
@ AVMEDIA_TYPE_NB
Definition: avutil.h:206
init_dynload
void init_dynload(void)
Initialize dynamic library loading.
Definition: cmdutils.c:119
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: cmdutils.c:205
parse_options
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.
get_rotation
double get_rotation(AVStream *st)
Definition: cmdutils.c:2217
codec_id
enum AVCodecID codec_id
Definition: vaapi_decode.c:369
arg
const char * arg
Definition: jacosubdec.c:67
OptionGroupDef::name
const char * name
< group name
Definition: cmdutils.h:302
context
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 keep it simple and lowercase description are in without and describe what they for example set the foo of the bar offset is the offset of the field in your context
Definition: writing_filters.txt:91
AVFormatContext
Format I/O context.
Definition: avformat.h:1107
opts
AVDictionary * opts
Definition: movenc.c:50
OptionGroup::format_opts
AVDictionary * format_opts
Definition: cmdutils.h:323
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
OptionParseContext::global_opts
OptionGroup global_opts
Definition: cmdutils.h:341
Option::opt
const OptionDef * opt
Definition: cmdutils.h:295
swr_opts
AVDictionary * swr_opts
Definition: cmdutils.c:70
show_encoders
int show_encoders(void *optctx, const char *opt, const char *arg)
Print a listing containing all the encoders supported by the program.
Definition: cmdutils.c:1668
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.
Definition: cmdutils.c:2120
show_version
int show_version(void *optctx, const char *opt, const char *arg)
Print the version of the program to stdout.
Definition: cmdutils.c:1211
show_pix_fmts
int show_pix_fmts(void *optctx, const char *opt, const char *arg)
Print a listing containing all the pixel formats supported by the program.
Definition: cmdutils.c:1762
OptionGroup::opts
Option * opts
Definition: cmdutils.h:319
OptionGroup
Definition: cmdutils.h:315
parse_optgroup
int parse_optgroup(void *optctx, OptionGroup *g)
Parse an options group and write results into optctx.
Definition: cmdutils.c:412
AVCodecID
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: codec_id.h:47
check_stream_specifier
int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec)
Check if the given stream matches a stream specifier.
Definition: cmdutils.c:2112
read_yesno
int read_yesno(void)
Return a positive value if a line read from standard input starts with [yY], otherwise return 0.
Definition: cmdutils.c:2051
show_license
int show_license(void *optctx, const char *opt, const char *arg)
Print the license of the program to stdout.
Definition: cmdutils.c:1228
options
const OptionDef options[]
opt_codec_debug
int opt_codec_debug(void *optctx, const char *opt, const char *arg)
show_demuxers
int show_demuxers(void *optctx, const char *opt, const char *arg)
Print a listing containing all the demuxer supported by the program (including devices).
Definition: cmdutils.c:1382
opt_cpuflags
int opt_cpuflags(void *optctx, const char *opt, const char *arg)
Override the cpuflags.
Definition: cmdutils.c:847
size
int size
Definition: twinvq_data.h:10344
show_devices
int show_devices(void *optctx, const char *opt, const char *arg)
Print a listing containing all the devices supported by the program.
Definition: cmdutils.c:1387
show_banner
void show_banner(int argc, char **argv, const OptionDef *options)
Print the program banner to stderr.
Definition: cmdutils.c:1200
register_exit
void register_exit(void(*cb)(int ret))
Register a program-specific cleanup routine.
Definition: cmdutils.c:130
uninit_parse_context
void uninit_parse_context(OptionParseContext *octx)
Free all allocated memory in an OptionParseContext.
Definition: cmdutils.c:715
exit_program
void exit_program(int ret) av_noreturn
Wraps exit with a program-specific cleanup routine.
Definition: cmdutils.c:135
show_decoders
int show_decoders(void *optctx, const char *opt, const char *arg)
Print a listing containing all the decoders supported by the program.
Definition: cmdutils.c:1662
opt_loglevel
int opt_loglevel(void *optctx, const char *opt, const char *arg)
Set the libav* libraries log level.
Definition: cmdutils.c:885
opt_max_alloc
int opt_max_alloc(void *optctx, const char *opt, const char *arg)
Definition: cmdutils.c:1075
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: cmdutils.c:504
show_muxers
int show_muxers(void *optctx, const char *opt, const char *arg)
Print a listing containing all the muxers supported by the program (including devices).
Definition: cmdutils.c:1377
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: cmdutils.c:543
format_opts
AVDictionary * format_opts
Definition: cmdutils.c:71
OptionParseContext::groups
OptionGroupList * groups
Definition: cmdutils.h:343
show_protocols
int show_protocols(void *optctx, const char *opt, const char *arg)
Print a listing containing all the protocols supported by the program.
Definition: cmdutils.c:1686
OptionDef::u
union OptionDef::@1 u
avcodec.h
SpecifierOpt::i64
int64_t i64
Definition: cmdutils.h:157
OptionGroup::sws_dict
AVDictionary * sws_dict
Definition: cmdutils.h:325
SpecifierOpt
Definition: cmdutils.h:152
OptionGroup::resample_opts
AVDictionary * resample_opts
Definition: cmdutils.h:324
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.
Definition: cmdutils.c:741
array
static int array[MAX_W *MAX_W]
Definition: jpeg2000dwt.c:106
ret
ret
Definition: filter_design.txt:187
AVStream
Stream structure.
Definition: avformat.h:847
hide_banner
int hide_banner
Definition: cmdutils.c:75
OptionGroup::arg
const char * arg
Definition: cmdutils.h:317
avformat.h
show_help
int show_help(void *optctx, const char *opt, const char *arg)
Generic -h handler common to all fftools.
Definition: cmdutils.c:2013
AVCodecContext
main external API structure.
Definition: avcodec.h:379
SpecifierOpt::str
uint8_t * str
Definition: cmdutils.h:155
show_formats
int show_formats(void *optctx, const char *opt, const char *arg)
Print a listing containing all the formats supported by the program (including devices).
Definition: cmdutils.c:1372
avfilter.h
show_colors
int show_colors(void *optctx, const char *opt, const char *arg)
Print a listing containing all the color names and values recognized by the program.
Definition: cmdutils.c:1748
show_codecs
int show_codecs(void *optctx, const char *opt, const char *arg)
Print a listing containing all the codecs supported by the program.
Definition: cmdutils.c:1567
show_filters
int show_filters(void *optctx, const char *opt, const char *arg)
Print a listing containing all the filters supported by the program.
Definition: cmdutils.c:1701
show_buildconf
int show_buildconf(void *optctx, const char *opt, const char *arg)
Print the build configuration of the program to stdout.
Definition: cmdutils.c:1220
Option::val
const char * val
Definition: cmdutils.h:297
SpecifierOpt::u
union SpecifierOpt::@0 u
OptionDef::name
const char * name
Definition: cmdutils.h:165
show_sample_fmts
int show_sample_fmts(void *optctx, const char *opt, const char *arg)
Print a listing containing all the sample formats supported by the program.
Definition: cmdutils.c:1824
SpecifierOpt::dbl
double dbl
Definition: cmdutils.h:160
init_opts
void init_opts(void)
Initialize the cmdutils option system, in particular allocate the *_opts contexts.
Definition: cmdutils.c:84
OptionGroupDef::sep
const char * sep
Option to be used as group separator.
Definition: cmdutils.h:307
show_bsfs
int show_bsfs(void *optctx, const char *opt, const char *arg)
Print a listing containing all the bit stream filters supported by the program.
Definition: cmdutils.c:1674
log_callback_help
void log_callback_help(void *ptr, int level, const char *fmt, va_list vl)
Trivial log callback.
Definition: cmdutils.c:98
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
opt_report
int opt_report(void *optctx, const char *opt, const char *arg)
Definition: cmdutils.c:1070
OptionParseContext::nb_groups
int nb_groups
Definition: cmdutils.h:344
parse_option
int parse_option(void *optctx, const char *opt, const char *arg, const OptionDef *options)
Parse one given option.
Definition: cmdutils.c:348
resample_opts
AVDictionary * resample_opts
Definition: cmdutils.h:51
avformat_opts
AVFormatContext * avformat_opts
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: cmdutils.c:445
int
int
Definition: ffmpeg_filter.c:156
opt_cpucount
int opt_cpucount(void *optctx, const char *opt, const char *arg)
Override the cpucount.
Definition: cmdutils.c:859
OptionParseContext::cur_group
OptionGroup cur_group
Definition: cmdutils.h:347
SpecifierOpt::f
float f
Definition: cmdutils.h:159
swscale.h
OptionDef::func_arg
int(* func_arg)(void *, const char *, const char *)
Definition: cmdutils.h:188
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.
Definition: cmdutils.c:176
program_birth_year
const int program_birth_year
program birth year, defined by the program for show_banner()
Definition: ffmpeg.c:110
min
float min
Definition: vorbis_enc_data.h:429
OptionDef::flags
int flags
Definition: cmdutils.h:166