git.sesse.net Git - ffmpeg/blob - cmdutils.h

   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 FFMPEG_CMDUTILS_H
  23 #define FFMPEG_CMDUTILS_H
  24
  25 #include <stdint.h>
  26
  27 #include "libavcodec/avcodec.h"
  28 #include "libavfilter/avfilter.h"
  29 #include "libavformat/avformat.h"
  30 #include "libswscale/swscale.h"
  31
  32 #ifdef __MINGW32__
  33 #undef main /* We don't want SDL to override our main() */
  34 #endif
  35
  36 /**
  37  * program name, defined by the program for show_version().
  38  */
  39 extern const char program_name[];
  40
  41 /**
  42  * program birth year, defined by the program for show_banner()
  43  */
  44 extern const int program_birth_year;
  45
  46 extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
  47 extern AVFormatContext *avformat_opts;
  48 extern struct SwsContext *sws_opts;
  49 extern AVDictionary *swr_opts;
  50 extern AVDictionary *format_opts, *codec_opts, *resample_opts;
  51
  52 /**
  53  * Register a program-specific cleanup routine.
  54  */
  55 void register_exit(void (*cb)(int ret));
  56
  57 /**
  58  * Wraps exit with a program-specific cleanup routine.
  59  */
  60 void exit_program(int ret);
  61
  62 /**
  63  * Initialize the cmdutils option system, in particular
  64  * allocate the *_opts contexts.
  65  */
  66 void init_opts(void);
  67 /**
  68  * Uninitialize the cmdutils option system, in particular
  69  * free the *_opts contexts and their contents.
  70  */
  71 void uninit_opts(void);
  72
  73 /**
  74  * Trivial log callback.
  75  * Only suitable for opt_help and similar since it lacks prefix handling.
  76  */
  77 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
  78
  79 /**
  80  * Override the cpuflags.
  81  */
  82 int opt_cpuflags(void *optctx, const char *opt, const char *arg);
  83
  84 /**
  85  * Fallback for options that are not explicitly handled, these will be
  86  * parsed through AVOptions.
  87  */
  88 int opt_default(void *optctx, const char *opt, const char *arg);
  89
  90 /**
  91  * Set the libav* libraries log level.
  92  */
  93 int opt_loglevel(void *optctx, const char *opt, const char *arg);
  94
  95 int opt_report(const char *opt);
  96
  97 int opt_max_alloc(void *optctx, const char *opt, const char *arg);
  98
  99 int opt_codec_debug(void *optctx, const char *opt, const char *arg);
 100
 101 #if CONFIG_OPENCL
 102 int opt_opencl(void *optctx, const char *opt, const char *arg);
 103
 104 int opt_opencl_bench(void *optctx, const char *opt, const char *arg);
 105 #endif
 106
 107 /**
 108  * Limit the execution time.
 109  */
 110 int opt_timelimit(void *optctx, const char *opt, const char *arg);
 111
 112 /**
 113  * Parse a string and return its corresponding value as a double.
 114  * Exit from the application if the string cannot be correctly
 115  * parsed or the corresponding value is invalid.
 116  *
 117  * @param context the context of the value to be set (e.g. the
 118  * corresponding command line option name)
 119  * @param numstr the string to be parsed
 120  * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
 121  * string should be parsed
 122  * @param min the minimum valid accepted value
 123  * @param max the maximum valid accepted value
 124  */
 125 double parse_number_or_die(const char *context, const char *numstr, int type,
 126                            double min, double max);
 127
 128 /**
 129  * Parse a string specifying a time and return its corresponding
 130  * value as a number of microseconds. Exit from the application if
 131  * the string cannot be correctly parsed.
 132  *
 133  * @param context the context of the value to be set (e.g. the
 134  * corresponding command line option name)
 135  * @param timestr the string to be parsed
 136  * @param is_duration a flag which tells how to interpret timestr, if
 137  * not zero timestr is interpreted as a duration, otherwise as a
 138  * date
 139  *
 140  * @see av_parse_time()
 141  */
 142 int64_t parse_time_or_die(const char *context, const char *timestr,
 143                           int is_duration);
 144
 145 typedef struct SpecifierOpt {
 146     char *specifier;    /**< stream/chapter/program/... specifier */
 147     union {
 148         uint8_t *str;
 149         int        i;
 150         int64_t  i64;
 151         float      f;
 152         double   dbl;
 153     } u;
 154 } SpecifierOpt;
 155
 156 typedef struct OptionDef {
 157     const char *name;
 158     int flags;
 159 #define HAS_ARG    0x0001
 160 #define OPT_BOOL   0x0002
 161 #define OPT_EXPERT 0x0004
 162 #define OPT_STRING 0x0008
 163 #define OPT_VIDEO  0x0010
 164 #define OPT_AUDIO  0x0020
 165 #define OPT_INT    0x0080
 166 #define OPT_FLOAT  0x0100
 167 #define OPT_SUBTITLE 0x0200
 168 #define OPT_INT64  0x0400
 169 #define OPT_EXIT   0x0800
 170 #define OPT_DATA   0x1000
 171 #define OPT_PERFILE  0x2000     /* the option is per-file (currently ffmpeg-only).
 172                                    implied by OPT_OFFSET or OPT_SPEC */
 173 #define OPT_OFFSET 0x4000       /* option is specified as an offset in a passed optctx */
 174 #define OPT_SPEC   0x8000       /* option is to be stored in an array of SpecifierOpt.
 175                                    Implies OPT_OFFSET. Next element after the offset is
 176                                    an int containing element count in the array. */
 177 #define OPT_TIME  0x10000
 178 #define OPT_DOUBLE 0x20000
 179 #define OPT_INPUT  0x40000
 180 #define OPT_OUTPUT 0x80000
 181      union {
 182         void *dst_ptr;
 183         int (*func_arg)(void *, const char *, const char *);
 184         size_t off;
 185     } u;
 186     const char *help;
 187     const char *argname;
 188 } OptionDef;
 189
 190 /**
 191  * Print help for all options matching specified flags.
 192  *
 193  * @param options a list of options
 194  * @param msg title of this group. Only printed if at least one option matches.
 195  * @param req_flags print only options which have all those flags set.
 196  * @param rej_flags don't print options which have any of those flags set.
 197  * @param alt_flags print only options that have at least one of those flags set
 198  */
 199 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
 200                        int rej_flags, int alt_flags);
 201
 202 /**
 203  * Show help for all options with given flags in class and all its
 204  * children.
 205  */
 206 void show_help_children(const AVClass *class, int flags);
 207
 208 /**
 209  * Per-fftool specific help handler. Implemented in each
 210  * fftool, called by show_help().
 211  */
 212 void show_help_default(const char *opt, const char *arg);
 213
 214 /**
 215  * Generic -h handler common to all fftools.
 216  */
 217 int show_help(void *optctx, const char *opt, const char *arg);
 218
 219 /**
 220  * Parse the command line arguments.
 221  *
 222  * @param optctx an opaque options context
 223  * @param argc   number of command line arguments
 224  * @param argv   values of command line arguments
 225  * @param options Array with the definitions required to interpret every
 226  * option of the form: -option_name [argument]
 227  * @param parse_arg_function Name of the function called to process every
 228  * argument without a leading option name flag. NULL if such arguments do
 229  * not have to be processed.
 230  */
 231 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
 232                    void (* parse_arg_function)(void *optctx, const char*));
 233
 234 /**
 235  * Parse one given option.
 236  *
 237  * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
 238  */
 239 int parse_option(void *optctx, const char *opt, const char *arg,
 240                  const OptionDef *options);
 241
 242 /**
 243  * An option extracted from the commandline.
 244  * Cannot use AVDictionary because of options like -map which can be
 245  * used multiple times.
 246  */
 247 typedef struct Option {
 248     const OptionDef  *opt;
 249     const char       *key;
 250     const char       *val;
 251 } Option;
 252
 253 typedef struct OptionGroupDef {
 254     /**< group name */
 255     const char *name;
 256     /**
 257      * Option to be used as group separator. Can be NULL for groups which
 258      * are terminated by a non-option argument (e.g. ffmpeg output files)
 259      */
 260     const char *sep;
 261     /**
 262      * Option flags that must be set on each option that is
 263      * applied to this group
 264      */
 265     int flags;
 266 } OptionGroupDef;
 267
 268 typedef struct OptionGroup {
 269     const OptionGroupDef *group_def;
 270     const char *arg;
 271
 272     Option *opts;
 273     int  nb_opts;
 274
 275     AVDictionary *codec_opts;
 276     AVDictionary *format_opts;
 277     AVDictionary *resample_opts;
 278     struct SwsContext *sws_opts;
 279     AVDictionary *swr_opts;
 280 } OptionGroup;
 281
 282 /**
 283  * A list of option groups that all have the same group type
 284  * (e.g. input files or output files)
 285  */
 286 typedef struct OptionGroupList {
 287     const OptionGroupDef *group_def;
 288
 289     OptionGroup *groups;
 290     int       nb_groups;
 291 } OptionGroupList;
 292
 293 typedef struct OptionParseContext {
 294     OptionGroup global_opts;
 295
 296     OptionGroupList *groups;
 297     int           nb_groups;
 298
 299     /* parsing state */
 300     OptionGroup cur_group;
 301 } OptionParseContext;
 302
 303 /**
 304  * Parse an options group and write results into optctx.
 305  *
 306  * @param optctx an app-specific options context. NULL for global options group
 307  */
 308 int parse_optgroup(void *optctx, OptionGroup *g);
 309
 310 /**
 311  * Split the commandline into an intermediate form convenient for further
 312  * processing.
 313  *
 314  * The commandline is assumed to be composed of options which either belong to a
 315  * group (those with OPT_SPEC, OPT_OFFSET or OPT_PERFILE) or are global
 316  * (everything else).
 317  *
 318  * A group (defined by an OptionGroupDef struct) is a sequence of options
 319  * terminated by either a group separator option (e.g. -i) or a parameter that
 320  * is not an option (doesn't start with -). A group without a separator option
 321  * must always be first in the supplied groups list.
 322  *
 323  * All options within the same group are stored in one OptionGroup struct in an
 324  * OptionGroupList, all groups with the same group definition are stored in one
 325  * OptionGroupList in OptionParseContext.groups. The order of group lists is the
 326  * same as the order of group definitions.
 327  */
 328 int split_commandline(OptionParseContext *octx, int argc, char *argv[],
 329                       const OptionDef *options,
 330                       const OptionGroupDef *groups, int nb_groups);
 331
 332 /**
 333  * Free all allocated memory in an OptionParseContext.
 334  */
 335 void uninit_parse_context(OptionParseContext *octx);
 336
 337 /**
 338  * Find the '-loglevel' option in the command line args and apply it.
 339  */
 340 void parse_loglevel(int argc, char **argv, const OptionDef *options);
 341
 342 /**
 343  * Return index of option opt in argv or 0 if not found.
 344  */
 345 int locate_option(int argc, char **argv, const OptionDef *options,
 346                   const char *optname);
 347
 348 /**
 349  * Check if the given stream matches a stream specifier.
 350  *
 351  * @param s  Corresponding format context.
 352  * @param st Stream from s to be checked.
 353  * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
 354  *
 355  * @return 1 if the stream matches, 0 if it doesn't, <0 on error
 356  */
 357 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
 358
 359 /**
 360  * Filter out options for given codec.
 361  *
 362  * Create a new options dictionary containing only the options from
 363  * opts which apply to the codec with ID codec_id.
 364  *
 365  * @param opts     dictionary to place options in
 366  * @param codec_id ID of the codec that should be filtered for
 367  * @param s Corresponding format context.
 368  * @param st A stream from s for which the options should be filtered.
 369  * @param codec The particular codec for which the options should be filtered.
 370  *              If null, the default one is looked up according to the codec id.
 371  * @return a pointer to the created dictionary
 372  */
 373 AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
 374                                 AVFormatContext *s, AVStream *st, AVCodec *codec);
 375
 376 /**
 377  * Setup AVCodecContext options for avformat_find_stream_info().
 378  *
 379  * Create an array of dictionaries, one dictionary for each stream
 380  * contained in s.
 381  * Each dictionary will contain the options from codec_opts which can
 382  * be applied to the corresponding stream codec context.
 383  *
 384  * @return pointer to the created array of dictionaries, NULL if it
 385  * cannot be created
 386  */
 387 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
 388                                            AVDictionary *codec_opts);
 389
 390 /**
 391  * Print an error message to stderr, indicating filename and a human
 392  * readable description of the error code err.
 393  *
 394  * If strerror_r() is not available the use of this function in a
 395  * multithreaded application may be unsafe.
 396  *
 397  * @see av_strerror()
 398  */
 399 void print_error(const char *filename, int err);
 400
 401 /**
 402  * Print the program banner to stderr. The banner contents depend on the
 403  * current version of the repository and of the libav* libraries used by
 404  * the program.
 405  */
 406 void show_banner(int argc, char **argv, const OptionDef *options);
 407
 408 /**
 409  * Print the version of the program to stdout. The version message
 410  * depends on the current versions of the repository and of the libav*
 411  * libraries.
 412  * This option processing function does not utilize the arguments.
 413  */
 414 int show_version(void *optctx, const char *opt, const char *arg);
 415
 416 /**
 417  * Print the build configuration of the program to stdout. The contents
 418  * depend on the definition of FFMPEG_CONFIGURATION.
 419  * This option processing function does not utilize the arguments.
 420  */
 421 int show_buildconf(void *optctx, const char *opt, const char *arg);
 422
 423 /**
 424  * Print the license of the program to stdout. The license depends on
 425  * the license of the libraries compiled into the program.
 426  * This option processing function does not utilize the arguments.
 427  */
 428 int show_license(void *optctx, const char *opt, const char *arg);
 429
 430 /**
 431  * Print a listing containing all the formats supported by the
 432  * program.
 433  * This option processing function does not utilize the arguments.
 434  */
 435 int show_formats(void *optctx, const char *opt, const char *arg);
 436
 437 /**
 438  * Print a listing containing all the codecs supported by the
 439  * program.
 440  * This option processing function does not utilize the arguments.
 441  */
 442 int show_codecs(void *optctx, const char *opt, const char *arg);
 443
 444 /**
 445  * Print a listing containing all the decoders supported by the
 446  * program.
 447  */
 448 int show_decoders(void *optctx, const char *opt, const char *arg);
 449
 450 /**
 451  * Print a listing containing all the encoders supported by the
 452  * program.
 453  */
 454 int show_encoders(void *optctx, const char *opt, const char *arg);
 455
 456 /**
 457  * Print a listing containing all the filters supported by the
 458  * program.
 459  * This option processing function does not utilize the arguments.
 460  */
 461 int show_filters(void *optctx, const char *opt, const char *arg);
 462
 463 /**
 464  * Print a listing containing all the bit stream filters supported by the
 465  * program.
 466  * This option processing function does not utilize the arguments.
 467  */
 468 int show_bsfs(void *optctx, const char *opt, const char *arg);
 469
 470 /**
 471  * Print a listing containing all the protocols supported by the
 472  * program.
 473  * This option processing function does not utilize the arguments.
 474  */
 475 int show_protocols(void *optctx, const char *opt, const char *arg);
 476
 477 /**
 478  * Print a listing containing all the pixel formats supported by the
 479  * program.
 480  * This option processing function does not utilize the arguments.
 481  */
 482 int show_pix_fmts(void *optctx, const char *opt, const char *arg);
 483
 484 /**
 485  * Print a listing containing all the standard channel layouts supported by
 486  * the program.
 487  * This option processing function does not utilize the arguments.
 488  */
 489 int show_layouts(void *optctx, const char *opt, const char *arg);
 490
 491 /**
 492  * Print a listing containing all the sample formats supported by the
 493  * program.
 494  */
 495 int show_sample_fmts(void *optctx, const char *opt, const char *arg);
 496
 497 /**
 498  * Print a listing containing all the color names and values recognized
 499  * by the program.
 500  */
 501 int show_colors(void *optctx, const char *opt, const char *arg);
 502
 503 /**
 504  * Return a positive value if a line read from standard input
 505  * starts with [yY], otherwise return 0.
 506  */
 507 int read_yesno(void);
 508
 509 /**
 510  * Read the file with name filename, and put its content in a newly
 511  * allocated 0-terminated buffer.
 512  *
 513  * @param filename file to read from
 514  * @param bufptr location where pointer to buffer is returned
 515  * @param size   location where size of buffer is returned
 516  * @return >= 0 in case of success, a negative value corresponding to an
 517  * AVERROR error code in case of failure.
 518  */
 519 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
 520
 521 /**
 522  * Get a file corresponding to a preset file.
 523  *
 524  * If is_path is non-zero, look for the file in the path preset_name.
 525  * Otherwise search for a file named arg.ffpreset in the directories
 526  * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
 527  * at configuration time or in a "ffpresets" folder along the executable
 528  * on win32, in that order. If no such file is found and
 529  * codec_name is defined, then search for a file named
 530  * codec_name-preset_name.avpreset in the above-mentioned directories.
 531  *
 532  * @param filename buffer where the name of the found filename is written
 533  * @param filename_size size in bytes of the filename buffer
 534  * @param preset_name name of the preset to search
 535  * @param is_path tell if preset_name is a filename path
 536  * @param codec_name name of the codec for which to look for the
 537  * preset, may be NULL
 538  */
 539 FILE *get_preset_file(char *filename, size_t filename_size,
 540                       const char *preset_name, int is_path, const char *codec_name);
 541
 542 /**
 543  * Realloc array to hold new_size elements of elem_size.
 544  * Calls exit() on failure.
 545  *
 546  * @param array array to reallocate
 547  * @param elem_size size in bytes of each element
 548  * @param size new element count will be written here
 549  * @param new_size number of elements to place in reallocated array
 550  * @return reallocated array
 551  */
 552 void *grow_array(void *array, int elem_size, int *size, int new_size);
 553
 554 #define media_type_string av_get_media_type_string
 555
 556 #define GROW_ARRAY(array, nb_elems)\
 557     array = grow_array(array, sizeof(*array), &nb_elems, nb_elems + 1)
 558
 559 #define GET_PIX_FMT_NAME(pix_fmt)\
 560     const char *name = av_get_pix_fmt_name(pix_fmt);
 561
 562 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
 563     const char *name = av_get_sample_fmt_name(sample_fmt)
 564
 565 #define GET_SAMPLE_RATE_NAME(rate)\
 566     char name[16];\
 567     snprintf(name, sizeof(name), "%d", rate);
 568
 569 #define GET_CH_LAYOUT_NAME(ch_layout)\
 570     char name[16];\
 571     snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
 572
 573 #define GET_CH_LAYOUT_DESC(ch_layout)\
 574     char name[128];\
 575     av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
 576
 577 #endif /* CMDUTILS_H */