]> jfr.im git - yt-dlp.git/blame - youtube_dl/options.py
[utils] Modernize
[yt-dlp.git] / youtube_dl / options.py
CommitLineData
2daabe49
PH
1from __future__ import unicode_literals
2
34a741a8
PH
3import os.path
4import optparse
5import shlex
6import sys
7
8c25f81b 8from .compat import (
4644ac55
S
9 compat_expanduser,
10 compat_getenv,
8c25f81b
PH
11)
12from .utils import (
34a741a8
PH
13 get_term_width,
14 write_string,
15)
16from .version import __version__
17
18
19def parseOpts(overrideArguments=None):
20 def _readOptions(filename_bytes, default=[]):
21 try:
22 optionf = open(filename_bytes)
23 except IOError:
24 return default # silently skip if file is not present
25 try:
26 res = []
27 for l in optionf:
28 res += shlex.split(l, comments=True)
29 finally:
30 optionf.close()
31 return res
32
33 def _readUserConf():
4644ac55 34 xdg_config_home = compat_getenv('XDG_CONFIG_HOME')
34a741a8
PH
35 if xdg_config_home:
36 userConfFile = os.path.join(xdg_config_home, 'youtube-dl', 'config')
37 if not os.path.isfile(userConfFile):
38 userConfFile = os.path.join(xdg_config_home, 'youtube-dl.conf')
39 else:
4644ac55 40 userConfFile = os.path.join(compat_expanduser('~'), '.config', 'youtube-dl', 'config')
34a741a8 41 if not os.path.isfile(userConfFile):
4644ac55 42 userConfFile = os.path.join(compat_expanduser('~'), '.config', 'youtube-dl.conf')
34a741a8
PH
43 userConf = _readOptions(userConfFile, None)
44
45 if userConf is None:
4644ac55 46 appdata_dir = compat_getenv('appdata')
34a741a8
PH
47 if appdata_dir:
48 userConf = _readOptions(
49 os.path.join(appdata_dir, 'youtube-dl', 'config'),
50 default=None)
51 if userConf is None:
52 userConf = _readOptions(
53 os.path.join(appdata_dir, 'youtube-dl', 'config.txt'),
54 default=None)
55
56 if userConf is None:
57 userConf = _readOptions(
4644ac55 58 os.path.join(compat_expanduser('~'), 'youtube-dl.conf'),
34a741a8
PH
59 default=None)
60 if userConf is None:
61 userConf = _readOptions(
4644ac55 62 os.path.join(compat_expanduser('~'), 'youtube-dl.conf.txt'),
34a741a8
PH
63 default=None)
64
65 if userConf is None:
66 userConf = []
67
68 return userConf
69
70 def _format_option_string(option):
71 ''' ('-o', '--option') -> -o, --format METAVAR'''
72
73 opts = []
74
75 if option._short_opts:
76 opts.append(option._short_opts[0])
77 if option._long_opts:
78 opts.append(option._long_opts[0])
79 if len(opts) > 1:
80 opts.insert(1, ', ')
81
8450c15c
PH
82 if option.takes_value():
83 opts.append(' %s' % option.metavar)
34a741a8
PH
84
85 return "".join(opts)
86
87 def _comma_separated_values_options_callback(option, opt_str, value, parser):
88 setattr(parser.values, option.dest, value.split(','))
89
90 def _hide_login_info(opts):
91 opts = list(opts)
92 for private_opt in ['-p', '--password', '-u', '--username', '--video-password']:
93 try:
94 i = opts.index(private_opt)
8450c15c 95 opts[i + 1] = 'PRIVATE'
34a741a8
PH
96 except ValueError:
97 pass
98 return opts
99
34a741a8
PH
100 # No need to wrap help messages if we're on a wide console
101 columns = get_term_width()
8450c15c
PH
102 max_width = columns if columns else 80
103 max_help_position = 80
34a741a8
PH
104
105 fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position)
106 fmt.format_option_strings = _format_option_string
107
108 kw = {
8450c15c
PH
109 'version': __version__,
110 'formatter': fmt,
111 'usage': '%prog [options] url [url...]',
112 'conflict_handler': 'resolve',
34a741a8
PH
113 }
114
115 parser = optparse.OptionParser(**kw)
116
8450c15c
PH
117 general = optparse.OptionGroup(parser, 'General Options')
118 general.add_option(
119 '-h', '--help',
120 action='help',
121 help='print this help text and exit')
122 general.add_option(
123 '-v', '--version',
124 action='version',
125 help='print program version and exit')
126 general.add_option(
127 '-U', '--update',
128 action='store_true', dest='update_self',
129 help='update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
130 general.add_option(
131 '-i', '--ignore-errors',
132 action='store_true', dest='ignoreerrors', default=False,
133 help='continue on download errors, for example to skip unavailable videos in a playlist')
134 general.add_option(
135 '--abort-on-error',
136 action='store_false', dest='ignoreerrors',
137 help='Abort downloading of further videos (in the playlist or the command line) if an error occurs')
138 general.add_option(
139 '--dump-user-agent',
140 action='store_true', dest='dump_user_agent', default=False,
141 help='display the current browser identification')
34a741a8 142 general.add_option(
8450c15c
PH
143 '--list-extractors',
144 action='store_true', dest='list_extractors', default=False,
145 help='List all supported extractors and the URLs they would handle')
146 general.add_option(
147 '--extractor-descriptions',
148 action='store_true', dest='list_extractor_descriptions', default=False,
149 help='Output descriptions of all supported extractors')
150 general.add_option(
151 '--proxy', dest='proxy',
152 default=None, metavar='URL',
34a741a8
PH
153 help='Use the specified HTTP/HTTPS proxy. Pass in an empty string (--proxy "") for direct connection')
154 general.add_option(
8450c15c
PH
155 '--socket-timeout',
156 dest='socket_timeout', type=float, default=None,
157 help='Time to wait before giving up, in seconds')
34a741a8
PH
158 general.add_option(
159 '--default-search',
160 dest='default_search', metavar='PREFIX',
161 help='Use this prefix for unqualified URLs. For example "gvsearch2:" downloads two videos from google videos for youtube-dl "large apple". Use the value "auto" to let youtube-dl guess ("auto_warning" to emit a warning when guessing). "error" just throws an error. The default value "fixup_error" repairs broken URLs, but emits an error if this is not possible instead of searching.')
162 general.add_option(
163 '--ignore-config',
164 action='store_true',
165 help='Do not read configuration files. When given in the global configuration file /etc/youtube-dl.conf: do not read the user configuration in ~/.config/youtube-dl.conf (%APPDATA%/youtube-dl/config.txt on Windows)')
057a5206
PH
166 general.add_option(
167 '--flat-playlist',
168 action='store_const', dest='extract_flat', const='in_playlist',
169 default=False,
170 help='Do not extract the videos of a playlist, only list them.')
34a741a8 171
8450c15c 172 selection = optparse.OptionGroup(parser, 'Video Selection')
34a741a8
PH
173 selection.add_option(
174 '--playlist-start',
175 dest='playliststart', metavar='NUMBER', default=1, type=int,
176 help='playlist video to start at (default is %default)')
177 selection.add_option(
178 '--playlist-end',
179 dest='playlistend', metavar='NUMBER', default=None, type=int,
180 help='playlist video to end at (default is last)')
34a741a8 181 selection.add_option(
8450c15c
PH
182 '--match-title',
183 dest='matchtitle', metavar='REGEX',
184 help='download only matching titles (regex or caseless sub-string)')
185 selection.add_option(
186 '--reject-title',
187 dest='rejecttitle', metavar='REGEX',
188 help='skip download for matching titles (regex or caseless sub-string)')
189 selection.add_option(
190 '--max-downloads',
191 dest='max_downloads', metavar='NUMBER', type=int, default=None,
192 help='Abort after downloading NUMBER files')
193 selection.add_option(
194 '--min-filesize',
195 metavar='SIZE', dest='min_filesize', default=None,
196 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
197 selection.add_option(
198 '--max-filesize',
199 metavar='SIZE', dest='max_filesize', default=None,
200 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
201 selection.add_option(
202 '--date',
203 metavar='DATE', dest='date', default=None,
204 help='download only videos uploaded in this date')
205 selection.add_option(
206 '--datebefore',
207 metavar='DATE', dest='datebefore', default=None,
34a741a8
PH
208 help='download only videos uploaded on or before this date (i.e. inclusive)')
209 selection.add_option(
8450c15c
PH
210 '--dateafter',
211 metavar='DATE', dest='dateafter', default=None,
34a741a8
PH
212 help='download only videos uploaded on or after this date (i.e. inclusive)')
213 selection.add_option(
8450c15c
PH
214 '--min-views',
215 metavar='COUNT', dest='min_views', default=None, type=int,
216 help='Do not download any videos with less than COUNT views',)
34a741a8 217 selection.add_option(
8450c15c
PH
218 '--max-views',
219 metavar='COUNT', dest='max_views', default=None, type=int,
220 help='Do not download any videos with more than COUNT views')
34a741a8 221 selection.add_option(
8450c15c
PH
222 '--no-playlist',
223 action='store_true', dest='noplaylist', default=False,
224 help='download only the currently playing video')
225 selection.add_option(
226 '--age-limit',
227 metavar='YEARS', dest='age_limit', default=None, type=int,
228 help='download only videos suitable for the given age')
229 selection.add_option(
230 '--download-archive', metavar='FILE',
231 dest='download_archive',
232 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.')
233 selection.add_option(
234 '--include-ads',
235 dest='include_ads', action='store_true',
34a741a8 236 help='Download advertisements as well (experimental)')
34a741a8 237
8450c15c
PH
238 authentication = optparse.OptionGroup(parser, 'Authentication Options')
239 authentication.add_option(
240 '-u', '--username',
241 dest='username', metavar='USERNAME',
242 help='login with this account ID')
243 authentication.add_option(
244 '-p', '--password',
245 dest='password', metavar='PASSWORD',
246 help='account password')
247 authentication.add_option(
248 '-2', '--twofactor',
249 dest='twofactor', metavar='TWOFACTOR',
250 help='two-factor auth code')
251 authentication.add_option(
252 '-n', '--netrc',
253 action='store_true', dest='usenetrc', default=False,
254 help='use .netrc authentication data')
255 authentication.add_option(
256 '--video-password',
257 dest='videopassword', metavar='PASSWORD',
258 help='video password (vimeo, smotri)')
259
260 video_format = optparse.OptionGroup(parser, 'Video Format Options')
261 video_format.add_option(
262 '-f', '--format',
263 action='store', dest='format', metavar='FORMAT', default=None,
264 help='video format code, specify the order of preference using slashes: -f 22/17/18 . -f mp4 , -f m4a and -f flv are also supported. You can also use the special names "best", "bestvideo", "bestaudio", "worst", "worstvideo" and "worstaudio". By default, youtube-dl will pick the best quality. Use commas to download multiple audio formats, such as -f 136/137/mp4/bestvideo,140/m4a/bestaudio')
265 video_format.add_option(
266 '--all-formats',
267 action='store_const', dest='format', const='all',
268 help='download all available video formats')
269 video_format.add_option(
270 '--prefer-free-formats',
271 action='store_true', dest='prefer_free_formats', default=False,
272 help='prefer free video formats unless a specific one is requested')
273 video_format.add_option(
274 '--max-quality',
275 action='store', dest='format_limit', metavar='FORMAT',
276 help='highest quality format to download')
277 video_format.add_option(
278 '-F', '--list-formats',
279 action='store_true', dest='listformats',
280 help='list all available formats')
203fb43f
PH
281 video_format.add_option(
282 '--youtube-include-dash-manifest',
283 action='store_true', dest='youtube_include_dash_manifest', default=True,
284 help=optparse.SUPPRESS_HELP)
285 video_format.add_option(
286 '--youtube-skip-dash-manifest',
287 action='store_false', dest='youtube_include_dash_manifest',
288 help='Do not download the DASH manifest on YouTube videos')
8450c15c
PH
289
290 subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
291 subtitles.add_option(
292 '--write-sub', '--write-srt',
293 action='store_true', dest='writesubtitles', default=False,
294 help='write subtitle file')
295 subtitles.add_option(
296 '--write-auto-sub', '--write-automatic-sub',
297 action='store_true', dest='writeautomaticsub', default=False,
298 help='write automatic subtitle file (youtube only)')
299 subtitles.add_option(
300 '--all-subs',
301 action='store_true', dest='allsubtitles', default=False,
302 help='downloads all the available subtitles of the video')
303 subtitles.add_option(
304 '--list-subs',
305 action='store_true', dest='listsubtitles', default=False,
306 help='lists all available subtitles for the video')
307 subtitles.add_option(
308 '--sub-format',
309 action='store', dest='subtitlesformat', metavar='FORMAT', default='srt',
310 help='subtitle format (default=srt) ([sbv/vtt] youtube only)')
311 subtitles.add_option(
312 '--sub-lang', '--sub-langs', '--srt-lang',
313 action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
314 default=[], callback=_comma_separated_values_options_callback,
315 help='languages of the subtitles to download (optional) separated by commas, use IETF language tags like \'en,pt\'')
316
317 downloader = optparse.OptionGroup(parser, 'Download Options')
318 downloader.add_option(
319 '-r', '--rate-limit',
320 dest='ratelimit', metavar='LIMIT',
321 help='maximum download rate in bytes per second (e.g. 50K or 4.2M)')
322 downloader.add_option(
323 '-R', '--retries',
324 dest='retries', metavar='RETRIES', default=10,
325 help='number of retries (default is %default)')
326 downloader.add_option(
327 '--buffer-size',
328 dest='buffersize', metavar='SIZE', default='1024',
329 help='size of download buffer (e.g. 1024 or 16K) (default is %default)')
330 downloader.add_option(
331 '--no-resize-buffer',
332 action='store_true', dest='noresizebuffer', default=False,
333 help='do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.')
334 downloader.add_option(
335 '--test',
336 action='store_true', dest='test', default=False,
337 help=optparse.SUPPRESS_HELP)
338
339 workarounds = optparse.OptionGroup(parser, 'Workarounds')
34a741a8 340 workarounds.add_option(
8450c15c
PH
341 '--encoding',
342 dest='encoding', metavar='ENCODING',
34a741a8
PH
343 help='Force the specified encoding (experimental)')
344 workarounds.add_option(
8450c15c
PH
345 '--no-check-certificate',
346 action='store_true', dest='no_check_certificate', default=False,
34a741a8
PH
347 help='Suppress HTTPS certificate validation.')
348 workarounds.add_option(
8450c15c
PH
349 '--prefer-insecure',
350 '--prefer-unsecure', action='store_true', dest='prefer_insecure',
34a741a8
PH
351 help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)')
352 workarounds.add_option(
8450c15c
PH
353 '--user-agent',
354 metavar='UA', dest='user_agent',
355 help='specify a custom user agent')
34a741a8 356 workarounds.add_option(
8450c15c
PH
357 '--referer',
358 metavar='URL', dest='referer', default=None,
34a741a8
PH
359 help='specify a custom referer, use if the video access is restricted to one domain',
360 )
361 workarounds.add_option(
8450c15c
PH
362 '--add-header',
363 metavar='FIELD:VALUE', dest='headers', action='append',
34a741a8
PH
364 help='specify a custom HTTP header and its value, separated by a colon \':\'. You can use this option multiple times',
365 )
366 workarounds.add_option(
8450c15c
PH
367 '--bidi-workaround',
368 dest='bidi_workaround', action='store_true',
369 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
34a741a8 370
8450c15c
PH
371 verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
372 verbosity.add_option(
373 '-q', '--quiet',
374 action='store_true', dest='quiet', default=False,
375 help='activates quiet mode')
34a741a8
PH
376 verbosity.add_option(
377 '--no-warnings',
378 dest='no_warnings', action='store_true', default=False,
379 help='Ignore warnings')
8450c15c
PH
380 verbosity.add_option(
381 '-s', '--simulate',
382 action='store_true', dest='simulate', default=False,
383 help='do not download the video and do not write anything to disk',)
384 verbosity.add_option(
385 '--skip-download',
386 action='store_true', dest='skip_download', default=False,
387 help='do not download the video',)
388 verbosity.add_option(
389 '-g', '--get-url',
390 action='store_true', dest='geturl', default=False,
391 help='simulate, quiet but print URL')
392 verbosity.add_option(
393 '-e', '--get-title',
394 action='store_true', dest='gettitle', default=False,
395 help='simulate, quiet but print title')
396 verbosity.add_option(
397 '--get-id',
398 action='store_true', dest='getid', default=False,
399 help='simulate, quiet but print id')
400 verbosity.add_option(
401 '--get-thumbnail',
402 action='store_true', dest='getthumbnail', default=False,
403 help='simulate, quiet but print thumbnail URL')
404 verbosity.add_option(
405 '--get-description',
406 action='store_true', dest='getdescription', default=False,
407 help='simulate, quiet but print video description')
408 verbosity.add_option(
409 '--get-duration',
410 action='store_true', dest='getduration', default=False,
411 help='simulate, quiet but print video length')
412 verbosity.add_option(
413 '--get-filename',
414 action='store_true', dest='getfilename', default=False,
415 help='simulate, quiet but print output filename')
416 verbosity.add_option(
417 '--get-format',
418 action='store_true', dest='getformat', default=False,
419 help='simulate, quiet but print output format')
420 verbosity.add_option(
421 '-j', '--dump-json',
422 action='store_true', dest='dumpjson', default=False,
423 help='simulate, quiet but print JSON information. See --output for a description of available keys.')
63e0be34
PH
424 verbosity.add_option(
425 '-J', '--dump-single-json',
426 action='store_true', dest='dump_single_json', default=False,
427 help='simulate, quiet but print JSON information for each command-line argument. If the URL refers to a playlist, dump the whole playlist information in a single line.')
8450c15c
PH
428 verbosity.add_option(
429 '--newline',
430 action='store_true', dest='progress_with_newline', default=False,
431 help='output progress bar as new lines')
432 verbosity.add_option(
433 '--no-progress',
434 action='store_true', dest='noprogress', default=False,
435 help='do not print progress bar')
436 verbosity.add_option(
437 '--console-title',
438 action='store_true', dest='consoletitle', default=False,
439 help='display progress in console titlebar')
440 verbosity.add_option(
441 '-v', '--verbose',
442 action='store_true', dest='verbose', default=False,
443 help='print various debugging information')
444 verbosity.add_option(
445 '--dump-intermediate-pages',
446 action='store_true', dest='dump_intermediate_pages', default=False,
447 help='print downloaded pages to debug problems (very verbose)')
448 verbosity.add_option(
449 '--write-pages',
450 action='store_true', dest='write_pages', default=False,
451 help='Write downloaded intermediary pages to files in the current directory to debug problems')
452 verbosity.add_option(
453 '--youtube-print-sig-code',
454 action='store_true', dest='youtube_print_sig_code', default=False,
455 help=optparse.SUPPRESS_HELP)
456 verbosity.add_option(
457 '--print-traffic',
458 dest='debug_printtraffic', action='store_true', default=False,
459 help='Display sent and read HTTP traffic')
460
461 filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
462 filesystem.add_option(
463 '-a', '--batch-file',
464 dest='batchfile', metavar='FILE',
465 help='file containing URLs to download (\'-\' for stdin)')
466 filesystem.add_option(
467 '--id', default=False,
468 action='store_true', dest='useid', help='use only video ID in file name')
469 filesystem.add_option(
470 '-A', '--auto-number',
471 action='store_true', dest='autonumber', default=False,
472 help='number downloaded files starting from 00000')
473 filesystem.add_option(
474 '-o', '--output',
475 dest='outtmpl', metavar='TEMPLATE',
476 help=('output filename template. Use %(title)s to get the title, '
477 '%(uploader)s for the uploader name, %(uploader_id)s for the uploader nickname if different, '
478 '%(autonumber)s to get an automatically incremented number, '
479 '%(ext)s for the filename extension, '
480 '%(format)s for the format description (like "22 - 1280x720" or "HD"), '
481 '%(format_id)s for the unique id of the format (like Youtube\'s itags: "137"), '
482 '%(upload_date)s for the upload date (YYYYMMDD), '
483 '%(extractor)s for the provider (youtube, metacafe, etc), '
484 '%(id)s for the video id, %(playlist)s for the playlist the video is in, '
485 '%(playlist_index)s for the position in the playlist and %% for a literal percent. '
486 '%(height)s and %(width)s for the width and height of the video format. '
487 '%(resolution)s for a textual description of the resolution of the video format. '
488 'Use - to output to stdout. Can also be used to download to a different directory, '
489 'for example with -o \'/my/downloads/%(uploader)s/%(title)s-%(id)s.%(ext)s\' .'))
490 filesystem.add_option(
491 '--autonumber-size',
492 dest='autonumber_size', metavar='NUMBER',
493 help='Specifies the number of digits in %(autonumber)s when it is present in output filename template or --auto-number option is given')
494 filesystem.add_option(
495 '--restrict-filenames',
496 action='store_true', dest='restrictfilenames', default=False,
497 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
498 filesystem.add_option(
499 '-t', '--title',
500 action='store_true', dest='usetitle', default=False,
501 help='[deprecated] use title in file name (default)')
502 filesystem.add_option(
503 '-l', '--literal', default=False,
504 action='store_true', dest='usetitle',
505 help='[deprecated] alias of --title')
506 filesystem.add_option(
507 '-w', '--no-overwrites',
508 action='store_true', dest='nooverwrites', default=False,
509 help='do not overwrite files')
510 filesystem.add_option(
511 '-c', '--continue',
512 action='store_true', dest='continue_dl', default=True,
513 help='force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.')
514 filesystem.add_option(
515 '--no-continue',
516 action='store_false', dest='continue_dl',
517 help='do not resume partially downloaded files (restart from beginning)')
518 filesystem.add_option(
519 '--no-part',
520 action='store_true', dest='nopart', default=False,
521 help='do not use .part files - write directly into output file')
522 filesystem.add_option(
523 '--no-mtime',
524 action='store_false', dest='updatetime', default=True,
525 help='do not use the Last-modified header to set the file modification time')
526 filesystem.add_option(
527 '--write-description',
528 action='store_true', dest='writedescription', default=False,
529 help='write video description to a .description file')
530 filesystem.add_option(
531 '--write-info-json',
532 action='store_true', dest='writeinfojson', default=False,
533 help='write video metadata to a .info.json file')
534 filesystem.add_option(
535 '--write-annotations',
536 action='store_true', dest='writeannotations', default=False,
537 help='write video annotations to a .annotation file')
538 filesystem.add_option(
539 '--write-thumbnail',
540 action='store_true', dest='writethumbnail', default=False,
541 help='write thumbnail image to disk')
542 filesystem.add_option(
543 '--load-info',
544 dest='load_info_filename', metavar='FILE',
545 help='json file containing the video information (created with the "--write-json" option)')
546 filesystem.add_option(
547 '--cookies',
548 dest='cookiefile', metavar='FILE',
549 help='file to read cookies from and dump cookie jar in')
34a741a8
PH
550 filesystem.add_option(
551 '--cache-dir', dest='cachedir', default=None, metavar='DIR',
552 help='Location in the filesystem where youtube-dl can store some downloaded information permanently. By default $XDG_CACHE_HOME/youtube-dl or ~/.cache/youtube-dl . At the moment, only YouTube player files (for videos with obfuscated signatures) are cached, but that may change.')
553 filesystem.add_option(
554 '--no-cache-dir', action='store_const', const=False, dest='cachedir',
555 help='Disable filesystem caching')
556 filesystem.add_option(
8450c15c
PH
557 '--rm-cache-dir',
558 action='store_true', dest='rm_cachedir',
34a741a8
PH
559 help='Delete all filesystem cache files')
560
8450c15c
PH
561 postproc = optparse.OptionGroup(parser, 'Post-processing Options')
562 postproc.add_option(
563 '-x', '--extract-audio',
564 action='store_true', dest='extractaudio', default=False,
565 help='convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)')
566 postproc.add_option(
567 '--audio-format', metavar='FORMAT', dest='audioformat', default='best',
568 help='"best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; "%default" by default')
569 postproc.add_option(
570 '--audio-quality', metavar='QUALITY',
571 dest='audioquality', default='5',
572 help='ffmpeg/avconv audio quality specification, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default %default)')
573 postproc.add_option(
574 '--recode-video',
575 metavar='FORMAT', dest='recodevideo', default=None,
576 help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv)')
577 postproc.add_option(
578 '-k', '--keep-video',
579 action='store_true', dest='keepvideo', default=False,
580 help='keeps the video file on disk after the post-processing; the video is erased by default')
581 postproc.add_option(
582 '--no-post-overwrites',
583 action='store_true', dest='nopostoverwrites', default=False,
584 help='do not overwrite post-processed files; the post-processed files are overwritten by default')
585 postproc.add_option(
586 '--embed-subs',
587 action='store_true', dest='embedsubtitles', default=False,
588 help='embed subtitles in the video (only for mp4 videos)')
589 postproc.add_option(
590 '--embed-thumbnail',
591 action='store_true', dest='embedthumbnail', default=False,
592 help='embed thumbnail in the audio as cover art')
593 postproc.add_option(
594 '--add-metadata',
595 action='store_true', dest='addmetadata', default=False,
596 help='write metadata to the video file')
597 postproc.add_option(
598 '--xattrs',
599 action='store_true', dest='xattrs', default=False,
600 help='write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
601 postproc.add_option(
602 '--prefer-avconv',
603 action='store_false', dest='prefer_ffmpeg',
34a741a8 604 help='Prefer avconv over ffmpeg for running the postprocessors (default)')
8450c15c
PH
605 postproc.add_option(
606 '--prefer-ffmpeg',
607 action='store_true', dest='prefer_ffmpeg',
34a741a8
PH
608 help='Prefer ffmpeg over avconv for running the postprocessors')
609 postproc.add_option(
8450c15c
PH
610 '--exec',
611 metavar='CMD', dest='exec_cmd',
34a741a8
PH
612 help='Execute a command on the file after downloading, similar to find\'s -exec syntax. Example: --exec \'adb push {} /sdcard/Music/ && rm {}\'' )
613
614 parser.add_option_group(general)
615 parser.add_option_group(selection)
616 parser.add_option_group(downloader)
617 parser.add_option_group(filesystem)
618 parser.add_option_group(verbosity)
619 parser.add_option_group(workarounds)
620 parser.add_option_group(video_format)
621 parser.add_option_group(subtitles)
622 parser.add_option_group(authentication)
623 parser.add_option_group(postproc)
624
625 if overrideArguments is not None:
626 opts, args = parser.parse_args(overrideArguments)
627 if opts.verbose:
8450c15c 628 write_string('[debug] Override config: ' + repr(overrideArguments) + '\n')
34a741a8
PH
629 else:
630 commandLineConf = sys.argv[1:]
631 if '--ignore-config' in commandLineConf:
632 systemConf = []
633 userConf = []
634 else:
635 systemConf = _readOptions('/etc/youtube-dl.conf')
636 if '--ignore-config' in systemConf:
637 userConf = []
638 else:
639 userConf = _readUserConf()
640 argv = systemConf + userConf + commandLineConf
641
642 opts, args = parser.parse_args(argv)
643 if opts.verbose:
8450c15c
PH
644 write_string('[debug] System config: ' + repr(_hide_login_info(systemConf)) + '\n')
645 write_string('[debug] User config: ' + repr(_hide_login_info(userConf)) + '\n')
646 write_string('[debug] Command-line args: ' + repr(_hide_login_info(commandLineConf)) + '\n')
34a741a8
PH
647
648 return parser, opts, args