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