lavu/eval: rename "new_eval_expr()" to "make_eval_expr()"
[ffmpeg.git] / cmdutils.h
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 FFMPEG_CMDUTILS_H
23 #define FFMPEG_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 #ifdef __MINGW32__
33 #undef main /* We don't want SDL to override our main() */
34 #endif
35
36 /**
37  * program name, defined by the program for show_version().
38  */
39 extern const char program_name[];
40
41 /**
42  * program birth year, defined by the program for show_banner()
43  */
44 extern const int program_birth_year;
45
46 /**
47  * this year, defined by the program for show_banner()
48  */
49 extern const int this_year;
50
51 extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
52 extern AVFormatContext *avformat_opts;
53 extern struct SwsContext *sws_opts;
54 extern AVDictionary *swr_opts;
55 extern AVDictionary *format_opts, *codec_opts, *resample_opts;
56
57 /**
58  * Initialize the cmdutils option system, in particular
59  * allocate the *_opts contexts.
60  */
61 void init_opts(void);
62 /**
63  * Uninitialize the cmdutils option system, in particular
64  * free the *_opts contexts and their contents.
65  */
66 void uninit_opts(void);
67
68 /**
69  * Trivial log callback.
70  * Only suitable for opt_help and similar since it lacks prefix handling.
71  */
72 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
73
74 /**
75  * Fallback for options that are not explicitly handled, these will be
76  * parsed through AVOptions.
77  */
78 int opt_default(void *optctx, const char *opt, const char *arg);
79
80 /**
81  * Set the libav* libraries log level.
82  */
83 int opt_loglevel(void *optctx, const char *opt, const char *arg);
84
85 int opt_report(const char *opt);
86
87 int opt_max_alloc(void *optctx, const char *opt, const char *arg);
88
89 int opt_cpuflags(void *optctx, const char *opt, const char *arg);
90
91 int opt_codec_debug(void *optctx, const char *opt, const char *arg);
92
93 /**
94  * Limit the execution time.
95  */
96 int opt_timelimit(void *optctx, const char *opt, const char *arg);
97
98 /**
99  * Parse a string and return its corresponding value as a double.
100  * Exit from the application if the string cannot be correctly
101  * parsed or the corresponding value is invalid.
102  *
103  * @param context the context of the value to be set (e.g. the
104  * corresponding command line option name)
105  * @param numstr the string to be parsed
106  * @param type the type (OPT_INT64 or OPT_FLOAT) as which the
107  * string should be parsed
108  * @param min the minimum valid accepted value
109  * @param max the maximum valid accepted value
110  */
111 double parse_number_or_die(const char *context, const char *numstr, int type,
112                            double min, double max);
113
114 /**
115  * Parse a string specifying a time and return its corresponding
116  * value as a number of microseconds. Exit from the application if
117  * the string cannot be correctly parsed.
118  *
119  * @param context the context of the value to be set (e.g. the
120  * corresponding command line option name)
121  * @param timestr the string to be parsed
122  * @param is_duration a flag which tells how to interpret timestr, if
123  * not zero timestr is interpreted as a duration, otherwise as a
124  * date
125  *
126  * @see av_parse_time()
127  */
128 int64_t parse_time_or_die(const char *context, const char *timestr,
129                           int is_duration);
130
131 typedef struct SpecifierOpt {
132     char *specifier;    /**< stream/chapter/program/... specifier */
133     union {
134         uint8_t *str;
135         int        i;
136         int64_t  i64;
137         float      f;
138         double   dbl;
139     } u;
140 } SpecifierOpt;
141
142 typedef struct OptionDef {
143     const char *name;
144     int flags;
145 #define HAS_ARG    0x0001
146 #define OPT_BOOL   0x0002
147 #define OPT_EXPERT 0x0004
148 #define OPT_STRING 0x0008
149 #define OPT_VIDEO  0x0010
150 #define OPT_AUDIO  0x0020
151 #define OPT_INT    0x0080
152 #define OPT_FLOAT  0x0100
153 #define OPT_SUBTITLE 0x0200
154 #define OPT_INT64  0x0400
155 #define OPT_EXIT   0x0800
156 #define OPT_DATA   0x1000
157 #define OPT_PERFILE  0x2000     /* the option is per-file (currently ffmpeg-only).
158                                    implied by OPT_OFFSET or OPT_SPEC */
159 #define OPT_OFFSET 0x4000       /* option is specified as an offset in a passed optctx */
160 #define OPT_SPEC   0x8000       /* option is to be stored in an array of SpecifierOpt.
161                                    Implies OPT_OFFSET. Next element after the offset is
162                                    an int containing element count in the array. */
163 #define OPT_TIME  0x10000
164 #define OPT_DOUBLE 0x20000
165 #define OPT_INPUT  0x40000
166 #define OPT_OUTPUT 0x80000
167      union {
168         void *dst_ptr;
169         int (*func_arg)(void *, const char *, const char *);
170         size_t off;
171     } u;
172     const char *help;
173     const char *argname;
174 } OptionDef;
175
176 /**
177  * Print help for all options matching specified flags.
178  *
179  * @param options a list of options
180  * @param msg title of this group. Only printed if at least one option matches.
181  * @param req_flags print only options which have all those flags set.
182  * @param rej_flags don't print options which have any of those flags set.
183  * @param alt_flags print only options that have at least one of those flags set
184  */
185 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
186                        int rej_flags, int alt_flags);
187
188 /**
189  * Show help for all options with given flags in class and all its
190  * children.
191  */
192 void show_help_children(const AVClass *class, int flags);
193
194 /**
195  * Per-fftool specific help handler. Implemented in each
196  * fftool, called by show_help().
197  */
198 void show_help_default(const char *opt, const char *arg);
199
200 /**
201  * Generic -h handler common to all fftools.
202  */
203 int show_help(void *optctx, const char *opt, const char *arg);
204
205 /**
206  * Parse the command line arguments.
207  *
208  * @param optctx an opaque options context
209  * @param argc   number of command line arguments
210  * @param argv   values of command line arguments
211  * @param options Array with the definitions required to interpret every
212  * option of the form: -option_name [argument]
213  * @param parse_arg_function Name of the function called to process every
214  * argument without a leading option name flag. NULL if such arguments do
215  * not have to be processed.
216  */
217 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
218                    void (* parse_arg_function)(void *optctx, const char*));
219
220 /**
221  * Parse one given option.
222  *
223  * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
224  */
225 int parse_option(void *optctx, const char *opt, const char *arg,
226                  const OptionDef *options);
227
228 /**
229  * An option extracted from the commandline.
230  * Cannot use AVDictionary because of options like -map which can be
231  * used multiple times.
232  */
233 typedef struct Option {
234     const OptionDef  *opt;
235     const char       *key;
236     const char       *val;
237 } Option;
238
239 typedef struct OptionGroupDef {
240     /**< group name */
241     const char *name;
242     /**
243      * Option to be used as group separator. Can be NULL for groups which
244      * are terminated by a non-option argument (e.g. ffmpeg output files)
245      */
246     const char *sep;
247     /**
248      * Option flags that must be set on each option that is
249      * applied to this group
250      */
251     int flags;
252 } OptionGroupDef;
253
254 typedef struct OptionGroup {
255     const OptionGroupDef *group_def;
256     const char *arg;
257
258     Option *opts;
259     int  nb_opts;
260
261     AVDictionary *codec_opts;
262     AVDictionary *format_opts;
263     AVDictionary *resample_opts;
264     struct SwsContext *sws_opts;
265     AVDictionary *swr_opts;
266 } OptionGroup;
267
268 /**
269  * A list of option groups that all have the same group type
270  * (e.g. input files or output files)
271  */
272 typedef struct OptionGroupList {
273     const OptionGroupDef *group_def;
274
275     OptionGroup *groups;
276     int       nb_groups;
277 } OptionGroupList;
278
279 typedef struct OptionParseContext {
280     OptionGroup global_opts;
281
282     OptionGroupList *groups;
283     int           nb_groups;
284
285     /* parsing state */
286     OptionGroup cur_group;
287 } OptionParseContext;
288
289 /**
290  * Parse an options group and write results into optctx.
291  *
292  * @param optctx an app-specific options context. NULL for global options group
293  */
294 int parse_optgroup(void *optctx, OptionGroup *g);
295
296 /**
297  * Split the commandline into an intermediate form convenient for further
298  * processing.
299  *
300  * The commandline is assumed to be composed of options which either belong to a
301  * group (those with OPT_SPEC, OPT_OFFSET or OPT_PERFILE) or are global
302  * (everything else).
303  *
304  * A group (defined by an OptionGroupDef struct) is a sequence of options
305  * terminated by either a group separator option (e.g. -i) or a parameter that
306  * is not an option (doesn't start with -). A group without a separator option
307  * must always be first in the supplied groups list.
308  *
309  * All options within the same group are stored in one OptionGroup struct in an
310  * OptionGroupList, all groups with the same group definition are stored in one
311  * OptionGroupList in OptionParseContext.groups. The order of group lists is the
312  * same as the order of group definitions.
313  */
314 int split_commandline(OptionParseContext *octx, int argc, char *argv[],
315                       const OptionDef *options,
316                       const OptionGroupDef *groups, int nb_groups);
317
318 /**
319  * Free all allocated memory in an OptionParseContext.
320  */
321 void uninit_parse_context(OptionParseContext *octx);
322
323 /**
324  * Find the '-loglevel' option in the command line args and apply it.
325  */
326 void parse_loglevel(int argc, char **argv, const OptionDef *options);
327
328 /**
329  * Return index of option opt in argv or 0 if not found.
330  */
331 int locate_option(int argc, char **argv, const OptionDef *options,
332                   const char *optname);
333
334 /**
335  * Check if the given stream matches a stream specifier.
336  *
337  * @param s  Corresponding format context.
338  * @param st Stream from s to be checked.
339  * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
340  *
341  * @return 1 if the stream matches, 0 if it doesn't, <0 on error
342  */
343 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
344
345 /**
346  * Filter out options for given codec.
347  *
348  * Create a new options dictionary containing only the options from
349  * opts which apply to the codec with ID codec_id.
350  *
351  * @param opts     dictionary to place options in
352  * @param codec_id ID of the codec that should be filtered for
353  * @param s Corresponding format context.
354  * @param st A stream from s for which the options should be filtered.
355  * @param codec The particular codec for which the options should be filtered.
356  *              If null, the default one is looked up according to the codec id.
357  * @return a pointer to the created dictionary
358  */
359 AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
360                                 AVFormatContext *s, AVStream *st, AVCodec *codec);
361
362 /**
363  * Setup AVCodecContext options for avformat_find_stream_info().
364  *
365  * Create an array of dictionaries, one dictionary for each stream
366  * contained in s.
367  * Each dictionary will contain the options from codec_opts which can
368  * be applied to the corresponding stream codec context.
369  *
370  * @return pointer to the created array of dictionaries, NULL if it
371  * cannot be created
372  */
373 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
374                                            AVDictionary *codec_opts);
375
376 /**
377  * Print an error message to stderr, indicating filename and a human
378  * readable description of the error code err.
379  *
380  * If strerror_r() is not available the use of this function in a
381  * multithreaded application may be unsafe.
382  *
383  * @see av_strerror()
384  */
385 void print_error(const char *filename, int err);
386
387 /**
388  * Print the program banner to stderr. The banner contents depend on the
389  * current version of the repository and of the libav* libraries used by
390  * the program.
391  */
392 void show_banner(int argc, char **argv, const OptionDef *options);
393
394 /**
395  * Print the version of the program to stdout. The version message
396  * depends on the current versions of the repository and of the libav*
397  * libraries.
398  * This option processing function does not utilize the arguments.
399  */
400 int show_version(void *optctx, const char *opt, const char *arg);
401
402 /**
403  * Print the license of the program to stdout. The license depends on
404  * the license of the libraries compiled into the program.
405  * This option processing function does not utilize the arguments.
406  */
407 int show_license(void *optctx, const char *opt, const char *arg);
408
409 /**
410  * Print a listing containing all the formats supported by the
411  * program.
412  * This option processing function does not utilize the arguments.
413  */
414 int show_formats(void *optctx, const char *opt, const char *arg);
415
416 /**
417  * Print a listing containing all the codecs supported by the
418  * program.
419  * This option processing function does not utilize the arguments.
420  */
421 int show_codecs(void *optctx, const char *opt, const char *arg);
422
423 /**
424  * Print a listing containing all the decoders supported by the
425  * program.
426  */
427 int show_decoders(void *optctx, const char *opt, const char *arg);
428
429 /**
430  * Print a listing containing all the encoders supported by the
431  * program.
432  */
433 int show_encoders(void *optctx, const char *opt, const char *arg);
434
435 /**
436  * Print a listing containing all the filters supported by the
437  * program.
438  * This option processing function does not utilize the arguments.
439  */
440 int show_filters(void *optctx, const char *opt, const char *arg);
441
442 /**
443  * Print a listing containing all the bit stream filters supported by the
444  * program.
445  * This option processing function does not utilize the arguments.
446  */
447 int show_bsfs(void *optctx, const char *opt, const char *arg);
448
449 /**
450  * Print a listing containing all the protocols supported by the
451  * program.
452  * This option processing function does not utilize the arguments.
453  */
454 int show_protocols(void *optctx, const char *opt, const char *arg);
455
456 /**
457  * Print a listing containing all the pixel formats supported by the
458  * program.
459  * This option processing function does not utilize the arguments.
460  */
461 int show_pix_fmts(void *optctx, const char *opt, const char *arg);
462
463 /**
464  * Print a listing containing all the standard channel layouts supported by
465  * the program.
466  * This option processing function does not utilize the arguments.
467  */
468 int show_layouts(void *optctx, const char *opt, const char *arg);
469
470 /**
471  * Print a listing containing all the sample formats supported by the
472  * program.
473  */
474 int show_sample_fmts(void *optctx, const char *opt, const char *arg);
475
476 /**
477  * Return a positive value if a line read from standard input
478  * starts with [yY], otherwise return 0.
479  */
480 int read_yesno(void);
481
482 /**
483  * Read the file with name filename, and put its content in a newly
484  * allocated 0-terminated buffer.
485  *
486  * @param filename file to read from
487  * @param bufptr location where pointer to buffer is returned
488  * @param size   location where size of buffer is returned
489  * @return 0 in case of success, a negative value corresponding to an
490  * AVERROR error code in case of failure.
491  */
492 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
493
494 /**
495  * Get a file corresponding to a preset file.
496  *
497  * If is_path is non-zero, look for the file in the path preset_name.
498  * Otherwise search for a file named arg.ffpreset in the directories
499  * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
500  * at configuration time or in a "ffpresets" folder along the executable
501  * on win32, in that order. If no such file is found and
502  * codec_name is defined, then search for a file named
503  * codec_name-preset_name.avpreset in the above-mentioned directories.
504  *
505  * @param filename buffer where the name of the found filename is written
506  * @param filename_size size in bytes of the filename buffer
507  * @param preset_name name of the preset to search
508  * @param is_path tell if preset_name is a filename path
509  * @param codec_name name of the codec for which to look for the
510  * preset, may be NULL
511  */
512 FILE *get_preset_file(char *filename, size_t filename_size,
513                       const char *preset_name, int is_path, const char *codec_name);
514
515 /**
516  * Realloc array to hold new_size elements of elem_size.
517  * Calls exit() on failure.
518  *
519  * @param array array to reallocate
520  * @param elem_size size in bytes of each element
521  * @param size new element count will be written here
522  * @param new_size number of elements to place in reallocated array
523  * @return reallocated array
524  */
525 void *grow_array(void *array, int elem_size, int *size, int new_size);
526
527 #define GROW_ARRAY(array, nb_elems)\
528     array = grow_array(array, sizeof(*array), &nb_elems, nb_elems + 1)
529
530 #define GET_PIX_FMT_NAME(pix_fmt)\
531     const char *name = av_get_pix_fmt_name(pix_fmt);
532
533 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
534     const char *name = av_get_sample_fmt_name(sample_fmt)
535
536 #define GET_SAMPLE_RATE_NAME(rate)\
537     char name[16];\
538     snprintf(name, sizeof(name), "%d", rate);
539
540 #define GET_CH_LAYOUT_NAME(ch_layout)\
541     char name[16];\
542     snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
543
544 #define GET_CH_LAYOUT_DESC(ch_layout)\
545     char name[128];\
546     av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
547
548 #endif /* CMDUTILS_H */