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