1 from __future__
import unicode_literals
10 compat_get_terminal_size
,
23 from .cookies
import SUPPORTED_BROWSERS
24 from .version
import __version__
26 from .downloader
.external
import list_external_downloaders
27 from .postprocessor
import (
29 FFmpegSubtitlesConvertorPP
,
30 FFmpegThumbnailsConvertorPP
,
34 from .postprocessor
.modify_chapters
import DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
37 def _hide_login_info(opts
):
38 PRIVATE_OPTS
= set(['-p', '--password', '-u', '--username', '--video-password', '--ap-password', '--ap-username'])
39 eqre
= re
.compile('^(?P<key>' + ('|'.join(re
.escape(po
) for po
in PRIVATE_OPTS
)) + ')=.+$')
44 return m
.group('key') + '=PRIVATE'
48 opts
= list(map(_scrub_eq
, opts
))
49 for idx
, opt
in enumerate(opts
):
50 if opt
in PRIVATE_OPTS
and idx
+ 1 < len(opts
):
51 opts
[idx
+ 1] = 'PRIVATE'
55 def parseOpts(overrideArguments
=None):
56 def _readOptions(filename_bytes
, default
=[]):
58 optionf
= open(filename_bytes
)
60 return default
# silently skip if file is not present
62 # FIXME: https://github.com/ytdl-org/youtube-dl/commit/dfe5fa49aed02cf36ba9f743b11b0903554b5e56
63 contents
= optionf
.read()
64 if sys
.version_info
< (3,):
65 contents
= contents
.decode(preferredencoding())
66 res
= compat_shlex_split(contents
, comments
=True)
71 def _readUserConf(package_name
, default
=[]):
73 xdg_config_home
= compat_getenv('XDG_CONFIG_HOME') or compat_expanduser('~/.config')
74 userConfFile
= os
.path
.join(xdg_config_home
, package_name
, 'config')
75 if not os
.path
.isfile(userConfFile
):
76 userConfFile
= os
.path
.join(xdg_config_home
, '%s.conf' % package_name
)
77 userConf
= _readOptions(userConfFile
, default
=None)
78 if userConf
is not None:
79 return userConf
, userConfFile
82 appdata_dir
= compat_getenv('appdata')
84 userConfFile
= os
.path
.join(appdata_dir
, package_name
, 'config')
85 userConf
= _readOptions(userConfFile
, default
=None)
87 userConfFile
+= '.txt'
88 userConf
= _readOptions(userConfFile
, default
=None)
89 if userConf
is not None:
90 return userConf
, userConfFile
93 userConfFile
= os
.path
.join(compat_expanduser('~'), '%s.conf' % package_name
)
94 userConf
= _readOptions(userConfFile
, default
=None)
96 userConfFile
+= '.txt'
97 userConf
= _readOptions(userConfFile
, default
=None)
98 if userConf
is not None:
99 return userConf
, userConfFile
103 def _format_option_string(option
):
104 ''' ('-o', '--option') -> -o, --format METAVAR'''
108 if option
._short
_opts
:
109 opts
.append(option
._short
_opts
[0])
110 if option
._long
_opts
:
111 opts
.append(option
._long
_opts
[0])
115 if option
.takes_value():
116 opts
.append(' %s' % option
.metavar
)
120 def _list_from_options_callback(option
, opt_str
, value
, parser
, append
=True, delim
=',', process
=str.strip
):
121 # append can be True, False or -1 (prepend)
122 current
= getattr(parser
.values
, option
.dest
) if append
else []
123 value
= list(filter(None, [process(value
)] if delim
is None else map(process
, value
.split(delim
))))
125 parser
.values
, option
.dest
,
126 current
+ value
if append
is True else value
+ current
)
128 def _set_from_options_callback(
129 option
, opt_str
, value
, parser
, delim
=',', allowed_values
=None, aliases
={},
130 process
=lambda x
: x
.lower().strip()):
131 current
= getattr(parser
.values
, option
.dest
)
132 values
= [process(value
)] if delim
is None else list(map(process
, value
.split(delim
)[::-1]))
134 actual_val
= val
= values
.pop()
136 current
.update(allowed_values
)
140 values
.extend(aliases
[val
])
146 current
.update([val
])
147 if allowed_values
is not None and val
not in allowed_values
:
148 raise optparse
.OptionValueError(f
'wrong {option.metavar} for {opt_str}: {actual_val}')
150 setattr(parser
.values
, option
.dest
, current
)
152 def _dict_from_options_callback(
153 option
, opt_str
, value
, parser
,
154 allowed_keys
=r
'[\w-]+', delimiter
=':', default_key
=None, process
=None, multiple_keys
=True,
155 process_key
=str.lower
):
157 out_dict
= getattr(parser
.values
, option
.dest
)
159 allowed_keys
= r
'(%s)(,(%s))*' % (allowed_keys
, allowed_keys
)
160 mobj
= re
.match(r
'(?i)(?P<keys>%s)%s(?P<val>.*)$' % (allowed_keys
, delimiter
), value
)
162 keys
, val
= mobj
.group('keys').split(','), mobj
.group('val')
163 elif default_key
is not None:
164 keys
, val
= [default_key
], value
166 raise optparse
.OptionValueError(
167 'wrong %s formatting; it should be %s, not "%s"' % (opt_str
, option
.metavar
, value
))
169 keys
= map(process_key
, keys
) if process_key
else keys
170 val
= process(val
) if process
else val
171 except Exception as err
:
172 raise optparse
.OptionValueError(f
'wrong {opt_str} formatting; {err}')
176 # No need to wrap help messages if we're on a wide console
177 columns
= compat_get_terminal_size().columns
178 max_width
= columns
if columns
else 80
179 # 47% is chosen because that is how README.md is currently formatted
180 # and moving help text even further to the right is undesirable.
181 # This can be reduced in the future to get a prettier output
182 max_help_position
= int(0.47 * max_width
)
184 fmt
= optparse
.IndentedHelpFormatter(width
=max_width
, max_help_position
=max_help_position
)
185 fmt
.format_option_strings
= _format_option_string
188 'version': __version__
,
190 'usage': '%prog [OPTIONS] URL [URL...]',
191 'conflict_handler': 'resolve',
194 parser
= optparse
.OptionParser(**compat_kwargs(kw
))
196 general
= optparse
.OptionGroup(parser
, 'General Options')
200 help='Print this help text and exit')
204 help='Print program version and exit')
207 action
='store_true', dest
='update_self',
208 help='Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
210 '-i', '--ignore-errors',
211 action
='store_true', dest
='ignoreerrors',
212 help='Ignore download and postprocessing errors. The download will be considered successful even if the postprocessing fails')
214 '--no-abort-on-error',
215 action
='store_const', dest
='ignoreerrors', const
='only_download',
216 help='Continue with next video on download errors; e.g. to skip unavailable videos in a playlist (default)')
218 '--abort-on-error', '--no-ignore-errors',
219 action
='store_false', dest
='ignoreerrors',
220 help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
223 action
='store_true', dest
='dump_user_agent', default
=False,
224 help='Display the current user-agent and exit')
227 action
='store_true', dest
='list_extractors', default
=False,
228 help='List all supported extractors and exit')
230 '--extractor-descriptions',
231 action
='store_true', dest
='list_extractor_descriptions', default
=False,
232 help='Output descriptions of all supported extractors and exit')
234 '--force-generic-extractor',
235 action
='store_true', dest
='force_generic_extractor', default
=False,
236 help='Force extraction to use the generic extractor')
239 dest
='default_search', metavar
='PREFIX',
240 help='Use this prefix for unqualified URLs. For example "gvsearch2:" downloads two videos from google videos for the search term "large apple". Use the value "auto" to let yt-dlp 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')
242 '--ignore-config', '--no-config',
243 action
='store_true', dest
='ignoreconfig',
245 'Disable loading any configuration files except the one provided by --config-location. '
246 'When given inside a configuration file, no further configuration files are loaded. '
247 'Additionally, (for backward compatibility) if this option is found inside the '
248 'system configuration file, the user configuration is not loaded'))
251 dest
='config_location', metavar
='PATH',
252 help='Location of the main configuration file; either the path to the config or its containing directory')
255 action
='store_const', dest
='extract_flat', const
='in_playlist', default
=False,
256 help='Do not extract the videos of a playlist, only list them')
258 '--no-flat-playlist',
259 action
='store_false', dest
='extract_flat',
260 help='Extract the videos of a playlist')
263 dest
='wait_for_video', metavar
='MIN[-MAX]', default
=None,
265 'Wait for scheduled streams to become available. '
266 'Pass the minimum number of seconds (or range) to wait between retries'))
268 '--no-wait-for-video',
269 dest
='wait_for_video', action
='store_const', const
=None,
270 help='Do not wait for scheduled streams (default)')
273 action
='store_true', dest
='mark_watched', default
=False,
274 help='Mark videos watched (even with --simulate). Currently only supported for YouTube')
277 action
='store_false', dest
='mark_watched',
278 help='Do not mark videos watched (default)')
281 action
='store_true', dest
='no_color', default
=False,
282 help='Do not emit color codes in output')
285 metavar
='OPTS', dest
='compat_opts', default
=set(), type='str',
286 action
='callback', callback
=_set_from_options_callback
,
289 'filename', 'format-sort', 'abort-on-error', 'format-spec', 'no-playlist-metafiles',
290 'multistreams', 'no-live-chat', 'playlist-index', 'list-formats', 'no-direct-merge',
291 'no-youtube-channel-redirect', 'no-youtube-unavailable-videos', 'no-attach-info-json', 'embed-metadata',
292 'embed-thumbnail-atomicparsley', 'seperate-video-versions', 'no-clean-infojson', 'no-keep-subs',
294 'youtube-dl': ['-multistreams', 'all'],
295 'youtube-dlc': ['-no-youtube-channel-redirect', '-no-live-chat', 'all'],
298 'Options that can help keep compatibility with youtube-dl or youtube-dlc '
299 'configurations by reverting some of the changes made in yt-dlp. '
300 'See "Differences in default behavior" for details'))
302 network
= optparse
.OptionGroup(parser
, 'Network Options')
304 '--proxy', dest
='proxy',
305 default
=None, metavar
='URL',
307 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable '
308 'SOCKS proxy, specify a proper scheme. For example '
309 'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") '
310 'for direct connection'))
313 dest
='socket_timeout', type=float, default
=None, metavar
='SECONDS',
314 help='Time to wait before giving up, in seconds')
317 metavar
='IP', dest
='source_address', default
=None,
318 help='Client-side IP address to bind to',
321 '-4', '--force-ipv4',
322 action
='store_const', const
='0.0.0.0', dest
='source_address',
323 help='Make all connections via IPv4',
326 '-6', '--force-ipv6',
327 action
='store_const', const
='::', dest
='source_address',
328 help='Make all connections via IPv6',
331 geo
= optparse
.OptionGroup(parser
, 'Geo-restriction')
333 '--geo-verification-proxy',
334 dest
='geo_verification_proxy', default
=None, metavar
='URL',
336 'Use this proxy to verify the IP address for some geo-restricted sites. '
337 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
339 '--cn-verification-proxy',
340 dest
='cn_verification_proxy', default
=None, metavar
='URL',
341 help=optparse
.SUPPRESS_HELP
)
344 action
='store_true', dest
='geo_bypass', default
=True,
345 help='Bypass geographic restriction via faking X-Forwarded-For HTTP header')
348 action
='store_false', dest
='geo_bypass', default
=True,
349 help='Do not bypass geographic restriction via faking X-Forwarded-For HTTP header')
351 '--geo-bypass-country', metavar
='CODE',
352 dest
='geo_bypass_country', default
=None,
353 help='Force bypass geographic restriction with explicitly provided two-letter ISO 3166-2 country code')
355 '--geo-bypass-ip-block', metavar
='IP_BLOCK',
356 dest
='geo_bypass_ip_block', default
=None,
357 help='Force bypass geographic restriction with explicitly provided IP block in CIDR notation')
359 selection
= optparse
.OptionGroup(parser
, 'Video Selection')
360 selection
.add_option(
362 dest
='playliststart', metavar
='NUMBER', default
=1, type=int,
363 help='Playlist video to start at (default is %default)')
364 selection
.add_option(
366 dest
='playlistend', metavar
='NUMBER', default
=None, type=int,
367 help='Playlist video to end at (default is last)')
368 selection
.add_option(
370 dest
='playlist_items', metavar
='ITEM_SPEC', default
=None,
371 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')
372 selection
.add_option(
374 dest
='matchtitle', metavar
='REGEX',
375 help=optparse
.SUPPRESS_HELP
)
376 selection
.add_option(
378 dest
='rejecttitle', metavar
='REGEX',
379 help=optparse
.SUPPRESS_HELP
)
380 selection
.add_option(
382 metavar
='SIZE', dest
='min_filesize', default
=None,
383 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
384 selection
.add_option(
386 metavar
='SIZE', dest
='max_filesize', default
=None,
387 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
388 selection
.add_option(
390 metavar
='DATE', dest
='date', default
=None,
392 'Download only videos uploaded on this date. '
393 'The date can be "YYYYMMDD" or in the format '
394 '"(now|today)[+-][0-9](day|week|month|year)(s)?"'))
395 selection
.add_option(
397 metavar
='DATE', dest
='datebefore', default
=None,
399 'Download only videos uploaded on or before this date. '
400 'The date formats accepted is the same as --date'))
401 selection
.add_option(
403 metavar
='DATE', dest
='dateafter', default
=None,
405 'Download only videos uploaded on or after this date. '
406 'The date formats accepted is the same as --date'))
407 selection
.add_option(
409 metavar
='COUNT', dest
='min_views', default
=None, type=int,
410 help=optparse
.SUPPRESS_HELP
)
411 selection
.add_option(
413 metavar
='COUNT', dest
='max_views', default
=None, type=int,
414 help=optparse
.SUPPRESS_HELP
)
415 selection
.add_option(
417 metavar
='FILTER', dest
='match_filter', default
=None,
419 'Generic video filter. Any field (see "OUTPUT TEMPLATE") can be compared with a '
420 'number or a string using the operators defined in "Filtering formats". '
421 'You can also simply specify a field to match if the field is present '
422 'and "!field" to check if the field is not present. In addition, '
423 'Python style regular expression matching can be done using "~=", '
424 'and multiple filters can be checked with "&". '
425 'Use a "\\" to escape "&" or quotes if needed. Eg: --match-filter '
426 '"!is_live & like_count>?100 & description~=\'(?i)\\bcats \\& dogs\\b\'" '
427 'matches only videos that are not live, has a like count more than 100 '
428 '(or the like field is not available), and also has a description '
429 'that contains the phrase "cats & dogs" (ignoring case)'))
430 selection
.add_option(
432 metavar
='FILTER', dest
='match_filter', action
='store_const', const
=None,
433 help='Do not use generic video filter (default)')
434 selection
.add_option(
436 action
='store_true', dest
='noplaylist', default
=False,
437 help='Download only the video, if the URL refers to a video and a playlist')
438 selection
.add_option(
440 action
='store_false', dest
='noplaylist',
441 help='Download the playlist, if the URL refers to a video and a playlist')
442 selection
.add_option(
444 metavar
='YEARS', dest
='age_limit', default
=None, type=int,
445 help='Download only videos suitable for the given age')
446 selection
.add_option(
447 '--download-archive', metavar
='FILE',
448 dest
='download_archive',
449 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
450 selection
.add_option(
451 '--no-download-archive',
452 dest
='download_archive', action
="store_const", const
=None,
453 help='Do not use archive file (default)')
454 selection
.add_option(
456 dest
='max_downloads', metavar
='NUMBER', type=int, default
=None,
457 help='Abort after downloading NUMBER files')
458 selection
.add_option(
459 '--break-on-existing',
460 action
='store_true', dest
='break_on_existing', default
=False,
461 help='Stop the download process when encountering a file that is in the archive')
462 selection
.add_option(
464 action
='store_true', dest
='break_on_reject', default
=False,
465 help='Stop the download process when encountering a file that has been filtered out')
466 selection
.add_option(
468 action
='store_true', dest
='break_per_url', default
=False,
469 help='Make --break-on-existing and --break-on-reject act only on the current input URL')
470 selection
.add_option(
471 '--no-break-per-input',
472 action
='store_false', dest
='break_per_url',
473 help='--break-on-existing and --break-on-reject terminates the entire download queue')
474 selection
.add_option(
475 '--skip-playlist-after-errors', metavar
='N',
476 dest
='skip_playlist_after_errors', default
=None, type=int,
477 help='Number of allowed failures until the rest of the playlist is skipped')
478 selection
.add_option(
480 dest
='include_ads', action
='store_true',
481 help=optparse
.SUPPRESS_HELP
)
482 selection
.add_option(
484 dest
='include_ads', action
='store_false',
485 help=optparse
.SUPPRESS_HELP
)
487 authentication
= optparse
.OptionGroup(parser
, 'Authentication Options')
488 authentication
.add_option(
490 dest
='username', metavar
='USERNAME',
491 help='Login with this account ID')
492 authentication
.add_option(
494 dest
='password', metavar
='PASSWORD',
495 help='Account password. If this option is left out, yt-dlp will ask interactively')
496 authentication
.add_option(
498 dest
='twofactor', metavar
='TWOFACTOR',
499 help='Two-factor authentication code')
500 authentication
.add_option(
502 action
='store_true', dest
='usenetrc', default
=False,
503 help='Use .netrc authentication data')
504 authentication
.add_option(
506 dest
='netrc_location', metavar
='PATH',
507 help='Location of .netrc authentication data; either the path or its containing directory. Defaults to ~/.netrc')
508 authentication
.add_option(
510 dest
='videopassword', metavar
='PASSWORD',
511 help='Video password (vimeo, youku)')
512 authentication
.add_option(
514 dest
='ap_mso', metavar
='MSO',
515 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
516 authentication
.add_option(
518 dest
='ap_username', metavar
='USERNAME',
519 help='Multiple-system operator account login')
520 authentication
.add_option(
522 dest
='ap_password', metavar
='PASSWORD',
523 help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
524 authentication
.add_option(
526 action
='store_true', dest
='ap_list_mso', default
=False,
527 help='List all supported multiple-system operators')
529 video_format
= optparse
.OptionGroup(parser
, 'Video Format Options')
530 video_format
.add_option(
532 action
='store', dest
='format', metavar
='FORMAT', default
=None,
533 help='Video format code, see "FORMAT SELECTION" for more details')
534 video_format
.add_option(
535 '-S', '--format-sort', metavar
='SORTORDER',
536 dest
='format_sort', default
=[], type='str', action
='callback',
537 callback
=_list_from_options_callback
, callback_kwargs
={'append': -1}
,
538 help='Sort the formats by the fields given, see "Sorting Formats" for more details')
539 video_format
.add_option(
540 '--format-sort-force', '--S-force',
541 action
='store_true', dest
='format_sort_force', metavar
='FORMAT', default
=False,
543 'Force user specified sort order to have precedence over all fields, '
544 'see "Sorting Formats" for more details'))
545 video_format
.add_option(
546 '--no-format-sort-force',
547 action
='store_false', dest
='format_sort_force', metavar
='FORMAT', default
=False,
549 'Some fields have precedence over the user specified sort order (default), '
550 'see "Sorting Formats" for more details'))
551 video_format
.add_option(
552 '--video-multistreams',
553 action
='store_true', dest
='allow_multiple_video_streams', default
=None,
554 help='Allow multiple video streams to be merged into a single file')
555 video_format
.add_option(
556 '--no-video-multistreams',
557 action
='store_false', dest
='allow_multiple_video_streams',
558 help='Only one video stream is downloaded for each output file (default)')
559 video_format
.add_option(
560 '--audio-multistreams',
561 action
='store_true', dest
='allow_multiple_audio_streams', default
=None,
562 help='Allow multiple audio streams to be merged into a single file')
563 video_format
.add_option(
564 '--no-audio-multistreams',
565 action
='store_false', dest
='allow_multiple_audio_streams',
566 help='Only one audio stream is downloaded for each output file (default)')
567 video_format
.add_option(
569 action
='store_const', dest
='format', const
='all',
570 help=optparse
.SUPPRESS_HELP
)
571 video_format
.add_option(
572 '--prefer-free-formats',
573 action
='store_true', dest
='prefer_free_formats', default
=False,
575 'Prefer video formats with free containers over non-free ones of same quality. '
576 'Use with "-S ext" to strictly prefer free containers irrespective of quality'))
577 video_format
.add_option(
578 '--no-prefer-free-formats',
579 action
='store_false', dest
='prefer_free_formats', default
=False,
580 help="Don't give any special preference to free containers (default)")
581 video_format
.add_option(
583 action
='store_const', const
='selected', dest
='check_formats', default
=None,
584 help='Check that the selected formats are actually downloadable')
585 video_format
.add_option(
586 '--check-all-formats',
587 action
='store_true', dest
='check_formats',
588 help='Check all formats for whether they are actually downloadable')
589 video_format
.add_option(
590 '--no-check-formats',
591 action
='store_false', dest
='check_formats',
592 help='Do not check that the formats are actually downloadable')
593 video_format
.add_option(
594 '-F', '--list-formats',
595 action
='store_true', dest
='listformats',
596 help='List available formats of each video. Simulate unless --no-simulate is used')
597 video_format
.add_option(
598 '--list-formats-as-table',
599 action
='store_true', dest
='listformats_table', default
=True,
600 help=optparse
.SUPPRESS_HELP
)
601 video_format
.add_option(
602 '--list-formats-old', '--no-list-formats-as-table',
603 action
='store_false', dest
='listformats_table',
604 help=optparse
.SUPPRESS_HELP
)
605 video_format
.add_option(
606 '--merge-output-format',
607 action
='store', dest
='merge_output_format', metavar
='FORMAT', default
=None,
609 'If a merge is required (e.g. bestvideo+bestaudio), '
610 'output to given container format. One of mkv, mp4, ogg, webm, flv. '
611 'Ignored if no merge is required'))
612 video_format
.add_option(
613 '--allow-unplayable-formats',
614 action
='store_true', dest
='allow_unplayable_formats', default
=False,
615 help=optparse
.SUPPRESS_HELP
)
616 video_format
.add_option(
617 '--no-allow-unplayable-formats',
618 action
='store_false', dest
='allow_unplayable_formats',
619 help=optparse
.SUPPRESS_HELP
)
621 subtitles
= optparse
.OptionGroup(parser
, 'Subtitle Options')
622 subtitles
.add_option(
623 '--write-subs', '--write-srt',
624 action
='store_true', dest
='writesubtitles', default
=False,
625 help='Write subtitle file')
626 subtitles
.add_option(
627 '--no-write-subs', '--no-write-srt',
628 action
='store_false', dest
='writesubtitles',
629 help='Do not write subtitle file (default)')
630 subtitles
.add_option(
631 '--write-auto-subs', '--write-automatic-subs',
632 action
='store_true', dest
='writeautomaticsub', default
=False,
633 help='Write automatically generated subtitle file (Alias: --write-automatic-subs)')
634 subtitles
.add_option(
635 '--no-write-auto-subs', '--no-write-automatic-subs',
636 action
='store_false', dest
='writeautomaticsub', default
=False,
637 help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)')
638 subtitles
.add_option(
640 action
='store_true', dest
='allsubtitles', default
=False,
641 help=optparse
.SUPPRESS_HELP
)
642 subtitles
.add_option(
644 action
='store_true', dest
='listsubtitles', default
=False,
645 help='List available subtitles of each video. Simulate unless --no-simulate is used')
646 subtitles
.add_option(
648 action
='store', dest
='subtitlesformat', metavar
='FORMAT', default
='best',
649 help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
650 subtitles
.add_option(
651 '--sub-langs', '--srt-langs',
652 action
='callback', dest
='subtitleslangs', metavar
='LANGS', type='str',
653 default
=[], callback
=_list_from_options_callback
,
655 'Languages of the subtitles to download (can be regex) or "all" separated by commas. (Eg: --sub-langs "en.*,ja") '
656 'You can prefix the language code with a "-" to exempt it from the requested languages. (Eg: --sub-langs all,-live_chat) '
657 'Use --list-subs for a list of available language tags'))
659 downloader
= optparse
.OptionGroup(parser
, 'Download Options')
660 downloader
.add_option(
661 '-N', '--concurrent-fragments',
662 dest
='concurrent_fragment_downloads', metavar
='N', default
=1, type=int,
663 help='Number of fragments of a dash/hlsnative video that should be download concurrently (default is %default)')
664 downloader
.add_option(
665 '-r', '--limit-rate', '--rate-limit',
666 dest
='ratelimit', metavar
='RATE',
667 help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
668 downloader
.add_option(
670 dest
='throttledratelimit', metavar
='RATE',
671 help='Minimum download rate in bytes per second below which throttling is assumed and the video data is re-extracted (e.g. 100K)')
672 downloader
.add_option(
674 dest
='retries', metavar
='RETRIES', default
=10,
675 help='Number of retries (default is %default), or "infinite"')
676 downloader
.add_option(
677 '--fragment-retries',
678 dest
='fragment_retries', metavar
='RETRIES', default
=10,
679 help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
680 downloader
.add_option(
681 '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment',
682 action
='store_true', dest
='skip_unavailable_fragments', default
=True,
683 help='Skip unavailable fragments for DASH, hlsnative and ISM (default) (Alias: --no-abort-on-unavailable-fragment)')
684 downloader
.add_option(
685 '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments',
686 action
='store_false', dest
='skip_unavailable_fragments',
687 help='Abort downloading if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
688 downloader
.add_option(
690 action
='store_true', dest
='keep_fragments', default
=False,
691 help='Keep downloaded fragments on disk after downloading is finished')
692 downloader
.add_option(
693 '--no-keep-fragments',
694 action
='store_false', dest
='keep_fragments',
695 help='Delete downloaded fragments after downloading is finished (default)')
696 downloader
.add_option(
698 dest
='buffersize', metavar
='SIZE', default
='1024',
699 help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
700 downloader
.add_option(
702 action
='store_false', dest
='noresizebuffer',
703 help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
704 downloader
.add_option(
705 '--no-resize-buffer',
706 action
='store_true', dest
='noresizebuffer', default
=False,
707 help='Do not automatically adjust the buffer size')
708 downloader
.add_option(
710 dest
='http_chunk_size', metavar
='SIZE', default
=None,
712 'Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). '
713 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
714 downloader
.add_option(
716 action
='store_true', dest
='test', default
=False,
717 help=optparse
.SUPPRESS_HELP
)
718 downloader
.add_option(
719 '--playlist-reverse',
721 help='Download playlist videos in reverse order')
722 downloader
.add_option(
723 '--no-playlist-reverse',
724 action
='store_false', dest
='playlist_reverse',
725 help='Download playlist videos in default order (default)')
726 downloader
.add_option(
729 help='Download playlist videos in random order')
730 downloader
.add_option(
731 '--xattr-set-filesize',
732 dest
='xattr_set_filesize', action
='store_true',
733 help='Set file xattribute ytdl.filesize with expected file size')
734 downloader
.add_option(
735 '--hls-prefer-native',
736 dest
='hls_prefer_native', action
='store_true', default
=None,
737 help=optparse
.SUPPRESS_HELP
)
738 downloader
.add_option(
739 '--hls-prefer-ffmpeg',
740 dest
='hls_prefer_native', action
='store_false', default
=None,
741 help=optparse
.SUPPRESS_HELP
)
742 downloader
.add_option(
744 dest
='hls_use_mpegts', action
='store_true', default
=None,
746 'Use the mpegts container for HLS videos; '
747 'allowing some players to play the video while downloading, '
748 'and reducing the chance of file corruption if download is interrupted. '
749 'This is enabled by default for live streams'))
750 downloader
.add_option(
751 '--no-hls-use-mpegts',
752 dest
='hls_use_mpegts', action
='store_false',
754 'Do not use the mpegts container for HLS videos. '
755 'This is default when not downloading live streams'))
756 downloader
.add_option(
757 '--downloader', '--external-downloader',
758 dest
='external_downloader', metavar
='[PROTO:]NAME', default
={}, type='str',
759 action
='callback', callback
=_dict_from_options_callback
,
761 'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms',
762 'default_key': 'default',
765 'Name or path of the external downloader to use (optionally) prefixed by '
766 'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. '
767 'Currently supports native, %s (Recommended: aria2c). '
768 'You can use this option multiple times to set different downloaders for different protocols. '
769 'For example, --downloader aria2c --downloader "dash,m3u8:native" will use '
770 'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads '
771 '(Alias: --external-downloader)' % ', '.join(list_external_downloaders())))
772 downloader
.add_option(
773 '--downloader-args', '--external-downloader-args',
774 metavar
='NAME:ARGS', dest
='external_downloader_args', default
={}, type='str',
775 action
='callback', callback
=_dict_from_options_callback
,
777 'allowed_keys': r
'ffmpeg_[io]\d*|%s' % '|'.join(list_external_downloaders()),
778 'default_key': 'default',
779 'process': compat_shlex_split
781 'Give these arguments to the external downloader. '
782 'Specify the downloader name and the arguments separated by a colon ":". '
783 'For ffmpeg, arguments can be passed to different positions using the same syntax as --postprocessor-args. '
784 'You can use this option multiple times to give different arguments to different downloaders '
785 '(Alias: --external-downloader-args)'))
787 workarounds
= optparse
.OptionGroup(parser
, 'Workarounds')
788 workarounds
.add_option(
790 dest
='encoding', metavar
='ENCODING',
791 help='Force the specified encoding (experimental)')
792 workarounds
.add_option(
793 '--no-check-certificates',
794 action
='store_true', dest
='no_check_certificate', default
=False,
795 help='Suppress HTTPS certificate validation')
796 workarounds
.add_option(
797 '--prefer-insecure', '--prefer-unsecure',
798 action
='store_true', dest
='prefer_insecure',
799 help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)')
800 workarounds
.add_option(
802 metavar
='UA', dest
='user_agent',
803 help='Specify a custom user agent')
804 workarounds
.add_option(
806 metavar
='URL', dest
='referer', default
=None,
807 help='Specify a custom referer, use if the video access is restricted to one domain',
809 workarounds
.add_option(
811 metavar
='FIELD:VALUE', dest
='headers', default
={}, type='str',
812 action
='callback', callback
=_dict_from_options_callback
,
813 callback_kwargs
={'multiple_keys': False, 'process_key': None}
,
814 help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
816 workarounds
.add_option(
818 dest
='bidi_workaround', action
='store_true',
819 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
820 workarounds
.add_option(
821 '--sleep-requests', metavar
='SECONDS',
822 dest
='sleep_interval_requests', type=float,
823 help='Number of seconds to sleep between requests during data extraction')
824 workarounds
.add_option(
825 '--sleep-interval', '--min-sleep-interval', metavar
='SECONDS',
826 dest
='sleep_interval', type=float,
828 'Number of seconds to sleep before each download. '
829 'This is the minimum time to sleep when used along with --max-sleep-interval '
830 '(Alias: --min-sleep-interval)'))
831 workarounds
.add_option(
832 '--max-sleep-interval', metavar
='SECONDS',
833 dest
='max_sleep_interval', type=float,
834 help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval')
835 workarounds
.add_option(
836 '--sleep-subtitles', metavar
='SECONDS',
837 dest
='sleep_interval_subtitles', default
=0, type=int,
838 help='Number of seconds to sleep before each subtitle download')
840 verbosity
= optparse
.OptionGroup(parser
, 'Verbosity and Simulation Options')
841 verbosity
.add_option(
843 action
='store_true', dest
='quiet', default
=False,
844 help='Activate quiet mode. If used with --verbose, print the log to stderr')
845 verbosity
.add_option(
847 dest
='no_warnings', action
='store_true', default
=False,
848 help='Ignore warnings')
849 verbosity
.add_option(
851 action
='store_true', dest
='simulate', default
=None,
852 help='Do not download the video and do not write anything to disk')
853 verbosity
.add_option(
855 action
='store_false', dest
='simulate',
856 help='Download the video even if printing/listing options are used')
857 verbosity
.add_option(
858 '--ignore-no-formats-error',
859 action
='store_true', dest
='ignore_no_formats_error', default
=False,
861 'Ignore "No video formats" error. Useful for extracting metadata '
862 'even if the videos are not actually available for download (experimental)'))
863 verbosity
.add_option(
864 '--no-ignore-no-formats-error',
865 action
='store_false', dest
='ignore_no_formats_error',
866 help='Throw error when no downloadable video formats are found (default)')
867 verbosity
.add_option(
868 '--skip-download', '--no-download',
869 action
='store_true', dest
='skip_download', default
=False,
870 help='Do not download the video but write all related files (Alias: --no-download)')
871 verbosity
.add_option(
873 metavar
='TEMPLATE', action
='append', dest
='forceprint',
875 'Quiet, but print the given fields for each video. Simulate unless --no-simulate is used. '
876 'Either a field name or same syntax as the output template can be used'))
877 verbosity
.add_option(
879 action
='store_true', dest
='geturl', default
=False,
880 help=optparse
.SUPPRESS_HELP
)
881 verbosity
.add_option(
883 action
='store_true', dest
='gettitle', default
=False,
884 help=optparse
.SUPPRESS_HELP
)
885 verbosity
.add_option(
887 action
='store_true', dest
='getid', default
=False,
888 help=optparse
.SUPPRESS_HELP
)
889 verbosity
.add_option(
891 action
='store_true', dest
='getthumbnail', default
=False,
892 help=optparse
.SUPPRESS_HELP
)
893 verbosity
.add_option(
895 action
='store_true', dest
='getdescription', default
=False,
896 help=optparse
.SUPPRESS_HELP
)
897 verbosity
.add_option(
899 action
='store_true', dest
='getduration', default
=False,
900 help=optparse
.SUPPRESS_HELP
)
901 verbosity
.add_option(
903 action
='store_true', dest
='getfilename', default
=False,
904 help=optparse
.SUPPRESS_HELP
)
905 verbosity
.add_option(
907 action
='store_true', dest
='getformat', default
=False,
908 help=optparse
.SUPPRESS_HELP
)
909 verbosity
.add_option(
911 action
='store_true', dest
='dumpjson', default
=False,
912 help='Quiet, but print JSON information for each video. Simulate unless --no-simulate is used. See "OUTPUT TEMPLATE" for a description of available keys')
913 verbosity
.add_option(
914 '-J', '--dump-single-json',
915 action
='store_true', dest
='dump_single_json', default
=False,
917 'Quiet, but print JSON information for each url or infojson passed. Simulate unless --no-simulate is used. '
918 'If the URL refers to a playlist, the whole playlist information is dumped in a single line'))
919 verbosity
.add_option(
921 action
='store_true', dest
='print_json', default
=False,
922 help=optparse
.SUPPRESS_HELP
)
923 verbosity
.add_option(
924 '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
925 action
='store_true', dest
='force_write_download_archive', default
=False,
927 'Force download archive entries to be written as far as no errors occur, '
928 'even if -s or another simulation option is used (Alias: --force-download-archive)'))
929 verbosity
.add_option(
931 action
='store_true', dest
='progress_with_newline', default
=False,
932 help='Output progress bar as new lines')
933 verbosity
.add_option(
935 action
='store_true', dest
='noprogress', default
=None,
936 help='Do not print progress bar')
937 verbosity
.add_option(
939 action
='store_false', dest
='noprogress',
940 help='Show progress bar, even if in quiet mode')
941 verbosity
.add_option(
943 action
='store_true', dest
='consoletitle', default
=False,
944 help='Display progress in console titlebar')
945 verbosity
.add_option(
946 '--progress-template',
947 metavar
='[TYPES:]TEMPLATE', dest
='progress_template', default
={}, type='str',
948 action
='callback', callback
=_dict_from_options_callback
,
950 'allowed_keys': '(download|postprocess)(-title)?',
951 'default_key': 'download'
953 'Template for progress outputs, optionally prefixed with one of "download:" (default), '
954 '"download-title:" (the console title), "postprocess:", or "postprocess-title:". '
955 'The video\'s fields are accessible under the "info" key and '
956 'the progress attributes are accessible under "progress" key. E.g.: '
957 # TODO: Document the fields inside "progress"
958 '--console-title --progress-template "download-title:%(info.id)s-%(progress.eta)s"'))
959 verbosity
.add_option(
961 action
='store_true', dest
='verbose', default
=False,
962 help='Print various debugging information')
963 verbosity
.add_option(
964 '--dump-pages', '--dump-intermediate-pages',
965 action
='store_true', dest
='dump_intermediate_pages', default
=False,
966 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
967 verbosity
.add_option(
969 action
='store_true', dest
='write_pages', default
=False,
970 help='Write downloaded intermediary pages to files in the current directory to debug problems')
971 verbosity
.add_option(
972 '--youtube-print-sig-code',
973 action
='store_true', dest
='youtube_print_sig_code', default
=False,
974 help=optparse
.SUPPRESS_HELP
)
975 verbosity
.add_option(
976 '--print-traffic', '--dump-headers',
977 dest
='debug_printtraffic', action
='store_true', default
=False,
978 help='Display sent and read HTTP traffic')
979 verbosity
.add_option(
981 dest
='call_home', action
='store_true', default
=False,
982 # help='[Broken] Contact the yt-dlp server for debugging')
983 help=optparse
.SUPPRESS_HELP
)
984 verbosity
.add_option(
986 dest
='call_home', action
='store_false',
987 # help='Do not contact the yt-dlp server for debugging (default)')
988 help=optparse
.SUPPRESS_HELP
)
990 filesystem
= optparse
.OptionGroup(parser
, 'Filesystem Options')
991 filesystem
.add_option(
992 '-a', '--batch-file',
993 dest
='batchfile', metavar
='FILE',
994 help="File containing URLs to download ('-' for stdin), one URL per line. "
995 "Lines starting with '#', ';' or ']' are considered as comments and ignored")
996 filesystem
.add_option(
998 dest
='batchfile', action
='store_const', const
=None,
999 help='Do not read URLs from batch file (default)')
1000 filesystem
.add_option(
1001 '--id', default
=False,
1002 action
='store_true', dest
='useid', help=optparse
.SUPPRESS_HELP
)
1003 filesystem
.add_option(
1005 metavar
='[TYPES:]PATH', dest
='paths', default
={}, type='str',
1006 action
='callback', callback
=_dict_from_options_callback
,
1008 'allowed_keys': 'home|temp|%s' % '|'.join(OUTTMPL_TYPES
.keys()),
1009 'default_key': 'home'
1011 'The paths where the files should be downloaded. '
1012 'Specify the type of file and the path separated by a colon ":". '
1013 'All the same types as --output are supported. '
1014 'Additionally, you can also provide "home" (default) and "temp" paths. '
1015 'All intermediary files are first downloaded to the temp path and '
1016 'then the final files are moved over to the home path after download is finished. '
1017 'This option is ignored if --output is an absolute path'))
1018 filesystem
.add_option(
1020 metavar
='[TYPES:]TEMPLATE', dest
='outtmpl', default
={}, type='str',
1021 action
='callback', callback
=_dict_from_options_callback
,
1023 'allowed_keys': '|'.join(OUTTMPL_TYPES
.keys()),
1024 'default_key': 'default'
1025 }, help='Output filename template; see "OUTPUT TEMPLATE" for details')
1026 filesystem
.add_option(
1027 '--output-na-placeholder',
1028 dest
='outtmpl_na_placeholder', metavar
='TEXT', default
='NA',
1029 help=('Placeholder value for unavailable meta fields in output filename template (default: "%default")'))
1030 filesystem
.add_option(
1031 '--autonumber-size',
1032 dest
='autonumber_size', metavar
='NUMBER', type=int,
1033 help=optparse
.SUPPRESS_HELP
)
1034 filesystem
.add_option(
1035 '--autonumber-start',
1036 dest
='autonumber_start', metavar
='NUMBER', default
=1, type=int,
1037 help=optparse
.SUPPRESS_HELP
)
1038 filesystem
.add_option(
1039 '--restrict-filenames',
1040 action
='store_true', dest
='restrictfilenames', default
=False,
1041 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
1042 filesystem
.add_option(
1043 '--no-restrict-filenames',
1044 action
='store_false', dest
='restrictfilenames',
1045 help='Allow Unicode characters, "&" and spaces in filenames (default)')
1046 filesystem
.add_option(
1047 '--windows-filenames',
1048 action
='store_true', dest
='windowsfilenames', default
=False,
1049 help='Force filenames to be Windows-compatible')
1050 filesystem
.add_option(
1051 '--no-windows-filenames',
1052 action
='store_false', dest
='windowsfilenames',
1053 help='Make filenames Windows-compatible only if using Windows (default)')
1054 filesystem
.add_option(
1055 '--trim-filenames', '--trim-file-names', metavar
='LENGTH',
1056 dest
='trim_file_name', default
=0, type=int,
1057 help='Limit the filename length (excluding extension) to the specified number of characters')
1058 filesystem
.add_option(
1059 '-w', '--no-overwrites',
1060 action
='store_false', dest
='overwrites', default
=None,
1061 help='Do not overwrite any files')
1062 filesystem
.add_option(
1063 '--force-overwrites', '--yes-overwrites',
1064 action
='store_true', dest
='overwrites',
1065 help='Overwrite all video and metadata files. This option includes --no-continue')
1066 filesystem
.add_option(
1067 '--no-force-overwrites',
1068 action
='store_const', dest
='overwrites', const
=None,
1069 help='Do not overwrite the video, but overwrite related files (default)')
1070 filesystem
.add_option(
1072 action
='store_true', dest
='continue_dl', default
=True,
1073 help='Resume partially downloaded files/fragments (default)')
1074 filesystem
.add_option(
1076 action
='store_false', dest
='continue_dl',
1078 'Do not resume partially downloaded fragments. '
1079 'If the file is not fragmented, restart download of the entire file'))
1080 filesystem
.add_option(
1082 action
='store_false', dest
='nopart', default
=False,
1083 help='Use .part files instead of writing directly into output file (default)')
1084 filesystem
.add_option(
1086 action
='store_true', dest
='nopart',
1087 help='Do not use .part files - write directly into output file')
1088 filesystem
.add_option(
1090 action
='store_true', dest
='updatetime', default
=True,
1091 help='Use the Last-modified header to set the file modification time (default)')
1092 filesystem
.add_option(
1094 action
='store_false', dest
='updatetime',
1095 help='Do not use the Last-modified header to set the file modification time')
1096 filesystem
.add_option(
1097 '--write-description',
1098 action
='store_true', dest
='writedescription', default
=False,
1099 help='Write video description to a .description file')
1100 filesystem
.add_option(
1101 '--no-write-description',
1102 action
='store_false', dest
='writedescription',
1103 help='Do not write video description (default)')
1104 filesystem
.add_option(
1105 '--write-info-json',
1106 action
='store_true', dest
='writeinfojson', default
=False,
1107 help='Write video metadata to a .info.json file (this may contain personal information)')
1108 filesystem
.add_option(
1109 '--no-write-info-json',
1110 action
='store_false', dest
='writeinfojson',
1111 help='Do not write video metadata (default)')
1112 filesystem
.add_option(
1113 '--write-annotations',
1114 action
='store_true', dest
='writeannotations', default
=False,
1115 help=optparse
.SUPPRESS_HELP
)
1116 filesystem
.add_option(
1117 '--no-write-annotations',
1118 action
='store_false', dest
='writeannotations',
1119 help=optparse
.SUPPRESS_HELP
)
1120 filesystem
.add_option(
1121 '--write-playlist-metafiles',
1122 action
='store_true', dest
='allow_playlist_files', default
=None,
1124 'Write playlist metadata in addition to the video metadata '
1125 'when using --write-info-json, --write-description etc. (default)'))
1126 filesystem
.add_option(
1127 '--no-write-playlist-metafiles',
1128 action
='store_false', dest
='allow_playlist_files',
1129 help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
1130 filesystem
.add_option(
1132 action
='store_true', dest
='clean_infojson', default
=None,
1134 'Remove some private fields such as filenames from the infojson. '
1135 'Note that it could still contain some personal information (default)'))
1136 filesystem
.add_option(
1137 '--no-clean-infojson',
1138 action
='store_false', dest
='clean_infojson',
1139 help='Write all fields to the infojson')
1140 filesystem
.add_option(
1141 '--write-comments', '--get-comments',
1142 action
='store_true', dest
='getcomments', default
=False,
1144 'Retrieve video comments to be placed in the infojson. '
1145 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)'))
1146 filesystem
.add_option(
1147 '--no-write-comments', '--no-get-comments',
1148 action
='store_false', dest
='getcomments',
1149 help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)')
1150 filesystem
.add_option(
1151 '--load-info-json', '--load-info',
1152 dest
='load_info_filename', metavar
='FILE',
1153 help='JSON file containing the video information (created with the "--write-info-json" option)')
1154 filesystem
.add_option(
1156 dest
='cookiefile', metavar
='FILE',
1157 help='Netscape formatted file to read cookies from and dump cookie jar in')
1158 filesystem
.add_option(
1160 action
='store_const', const
=None, dest
='cookiefile', metavar
='FILE',
1161 help='Do not read/dump cookies from/to file (default)')
1162 filesystem
.add_option(
1163 '--cookies-from-browser',
1164 dest
='cookiesfrombrowser', metavar
='BROWSER[:PROFILE]',
1166 'Load cookies from a user profile of the given web browser. '
1167 'Currently supported browsers are: {}. '
1168 'You can specify the user profile name or directory using '
1169 '"BROWSER:PROFILE_NAME" or "BROWSER:PROFILE_PATH". '
1170 'If no profile is given, the most recently accessed one is used'.format(
1171 ', '.join(sorted(SUPPORTED_BROWSERS
)))))
1172 filesystem
.add_option(
1173 '--no-cookies-from-browser',
1174 action
='store_const', const
=None, dest
='cookiesfrombrowser',
1175 help='Do not load cookies from browser (default)')
1176 filesystem
.add_option(
1177 '--cache-dir', dest
='cachedir', default
=None, metavar
='DIR',
1178 help='Location in the filesystem where youtube-dl can store some downloaded information (such as client ids and signatures) permanently. By default $XDG_CACHE_HOME/yt-dlp or ~/.cache/yt-dlp')
1179 filesystem
.add_option(
1180 '--no-cache-dir', action
='store_false', dest
='cachedir',
1181 help='Disable filesystem caching')
1182 filesystem
.add_option(
1184 action
='store_true', dest
='rm_cachedir',
1185 help='Delete all filesystem cache files')
1187 thumbnail
= optparse
.OptionGroup(parser
, 'Thumbnail Options')
1188 thumbnail
.add_option(
1189 '--write-thumbnail',
1190 action
='store_true', dest
='writethumbnail', default
=False,
1191 help='Write thumbnail image to disk')
1192 thumbnail
.add_option(
1193 '--no-write-thumbnail',
1194 action
='store_false', dest
='writethumbnail',
1195 help='Do not write thumbnail image to disk (default)')
1196 thumbnail
.add_option(
1197 '--write-all-thumbnails',
1198 action
='store_true', dest
='write_all_thumbnails', default
=False,
1199 help='Write all thumbnail image formats to disk')
1200 thumbnail
.add_option(
1201 '--list-thumbnails',
1202 action
='store_true', dest
='list_thumbnails', default
=False,
1203 help='List available thumbnails of each video. Simulate unless --no-simulate is used')
1205 link
= optparse
.OptionGroup(parser
, 'Internet Shortcut Options')
1208 action
='store_true', dest
='writelink', default
=False,
1209 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1212 action
='store_true', dest
='writeurllink', default
=False,
1213 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1215 '--write-webloc-link',
1216 action
='store_true', dest
='writewebloclink', default
=False,
1217 help='Write a .webloc macOS internet shortcut')
1219 '--write-desktop-link',
1220 action
='store_true', dest
='writedesktoplink', default
=False,
1221 help='Write a .desktop Linux internet shortcut')
1223 postproc
= optparse
.OptionGroup(parser
, 'Post-Processing Options')
1224 postproc
.add_option(
1225 '-x', '--extract-audio',
1226 action
='store_true', dest
='extractaudio', default
=False,
1227 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1228 postproc
.add_option(
1229 '--audio-format', metavar
='FORMAT', dest
='audioformat', default
='best',
1231 'Specify audio format to convert the audio to when -x is used. Currently supported formats are: '
1232 'best (default) or one of %s' % '|'.join(FFmpegExtractAudioPP
.SUPPORTED_EXTS
)))
1233 postproc
.add_option(
1234 '--audio-quality', metavar
='QUALITY',
1235 dest
='audioquality', default
='5',
1236 help='Specify ffmpeg audio quality, insert a value between 0 (best) and 10 (worst) for VBR or a specific bitrate like 128K (default %default)')
1237 postproc
.add_option(
1239 metavar
='FORMAT', dest
='remuxvideo', default
=None,
1241 'Remux the video into another container if necessary (currently supported: %s). '
1242 'If target container does not support the video/audio codec, remuxing will fail. '
1243 'You can specify multiple rules; Eg. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 '
1244 'and anything else to mkv.' % '|'.join(FFmpegVideoRemuxerPP
.SUPPORTED_EXTS
)))
1245 postproc
.add_option(
1247 metavar
='FORMAT', dest
='recodevideo', default
=None,
1249 'Re-encode the video into another format if re-encoding is necessary. '
1250 'The syntax and supported formats are the same as --remux-video'))
1251 postproc
.add_option(
1252 '--postprocessor-args', '--ppa',
1253 metavar
='NAME:ARGS', dest
='postprocessor_args', default
={}, type='str',
1254 action
='callback', callback
=_dict_from_options_callback
,
1256 'allowed_keys': r
'\w+(?:\+\w+)?', 'default_key': 'default-compat',
1257 'process': compat_shlex_split
,
1258 'multiple_keys': False
1260 'Give these arguments to the postprocessors. '
1261 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1262 'to give the argument to the specified postprocessor/executable. Supported PP are: '
1263 'Merger, ModifyChapters, SplitChapters, ExtractAudio, VideoRemuxer, VideoConvertor, '
1264 'Metadata, EmbedSubtitle, EmbedThumbnail, SubtitlesConvertor, ThumbnailsConvertor, '
1265 'FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. '
1266 'The supported executables are: AtomicParsley, FFmpeg and FFprobe. '
1267 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1268 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
1269 '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
1270 'before the specified input/output file. Eg: --ppa "Merger+ffmpeg_i1:-v quiet". '
1271 'You can use this option multiple times to give different arguments to different '
1272 'postprocessors. (Alias: --ppa)'))
1273 postproc
.add_option(
1274 '-k', '--keep-video',
1275 action
='store_true', dest
='keepvideo', default
=False,
1276 help='Keep the intermediate video file on disk after post-processing')
1277 postproc
.add_option(
1279 action
='store_false', dest
='keepvideo',
1280 help='Delete the intermediate video file after post-processing (default)')
1281 postproc
.add_option(
1282 '--post-overwrites',
1283 action
='store_false', dest
='nopostoverwrites',
1284 help='Overwrite post-processed files (default)')
1285 postproc
.add_option(
1286 '--no-post-overwrites',
1287 action
='store_true', dest
='nopostoverwrites', default
=False,
1288 help='Do not overwrite post-processed files')
1289 postproc
.add_option(
1291 action
='store_true', dest
='embedsubtitles', default
=False,
1292 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1293 postproc
.add_option(
1295 action
='store_false', dest
='embedsubtitles',
1296 help='Do not embed subtitles (default)')
1297 postproc
.add_option(
1298 '--embed-thumbnail',
1299 action
='store_true', dest
='embedthumbnail', default
=False,
1300 help='Embed thumbnail in the video as cover art')
1301 postproc
.add_option(
1302 '--no-embed-thumbnail',
1303 action
='store_false', dest
='embedthumbnail',
1304 help='Do not embed thumbnail (default)')
1305 postproc
.add_option(
1306 '--embed-metadata', '--add-metadata',
1307 action
='store_true', dest
='addmetadata', default
=False,
1309 'Embed metadata to the video file. Also embeds chapters/infojson if present '
1310 'unless --no-embed-chapters/--no-embed-info-json are used (Alias: --add-metadata)'))
1311 postproc
.add_option(
1312 '--no-embed-metadata', '--no-add-metadata',
1313 action
='store_false', dest
='addmetadata',
1314 help='Do not add metadata to file (default) (Alias: --no-add-metadata)')
1315 postproc
.add_option(
1316 '--embed-chapters', '--add-chapters',
1317 action
='store_true', dest
='addchapters', default
=None,
1318 help='Add chapter markers to the video file (Alias: --add-chapters)')
1319 postproc
.add_option(
1320 '--no-embed-chapters', '--no-add-chapters',
1321 action
='store_false', dest
='addchapters',
1322 help='Do not add chapter markers (default) (Alias: --no-add-chapters)')
1323 postproc
.add_option(
1324 '--embed-info-json',
1325 action
='store_true', dest
='embed_infojson', default
=None,
1326 help='Embed the infojson as an attachment to mkv/mka video files')
1327 postproc
.add_option(
1328 '--no-embed-info-json',
1329 action
='store_false', dest
='embed_infojson',
1330 help='Do not embed the infojson as an attachment to the video file')
1331 postproc
.add_option(
1332 '--metadata-from-title',
1333 metavar
='FORMAT', dest
='metafromtitle',
1334 help=optparse
.SUPPRESS_HELP
)
1335 postproc
.add_option(
1337 metavar
='FROM:TO', dest
='parse_metadata', action
='append',
1339 'Parse additional metadata like title/artist from other fields; '
1340 'see "MODIFYING METADATA" for details'))
1341 postproc
.add_option(
1342 '--replace-in-metadata',
1343 dest
='parse_metadata', metavar
='FIELDS REGEX REPLACE', action
='append', nargs
=3,
1344 help='Replace text in a metadata field using the given regex. This option can be used multiple times')
1345 postproc
.add_option(
1347 action
='store_true', dest
='xattrs', default
=False,
1348 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
1349 postproc
.add_option(
1351 metavar
='POLICY', dest
='fixup', default
=None,
1352 choices
=('never', 'ignore', 'warn', 'detect_or_warn', 'force'),
1354 'Automatically correct known faults of the file. '
1355 'One of never (do nothing), warn (only emit a warning), '
1356 'detect_or_warn (the default; fix file if we can, warn otherwise), '
1357 'force (try fixing even if file already exists)'))
1358 postproc
.add_option(
1359 '--prefer-avconv', '--no-prefer-ffmpeg',
1360 action
='store_false', dest
='prefer_ffmpeg',
1361 help=optparse
.SUPPRESS_HELP
)
1362 postproc
.add_option(
1363 '--prefer-ffmpeg', '--no-prefer-avconv',
1364 action
='store_true', dest
='prefer_ffmpeg', default
=True,
1365 help=optparse
.SUPPRESS_HELP
)
1366 postproc
.add_option(
1367 '--ffmpeg-location', '--avconv-location', metavar
='PATH',
1368 dest
='ffmpeg_location',
1369 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1370 postproc
.add_option(
1371 '--exec', metavar
='CMD',
1372 action
='append', dest
='exec_cmd',
1374 'Execute a command on the file after downloading and post-processing. '
1375 'Same syntax as the output template can be used to pass any field as arguments to the command. '
1376 'An additional field "filepath" that contains the final path of the downloaded file is also available. '
1377 'If no fields are passed, %(filepath)q is appended to the end of the command. '
1378 'This option can be used multiple times'))
1379 postproc
.add_option(
1381 action
='store_const', dest
='exec_cmd', const
=[],
1382 help='Remove any previously defined --exec')
1383 postproc
.add_option(
1384 '--exec-before-download', metavar
='CMD',
1385 action
='append', dest
='exec_before_dl_cmd',
1387 'Execute a command before the actual download. '
1388 'The syntax is the same as --exec but "filepath" is not available. '
1389 'This option can be used multiple times'))
1390 postproc
.add_option(
1391 '--no-exec-before-download',
1392 action
='store_const', dest
='exec_before_dl_cmd', const
=[],
1393 help='Remove any previously defined --exec-before-download')
1394 postproc
.add_option(
1395 '--convert-subs', '--convert-sub', '--convert-subtitles',
1396 metavar
='FORMAT', dest
='convertsubtitles', default
=None,
1398 'Convert the subtitles to another format (currently supported: %s) '
1399 '(Alias: --convert-subtitles)' % '|'.join(FFmpegSubtitlesConvertorPP
.SUPPORTED_EXTS
)))
1400 postproc
.add_option(
1401 '--convert-thumbnails',
1402 metavar
='FORMAT', dest
='convertthumbnails', default
=None,
1404 'Convert the thumbnails to another format '
1405 '(currently supported: %s) ' % '|'.join(FFmpegThumbnailsConvertorPP
.SUPPORTED_EXTS
)))
1406 postproc
.add_option(
1407 '--split-chapters', '--split-tracks',
1408 dest
='split_chapters', action
='store_true', default
=False,
1410 'Split video into multiple files based on internal chapters. '
1411 'The "chapter:" prefix can be used with "--paths" and "--output" to '
1412 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1413 postproc
.add_option(
1414 '--no-split-chapters', '--no-split-tracks',
1415 dest
='split_chapters', action
='store_false',
1416 help='Do not split video based on chapters (default)')
1417 postproc
.add_option(
1418 '--remove-chapters',
1419 metavar
='REGEX', dest
='remove_chapters', action
='append',
1421 'Remove chapters whose title matches the given regular expression. '
1422 'Time ranges prefixed by a "*" can also be used in place of chapters to remove the specified range. '
1423 'Eg: --remove-chapters "*10:15-15:00" --remove-chapters "intro". '
1424 'This option can be used multiple times'))
1425 postproc
.add_option(
1426 '--no-remove-chapters', dest
='remove_chapters', action
='store_const', const
=None,
1427 help='Do not remove any chapters from the file (default)')
1428 postproc
.add_option(
1429 '--force-keyframes-at-cuts',
1430 action
='store_true', dest
='force_keyframes_at_cuts', default
=False,
1432 'Force keyframes around the chapters before removing/splitting them. '
1433 'Requires a reencode and thus is very slow, but the resulting video '
1434 'may have fewer artifacts around the cuts'))
1435 postproc
.add_option(
1436 '--no-force-keyframes-at-cuts',
1437 action
='store_false', dest
='force_keyframes_at_cuts',
1438 help='Do not force keyframes around the chapters when cutting/splitting (default)')
1439 _postprocessor_opts_parser
= lambda key
, val
='': (
1440 *(item
.split('=', 1) for item
in (val
.split(';') if val
else [])),
1441 ('key', remove_end(key
, 'PP')))
1442 postproc
.add_option(
1443 '--use-postprocessor',
1444 metavar
='NAME[:ARGS]', dest
='add_postprocessors', default
=[], type='str',
1445 action
='callback', callback
=_list_from_options_callback
,
1448 'process': lambda val
: dict(_postprocessor_opts_parser(*val
.split(':', 1)))
1450 'The (case sensitive) name of plugin postprocessors to be enabled, '
1451 'and (optionally) arguments to be passed to it, seperated by a colon ":". '
1452 'ARGS are a semicolon ";" delimited list of NAME=VALUE. '
1453 'The "when" argument determines when the postprocessor is invoked. '
1454 'It can be one of "pre_process" (after extraction), '
1455 '"before_dl" (before video download), "post_process" (after video download; default) '
1456 'or "after_move" (after moving file to their final locations). '
1457 'This option can be used multiple times to add different postprocessors'))
1459 sponsorblock
= optparse
.OptionGroup(parser
, 'SponsorBlock Options', description
=(
1460 'Make chapter entries for, or remove various segments (sponsor, introductions, etc.) '
1461 'from downloaded YouTube videos using the SponsorBlock API (https://sponsor.ajay.app)'))
1462 sponsorblock
.add_option(
1463 '--sponsorblock-mark', metavar
='CATS',
1464 dest
='sponsorblock_mark', default
=set(), action
='callback', type='str',
1465 callback
=_set_from_options_callback
, callback_kwargs
={'allowed_values': SponsorBlockPP.CATEGORIES.keys()}
,
1467 'SponsorBlock categories to create chapters for, separated by commas. '
1468 'Available categories are all, %s. You can prefix the category with a "-" to exempt it. '
1469 'See https://wiki.sponsor.ajay.app/index.php/Segment_Categories for description of the categories. '
1470 'Eg: --sponsorblock-mark all,-preview' % ', '.join(SponsorBlockPP
.CATEGORIES
.keys())))
1471 sponsorblock
.add_option(
1472 '--sponsorblock-remove', metavar
='CATS',
1473 dest
='sponsorblock_remove', default
=set(), action
='callback', type='str',
1474 callback
=_set_from_options_callback
, callback_kwargs
={'allowed_values': SponsorBlockPP.CATEGORIES.keys()}
,
1476 'SponsorBlock categories to be removed from the video file, separated by commas. '
1477 'If a category is present in both mark and remove, remove takes precedence. '
1478 'The syntax and available categories are the same as for --sponsorblock-mark'))
1479 sponsorblock
.add_option(
1480 '--sponsorblock-chapter-title', metavar
='TEMPLATE',
1481 default
=DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
, dest
='sponsorblock_chapter_title',
1483 'The title template for SponsorBlock chapters created by --sponsorblock-mark. '
1484 'The same syntax as the output template is used, but the only available fields are '
1485 'start_time, end_time, category, categories, name, category_names. Defaults to "%default"'))
1486 sponsorblock
.add_option(
1487 '--no-sponsorblock', default
=False,
1488 action
='store_true', dest
='no_sponsorblock',
1489 help='Disable both --sponsorblock-mark and --sponsorblock-remove')
1490 sponsorblock
.add_option(
1491 '--sponsorblock-api', metavar
='URL',
1492 default
='https://sponsor.ajay.app', dest
='sponsorblock_api',
1493 help='SponsorBlock API location, defaults to %default')
1495 sponsorblock
.add_option(
1497 action
='store_true', dest
='sponskrub', default
=False,
1498 help=optparse
.SUPPRESS_HELP
)
1499 sponsorblock
.add_option(
1501 action
='store_false', dest
='sponskrub',
1502 help=optparse
.SUPPRESS_HELP
)
1503 sponsorblock
.add_option(
1504 '--sponskrub-cut', default
=False,
1505 action
='store_true', dest
='sponskrub_cut',
1506 help=optparse
.SUPPRESS_HELP
)
1507 sponsorblock
.add_option(
1508 '--no-sponskrub-cut',
1509 action
='store_false', dest
='sponskrub_cut',
1510 help=optparse
.SUPPRESS_HELP
)
1511 sponsorblock
.add_option(
1512 '--sponskrub-force', default
=False,
1513 action
='store_true', dest
='sponskrub_force',
1514 help=optparse
.SUPPRESS_HELP
)
1515 sponsorblock
.add_option(
1516 '--no-sponskrub-force',
1517 action
='store_true', dest
='sponskrub_force',
1518 help=optparse
.SUPPRESS_HELP
)
1519 sponsorblock
.add_option(
1520 '--sponskrub-location', metavar
='PATH',
1521 dest
='sponskrub_path', default
='',
1522 help=optparse
.SUPPRESS_HELP
)
1523 sponsorblock
.add_option(
1524 '--sponskrub-args', dest
='sponskrub_args', metavar
='ARGS',
1525 help=optparse
.SUPPRESS_HELP
)
1527 extractor
= optparse
.OptionGroup(parser
, 'Extractor Options')
1528 extractor
.add_option(
1529 '--extractor-retries',
1530 dest
='extractor_retries', metavar
='RETRIES', default
=3,
1531 help='Number of retries for known extractor errors (default is %default), or "infinite"')
1532 extractor
.add_option(
1533 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1534 action
='store_true', dest
='dynamic_mpd', default
=True,
1535 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1536 extractor
.add_option(
1537 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1538 action
='store_false', dest
='dynamic_mpd',
1539 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1540 extractor
.add_option(
1541 '--hls-split-discontinuity',
1542 dest
='hls_split_discontinuity', action
='store_true', default
=False,
1543 help='Split HLS playlists to different formats at discontinuities such as ad breaks'
1545 extractor
.add_option(
1546 '--no-hls-split-discontinuity',
1547 dest
='hls_split_discontinuity', action
='store_false',
1548 help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
1549 _extractor_arg_parser
= lambda key
, vals
='': (key
.strip().lower().replace('-', '_'), [val
.strip() for val
in vals
.split(',')])
1550 extractor
.add_option(
1552 metavar
='KEY:ARGS', dest
='extractor_args', default
={}, type='str',
1553 action
='callback', callback
=_dict_from_options_callback
,
1555 'multiple_keys': False,
1556 'process': lambda val
: dict(
1557 _extractor_arg_parser(*arg
.split('=', 1)) for arg
in val
.split(';'))
1559 'Pass these arguments to the extractor. See "EXTRACTOR ARGUMENTS" for details. '
1560 'You can use this option multiple times to give arguments for different extractors'))
1561 extractor
.add_option(
1562 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1563 action
='store_true', dest
='youtube_include_dash_manifest', default
=True,
1564 help=optparse
.SUPPRESS_HELP
)
1565 extractor
.add_option(
1566 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1567 action
='store_false', dest
='youtube_include_dash_manifest',
1568 help=optparse
.SUPPRESS_HELP
)
1569 extractor
.add_option(
1570 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1571 action
='store_true', dest
='youtube_include_hls_manifest', default
=True,
1572 help=optparse
.SUPPRESS_HELP
)
1573 extractor
.add_option(
1574 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1575 action
='store_false', dest
='youtube_include_hls_manifest',
1576 help=optparse
.SUPPRESS_HELP
)
1578 parser
.add_option_group(general
)
1579 parser
.add_option_group(network
)
1580 parser
.add_option_group(geo
)
1581 parser
.add_option_group(selection
)
1582 parser
.add_option_group(downloader
)
1583 parser
.add_option_group(filesystem
)
1584 parser
.add_option_group(thumbnail
)
1585 parser
.add_option_group(link
)
1586 parser
.add_option_group(verbosity
)
1587 parser
.add_option_group(workarounds
)
1588 parser
.add_option_group(video_format
)
1589 parser
.add_option_group(subtitles
)
1590 parser
.add_option_group(authentication
)
1591 parser
.add_option_group(postproc
)
1592 parser
.add_option_group(sponsorblock
)
1593 parser
.add_option_group(extractor
)
1595 if overrideArguments
is not None:
1596 opts
, args
= parser
.parse_args(overrideArguments
)
1598 write_string('[debug] Override config: ' + repr(overrideArguments
) + '\n')
1600 def compat_conf(conf
):
1601 if sys
.version_info
< (3,):
1602 return [a
.decode(preferredencoding(), 'replace') for a
in conf
]
1606 'command-line': compat_conf(sys
.argv
[1:]),
1607 'custom': [], 'home': [], 'portable': [], 'user': [], 'system': []}
1608 paths
= {'command-line': False}
1610 def read_options(name
, path
, user
=False):
1611 ''' loads config files and returns ignoreconfig '''
1612 # Multiple package names can be given here
1613 # Eg: ('yt-dlp', 'youtube-dlc', 'youtube-dl') will look for
1614 # the configuration file of any of these three packages
1615 for package
in ('yt-dlp',):
1617 config
, current_path
= _readUserConf(package
, default
=None)
1619 current_path
= os
.path
.join(path
, '%s.conf' % package
)
1620 config
= _readOptions(current_path
, default
=None)
1621 if config
is not None:
1622 current_path
= os
.path
.realpath(current_path
)
1623 if current_path
in paths
.values():
1625 configs
[name
], paths
[name
] = config
, current_path
1626 return parser
.parse_args(config
)[0].ignoreconfig
1630 opts
, _
= parser
.parse_args(configs
['command-line'])
1631 if opts
.config_location
is not None:
1632 location
= compat_expanduser(opts
.config_location
)
1633 if os
.path
.isdir(location
):
1634 location
= os
.path
.join(location
, 'yt-dlp.conf')
1635 if not os
.path
.exists(location
):
1636 parser
.error('config-location %s does not exist.' % location
)
1637 config
= _readOptions(location
, default
=None)
1639 configs
['custom'], paths
['custom'] = config
, location
1641 if opts
.ignoreconfig
:
1643 if parser
.parse_args(configs
['custom'])[0].ignoreconfig
:
1645 if read_options('portable', get_executable_path()):
1647 opts
, _
= parser
.parse_args(configs
['portable'] + configs
['custom'] + configs
['command-line'])
1648 if read_options('home', expand_path(opts
.paths
.get('home', '')).strip()):
1650 if read_options('system', '/etc'):
1652 if read_options('user', None, user
=True):
1653 configs
['system'], paths
['system'] = [], None
1656 argv
= configs
['system'] + configs
['user'] + configs
['home'] + configs
['portable'] + configs
['custom'] + configs
['command-line']
1657 opts
, args
= parser
.parse_args(argv
)
1659 for label
in ('Command-line', 'Custom', 'Portable', 'Home', 'User', 'System'):
1662 write_string(f
'[debug] {label} config file: {paths[key]}\n')
1663 if paths
.get(key
) is not None:
1664 write_string(f
'[debug] {label} config: {_hide_login_info(configs[key])!r}\n')
1666 return parser
, opts
, args