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 const char **opt_names;
  47 extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
  48 extern AVFormatContext *avformat_opts;
  49 extern struct SwsContext *sws_opts;
  50 extern AVDictionary *format_opts, *video_opts, *audio_opts, *sub_opts;
  51
  52 /**
  53  * Initialize the cmdutils option system, in particular
  54  * allocate the *_opts contexts.
  55  */
  56 void init_opts(void);
  57 /**
  58  * Uninitialize the cmdutils option system, in particular
  59  * free the *_opts contexts and their contents.
  60  */
  61 void uninit_opts(void);
  62
  63 /**
  64  * Trivial log callback.
  65  * Only suitable for show_help and similar since it lacks prefix handling.
  66  */
  67 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
  68
  69 /**
  70  * Fallback for options that are not explicitly handled, these will be
  71  * parsed through AVOptions.
  72  */
  73 int opt_default(const char *opt, const char *arg);
  74
  75 /**
  76  * Set the libav* libraries log level.
  77  */
  78 int opt_loglevel(const char *opt, const char *arg);
  79
  80 /**
  81  * Limit the execution time.
  82  */
  83 int opt_timelimit(const char *opt, const char *arg);
  84
  85 /**
  86  * Parse a string and return its corresponding value as a double.
  87  * Exit from the application if the string cannot be correctly
  88  * parsed or the corresponding value is invalid.
  89  *
  90  * @param context the context of the value to be set (e.g. the
  91  * corresponding commandline option name)
  92  * @param numstr the string to be parsed
  93  * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
  94  * string should be parsed
  95  * @param min the minimum valid accepted value
  96  * @param max the maximum valid accepted value
  97  */
  98 double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
  99
 100 /**
 101  * Parse a string specifying a time and return its corresponding
 102  * value as a number of microseconds. Exit from the application if
 103  * the string cannot be correctly parsed.
 104  *
 105  * @param context the context of the value to be set (e.g. the
 106  * corresponding commandline option name)
 107  * @param timestr the string to be parsed
 108  * @param is_duration a flag which tells how to interpret timestr, if
 109  * not zero timestr is interpreted as a duration, otherwise as a
 110  * date
 111  *
 112  * @see parse_date()
 113  */
 114 int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
 115
 116 typedef struct {
 117     const char *name;
 118     int flags;
 119 #define HAS_ARG    0x0001
 120 #define OPT_BOOL   0x0002
 121 #define OPT_EXPERT 0x0004
 122 #define OPT_STRING 0x0008
 123 #define OPT_VIDEO  0x0010
 124 #define OPT_AUDIO  0x0020
 125 #define OPT_GRAB   0x0040
 126 #define OPT_INT    0x0080
 127 #define OPT_FLOAT  0x0100
 128 #define OPT_SUBTITLE 0x0200
 129 #define OPT_INT64  0x0400
 130 #define OPT_EXIT   0x0800
 131 #define OPT_DATA   0x1000
 132      union {
 133         int *int_arg;
 134         char **str_arg;
 135         float *float_arg;
 136         int (*func_arg)(const char *, const char *);
 137         int64_t *int64_arg;
 138     } u;
 139     const char *help;
 140     const char *argname;
 141 } OptionDef;
 142
 143 void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
 144
 145 /**
 146  * Parse the command line arguments.
 147  * @param options Array with the definitions required to interpret every
 148  * option of the form: -option_name [argument]
 149  * @param parse_arg_function Name of the function called to process every
 150  * argument without a leading option name flag. NULL if such arguments do
 151  * not have to be processed.
 152  */
 153 void parse_options(int argc, char **argv, const OptionDef *options,
 154                    int (* parse_arg_function)(const char *opt, const char *arg));
 155
 156 void set_context_opts(void *ctx, void *opts_ctx, int flags, AVCodec *codec);
 157
 158 /**
 159  * Print an error message to stderr, indicating filename and a human
 160  * readable description of the error code err.
 161  *
 162  * If strerror_r() is not available the use of this function in a
 163  * multithreaded application may be unsafe.
 164  *
 165  * @see av_strerror()
 166  */
 167 void print_error(const char *filename, int err);
 168
 169 /**
 170  * Print the program banner to stderr. The banner contents depend on the
 171  * current version of the repository and of the libav* libraries used by
 172  * the program.
 173  */
 174 void show_banner(void);
 175
 176 /**
 177  * Print the version of the program to stdout. The version message
 178  * depends on the current versions of the repository and of the libav*
 179  * libraries.
 180  */
 181 void show_version(void);
 182
 183 /**
 184  * Print the license of the program to stdout. The license depends on
 185  * the license of the libraries compiled into the program.
 186  */
 187 void show_license(void);
 188
 189 /**
 190  * Print a listing containing all the formats supported by the
 191  * program.
 192  */
 193 void show_formats(void);
 194
 195 /**
 196  * Print a listing containing all the codecs supported by the
 197  * program.
 198  */
 199 void show_codecs(void);
 200
 201 /**
 202  * Print a listing containing all the filters supported by the
 203  * program.
 204  */
 205 void show_filters(void);
 206
 207 /**
 208  * Print a listing containing all the bit stream filters supported by the
 209  * program.
 210  */
 211 void show_bsfs(void);
 212
 213 /**
 214  * Print a listing containing all the protocols supported by the
 215  * program.
 216  */
 217 void show_protocols(void);
 218
 219 /**
 220  * Print a listing containing all the pixel formats supported by the
 221  * program.
 222  */
 223 void show_pix_fmts(void);
 224
 225 /**
 226  * Return a positive value if a line read from standard input
 227  * starts with [yY], otherwise return 0.
 228  */
 229 int read_yesno(void);
 230
 231 /**
 232  * Read the file with name filename, and put its content in a newly
 233  * allocated 0-terminated buffer.
 234  *
 235  * @param bufptr location where pointer to buffer is returned
 236  * @param size   location where size of buffer is returned
 237  * @return 0 in case of success, a negative value corresponding to an
 238  * AVERROR error code in case of failure.
 239  */
 240 int read_file(const char *filename, char **bufptr, size_t *size);
 241
 242 /**
 243  * Get a file corresponding to a preset file.
 244  *
 245  * If is_path is non-zero, look for the file in the path preset_name.
 246  * Otherwise search for a file named arg.ffpreset in the directories
 247  * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
 248  * at configuration time or in a "ffpresets" folder along the executable
 249  * on win32, in that order. If no such file is found and
 250  * codec_name is defined, then search for a file named
 251  * codec_name-preset_name.ffpreset in the above-mentioned directories.
 252  *
 253  * @param filename buffer where the name of the found filename is written
 254  * @param filename_size size in bytes of the filename buffer
 255  * @param preset_name name of the preset to search
 256  * @param is_path tell if preset_name is a filename path
 257  * @param codec_name name of the codec for which to look for the
 258  * preset, may be NULL
 259  */
 260 FILE *get_preset_file(char *filename, size_t filename_size,
 261                       const char *preset_name, int is_path, const char *codec_name);
 262
 263 #endif /* FFMPEG_CMDUTILS_H */