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 action
='store_true', dest
='mark_watched', default
=False,
264 help='Mark videos watched (even with --simulate). Currently only supported for YouTube')
267 action
='store_false', dest
='mark_watched',
268 help='Do not mark videos watched (default)')
271 action
='store_true', dest
='no_color', default
=False,
272 help='Do not emit color codes in output')
275 metavar
='OPTS', dest
='compat_opts', default
=set(), type='str',
276 action
='callback', callback
=_set_from_options_callback
,
279 'filename', 'format-sort', 'abort-on-error', 'format-spec', 'no-playlist-metafiles',
280 'multistreams', 'no-live-chat', 'playlist-index', 'list-formats', 'no-direct-merge',
281 'no-youtube-channel-redirect', 'no-youtube-unavailable-videos', 'no-attach-info-json', 'embed-metadata',
282 'embed-thumbnail-atomicparsley', 'seperate-video-versions', 'no-clean-infojson', 'no-keep-subs',
284 'youtube-dl': ['-multistreams', 'all'],
285 'youtube-dlc': ['-no-youtube-channel-redirect', '-no-live-chat', 'all'],
288 'Options that can help keep compatibility with youtube-dl or youtube-dlc '
289 'configurations by reverting some of the changes made in yt-dlp. '
290 'See "Differences in default behavior" for details'))
292 network
= optparse
.OptionGroup(parser
, 'Network Options')
294 '--proxy', dest
='proxy',
295 default
=None, metavar
='URL',
297 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable '
298 'SOCKS proxy, specify a proper scheme. For example '
299 'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") '
300 'for direct connection'))
303 dest
='socket_timeout', type=float, default
=None, metavar
='SECONDS',
304 help='Time to wait before giving up, in seconds')
307 metavar
='IP', dest
='source_address', default
=None,
308 help='Client-side IP address to bind to',
311 '-4', '--force-ipv4',
312 action
='store_const', const
='0.0.0.0', dest
='source_address',
313 help='Make all connections via IPv4',
316 '-6', '--force-ipv6',
317 action
='store_const', const
='::', dest
='source_address',
318 help='Make all connections via IPv6',
321 geo
= optparse
.OptionGroup(parser
, 'Geo-restriction')
323 '--geo-verification-proxy',
324 dest
='geo_verification_proxy', default
=None, metavar
='URL',
326 'Use this proxy to verify the IP address for some geo-restricted sites. '
327 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
329 '--cn-verification-proxy',
330 dest
='cn_verification_proxy', default
=None, metavar
='URL',
331 help=optparse
.SUPPRESS_HELP
)
334 action
='store_true', dest
='geo_bypass', default
=True,
335 help='Bypass geographic restriction via faking X-Forwarded-For HTTP header')
338 action
='store_false', dest
='geo_bypass', default
=True,
339 help='Do not bypass geographic restriction via faking X-Forwarded-For HTTP header')
341 '--geo-bypass-country', metavar
='CODE',
342 dest
='geo_bypass_country', default
=None,
343 help='Force bypass geographic restriction with explicitly provided two-letter ISO 3166-2 country code')
345 '--geo-bypass-ip-block', metavar
='IP_BLOCK',
346 dest
='geo_bypass_ip_block', default
=None,
347 help='Force bypass geographic restriction with explicitly provided IP block in CIDR notation')
349 selection
= optparse
.OptionGroup(parser
, 'Video Selection')
350 selection
.add_option(
352 dest
='playliststart', metavar
='NUMBER', default
=1, type=int,
353 help='Playlist video to start at (default is %default)')
354 selection
.add_option(
356 dest
='playlistend', metavar
='NUMBER', default
=None, type=int,
357 help='Playlist video to end at (default is last)')
358 selection
.add_option(
360 dest
='playlist_items', metavar
='ITEM_SPEC', default
=None,
361 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')
362 selection
.add_option(
364 dest
='matchtitle', metavar
='REGEX',
365 help=optparse
.SUPPRESS_HELP
)
366 selection
.add_option(
368 dest
='rejecttitle', metavar
='REGEX',
369 help=optparse
.SUPPRESS_HELP
)
370 selection
.add_option(
372 dest
='max_downloads', metavar
='NUMBER', type=int, default
=None,
373 help='Abort after downloading NUMBER files')
374 selection
.add_option(
376 metavar
='SIZE', dest
='min_filesize', default
=None,
377 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
378 selection
.add_option(
380 metavar
='SIZE', dest
='max_filesize', default
=None,
381 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
382 selection
.add_option(
384 metavar
='DATE', dest
='date', default
=None,
386 'Download only videos uploaded on this date. '
387 'The date can be "YYYYMMDD" or in the format '
388 '"(now|today)[+-][0-9](day|week|month|year)(s)?"'))
389 selection
.add_option(
391 metavar
='DATE', dest
='datebefore', default
=None,
393 'Download only videos uploaded on or before this date. '
394 'The date formats accepted is the same as --date'))
395 selection
.add_option(
397 metavar
='DATE', dest
='dateafter', default
=None,
399 'Download only videos uploaded on or after this date. '
400 'The date formats accepted is the same as --date'))
401 selection
.add_option(
403 metavar
='COUNT', dest
='min_views', default
=None, type=int,
404 help=optparse
.SUPPRESS_HELP
)
405 selection
.add_option(
407 metavar
='COUNT', dest
='max_views', default
=None, type=int,
408 help=optparse
.SUPPRESS_HELP
)
409 selection
.add_option(
411 metavar
='FILTER', dest
='match_filter', default
=None,
413 'Generic video filter. Any field (see "OUTPUT TEMPLATE") can be compared with a '
414 'number or a string using the operators defined in "Filtering formats". '
415 'You can also simply specify a field to match if the field is present '
416 'and "!field" to check if the field is not present. In addition, '
417 'Python style regular expression matching can be done using "~=", '
418 'and multiple filters can be checked with "&". '
419 'Use a "\\" to escape "&" or quotes if needed. Eg: --match-filter '
420 '"!is_live & like_count>?100 & description~=\'(?i)\\bcats \\& dogs\\b\'" '
421 'matches only videos that are not live, has a like count more than 100 '
422 '(or the like field is not available), and also has a description '
423 'that contains the phrase "cats & dogs" (ignoring case)'))
424 selection
.add_option(
426 metavar
='FILTER', dest
='match_filter', action
='store_const', const
=None,
427 help='Do not use generic video filter (default)')
428 selection
.add_option(
430 action
='store_true', dest
='noplaylist', default
=False,
431 help='Download only the video, if the URL refers to a video and a playlist')
432 selection
.add_option(
434 action
='store_false', dest
='noplaylist',
435 help='Download the playlist, if the URL refers to a video and a playlist')
436 selection
.add_option(
438 metavar
='YEARS', dest
='age_limit', default
=None, type=int,
439 help='Download only videos suitable for the given age')
440 selection
.add_option(
441 '--download-archive', metavar
='FILE',
442 dest
='download_archive',
443 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
444 selection
.add_option(
445 '--break-on-existing',
446 action
='store_true', dest
='break_on_existing', default
=False,
447 help='Stop the download process when encountering a file that is in the archive')
448 selection
.add_option(
450 action
='store_true', dest
='break_on_reject', default
=False,
451 help='Stop the download process when encountering a file that has been filtered out')
452 selection
.add_option(
453 '--skip-playlist-after-errors', metavar
='N',
454 dest
='skip_playlist_after_errors', default
=None, type=int,
455 help='Number of allowed failures until the rest of the playlist is skipped')
456 selection
.add_option(
457 '--no-download-archive',
458 dest
='download_archive', action
="store_const", const
=None,
459 help='Do not use archive file (default)')
460 selection
.add_option(
462 dest
='include_ads', action
='store_true',
463 help=optparse
.SUPPRESS_HELP
)
464 selection
.add_option(
466 dest
='include_ads', action
='store_false',
467 help=optparse
.SUPPRESS_HELP
)
469 authentication
= optparse
.OptionGroup(parser
, 'Authentication Options')
470 authentication
.add_option(
472 dest
='username', metavar
='USERNAME',
473 help='Login with this account ID')
474 authentication
.add_option(
476 dest
='password', metavar
='PASSWORD',
477 help='Account password. If this option is left out, yt-dlp will ask interactively')
478 authentication
.add_option(
480 dest
='twofactor', metavar
='TWOFACTOR',
481 help='Two-factor authentication code')
482 authentication
.add_option(
484 action
='store_true', dest
='usenetrc', default
=False,
485 help='Use .netrc authentication data')
486 authentication
.add_option(
488 dest
='netrc_location', metavar
='PATH',
489 help='Location of .netrc authentication data; either the path or its containing directory. Defaults to ~/.netrc')
490 authentication
.add_option(
492 dest
='videopassword', metavar
='PASSWORD',
493 help='Video password (vimeo, youku)')
494 authentication
.add_option(
496 dest
='ap_mso', metavar
='MSO',
497 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
498 authentication
.add_option(
500 dest
='ap_username', metavar
='USERNAME',
501 help='Multiple-system operator account login')
502 authentication
.add_option(
504 dest
='ap_password', metavar
='PASSWORD',
505 help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
506 authentication
.add_option(
508 action
='store_true', dest
='ap_list_mso', default
=False,
509 help='List all supported multiple-system operators')
511 video_format
= optparse
.OptionGroup(parser
, 'Video Format Options')
512 video_format
.add_option(
514 action
='store', dest
='format', metavar
='FORMAT', default
=None,
515 help='Video format code, see "FORMAT SELECTION" for more details')
516 video_format
.add_option(
517 '-S', '--format-sort', metavar
='SORTORDER',
518 dest
='format_sort', default
=[], type='str', action
='callback',
519 callback
=_list_from_options_callback
, callback_kwargs
={'append': -1}
,
520 help='Sort the formats by the fields given, see "Sorting Formats" for more details')
521 video_format
.add_option(
522 '--format-sort-force', '--S-force',
523 action
='store_true', dest
='format_sort_force', metavar
='FORMAT', default
=False,
525 'Force user specified sort order to have precedence over all fields, '
526 'see "Sorting Formats" for more details'))
527 video_format
.add_option(
528 '--no-format-sort-force',
529 action
='store_false', dest
='format_sort_force', metavar
='FORMAT', default
=False,
531 'Some fields have precedence over the user specified sort order (default), '
532 'see "Sorting Formats" for more details'))
533 video_format
.add_option(
534 '--video-multistreams',
535 action
='store_true', dest
='allow_multiple_video_streams', default
=None,
536 help='Allow multiple video streams to be merged into a single file')
537 video_format
.add_option(
538 '--no-video-multistreams',
539 action
='store_false', dest
='allow_multiple_video_streams',
540 help='Only one video stream is downloaded for each output file (default)')
541 video_format
.add_option(
542 '--audio-multistreams',
543 action
='store_true', dest
='allow_multiple_audio_streams', default
=None,
544 help='Allow multiple audio streams to be merged into a single file')
545 video_format
.add_option(
546 '--no-audio-multistreams',
547 action
='store_false', dest
='allow_multiple_audio_streams',
548 help='Only one audio stream is downloaded for each output file (default)')
549 video_format
.add_option(
551 action
='store_const', dest
='format', const
='all',
552 help=optparse
.SUPPRESS_HELP
)
553 video_format
.add_option(
554 '--prefer-free-formats',
555 action
='store_true', dest
='prefer_free_formats', default
=False,
557 'Prefer video formats with free containers over non-free ones of same quality. '
558 'Use with "-S ext" to strictly prefer free containers irrespective of quality'))
559 video_format
.add_option(
560 '--no-prefer-free-formats',
561 action
='store_false', dest
='prefer_free_formats', default
=False,
562 help="Don't give any special preference to free containers (default)")
563 video_format
.add_option(
565 action
='store_const', const
='selected', dest
='check_formats', default
=None,
566 help='Check that the selected formats are actually downloadable')
567 video_format
.add_option(
568 '--check-all-formats',
569 action
='store_true', dest
='check_formats',
570 help='Check all formats for whether they are actually downloadable')
571 video_format
.add_option(
572 '--no-check-formats',
573 action
='store_false', dest
='check_formats',
574 help='Do not check that the formats are actually downloadable')
575 video_format
.add_option(
576 '-F', '--list-formats',
577 action
='store_true', dest
='listformats',
578 help='List available formats of each video. Simulate unless --no-simulate is used')
579 video_format
.add_option(
580 '--list-formats-as-table',
581 action
='store_true', dest
='listformats_table', default
=True,
582 help=optparse
.SUPPRESS_HELP
)
583 video_format
.add_option(
584 '--list-formats-old', '--no-list-formats-as-table',
585 action
='store_false', dest
='listformats_table',
586 help=optparse
.SUPPRESS_HELP
)
587 video_format
.add_option(
588 '--merge-output-format',
589 action
='store', dest
='merge_output_format', metavar
='FORMAT', default
=None,
591 'If a merge is required (e.g. bestvideo+bestaudio), '
592 'output to given container format. One of mkv, mp4, ogg, webm, flv. '
593 'Ignored if no merge is required'))
594 video_format
.add_option(
595 '--allow-unplayable-formats',
596 action
='store_true', dest
='allow_unplayable_formats', default
=False,
597 help=optparse
.SUPPRESS_HELP
)
598 video_format
.add_option(
599 '--no-allow-unplayable-formats',
600 action
='store_false', dest
='allow_unplayable_formats',
601 help=optparse
.SUPPRESS_HELP
)
603 subtitles
= optparse
.OptionGroup(parser
, 'Subtitle Options')
604 subtitles
.add_option(
605 '--write-subs', '--write-srt',
606 action
='store_true', dest
='writesubtitles', default
=False,
607 help='Write subtitle file')
608 subtitles
.add_option(
609 '--no-write-subs', '--no-write-srt',
610 action
='store_false', dest
='writesubtitles',
611 help='Do not write subtitle file (default)')
612 subtitles
.add_option(
613 '--write-auto-subs', '--write-automatic-subs',
614 action
='store_true', dest
='writeautomaticsub', default
=False,
615 help='Write automatically generated subtitle file (Alias: --write-automatic-subs)')
616 subtitles
.add_option(
617 '--no-write-auto-subs', '--no-write-automatic-subs',
618 action
='store_false', dest
='writeautomaticsub', default
=False,
619 help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)')
620 subtitles
.add_option(
622 action
='store_true', dest
='allsubtitles', default
=False,
623 help=optparse
.SUPPRESS_HELP
)
624 subtitles
.add_option(
626 action
='store_true', dest
='listsubtitles', default
=False,
627 help='List available subtitles of each video. Simulate unless --no-simulate is used')
628 subtitles
.add_option(
630 action
='store', dest
='subtitlesformat', metavar
='FORMAT', default
='best',
631 help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
632 subtitles
.add_option(
633 '--sub-langs', '--srt-langs',
634 action
='callback', dest
='subtitleslangs', metavar
='LANGS', type='str',
635 default
=[], callback
=_list_from_options_callback
,
637 'Languages of the subtitles to download (can be regex) or "all" separated by commas. (Eg: --sub-langs "en.*,ja") '
638 'You can prefix the language code with a "-" to exempt it from the requested languages. (Eg: --sub-langs all,-live_chat) '
639 'Use --list-subs for a list of available language tags'))
641 downloader
= optparse
.OptionGroup(parser
, 'Download Options')
642 downloader
.add_option(
643 '-N', '--concurrent-fragments',
644 dest
='concurrent_fragment_downloads', metavar
='N', default
=1, type=int,
645 help='Number of fragments of a dash/hlsnative video that should be download concurrently (default is %default)')
646 downloader
.add_option(
647 '-r', '--limit-rate', '--rate-limit',
648 dest
='ratelimit', metavar
='RATE',
649 help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
650 downloader
.add_option(
652 dest
='throttledratelimit', metavar
='RATE',
653 help='Minimum download rate in bytes per second below which throttling is assumed and the video data is re-extracted (e.g. 100K)')
654 downloader
.add_option(
656 dest
='retries', metavar
='RETRIES', default
=10,
657 help='Number of retries (default is %default), or "infinite"')
658 downloader
.add_option(
659 '--fragment-retries',
660 dest
='fragment_retries', metavar
='RETRIES', default
=10,
661 help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
662 downloader
.add_option(
663 '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment',
664 action
='store_true', dest
='skip_unavailable_fragments', default
=True,
665 help='Skip unavailable fragments for DASH, hlsnative and ISM (default) (Alias: --no-abort-on-unavailable-fragment)')
666 downloader
.add_option(
667 '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments',
668 action
='store_false', dest
='skip_unavailable_fragments',
669 help='Abort downloading if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
670 downloader
.add_option(
672 action
='store_true', dest
='keep_fragments', default
=False,
673 help='Keep downloaded fragments on disk after downloading is finished')
674 downloader
.add_option(
675 '--no-keep-fragments',
676 action
='store_false', dest
='keep_fragments',
677 help='Delete downloaded fragments after downloading is finished (default)')
678 downloader
.add_option(
680 dest
='buffersize', metavar
='SIZE', default
='1024',
681 help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
682 downloader
.add_option(
684 action
='store_false', dest
='noresizebuffer',
685 help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
686 downloader
.add_option(
687 '--no-resize-buffer',
688 action
='store_true', dest
='noresizebuffer', default
=False,
689 help='Do not automatically adjust the buffer size')
690 downloader
.add_option(
692 dest
='http_chunk_size', metavar
='SIZE', default
=None,
694 'Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). '
695 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
696 downloader
.add_option(
698 action
='store_true', dest
='test', default
=False,
699 help=optparse
.SUPPRESS_HELP
)
700 downloader
.add_option(
701 '--playlist-reverse',
703 help='Download playlist videos in reverse order')
704 downloader
.add_option(
705 '--no-playlist-reverse',
706 action
='store_false', dest
='playlist_reverse',
707 help='Download playlist videos in default order (default)')
708 downloader
.add_option(
711 help='Download playlist videos in random order')
712 downloader
.add_option(
713 '--xattr-set-filesize',
714 dest
='xattr_set_filesize', action
='store_true',
715 help='Set file xattribute ytdl.filesize with expected file size')
716 downloader
.add_option(
717 '--hls-prefer-native',
718 dest
='hls_prefer_native', action
='store_true', default
=None,
719 help=optparse
.SUPPRESS_HELP
)
720 downloader
.add_option(
721 '--hls-prefer-ffmpeg',
722 dest
='hls_prefer_native', action
='store_false', default
=None,
723 help=optparse
.SUPPRESS_HELP
)
724 downloader
.add_option(
726 dest
='hls_use_mpegts', action
='store_true', default
=None,
728 'Use the mpegts container for HLS videos; '
729 'allowing some players to play the video while downloading, '
730 'and reducing the chance of file corruption if download is interrupted. '
731 'This is enabled by default for live streams'))
732 downloader
.add_option(
733 '--no-hls-use-mpegts',
734 dest
='hls_use_mpegts', action
='store_false',
736 'Do not use the mpegts container for HLS videos. '
737 'This is default when not downloading live streams'))
738 downloader
.add_option(
739 '--downloader', '--external-downloader',
740 dest
='external_downloader', metavar
='[PROTO:]NAME', default
={}, type='str',
741 action
='callback', callback
=_dict_from_options_callback
,
743 'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms',
744 'default_key': 'default',
747 'Name or path of the external downloader to use (optionally) prefixed by '
748 'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. '
749 'Currently supports native, %s (Recommended: aria2c). '
750 'You can use this option multiple times to set different downloaders for different protocols. '
751 'For example, --downloader aria2c --downloader "dash,m3u8:native" will use '
752 'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads '
753 '(Alias: --external-downloader)' % ', '.join(list_external_downloaders())))
754 downloader
.add_option(
755 '--downloader-args', '--external-downloader-args',
756 metavar
='NAME:ARGS', dest
='external_downloader_args', default
={}, type='str',
757 action
='callback', callback
=_dict_from_options_callback
,
759 'allowed_keys': r
'ffmpeg_[io]\d*|%s' % '|'.join(list_external_downloaders()),
760 'default_key': 'default',
761 'process': compat_shlex_split
763 'Give these arguments to the external downloader. '
764 'Specify the downloader name and the arguments separated by a colon ":". '
765 'For ffmpeg, arguments can be passed to different positions using the same syntax as --postprocessor-args. '
766 'You can use this option multiple times to give different arguments to different downloaders '
767 '(Alias: --external-downloader-args)'))
769 workarounds
= optparse
.OptionGroup(parser
, 'Workarounds')
770 workarounds
.add_option(
772 dest
='encoding', metavar
='ENCODING',
773 help='Force the specified encoding (experimental)')
774 workarounds
.add_option(
775 '--no-check-certificates',
776 action
='store_true', dest
='no_check_certificate', default
=False,
777 help='Suppress HTTPS certificate validation')
778 workarounds
.add_option(
779 '--prefer-insecure', '--prefer-unsecure',
780 action
='store_true', dest
='prefer_insecure',
781 help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)')
782 workarounds
.add_option(
784 metavar
='UA', dest
='user_agent',
785 help='Specify a custom user agent')
786 workarounds
.add_option(
788 metavar
='URL', dest
='referer', default
=None,
789 help='Specify a custom referer, use if the video access is restricted to one domain',
791 workarounds
.add_option(
793 metavar
='FIELD:VALUE', dest
='headers', default
={}, type='str',
794 action
='callback', callback
=_dict_from_options_callback
,
795 callback_kwargs
={'multiple_keys': False, 'process_key': None}
,
796 help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
798 workarounds
.add_option(
800 dest
='bidi_workaround', action
='store_true',
801 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
802 workarounds
.add_option(
803 '--sleep-requests', metavar
='SECONDS',
804 dest
='sleep_interval_requests', type=float,
805 help='Number of seconds to sleep between requests during data extraction')
806 workarounds
.add_option(
807 '--sleep-interval', '--min-sleep-interval', metavar
='SECONDS',
808 dest
='sleep_interval', type=float,
810 'Number of seconds to sleep before each download. '
811 'This is the minimum time to sleep when used along with --max-sleep-interval '
812 '(Alias: --min-sleep-interval)'))
813 workarounds
.add_option(
814 '--max-sleep-interval', metavar
='SECONDS',
815 dest
='max_sleep_interval', type=float,
816 help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval')
817 workarounds
.add_option(
818 '--sleep-subtitles', metavar
='SECONDS',
819 dest
='sleep_interval_subtitles', default
=0, type=int,
820 help='Number of seconds to sleep before each subtitle download')
822 verbosity
= optparse
.OptionGroup(parser
, 'Verbosity and Simulation Options')
823 verbosity
.add_option(
825 action
='store_true', dest
='quiet', default
=False,
826 help='Activate quiet mode. If used with --verbose, print the log to stderr')
827 verbosity
.add_option(
829 dest
='no_warnings', action
='store_true', default
=False,
830 help='Ignore warnings')
831 verbosity
.add_option(
833 action
='store_true', dest
='simulate', default
=None,
834 help='Do not download the video and do not write anything to disk')
835 verbosity
.add_option(
837 action
='store_false', dest
='simulate',
838 help='Download the video even if printing/listing options are used')
839 verbosity
.add_option(
840 '--ignore-no-formats-error',
841 action
='store_true', dest
='ignore_no_formats_error', default
=False,
843 'Ignore "No video formats" error. Useful for extracting metadata '
844 'even if the videos are not actually available for download (experimental)'))
845 verbosity
.add_option(
846 '--no-ignore-no-formats-error',
847 action
='store_false', dest
='ignore_no_formats_error',
848 help='Throw error when no downloadable video formats are found (default)')
849 verbosity
.add_option(
850 '--skip-download', '--no-download',
851 action
='store_true', dest
='skip_download', default
=False,
852 help='Do not download the video but write all related files (Alias: --no-download)')
853 verbosity
.add_option(
855 metavar
='TEMPLATE', action
='append', dest
='forceprint',
857 'Quiet, but print the given fields for each video. Simulate unless --no-simulate is used. '
858 'Either a field name or same syntax as the output template can be used'))
859 verbosity
.add_option(
861 action
='store_true', dest
='geturl', default
=False,
862 help=optparse
.SUPPRESS_HELP
)
863 verbosity
.add_option(
865 action
='store_true', dest
='gettitle', default
=False,
866 help=optparse
.SUPPRESS_HELP
)
867 verbosity
.add_option(
869 action
='store_true', dest
='getid', default
=False,
870 help=optparse
.SUPPRESS_HELP
)
871 verbosity
.add_option(
873 action
='store_true', dest
='getthumbnail', default
=False,
874 help=optparse
.SUPPRESS_HELP
)
875 verbosity
.add_option(
877 action
='store_true', dest
='getdescription', default
=False,
878 help=optparse
.SUPPRESS_HELP
)
879 verbosity
.add_option(
881 action
='store_true', dest
='getduration', default
=False,
882 help=optparse
.SUPPRESS_HELP
)
883 verbosity
.add_option(
885 action
='store_true', dest
='getfilename', default
=False,
886 help=optparse
.SUPPRESS_HELP
)
887 verbosity
.add_option(
889 action
='store_true', dest
='getformat', default
=False,
890 help=optparse
.SUPPRESS_HELP
)
891 verbosity
.add_option(
893 action
='store_true', dest
='dumpjson', default
=False,
894 help='Quiet, but print JSON information for each video. Simulate unless --no-simulate is used. See "OUTPUT TEMPLATE" for a description of available keys')
895 verbosity
.add_option(
896 '-J', '--dump-single-json',
897 action
='store_true', dest
='dump_single_json', default
=False,
899 'Quiet, but print JSON information for each url or infojson passed. Simulate unless --no-simulate is used. '
900 'If the URL refers to a playlist, the whole playlist information is dumped in a single line'))
901 verbosity
.add_option(
903 action
='store_true', dest
='print_json', default
=False,
904 help=optparse
.SUPPRESS_HELP
)
905 verbosity
.add_option(
906 '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
907 action
='store_true', dest
='force_write_download_archive', default
=False,
909 'Force download archive entries to be written as far as no errors occur, '
910 'even if -s or another simulation option is used (Alias: --force-download-archive)'))
911 verbosity
.add_option(
913 action
='store_true', dest
='progress_with_newline', default
=False,
914 help='Output progress bar as new lines')
915 verbosity
.add_option(
917 action
='store_true', dest
='noprogress', default
=None,
918 help='Do not print progress bar')
919 verbosity
.add_option(
921 action
='store_false', dest
='noprogress',
922 help='Show progress bar, even if in quiet mode')
923 verbosity
.add_option(
925 action
='store_true', dest
='consoletitle', default
=False,
926 help='Display progress in console titlebar')
927 verbosity
.add_option(
928 '--progress-template',
929 metavar
='[TYPES:]TEMPLATE', dest
='progress_template', default
={}, type='str',
930 action
='callback', callback
=_dict_from_options_callback
,
932 'allowed_keys': '(download|postprocess)(-title)?',
933 'default_key': 'download'
935 'Template for progress outputs, optionally prefixed with one of "download:" (default), '
936 '"download-title:" (the console title), "postprocess:", or "postprocess-title:". '
937 'The video\'s fields are accessible under the "info" key and '
938 'the progress attributes are accessible under "progress" key. E.g.: '
939 # TODO: Document the fields inside "progress"
940 '--console-title --progress-template "download-title:%(info.id)s-%(progress.eta)s"'))
941 verbosity
.add_option(
943 action
='store_true', dest
='verbose', default
=False,
944 help='Print various debugging information')
945 verbosity
.add_option(
946 '--dump-pages', '--dump-intermediate-pages',
947 action
='store_true', dest
='dump_intermediate_pages', default
=False,
948 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
949 verbosity
.add_option(
951 action
='store_true', dest
='write_pages', default
=False,
952 help='Write downloaded intermediary pages to files in the current directory to debug problems')
953 verbosity
.add_option(
954 '--youtube-print-sig-code',
955 action
='store_true', dest
='youtube_print_sig_code', default
=False,
956 help=optparse
.SUPPRESS_HELP
)
957 verbosity
.add_option(
958 '--print-traffic', '--dump-headers',
959 dest
='debug_printtraffic', action
='store_true', default
=False,
960 help='Display sent and read HTTP traffic')
961 verbosity
.add_option(
963 dest
='call_home', action
='store_true', default
=False,
964 # help='[Broken] Contact the yt-dlp server for debugging')
965 help=optparse
.SUPPRESS_HELP
)
966 verbosity
.add_option(
968 dest
='call_home', action
='store_false',
969 # help='Do not contact the yt-dlp server for debugging (default)')
970 help=optparse
.SUPPRESS_HELP
)
972 filesystem
= optparse
.OptionGroup(parser
, 'Filesystem Options')
973 filesystem
.add_option(
974 '-a', '--batch-file',
975 dest
='batchfile', metavar
='FILE',
976 help="File containing URLs to download ('-' for stdin), one URL per line. "
977 "Lines starting with '#', ';' or ']' are considered as comments and ignored")
978 filesystem
.add_option(
980 dest
='batchfile', action
='store_const', const
=None,
981 help='Do not read URLs from batch file (default)')
982 filesystem
.add_option(
983 '--id', default
=False,
984 action
='store_true', dest
='useid', help=optparse
.SUPPRESS_HELP
)
985 filesystem
.add_option(
987 metavar
='[TYPES:]PATH', dest
='paths', default
={}, type='str',
988 action
='callback', callback
=_dict_from_options_callback
,
990 'allowed_keys': 'home|temp|%s' % '|'.join(OUTTMPL_TYPES
.keys()),
991 'default_key': 'home'
993 'The paths where the files should be downloaded. '
994 'Specify the type of file and the path separated by a colon ":". '
995 'All the same types as --output are supported. '
996 'Additionally, you can also provide "home" (default) and "temp" paths. '
997 'All intermediary files are first downloaded to the temp path and '
998 'then the final files are moved over to the home path after download is finished. '
999 'This option is ignored if --output is an absolute path'))
1000 filesystem
.add_option(
1002 metavar
='[TYPES:]TEMPLATE', dest
='outtmpl', default
={}, type='str',
1003 action
='callback', callback
=_dict_from_options_callback
,
1005 'allowed_keys': '|'.join(OUTTMPL_TYPES
.keys()),
1006 'default_key': 'default'
1007 }, help='Output filename template; see "OUTPUT TEMPLATE" for details')
1008 filesystem
.add_option(
1009 '--output-na-placeholder',
1010 dest
='outtmpl_na_placeholder', metavar
='TEXT', default
='NA',
1011 help=('Placeholder value for unavailable meta fields in output filename template (default: "%default")'))
1012 filesystem
.add_option(
1013 '--autonumber-size',
1014 dest
='autonumber_size', metavar
='NUMBER', type=int,
1015 help=optparse
.SUPPRESS_HELP
)
1016 filesystem
.add_option(
1017 '--autonumber-start',
1018 dest
='autonumber_start', metavar
='NUMBER', default
=1, type=int,
1019 help=optparse
.SUPPRESS_HELP
)
1020 filesystem
.add_option(
1021 '--restrict-filenames',
1022 action
='store_true', dest
='restrictfilenames', default
=False,
1023 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
1024 filesystem
.add_option(
1025 '--no-restrict-filenames',
1026 action
='store_false', dest
='restrictfilenames',
1027 help='Allow Unicode characters, "&" and spaces in filenames (default)')
1028 filesystem
.add_option(
1029 '--windows-filenames',
1030 action
='store_true', dest
='windowsfilenames', default
=False,
1031 help='Force filenames to be Windows-compatible')
1032 filesystem
.add_option(
1033 '--no-windows-filenames',
1034 action
='store_false', dest
='windowsfilenames',
1035 help='Make filenames Windows-compatible only if using Windows (default)')
1036 filesystem
.add_option(
1037 '--trim-filenames', '--trim-file-names', metavar
='LENGTH',
1038 dest
='trim_file_name', default
=0, type=int,
1039 help='Limit the filename length (excluding extension) to the specified number of characters')
1040 filesystem
.add_option(
1041 '-w', '--no-overwrites',
1042 action
='store_false', dest
='overwrites', default
=None,
1043 help='Do not overwrite any files')
1044 filesystem
.add_option(
1045 '--force-overwrites', '--yes-overwrites',
1046 action
='store_true', dest
='overwrites',
1047 help='Overwrite all video and metadata files. This option includes --no-continue')
1048 filesystem
.add_option(
1049 '--no-force-overwrites',
1050 action
='store_const', dest
='overwrites', const
=None,
1051 help='Do not overwrite the video, but overwrite related files (default)')
1052 filesystem
.add_option(
1054 action
='store_true', dest
='continue_dl', default
=True,
1055 help='Resume partially downloaded files/fragments (default)')
1056 filesystem
.add_option(
1058 action
='store_false', dest
='continue_dl',
1060 'Do not resume partially downloaded fragments. '
1061 'If the file is not fragmented, restart download of the entire file'))
1062 filesystem
.add_option(
1064 action
='store_false', dest
='nopart', default
=False,
1065 help='Use .part files instead of writing directly into output file (default)')
1066 filesystem
.add_option(
1068 action
='store_true', dest
='nopart',
1069 help='Do not use .part files - write directly into output file')
1070 filesystem
.add_option(
1072 action
='store_true', dest
='updatetime', default
=True,
1073 help='Use the Last-modified header to set the file modification time (default)')
1074 filesystem
.add_option(
1076 action
='store_false', dest
='updatetime',
1077 help='Do not use the Last-modified header to set the file modification time')
1078 filesystem
.add_option(
1079 '--write-description',
1080 action
='store_true', dest
='writedescription', default
=False,
1081 help='Write video description to a .description file')
1082 filesystem
.add_option(
1083 '--no-write-description',
1084 action
='store_false', dest
='writedescription',
1085 help='Do not write video description (default)')
1086 filesystem
.add_option(
1087 '--write-info-json',
1088 action
='store_true', dest
='writeinfojson', default
=False,
1089 help='Write video metadata to a .info.json file (this may contain personal information)')
1090 filesystem
.add_option(
1091 '--no-write-info-json',
1092 action
='store_false', dest
='writeinfojson',
1093 help='Do not write video metadata (default)')
1094 filesystem
.add_option(
1095 '--write-annotations',
1096 action
='store_true', dest
='writeannotations', default
=False,
1097 help=optparse
.SUPPRESS_HELP
)
1098 filesystem
.add_option(
1099 '--no-write-annotations',
1100 action
='store_false', dest
='writeannotations',
1101 help=optparse
.SUPPRESS_HELP
)
1102 filesystem
.add_option(
1103 '--write-playlist-metafiles',
1104 action
='store_true', dest
='allow_playlist_files', default
=None,
1106 'Write playlist metadata in addition to the video metadata '
1107 'when using --write-info-json, --write-description etc. (default)'))
1108 filesystem
.add_option(
1109 '--no-write-playlist-metafiles',
1110 action
='store_false', dest
='allow_playlist_files',
1111 help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
1112 filesystem
.add_option(
1114 action
='store_true', dest
='clean_infojson', default
=None,
1116 'Remove some private fields such as filenames from the infojson. '
1117 'Note that it could still contain some personal information (default)'))
1118 filesystem
.add_option(
1119 '--no-clean-infojson',
1120 action
='store_false', dest
='clean_infojson',
1121 help='Write all fields to the infojson')
1122 filesystem
.add_option(
1123 '--write-comments', '--get-comments',
1124 action
='store_true', dest
='getcomments', default
=False,
1126 'Retrieve video comments to be placed in the infojson. '
1127 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)'))
1128 filesystem
.add_option(
1129 '--no-write-comments', '--no-get-comments',
1130 action
='store_false', dest
='getcomments',
1131 help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)')
1132 filesystem
.add_option(
1133 '--load-info-json', '--load-info',
1134 dest
='load_info_filename', metavar
='FILE',
1135 help='JSON file containing the video information (created with the "--write-info-json" option)')
1136 filesystem
.add_option(
1138 dest
='cookiefile', metavar
='FILE',
1139 help='File to read cookies from and dump cookie jar in')
1140 filesystem
.add_option(
1142 action
='store_const', const
=None, dest
='cookiefile', metavar
='FILE',
1143 help='Do not read/dump cookies from/to file (default)')
1144 filesystem
.add_option(
1145 '--cookies-from-browser',
1146 dest
='cookiesfrombrowser', metavar
='BROWSER[:PROFILE]',
1148 'Load cookies from a user profile of the given web browser. '
1149 'Currently supported browsers are: {}. '
1150 'You can specify the user profile name or directory using '
1151 '"BROWSER:PROFILE_NAME" or "BROWSER:PROFILE_PATH". '
1152 'If no profile is given, the most recently accessed one is used'.format(
1153 ', '.join(sorted(SUPPORTED_BROWSERS
)))))
1154 filesystem
.add_option(
1155 '--no-cookies-from-browser',
1156 action
='store_const', const
=None, dest
='cookiesfrombrowser',
1157 help='Do not load cookies from browser (default)')
1158 filesystem
.add_option(
1159 '--cache-dir', dest
='cachedir', default
=None, metavar
='DIR',
1160 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')
1161 filesystem
.add_option(
1162 '--no-cache-dir', action
='store_false', dest
='cachedir',
1163 help='Disable filesystem caching')
1164 filesystem
.add_option(
1166 action
='store_true', dest
='rm_cachedir',
1167 help='Delete all filesystem cache files')
1169 thumbnail
= optparse
.OptionGroup(parser
, 'Thumbnail Options')
1170 thumbnail
.add_option(
1171 '--write-thumbnail',
1172 action
='store_true', dest
='writethumbnail', default
=False,
1173 help='Write thumbnail image to disk')
1174 thumbnail
.add_option(
1175 '--no-write-thumbnail',
1176 action
='store_false', dest
='writethumbnail',
1177 help='Do not write thumbnail image to disk (default)')
1178 thumbnail
.add_option(
1179 '--write-all-thumbnails',
1180 action
='store_true', dest
='write_all_thumbnails', default
=False,
1181 help='Write all thumbnail image formats to disk')
1182 thumbnail
.add_option(
1183 '--list-thumbnails',
1184 action
='store_true', dest
='list_thumbnails', default
=False,
1185 help='List available thumbnails of each video. Simulate unless --no-simulate is used')
1187 link
= optparse
.OptionGroup(parser
, 'Internet Shortcut Options')
1190 action
='store_true', dest
='writelink', default
=False,
1191 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1194 action
='store_true', dest
='writeurllink', default
=False,
1195 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1197 '--write-webloc-link',
1198 action
='store_true', dest
='writewebloclink', default
=False,
1199 help='Write a .webloc macOS internet shortcut')
1201 '--write-desktop-link',
1202 action
='store_true', dest
='writedesktoplink', default
=False,
1203 help='Write a .desktop Linux internet shortcut')
1205 postproc
= optparse
.OptionGroup(parser
, 'Post-Processing Options')
1206 postproc
.add_option(
1207 '-x', '--extract-audio',
1208 action
='store_true', dest
='extractaudio', default
=False,
1209 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1210 postproc
.add_option(
1211 '--audio-format', metavar
='FORMAT', dest
='audioformat', default
='best',
1213 'Specify audio format to convert the audio to when -x is used. Currently supported formats are: '
1214 'best (default) or one of %s' % '|'.join(FFmpegExtractAudioPP
.SUPPORTED_EXTS
)))
1215 postproc
.add_option(
1216 '--audio-quality', metavar
='QUALITY',
1217 dest
='audioquality', default
='5',
1218 help='Specify ffmpeg audio quality, insert a value between 0 (best) and 10 (worst) for VBR or a specific bitrate like 128K (default %default)')
1219 postproc
.add_option(
1221 metavar
='FORMAT', dest
='remuxvideo', default
=None,
1223 'Remux the video into another container if necessary (currently supported: %s). '
1224 'If target container does not support the video/audio codec, remuxing will fail. '
1225 'You can specify multiple rules; Eg. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 '
1226 'and anything else to mkv.' % '|'.join(FFmpegVideoRemuxerPP
.SUPPORTED_EXTS
)))
1227 postproc
.add_option(
1229 metavar
='FORMAT', dest
='recodevideo', default
=None,
1231 'Re-encode the video into another format if re-encoding is necessary. '
1232 'The syntax and supported formats are the same as --remux-video'))
1233 postproc
.add_option(
1234 '--postprocessor-args', '--ppa',
1235 metavar
='NAME:ARGS', dest
='postprocessor_args', default
={}, type='str',
1236 action
='callback', callback
=_dict_from_options_callback
,
1238 'allowed_keys': r
'\w+(?:\+\w+)?', 'default_key': 'default-compat',
1239 'process': compat_shlex_split
,
1240 'multiple_keys': False
1242 'Give these arguments to the postprocessors. '
1243 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1244 'to give the argument to the specified postprocessor/executable. Supported PP are: '
1245 'Merger, ModifyChapters, SplitChapters, ExtractAudio, VideoRemuxer, VideoConvertor, '
1246 'Metadata, EmbedSubtitle, EmbedThumbnail, SubtitlesConvertor, ThumbnailsConvertor, '
1247 'FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. '
1248 'The supported executables are: AtomicParsley, FFmpeg and FFprobe. '
1249 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1250 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
1251 '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
1252 'before the specified input/output file. Eg: --ppa "Merger+ffmpeg_i1:-v quiet". '
1253 'You can use this option multiple times to give different arguments to different '
1254 'postprocessors. (Alias: --ppa)'))
1255 postproc
.add_option(
1256 '-k', '--keep-video',
1257 action
='store_true', dest
='keepvideo', default
=False,
1258 help='Keep the intermediate video file on disk after post-processing')
1259 postproc
.add_option(
1261 action
='store_false', dest
='keepvideo',
1262 help='Delete the intermediate video file after post-processing (default)')
1263 postproc
.add_option(
1264 '--post-overwrites',
1265 action
='store_false', dest
='nopostoverwrites',
1266 help='Overwrite post-processed files (default)')
1267 postproc
.add_option(
1268 '--no-post-overwrites',
1269 action
='store_true', dest
='nopostoverwrites', default
=False,
1270 help='Do not overwrite post-processed files')
1271 postproc
.add_option(
1273 action
='store_true', dest
='embedsubtitles', default
=False,
1274 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1275 postproc
.add_option(
1277 action
='store_false', dest
='embedsubtitles',
1278 help='Do not embed subtitles (default)')
1279 postproc
.add_option(
1280 '--embed-thumbnail',
1281 action
='store_true', dest
='embedthumbnail', default
=False,
1282 help='Embed thumbnail in the video as cover art')
1283 postproc
.add_option(
1284 '--no-embed-thumbnail',
1285 action
='store_false', dest
='embedthumbnail',
1286 help='Do not embed thumbnail (default)')
1287 postproc
.add_option(
1288 '--embed-metadata', '--add-metadata',
1289 action
='store_true', dest
='addmetadata', default
=False,
1290 help='Embed metadata to the video file. Also adds chapters to file unless --no-add-chapters is used (Alias: --add-metadata)')
1291 postproc
.add_option(
1292 '--no-embed-metadata', '--no-add-metadata',
1293 action
='store_false', dest
='addmetadata',
1294 help='Do not add metadata to file (default) (Alias: --no-add-metadata)')
1295 postproc
.add_option(
1296 '--embed-chapters', '--add-chapters',
1297 action
='store_true', dest
='addchapters', default
=None,
1298 help='Add chapter markers to the video file (Alias: --add-chapters)')
1299 postproc
.add_option(
1300 '--no-embed-chapters', '--no-add-chapters',
1301 action
='store_false', dest
='addchapters',
1302 help='Do not add chapter markers (default) (Alias: --no-add-chapters)')
1303 postproc
.add_option(
1304 '--metadata-from-title',
1305 metavar
='FORMAT', dest
='metafromtitle',
1306 help=optparse
.SUPPRESS_HELP
)
1307 postproc
.add_option(
1309 metavar
='FROM:TO', dest
='parse_metadata', action
='append',
1311 'Parse additional metadata like title/artist from other fields; '
1312 'see "MODIFYING METADATA" for details'))
1313 postproc
.add_option(
1314 '--replace-in-metadata',
1315 dest
='parse_metadata', metavar
='FIELDS REGEX REPLACE', action
='append', nargs
=3,
1316 help='Replace text in a metadata field using the given regex. This option can be used multiple times')
1317 postproc
.add_option(
1319 action
='store_true', dest
='xattrs', default
=False,
1320 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
1321 postproc
.add_option(
1323 metavar
='POLICY', dest
='fixup', default
=None,
1324 choices
=('never', 'ignore', 'warn', 'detect_or_warn', 'force'),
1326 'Automatically correct known faults of the file. '
1327 'One of never (do nothing), warn (only emit a warning), '
1328 'detect_or_warn (the default; fix file if we can, warn otherwise), '
1329 'force (try fixing even if file already exists'))
1330 postproc
.add_option(
1331 '--prefer-avconv', '--no-prefer-ffmpeg',
1332 action
='store_false', dest
='prefer_ffmpeg',
1333 help=optparse
.SUPPRESS_HELP
)
1334 postproc
.add_option(
1335 '--prefer-ffmpeg', '--no-prefer-avconv',
1336 action
='store_true', dest
='prefer_ffmpeg', default
=True,
1337 help=optparse
.SUPPRESS_HELP
)
1338 postproc
.add_option(
1339 '--ffmpeg-location', '--avconv-location', metavar
='PATH',
1340 dest
='ffmpeg_location',
1341 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1342 postproc
.add_option(
1343 '--exec', metavar
='CMD',
1344 action
='append', dest
='exec_cmd',
1346 'Execute a command on the file after downloading and post-processing. '
1347 'Same syntax as the output template can be used to pass any field as arguments to the command. '
1348 'An additional field "filepath" that contains the final path of the downloaded file is also available. '
1349 'If no fields are passed, %(filepath)q is appended to the end of the command. '
1350 'This option can be used multiple times'))
1351 postproc
.add_option(
1353 action
='store_const', dest
='exec_cmd', const
=[],
1354 help='Remove any previously defined --exec')
1355 postproc
.add_option(
1356 '--exec-before-download', metavar
='CMD',
1357 action
='append', dest
='exec_before_dl_cmd',
1359 'Execute a command before the actual download. '
1360 'The syntax is the same as --exec but "filepath" is not available. '
1361 'This option can be used multiple times'))
1362 postproc
.add_option(
1363 '--no-exec-before-download',
1364 action
='store_const', dest
='exec_before_dl_cmd', const
=[],
1365 help='Remove any previously defined --exec-before-download')
1366 postproc
.add_option(
1367 '--convert-subs', '--convert-sub', '--convert-subtitles',
1368 metavar
='FORMAT', dest
='convertsubtitles', default
=None,
1370 'Convert the subtitles to another format (currently supported: %s) '
1371 '(Alias: --convert-subtitles)' % '|'.join(FFmpegSubtitlesConvertorPP
.SUPPORTED_EXTS
)))
1372 postproc
.add_option(
1373 '--convert-thumbnails',
1374 metavar
='FORMAT', dest
='convertthumbnails', default
=None,
1376 'Convert the thumbnails to another format '
1377 '(currently supported: %s) ' % '|'.join(FFmpegThumbnailsConvertorPP
.SUPPORTED_EXTS
)))
1378 postproc
.add_option(
1379 '--split-chapters', '--split-tracks',
1380 dest
='split_chapters', action
='store_true', default
=False,
1382 'Split video into multiple files based on internal chapters. '
1383 'The "chapter:" prefix can be used with "--paths" and "--output" to '
1384 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1385 postproc
.add_option(
1386 '--no-split-chapters', '--no-split-tracks',
1387 dest
='split_chapters', action
='store_false',
1388 help='Do not split video based on chapters (default)')
1389 postproc
.add_option(
1390 '--remove-chapters',
1391 metavar
='REGEX', dest
='remove_chapters', action
='append',
1393 'Remove chapters whose title matches the given regular expression. '
1394 'Time ranges prefixed by a "*" can also be used in place of chapters to remove the specified range. '
1395 'Eg: --remove-chapters "*10:15-15:00" --remove-chapters "intro". '
1396 'This option can be used multiple times'))
1397 postproc
.add_option(
1398 '--no-remove-chapters', dest
='remove_chapters', action
='store_const', const
=None,
1399 help='Do not remove any chapters from the file (default)')
1400 postproc
.add_option(
1401 '--force-keyframes-at-cuts',
1402 action
='store_true', dest
='force_keyframes_at_cuts', default
=False,
1404 'Force keyframes around the chapters before removing/splitting them. '
1405 'Requires a reencode and thus is very slow, but the resulting video '
1406 'may have fewer artifacts around the cuts'))
1407 postproc
.add_option(
1408 '--no-force-keyframes-at-cuts',
1409 action
='store_false', dest
='force_keyframes_at_cuts',
1410 help='Do not force keyframes around the chapters when cutting/splitting (default)')
1411 _postprocessor_opts_parser
= lambda key
, val
='': (
1412 *(item
.split('=', 1) for item
in (val
.split(';') if val
else [])),
1413 ('key', remove_end(key
, 'PP')))
1414 postproc
.add_option(
1415 '--use-postprocessor',
1416 metavar
='NAME[:ARGS]', dest
='add_postprocessors', default
=[], type='str',
1417 action
='callback', callback
=_list_from_options_callback
,
1420 'process': lambda val
: dict(_postprocessor_opts_parser(*val
.split(':', 1)))
1422 'The (case sensitive) name of plugin postprocessors to be enabled, '
1423 'and (optionally) arguments to be passed to it, seperated by a colon ":". '
1424 'ARGS are a semicolon ";" delimited list of NAME=VALUE. '
1425 'The "when" argument determines when the postprocessor is invoked. '
1426 'It can be one of "pre_process" (after extraction), '
1427 '"before_dl" (before video download), "post_process" (after video download; default) '
1428 'or "after_move" (after moving file to their final locations). '
1429 'This option can be used multiple times to add different postprocessors'))
1431 sponsorblock
= optparse
.OptionGroup(parser
, 'SponsorBlock Options', description
=(
1432 'Make chapter entries for, or remove various segments (sponsor, introductions, etc.) '
1433 'from downloaded YouTube videos using the SponsorBlock API (https://sponsor.ajay.app)'))
1434 sponsorblock
.add_option(
1435 '--sponsorblock-mark', metavar
='CATS',
1436 dest
='sponsorblock_mark', default
=set(), action
='callback', type='str',
1437 callback
=_set_from_options_callback
, callback_kwargs
={'allowed_values': SponsorBlockPP.CATEGORIES.keys()}
,
1439 'SponsorBlock categories to create chapters for, separated by commas. '
1440 'Available categories are all, %s. You can prefix the category with a "-" to exempt it. '
1441 'See https://wiki.sponsor.ajay.app/index.php/Segment_Categories for description of the categories. '
1442 'Eg: --sponsorblock-mark all,-preview' % ', '.join(SponsorBlockPP
.CATEGORIES
.keys())))
1443 sponsorblock
.add_option(
1444 '--sponsorblock-remove', metavar
='CATS',
1445 dest
='sponsorblock_remove', default
=set(), action
='callback', type='str',
1446 callback
=_set_from_options_callback
, callback_kwargs
={'allowed_values': SponsorBlockPP.CATEGORIES.keys()}
,
1448 'SponsorBlock categories to be removed from the video file, separated by commas. '
1449 'If a category is present in both mark and remove, remove takes precedence. '
1450 'The syntax and available categories are the same as for --sponsorblock-mark'))
1451 sponsorblock
.add_option(
1452 '--sponsorblock-chapter-title', metavar
='TEMPLATE',
1453 default
=DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
, dest
='sponsorblock_chapter_title',
1455 'The title template for SponsorBlock chapters created by --sponsorblock-mark. '
1456 'The same syntax as the output template is used, but the only available fields are '
1457 'start_time, end_time, category, categories, name, category_names. Defaults to "%default"'))
1458 sponsorblock
.add_option(
1459 '--no-sponsorblock', default
=False,
1460 action
='store_true', dest
='no_sponsorblock',
1461 help='Disable both --sponsorblock-mark and --sponsorblock-remove')
1462 sponsorblock
.add_option(
1463 '--sponsorblock-api', metavar
='URL',
1464 default
='https://sponsor.ajay.app', dest
='sponsorblock_api',
1465 help='SponsorBlock API location, defaults to %default')
1467 sponsorblock
.add_option(
1469 action
='store_true', dest
='sponskrub', default
=False,
1470 help=optparse
.SUPPRESS_HELP
)
1471 sponsorblock
.add_option(
1473 action
='store_false', dest
='sponskrub',
1474 help=optparse
.SUPPRESS_HELP
)
1475 sponsorblock
.add_option(
1476 '--sponskrub-cut', default
=False,
1477 action
='store_true', dest
='sponskrub_cut',
1478 help=optparse
.SUPPRESS_HELP
)
1479 sponsorblock
.add_option(
1480 '--no-sponskrub-cut',
1481 action
='store_false', dest
='sponskrub_cut',
1482 help=optparse
.SUPPRESS_HELP
)
1483 sponsorblock
.add_option(
1484 '--sponskrub-force', default
=False,
1485 action
='store_true', dest
='sponskrub_force',
1486 help=optparse
.SUPPRESS_HELP
)
1487 sponsorblock
.add_option(
1488 '--no-sponskrub-force',
1489 action
='store_true', dest
='sponskrub_force',
1490 help=optparse
.SUPPRESS_HELP
)
1491 sponsorblock
.add_option(
1492 '--sponskrub-location', metavar
='PATH',
1493 dest
='sponskrub_path', default
='',
1494 help=optparse
.SUPPRESS_HELP
)
1495 sponsorblock
.add_option(
1496 '--sponskrub-args', dest
='sponskrub_args', metavar
='ARGS',
1497 help=optparse
.SUPPRESS_HELP
)
1499 extractor
= optparse
.OptionGroup(parser
, 'Extractor Options')
1500 extractor
.add_option(
1501 '--extractor-retries',
1502 dest
='extractor_retries', metavar
='RETRIES', default
=3,
1503 help='Number of retries for known extractor errors (default is %default), or "infinite"')
1504 extractor
.add_option(
1505 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1506 action
='store_true', dest
='dynamic_mpd', default
=True,
1507 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1508 extractor
.add_option(
1509 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1510 action
='store_false', dest
='dynamic_mpd',
1511 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1512 extractor
.add_option(
1513 '--hls-split-discontinuity',
1514 dest
='hls_split_discontinuity', action
='store_true', default
=False,
1515 help='Split HLS playlists to different formats at discontinuities such as ad breaks'
1517 extractor
.add_option(
1518 '--no-hls-split-discontinuity',
1519 dest
='hls_split_discontinuity', action
='store_false',
1520 help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
1521 _extractor_arg_parser
= lambda key
, vals
='': (key
.strip().lower().replace('-', '_'), [val
.strip() for val
in vals
.split(',')])
1522 extractor
.add_option(
1524 metavar
='KEY:ARGS', dest
='extractor_args', default
={}, type='str',
1525 action
='callback', callback
=_dict_from_options_callback
,
1527 'multiple_keys': False,
1528 'process': lambda val
: dict(
1529 _extractor_arg_parser(*arg
.split('=', 1)) for arg
in val
.split(';'))
1531 'Pass these arguments to the extractor. See "EXTRACTOR ARGUMENTS" for details. '
1532 'You can use this option multiple times to give arguments for different extractors'))
1533 extractor
.add_option(
1534 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1535 action
='store_true', dest
='youtube_include_dash_manifest', default
=True,
1536 help=optparse
.SUPPRESS_HELP
)
1537 extractor
.add_option(
1538 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1539 action
='store_false', dest
='youtube_include_dash_manifest',
1540 help=optparse
.SUPPRESS_HELP
)
1541 extractor
.add_option(
1542 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1543 action
='store_true', dest
='youtube_include_hls_manifest', default
=True,
1544 help=optparse
.SUPPRESS_HELP
)
1545 extractor
.add_option(
1546 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1547 action
='store_false', dest
='youtube_include_hls_manifest',
1548 help=optparse
.SUPPRESS_HELP
)
1550 parser
.add_option_group(general
)
1551 parser
.add_option_group(network
)
1552 parser
.add_option_group(geo
)
1553 parser
.add_option_group(selection
)
1554 parser
.add_option_group(downloader
)
1555 parser
.add_option_group(filesystem
)
1556 parser
.add_option_group(thumbnail
)
1557 parser
.add_option_group(link
)
1558 parser
.add_option_group(verbosity
)
1559 parser
.add_option_group(workarounds
)
1560 parser
.add_option_group(video_format
)
1561 parser
.add_option_group(subtitles
)
1562 parser
.add_option_group(authentication
)
1563 parser
.add_option_group(postproc
)
1564 parser
.add_option_group(sponsorblock
)
1565 parser
.add_option_group(extractor
)
1567 if overrideArguments
is not None:
1568 opts
, args
= parser
.parse_args(overrideArguments
)
1570 write_string('[debug] Override config: ' + repr(overrideArguments
) + '\n')
1572 def compat_conf(conf
):
1573 if sys
.version_info
< (3,):
1574 return [a
.decode(preferredencoding(), 'replace') for a
in conf
]
1578 'command-line': compat_conf(sys
.argv
[1:]),
1579 'custom': [], 'home': [], 'portable': [], 'user': [], 'system': []}
1580 paths
= {'command-line': False}
1582 def read_options(name
, path
, user
=False):
1583 ''' loads config files and returns ignoreconfig '''
1584 # Multiple package names can be given here
1585 # Eg: ('yt-dlp', 'youtube-dlc', 'youtube-dl') will look for
1586 # the configuration file of any of these three packages
1587 for package
in ('yt-dlp',):
1589 config
, current_path
= _readUserConf(package
, default
=None)
1591 current_path
= os
.path
.join(path
, '%s.conf' % package
)
1592 config
= _readOptions(current_path
, default
=None)
1593 if config
is not None:
1594 configs
[name
], paths
[name
] = config
, current_path
1595 return parser
.parse_args(config
)[0].ignoreconfig
1599 opts
, _
= parser
.parse_args(configs
['command-line'])
1600 if opts
.config_location
is not None:
1601 location
= compat_expanduser(opts
.config_location
)
1602 if os
.path
.isdir(location
):
1603 location
= os
.path
.join(location
, 'yt-dlp.conf')
1604 if not os
.path
.exists(location
):
1605 parser
.error('config-location %s does not exist.' % location
)
1606 config
= _readOptions(location
, default
=None)
1608 configs
['custom'], paths
['custom'] = config
, location
1610 if opts
.ignoreconfig
:
1612 if parser
.parse_args(configs
['custom'])[0].ignoreconfig
:
1614 if read_options('portable', get_executable_path()):
1616 opts
, _
= parser
.parse_args(configs
['portable'] + configs
['custom'] + configs
['command-line'])
1617 if read_options('home', expand_path(opts
.paths
.get('home', '')).strip()):
1619 if read_options('system', '/etc'):
1621 if read_options('user', None, user
=True):
1622 configs
['system'], paths
['system'] = [], None
1625 argv
= configs
['system'] + configs
['user'] + configs
['home'] + configs
['portable'] + configs
['custom'] + configs
['command-line']
1626 opts
, args
= parser
.parse_args(argv
)
1628 for label
in ('Command-line', 'Custom', 'Portable', 'Home', 'User', 'System'):
1631 write_string(f
'[debug] {label} config file: {paths[key]}\n')
1632 if paths
.get(key
) is not None:
1633 write_string(f
'[debug] {label} config: {_hide_login_info(configs[key])!r}\n')
1635 return parser
, opts
, args