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