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 <inttypes.h>
  26 #include "libavcodec/avcodec.h"
  27 #include "libavformat/avformat.h"
  28 #include "libswscale/swscale.h"
  29
  30 /**
  31  * program name, defined by the program for show_version().
  32  */
  33 extern const char program_name[];
  34
  35 /**
  36  * program birth year, defined by the program for show_banner()
  37  */
  38 extern const int program_birth_year;
  39
  40 extern const int this_year;
  41
  42 extern const char **opt_names;
  43 extern AVCodecContext *avcodec_opts[CODEC_TYPE_NB];
  44 extern AVFormatContext *avformat_opts;
  45 extern struct SwsContext *sws_opts;
  46
  47 /**
  48  * Fallback for options that are not explicitly handled, these will be
  49  * parsed through AVOptions.
  50  */
  51 int opt_default(const char *opt, const char *arg);
  52
  53 /**
  54  * Parses a string and returns its corresponding value as a double.
  55  * Exits from the application if the string cannot be correctly
  56  * parsed or the corresponding value is invalid.
  57  *
  58  * @param context the context of the value to be set (e.g. the
  59  * corresponding commandline option name)
  60  * @param numstr the string to be parsed
  61  * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
  62  * string should be parsed
  63  * @param min the minimum valid accepted value
  64  * @param max the maximum valid accepted value
  65  */
  66 double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
  67
  68 /**
  69  * Parses a string specifying a time and returns its corresponding
  70  * value as a number of microseconds. Exits from the application if
  71  * the string cannot be correctly parsed.
  72  *
  73  * @param context the context of the value to be set (e.g. the
  74  * corresponding commandline option name)
  75  * @param timestr the string to be parsed
  76  * @param is_duration a flag which tells how to interpret \p timestr, if
  77  * not zero \p timestr is interpreted as a duration, otherwise as a
  78  * date
  79  *
  80  * @see parse_date()
  81  */
  82 int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
  83
  84 typedef struct {
  85     const char *name;
  86     int flags;
  87 #define HAS_ARG    0x0001
  88 #define OPT_BOOL   0x0002
  89 #define OPT_EXPERT 0x0004
  90 #define OPT_STRING 0x0008
  91 #define OPT_VIDEO  0x0010
  92 #define OPT_AUDIO  0x0020
  93 #define OPT_GRAB   0x0040
  94 #define OPT_INT    0x0080
  95 #define OPT_FLOAT  0x0100
  96 #define OPT_SUBTITLE 0x0200
  97 #define OPT_FUNC2  0x0400
  98 #define OPT_INT64  0x0800
  99 #define OPT_EXIT   0x1000
 100      union {
 101         void (*func_arg)(const char *); //FIXME passing error code as int return would be nicer then exit() in the func
 102         int *int_arg;
 103         char **str_arg;
 104         float *float_arg;
 105         int (*func2_arg)(const char *, const char *);
 106         int64_t *int64_arg;
 107     } u;
 108     const char *help;
 109     const char *argname;
 110 } OptionDef;
 111
 112 void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
 113
 114 /**
 115  * Parses the command line arguments.
 116  * @param options Array with the definitions required to interpret every
 117  * option of the form: -<option_name> [<argument>]
 118  * @param parse_arg_function Name of the function called to process every
 119  * argument without a leading option name flag. NULL if such arguments do
 120  * not have to be processed.
 121  */
 122 void parse_options(int argc, char **argv, const OptionDef *options,
 123                    void (* parse_arg_function)(const char*));
 124
 125 void set_context_opts(void *ctx, void *opts_ctx, int flags);
 126
 127 void print_error(const char *filename, int err);
 128
 129 /**
 130  * Prints the program banner to stderr. The banner contents depend on the
 131  * current version of the repository and of the libav* libraries used by
 132  * the program.
 133  */
 134 void show_banner(void);
 135
 136 /**
 137  * Prints the version of the program to stdout. The version message
 138  * depends on the current versions of the repository and of the libav*
 139  * libraries.
 140  */
 141 void show_version(void);
 142
 143 /**
 144  * Prints the license of the program to stdout. The license depends on
 145  * the license of the libraries compiled into the program.
 146  */
 147 void show_license(void);
 148
 149 /**
 150  * Prints a listing containing all the formats supported by the
 151  * program.
 152  */
 153 void show_formats(void);
 154
 155 /**
 156  * Returns a positive value if reads from standard input a line
 157  * starting with [yY], otherwise returns 0.
 158  */
 159 int read_yesno(void);
 160
 161 #endif /* FFMPEG_CMDUTILS_H */