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