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