cmdutils.h
Go to the documentation of this file.
1 /*
2  * Various utilities for command line tools
3  * copyright (c) 2003 Fabrice Bellard
4  *
5  * This file is part of Libav.
6  *
7  * Libav is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * Libav is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 #ifndef LIBAV_CMDUTILS_H
23 #define LIBAV_CMDUTILS_H
24 
25 #include <stdint.h>
26 
27 #include "libavcodec/avcodec.h"
28 #include "libavfilter/avfilter.h"
29 #include "libavformat/avformat.h"
30 #include "libswscale/swscale.h"
31 
35 extern const char program_name[];
36 
40 extern const int program_birth_year;
41 
44 extern struct SwsContext *sws_opts;
46 
51 void init_opts(void);
56 void uninit_opts(void);
57 
62 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
63 
68 int opt_default(const char *opt, const char *arg);
69 
73 int opt_loglevel(const char *opt, const char *arg);
74 
78 int opt_timelimit(const char *opt, const char *arg);
79 
93 double parse_number_or_die(const char *context, const char *numstr, int type,
94  double min, double max);
95 
110 int64_t parse_time_or_die(const char *context, const char *timestr,
111  int is_duration);
112 
113 typedef struct SpecifierOpt {
114  char *specifier;
115  union {
116  uint8_t *str;
117  int i;
118  int64_t i64;
119  float f;
120  double dbl;
121  } u;
122 } SpecifierOpt;
123 
124 typedef struct {
125  const char *name;
126  int flags;
127 #define HAS_ARG 0x0001
128 #define OPT_BOOL 0x0002
129 #define OPT_EXPERT 0x0004
130 #define OPT_STRING 0x0008
131 #define OPT_VIDEO 0x0010
132 #define OPT_AUDIO 0x0020
133 #define OPT_GRAB 0x0040
134 #define OPT_INT 0x0080
135 #define OPT_FLOAT 0x0100
136 #define OPT_SUBTITLE 0x0200
137 #define OPT_INT64 0x0400
138 #define OPT_EXIT 0x0800
139 #define OPT_DATA 0x1000
140 #define OPT_FUNC2 0x2000
141 #define OPT_OFFSET 0x4000 /* option is specified as an offset in a passed optctx */
142 #define OPT_SPEC 0x8000 /* option is to be stored in an array of SpecifierOpt.
143  Implies OPT_OFFSET. Next element after the offset is
144  an int containing element count in the array. */
145 #define OPT_TIME 0x10000
146 #define OPT_DOUBLE 0x20000
147  union {
148  void *dst_ptr;
149  int (*func_arg)(const char *, const char *);
150  int (*func2_arg)(void *, const char *, const char *);
151  size_t off;
152  } u;
153  const char *help;
154  const char *argname;
155 } OptionDef;
156 
157 void show_help_options(const OptionDef *options, const char *msg, int mask,
158  int value);
159 
164 void show_help_children(const AVClass *class, int flags);
165 
176 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
177  void (* parse_arg_function)(void *optctx, const char*));
178 
184 int parse_option(void *optctx, const char *opt, const char *arg,
185  const OptionDef *options);
186 
190 void parse_loglevel(int argc, char **argv, const OptionDef *options);
191 
201 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
202 
214  AVFormatContext *s, AVStream *st);
215 
228  AVDictionary *codec_opts);
229 
239 void print_error(const char *filename, int err);
240 
246 void show_banner(void);
247 
253 void show_version(void);
254 
259 void show_license(void);
260 
265 void show_formats(void);
266 
271 void show_codecs(void);
272 
277 void show_filters(void);
278 
283 void show_bsfs(void);
284 
289 void show_protocols(void);
290 
295 void show_pix_fmts(void);
296 
301 int show_sample_fmts(const char *opt, const char *arg);
302 
307 int read_yesno(void);
308 
318 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
319 
320 typedef struct {
321  int64_t num_faulty_pts;
322  int64_t num_faulty_dts;
323  int64_t last_pts;
324  int64_t last_dts;
326 
331 
342 int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts);
343 
361 FILE *get_preset_file(char *filename, size_t filename_size,
362  const char *preset_name, int is_path, const char *codec_name);
363 
364 typedef struct {
366 } AVSinkContext;
367 
368 extern AVFilter avsink;
369 
377  AVFilterBufferRef **picref, AVRational *pts_tb);
378 
383 void exit_program(int ret);
384 
393 void *grow_array(void *array, int elem_size, int *size, int new_size);
394 
395 #endif /* LIBAV_CMDUTILS_H */
int64_t num_faulty_dts
Number of incorrect PTS values so far.
Definition: cmdutils.h:322
int size
Audio Video Frame.
Definition: avcodec.h:985
int64_t num_faulty_pts
Definition: cmdutils.h:321
int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec)
Check if the given stream matches a stream specifier.
Definition: cmdutils.c:909
enum PixelFormat pix_fmt
Definition: v4l.c:65
double dbl
Definition: cmdutils.h:120
AVCodecContext * avcodec_opts[AVMEDIA_TYPE_NB]
int64_t last_pts
Number of incorrect DTS values so far.
Definition: cmdutils.h:323
void show_bsfs(void)
Print a listing containing all the bit stream filters supported by the program.
Definition: cmdutils.c:724
Format I/O context.
Definition: avformat.h:863
AVDictionary * format_opts
Definition: cmdutils.c:56
double parse_number_or_die(const char *context, const char *numstr, int type, double min, double max)
Parse a string and return its corresponding value as a double.
Definition: cmdutils.c:83
void show_version(void)
Print the version of the program to stdout.
Definition: cmdutils.c:525
void parse_loglevel(int argc, char **argv, const OptionDef *options)
Find the '-loglevel' option in the command line args and apply it.
Definition: cmdutils.c:357
static int flags
Definition: log.c:34
AVFilter avsink
external api for the swscale stuff
void uninit_opts(void)
Uninitialize the cmdutils option system, in particular free the *_opts contexts and their contents...
Definition: cmdutils.c:68
enum CodecID codec_id
Definition: mov_chan.c:417
static const uint16_t mask[17]
Definition: lzw.c:36
struct SwsContext * sws_opts
Definition: cmdutils.c:55
void init_opts(void)
Initialize the cmdutils option system, in particular allocate the *_opts contexts.
Definition: cmdutils.c:60
const char * name
Definition: cmdutils.h:125
int flags
Definition: cmdutils.h:126
const int program_birth_year
program birth year, defined by the program for show_banner()
Definition: avconv.c:85
AVDictionary ** setup_find_stream_info_opts(AVFormatContext *s, AVDictionary *codec_opts)
Setup AVCodecContext options for avformat_find_stream_info().
Definition: cmdutils.c:1019
size_t off
Definition: cmdutils.h:151
void init_pts_correction(PtsCorrectionContext *ctx)
Reset the state of the PtsCorrectionContext.
Definition: cmdutils.c:848
AVDictionary * filter_codec_opts(AVDictionary *opts, enum CodecID codec_id, AVFormatContext *s, AVStream *st)
Filter out options for given codec.
Definition: cmdutils.c:962
int64_t i64
Definition: cmdutils.h:118
union SpecifierOpt::@1 u
FILE * get_preset_file(char *filename, size_t filename_size, const char *preset_name, int is_path, const char *codec_name)
Get a file corresponding to a preset file.
Definition: cmdutils.c:876
int opt_loglevel(const char *opt, const char *arg)
Set the libav* libraries log level.
Definition: cmdutils.c:407
int parse_option(void *optctx, const char *opt, const char *arg, const OptionDef *options)
Parse one given option.
Definition: cmdutils.c:224
char * specifier
stream/chapter/program/...
Definition: cmdutils.h:114
void show_filters(void)
Print a listing containing all the filters supported by the program.
Definition: cmdutils.c:748
int opt_default(const char *opt, const char *arg)
Fallback for options that are not explicitly handled, these will be parsed through AVOptions...
Definition: cmdutils.c:367
void * dst_ptr
Definition: cmdutils.h:148
void show_banner(void)
Print the program banner to stderr.
Definition: cmdutils.c:513
void show_help_options(const OptionDef *options, const char *msg, int mask, int value)
Definition: cmdutils.c:116
uint8_t * str
Definition: cmdutils.h:116
Stream structure.
Definition: avformat.h:620
A reference to an AVFilterBuffer.
Definition: avfilter.h:124
external API header
const char * help
Definition: cmdutils.h:153
static const OptionDef options[]
Definition: avconv.c:105
main external API structure.
Definition: avcodec.h:1329
int64_t parse_time_or_die(const char *context, const char *timestr, int is_duration)
Parse a string specifying a time and return its corresponding value as a number of microseconds...
Definition: cmdutils.c:104
AVDictionary * codec_opts
Definition: cmdutils.c:56
int get_filtered_video_frame(AVFilterContext *sink, AVFrame *frame, AVFilterBufferRef **picref, AVRational *pts_tb)
Extract a frame from sink.
Describe the class of an AVClass context structure.
Definition: log.h:33
Filter definition.
Definition: avfilter.h:497
rational number numerator/denominator
Definition: rational.h:43
const char * argname
Definition: cmdutils.h:154
int cmdutils_read_file(const char *filename, char **bufptr, size_t *size)
Read the file with name filename, and put its content in a newly allocated 0-terminated buffer...
Definition: cmdutils.c:811
struct SpecifierOpt SpecifierOpt
int64_t last_dts
PTS of the last frame.
Definition: cmdutils.h:324
void show_license(void)
Print the license of the program to stdout.
Definition: cmdutils.c:531
void show_formats(void)
Print a listing containing all the formats supported by the program.
Definition: cmdutils.c:600
uint8_t level
Definition: svq3.c:123
void parse_options(void *optctx, int argc, char **argv, const OptionDef *options, void(*parse_arg_function)(void *optctx, const char *))
Parse the command line arguments.
void show_protocols(void)
Print a listing containing all the protocols supported by the program.
Definition: cmdutils.c:734
PixelFormat
Pixel format.
Definition: pixfmt.h:62
Main libavformat public API header.
int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts)
Attempt to guess proper monotonic timestamps for decoded video frames which might have incorrect time...
Definition: cmdutils.c:854
int show_sample_fmts(const char *opt, const char *arg)
Print a listing containing all the sample formats supported by the program.
Definition: cmdutils.c:791
AVFormatContext * avformat_opts
void * grow_array(void *array, int elem_size, int *size, int new_size)
Realloc array to hold new_size elements of elem_size.
Definition: cmdutils.c:1105
CodecID
Identify the syntax and semantics of the bitstream.
Definition: avcodec.h:83
void show_help_children(const AVClass *class, int flags)
Show help for all options with given flags in class and all its children.
Definition: cmdutils.c:140
void show_codecs(void)
Print a listing containing all the codecs supported by the program.
Definition: cmdutils.c:647
void show_pix_fmts(void)
Print a listing containing all the pixel formats supported by the program.
Definition: cmdutils.c:759
An instance of a filter.
Definition: avfilter.h:538
void exit_program(int ret)
Do all the necessary cleanup and abort.
Definition: avconv.c:663
void log_callback_help(void *ptr, int level, const char *fmt, va_list vl)
Trivial log callback.
Definition: cmdutils.c:78
void print_error(const char *filename, int err)
Print an error message to stderr, indicating filename and a human readable description of the error c...
Definition: cmdutils.c:455
int opt_timelimit(const char *opt, const char *arg)
Limit the execution time.
Definition: cmdutils.c:442
float min
int read_yesno(void)
Return a positive value if a line read from standard input starts with [yY], otherwise return 0...
Definition: cmdutils.c:800
const char program_name[]
program name, defined by the program for show_version().
Definition: avconv.c:84