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