Rename opt_default() so it will not conflict with the one from ffmpeg.c
[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
DB
25#include <inttypes.h>
26
60b5a745 27/**
64555bd9
MN
28 * program name, defined by the program for show_version().
29 */
30extern const char program_name[];
31
32/**
ea9c581f
SS
33 * program birth year, defined by the program for show_banner()
34 */
35extern const int program_birth_year;
36
37/**
15067504
DB
38 * Parses a string and returns its corresponding value as a double.
39 * Exits from the application if the string cannot be correctly
40 * parsed or the corresponding value is invalid.
60b5a745
SS
41 *
42 * @param context the context of the value to be set (e.g. the
43 * corresponding commandline option name)
44 * @param numstr the string to be parsed
45 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
46 * string should be parsed
15067504
DB
47 * @param min the minimum valid accepted value
48 * @param max the maximum valid accepted value
60b5a745
SS
49 */
50double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
51
7542157d
SS
52/**
53 * Parses a string specifying a time and returns its corresponding
54 * value as a number of microseconds. Exits from the application if
55 * the string cannot be correctly parsed.
56 *
57 * @param context the context of the value to be set (e.g. the
58 * corresponding commandline option name)
59 * @param timestr the string to be parsed
60 * @param is_duration a flag which tells how to interpret \p timestr, if
61 * not zero \p timestr is interpreted as a duration, otherwise as a
62 * date
63 *
748061de 64 * @see parse_date()
7542157d
SS
65 */
66int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
67
01310af2
FB
68typedef struct {
69 const char *name;
70 int flags;
71#define HAS_ARG 0x0001
72#define OPT_BOOL 0x0002
73#define OPT_EXPERT 0x0004
74#define OPT_STRING 0x0008
02d504a7
FB
75#define OPT_VIDEO 0x0010
76#define OPT_AUDIO 0x0020
77#define OPT_GRAB 0x0040
26d4f26b 78#define OPT_INT 0x0080
394c4d77 79#define OPT_FLOAT 0x0100
ae27975d 80#define OPT_SUBTITLE 0x0200
8bbf6db9 81#define OPT_FUNC2 0x0400
ffdf9a1f 82#define OPT_INT64 0x0800
a0b3bcd9 83#define OPT_EXIT 0x1000
ae27975d 84 union {
8bbf6db9 85 void (*func_arg)(const char *); //FIXME passing error code as int return would be nicer then exit() in the func
01310af2
FB
86 int *int_arg;
87 char **str_arg;
1f631450 88 float *float_arg;
8bbf6db9 89 int (*func2_arg)(const char *, const char *);
ffdf9a1f 90 int64_t *int64_arg;
01310af2
FB
91 } u;
92 const char *help;
93 const char *argname;
94} OptionDef;
95
02d504a7 96void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
60a9966e
SS
97
98/**
99 * Parses the command line arguments.
100 * @param options Array with the definitions required to interpret every
101 * option of the form: -<option_name> [<argument>]
102 * @param parse_arg_function Name of the function called to process every
103 * argument without a leading option name flag. NULL if such arguments do
104 * not have to be processed.
105 */
106void parse_options(int argc, char **argv, const OptionDef *options,
107 void (* parse_arg_function)(const char*));
108
01310af2
FB
109void print_error(const char *filename, int err);
110
f35917b2 111/**
15067504
DB
112 * Prints the program banner to stderr. The banner contents depend on the
113 * current version of the repository and of the libav* libraries used by
114 * the program.
86074ed1 115 */
ea9c581f 116void show_banner(void);
86074ed1
SS
117
118/**
15067504 119 * Prints the version of the program to stdout. The version message
86074ed1
SS
120 * depends on the current versions of the repository and of the libav*
121 * libraries.
86074ed1 122 */
64555bd9 123void show_version(void);
86074ed1
SS
124
125/**
15067504
DB
126 * Prints the license of the program to stdout. The license depends on
127 * the license of the libraries compiled into the program.
f35917b2
SS
128 */
129void show_license(void);
130
ba9880c1
SS
131/**
132 * Prints a listing containing all the formats supported by the
133 * program.
134 */
135void show_formats(void);
136
5b21bdab 137#endif /* FFMPEG_CMDUTILS_H */