cmdutils.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494
  1. /*
  2. * Various utilities for command line tools
  3. * copyright (c) 2003 Fabrice Bellard
  4. *
  5. * This file is part of FFmpeg.
  6. *
  7. * FFmpeg 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. * FFmpeg 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 FFmpeg; if not, write to the Free Software
  19. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20. */
  21. #ifndef FFTOOLS_CMDUTILS_H
  22. #define FFTOOLS_CMDUTILS_H
  23. #include <stdint.h>
  24. #include "config.h"
  25. #include "libavcodec/avcodec.h"
  26. #include "libavfilter/avfilter.h"
  27. #include "libavformat/avformat.h"
  28. #include "libswscale/swscale.h"
  29. #ifdef _WIN32
  30. #undef main /* We don't want SDL to override our main() */
  31. #endif
  32. /**
  33. * program name, defined by the program for show_version().
  34. */
  35. extern const char program_name[];
  36. /**
  37. * program birth year, defined by the program for show_banner()
  38. */
  39. extern const int program_birth_year;
  40. extern AVDictionary *sws_dict;
  41. extern AVDictionary *swr_opts;
  42. extern AVDictionary *format_opts, *codec_opts;
  43. extern int hide_banner;
  44. /**
  45. * Initialize dynamic library loading
  46. */
  47. void init_dynload(void);
  48. /**
  49. * Uninitialize the cmdutils option system, in particular
  50. * free the *_opts contexts and their contents.
  51. */
  52. void uninit_opts(void);
  53. /**
  54. * Trivial log callback.
  55. * Only suitable for opt_help and similar since it lacks prefix handling.
  56. */
  57. void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
  58. /**
  59. * Fallback for options that are not explicitly handled, these will be
  60. * parsed through AVOptions.
  61. */
  62. int opt_default(void *optctx, const char *opt, const char *arg);
  63. /**
  64. * Limit the execution time.
  65. */
  66. int opt_timelimit(void *optctx, const char *opt, const char *arg);
  67. enum OptionType {
  68. OPT_TYPE_FUNC,
  69. OPT_TYPE_BOOL,
  70. OPT_TYPE_STRING,
  71. OPT_TYPE_INT,
  72. OPT_TYPE_INT64,
  73. OPT_TYPE_FLOAT,
  74. OPT_TYPE_DOUBLE,
  75. OPT_TYPE_TIME,
  76. };
  77. /**
  78. * Parse a string and return its corresponding value as a double.
  79. *
  80. * @param context the context of the value to be set (e.g. the
  81. * corresponding command line option name)
  82. * @param numstr the string to be parsed
  83. * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
  84. * string should be parsed
  85. * @param min the minimum valid accepted value
  86. * @param max the maximum valid accepted value
  87. */
  88. int parse_number(const char *context, const char *numstr, enum OptionType type,
  89. double min, double max, double *dst);
  90. typedef struct SpecifierOpt {
  91. char *specifier; /**< stream/chapter/program/... specifier */
  92. union {
  93. uint8_t *str;
  94. int i;
  95. int64_t i64;
  96. uint64_t ui64;
  97. float f;
  98. double dbl;
  99. } u;
  100. } SpecifierOpt;
  101. typedef struct SpecifierOptList {
  102. SpecifierOpt *opt;
  103. int nb_opt;
  104. /* Canonical option definition that was parsed into this list. */
  105. const struct OptionDef *opt_canon;
  106. enum OptionType type;
  107. } SpecifierOptList;
  108. typedef struct OptionDef {
  109. const char *name;
  110. enum OptionType type;
  111. int flags;
  112. /* The OPT_TYPE_FUNC option takes an argument.
  113. * Must not be used with other option types, as for those it holds:
  114. * - OPT_TYPE_BOOL do not take an argument
  115. * - all other types do
  116. */
  117. #define OPT_FUNC_ARG (1 << 0)
  118. /* Program will immediately exit after processing this option */
  119. #define OPT_EXIT (1 << 1)
  120. /* Option is intended for advanced users. Only affects
  121. * help output.
  122. */
  123. #define OPT_EXPERT (1 << 2)
  124. #define OPT_VIDEO (1 << 3)
  125. #define OPT_AUDIO (1 << 4)
  126. #define OPT_SUBTITLE (1 << 5)
  127. #define OPT_DATA (1 << 6)
  128. /* The option is per-file (currently ffmpeg-only). At least one of OPT_INPUT,
  129. * OPT_OUTPUT, OPT_DECODER must be set when this flag is in use.
  130. */
  131. #define OPT_PERFILE (1 << 7)
  132. /* Option is specified as an offset in a passed optctx.
  133. * Always use as OPT_OFFSET in option definitions. */
  134. #define OPT_FLAG_OFFSET (1 << 8)
  135. #define OPT_OFFSET (OPT_FLAG_OFFSET | OPT_PERFILE)
  136. /* Option is to be stored in a SpecifierOptList.
  137. Always use as OPT_SPEC in option definitions. */
  138. #define OPT_FLAG_SPEC (1 << 9)
  139. #define OPT_SPEC (OPT_FLAG_SPEC | OPT_OFFSET)
  140. /* Option applies per-stream (implies OPT_SPEC). */
  141. #define OPT_FLAG_PERSTREAM (1 << 10)
  142. #define OPT_PERSTREAM (OPT_FLAG_PERSTREAM | OPT_SPEC)
  143. /* ffmpeg-only - specifies whether an OPT_PERFILE option applies to input,
  144. * output, or both. */
  145. #define OPT_INPUT (1 << 11)
  146. #define OPT_OUTPUT (1 << 12)
  147. /* This option is a "canonical" form, to which one or more alternatives
  148. * exist. These alternatives are listed in u1.names_alt. */
  149. #define OPT_HAS_ALT (1 << 13)
  150. /* This option is an alternative form of some other option, whose
  151. * name is stored in u1.name_canon */
  152. #define OPT_HAS_CANON (1 << 14)
  153. /* ffmpeg-only - OPT_PERFILE may apply to standalone decoders */
  154. #define OPT_DECODER (1 << 15)
  155. union {
  156. void *dst_ptr;
  157. int (*func_arg)(void *, const char *, const char *);
  158. size_t off;
  159. } u;
  160. const char *help;
  161. const char *argname;
  162. union {
  163. /* Name of the canonical form of this option.
  164. * Is valid when OPT_HAS_CANON is set. */
  165. const char *name_canon;
  166. /* A NULL-terminated list of alternate forms of this option.
  167. * Is valid when OPT_HAS_ALT is set. */
  168. const char * const *names_alt;
  169. } u1;
  170. } OptionDef;
  171. /**
  172. * Print help for all options matching specified flags.
  173. *
  174. * @param options a list of options
  175. * @param msg title of this group. Only printed if at least one option matches.
  176. * @param req_flags print only options which have all those flags set.
  177. * @param rej_flags don't print options which have any of those flags set.
  178. */
  179. void show_help_options(const OptionDef *options, const char *msg, int req_flags,
  180. int rej_flags);
  181. /**
  182. * Show help for all options with given flags in class and all its
  183. * children.
  184. */
  185. void show_help_children(const AVClass *class, int flags);
  186. /**
  187. * Per-fftool specific help handler. Implemented in each
  188. * fftool, called by show_help().
  189. */
  190. void show_help_default(const char *opt, const char *arg);
  191. /**
  192. * Parse the command line arguments.
  193. *
  194. * @param optctx an opaque options context
  195. * @param argc number of command line arguments
  196. * @param argv values of command line arguments
  197. * @param options Array with the definitions required to interpret every
  198. * option of the form: -option_name [argument]
  199. * @param parse_arg_function Name of the function called to process every
  200. * argument without a leading option name flag. NULL if such arguments do
  201. * not have to be processed.
  202. */
  203. int parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
  204. int (* parse_arg_function)(void *optctx, const char*));
  205. /**
  206. * Parse one given option.
  207. *
  208. * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
  209. */
  210. int parse_option(void *optctx, const char *opt, const char *arg,
  211. const OptionDef *options);
  212. /**
  213. * An option extracted from the commandline.
  214. * Cannot use AVDictionary because of options like -map which can be
  215. * used multiple times.
  216. */
  217. typedef struct Option {
  218. const OptionDef *opt;
  219. const char *key;
  220. const char *val;
  221. } Option;
  222. typedef struct OptionGroupDef {
  223. /**< group name */
  224. const char *name;
  225. /**
  226. * Option to be used as group separator. Can be NULL for groups which
  227. * are terminated by a non-option argument (e.g. ffmpeg output files)
  228. */
  229. const char *sep;
  230. /**
  231. * Option flags that must be set on each option that is
  232. * applied to this group
  233. */
  234. int flags;
  235. } OptionGroupDef;
  236. typedef struct OptionGroup {
  237. const OptionGroupDef *group_def;
  238. const char *arg;
  239. Option *opts;
  240. int nb_opts;
  241. AVDictionary *codec_opts;
  242. AVDictionary *format_opts;
  243. AVDictionary *sws_dict;
  244. AVDictionary *swr_opts;
  245. } OptionGroup;
  246. /**
  247. * A list of option groups that all have the same group type
  248. * (e.g. input files or output files)
  249. */
  250. typedef struct OptionGroupList {
  251. const OptionGroupDef *group_def;
  252. OptionGroup *groups;
  253. int nb_groups;
  254. } OptionGroupList;
  255. typedef struct OptionParseContext {
  256. OptionGroup global_opts;
  257. OptionGroupList *groups;
  258. int nb_groups;
  259. /* parsing state */
  260. OptionGroup cur_group;
  261. } OptionParseContext;
  262. /**
  263. * Parse an options group and write results into optctx.
  264. *
  265. * @param optctx an app-specific options context. NULL for global options group
  266. */
  267. int parse_optgroup(void *optctx, OptionGroup *g, const OptionDef *defs);
  268. /**
  269. * Split the commandline into an intermediate form convenient for further
  270. * processing.
  271. *
  272. * The commandline is assumed to be composed of options which either belong to a
  273. * group (those with OPT_SPEC, OPT_OFFSET or OPT_PERFILE) or are global
  274. * (everything else).
  275. *
  276. * A group (defined by an OptionGroupDef struct) is a sequence of options
  277. * terminated by either a group separator option (e.g. -i) or a parameter that
  278. * is not an option (doesn't start with -). A group without a separator option
  279. * must always be first in the supplied groups list.
  280. *
  281. * All options within the same group are stored in one OptionGroup struct in an
  282. * OptionGroupList, all groups with the same group definition are stored in one
  283. * OptionGroupList in OptionParseContext.groups. The order of group lists is the
  284. * same as the order of group definitions.
  285. */
  286. int split_commandline(OptionParseContext *octx, int argc, char *argv[],
  287. const OptionDef *options,
  288. const OptionGroupDef *groups, int nb_groups);
  289. /**
  290. * Free all allocated memory in an OptionParseContext.
  291. */
  292. void uninit_parse_context(OptionParseContext *octx);
  293. /**
  294. * Find the '-loglevel' option in the command line args and apply it.
  295. */
  296. void parse_loglevel(int argc, char **argv, const OptionDef *options);
  297. /**
  298. * Return index of option opt in argv or 0 if not found.
  299. */
  300. int locate_option(int argc, char **argv, const OptionDef *options,
  301. const char *optname);
  302. /**
  303. * Check if the given stream matches a stream specifier.
  304. *
  305. * @param s Corresponding format context.
  306. * @param st Stream from s to be checked.
  307. * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
  308. *
  309. * @return 1 if the stream matches, 0 if it doesn't, <0 on error
  310. */
  311. int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
  312. /**
  313. * Filter out options for given codec.
  314. *
  315. * Create a new options dictionary containing only the options from
  316. * opts which apply to the codec with ID codec_id.
  317. *
  318. * @param opts dictionary to place options in
  319. * @param codec_id ID of the codec that should be filtered for
  320. * @param s Corresponding format context.
  321. * @param st A stream from s for which the options should be filtered.
  322. * @param codec The particular codec for which the options should be filtered.
  323. * If null, the default one is looked up according to the codec id.
  324. * @param dst a pointer to the created dictionary
  325. * @param opts_used if non-NULL, every option stored in dst is also stored here,
  326. * with specifiers preserved
  327. * @return a non-negative number on success, a negative error code on failure
  328. */
  329. int filter_codec_opts(const AVDictionary *opts, enum AVCodecID codec_id,
  330. AVFormatContext *s, AVStream *st, const AVCodec *codec,
  331. AVDictionary **dst, AVDictionary **opts_used);
  332. /**
  333. * Setup AVCodecContext options for avformat_find_stream_info().
  334. *
  335. * Create an array of dictionaries, one dictionary for each stream
  336. * contained in s.
  337. * Each dictionary will contain the options from codec_opts which can
  338. * be applied to the corresponding stream codec context.
  339. */
  340. int setup_find_stream_info_opts(AVFormatContext *s,
  341. AVDictionary *codec_opts,
  342. AVDictionary ***dst);
  343. /**
  344. * Print an error message to stderr, indicating filename and a human
  345. * readable description of the error code err.
  346. *
  347. * If strerror_r() is not available the use of this function in a
  348. * multithreaded application may be unsafe.
  349. *
  350. * @see av_strerror()
  351. */
  352. static inline void print_error(const char *filename, int err)
  353. {
  354. av_log(NULL, AV_LOG_ERROR, "%s: %s\n", filename, av_err2str(err));
  355. }
  356. /**
  357. * Print the program banner to stderr. The banner contents depend on the
  358. * current version of the repository and of the libav* libraries used by
  359. * the program.
  360. */
  361. void show_banner(int argc, char **argv, const OptionDef *options);
  362. /**
  363. * Return a positive value if a line read from standard input
  364. * starts with [yY], otherwise return 0.
  365. */
  366. int read_yesno(void);
  367. /**
  368. * Get a file corresponding to a preset file.
  369. *
  370. * If is_path is non-zero, look for the file in the path preset_name.
  371. * Otherwise search for a file named arg.ffpreset in the directories
  372. * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
  373. * at configuration time or in a "ffpresets" folder along the executable
  374. * on win32, in that order. If no such file is found and
  375. * codec_name is defined, then search for a file named
  376. * codec_name-preset_name.avpreset in the above-mentioned directories.
  377. *
  378. * @param filename buffer where the name of the found filename is written
  379. * @param filename_size size in bytes of the filename buffer
  380. * @param preset_name name of the preset to search
  381. * @param is_path tell if preset_name is a filename path
  382. * @param codec_name name of the codec for which to look for the
  383. * preset, may be NULL
  384. */
  385. FILE *get_preset_file(char *filename, size_t filename_size,
  386. const char *preset_name, int is_path, const char *codec_name);
  387. /**
  388. * Realloc array to hold new_size elements of elem_size.
  389. *
  390. * @param array pointer to the array to reallocate, will be updated
  391. * with a new pointer on success
  392. * @param elem_size size in bytes of each element
  393. * @param size new element count will be written here
  394. * @param new_size number of elements to place in reallocated array
  395. * @return a non-negative number on success, a negative error code on failure
  396. */
  397. int grow_array(void **array, int elem_size, int *size, int new_size);
  398. /**
  399. * Atomically add a new element to an array of pointers, i.e. allocate
  400. * a new entry, reallocate the array of pointers and make the new last
  401. * member of this array point to the newly allocated buffer.
  402. *
  403. * @param array array of pointers to reallocate
  404. * @param elem_size size of the new element to allocate
  405. * @param nb_elems pointer to the number of elements of the array array;
  406. * *nb_elems will be incremented by one by this function.
  407. * @return pointer to the newly allocated entry or NULL on failure
  408. */
  409. void *allocate_array_elem(void *array, size_t elem_size, int *nb_elems);
  410. #define GROW_ARRAY(array, nb_elems)\
  411. grow_array((void**)&array, sizeof(*array), &nb_elems, nb_elems + 1)
  412. #define GET_PIX_FMT_NAME(pix_fmt)\
  413. const char *name = av_get_pix_fmt_name(pix_fmt);
  414. #define GET_CODEC_NAME(id)\
  415. const char *name = avcodec_descriptor_get(id)->name;
  416. #define GET_SAMPLE_FMT_NAME(sample_fmt)\
  417. const char *name = av_get_sample_fmt_name(sample_fmt)
  418. #define GET_SAMPLE_RATE_NAME(rate)\
  419. char name[16];\
  420. snprintf(name, sizeof(name), "%d", rate);
  421. double get_rotation(const int32_t *displaymatrix);
  422. /* read file contents into a string */
  423. char *file_read(const char *filename);
  424. /* Remove keys in dictionary b from dictionary a */
  425. void remove_avoptions(AVDictionary **a, AVDictionary *b);
  426. /* Check if any keys exist in dictionary m */
  427. int check_avoptions(AVDictionary *m);
  428. #endif /* FFTOOLS_CMDUTILS_H */