cmdutils.h

   1 /*
   2  * Various utilities for command line tools
   3  * copyright (c) 2003 Fabrice Bellard
   4  *
   5  * This file is part of Libav.
   6  *
   7  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef LIBAV_CMDUTILS_H
  23 #define LIBAV_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 AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
  43 extern AVFormatContext *avformat_opts;
  44 extern struct SwsContext *sws_opts;
  45 extern AVDictionary *format_opts, *codec_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_INT64  0x0400
 125 #define OPT_EXIT   0x0800
 126 #define OPT_DATA   0x1000
 127      union {
 128         int *int_arg;
 129         char **str_arg;
 130         float *float_arg;
 131         int (*func_arg)(const char *, const char *);
 132         int64_t *int64_arg;
 133     } u;
 134     const char *help;
 135     const char *argname;
 136 } OptionDef;
 137
 138 void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
 139
 140 /**
 141  * Parse the command line arguments.
 142  * @param options Array with the definitions required to interpret every
 143  * option of the form: -option_name [argument]
 144  * @param parse_arg_function Name of the function called to process every
 145  * argument without a leading option name flag. NULL if such arguments do
 146  * not have to be processed.
 147  */
 148 void parse_options(int argc, char **argv, const OptionDef *options,
 149                    void (* parse_arg_function)(const char*));
 150
 151 /**
 152  * Check if the given stream matches a stream specifier.
 153  *
 154  * @param s  Corresponding format context.
 155  * @param st Stream from s to be checked.
 156  * @param spec A stream specifier of the [v|a|s|d]:[<stream index>] form.
 157  *
 158  * @return 1 if the stream matches, 0 if it doesn't, <0 on error
 159  */
 160 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
 161
 162 /**
 163  * Filter out options for given codec.
 164  *
 165  * Create a new options dictionary containing only the options from
 166  * opts which apply to the codec with ID codec_id.
 167  *
 168  * @param s Corresponding format context.
 169  * @param st A stream from s for which the options should be filtered.
 170  * @return a pointer to the created dictionary
 171  */
 172 AVDictionary *filter_codec_opts(AVDictionary *opts, enum CodecID codec_id, AVFormatContext *s, AVStream *st);
 173
 174 /**
 175  * Setup AVCodecContext options for avformat_find_stream_info().
 176  *
 177  * Create an array of dictionaries, one dictionary for each stream
 178  * contained in s.
 179  * Each dictionary will contain the options from codec_opts which can
 180  * be applied to the corresponding stream codec context.
 181  *
 182  * @return pointer to the created array of dictionaries, NULL if it
 183  * cannot be created
 184  */
 185 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s, AVDictionary *codec_opts);
 186
 187 /**
 188  * Print an error message to stderr, indicating filename and a human
 189  * readable description of the error code err.
 190  *
 191  * If strerror_r() is not available the use of this function in a
 192  * multithreaded application may be unsafe.
 193  *
 194  * @see av_strerror()
 195  */
 196 void print_error(const char *filename, int err);
 197
 198 /**
 199  * Print the program banner to stderr. The banner contents depend on the
 200  * current version of the repository and of the libav* libraries used by
 201  * the program.
 202  */
 203 void show_banner(void);
 204
 205 /**
 206  * Print the version of the program to stdout. The version message
 207  * depends on the current versions of the repository and of the libav*
 208  * libraries.
 209  */
 210 void show_version(void);
 211
 212 /**
 213  * Print the license of the program to stdout. The license depends on
 214  * the license of the libraries compiled into the program.
 215  */
 216 void show_license(void);
 217
 218 /**
 219  * Print a listing containing all the formats supported by the
 220  * program.
 221  */
 222 void show_formats(void);
 223
 224 /**
 225  * Print a listing containing all the codecs supported by the
 226  * program.
 227  */
 228 void show_codecs(void);
 229
 230 /**
 231  * Print a listing containing all the filters supported by the
 232  * program.
 233  */
 234 void show_filters(void);
 235
 236 /**
 237  * Print a listing containing all the bit stream filters supported by the
 238  * program.
 239  */
 240 void show_bsfs(void);
 241
 242 /**
 243  * Print a listing containing all the protocols supported by the
 244  * program.
 245  */
 246 void show_protocols(void);
 247
 248 /**
 249  * Print a listing containing all the pixel formats supported by the
 250  * program.
 251  */
 252 void show_pix_fmts(void);
 253
 254 /**
 255  * Return a positive value if a line read from standard input
 256  * starts with [yY], otherwise return 0.
 257  */
 258 int read_yesno(void);
 259
 260 /**
 261  * Read the file with name filename, and put its content in a newly
 262  * allocated 0-terminated buffer.
 263  *
 264  * @param bufptr location where pointer to buffer is returned
 265  * @param size   location where size of buffer is returned
 266  * @return 0 in case of success, a negative value corresponding to an
 267  * AVERROR error code in case of failure.
 268  */
 269 int read_file(const char *filename, char **bufptr, size_t *size);
 270
 271 typedef struct {
 272     int64_t num_faulty_pts; /// Number of incorrect PTS values so far
 273     int64_t num_faulty_dts; /// Number of incorrect DTS values so far
 274     int64_t last_pts;       /// PTS of the last frame
 275     int64_t last_dts;       /// DTS of the last frame
 276 } PtsCorrectionContext;
 277
 278 /**
 279  * Reset the state of the PtsCorrectionContext.
 280  */
 281 void init_pts_correction(PtsCorrectionContext *ctx);
 282
 283 /**
 284  * Attempt to guess proper monotonic timestamps for decoded video frames
 285  * which might have incorrect times. Input timestamps may wrap around, in
 286  * which case the output will as well.
 287  *
 288  * @param pts the pts field of the decoded AVPacket, as passed through
 289  * AVCodecContext.reordered_opaque
 290  * @param dts the dts field of the decoded AVPacket
 291  * @return one of the input values, may be AV_NOPTS_VALUE
 292  */
 293 int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
 294
 295 /**
 296  * Get a file corresponding to a preset file.
 297  *
 298  * If is_path is non-zero, look for the file in the path preset_name.
 299  * Otherwise search for a file named arg.ffpreset in the directories
 300  * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
 301  * at configuration time, in that order. If no such file is found and
 302  * codec_name is defined, then search for a file named
 303  * codec_name-preset_name.ffpreset in the above-mentioned directories.
 304  *
 305  * @param filename buffer where the name of the found filename is written
 306  * @param filename_size size in bytes of the filename buffer
 307  * @param preset_name name of the preset to search
 308  * @param is_path tell if preset_name is a filename path
 309  * @param codec_name name of the codec for which to look for the
 310  * preset, may be NULL
 311  */
 312 FILE *get_preset_file(char *filename, size_t filename_size,
 313                       const char *preset_name, int is_path, const char *codec_name);
 314
 315 typedef struct {
 316     enum PixelFormat pix_fmt;
 317 } FFSinkContext;
 318
 319 extern AVFilter ffsink;
 320
 321 /**
 322  * Extract a frame from sink.
 323  *
 324  * @return a negative error in case of failure, 1 if one frame has
 325  * been extracted successfully.
 326  */
 327 int get_filtered_video_frame(AVFilterContext *sink, AVFrame *frame,
 328                              AVFilterBufferRef **picref, AVRational *pts_tb);
 329
 330 /**
 331  * Do all the necessary cleanup and abort.
 332  * This function is implemented in the avtools, not cmdutils.
 333  */
 334 void exit_program(int ret);
 335
 336 /**
 337  * Realloc array to hold new_size elements of elem_size.
 338  * Calls exit_program() on failure.
 339  *
 340  * @param elem_size size in bytes of each element
 341  * @param size new element count will be written here
 342  * @return reallocated array
 343  */
 344 void *grow_array(void *array, int elem_size, int *size, int new_size);
 345
 346 #endif /* LIBAV_CMDUTILS_H */