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 *format_opts, *codec_opts;
  50
  51 /**
  52  * Initialize the cmdutils option system, in particular
  53  * allocate the *_opts contexts.
  54  */
  55 void init_opts(void);
  56 /**
  57  * Uninitialize the cmdutils option system, in particular
  58  * free the *_opts contexts and their contents.
  59  */
  60 void uninit_opts(void);
  61
  62 /**
  63  * Trivial log callback.
  64  * Only suitable for opt_help and similar since it lacks prefix handling.
  65  */
  66 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
  67
  68 /**
  69  * Fallback for options that are not explicitly handled, these will be
  70  * parsed through AVOptions.
  71  */
  72 int opt_default(const char *opt, const char *arg);
  73
  74 /**
  75  * Set the libav* libraries log level.
  76  */
  77 int opt_loglevel(const char *opt, const char *arg);
  78
  79 /**
  80  * Limit the execution time.
  81  */
  82 int opt_timelimit(const char *opt, const char *arg);
  83
  84 /**
  85  * Parse a string and return its corresponding value as a double.
  86  * Exit from the application if the string cannot be correctly
  87  * parsed or the corresponding value is invalid.
  88  *
  89  * @param context the context of the value to be set (e.g. the
  90  * corresponding commandline option name)
  91  * @param numstr the string to be parsed
  92  * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
  93  * string should be parsed
  94  * @param min the minimum valid accepted value
  95  * @param max the maximum valid accepted value
  96  */
  97 double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
  98
  99 /**
 100  * Parse a string specifying a time and return its corresponding
 101  * value as a number of microseconds. Exit from the application if
 102  * the string cannot be correctly parsed.
 103  *
 104  * @param context the context of the value to be set (e.g. the
 105  * corresponding commandline option name)
 106  * @param timestr the string to be parsed
 107  * @param is_duration a flag which tells how to interpret timestr, if
 108  * not zero timestr is interpreted as a duration, otherwise as a
 109  * date
 110  *
 111  * @see parse_date()
 112  */
 113 int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
 114
 115 typedef struct SpecifierOpt {
 116     char *specifier;    /**< stream/chapter/program/... specifier */
 117     union {
 118         uint8_t *str;
 119         int        i;
 120         int64_t  i64;
 121         float      f;
 122         double   dbl;
 123     } u;
 124 } SpecifierOpt;
 125
 126 typedef struct {
 127     const char *name;
 128     int flags;
 129 #define HAS_ARG    0x0001
 130 #define OPT_BOOL   0x0002
 131 #define OPT_EXPERT 0x0004
 132 #define OPT_STRING 0x0008
 133 #define OPT_VIDEO  0x0010
 134 #define OPT_AUDIO  0x0020
 135 #define OPT_GRAB   0x0040
 136 #define OPT_INT    0x0080
 137 #define OPT_FLOAT  0x0100
 138 #define OPT_SUBTITLE 0x0200
 139 #define OPT_INT64  0x0400
 140 #define OPT_EXIT   0x0800
 141 #define OPT_DATA   0x1000
 142 #define OPT_FUNC2  0x2000
 143 #define OPT_OFFSET 0x4000       /* option is specified as an offset in a passed optctx */
 144 #define OPT_SPEC   0x8000       /* option is to be stored in an array of SpecifierOpt.
 145                                    Implies OPT_OFFSET. Next element after the offset is
 146                                    an int containing element count in the array. */
 147 #define OPT_TIME  0x10000
 148 #define OPT_DOUBLE 0x20000
 149      union {
 150         void *dst_ptr;
 151         int (*func_arg)(const char *, const char *);
 152         int (*func2_arg)(void *, const char *, const char *);
 153         size_t off;
 154     } u;
 155     const char *help;
 156     const char *argname;
 157 } OptionDef;
 158
 159 void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
 160
 161 /**
 162  * Parse the command line arguments.
 163  *
 164  * @param optctx an opaque options context
 165  * @param options Array with the definitions required to interpret every
 166  * option of the form: -option_name [argument]
 167  * @param parse_arg_function Name of the function called to process every
 168  * argument without a leading option name flag. NULL if such arguments do
 169  * not have to be processed.
 170  */
 171 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
 172                    void (* parse_arg_function)(void *optctx, const char*));
 173
 174 /**
 175  * Parse one given option.
 176  *
 177  * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
 178  */
 179 int parse_option(void *optctx, const char *opt, const char *arg, const OptionDef *options);
 180
 181 /**
 182  * Check if the given stream matches a stream specifier.
 183  *
 184  * @param s  Corresponding format context.
 185  * @param st Stream from s to be checked.
 186  * @param spec A stream specifier of the [v|a|s|d]:[<stream index>] form.
 187  *
 188  * @return 1 if the stream matches, 0 if it doesn't, <0 on error
 189  */
 190 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
 191
 192 /**
 193  * Filter out options for given codec.
 194  *
 195  * Create a new options dictionary containing only the options from
 196  * opts which apply to the codec with ID codec_id.
 197  *
 198  * @param s Corresponding format context.
 199  * @param st A stream from s for which the options should be filtered.
 200  * @return a pointer to the created dictionary
 201  */
 202 AVDictionary *filter_codec_opts(AVDictionary *opts, enum CodecID codec_id, AVFormatContext *s, AVStream *st);
 203
 204 /**
 205  * Setup AVCodecContext options for avformat_find_stream_info().
 206  *
 207  * Create an array of dictionaries, one dictionary for each stream
 208  * contained in s.
 209  * Each dictionary will contain the options from codec_opts which can
 210  * be applied to the corresponding stream codec context.
 211  *
 212  * @return pointer to the created array of dictionaries, NULL if it
 213  * cannot be created
 214  */
 215 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s, AVDictionary *codec_opts);
 216
 217 /**
 218  * Print an error message to stderr, indicating filename and a human
 219  * readable description of the error code err.
 220  *
 221  * If strerror_r() is not available the use of this function in a
 222  * multithreaded application may be unsafe.
 223  *
 224  * @see av_strerror()
 225  */
 226 void print_error(const char *filename, int err);
 227
 228 /**
 229  * Print the program banner to stderr. The banner contents depend on the
 230  * current version of the repository and of the libav* libraries used by
 231  * the program.
 232  */
 233 void show_banner(void);
 234
 235 /**
 236  * Print the version of the program to stdout. The version message
 237  * depends on the current versions of the repository and of the libav*
 238  * libraries.
 239  * This option processing function does not utilize the arguments.
 240  */
 241 int opt_version(const char *opt, const char *arg);
 242
 243 /**
 244  * Print the license of the program to stdout. The license depends on
 245  * the license of the libraries compiled into the program.
 246  * This option processing function does not utilize the arguments.
 247  */
 248 int opt_license(const char *opt, const char *arg);
 249
 250 /**
 251  * Print a listing containing all the formats supported by the
 252  * program.
 253  * This option processing function does not utilize the arguments.
 254  */
 255 int opt_formats(const char *opt, const char *arg);
 256
 257 /**
 258  * Print a listing containing all the codecs supported by the
 259  * program.
 260  * This option processing function does not utilize the arguments.
 261  */
 262 int opt_codecs(const char *opt, const char *arg);
 263
 264 /**
 265  * Print a listing containing all the filters supported by the
 266  * program.
 267  * This option processing function does not utilize the arguments.
 268  */
 269 int opt_filters(const char *opt, const char *arg);
 270
 271 /**
 272  * Print a listing containing all the bit stream filters supported by the
 273  * program.
 274  * This option processing function does not utilize the arguments.
 275  */
 276 int opt_bsfs(const char *opt, const char *arg);
 277
 278 /**
 279  * Print a listing containing all the protocols supported by the
 280  * program.
 281  * This option processing function does not utilize the arguments.
 282  */
 283 int opt_protocols(const char *opt, const char *arg);
 284
 285 /**
 286  * Print a listing containing all the pixel formats supported by the
 287  * program.
 288  * This option processing function does not utilize the arguments.
 289  */
 290 int opt_pix_fmts(const char *opt, const char *arg);
 291
 292 /**
 293  * Print a listing containing all the sample formats supported by the
 294  * program.
 295  */
 296 int show_sample_fmts(const char *opt, const char *arg);
 297
 298 /**
 299  * Return a positive value if a line read from standard input
 300  * starts with [yY], otherwise return 0.
 301  */
 302 int read_yesno(void);
 303
 304 /**
 305  * Read the file with name filename, and put its content in a newly
 306  * allocated 0-terminated buffer.
 307  *
 308  * @param bufptr location where pointer to buffer is returned
 309  * @param size   location where size of buffer is returned
 310  * @return 0 in case of success, a negative value corresponding to an
 311  * AVERROR error code in case of failure.
 312  */
 313 int read_file(const char *filename, char **bufptr, size_t *size);
 314
 315 /**
 316  * Get a file corresponding to a preset file.
 317  *
 318  * If is_path is non-zero, look for the file in the path preset_name.
 319  * Otherwise search for a file named arg.ffpreset in the directories
 320  * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
 321  * at configuration time or in a "ffpresets" folder along the executable
 322  * on win32, in that order. If no such file is found and
 323  * codec_name is defined, then search for a file named
 324  * codec_name-preset_name.ffpreset in the above-mentioned directories.
 325  *
 326  * @param filename buffer where the name of the found filename is written
 327  * @param filename_size size in bytes of the filename buffer
 328  * @param preset_name name of the preset to search
 329  * @param is_path tell if preset_name is a filename path
 330  * @param codec_name name of the codec for which to look for the
 331  * preset, may be NULL
 332  */
 333 FILE *get_preset_file(char *filename, size_t filename_size,
 334                       const char *preset_name, int is_path, const char *codec_name);
 335
 336 /**
 337  * Do all the necessary cleanup and abort.
 338  * This function is implemented in the avtools, not cmdutils.
 339  */
 340 void exit_program(int ret);
 341
 342 /**
 343  * Realloc array to hold new_size elements of elem_size.
 344  * Calls exit_program() on failure.
 345  *
 346  * @param elem_size size in bytes of each element
 347  * @param size new element count will be written here
 348  * @return reallocated array
 349  */
 350 void *grow_array(void *array, int elem_size, int *size, int new_size);
 351
 352 #endif /* LIBAV_CMDUTILS_H */