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