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 32/** 33 * program name, defined by the program for show_version(). 34 */ 35extern const char program_name[]; 36 37/** 38 * program birth year, defined by the program for show_banner() 39 */ 40extern const int program_birth_year; 41 42extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB]; 43extern AVFormatContext *avformat_opts; 44extern struct SwsContext *sws_opts; 45extern AVDictionary *format_opts, *codec_opts; 46 47/** 48 * Initialize the cmdutils option system, in particular 49 * allocate the *_opts contexts. 50 */ 51void init_opts(void); 52/** 53 * Uninitialize the cmdutils option system, in particular 54 * free the *_opts contexts and their contents. 55 */ 56void uninit_opts(void); 57 58/** 59 * Trivial log callback. 60 * Only suitable for show_help and similar since it lacks prefix handling. 61 */ 62void log_callback_help(void* ptr, int level, const char* fmt, va_list vl); 63 64/** 65 * Fallback for options that are not explicitly handled, these will be 66 * parsed through AVOptions. 67 */ 68int opt_default(const char *opt, const char *arg); 69 70/** 71 * Set the libav* libraries log level. 72 */ 73int opt_loglevel(const char *opt, const char *arg); 74 75/** 76 * Limit the execution time. 77 */ 78int opt_timelimit(const char *opt, const char *arg); 79 80/** 81 * Parse a string and return its corresponding value as a double. 82 * Exit from the application if the string cannot be correctly 83 * parsed or the corresponding value is invalid. 84 * 85 * @param context the context of the value to be set (e.g. the 86 * corresponding command line option name) 87 * @param numstr the string to be parsed 88 * @param type the type (OPT_INT64 or OPT_FLOAT) as which the 89 * string should be parsed 90 * @param min the minimum valid accepted value 91 * @param max the maximum valid accepted value 92 */ 93double parse_number_or_die(const char *context, const char *numstr, int type, 94 double min, double max); 95 96/** 97 * Parse a string specifying a time and return its corresponding 98 * value as a number of microseconds. Exit from the application if 99 * the string cannot be correctly parsed. 100 * 101 * @param context the context of the value to be set (e.g. the 102 * corresponding command line option name) 103 * @param timestr the string to be parsed 104 * @param is_duration a flag which tells how to interpret timestr, if 105 * not zero timestr is interpreted as a duration, otherwise as a 106 * date 107 * 108 * @see parse_date() 109 */ 110int64_t parse_time_or_die(const char *context, const char *timestr, 111 int is_duration); 112 113typedef struct SpecifierOpt { 114 char *specifier; /**< stream/chapter/program/... 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 124typedef 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 157void show_help_options(const OptionDef *options, const char *msg, int mask, 158 int value); 159 160/** 161 * Show help for all options with given flags in class and all its 162 * children. 163 */ 164void show_help_children(const AVClass *class, int flags); 165 166/** 167 * Parse the command line arguments. 168 * 169 * @param optctx an opaque options context 170 * @param options Array with the definitions required to interpret every 171 * option of the form: -option_name [argument] 172 * @param parse_arg_function Name of the function called to process every 173 * argument without a leading option name flag. NULL if such arguments do 174 * not have to be processed. 175 */ 176void parse_options(void *optctx, int argc, char **argv, const OptionDef *options, 177 void (* parse_arg_function)(void *optctx, const char*)); 178 179/** 180 * Parse one given option. 181 * 182 * @return on success 1 if arg was consumed, 0 otherwise; negative number on error 183 */ 184int parse_option(void *optctx, const char *opt, const char *arg, 185 const OptionDef *options); 186 187/** 188 * Find the '-loglevel' option in the command line args and apply it. 189 */ 190void parse_loglevel(int argc, char **argv, const OptionDef *options); 191 192/** 193 * Check if the given stream matches a stream specifier. 194 * 195 * @param s Corresponding format context. 196 * @param st Stream from s to be checked. 197 * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form. 198 * 199 * @return 1 if the stream matches, 0 if it doesn't, <0 on error 200 */ 201int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec); 202 203/** 204 * Filter out options for given codec. 205 * 206 * Create a new options dictionary containing only the options from 207 * opts which apply to the codec with ID codec_id. 208 * 209 * @param s Corresponding format context. 210 * @param st A stream from s for which the options should be filtered. 211 * @return a pointer to the created dictionary 212 */ 213AVDictionary *filter_codec_opts(AVDictionary *opts, enum CodecID codec_id, 214 AVFormatContext *s, AVStream *st); 215 216/** 217 * Setup AVCodecContext options for avformat_find_stream_info(). 218 * 219 * Create an array of dictionaries, one dictionary for each stream 220 * contained in s. 221 * Each dictionary will contain the options from codec_opts which can 222 * be applied to the corresponding stream codec context. 223 * 224 * @return pointer to the created array of dictionaries, NULL if it 225 * cannot be created 226 */ 227AVDictionary **setup_find_stream_info_opts(AVFormatContext *s, 228 AVDictionary *codec_opts); 229 230/** 231 * Print an error message to stderr, indicating filename and a human 232 * readable description of the error code err. 233 * 234 * If strerror_r() is not available the use of this function in a 235 * multithreaded application may be unsafe. 236 * 237 * @see av_strerror() 238 */ 239void print_error(const char *filename, int err); 240 241/** 242 * Print the program banner to stderr. The banner contents depend on the 243 * current version of the repository and of the libav* libraries used by 244 * the program. 245 */ 246void show_banner(void); 247 248/** 249 * Print the version of the program to stdout. The version message 250 * depends on the current versions of the repository and of the libav* 251 * libraries. 252 */ 253void show_version(void); 254 255/** 256 * Print the license of the program to stdout. The license depends on 257 * the license of the libraries compiled into the program. 258 */ 259void show_license(void); 260 261/** 262 * Print a listing containing all the formats supported by the 263 * program. 264 */ 265void show_formats(void); 266 267/** 268 * Print a listing containing all the codecs supported by the 269 * program. 270 */ 271void show_codecs(void); 272 273/** 274 * Print a listing containing all the filters supported by the 275 * program. 276 */ 277void show_filters(void); 278 279/** 280 * Print a listing containing all the bit stream filters supported by the 281 * program. 282 */ 283void show_bsfs(void); 284 285/** 286 * Print a listing containing all the protocols supported by the 287 * program. 288 */ 289void show_protocols(void); 290 291/** 292 * Print a listing containing all the pixel formats supported by the 293 * program. 294 */ 295void show_pix_fmts(void); 296 297/** 298 * Print a listing containing all the sample formats supported by the 299 * program. 300 */ 301int show_sample_fmts(const char *opt, const char *arg); 302 303/** 304 * Return a positive value if a line read from standard input 305 * starts with [yY], otherwise return 0. 306 */ 307int read_yesno(void); 308 309/** 310 * Read the file with name filename, and put its content in a newly 311 * allocated 0-terminated buffer. 312 * 313 * @param bufptr location where pointer to buffer is returned 314 * @param size location where size of buffer is returned 315 * @return 0 in case of success, a negative value corresponding to an 316 * AVERROR error code in case of failure. 317 */ 318int cmdutils_read_file(const char *filename, char **bufptr, size_t *size); 319 320typedef struct { 321 int64_t num_faulty_pts; /// Number of incorrect PTS values so far 322 int64_t num_faulty_dts; /// Number of incorrect DTS values so far 323 int64_t last_pts; /// PTS of the last frame 324 int64_t last_dts; /// DTS of the last frame 325} PtsCorrectionContext; 326 327/** 328 * Reset the state of the PtsCorrectionContext. 329 */ 330void init_pts_correction(PtsCorrectionContext *ctx); 331 332/** 333 * Attempt to guess proper monotonic timestamps for decoded video frames 334 * which might have incorrect times. Input timestamps may wrap around, in 335 * which case the output will as well. 336 * 337 * @param pts the pts field of the decoded AVPacket, as passed through 338 * AVCodecContext.reordered_opaque 339 * @param dts the dts field of the decoded AVPacket 340 * @return one of the input values, may be AV_NOPTS_VALUE 341 */ 342int64_t guess_correct_pts(PtsCorrectionContext *ctx, int64_t pts, int64_t dts); 343 344/** 345 * Get a file corresponding to a preset file. 346 * 347 * If is_path is non-zero, look for the file in the path preset_name. 348 * Otherwise search for a file named arg.avpreset in the directories 349 * $AVCONV_DATADIR (if set), $HOME/.avconv, and in the datadir defined 350 * at configuration time, in that order. If no such file is found and 351 * codec_name is defined, then search for a file named 352 * codec_name-preset_name.avpreset in the above-mentioned directories. 353 * 354 * @param filename buffer where the name of the found filename is written 355 * @param filename_size size in bytes of the filename buffer 356 * @param preset_name name of the preset to search 357 * @param is_path tell if preset_name is a filename path 358 * @param codec_name name of the codec for which to look for the 359 * preset, may be NULL 360 */ 361FILE *get_preset_file(char *filename, size_t filename_size, 362 const char *preset_name, int is_path, const char *codec_name); 363 364typedef struct { 365 enum PixelFormat pix_fmt; 366} AVSinkContext; 367 368extern AVFilter avsink; 369 370/** 371 * Extract a frame from sink. 372 * 373 * @return a negative error in case of failure, 1 if one frame has 374 * been extracted successfully. 375 */ 376int get_filtered_video_frame(AVFilterContext *sink, AVFrame *frame, 377 AVFilterBufferRef **picref, AVRational *pts_tb); 378 379/** 380 * Do all the necessary cleanup and abort. 381 * This function is implemented in the avtools, not cmdutils. 382 */ 383void exit_program(int ret); 384 385/** 386 * Realloc array to hold new_size elements of elem_size. 387 * Calls exit_program() on failure. 388 * 389 * @param elem_size size in bytes of each element 390 * @param size new element count will be written here 391 * @return reallocated array 392 */ 393void *grow_array(void *array, int elem_size, int *size, int new_size); 394 395#endif /* LIBAV_CMDUTILS_H */ 396