mirror of https://git.ffmpeg.org/ffmpeg.git
124 lines
4.2 KiB
C
124 lines
4.2 KiB
C
/*
|
|
* 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
|
|
*/
|
|
|
|
#ifndef FFMPEG_CMDUTILS_H
|
|
#define FFMPEG_CMDUTILS_H
|
|
|
|
#include <inttypes.h>
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @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
|
|
* @param min the minimum valid accepted value
|
|
* @param max the maximum valid accepted value
|
|
*/
|
|
double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max);
|
|
|
|
/**
|
|
* 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
|
|
* @param is_duration a flag which tells how to interpret \p timestr, if
|
|
* not zero \p timestr is interpreted as a duration, otherwise as a
|
|
* date
|
|
*
|
|
* @see av_parse_date()
|
|
*/
|
|
int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration);
|
|
|
|
typedef struct {
|
|
const char *name;
|
|
int flags;
|
|
#define HAS_ARG 0x0001
|
|
#define OPT_BOOL 0x0002
|
|
#define OPT_EXPERT 0x0004
|
|
#define OPT_STRING 0x0008
|
|
#define OPT_VIDEO 0x0010
|
|
#define OPT_AUDIO 0x0020
|
|
#define OPT_GRAB 0x0040
|
|
#define OPT_INT 0x0080
|
|
#define OPT_FLOAT 0x0100
|
|
#define OPT_SUBTITLE 0x0200
|
|
#define OPT_FUNC2 0x0400
|
|
#define OPT_INT64 0x0800
|
|
union {
|
|
void (*func_arg)(const char *); //FIXME passing error code as int return would be nicer then exit() in the func
|
|
int *int_arg;
|
|
char **str_arg;
|
|
float *float_arg;
|
|
int (*func2_arg)(const char *, const char *);
|
|
int64_t *int64_arg;
|
|
} u;
|
|
const char *help;
|
|
const char *argname;
|
|
} OptionDef;
|
|
|
|
void show_help_options(const OptionDef *options, const char *msg, int mask, int value);
|
|
|
|
/**
|
|
* 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*));
|
|
|
|
void print_error(const char *filename, int err);
|
|
|
|
/**
|
|
* 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.
|
|
* @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 to 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);
|
|
|
|
/**
|
|
* Prints the license of the program to stdout. The license depends on
|
|
* the license of the libraries compiled into the program.
|
|
*/
|
|
void show_license(void);
|
|
|
|
#endif /* FFMPEG_CMDUTILS_H */
|