cmdutils.h 4.94 KB
Newer Older
Diego Biurrun's avatar
Diego Biurrun committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 * Various utilities for command line tools
 * copyright (c) 2003 Fabrice Bellard
 *
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

22 23
#ifndef FFMPEG_CMDUTILS_H
#define FFMPEG_CMDUTILS_H
Fabrice Bellard's avatar
Fabrice Bellard committed
24

25
#include <inttypes.h>
26 27 28
#include "libavcodec/avcodec.h"
#include "libavformat/avformat.h"
#include "libswscale/swscale.h"
29

30 31 32 33 34
/**
 * program name, defined by the program for show_version().
 */
extern const char program_name[];

35 36 37 38 39
/**
 * program birth year, defined by the program for show_banner()
 */
extern const int program_birth_year;

40 41
extern const int this_year;

42
extern const char **opt_names;
43
extern AVCodecContext *avcodec_opts[CODEC_TYPE_NB];
44 45 46 47
extern AVFormatContext *avformat_opts;
extern struct SwsContext *sws_opts;

/**
48
 * Fallback for options that are not explicitly handled, these will be
49 50 51 52
 * parsed through AVOptions.
 */
int opt_default(const char *opt, const char *arg);

53
/**
54 55 56
 * Parses a string and returns its corresponding value as a double.
 * Exits from the application if the string cannot be correctly
 * parsed or the corresponding value is invalid.
57 58 59 60 61 62
 *
 * @param context the context of the value to be set (e.g. the
 * corresponding commandline option name)
 * @param numstr the string to be parsed
 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
 * string should be parsed
63 64
 * @param min the minimum valid accepted value
 * @param max the maximum valid accepted value
65 66 67
 */
double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);

68 69 70 71 72 73 74 75
/**
 * Parses a string specifying a time and returns its corresponding
 * value as a number of microseconds. Exits from the application if
 * the string cannot be correctly parsed.
 *
 * @param context the context of the value to be set (e.g. the
 * corresponding commandline option name)
 * @param timestr the string to be parsed
76 77
 * @param is_duration a flag which tells how to interpret timestr, if
 * not zero timestr is interpreted as a duration, otherwise as a
78 79
 * date
 *
Stefano Sabatini's avatar
Typo  
Stefano Sabatini committed
80
 * @see parse_date()
81 82 83
 */
int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);

Fabrice Bellard's avatar
Fabrice Bellard committed
84 85 86 87 88 89 90
typedef struct {
    const char *name;
    int flags;
#define HAS_ARG    0x0001
#define OPT_BOOL   0x0002
#define OPT_EXPERT 0x0004
#define OPT_STRING 0x0008
91 92 93
#define OPT_VIDEO  0x0010
#define OPT_AUDIO  0x0020
#define OPT_GRAB   0x0040
Michael Niedermayer's avatar
OPT_INT  
Michael Niedermayer committed
94
#define OPT_INT    0x0080
Michael Niedermayer's avatar
Michael Niedermayer committed
95
#define OPT_FLOAT  0x0100
Fabrice Bellard's avatar
Fabrice Bellard committed
96
#define OPT_SUBTITLE 0x0200
Michael Niedermayer's avatar
Michael Niedermayer committed
97
#define OPT_FUNC2  0x0400
Baptiste Coudurier's avatar
Baptiste Coudurier committed
98
#define OPT_INT64  0x0800
Michael Niedermayer's avatar
Michael Niedermayer committed
99
#define OPT_EXIT   0x1000
Fabrice Bellard's avatar
Fabrice Bellard committed
100
     union {
Michael Niedermayer's avatar
Michael Niedermayer committed
101
        void (*func_arg)(const char *); //FIXME passing error code as int return would be nicer then exit() in the func
Fabrice Bellard's avatar
Fabrice Bellard committed
102 103
        int *int_arg;
        char **str_arg;
Michael Niedermayer's avatar
Michael Niedermayer committed
104
        float *float_arg;
Michael Niedermayer's avatar
Michael Niedermayer committed
105
        int (*func2_arg)(const char *, const char *);
Baptiste Coudurier's avatar
Baptiste Coudurier committed
106
        int64_t *int64_arg;
Fabrice Bellard's avatar
Fabrice Bellard committed
107 108 109 110 111
    } u;
    const char *help;
    const char *argname;
} OptionDef;

112
void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
113 114 115 116 117 118 119 120 121 122 123 124

/**
 * Parses the command line arguments.
 * @param options Array with the definitions required to interpret every
 * option of the form: -<option_name> [<argument>]
 * @param parse_arg_function Name of the function called to process every
 * argument without a leading option name flag. NULL if such arguments do
 * not have to be processed.
 */
void parse_options(int argc, char **argv, const OptionDef *options,
                   void (* parse_arg_function)(const char*));

125 126
void set_context_opts(void *ctx, void *opts_ctx, int flags);

Fabrice Bellard's avatar
Fabrice Bellard committed
127 128
void print_error(const char *filename, int err);

129
/**
130 131 132
 * Prints the program banner to stderr. The banner contents depend on the
 * current version of the repository and of the libav* libraries used by
 * the program.
133
 */
134
void show_banner(void);
135 136

/**
137
 * Prints the version of the program to stdout. The version message
138 139 140
 * depends on the current versions of the repository and of the libav*
 * libraries.
 */
141
void show_version(void);
142

143
/**
144 145
 * Prints the license of the program to stdout. The license depends on
 * the license of the libraries compiled into the program.
146 147 148
 */
void show_license(void);

149 150 151 152 153 154
/**
 * Prints a listing containing all the formats supported by the
 * program.
 */
void show_formats(void);

Stefano Sabatini's avatar
Stefano Sabatini committed
155 156 157 158 159 160
/**
 * Returns a positive value if reads from standard input a line
 * starting with [yY], otherwise returns 0.
 */
int read_yesno(void);

161
#endif /* FFMPEG_CMDUTILS_H */