Move COPY3_IF_LT to lavc/mathops.h
[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;
636f1c4c 43extern AVCodecContext *avcodec_opts[CODEC_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/**
4c97a6fa
SS
54 * Sets the libav* libraries log level.
55 */
56int opt_loglevel(const char *opt, const char *arg);
57
58/**
15067504
DB
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.
60b5a745
SS
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
15067504
DB
68 * @param min the minimum valid accepted value
69 * @param max the maximum valid accepted value
60b5a745
SS
70 */
71double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
72
7542157d
SS
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
bf7e799c
SS
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
7542157d
SS
83 * date
84 *
748061de 85 * @see parse_date()
7542157d
SS
86 */
87int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
88
01310af2
FB
89typedef 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
02d504a7
FB
96#define OPT_VIDEO 0x0010
97#define OPT_AUDIO 0x0020
98#define OPT_GRAB 0x0040
26d4f26b 99#define OPT_INT 0x0080
394c4d77 100#define OPT_FLOAT 0x0100
ae27975d 101#define OPT_SUBTITLE 0x0200
8bbf6db9 102#define OPT_FUNC2 0x0400
ffdf9a1f 103#define OPT_INT64 0x0800
a0b3bcd9 104#define OPT_EXIT 0x1000
ae27975d 105 union {
8bbf6db9 106 void (*func_arg)(const char *); //FIXME passing error code as int return would be nicer then exit() in the func
01310af2
FB
107 int *int_arg;
108 char **str_arg;
1f631450 109 float *float_arg;
8bbf6db9 110 int (*func2_arg)(const char *, const char *);
ffdf9a1f 111 int64_t *int64_arg;
01310af2
FB
112 } u;
113 const char *help;
114 const char *argname;
115} OptionDef;
116
02d504a7 117void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
60a9966e
SS
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 */
127void parse_options(int argc, char **argv, const OptionDef *options,
128 void (* parse_arg_function)(const char*));
129
85663ef3
MN
130void set_context_opts(void *ctx, void *opts_ctx, int flags);
131
01310af2
FB
132void print_error(const char *filename, int err);
133
c5dc6026
SS
134void list_fmts(void (*get_fmt_string)(char *buf, int buf_size, int fmt), int nb_fmts);
135
f35917b2 136/**
15067504
DB
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.
86074ed1 140 */
ea9c581f 141void show_banner(void);
86074ed1
SS
142
143/**
15067504 144 * Prints the version of the program to stdout. The version message
86074ed1
SS
145 * depends on the current versions of the repository and of the libav*
146 * libraries.
86074ed1 147 */
64555bd9 148void show_version(void);
86074ed1
SS
149
150/**
15067504
DB
151 * Prints the license of the program to stdout. The license depends on
152 * the license of the libraries compiled into the program.
f35917b2
SS
153 */
154void show_license(void);
155
ba9880c1
SS
156/**
157 * Prints a listing containing all the formats supported by the
158 * program.
159 */
160void show_formats(void);
161
090b61b2 162/**
8447f0bd
MN
163 * Prints a listing containing all the codecs supported by the
164 * program.
165 */
166void show_codecs(void);
167
168/**
62d75662
SS
169 * Prints a listing containing all the filters supported by the
170 * program.
171 */
172void show_filters(void);
173
174/**
8447f0bd
MN
175 * Prints a listing containing all the bit stream filters supported by the
176 * program.
177 */
178void show_bsfs(void);
179
180/**
181 * Prints a listing containing all the protocols supported by the
182 * program.
183 */
184void show_protocols(void);
185
186/**
3f7bb426
SS
187 * Prints a listing containing all the pixel formats supported by the
188 * program.
189 */
190void show_pix_fmts(void);
191
192/**
090b61b2
SS
193 * Returns a positive value if reads from standard input a line
194 * starting with [yY], otherwise returns 0.
195 */
196int read_yesno(void);
197
5b21bdab 198#endif /* FFMPEG_CMDUTILS_H */