f5a90186 |
/*
* 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
*/
|
5b21bdab |
#ifndef FFMPEG_CMDUTILS_H
#define FFMPEG_CMDUTILS_H |
01310af2 |
|
ea91e771 |
#include <stdint.h>
|
95137bbb |
#include "libavcodec/avcodec.h" |
ea91e771 |
#include "libavfilter/avfilter.h" |
95137bbb |
#include "libavformat/avformat.h"
#include "libswscale/swscale.h" |
f0a838e5 |
|
25c32d08 |
#ifdef __MINGW32__
#undef main /* We don't want SDL to override our main() */
#endif
|
60b5a745 |
/** |
64555bd9 |
* program name, defined by the program for show_version().
*/
extern const char program_name[];
/** |
ea9c581f |
* program birth year, defined by the program for show_banner()
*/
extern const int program_birth_year;
|
e869d08c |
/**
* this year, defined by the program for show_banner()
*/
extern const int this_year;
|
72415b2a |
extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB]; |
85663ef3 |
extern AVFormatContext *avformat_opts;
extern struct SwsContext *sws_opts; |
8c8eab8b |
extern AVDictionary *format_opts, *codec_opts; |
85663ef3 |
/** |
a5c33faa |
* Initialize the cmdutils option system, in particular
* allocate the *_opts contexts.
*/
void init_opts(void);
/**
* Uninitialize the cmdutils option system, in particular
* free the *_opts contexts and their contents.
*/
void uninit_opts(void);
/** |
1790d3b3 |
* Trivial log callback. |
a0991833 |
* Only suitable for opt_help and similar since it lacks prefix handling. |
1790d3b3 |
*/
void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
/** |
b7438896 |
* Fallback for options that are not explicitly handled, these will be |
85663ef3 |
* parsed through AVOptions.
*/
int opt_default(const char *opt, const char *arg);
|
ea9c581f |
/** |
49bd8e4b |
* Set the libav* libraries log level. |
4c97a6fa |
*/
int opt_loglevel(const char *opt, const char *arg);
|
337ce558 |
int opt_report(const char *opt);
|
c48f67f0 |
int opt_max_alloc(const char *opt, const char *arg);
|
e9adeeec |
int opt_codec_debug(const char *opt, const char *arg);
|
4c97a6fa |
/** |
ffcc6e24 |
* Limit the execution time.
*/
int opt_timelimit(const char *opt, const char *arg);
/** |
49bd8e4b |
* Parse a string and return its corresponding value as a double.
* Exit from the application if the string cannot be correctly |
15067504 |
* parsed or the corresponding value is invalid. |
60b5a745 |
*
* @param context the context of the value to be set (e.g. the |
da9cea77 |
* corresponding command line option name) |
60b5a745 |
* @param numstr the string to be parsed
* @param type the type (OPT_INT64 or OPT_FLOAT) as which the
* string should be parsed |
15067504 |
* @param min the minimum valid accepted value
* @param max the maximum valid accepted value |
60b5a745 |
*/ |
0184bbe2 |
double parse_number_or_die(const char *context, const char *numstr, int type,
double min, double max); |
60b5a745 |
|
7542157d |
/** |
49bd8e4b |
* Parse a string specifying a time and return its corresponding
* value as a number of microseconds. Exit from the application if |
7542157d |
* the string cannot be correctly parsed.
*
* @param context the context of the value to be set (e.g. the |
da9cea77 |
* corresponding command line option name) |
7542157d |
* @param timestr the string to be parsed |
bf7e799c |
* @param is_duration a flag which tells how to interpret timestr, if
* not zero timestr is interpreted as a duration, otherwise as a |
7542157d |
* date
* |
748061de |
* @see parse_date() |
7542157d |
*/ |
0184bbe2 |
int64_t parse_time_or_die(const char *context, const char *timestr,
int is_duration); |
7542157d |
|
6361c5e1 |
typedef struct SpecifierOpt {
char *specifier; /**< stream/chapter/program/... specifier */
union {
uint8_t *str;
int i;
int64_t i64;
float f; |
33f75d72 |
double dbl; |
6361c5e1 |
} u;
} SpecifierOpt;
|
01310af2 |
typedef struct {
const char *name;
int flags;
#define HAS_ARG 0x0001
#define OPT_BOOL 0x0002
#define OPT_EXPERT 0x0004
#define OPT_STRING 0x0008 |
02d504a7 |
#define OPT_VIDEO 0x0010
#define OPT_AUDIO 0x0020
#define OPT_GRAB 0x0040 |
26d4f26b |
#define OPT_INT 0x0080 |
394c4d77 |
#define OPT_FLOAT 0x0100 |
ae27975d |
#define OPT_SUBTITLE 0x0200 |
eb8bc572 |
#define OPT_INT64 0x0400
#define OPT_EXIT 0x0800
#define OPT_DATA 0x1000 |
7cc8d638 |
#define OPT_FUNC2 0x2000
#define OPT_OFFSET 0x4000 /* option is specified as an offset in a passed optctx */ |
6361c5e1 |
#define OPT_SPEC 0x8000 /* option is to be stored in an array of SpecifierOpt.
Implies OPT_OFFSET. Next element after the offset is
an int containing element count in the array. */ |
6b779ccc |
#define OPT_TIME 0x10000 |
33f75d72 |
#define OPT_DOUBLE 0x20000 |
ae27975d |
union { |
7efe05ab |
void *dst_ptr; |
eb8bc572 |
int (*func_arg)(const char *, const char *); |
7cc8d638 |
int (*func2_arg)(void *, const char *, const char *);
size_t off; |
01310af2 |
} u;
const char *help;
const char *argname;
} OptionDef;
|
0184bbe2 |
void show_help_options(const OptionDef *options, const char *msg, int mask,
int value); |
60a9966e |
/** |
7a6cd995 |
* Show help for all options with given flags in class and all its
* children.
*/
void show_help_children(const AVClass *class, int flags);
/** |
49bd8e4b |
* Parse the command line arguments. |
7cc8d638 |
*
* @param optctx an opaque options context |
60a9966e |
* @param options Array with the definitions required to interpret every |
0baf34d8 |
* option of the form: -option_name [argument] |
60a9966e |
* @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.
*/ |
7cc8d638 |
void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
void (* parse_arg_function)(void *optctx, const char*)); |
60a9966e |
|
8d787f8e |
/** |
2f8e586d |
* Parse one given option.
*
* @return on success 1 if arg was consumed, 0 otherwise; negative number on error
*/ |
0184bbe2 |
int parse_option(void *optctx, const char *opt, const char *arg,
const OptionDef *options); |
60a9966e |
|
8d787f8e |
/** |
da9cea77 |
* Find the '-loglevel' option in the command line args and apply it. |
182cbe43 |
*/
void parse_loglevel(int argc, char **argv, const OptionDef *options);
/** |
d4863fc1 |
* Check if the given stream matches a stream specifier.
*
* @param s Corresponding format context.
* @param st Stream from s to be checked. |
e873c03a |
* @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form. |
d4863fc1 |
*
* @return 1 if the stream matches, 0 if it doesn't, <0 on error
*/
int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
/** |
8c8eab8b |
* Filter out options for given codec. |
ce23ca81 |
*
* Create a new options dictionary containing only the options from
* opts which apply to the codec with ID codec_id.
* |
d4863fc1 |
* @param s Corresponding format context.
* @param st A stream from s for which the options should be filtered. |
ce23ca81 |
* @return a pointer to the created dictionary |
8c8eab8b |
*/ |
c130428a |
AVDictionary *filter_codec_opts(AVDictionary *opts, AVCodec *codec, |
0184bbe2 |
AVFormatContext *s, AVStream *st); |
8c8eab8b |
|
7cea06d1 |
/**
* Setup AVCodecContext options for avformat_find_stream_info().
*
* Create an array of dictionaries, one dictionary for each stream
* contained in s.
* Each dictionary will contain the options from codec_opts which can
* be applied to the corresponding stream codec context.
*
* @return pointer to the created array of dictionaries, NULL if it
* cannot be created |
3009f521 |
*/ |
0184bbe2 |
AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
AVDictionary *codec_opts); |
85663ef3 |
|
8d787f8e |
/** |
49bd8e4b |
* Print an error message to stderr, indicating filename and a human |
8d787f8e |
* readable description of the error code err.
*
* If strerror_r() is not available the use of this function in a
* multithreaded application may be unsafe.
*
* @see av_strerror()
*/ |
01310af2 |
void print_error(const char *filename, int err);
|
f35917b2 |
/** |
49bd8e4b |
* Print the program banner to stderr. The banner contents depend on the |
15067504 |
* current version of the repository and of the libav* libraries used by
* the program. |
86074ed1 |
*/ |
452406bd |
void show_banner(int argc, char **argv, const OptionDef *options); |
86074ed1 |
/** |
49bd8e4b |
* Print the version of the program to stdout. The version message |
86074ed1 |
* depends on the current versions of the repository and of the libav*
* libraries. |
a0991833 |
* This option processing function does not utilize the arguments. |
86074ed1 |
*/ |
a0991833 |
int opt_version(const char *opt, const char *arg); |
86074ed1 |
/** |
49bd8e4b |
* Print the license of the program to stdout. The license depends on |
15067504 |
* the license of the libraries compiled into the program. |
a0991833 |
* This option processing function does not utilize the arguments. |
f35917b2 |
*/ |
a0991833 |
int opt_license(const char *opt, const char *arg); |
f35917b2 |
|
ba9880c1 |
/** |
49bd8e4b |
* Print a listing containing all the formats supported by the |
ba9880c1 |
* program. |
a0991833 |
* This option processing function does not utilize the arguments. |
ba9880c1 |
*/ |
a0991833 |
int opt_formats(const char *opt, const char *arg); |
ba9880c1 |
|
090b61b2 |
/** |
49bd8e4b |
* Print a listing containing all the codecs supported by the |
8447f0bd |
* program. |
a0991833 |
* This option processing function does not utilize the arguments. |
8447f0bd |
*/ |
a0991833 |
int opt_codecs(const char *opt, const char *arg); |
8447f0bd |
/** |
49bd8e4b |
* Print a listing containing all the filters supported by the |
62d75662 |
* program. |
a0991833 |
* This option processing function does not utilize the arguments. |
62d75662 |
*/ |
a0991833 |
int opt_filters(const char *opt, const char *arg); |
62d75662 |
/** |
49bd8e4b |
* Print a listing containing all the bit stream filters supported by the |
8447f0bd |
* program. |
a0991833 |
* This option processing function does not utilize the arguments. |
8447f0bd |
*/ |
a0991833 |
int opt_bsfs(const char *opt, const char *arg); |
8447f0bd |
/** |
49bd8e4b |
* Print a listing containing all the protocols supported by the |
8447f0bd |
* program. |
a0991833 |
* This option processing function does not utilize the arguments. |
8447f0bd |
*/ |
a0991833 |
int opt_protocols(const char *opt, const char *arg); |
8447f0bd |
/** |
49bd8e4b |
* Print a listing containing all the pixel formats supported by the |
3f7bb426 |
* program. |
a0991833 |
* This option processing function does not utilize the arguments. |
3f7bb426 |
*/ |
a0991833 |
int opt_pix_fmts(const char *opt, const char *arg); |
3f7bb426 |
/** |
05bffc12 |
* Print a listing containing all the sample formats supported by the
* program.
*/
int show_sample_fmts(const char *opt, const char *arg); |
3f7bb426 |
/** |
48966b02 |
* Return a positive value if a line read from standard input
* starts with [yY], otherwise return 0. |
090b61b2 |
*/
int read_yesno(void);
|
458b062d |
/** |
49bd8e4b |
* Read the file with name filename, and put its content in a newly |
458b062d |
* allocated 0-terminated buffer.
* |
49bd8e4b |
* @param bufptr location where pointer to buffer is returned
* @param size location where size of buffer is returned |
458b062d |
* @return 0 in case of success, a negative value corresponding to an
* AVERROR error code in case of failure.
*/ |
02170990 |
int cmdutils_read_file(const char *filename, char **bufptr, size_t *size); |
458b062d |
|
6e872935 |
/**
* Get a file corresponding to a preset file.
*
* If is_path is non-zero, look for the file in the path preset_name.
* Otherwise search for a file named arg.ffpreset in the directories
* $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined |
1b30e4f5 |
* at configuration time or in a "ffpresets" folder along the executable
* on win32, in that order. If no such file is found and |
6e872935 |
* codec_name is defined, then search for a file named
* codec_name-preset_name.ffpreset in the above-mentioned directories.
*
* @param filename buffer where the name of the found filename is written
* @param filename_size size in bytes of the filename buffer
* @param preset_name name of the preset to search
* @param is_path tell if preset_name is a filename path
* @param codec_name name of the codec for which to look for the
* preset, may be NULL
*/
FILE *get_preset_file(char *filename, size_t filename_size,
const char *preset_name, int is_path, const char *codec_name);
|
dad09ff9 |
/**
* Do all the necessary cleanup and abort.
* This function is implemented in the avtools, not cmdutils.
*/
void exit_program(int ret);
|
cac651c8 |
/**
* Realloc array to hold new_size elements of elem_size.
* Calls exit_program() on failure.
*
* @param elem_size size in bytes of each element
* @param size new element count will be written here
* @return reallocated array
*/
void *grow_array(void *array, int elem_size, int *size, int new_size);
|
90705aab |
#endif /* CMDUTILS_H */ |