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