Move the definitions of data_buf and data_size closer to where they are used.
[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 #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 int this_year;
41
42 extern const char **opt_names;
43 extern AVCodecContext *avcodec_opts[CODEC_TYPE_NB];
44 extern AVFormatContext *avformat_opts;
45 extern struct SwsContext *sws_opts;
46
47 /**
48  * Fallback for options that are not explicitly handled, these will be
49  * parsed through AVOptions.
50  */
51 int opt_default(const char *opt, const char *arg);
52
53 /**
54  * Sets the libav* libraries log level.
55  */
56 int opt_loglevel(const char *opt, const char *arg);
57
58 /**
59  * Parses a string and returns its corresponding value as a double.
60  * Exits from the application if the string cannot be correctly
61  * parsed or the corresponding value is invalid.
62  *
63  * @param context the context of the value to be set (e.g. the
64  * corresponding commandline option name)
65  * @param numstr the string to be parsed
66  * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
67  * string should be parsed
68  * @param min the minimum valid accepted value
69  * @param max the maximum valid accepted value
70  */
71 double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
72
73 /**
74  * Parses a string specifying a time and returns its corresponding
75  * value as a number of microseconds. Exits from the application if
76  * the string cannot be correctly parsed.
77  *
78  * @param context the context of the value to be set (e.g. the
79  * corresponding commandline option name)
80  * @param timestr the string to be parsed
81  * @param is_duration a flag which tells how to interpret timestr, if
82  * not zero timestr is interpreted as a duration, otherwise as a
83  * date
84  *
85  * @see parse_date()
86  */
87 int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
88
89 typedef struct {
90     const char *name;
91     int flags;
92 #define HAS_ARG    0x0001
93 #define OPT_BOOL   0x0002
94 #define OPT_EXPERT 0x0004
95 #define OPT_STRING 0x0008
96 #define OPT_VIDEO  0x0010
97 #define OPT_AUDIO  0x0020
98 #define OPT_GRAB   0x0040
99 #define OPT_INT    0x0080
100 #define OPT_FLOAT  0x0100
101 #define OPT_SUBTITLE 0x0200
102 #define OPT_FUNC2  0x0400
103 #define OPT_INT64  0x0800
104 #define OPT_EXIT   0x1000
105      union {
106         void (*func_arg)(const char *); //FIXME passing error code as int return would be nicer then exit() in the func
107         int *int_arg;
108         char **str_arg;
109         float *float_arg;
110         int (*func2_arg)(const char *, const char *);
111         int64_t *int64_arg;
112     } u;
113     const char *help;
114     const char *argname;
115 } OptionDef;
116
117 void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
118
119 /**
120  * Parses the command line arguments.
121  * @param options Array with the definitions required to interpret every
122  * option of the form: -<option_name> [<argument>]
123  * @param parse_arg_function Name of the function called to process every
124  * argument without a leading option name flag. NULL if such arguments do
125  * not have to be processed.
126  */
127 void parse_options(int argc, char **argv, const OptionDef *options,
128                    void (* parse_arg_function)(const char*));
129
130 void set_context_opts(void *ctx, void *opts_ctx, int flags);
131
132 void print_error(const char *filename, int err);
133
134 void list_fmts(void (*get_fmt_string)(char *buf, int buf_size, int fmt), int nb_fmts);
135
136 /**
137  * Prints the program banner to stderr. The banner contents depend on the
138  * current version of the repository and of the libav* libraries used by
139  * the program.
140  */
141 void show_banner(void);
142
143 /**
144  * Prints the version of the program to stdout. The version message
145  * depends on the current versions of the repository and of the libav*
146  * libraries.
147  */
148 void show_version(void);
149
150 /**
151  * Prints the license of the program to stdout. The license depends on
152  * the license of the libraries compiled into the program.
153  */
154 void show_license(void);
155
156 /**
157  * Prints a listing containing all the formats supported by the
158  * program.
159  */
160 void show_formats(void);
161
162 /**
163  * Prints a listing containing all the codecs supported by the
164  * program.
165  */
166 void show_codecs(void);
167
168 /**
169  * Prints a listing containing all the filters supported by the
170  * program.
171  */
172 void show_filters(void);
173
174 /**
175  * Prints a listing containing all the bit stream filters supported by the
176  * program.
177  */
178 void show_bsfs(void);
179
180 /**
181  * Prints a listing containing all the protocols supported by the
182  * program.
183  */
184 void show_protocols(void);
185
186 /**
187  * Prints a listing containing all the pixel formats supported by the
188  * program.
189  */
190 void show_pix_fmts(void);
191
192 /**
193  * Returns a positive value if reads from standard input a line
194  * starting with [yY], otherwise returns 0.
195  */
196 int read_yesno(void);
197
198 #endif /* FFMPEG_CMDUTILS_H */