1 from __future__ import unicode_literals
7 from .downloader.external import list_external_downloaders
10 compat_get_terminal_size,
19 from .version import __version__
22 def parseOpts(overrideArguments=None):
23 def _readOptions(filename_bytes, default=[]):
25 optionf = open(filename_bytes)
27 return default # silently skip if file is not present
31 res += compat_shlex_split(l, comments=True)
37 xdg_config_home = compat_getenv('XDG_CONFIG_HOME')
39 userConfFile = os.path.join(xdg_config_home, 'youtube-dl', 'config')
40 if not os.path.isfile(userConfFile):
41 userConfFile = os.path.join(xdg_config_home, 'youtube-dl.conf')
43 userConfFile = os.path.join(compat_expanduser('~'), '.config', 'youtube-dl', 'config')
44 if not os.path.isfile(userConfFile):
45 userConfFile = os.path.join(compat_expanduser('~'), '.config', 'youtube-dl.conf')
46 userConf = _readOptions(userConfFile, None)
49 appdata_dir = compat_getenv('appdata')
51 userConf = _readOptions(
52 os.path.join(appdata_dir, 'youtube-dl', 'config'),
55 userConf = _readOptions(
56 os.path.join(appdata_dir, 'youtube-dl', 'config.txt'),
60 userConf = _readOptions(
61 os.path.join(compat_expanduser('~'), 'youtube-dl.conf'),
64 userConf = _readOptions(
65 os.path.join(compat_expanduser('~'), 'youtube-dl.conf.txt'),
73 def _format_option_string(option):
74 ''' ('-o', '--option') -> -o, --format METAVAR'''
78 if option._short_opts:
79 opts.append(option._short_opts[0])
81 opts.append(option._long_opts[0])
85 if option.takes_value():
86 opts.append(' %s' % option.metavar)
90 def _comma_separated_values_options_callback(option, opt_str, value, parser):
91 setattr(parser.values, option.dest, value.split(','))
93 def _hide_login_info(opts):
95 for private_opt in ['-p', '--password', '-u', '--username', '--video-password']:
97 i = opts.index(private_opt)
98 opts[i + 1] = 'PRIVATE'
103 # No need to wrap help messages if we're on a wide console
104 columns = compat_get_terminal_size().columns
105 max_width = columns if columns else 80
106 max_help_position = 80
108 fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position)
109 fmt.format_option_strings = _format_option_string
112 'version': __version__,
114 'usage': '%prog [OPTIONS] URL [URL...]',
115 'conflict_handler': 'resolve',
118 parser = optparse.OptionParser(**compat_kwargs(kw))
120 general = optparse.OptionGroup(parser, 'General Options')
124 help='Print this help text and exit')
128 help='Print program version and exit')
131 action='store_true', dest='update_self',
132 help='Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
134 '-i', '--ignore-errors',
135 action='store_true', dest='ignoreerrors', default=False,
136 help='Continue on download errors, for example to skip unavailable videos in a playlist')
139 action='store_false', dest='ignoreerrors',
140 help='Abort downloading of further videos (in the playlist or the command line) if an error occurs')
143 action='store_true', dest='dump_user_agent', default=False,
144 help='Display the current browser identification')
147 action='store_true', dest='list_extractors', default=False,
148 help='List all supported extractors')
150 '--extractor-descriptions',
151 action='store_true', dest='list_extractor_descriptions', default=False,
152 help='Output descriptions of all supported extractors')
154 '--force-generic-extractor',
155 action='store_true', dest='force_generic_extractor', default=False,
156 help='Force extraction to use the generic extractor')
159 dest='default_search', metavar='PREFIX',
160 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.')
164 help='Do not read configuration files. '
165 'When given in the global configuration file /etc/youtube-dl.conf: '
166 'Do not read the user configuration in ~/.config/youtube-dl/config '
167 '(%APPDATA%/youtube-dl/config.txt on Windows)')
170 action='store_const', dest='extract_flat', const='in_playlist',
172 help='Do not extract the videos of a playlist, only list them.')
175 action='store_true', dest='mark_watched', default=False,
176 help='Mark videos watched (YouTube only)')
178 '--no-color', '--no-colors',
179 action='store_true', dest='no_color',
181 help='Do not emit color codes in output')
183 network = optparse.OptionGroup(parser, 'Network Options')
185 '--proxy', dest='proxy',
186 default=None, metavar='URL',
187 help='Use the specified HTTP/HTTPS proxy. Pass in an empty string (--proxy "") for direct connection')
190 dest='socket_timeout', type=float, default=None, metavar='SECONDS',
191 help='Time to wait before giving up, in seconds')
194 metavar='IP', dest='source_address', default=None,
195 help='Client-side IP address to bind to (experimental)',
198 '-4', '--force-ipv4',
199 action='store_const', const='0.0.0.0', dest='source_address',
200 help='Make all connections via IPv4 (experimental)',
203 '-6', '--force-ipv6',
204 action='store_const', const='::', dest='source_address',
205 help='Make all connections via IPv6 (experimental)',
208 '--cn-verification-proxy',
209 dest='cn_verification_proxy', default=None, metavar='URL',
210 help='Use this proxy to verify the IP address for some Chinese sites. '
211 'The default proxy specified by --proxy (or none, if the options is not present) is used for the actual downloading. (experimental)'
214 selection = optparse.OptionGroup(parser, 'Video Selection')
215 selection.add_option(
217 dest='playliststart', metavar='NUMBER', default=1, type=int,
218 help='Playlist video to start at (default is %default)')
219 selection.add_option(
221 dest='playlistend', metavar='NUMBER', default=None, type=int,
222 help='Playlist video to end at (default is last)')
223 selection.add_option(
225 dest='playlist_items', metavar='ITEM_SPEC', default=None,
226 help='Playlist video items to download. Specify indices of the videos in the playlist separated by commas like: "--playlist-items 1,2,5,8" if you want to download videos indexed 1, 2, 5, 8 in the playlist. You can specify range: "--playlist-items 1-3,7,10-13", it will download the videos at index 1, 2, 3, 7, 10, 11, 12 and 13.')
227 selection.add_option(
229 dest='matchtitle', metavar='REGEX',
230 help='Download only matching titles (regex or caseless sub-string)')
231 selection.add_option(
233 dest='rejecttitle', metavar='REGEX',
234 help='Skip download for matching titles (regex or caseless sub-string)')
235 selection.add_option(
237 dest='max_downloads', metavar='NUMBER', type=int, default=None,
238 help='Abort after downloading NUMBER files')
239 selection.add_option(
241 metavar='SIZE', dest='min_filesize', default=None,
242 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
243 selection.add_option(
245 metavar='SIZE', dest='max_filesize', default=None,
246 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
247 selection.add_option(
249 metavar='DATE', dest='date', default=None,
250 help='Download only videos uploaded in this date')
251 selection.add_option(
253 metavar='DATE', dest='datebefore', default=None,
254 help='Download only videos uploaded on or before this date (i.e. inclusive)')
255 selection.add_option(
257 metavar='DATE', dest='dateafter', default=None,
258 help='Download only videos uploaded on or after this date (i.e. inclusive)')
259 selection.add_option(
261 metavar='COUNT', dest='min_views', default=None, type=int,
262 help='Do not download any videos with less than COUNT views')
263 selection.add_option(
265 metavar='COUNT', dest='max_views', default=None, type=int,
266 help='Do not download any videos with more than COUNT views')
267 selection.add_option(
269 metavar='FILTER', dest='match_filter', default=None,
271 'Generic video filter (experimental). '
272 'Specify any key (see help for -o for a list of available keys) to'
273 ' match if the key is present, '
274 '!key to check if the key is not present,'
275 'key > NUMBER (like "comment_count > 12", also works with '
276 '>=, <, <=, !=, =) to compare against a number, and '
277 '& to require multiple matches. '
278 'Values which are not known are excluded unless you'
279 ' put a question mark (?) after the operator.'
280 'For example, to only match videos that have been liked more than '
281 '100 times and disliked less than 50 times (or the dislike '
282 'functionality is not available at the given service), but who '
283 'also have a description, use --match-filter '
284 '"like_count > 100 & dislike_count <? 50 & description" .'
286 selection.add_option(
288 action='store_true', dest='noplaylist', default=False,
289 help='Download only the video, if the URL refers to a video and a playlist.')
290 selection.add_option(
292 action='store_false', dest='noplaylist', default=False,
293 help='Download the playlist, if the URL refers to a video and a playlist.')
294 selection.add_option(
296 metavar='YEARS', dest='age_limit', default=None, type=int,
297 help='Download only videos suitable for the given age')
298 selection.add_option(
299 '--download-archive', metavar='FILE',
300 dest='download_archive',
301 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.')
302 selection.add_option(
304 dest='include_ads', action='store_true',
305 help='Download advertisements as well (experimental)')
307 authentication = optparse.OptionGroup(parser, 'Authentication Options')
308 authentication.add_option(
310 dest='username', metavar='USERNAME',
311 help='Login with this account ID')
312 authentication.add_option(
314 dest='password', metavar='PASSWORD',
315 help='Account password. If this option is left out, youtube-dl will ask interactively.')
316 authentication.add_option(
318 dest='twofactor', metavar='TWOFACTOR',
319 help='Two-factor auth code')
320 authentication.add_option(
322 action='store_true', dest='usenetrc', default=False,
323 help='Use .netrc authentication data')
324 authentication.add_option(
326 dest='videopassword', metavar='PASSWORD',
327 help='Video password (vimeo, smotri, youku)')
329 video_format = optparse.OptionGroup(parser, 'Video Format Options')
330 video_format.add_option(
332 action='store', dest='format', metavar='FORMAT', default=None,
333 help='Video format code, see the "FORMAT SELECTION" for all the info')
334 video_format.add_option(
336 action='store_const', dest='format', const='all',
337 help='Download all available video formats')
338 video_format.add_option(
339 '--prefer-free-formats',
340 action='store_true', dest='prefer_free_formats', default=False,
341 help='Prefer free video formats unless a specific one is requested')
342 video_format.add_option(
343 '-F', '--list-formats',
344 action='store_true', dest='listformats',
345 help='List all available formats of requested videos')
346 video_format.add_option(
347 '--youtube-include-dash-manifest',
348 action='store_true', dest='youtube_include_dash_manifest', default=True,
349 help=optparse.SUPPRESS_HELP)
350 video_format.add_option(
351 '--youtube-skip-dash-manifest',
352 action='store_false', dest='youtube_include_dash_manifest',
353 help='Do not download the DASH manifests and related data on YouTube videos')
354 video_format.add_option(
355 '--merge-output-format',
356 action='store', dest='merge_output_format', metavar='FORMAT', default=None,
358 'If a merge is required (e.g. bestvideo+bestaudio), '
359 'output to given container format. One of mkv, mp4, ogg, webm, flv. '
360 'Ignored if no merge is required'))
362 subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
363 subtitles.add_option(
364 '--write-sub', '--write-srt',
365 action='store_true', dest='writesubtitles', default=False,
366 help='Write subtitle file')
367 subtitles.add_option(
368 '--write-auto-sub', '--write-automatic-sub',
369 action='store_true', dest='writeautomaticsub', default=False,
370 help='Write automatically generated subtitle file (YouTube only)')
371 subtitles.add_option(
373 action='store_true', dest='allsubtitles', default=False,
374 help='Download all the available subtitles of the video')
375 subtitles.add_option(
377 action='store_true', dest='listsubtitles', default=False,
378 help='List all available subtitles for the video')
379 subtitles.add_option(
381 action='store', dest='subtitlesformat', metavar='FORMAT', default='best',
382 help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
383 subtitles.add_option(
384 '--sub-lang', '--sub-langs', '--srt-lang',
385 action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
386 default=[], callback=_comma_separated_values_options_callback,
387 help='Languages of the subtitles to download (optional) separated by commas, use --list-subs for available language tags')
389 downloader = optparse.OptionGroup(parser, 'Download Options')
390 downloader.add_option(
391 '-r', '--rate-limit',
392 dest='ratelimit', metavar='LIMIT',
393 help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
394 downloader.add_option(
396 dest='retries', metavar='RETRIES', default=10,
397 help='Number of retries (default is %default), or "infinite".')
398 downloader.add_option(
400 dest='buffersize', metavar='SIZE', default='1024',
401 help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
402 downloader.add_option(
403 '--no-resize-buffer',
404 action='store_true', dest='noresizebuffer', default=False,
405 help='Do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.')
406 downloader.add_option(
408 action='store_true', dest='test', default=False,
409 help=optparse.SUPPRESS_HELP)
410 downloader.add_option(
411 '--playlist-reverse',
413 help='Download playlist videos in reverse order')
414 downloader.add_option(
415 '--xattr-set-filesize',
416 dest='xattr_set_filesize', action='store_true',
417 help='Set file xattribute ytdl.filesize with expected filesize (experimental)')
418 downloader.add_option(
419 '--hls-prefer-native',
420 dest='hls_prefer_native', action='store_true',
421 help='Use the native HLS downloader instead of ffmpeg (experimental)')
422 downloader.add_option(
424 dest='hls_use_mpegts', action='store_true',
425 help='Use the mpegts container for HLS videos, allowing to play the '
426 'video while downloading (some players may not be able to play it)')
427 downloader.add_option(
428 '--external-downloader',
429 dest='external_downloader', metavar='COMMAND',
430 help='Use the specified external downloader. '
431 'Currently supports %s' % ','.join(list_external_downloaders()))
432 downloader.add_option(
433 '--external-downloader-args',
434 dest='external_downloader_args', metavar='ARGS',
435 help='Give these arguments to the external downloader')
437 workarounds = optparse.OptionGroup(parser, 'Workarounds')
438 workarounds.add_option(
440 dest='encoding', metavar='ENCODING',
441 help='Force the specified encoding (experimental)')
442 workarounds.add_option(
443 '--no-check-certificate',
444 action='store_true', dest='no_check_certificate', default=False,
445 help='Suppress HTTPS certificate validation')
446 workarounds.add_option(
448 '--prefer-unsecure', action='store_true', dest='prefer_insecure',
449 help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)')
450 workarounds.add_option(
452 metavar='UA', dest='user_agent',
453 help='Specify a custom user agent')
454 workarounds.add_option(
456 metavar='URL', dest='referer', default=None,
457 help='Specify a custom referer, use if the video access is restricted to one domain',
459 workarounds.add_option(
461 metavar='FIELD:VALUE', dest='headers', action='append',
462 help='Specify a custom HTTP header and its value, separated by a colon \':\'. You can use this option multiple times',
464 workarounds.add_option(
466 dest='bidi_workaround', action='store_true',
467 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
468 workarounds.add_option(
469 '--sleep-interval', metavar='SECONDS',
470 dest='sleep_interval', type=float,
471 help='Number of seconds to sleep before each download.')
473 verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
474 verbosity.add_option(
476 action='store_true', dest='quiet', default=False,
477 help='Activate quiet mode')
478 verbosity.add_option(
480 dest='no_warnings', action='store_true', default=False,
481 help='Ignore warnings')
482 verbosity.add_option(
484 action='store_true', dest='simulate', default=False,
485 help='Do not download the video and do not write anything to disk')
486 verbosity.add_option(
488 action='store_true', dest='skip_download', default=False,
489 help='Do not download the video')
490 verbosity.add_option(
492 action='store_true', dest='geturl', default=False,
493 help='Simulate, quiet but print URL')
494 verbosity.add_option(
496 action='store_true', dest='gettitle', default=False,
497 help='Simulate, quiet but print title')
498 verbosity.add_option(
500 action='store_true', dest='getid', default=False,
501 help='Simulate, quiet but print id')
502 verbosity.add_option(
504 action='store_true', dest='getthumbnail', default=False,
505 help='Simulate, quiet but print thumbnail URL')
506 verbosity.add_option(
508 action='store_true', dest='getdescription', default=False,
509 help='Simulate, quiet but print video description')
510 verbosity.add_option(
512 action='store_true', dest='getduration', default=False,
513 help='Simulate, quiet but print video length')
514 verbosity.add_option(
516 action='store_true', dest='getfilename', default=False,
517 help='Simulate, quiet but print output filename')
518 verbosity.add_option(
520 action='store_true', dest='getformat', default=False,
521 help='Simulate, quiet but print output format')
522 verbosity.add_option(
524 action='store_true', dest='dumpjson', default=False,
525 help='Simulate, quiet but print JSON information. See --output for a description of available keys.')
526 verbosity.add_option(
527 '-J', '--dump-single-json',
528 action='store_true', dest='dump_single_json', default=False,
529 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.')
530 verbosity.add_option(
532 action='store_true', dest='print_json', default=False,
533 help='Be quiet and print the video information as JSON (video is still being downloaded).',
535 verbosity.add_option(
537 action='store_true', dest='progress_with_newline', default=False,
538 help='Output progress bar as new lines')
539 verbosity.add_option(
541 action='store_true', dest='noprogress', default=False,
542 help='Do not print progress bar')
543 verbosity.add_option(
545 action='store_true', dest='consoletitle', default=False,
546 help='Display progress in console titlebar')
547 verbosity.add_option(
549 action='store_true', dest='verbose', default=False,
550 help='Print various debugging information')
551 verbosity.add_option(
552 '--dump-pages', '--dump-intermediate-pages',
553 action='store_true', dest='dump_intermediate_pages', default=False,
554 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
555 verbosity.add_option(
557 action='store_true', dest='write_pages', default=False,
558 help='Write downloaded intermediary pages to files in the current directory to debug problems')
559 verbosity.add_option(
560 '--youtube-print-sig-code',
561 action='store_true', dest='youtube_print_sig_code', default=False,
562 help=optparse.SUPPRESS_HELP)
563 verbosity.add_option(
564 '--print-traffic', '--dump-headers',
565 dest='debug_printtraffic', action='store_true', default=False,
566 help='Display sent and read HTTP traffic')
567 verbosity.add_option(
569 dest='call_home', action='store_true', default=False,
570 help='Contact the youtube-dl server for debugging')
571 verbosity.add_option(
573 dest='call_home', action='store_false', default=False,
574 help='Do NOT contact the youtube-dl server for debugging')
576 filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
577 filesystem.add_option(
578 '-a', '--batch-file',
579 dest='batchfile', metavar='FILE',
580 help='File containing URLs to download (\'-\' for stdin)')
581 filesystem.add_option(
582 '--id', default=False,
583 action='store_true', dest='useid', help='Use only video ID in file name')
584 filesystem.add_option(
586 dest='outtmpl', metavar='TEMPLATE',
587 help=('Output filename template. Use %(title)s to get the title, '
588 '%(uploader)s for the uploader name, %(uploader_id)s for the uploader nickname if different, '
589 '%(autonumber)s to get an automatically incremented number, '
590 '%(ext)s for the filename extension, '
591 '%(format)s for the format description (like "22 - 1280x720" or "HD"), '
592 '%(format_id)s for the unique id of the format (like YouTube\'s itags: "137"), '
593 '%(upload_date)s for the upload date (YYYYMMDD), '
594 '%(extractor)s for the provider (youtube, metacafe, etc), '
595 '%(id)s for the video id, '
596 '%(playlist_title)s, %(playlist_id)s, or %(playlist)s (=title if present, ID otherwise) for the playlist the video is in, '
597 '%(playlist_index)s for the position in the playlist. '
598 '%(height)s and %(width)s for the width and height of the video format. '
599 '%(resolution)s for a textual description of the resolution of the video format. '
600 '%% for a literal percent. '
601 'Use - to output to stdout. Can also be used to download to a different directory, '
602 'for example with -o \'/my/downloads/%(uploader)s/%(title)s-%(id)s.%(ext)s\' .'))
603 filesystem.add_option(
605 dest='autonumber_size', metavar='NUMBER',
606 help='Specify the number of digits in %(autonumber)s when it is present in output filename template or --auto-number option is given')
607 filesystem.add_option(
608 '--restrict-filenames',
609 action='store_true', dest='restrictfilenames', default=False,
610 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
611 filesystem.add_option(
612 '-A', '--auto-number',
613 action='store_true', dest='autonumber', default=False,
614 help='[deprecated; use -o "%(autonumber)s-%(title)s.%(ext)s" ] Number downloaded files starting from 00000')
615 filesystem.add_option(
617 action='store_true', dest='usetitle', default=False,
618 help='[deprecated] Use title in file name (default)')
619 filesystem.add_option(
620 '-l', '--literal', default=False,
621 action='store_true', dest='usetitle',
622 help='[deprecated] Alias of --title')
623 filesystem.add_option(
624 '-w', '--no-overwrites',
625 action='store_true', dest='nooverwrites', default=False,
626 help='Do not overwrite files')
627 filesystem.add_option(
629 action='store_true', dest='continue_dl', default=True,
630 help='Force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.')
631 filesystem.add_option(
633 action='store_false', dest='continue_dl',
634 help='Do not resume partially downloaded files (restart from beginning)')
635 filesystem.add_option(
637 action='store_true', dest='nopart', default=False,
638 help='Do not use .part files - write directly into output file')
639 filesystem.add_option(
641 action='store_false', dest='updatetime', default=True,
642 help='Do not use the Last-modified header to set the file modification time')
643 filesystem.add_option(
644 '--write-description',
645 action='store_true', dest='writedescription', default=False,
646 help='Write video description to a .description file')
647 filesystem.add_option(
649 action='store_true', dest='writeinfojson', default=False,
650 help='Write video metadata to a .info.json file')
651 filesystem.add_option(
652 '--write-annotations',
653 action='store_true', dest='writeannotations', default=False,
654 help='Write video annotations to a .annotations.xml file')
655 filesystem.add_option(
657 dest='load_info_filename', metavar='FILE',
658 help='JSON file containing the video information (created with the "--write-info-json" option)')
659 filesystem.add_option(
661 dest='cookiefile', metavar='FILE',
662 help='File to read cookies from and dump cookie jar in')
663 filesystem.add_option(
664 '--cache-dir', dest='cachedir', default=None, metavar='DIR',
665 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.')
666 filesystem.add_option(
667 '--no-cache-dir', action='store_const', const=False, dest='cachedir',
668 help='Disable filesystem caching')
669 filesystem.add_option(
671 action='store_true', dest='rm_cachedir',
672 help='Delete all filesystem cache files')
674 thumbnail = optparse.OptionGroup(parser, 'Thumbnail images')
675 thumbnail.add_option(
677 action='store_true', dest='writethumbnail', default=False,
678 help='Write thumbnail image to disk')
679 thumbnail.add_option(
680 '--write-all-thumbnails',
681 action='store_true', dest='write_all_thumbnails', default=False,
682 help='Write all thumbnail image formats to disk')
683 thumbnail.add_option(
685 action='store_true', dest='list_thumbnails', default=False,
686 help='Simulate and list all available thumbnail formats')
688 postproc = optparse.OptionGroup(parser, 'Post-processing Options')
690 '-x', '--extract-audio',
691 action='store_true', dest='extractaudio', default=False,
692 help='Convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)')
694 '--audio-format', metavar='FORMAT', dest='audioformat', default='best',
695 help='Specify audio format: "best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; "%default" by default')
697 '--audio-quality', metavar='QUALITY',
698 dest='audioquality', default='5',
699 help='Specify ffmpeg/avconv audio quality, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default %default)')
702 metavar='FORMAT', dest='recodevideo', default=None,
703 help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv|avi)')
705 '--postprocessor-args',
706 dest='postprocessor_args', metavar='ARGS',
707 help='Give these arguments to the postprocessor')
709 '-k', '--keep-video',
710 action='store_true', dest='keepvideo', default=False,
711 help='Keep the video file on disk after the post-processing; the video is erased by default')
713 '--no-post-overwrites',
714 action='store_true', dest='nopostoverwrites', default=False,
715 help='Do not overwrite post-processed files; the post-processed files are overwritten by default')
718 action='store_true', dest='embedsubtitles', default=False,
719 help='Embed subtitles in the video (only for mkv and mp4 videos)')
722 action='store_true', dest='embedthumbnail', default=False,
723 help='Embed thumbnail in the audio as cover art')
726 action='store_true', dest='addmetadata', default=False,
727 help='Write metadata to the video file')
729 '--metadata-from-title',
730 metavar='FORMAT', dest='metafromtitle',
731 help='Parse additional metadata like song title / artist from the video title. '
732 'The format syntax is the same as --output, '
733 'the parsed parameters replace existing values. '
734 'Additional templates: %(album)s, %(artist)s. '
735 'Example: --metadata-from-title "%(artist)s - %(title)s" matches a title like '
736 '"Coldplay - Paradise"')
739 action='store_true', dest='xattrs', default=False,
740 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
743 metavar='POLICY', dest='fixup', default='detect_or_warn',
744 help='Automatically correct known faults of the file. '
745 'One of never (do nothing), warn (only emit a warning), '
746 'detect_or_warn (the default; fix file if we can, warn otherwise)')
749 action='store_false', dest='prefer_ffmpeg',
750 help='Prefer avconv over ffmpeg for running the postprocessors (default)')
753 action='store_true', dest='prefer_ffmpeg',
754 help='Prefer ffmpeg over avconv for running the postprocessors')
756 '--ffmpeg-location', '--avconv-location', metavar='PATH',
757 dest='ffmpeg_location',
758 help='Location of the ffmpeg/avconv binary; either the path to the binary or its containing directory.')
761 metavar='CMD', dest='exec_cmd',
762 help='Execute a command on the file after downloading, similar to find\'s -exec syntax. Example: --exec \'adb push {} /sdcard/Music/ && rm {}\'')
764 '--convert-subs', '--convert-subtitles',
765 metavar='FORMAT', dest='convertsubtitles', default=None,
766 help='Convert the subtitles to other format (currently supported: srt|ass|vtt)')
768 parser.add_option_group(general)
769 parser.add_option_group(network)
770 parser.add_option_group(selection)
771 parser.add_option_group(downloader)
772 parser.add_option_group(filesystem)
773 parser.add_option_group(thumbnail)
774 parser.add_option_group(verbosity)
775 parser.add_option_group(workarounds)
776 parser.add_option_group(video_format)
777 parser.add_option_group(subtitles)
778 parser.add_option_group(authentication)
779 parser.add_option_group(postproc)
781 if overrideArguments is not None:
782 opts, args = parser.parse_args(overrideArguments)
784 write_string('[debug] Override config: ' + repr(overrideArguments) + '\n')
786 def compat_conf(conf):
787 if sys.version_info < (3,):
788 return [a.decode(preferredencoding(), 'replace') for a in conf]
791 command_line_conf = compat_conf(sys.argv[1:])
793 if '--ignore-config' in command_line_conf:
797 system_conf = compat_conf(_readOptions('/etc/youtube-dl.conf'))
798 if '--ignore-config' in system_conf:
801 user_conf = compat_conf(_readUserConf())
802 argv = system_conf + user_conf + command_line_conf
804 opts, args = parser.parse_args(argv)
806 write_string('[debug] System config: ' + repr(_hide_login_info(system_conf)) + '\n')
807 write_string('[debug] User config: ' + repr(_hide_login_info(user_conf)) + '\n')
808 write_string('[debug] Command-line args: ' + repr(_hide_login_info(command_line_conf)) + '\n')
810 return parser, opts, args