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 <inttypes.h>
  26
  27 typedef struct {
  28     const char *name;
  29     int flags;
  30 #define HAS_ARG    0x0001
  31 #define OPT_BOOL   0x0002
  32 #define OPT_EXPERT 0x0004
  33 #define OPT_STRING 0x0008
  34 #define OPT_VIDEO  0x0010
  35 #define OPT_AUDIO  0x0020
  36 #define OPT_GRAB   0x0040
  37 #define OPT_INT    0x0080
  38 #define OPT_FLOAT  0x0100
  39 #define OPT_SUBTITLE 0x0200
  40 #define OPT_FUNC2  0x0400
  41 #define OPT_INT64  0x0800
  42      union {
  43         void (*func_arg)(const char *); //FIXME passing error code as int return would be nicer then exit() in the func
  44         int *int_arg;
  45         char **str_arg;
  46         float *float_arg;
  47         int (*func2_arg)(const char *, const char *);
  48         int64_t *int64_arg;
  49     } u;
  50     const char *help;
  51     const char *argname;
  52 } OptionDef;
  53
  54 void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
  55
  56 /**
  57  * Parses the command line arguments.
  58  * @param options Array with the definitions required to interpret every
  59  * option of the form: -<option_name> [<argument>]
  60  * @param parse_arg_function Name of the function called to process every
  61  * argument without a leading option name flag. NULL if such arguments do
  62  * not have to be processed.
  63  */
  64 void parse_options(int argc, char **argv, const OptionDef *options,
  65                    void (* parse_arg_function)(const char*));
  66
  67 void print_error(const char *filename, int err);
  68
  69 /**
  70  * Prints the banner of the program on stderr. The banner message
  71  * depends on the current versions of the repository and of the libav*
  72  * libraries.
  73  * @param program_name Name of the program.
  74  * @param program_birth_year Year of birth of the program.
  75  */
  76 void show_banner(const char *program_name, int program_birth_year);
  77
  78 /**
  79  * Prints the version of the program on stdout. The version message
  80  * depends on the current versions of the repository and of the libav*
  81  * libraries.
  82  * @param program_name Name of the program.
  83  */
  84 void show_version(const char *program_name);
  85
  86 /**
  87  * Prints on stdout the license of the program, which depends on the license of
  88  * the compiled libav* libraries.
  89  */
  90 void show_license(void);
  91
  92 #endif /* FFMPEG_CMDUTILS_H */