cmdutils.h File Reference

#include <inttypes.h>
#include "libavcodec/avcodec.h"
#include "libavformat/avformat.h"
#include "libswscale/swscale.h"

Go to the source code of this file.

Data Structures

struct  OptionDef

Defines

#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
#define OPT_EXIT   0x1000

Functions

int opt_default (const char *opt, const char *arg)
 Fallback for options that are not explicitly handled, these will be parsed through AVOptions.
double parse_number_or_die (const char *context, const char *numstr, int type, double min, double max)
 Parses a string and returns its corresponding value as a double.
int64_t parse_time_or_die (const char *context, const char *timestr, int is_duration)
 Parses a string specifying a time and returns its corresponding value as a number of microseconds.
void show_help_options (const OptionDef *options, const char *msg, int mask, int value)
void parse_options (int argc, char **argv, const OptionDef *options, void(*parse_arg_function)(const char *))
 Parses the command line arguments.
void set_context_opts (void *ctx, void *opts_ctx, int flags)
void print_error (const char *filename, int err)
void show_banner (void)
 Prints the program banner to stderr.
void show_version (void)
 Prints the version of the program to stdout.
void show_license (void)
 Prints the license of the program to stdout.
void show_formats (void)
 Prints a listing containing all the formats supported by the program.

Variables

const char program_name []
 program name, defined by the program for show_version().
const int program_birth_year
 program birth year, defined by the program for show_banner()
const int this_year
const char ** opt_names
AVCodecContextavctx_opts [CODEC_TYPE_NB]
AVFormatContextavformat_opts
struct SwsContextsws_opts


Define Documentation

#define HAS_ARG   0x0001

Definition at line 87 of file cmdutils.h.

Referenced by parse_options(), and show_help_options().

#define OPT_AUDIO   0x0020

Definition at line 92 of file cmdutils.h.

Referenced by show_help().

#define OPT_BOOL   0x0002

Definition at line 88 of file cmdutils.h.

Referenced by parse_options().

#define OPT_EXIT   0x1000

Definition at line 99 of file cmdutils.h.

Referenced by parse_options().

#define OPT_EXPERT   0x0004

Definition at line 89 of file cmdutils.h.

Referenced by show_help().

#define OPT_FLOAT   0x0100

Definition at line 95 of file cmdutils.h.

Referenced by parse_options().

#define OPT_FUNC2   0x0400

Definition at line 97 of file cmdutils.h.

Referenced by parse_options().

#define OPT_GRAB   0x0040

Definition at line 93 of file cmdutils.h.

Referenced by show_help().

#define OPT_INT   0x0080

Definition at line 94 of file cmdutils.h.

Referenced by parse_options().

#define OPT_INT64   0x0800

#define OPT_STRING   0x0008

Definition at line 90 of file cmdutils.h.

Referenced by parse_options().

#define OPT_SUBTITLE   0x0200

Definition at line 96 of file cmdutils.h.

Referenced by show_help().

#define OPT_VIDEO   0x0010

Definition at line 91 of file cmdutils.h.

Referenced by show_help().


Function Documentation

int opt_default ( const char *  opt,
const char *  arg 
)

Fallback for options that are not explicitly handled, these will be parsed through AVOptions.

Definition at line 175 of file cmdutils.c.

Referenced by opt_bitrate(), opt_preset(), and opt_target().

double parse_number_or_die ( const char *  context,
const char *  numstr,
int  type,
double  min,
double  max 
)

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.

Parameters:
context the context of the value to be set (e.g. the corresponding commandline option name)
numstr the string to be parsed
type the type (OPT_INT64 or OPT_FLOAT) as which the string should be parsed
min the minimum valid accepted value
max the maximum valid accepted value

Definition at line 55 of file cmdutils.c.

Referenced by opt_audio_channels(), opt_audio_rate(), opt_debug(), opt_height(), opt_me_threshold(), opt_thread_count(), opt_verbose(), opt_vismv(), opt_width(), and parse_options().

void parse_options ( int  argc,
char **  argv,
const OptionDef options,
void(*)(const char *)  parse_arg_function 
)

Parses the command line arguments.

Parameters:
options Array with the definitions required to interpret every option of the form: -<option_name> [<argument>]
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.

Definition at line 115 of file cmdutils.c.

Referenced by main().

int64_t parse_time_or_die ( const char *  context,
const char *  timestr,
int  is_duration 
)

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.

Parameters:
context the context of the value to be set (e.g. the corresponding commandline option name)
timestr the string to be parsed
is_duration a flag which tells how to interpret timestr, if not zero timestr is interpreted as a duration, otherwise as a date
See also:
parse_date()

Definition at line 72 of file cmdutils.c.

Referenced by opt_input_ts_offset(), opt_rec_timestamp(), opt_recording_time(), opt_seek(), and opt_start_time().

void print_error ( const char *  filename,
int  err 
)

Definition at line 229 of file cmdutils.c.

Referenced by decode_thread(), opt_input_file(), opt_output_file(), and write_frame().

void set_context_opts ( void *  ctx,
void *  opts_ctx,
int  flags 
)

void show_banner ( void   ) 

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.

Definition at line 291 of file cmdutils.c.

Referenced by main().

void show_formats ( void   ) 

Prints a listing containing all the formats supported by the program.

Definition at line 379 of file cmdutils.c.

void show_help_options ( const OptionDef options,
const char *  msg,
int  mask,
int  value 
)

Definition at line 83 of file cmdutils.c.

Referenced by opt_show_help(), and show_help().

void show_license ( void   ) 

Prints the license of the program to stdout.

The license depends on the license of the libraries compiled into the program.

Definition at line 310 of file cmdutils.c.

void show_version ( void   ) 

Prints the version of the program to stdout.

The version message depends on the current versions of the repository and of the libav* libraries.

Definition at line 305 of file cmdutils.c.


Variable Documentation

AVCodecContext* avctx_opts[CODEC_TYPE_NB]

Definition at line 50 of file cmdutils.c.

Referenced by main(), opt_input_file(), opt_output_file(), and show_help().

const char** opt_names

Definition at line 47 of file cmdutils.c.

Referenced by av_exit(), opt_default(), and set_context_opts().

const int program_birth_year

program birth year, defined by the program for show_banner()

Definition at line 74 of file ffmpeg.c.

Referenced by show_banner().

const char program_name[]

program name, defined by the program for show_version().

Definition at line 73 of file ffmpeg.c.

Referenced by compute_status(), show_banner(), show_license(), and show_version().

Definition at line 51 of file cmdutils.c.

Referenced by av_encode(), main(), queue_picture(), and show_help().

const int this_year

Definition at line 53 of file cmdutils.c.

Referenced by show_banner().


Generated on Fri Oct 26 02:35:42 2012 for FFmpeg by  doxygen 1.5.8