Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 491 lines (426 sloc) 15.881 kb
f5a9018 @DonDiego Add missing license headers.
DonDiego authored
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
5b21bda @DonDiego Add FFMPEG_ prefix to all multiple inclusion guards.
DonDiego authored
22 #ifndef FFMPEG_CMDUTILS_H
23 #define FFMPEG_CMDUTILS_H
01310af added ffplay utility
Fabrice Bellard authored
24
ea91e77 @DonDiego Clean up #includes in cmdutils.h.
DonDiego authored
25 #include <stdint.h>
26
95137bb @DonDiego Fix 'make checkheaders', based on a patch by Diego Pettenò, flameeyes…
DonDiego authored
27 #include "libavcodec/avcodec.h"
ea91e77 @DonDiego Clean up #includes in cmdutils.h.
DonDiego authored
28 #include "libavfilter/avfilter.h"
95137bb @DonDiego Fix 'make checkheaders', based on a patch by Diego Pettenò, flameeyes…
DonDiego authored
29 #include "libavformat/avformat.h"
30 #include "libswscale/swscale.h"
f0a838e @DonDiego Add missing #includes to fix 'make checkheaders'.
DonDiego authored
31
25c32d0 @cehoyos cmdutils: move "#undef main" from ffplay.c to cmdutils.h
cehoyos authored
32 #ifdef __MINGW32__
33 #undef main /* We don't want SDL to override our main() */
34 #endif
35
60b5a74 Export and document in cmdutils.h the function parse_number_or_die().
Stefano Sabatini authored
36 /**
64555bd @michaelni Do not pass program_name as argument to show_version(), this allows some
michaelni authored
37 * program name, defined by the program for show_version().
38 */
39 extern const char program_name[];
40
41 /**
ea9c581 Simplify show_banner() so that it does not require arguments, similar
Stefano Sabatini authored
42 * program birth year, defined by the program for show_banner()
43 */
44 extern const int program_birth_year;
45
e869d08 @saste cmdutils: make this_year extern, so it can be referenced from other .…
saste authored
46 /**
47 * this year, defined by the program for show_banner()
48 */
49 extern const int this_year;
50
72415b2 Define AVMediaType enum, and use it instead of enum CodecType, which
Stefano Sabatini authored
51 extern AVCodecContext *avcodec_opts[AVMEDIA_TYPE_NB];
85663ef @michaelni Move opt_default() and set_context_opts() to cmdutils so it can be us…
michaelni authored
52 extern AVFormatContext *avformat_opts;
53 extern struct SwsContext *sws_opts;
be4cde2 @michaelni cmdutils: parse options for swr
michaelni authored
54 extern struct SwrContext *swr_opts;
8c8eab8 @elenril cmdutils: store all codec options in one dict instead of video/audio/sub
elenril authored
55 extern AVDictionary *format_opts, *codec_opts;
85663ef @michaelni Move opt_default() and set_context_opts() to cmdutils so it can be us…
michaelni authored
56
57 /**
a5c33fa Add init and uninit functions to cmdutils, reduces code duplication
Reimar Döffinger authored
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 /**
1790d3b Move log_callback_help to cmdutils.[hc], for allowing sharing.
Stefano Sabatini authored
69 * Trivial log callback.
a099183 Make all option parsing functions match the function pointer type thr…
Jeff Downs authored
70 * Only suitable for opt_help and similar since it lacks prefix handling.
1790d3b Move log_callback_help to cmdutils.[hc], for allowing sharing.
Stefano Sabatini authored
71 */
72 void log_callback_help(void* ptr, int level, const char* fmt, va_list vl);
73
74 /**
b743889 Fix typo: explixitly -> explicitly.
Stefano Sabatini authored
75 * Fallback for options that are not explicitly handled, these will be
85663ef @michaelni Move opt_default() and set_context_opts() to cmdutils so it can be us…
michaelni authored
76 * parsed through AVOptions.
77 */
11d957f @elenril avtools: remove the distinction between func_arg and func2_arg.
elenril authored
78 int opt_default(void *optctx, const char *opt, const char *arg);
85663ef @michaelni Move opt_default() and set_context_opts() to cmdutils so it can be us…
michaelni authored
79
ea9c581 Simplify show_banner() so that it does not require arguments, similar
Stefano Sabatini authored
80 /**
49bd8e4 @mansr Fix grammar errors in documentation
mansr authored
81 * Set the libav* libraries log level.
4c97a6f Move opt_loglevel() from ffmpeg.c to cmdutils.c.
Stefano Sabatini authored
82 */
11d957f @elenril avtools: remove the distinction between func_arg and func2_arg.
elenril authored
83 int opt_loglevel(void *optctx, const char *opt, const char *arg);
4c97a6f Move opt_loglevel() from ffmpeg.c to cmdutils.c.
Stefano Sabatini authored
84
337ce55 fftools: add -report option.
Nicolas George authored
85 int opt_report(const char *opt);
86
98298eb @michaelni Merge commit 'ec36aa69448f20a78d8c4588265022e0b2272ab5'
michaelni authored
87 int opt_max_alloc(void *optctx, const char *opt, const char *arg);
c48f67f @michaelni ff*: add -max_alloc command line option
michaelni authored
88
98298eb @michaelni Merge commit 'ec36aa69448f20a78d8c4588265022e0b2272ab5'
michaelni authored
89 int opt_cpuflags(void *optctx, const char *opt, const char *arg);
1060e9c @michaelni cmdutils: add -cpuflags.
michaelni authored
90
98298eb @michaelni Merge commit 'ec36aa69448f20a78d8c4588265022e0b2272ab5'
michaelni authored
91 int opt_codec_debug(void *optctx, const char *opt, const char *arg);
e9adeee @michaelni cmdutils: Fix loglevel for -debug
michaelni authored
92
4c97a6f Move opt_loglevel() from ffmpeg.c to cmdutils.c.
Stefano Sabatini authored
93 /**
ffcc6e2 @mansr Add -timelimit option
mansr authored
94 * Limit the execution time.
95 */
11d957f @elenril avtools: remove the distinction between func_arg and func2_arg.
elenril authored
96 int opt_timelimit(void *optctx, const char *opt, const char *arg);
ffcc6e2 @mansr Add -timelimit option
mansr authored
97
98 /**
49bd8e4 @mansr Fix grammar errors in documentation
mansr authored
99 * Parse a string and return its corresponding value as a double.
100 * Exit from the application if the string cannot be correctly
1506750 @DonDiego Improve wording/grammar of Doxygen comments.
DonDiego authored
101 * parsed or the corresponding value is invalid.
60b5a74 Export and document in cmdutils.h the function parse_number_or_die().
Stefano Sabatini authored
102 *
103 * @param context the context of the value to be set (e.g. the
da9cea7 @DonDiego Fix a bunch of common typos.
DonDiego authored
104 * corresponding command line option name)
60b5a74 Export and document in cmdutils.h the function parse_number_or_die().
Stefano Sabatini authored
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
1506750 @DonDiego Improve wording/grammar of Doxygen comments.
DonDiego authored
108 * @param min the minimum valid accepted value
109 * @param max the maximum valid accepted value
60b5a74 Export and document in cmdutils.h the function parse_number_or_die().
Stefano Sabatini authored
110 */
0184bbe @gnarula avprobe, cmdutils: K&R formatting cosmetics
gnarula authored
111 double parse_number_or_die(const char *context, const char *numstr, int type,
112 double min, double max);
60b5a74 Export and document in cmdutils.h the function parse_number_or_die().
Stefano Sabatini authored
113
7542157 Export parse_time_or_die from ffmpeg.c to cmdutils.c
Stefano Sabatini authored
114 /**
49bd8e4 @mansr Fix grammar errors in documentation
mansr authored
115 * Parse a string specifying a time and return its corresponding
116 * value as a number of microseconds. Exit from the application if
7542157 Export parse_time_or_die from ffmpeg.c to cmdutils.c
Stefano Sabatini authored
117 * the string cannot be correctly parsed.
118 *
119 * @param context the context of the value to be set (e.g. the
da9cea7 @DonDiego Fix a bunch of common typos.
DonDiego authored
120 * corresponding command line option name)
7542157 Export parse_time_or_die from ffmpeg.c to cmdutils.c
Stefano Sabatini authored
121 * @param timestr the string to be parsed
bf7e799 Remove '\p', '\c' and '\e' doxygen markup from doxy, as it should
Stefano Sabatini authored
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
7542157 Export parse_time_or_die from ffmpeg.c to cmdutils.c
Stefano Sabatini authored
124 * date
125 *
748061d Typo
Stefano Sabatini authored
126 * @see parse_date()
7542157 Export parse_time_or_die from ffmpeg.c to cmdutils.c
Stefano Sabatini authored
127 */
0184bbe @gnarula avprobe, cmdutils: K&R formatting cosmetics
gnarula authored
128 int64_t parse_time_or_die(const char *context, const char *timestr,
129 int is_duration);
7542157 Export parse_time_or_die from ffmpeg.c to cmdutils.c
Stefano Sabatini authored
130
6361c5e @elenril cmdutils: allow storing per-stream/chapter/.... options in a generic way
elenril authored
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;
33f75d7 @elenril avconv: move ts scale to options context.
elenril authored
138 double dbl;
6361c5e @elenril cmdutils: allow storing per-stream/chapter/.... options in a generic way
elenril authored
139 } u;
140 } SpecifierOpt;
141
01310af added ffplay utility
Fabrice Bellard authored
142 typedef struct {
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
02d504a more sections in help - copyright fixes
Fabrice Bellard authored
149 #define OPT_VIDEO 0x0010
150 #define OPT_AUDIO 0x0020
26d4f26 @michaelni OPT_INT
michaelni authored
151 #define OPT_INT 0x0080
394c4d7 @michaelni 1000l (copy & paste)
michaelni authored
152 #define OPT_FLOAT 0x0100
ae27975 subtitle option
Fabrice Bellard authored
153 #define OPT_SUBTITLE 0x0200
eb8bc57 cmdutils: remove OPT_FUNC2
Stefano Sabatini authored
154 #define OPT_INT64 0x0400
155 #define OPT_EXIT 0x0800
156 #define OPT_DATA 0x1000
98298eb @michaelni Merge commit 'ec36aa69448f20a78d8c4588265022e0b2272ab5'
michaelni authored
157 #define OPT_PERFILE 0x2000 /* the option is per-file (currently ffmpeg-only).
11d957f @elenril avtools: remove the distinction between func_arg and func2_arg.
elenril authored
158 implied by OPT_OFFSET or OPT_SPEC */
7cc8d63 @elenril cmdutils: add support for caller-provided option context.
elenril authored
159 #define OPT_OFFSET 0x4000 /* option is specified as an offset in a passed optctx */
6361c5e @elenril cmdutils: allow storing per-stream/chapter/.... options in a generic way
elenril authored
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. */
6b779cc @elenril avconv: move start_time, recording_time and input_ts_offset to option…
elenril authored
163 #define OPT_TIME 0x10000
33f75d7 @elenril avconv: move ts scale to options context.
elenril authored
164 #define OPT_DOUBLE 0x20000
ae27975 subtitle option
Fabrice Bellard authored
165 union {
7efe05a @elenril cmdutils: declare only one pointer type in OptionDef
elenril authored
166 void *dst_ptr;
11d957f @elenril avtools: remove the distinction between func_arg and func2_arg.
elenril authored
167 int (*func_arg)(void *, const char *, const char *);
7cc8d63 @elenril cmdutils: add support for caller-provided option context.
elenril authored
168 size_t off;
01310af added ffplay utility
Fabrice Bellard authored
169 } u;
170 const char *help;
171 const char *argname;
172 } OptionDef;
173
7c50121 @elenril cmdutils: change semantics of show_help_options() and document it.
elenril authored
174 /**
175 * Print help for all options matching specified flags.
176 *
177 * @param options a list of options
178 * @param msg title of this group. Only printed if at least one option matches.
179 * @param req_flags print only options which have all those flags set.
180 * @param rej_flags don't print options which have any of those flags set.
f9fada2 @elenril avconv: split printing "main options" into global and per-file.
elenril authored
181 * @param alt_flags print only options that have at least one of those flags set
7c50121 @elenril cmdutils: change semantics of show_help_options() and document it.
elenril authored
182 */
183 void show_help_options(const OptionDef *options, const char *msg, int req_flags,
f9fada2 @elenril avconv: split printing "main options" into global and per-file.
elenril authored
184 int rej_flags, int alt_flags);
60a9966 Make cmdutils.c:parse_options accept as argument a function to parse
Stefano Sabatini authored
185
186 /**
7a6cd99 @elenril cmdutils/avtools: simplify show_help() by using av_opt_child_class_ne…
elenril authored
187 * Show help for all options with given flags in class and all its
188 * children.
189 */
190 void show_help_children(const AVClass *class, int flags);
191
192 /**
a3ad68d @elenril cmdutils: extend -h to allow printing codec details.
elenril authored
193 * Per-avtool specific help handler. Implemented in each
194 * avtool, called by show_help().
195 */
196 void show_help_default(const char *opt, const char *arg);
197
198 /**
199 * Generic -h handler common to all avtools.
200 */
11d957f @elenril avtools: remove the distinction between func_arg and func2_arg.
elenril authored
201 int show_help(void *optctx, const char *opt, const char *arg);
a3ad68d @elenril cmdutils: extend -h to allow printing codec details.
elenril authored
202
203 /**
49bd8e4 @mansr Fix grammar errors in documentation
mansr authored
204 * Parse the command line arguments.
7cc8d63 @elenril cmdutils: add support for caller-provided option context.
elenril authored
205 *
206 * @param optctx an opaque options context
60a9966 Make cmdutils.c:parse_options accept as argument a function to parse
Stefano Sabatini authored
207 * @param options Array with the definitions required to interpret every
0baf34d @DonDiego Remove angular brackets from Doxygen comments; Doxygen confuses them …
DonDiego authored
208 * option of the form: -option_name [argument]
60a9966 Make cmdutils.c:parse_options accept as argument a function to parse
Stefano Sabatini authored
209 * @param parse_arg_function Name of the function called to process every
210 * argument without a leading option name flag. NULL if such arguments do
211 * not have to be processed.
212 */
7cc8d63 @elenril cmdutils: add support for caller-provided option context.
elenril authored
213 void parse_options(void *optctx, int argc, char **argv, const OptionDef *options,
214 void (* parse_arg_function)(void *optctx, const char*));
60a9966 Make cmdutils.c:parse_options accept as argument a function to parse
Stefano Sabatini authored
215
8d787f8 Document cmdutils.c:print_error().
Stefano Sabatini authored
216 /**
2f8e586 @elenril cmdutils: split per-option code out of parse_options().
elenril authored
217 * Parse one given option.
218 *
219 * @return on success 1 if arg was consumed, 0 otherwise; negative number on error
220 */
0184bbe @gnarula avprobe, cmdutils: K&R formatting cosmetics
gnarula authored
221 int parse_option(void *optctx, const char *opt, const char *arg,
222 const OptionDef *options);
60a9966 Make cmdutils.c:parse_options accept as argument a function to parse
Stefano Sabatini authored
223
8d787f8 Document cmdutils.c:print_error().
Stefano Sabatini authored
224 /**
da9cea7 @DonDiego Fix a bunch of common typos.
DonDiego authored
225 * Find the '-loglevel' option in the command line args and apply it.
182cbe4 @elenril avtools: parse loglevel before all the other options.
elenril authored
226 */
227 void parse_loglevel(int argc, char **argv, const OptionDef *options);
228
229 /**
4138cd2 @elenril avconv: add -cpuflags option for setting supported cpuflags.
elenril authored
230 * Return index of option opt in argv or 0 if not found.
231 */
232 int locate_option(int argc, char **argv, const OptionDef *options,
233 const char *optname);
234
235 /**
d4863fc @elenril cmdutils: allow precisely specifying a stream for AVOptions.
elenril authored
236 * Check if the given stream matches a stream specifier.
237 *
238 * @param s Corresponding format context.
239 * @param st Stream from s to be checked.
e873c03 @DonDiego misc Doxygen markup improvements
DonDiego authored
240 * @param spec A stream specifier of the [v|a|s|d]:[\<stream index\>] form.
d4863fc @elenril cmdutils: allow precisely specifying a stream for AVOptions.
elenril authored
241 *
242 * @return 1 if the stream matches, 0 if it doesn't, <0 on error
243 */
244 int check_stream_specifier(AVFormatContext *s, AVStream *st, const char *spec);
245
246 /**
8c8eab8 @elenril cmdutils: store all codec options in one dict instead of video/audio/sub
elenril authored
247 * Filter out options for given codec.
ce23ca8 cmdutils: clarify documentation for filter_codec_opts()
Stefano Sabatini authored
248 *
249 * Create a new options dictionary containing only the options from
250 * opts which apply to the codec with ID codec_id.
251 *
d4863fc @elenril cmdutils: allow precisely specifying a stream for AVOptions.
elenril authored
252 * @param s Corresponding format context.
253 * @param st A stream from s for which the options should be filtered.
d3ed1c9 @mstorsjo cmdutils: Pass the actual chosen encoder to filter_codec_opts
mstorsjo authored
254 * @param codec The particular codec for which the options should be filtered.
255 * If null, the default one is looked up according to the codec id.
ce23ca8 cmdutils: clarify documentation for filter_codec_opts()
Stefano Sabatini authored
256 * @return a pointer to the created dictionary
8c8eab8 @elenril cmdutils: store all codec options in one dict instead of video/audio/sub
elenril authored
257 */
36ef536 @elenril Replace all CODEC_ID_* with AV_CODEC_ID_*
elenril authored
258 AVDictionary *filter_codec_opts(AVDictionary *opts, enum AVCodecID codec_id,
d3ed1c9 @mstorsjo cmdutils: Pass the actual chosen encoder to filter_codec_opts
mstorsjo authored
259 AVFormatContext *s, AVStream *st, AVCodec *codec);
8c8eab8 @elenril cmdutils: store all codec options in one dict instead of video/audio/sub
elenril authored
260
7cea06d cmdutils: clarify documentation for setup_find_stream_info_opts()
Stefano Sabatini authored
261 /**
262 * Setup AVCodecContext options for avformat_find_stream_info().
263 *
264 * Create an array of dictionaries, one dictionary for each stream
265 * contained in s.
266 * Each dictionary will contain the options from codec_opts which can
267 * be applied to the corresponding stream codec context.
268 *
269 * @return pointer to the created array of dictionaries, NULL if it
270 * cannot be created
3009f52 @elenril ffplay: use new avcodec_open2 and avformat_find_stream_info API.
elenril authored
271 */
0184bbe @gnarula avprobe, cmdutils: K&R formatting cosmetics
gnarula authored
272 AVDictionary **setup_find_stream_info_opts(AVFormatContext *s,
273 AVDictionary *codec_opts);
85663ef @michaelni Move opt_default() and set_context_opts() to cmdutils so it can be us…
michaelni authored
274
8d787f8 Document cmdutils.c:print_error().
Stefano Sabatini authored
275 /**
49bd8e4 @mansr Fix grammar errors in documentation
mansr authored
276 * Print an error message to stderr, indicating filename and a human
8d787f8 Document cmdutils.c:print_error().
Stefano Sabatini authored
277 * readable description of the error code err.
278 *
279 * If strerror_r() is not available the use of this function in a
280 * multithreaded application may be unsafe.
281 *
282 * @see av_strerror()
283 */
01310af added ffplay utility
Fabrice Bellard authored
284 void print_error(const char *filename, int err);
285
f35917b Implement the cmdutils.c show_license function.
Stefano Sabatini authored
286 /**
49bd8e4 @mansr Fix grammar errors in documentation
mansr authored
287 * Print the program banner to stderr. The banner contents depend on the
1506750 @DonDiego Improve wording/grammar of Doxygen comments.
DonDiego authored
288 * current version of the repository and of the libav* libraries used by
289 * the program.
86074ed Implement common show version and banner.
Stefano Sabatini authored
290 */
452406b @michaelni ff*: Fix duplicatedly printed version info with -version
michaelni authored
291 void show_banner(int argc, char **argv, const OptionDef *options);
86074ed Implement common show version and banner.
Stefano Sabatini authored
292
293 /**
49bd8e4 @mansr Fix grammar errors in documentation
mansr authored
294 * Print the version of the program to stdout. The version message
86074ed Implement common show version and banner.
Stefano Sabatini authored
295 * depends on the current versions of the repository and of the libav*
296 * libraries.
a099183 Make all option parsing functions match the function pointer type thr…
Jeff Downs authored
297 * This option processing function does not utilize the arguments.
86074ed Implement common show version and banner.
Stefano Sabatini authored
298 */
11d957f @elenril avtools: remove the distinction between func_arg and func2_arg.
elenril authored
299 int show_version(void *optctx, const char *opt, const char *arg);
86074ed Implement common show version and banner.
Stefano Sabatini authored
300
301 /**
49bd8e4 @mansr Fix grammar errors in documentation
mansr authored
302 * Print the license of the program to stdout. The license depends on
1506750 @DonDiego Improve wording/grammar of Doxygen comments.
DonDiego authored
303 * the license of the libraries compiled into the program.
a099183 Make all option parsing functions match the function pointer type thr…
Jeff Downs authored
304 * This option processing function does not utilize the arguments.
f35917b Implement the cmdutils.c show_license function.
Stefano Sabatini authored
305 */
11d957f @elenril avtools: remove the distinction between func_arg and func2_arg.
elenril authored
306 int show_license(void *optctx, const char *opt, const char *arg);
f35917b Implement the cmdutils.c show_license function.
Stefano Sabatini authored
307
ba9880c Move show_formats() to cmdutils.c.
Stefano Sabatini authored
308 /**
49bd8e4 @mansr Fix grammar errors in documentation
mansr authored
309 * Print a listing containing all the formats supported by the
ba9880c Move show_formats() to cmdutils.c.
Stefano Sabatini authored
310 * program.
a099183 Make all option parsing functions match the function pointer type thr…
Jeff Downs authored
311 * This option processing function does not utilize the arguments.
ba9880c Move show_formats() to cmdutils.c.
Stefano Sabatini authored
312 */
11d957f @elenril avtools: remove the distinction between func_arg and func2_arg.
elenril authored
313 int show_formats(void *optctx, const char *opt, const char *arg);
ba9880c Move show_formats() to cmdutils.c.
Stefano Sabatini authored
314
090b61b Implement read_yesno().
Stefano Sabatini authored
315 /**
49bd8e4 @mansr Fix grammar errors in documentation
mansr authored
316 * Print a listing containing all the codecs supported by the
8447f0b @michaelni Split show_formats().
michaelni authored
317 * program.
a099183 Make all option parsing functions match the function pointer type thr…
Jeff Downs authored
318 * This option processing function does not utilize the arguments.
8447f0b @michaelni Split show_formats().
michaelni authored
319 */
11d957f @elenril avtools: remove the distinction between func_arg and func2_arg.
elenril authored
320 int show_codecs(void *optctx, const char *opt, const char *arg);
8447f0b @michaelni Split show_formats().
michaelni authored
321
322 /**
7c10194 @elenril cmdutils: refactor -codecs option.
elenril authored
323 * Print a listing containing all the decoders supported by the
324 * program.
325 */
11d957f @elenril avtools: remove the distinction between func_arg and func2_arg.
elenril authored
326 int show_decoders(void *optctx, const char *opt, const char *arg);
7c10194 @elenril cmdutils: refactor -codecs option.
elenril authored
327
328 /**
329 * Print a listing containing all the encoders supported by the
330 * program.
331 */
11d957f @elenril avtools: remove the distinction between func_arg and func2_arg.
elenril authored
332 int show_encoders(void *optctx, const char *opt, const char *arg);
8447f0b @michaelni Split show_formats().
michaelni authored
333
334 /**
49bd8e4 @mansr Fix grammar errors in documentation
mansr authored
335 * Print a listing containing all the filters supported by the
62d7566 Implement a -filters option, listing all the available libavfilter
Stefano Sabatini authored
336 * program.
a099183 Make all option parsing functions match the function pointer type thr…
Jeff Downs authored
337 * This option processing function does not utilize the arguments.
62d7566 Implement a -filters option, listing all the available libavfilter
Stefano Sabatini authored
338 */
11d957f @elenril avtools: remove the distinction between func_arg and func2_arg.
elenril authored
339 int show_filters(void *optctx, const char *opt, const char *arg);
62d7566 Implement a -filters option, listing all the available libavfilter
Stefano Sabatini authored
340
341 /**
49bd8e4 @mansr Fix grammar errors in documentation
mansr authored
342 * Print a listing containing all the bit stream filters supported by the
8447f0b @michaelni Split show_formats().
michaelni authored
343 * program.
a099183 Make all option parsing functions match the function pointer type thr…
Jeff Downs authored
344 * This option processing function does not utilize the arguments.
8447f0b @michaelni Split show_formats().
michaelni authored
345 */
11d957f @elenril avtools: remove the distinction between func_arg and func2_arg.
elenril authored
346 int show_bsfs(void *optctx, const char *opt, const char *arg);
8447f0b @michaelni Split show_formats().
michaelni authored
347
348 /**
49bd8e4 @mansr Fix grammar errors in documentation
mansr authored
349 * Print a listing containing all the protocols supported by the
8447f0b @michaelni Split show_formats().
michaelni authored
350 * program.
a099183 Make all option parsing functions match the function pointer type thr…
Jeff Downs authored
351 * This option processing function does not utilize the arguments.
8447f0b @michaelni Split show_formats().
michaelni authored
352 */
11d957f @elenril avtools: remove the distinction between func_arg and func2_arg.
elenril authored
353 int show_protocols(void *optctx, const char *opt, const char *arg);
8447f0b @michaelni Split show_formats().
michaelni authored
354
355 /**
49bd8e4 @mansr Fix grammar errors in documentation
mansr authored
356 * Print a listing containing all the pixel formats supported by the
3f7bb42 Implement a -pix_fmts option for listing all the supported pixel
Stefano Sabatini authored
357 * program.
a099183 Make all option parsing functions match the function pointer type thr…
Jeff Downs authored
358 * This option processing function does not utilize the arguments.
3f7bb42 Implement a -pix_fmts option for listing all the supported pixel
Stefano Sabatini authored
359 */
11d957f @elenril avtools: remove the distinction between func_arg and func2_arg.
elenril authored
360 int show_pix_fmts(void *optctx, const char *opt, const char *arg);
3f7bb42 Implement a -pix_fmts option for listing all the supported pixel
Stefano Sabatini authored
361
362 /**
786dadc cmdutils: add -layouts option.
Nicolas George authored
363 * Print a listing containing all the standard channel layouts supported by
364 * the program.
365 * This option processing function does not utilize the arguments.
366 */
98298eb @michaelni Merge commit 'ec36aa69448f20a78d8c4588265022e0b2272ab5'
michaelni authored
367 int show_layouts(void *optctx, const char *opt, const char *arg);
786dadc cmdutils: add -layouts option.
Nicolas George authored
368
369 /**
05bffc1 @elenril avconv: move audio_sample_fmt to options context.
elenril authored
370 * Print a listing containing all the sample formats supported by the
371 * program.
372 */
11d957f @elenril avtools: remove the distinction between func_arg and func2_arg.
elenril authored
373 int show_sample_fmts(void *optctx, const char *opt, const char *arg);
3f7bb42 Implement a -pix_fmts option for listing all the supported pixel
Stefano Sabatini authored
374
375 /**
48966b0 @mansr Grammar fixes
mansr authored
376 * Return a positive value if a line read from standard input
377 * starts with [yY], otherwise return 0.
090b61b Implement read_yesno().
Stefano Sabatini authored
378 */
379 int read_yesno(void);
380
458b062 Implement cmdutils.c:read_file(), and use it in ffmpeg.c for reading
Stefano Sabatini authored
381 /**
49bd8e4 @mansr Fix grammar errors in documentation
mansr authored
382 * Read the file with name filename, and put its content in a newly
458b062 Implement cmdutils.c:read_file(), and use it in ffmpeg.c for reading
Stefano Sabatini authored
383 * allocated 0-terminated buffer.
384 *
49bd8e4 @mansr Fix grammar errors in documentation
mansr authored
385 * @param bufptr location where pointer to buffer is returned
386 * @param size location where size of buffer is returned
458b062 Implement cmdutils.c:read_file(), and use it in ffmpeg.c for reading
Stefano Sabatini authored
387 * @return 0 in case of success, a negative value corresponding to an
388 * AVERROR error code in case of failure.
389 */
0217099 @mstorsjo cmdutils: Rename read_file to cmdutils_read_file
mstorsjo authored
390 int cmdutils_read_file(const char *filename, char **bufptr, size_t *size);
458b062 Implement cmdutils.c:read_file(), and use it in ffmpeg.c for reading
Stefano Sabatini authored
391
6e87293 Implement get_preset_file() in cmdutils.h and use it to factorize code
Stefano Sabatini authored
392 /**
393 * Get a file corresponding to a preset file.
394 *
395 * If is_path is non-zero, look for the file in the path preset_name.
396 * Otherwise search for a file named arg.ffpreset in the directories
397 * $FFMPEG_DATADIR (if set), $HOME/.ffmpeg, and in the datadir defined
1b30e4f preset dir for win32
Gianluigi Tiesi authored
398 * at configuration time or in a "ffpresets" folder along the executable
399 * on win32, in that order. If no such file is found and
6e87293 Implement get_preset_file() in cmdutils.h and use it to factorize code
Stefano Sabatini authored
400 * codec_name is defined, then search for a file named
050dc12 Read preset files with suffix .avpreset
Reinhard Tartler authored
401 * codec_name-preset_name.avpreset in the above-mentioned directories.
6e87293 Implement get_preset_file() in cmdutils.h and use it to factorize code
Stefano Sabatini authored
402 *
403 * @param filename buffer where the name of the found filename is written
404 * @param filename_size size in bytes of the filename buffer
405 * @param preset_name name of the preset to search
406 * @param is_path tell if preset_name is a filename path
407 * @param codec_name name of the codec for which to look for the
408 * preset, may be NULL
409 */
410 FILE *get_preset_file(char *filename, size_t filename_size,
411 const char *preset_name, int is_path, const char *codec_name);
412
dad09ff @elenril cmdutils: move exit_program() declaration to cmdutils from avconv
elenril authored
413 /**
414 * Do all the necessary cleanup and abort.
415 * This function is implemented in the avtools, not cmdutils.
416 */
22662ca attributes: add av_noreturn
Reinhard Tartler authored
417 av_noreturn void exit_program(int ret);
dad09ff @elenril cmdutils: move exit_program() declaration to cmdutils from avconv
elenril authored
418
cac651c @elenril cmdutils: move grow_array() from avconv to cmdutils.
elenril authored
419 /**
420 * Realloc array to hold new_size elements of elem_size.
421 * Calls exit_program() on failure.
422 *
423 * @param elem_size size in bytes of each element
424 * @param size new element count will be written here
425 * @return reallocated array
426 */
427 void *grow_array(void *array, int elem_size, int *size, int new_size);
428
d55c2e0 @elenril avtools: move buffer management code from avconv to cmdutils.
elenril authored
429 typedef struct FrameBuffer {
430 uint8_t *base[4];
431 uint8_t *data[4];
432 int linesize[4];
433
434 int h, w;
435 enum PixelFormat pix_fmt;
436
437 int refcount;
438 struct FrameBuffer **pool; ///< head of the buffer pool
439 struct FrameBuffer *next;
440 } FrameBuffer;
441
442 /**
443 * Get a frame from the pool. This is intended to be used as a callback for
444 * AVCodecContext.get_buffer.
445 *
446 * @param s codec context. s->opaque must be a pointer to the head of the
447 * buffer pool.
448 * @param frame frame->opaque will be set to point to the FrameBuffer
449 * containing the frame data.
450 */
451 int codec_get_buffer(AVCodecContext *s, AVFrame *frame);
452
453 /**
454 * A callback to be used for AVCodecContext.release_buffer along with
455 * codec_get_buffer().
456 */
457 void codec_release_buffer(AVCodecContext *s, AVFrame *frame);
458
459 /**
460 * A callback to be used for AVFilterBuffer.free.
461 * @param fb buffer to free. fb->priv must be a pointer to the FrameBuffer
462 * containing the buffer data.
463 */
464 void filter_release_buffer(AVFilterBuffer *fb);
465
466 /**
467 * Free all the buffers in the pool. This must be called after all the
468 * buffers have been released.
469 */
470 void free_buffer_pool(FrameBuffer **pool);
a3ad68d @elenril cmdutils: extend -h to allow printing codec details.
elenril authored
471
472 #define GET_PIX_FMT_NAME(pix_fmt)\
473 const char *name = av_get_pix_fmt_name(pix_fmt);
474
475 #define GET_SAMPLE_FMT_NAME(sample_fmt)\
476 const char *name = av_get_sample_fmt_name(sample_fmt)
477
478 #define GET_SAMPLE_RATE_NAME(rate)\
479 char name[16];\
480 snprintf(name, sizeof(name), "%d", rate);
481
482 #define GET_CH_LAYOUT_NAME(ch_layout)\
483 char name[16];\
484 snprintf(name, sizeof(name), "0x%"PRIx64, ch_layout);
485
486 #define GET_CH_LAYOUT_DESC(ch_layout)\
487 char name[128];\
488 av_get_channel_layout_string(name, sizeof(name), 0, ch_layout);
489
90705aa @michaelni cmdutils.h: Project name cleanup
michaelni authored
490 #endif /* CMDUTILS_H */
Something went wrong with that request. Please try again.