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