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