FFmpeg coverage

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