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(void *optctx, const char *opt, const char *arg);
  79
  80 /**
  81  * Set the libav* libraries log level.
  82  */
  83 int opt_loglevel(void *optctx, const char *opt, const char *arg);
  84
  85 int opt_report(const char *opt);
  86
  87 int opt_report_file(void *optctx, const char *opt, const char *arg);
  88
  89 int opt_max_alloc(void *optctx, const char *opt, const char *arg);
  90
  91 int opt_cpuflags(void *optctx, const char *opt, const char *arg);
  92
  93 int opt_codec_debug(void *optctx, const char *opt, const char *arg);
  94
  95 /**
  96  * Limit the execution time.
  97  */
  98 int opt_timelimit(void *optctx, const char *opt, const char *arg);
  99
 100 /**
 101  * Parse a string and return its corresponding value as a double.
 102  * Exit from the application if the string cannot be correctly
 103  * parsed or the corresponding value is invalid.
 104  *
 105  * @param context the context of the value to be set (e.g. the
 106  * corresponding command line option name)
 107  * @param numstr the string to be parsed
 108  * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
 109  * string should be parsed
 110  * @param min the minimum valid accepted value
 111  * @param max the maximum valid accepted value
 112  */
 113 double parse_number_or_die(const char *context, const char *numstr, int type,
 114                            double min, double max);
 115
 116 /**
 117  * Parse a string specifying a time and return its corresponding
 118  * value as a number of microseconds. Exit from the application if
 119  * the string cannot be correctly parsed.
 120  *
 121  * @param context the context of the value to be set (e.g. the
 122  * corresponding command line option name)
 123  * @param timestr the string to be parsed
 124  * @param is_duration a flag which tells how to interpret timestr, if
 125  * not zero timestr is interpreted as a duration, otherwise as a
 126  * date
 127  *
 128  * @see parse_date()
 129  */
 130 int64_t parse_time_or_die(const char *context, const char *timestr,
 131                           int is_duration);
 132
 133 typedef struct SpecifierOpt {
 134     char *specifier;    /**< stream/chapter/program/... specifier */
 135     union {
 136         uint8_t *str;
 137         int        i;
 138         int64_t  i64;
 139         float      f;
 140         double   dbl;
 141     } u;
 142 } SpecifierOpt;
 143
 144 typedef struct OptionDef {
 145     const char *name;
 146     int flags;
 147 #define HAS_ARG    0x0001
 148 #define OPT_BOOL   0x0002
 149 #define OPT_EXPERT 0x0004
 150 #define OPT_STRING 0x0008
 151 #define OPT_VIDEO  0x0010
 152 #define OPT_AUDIO  0x0020
 153 #define OPT_INT    0x0080
 154 #define OPT_FLOAT  0x0100
 155 #define OPT_SUBTITLE 0x0200
 156 #define OPT_INT64  0x0400
 157 #define OPT_EXIT   0x0800
 158 #define OPT_DATA   0x1000
 159 #define OPT_PERFILE  0x2000     /* the option is per-file (currently ffmpeg-only).
 160                                    implied by OPT_OFFSET or OPT_SPEC */
 161 #define OPT_OFFSET 0x4000       /* option is specified as an offset in a passed optctx */
 162 #define OPT_SPEC   0x8000       /* option is to be stored in an array of SpecifierOpt.
 163                                    Implies OPT_OFFSET. Next element after the offset is
 164                                    an int containing element count in the array. */
 165 #define OPT_TIME  0x10000
 166 #define OPT_DOUBLE 0x20000
 167      union {
 168         void *dst_ptr;
 169         int (*func_arg)(void *, const char *, const char *);
 170         size_t off;
 171     } u;
 172     const char *help;
 173     const char *argname;
 174 } OptionDef;
 175
 176 /**
 177  * Print help for all options matching specified flags.
 178  *
 179  * @param options a list of options
 180  * @param msg title of this group. Only printed if at least one option matches.
 181  * @param req_flags print only options which have all those flags set.
 182  * @param rej_flags don't print options which have any of those flags set.
 183  * @param alt_flags print only options that have at least one of those flags set
 184  */
 185 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
 186                        int rej_flags, int alt_flags);
 187
 188 /**
 189  * Show help for all options with given flags in class and all its
 190  * children.
 191  */
 192 void show_help_children(const AVClass *class, int flags);
 193
 194 /**
 195  * Per-avtool specific help handler. Implemented in each
 196  * avtool, called by show_help().
 197  */
 198 void show_help_default(const char *opt, const char *arg);
 199
 200 /**
 201  * Generic -h handler common to all avtools.
 202  */
 203 int show_help(void *optctx, const char *opt, const char *arg);
 204
 205 /**
 206  * Parse the command line arguments.
 207  *
 208  * @param optctx an opaque options context
 209  * @param argc   number of command line arguments
 210  * @param argv   values of command line arguments
 211  * @param options Array with the definitions required to interpret every
 212  * option of the form: -option_name [argument]
 213  * @param parse_arg_function Name of the function called to process every
 214  * argument without a leading option name flag. NULL if such arguments do
 215  * not have to be processed.
 216  */
 217 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
 218                    void (* parse_arg_function)(void *optctx, const char*));
 219
 220 /**
 221  * Parse one given option.
 222  *
 223  * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
 224  */
 225 int parse_option(void *optctx, const char *opt, const char *arg,
 226                  const OptionDef *options);
 227
 228 /**
 229  * Find the '-loglevel' option in the command line args and apply it.
 230  */
 231 void parse_loglevel(int argc, char **argv, const OptionDef *options);
 232
 233 /**
 234  * Return index of option opt in argv or 0 if not found.
 235  */
 236 int locate_option(int argc, char **argv, const OptionDef *options,
 237                   const char *optname);
 238
 239 /**
 240  * Check if the given stream matches a stream specifier.
 241  *
 242  * @param s  Corresponding format context.
 243  * @param st Stream from s to be checked.
 244  * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
 245  *
 246  * @return 1 if the stream matches, 0 if it doesn't, <0 on error
 247  */
 248 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
 249
 250 /**
 251  * Filter out options for given codec.
 252  *
 253  * Create a new options dictionary containing only the options from
 254  * opts which apply to the codec with ID codec_id.
 255  *
 256  * @param opts     dictionary to place options in
 257  * @param codec_id ID of the codec that should be filtered for
 258  * @param s Corresponding format context.
 259  * @param st A stream from s for which the options should be filtered.
 260  * @param codec The particular codec for which the options should be filtered.
 261  *              If null, the default one is looked up according to the codec id.
 262  * @return a pointer to the created dictionary
 263  */
 264 AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
 265                                 AVFormatContext *s, AVStream *st, AVCodec *codec);
 266
 267 /**
 268  * Setup AVCodecContext options for avformat_find_stream_info().
 269  *
 270  * Create an array of dictionaries, one dictionary for each stream
 271  * contained in s.
 272  * Each dictionary will contain the options from codec_opts which can
 273  * be applied to the corresponding stream codec context.
 274  *
 275  * @return pointer to the created array of dictionaries, NULL if it
 276  * cannot be created
 277  */
 278 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
 279                                            AVDictionary *codec_opts);
 280
 281 /**
 282  * Print an error message to stderr, indicating filename and a human
 283  * readable description of the error code err.
 284  *
 285  * If strerror_r() is not available the use of this function in a
 286  * multithreaded application may be unsafe.
 287  *
 288  * @see av_strerror()
 289  */
 290 void print_error(const char *filename, int err);
 291
 292 /**
 293  * Print the program banner to stderr. The banner contents depend on the
 294  * current version of the repository and of the libav* libraries used by
 295  * the program.
 296  */
 297 void show_banner(int argc, char **argv, const OptionDef *options);
 298
 299 /**
 300  * Print the version of the program to stdout. The version message
 301  * depends on the current versions of the repository and of the libav*
 302  * libraries.
 303  * This option processing function does not utilize the arguments.
 304  */
 305 int show_version(void *optctx, const char *opt, const char *arg);
 306
 307 /**
 308  * Print the license of the program to stdout. The license depends on
 309  * the license of the libraries compiled into the program.
 310  * This option processing function does not utilize the arguments.
 311  */
 312 int show_license(void *optctx, const char *opt, const char *arg);
 313
 314 /**
 315  * Print a listing containing all the formats supported by the
 316  * program.
 317  * This option processing function does not utilize the arguments.
 318  */
 319 int show_formats(void *optctx, const char *opt, const char *arg);
 320
 321 /**
 322  * Print a listing containing all the codecs supported by the
 323  * program.
 324  * This option processing function does not utilize the arguments.
 325  */
 326 int show_codecs(void *optctx, const char *opt, const char *arg);
 327
 328 /**
 329  * Print a listing containing all the decoders supported by the
 330  * program.
 331  */
 332 int show_decoders(void *optctx, const char *opt, const char *arg);
 333
 334 /**
 335  * Print a listing containing all the encoders supported by the
 336  * program.
 337  */
 338 int show_encoders(void *optctx, const char *opt, const char *arg);
 339
 340 /**
 341  * Print a listing containing all the filters supported by the
 342  * program.
 343  * This option processing function does not utilize the arguments.
 344  */
 345 int show_filters(void *optctx, const char *opt, const char *arg);
 346
 347 /**
 348  * Print a listing containing all the bit stream filters supported by the
 349  * program.
 350  * This option processing function does not utilize the arguments.
 351  */
 352 int show_bsfs(void *optctx, const char *opt, const char *arg);
 353
 354 /**
 355  * Print a listing containing all the protocols supported by the
 356  * program.
 357  * This option processing function does not utilize the arguments.
 358  */
 359 int show_protocols(void *optctx, const char *opt, const char *arg);
 360
 361 /**
 362  * Print a listing containing all the pixel formats supported by the
 363  * program.
 364  * This option processing function does not utilize the arguments.
 365  */
 366 int show_pix_fmts(void *optctx, const char *opt, const char *arg);
 367
 368 /**
 369  * Print a listing containing all the standard channel layouts supported by
 370  * the program.
 371  * This option processing function does not utilize the arguments.
 372  */
 373 int show_layouts(void *optctx, const char *opt, const char *arg);
 374
 375 /**
 376  * Print a listing containing all the sample formats supported by the
 377  * program.
 378  */
 379 int show_sample_fmts(void *optctx, const char *opt, const char *arg);
 380
 381 /**
 382  * Return a positive value if a line read from standard input
 383  * starts with [yY], otherwise return 0.
 384  */
 385 int read_yesno(void);
 386
 387 /**
 388  * Read the file with name filename, and put its content in a newly
 389  * allocated 0-terminated buffer.
 390  *
 391  * @param filename file to read from
 392  * @param bufptr location where pointer to buffer is returned
 393  * @param size   location where size of buffer is returned
 394  * @return 0 in case of success, a negative value corresponding to an
 395  * AVERROR error code in case of failure.
 396  */
 397 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
 398
 399 /**
 400  * Get a file corresponding to a preset file.
 401  *
 402  * If is_path is non-zero, look for the file in the path preset_name.
 403  * Otherwise search for a file named arg.ffpreset in the directories
 404  * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
 405  * at configuration time or in a "ffpresets" folder along the executable
 406  * on win32, in that order. If no such file is found and
 407  * codec_name is defined, then search for a file named
 408  * codec_name-preset_name.avpreset in the above-mentioned directories.
 409  *
 410  * @param filename buffer where the name of the found filename is written
 411  * @param filename_size size in bytes of the filename buffer
 412  * @param preset_name name of the preset to search
 413  * @param is_path tell if preset_name is a filename path
 414  * @param codec_name name of the codec for which to look for the
 415  * preset, may be NULL
 416  */
 417 FILE *get_preset_file(char *filename, size_t filename_size,
 418                       const char *preset_name, int is_path, const char *codec_name);
 419
 420 /**
 421  * Realloc array to hold new_size elements of elem_size.
 422  * Calls exit() on failure.
 423  *
 424  * @param array array to reallocate
 425  * @param elem_size size in bytes of each element
 426  * @param size new element count will be written here
 427  * @param new_size number of elements to place in reallocated array
 428  * @return reallocated array
 429  */
 430 void *grow_array(void *array, int elem_size, int *size, int new_size);
 431
 432 typedef struct FrameBuffer {
 433     uint8_t *base[4];
 434     uint8_t *data[4];
 435     int  linesize[4];
 436
 437     int h, w;
 438     enum AVPixelFormat pix_fmt;
 439
 440     int refcount;
 441     struct FrameBuffer **pool;  ///< head of the buffer pool
 442     struct FrameBuffer *next;
 443 } FrameBuffer;
 444
 445 /**
 446  * Get a frame from the pool. This is intended to be used as a callback for
 447  * AVCodecContext.get_buffer.
 448  *
 449  * @param s codec context. s->opaque must be a pointer to the head of the
 450  *          buffer pool.
 451  * @param frame frame->opaque will be set to point to the FrameBuffer
 452  *              containing the frame data.
 453  */
 454 int codec_get_buffer(AVCodecContext *s, AVFrame *frame);
 455
 456 /**
 457  * A callback to be used for AVCodecContext.release_buffer along with
 458  * codec_get_buffer().
 459  */
 460 void codec_release_buffer(AVCodecContext *s, AVFrame *frame);
 461
 462 /**
 463  * A callback to be used for AVFilterBuffer.free.
 464  * @param fb buffer to free. fb->priv must be a pointer to the FrameBuffer
 465  *           containing the buffer data.
 466  */
 467 void filter_release_buffer(AVFilterBuffer *fb);
 468
 469 /**
 470  * Free all the buffers in the pool. This must be called after all the
 471  * buffers have been released.
 472  */
 473 void free_buffer_pool(FrameBuffer **pool);
 474
 475 #define GET_PIX_FMT_NAME(pix_fmt)\
 476     const char *name = av_get_pix_fmt_name(pix_fmt);
 477
 478 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
 479     const char *name = av_get_sample_fmt_name(sample_fmt)
 480
 481 #define GET_SAMPLE_RATE_NAME(rate)\
 482     char name[16];\
 483     snprintf(name, sizeof(name), "%d", rate);
 484
 485 #define GET_CH_LAYOUT_NAME(ch_layout)\
 486     char name[16];\
 487     snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
 488
 489 #define GET_CH_LAYOUT_DESC(ch_layout)\
 490     char name[128];\
 491     av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
 492
 493 #endif /* CMDUTILS_H */