cmdutils.h 2.96 KB
Newer Older
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 26
#include <inttypes.h>

Fabrice Bellard's avatar
Fabrice Bellard committed
27 28 29 30 31 32 33
typedef struct {
    const char *name;
    int flags;
#define HAS_ARG    0x0001
#define OPT_BOOL   0x0002
#define OPT_EXPERT 0x0004
#define OPT_STRING 0x0008
34 35 36
#define OPT_VIDEO  0x0010
#define OPT_AUDIO  0x0020
#define OPT_GRAB   0x0040
Michael Niedermayer's avatar
Michael Niedermayer committed
37
#define OPT_INT    0x0080
38
#define OPT_FLOAT  0x0100
Fabrice Bellard's avatar
Fabrice Bellard committed
39
#define OPT_SUBTITLE 0x0200
40
#define OPT_FUNC2  0x0400
41
#define OPT_INT64  0x0800
Fabrice Bellard's avatar
Fabrice Bellard committed
42
     union {
43
        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
44 45
        int *int_arg;
        char **str_arg;
Michael Niedermayer's avatar
Michael Niedermayer committed
46
        float *float_arg;
47
        int (*func2_arg)(const char *, const char *);
48
        int64_t *int64_arg;
Fabrice Bellard's avatar
Fabrice Bellard committed
49 50 51 52 53
    } u;
    const char *help;
    const char *argname;
} OptionDef;

54
void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
55 56 57 58 59 60 61 62 63 64 65 66

/**
 * 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*));

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

69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
/**
 * Prints the banner of the program on stderr. The banner message
 * depends on the current versions of the repository and of the libav*
 * libraries.
 * @param program_name Name of the program.
 * @param program_birth_year Year of birth of the program.
 */
void show_banner(const char *program_name, int program_birth_year);

/**
 * Prints the version of the program on stdout. The version message
 * depends on the current versions of the repository and of the libav*
 * libraries.
 * @param program_name Name of the program.
 */
void show_version(const char *program_name);

86 87 88 89 90 91
/**
 * Prints on stdout the license of the program, which depends on the license of
 * the compiled libav* libraries.
 */
void show_license(void);

92
#endif /* FFMPEG_CMDUTILS_H */