Move show_formats() to cmdutils.c.
[libav.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 * program name, defined by the program for show_version().
29 */
30 extern const char program_name[];
31
32 /**
33 * Parses a string and returns its corresponding value as a double.
34 * Exits from the application if the string cannot be correctly
35 * parsed or the corresponding value is invalid.
36 *
37 * @param context the context of the value to be set (e.g. the
38 * corresponding commandline option name)
39 * @param numstr the string to be parsed
40 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
41 * string should be parsed
42 * @param min the minimum valid accepted value
43 * @param max the maximum valid accepted value
44 */
45 double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
46
47 /**
48 * Parses a string specifying a time and returns its corresponding
49 * value as a number of microseconds. Exits from the application if
50 * the string cannot be correctly parsed.
51 *
52 * @param context the context of the value to be set (e.g. the
53 * corresponding commandline option name)
54 * @param timestr the string to be parsed
55 * @param is_duration a flag which tells how to interpret \p timestr, if
56 * not zero \p timestr is interpreted as a duration, otherwise as a
57 * date
58 *
59 * @see parse_date()
60 */
61 int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
62
63 typedef struct {
64 const char *name;
65 int flags;
66 #define HAS_ARG 0x0001
67 #define OPT_BOOL 0x0002
68 #define OPT_EXPERT 0x0004
69 #define OPT_STRING 0x0008
70 #define OPT_VIDEO 0x0010
71 #define OPT_AUDIO 0x0020
72 #define OPT_GRAB 0x0040
73 #define OPT_INT 0x0080
74 #define OPT_FLOAT 0x0100
75 #define OPT_SUBTITLE 0x0200
76 #define OPT_FUNC2 0x0400
77 #define OPT_INT64 0x0800
78 #define OPT_EXIT 0x1000
79 union {
80 void (*func_arg)(const char *); //FIXME passing error code as int return would be nicer then exit() in the func
81 int *int_arg;
82 char **str_arg;
83 float *float_arg;
84 int (*func2_arg)(const char *, const char *);
85 int64_t *int64_arg;
86 } u;
87 const char *help;
88 const char *argname;
89 } OptionDef;
90
91 void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
92
93 /**
94 * Parses the command line arguments.
95 * @param options Array with the definitions required to interpret every
96 * option of the form: -<option_name> [<argument>]
97 * @param parse_arg_function Name of the function called to process every
98 * argument without a leading option name flag. NULL if such arguments do
99 * not have to be processed.
100 */
101 void parse_options(int argc, char **argv, const OptionDef *options,
102 void (* parse_arg_function)(const char*));
103
104 void print_error(const char *filename, int err);
105
106 /**
107 * Prints the program banner to stderr. The banner contents depend on the
108 * current version of the repository and of the libav* libraries used by
109 * the program.
110 * @param program_name name of the program
111 * @param program_birth_year year of birth of the program
112 */
113 void show_banner(const char *program_name, int program_birth_year);
114
115 /**
116 * Prints the version of the program to stdout. The version message
117 * depends on the current versions of the repository and of the libav*
118 * libraries.
119 * @param program_name name of the program
120 */
121 void show_version(void);
122
123 /**
124 * Prints the license of the program to stdout. The license depends on
125 * the license of the libraries compiled into the program.
126 */
127 void show_license(void);
128
129 /**
130 * Prints a listing containing all the formats supported by the
131 * program.
132 */
133 void show_formats(void);
134
135 #endif /* FFMPEG_CMDUTILS_H */