@begingroup --> @defgroup, only the latter is correct Doxygen syntax.
[libav.git] / cmdutils.h
CommitLineData
f5a90186
DB
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
5b21bdab
DB
22#ifndef FFMPEG_CMDUTILS_H
23#define FFMPEG_CMDUTILS_H
01310af2 24
f0a838e5 25#include <inttypes.h>
95137bbb
DB
26#include "libavcodec/avcodec.h"
27#include "libavformat/avformat.h"
28#include "libswscale/swscale.h"
f0a838e5 29
60b5a745 30/**
64555bd9
MN
31 * program name, defined by the program for show_version().
32 */
33extern const char program_name[];
34
35/**
ea9c581f
SS
36 * program birth year, defined by the program for show_banner()
37 */
38extern const int program_birth_year;
39
ef4c0bb1
SS
40extern const int this_year;
41
85663ef3 42extern const char **opt_names;
72415b2a 43extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
85663ef3
MN
44extern AVFormatContext *avformat_opts;
45extern struct SwsContext *sws_opts;
46
47/**
b7438896 48 * Fallback for options that are not explicitly handled, these will be
85663ef3
MN
49 * parsed through AVOptions.
50 */
51int opt_default(const char *opt, const char *arg);
52
ea9c581f 53/**
49bd8e4b 54 * Set the libav* libraries log level.
4c97a6fa
SS
55 */
56int opt_loglevel(const char *opt, const char *arg);
57
58/**
ffcc6e24
MR
59 * Limit the execution time.
60 */
61int opt_timelimit(const char *opt, const char *arg);
62
63/**
49bd8e4b
MR
64 * Parse a string and return its corresponding value as a double.
65 * Exit from the application if the string cannot be correctly
15067504 66 * parsed or the corresponding value is invalid.
60b5a745
SS
67 *
68 * @param context the context of the value to be set (e.g. the
69 * corresponding commandline option name)
70 * @param numstr the string to be parsed
71 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
72 * string should be parsed
15067504
DB
73 * @param min the minimum valid accepted value
74 * @param max the maximum valid accepted value
60b5a745
SS
75 */
76double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
77
7542157d 78/**
49bd8e4b
MR
79 * Parse a string specifying a time and return its corresponding
80 * value as a number of microseconds. Exit from the application if
7542157d
SS
81 * the string cannot be correctly parsed.
82 *
83 * @param context the context of the value to be set (e.g. the
84 * corresponding commandline option name)
85 * @param timestr the string to be parsed
bf7e799c
SS
86 * @param is_duration a flag which tells how to interpret timestr, if
87 * not zero timestr is interpreted as a duration, otherwise as a
7542157d
SS
88 * date
89 *
748061de 90 * @see parse_date()
7542157d
SS
91 */
92int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
93
01310af2
FB
94typedef struct {
95 const char *name;
96 int flags;
97#define HAS_ARG 0x0001
98#define OPT_BOOL 0x0002
99#define OPT_EXPERT 0x0004
100#define OPT_STRING 0x0008
02d504a7
FB
101#define OPT_VIDEO 0x0010
102#define OPT_AUDIO 0x0020
103#define OPT_GRAB 0x0040
26d4f26b 104#define OPT_INT 0x0080
394c4d77 105#define OPT_FLOAT 0x0100
ae27975d 106#define OPT_SUBTITLE 0x0200
8bbf6db9 107#define OPT_FUNC2 0x0400
ffdf9a1f 108#define OPT_INT64 0x0800
a0b3bcd9 109#define OPT_EXIT 0x1000
ae27975d 110 union {
8bbf6db9 111 void (*func_arg)(const char *); //FIXME passing error code as int return would be nicer then exit() in the func
01310af2
FB
112 int *int_arg;
113 char **str_arg;
1f631450 114 float *float_arg;
8bbf6db9 115 int (*func2_arg)(const char *, const char *);
ffdf9a1f 116 int64_t *int64_arg;
01310af2
FB
117 } u;
118 const char *help;
119 const char *argname;
120} OptionDef;
121
02d504a7 122void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
60a9966e
SS
123
124/**
49bd8e4b 125 * Parse the command line arguments.
60a9966e
SS
126 * @param options Array with the definitions required to interpret every
127 * option of the form: -<option_name> [<argument>]
128 * @param parse_arg_function Name of the function called to process every
129 * argument without a leading option name flag. NULL if such arguments do
130 * not have to be processed.
131 */
132void parse_options(int argc, char **argv, const OptionDef *options,
133 void (* parse_arg_function)(const char*));
134
85663ef3
MN
135void set_context_opts(void *ctx, void *opts_ctx, int flags);
136
8d787f8e 137/**
49bd8e4b 138 * Print an error message to stderr, indicating filename and a human
8d787f8e
SS
139 * readable description of the error code err.
140 *
141 * If strerror_r() is not available the use of this function in a
142 * multithreaded application may be unsafe.
143 *
144 * @see av_strerror()
145 */
01310af2
FB
146void print_error(const char *filename, int err);
147
c5dc6026
SS
148void list_fmts(void (*get_fmt_string)(char *buf, int buf_size, int fmt), int nb_fmts);
149
f35917b2 150/**
49bd8e4b 151 * Print the program banner to stderr. The banner contents depend on the
15067504
DB
152 * current version of the repository and of the libav* libraries used by
153 * the program.
86074ed1 154 */
ea9c581f 155void show_banner(void);
86074ed1
SS
156
157/**
49bd8e4b 158 * Print the version of the program to stdout. The version message
86074ed1
SS
159 * depends on the current versions of the repository and of the libav*
160 * libraries.
86074ed1 161 */
64555bd9 162void show_version(void);
86074ed1
SS
163
164/**
49bd8e4b 165 * Print the license of the program to stdout. The license depends on
15067504 166 * the license of the libraries compiled into the program.
f35917b2
SS
167 */
168void show_license(void);
169
ba9880c1 170/**
49bd8e4b 171 * Print a listing containing all the formats supported by the
ba9880c1
SS
172 * program.
173 */
174void show_formats(void);
175
090b61b2 176/**
49bd8e4b 177 * Print a listing containing all the codecs supported by the
8447f0bd
MN
178 * program.
179 */
180void show_codecs(void);
181
182/**
49bd8e4b 183 * Print a listing containing all the filters supported by the
62d75662
SS
184 * program.
185 */
186void show_filters(void);
187
188/**
49bd8e4b 189 * Print a listing containing all the bit stream filters supported by the
8447f0bd
MN
190 * program.
191 */
192void show_bsfs(void);
193
194/**
49bd8e4b 195 * Print a listing containing all the protocols supported by the
8447f0bd
MN
196 * program.
197 */
198void show_protocols(void);
199
200/**
49bd8e4b 201 * Print a listing containing all the pixel formats supported by the
3f7bb426
SS
202 * program.
203 */
204void show_pix_fmts(void);
205
206/**
48966b02
MR
207 * Return a positive value if a line read from standard input
208 * starts with [yY], otherwise return 0.
090b61b2
SS
209 */
210int read_yesno(void);
211
458b062d 212/**
49bd8e4b 213 * Read the file with name filename, and put its content in a newly
458b062d
SS
214 * allocated 0-terminated buffer.
215 *
49bd8e4b
MR
216 * @param bufptr location where pointer to buffer is returned
217 * @param size location where size of buffer is returned
458b062d
SS
218 * @return 0 in case of success, a negative value corresponding to an
219 * AVERROR error code in case of failure.
220 */
221int read_file(const char *filename, char **bufptr, size_t *size);
222
5b21bdab 223#endif /* FFMPEG_CMDUTILS_H */