1 from __future__
import unicode_literals
10 compat_get_terminal_size
,
22 from .cookies
import SUPPORTED_BROWSERS
23 from .version
import __version__
25 from .downloader
.external
import list_external_downloaders
26 from .postprocessor
import (
28 FFmpegSubtitlesConvertorPP
,
29 FFmpegThumbnailsConvertorPP
,
33 from .postprocessor
.modify_chapters
import DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
36 def _hide_login_info(opts
):
37 PRIVATE_OPTS
= set(['-p', '--password', '-u', '--username', '--video-password', '--ap-password', '--ap-username'])
38 eqre
= re
.compile('^(?P<key>' + ('|'.join(re
.escape(po
) for po
in PRIVATE_OPTS
)) + ')=.+$')
43 return m
.group('key') + '=PRIVATE'
47 opts
= list(map(_scrub_eq
, opts
))
48 for idx
, opt
in enumerate(opts
):
49 if opt
in PRIVATE_OPTS
and idx
+ 1 < len(opts
):
50 opts
[idx
+ 1] = 'PRIVATE'
54 def parseOpts(overrideArguments
=None):
55 def _readOptions(filename_bytes
, default
=[]):
57 optionf
= open(filename_bytes
)
59 return default
# silently skip if file is not present
61 # FIXME: https://github.com/ytdl-org/youtube-dl/commit/dfe5fa49aed02cf36ba9f743b11b0903554b5e56
62 contents
= optionf
.read()
63 if sys
.version_info
< (3,):
64 contents
= contents
.decode(preferredencoding())
65 res
= compat_shlex_split(contents
, comments
=True)
70 def _readUserConf(package_name
, default
=[]):
72 xdg_config_home
= compat_getenv('XDG_CONFIG_HOME') or compat_expanduser('~/.config')
73 userConfFile
= os
.path
.join(xdg_config_home
, package_name
, 'config')
74 if not os
.path
.isfile(userConfFile
):
75 userConfFile
= os
.path
.join(xdg_config_home
, '%s.conf' % package_name
)
76 userConf
= _readOptions(userConfFile
, default
=None)
77 if userConf
is not None:
78 return userConf
, userConfFile
81 appdata_dir
= compat_getenv('appdata')
83 userConfFile
= os
.path
.join(appdata_dir
, package_name
, 'config')
84 userConf
= _readOptions(userConfFile
, default
=None)
86 userConfFile
+= '.txt'
87 userConf
= _readOptions(userConfFile
, default
=None)
88 if userConf
is not None:
89 return userConf
, userConfFile
92 userConfFile
= os
.path
.join(compat_expanduser('~'), '%s.conf' % package_name
)
93 userConf
= _readOptions(userConfFile
, default
=None)
95 userConfFile
+= '.txt'
96 userConf
= _readOptions(userConfFile
, default
=None)
97 if userConf
is not None:
98 return userConf
, userConfFile
102 def _format_option_string(option
):
103 ''' ('-o', '--option') -> -o, --format METAVAR'''
107 if option
._short
_opts
:
108 opts
.append(option
._short
_opts
[0])
109 if option
._long
_opts
:
110 opts
.append(option
._long
_opts
[0])
114 if option
.takes_value():
115 opts
.append(' %s' % option
.metavar
)
119 def _list_from_options_callback(option
, opt_str
, value
, parser
, append
=True, delim
=',', process
=str.strip
):
120 # append can be True, False or -1 (prepend)
121 current
= getattr(parser
.values
, option
.dest
) if append
else []
122 value
= [process(value
)] if delim
is None else list(map(process
, value
.split(delim
)))
124 parser
.values
, option
.dest
,
125 current
+ value
if append
is True else value
+ current
)
127 def _set_from_options_callback(
128 option
, opt_str
, value
, parser
, delim
=',', allowed_values
=None, aliases
={},
129 process
=lambda x
: x
.lower().strip()):
130 current
= getattr(parser
.values
, option
.dest
)
131 values
= [process(value
)] if delim
is None else list(map(process
, value
.split(delim
)[::-1]))
133 actual_val
= val
= values
.pop()
135 current
.update(allowed_values
)
139 values
.extend(aliases
[val
])
145 current
.update([val
])
146 if allowed_values
is not None and val
not in allowed_values
:
147 raise optparse
.OptionValueError(f
'wrong {option.metavar} for {opt_str}: {actual_val}')
149 setattr(parser
.values
, option
.dest
, current
)
151 def _dict_from_options_callback(
152 option
, opt_str
, value
, parser
,
153 allowed_keys
=r
'[\w-]+', delimiter
=':', default_key
=None, process
=None, multiple_keys
=True):
155 out_dict
= getattr(parser
.values
, option
.dest
)
157 allowed_keys
= r
'(%s)(,(%s))*' % (allowed_keys
, allowed_keys
)
158 mobj
= re
.match(r
'(?i)(?P<keys>%s)%s(?P<val>.*)$' % (allowed_keys
, delimiter
), value
)
160 keys
= [k
.strip() for k
in mobj
.group('keys').lower().split(',')]
161 val
= mobj
.group('val')
162 elif default_key
is not None:
163 keys
, val
= [default_key
], value
165 raise optparse
.OptionValueError(
166 'wrong %s formatting; it should be %s, not "%s"' % (opt_str
, option
.metavar
, value
))
168 val
= process(val
) if process
else val
169 except Exception as err
:
170 raise optparse
.OptionValueError(
171 'wrong %s formatting; %s' % (opt_str
, err
))
175 # No need to wrap help messages if we're on a wide console
176 columns
= compat_get_terminal_size().columns
177 max_width
= columns
if columns
else 80
178 # 47% is chosen because that is how README.md is currently formatted
179 # and moving help text even further to the right is undesirable.
180 # This can be reduced in the future to get a prettier output
181 max_help_position
= int(0.47 * max_width
)
183 fmt
= optparse
.IndentedHelpFormatter(width
=max_width
, max_help_position
=max_help_position
)
184 fmt
.format_option_strings
= _format_option_string
187 'version': __version__
,
189 'usage': '%prog [OPTIONS] URL [URL...]',
190 'conflict_handler': 'resolve',
193 parser
= optparse
.OptionParser(**compat_kwargs(kw
))
195 general
= optparse
.OptionGroup(parser
, 'General Options')
199 help='Print this help text and exit')
203 help='Print program version and exit')
206 action
='store_true', dest
='update_self',
207 help='Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
209 '-i', '--ignore-errors', '--no-abort-on-error',
210 action
='store_true', dest
='ignoreerrors', default
=None,
211 help='Continue on download errors, for example to skip unavailable videos in a playlist (default) (Alias: --no-abort-on-error)')
213 '--abort-on-error', '--no-ignore-errors',
214 action
='store_false', dest
='ignoreerrors',
215 help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
218 action
='store_true', dest
='dump_user_agent', default
=False,
219 help='Display the current user-agent and exit')
222 action
='store_true', dest
='list_extractors', default
=False,
223 help='List all supported extractors and exit')
225 '--extractor-descriptions',
226 action
='store_true', dest
='list_extractor_descriptions', default
=False,
227 help='Output descriptions of all supported extractors and exit')
229 '--force-generic-extractor',
230 action
='store_true', dest
='force_generic_extractor', default
=False,
231 help='Force extraction to use the generic extractor')
234 dest
='default_search', metavar
='PREFIX',
235 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')
237 '--ignore-config', '--no-config',
238 action
='store_true', dest
='ignoreconfig',
240 'Disable loading any configuration files except the one provided by --config-location. '
241 'When given inside a configuration file, no further configuration files are loaded. '
242 'Additionally, (for backward compatibility) if this option is found inside the '
243 'system configuration file, the user configuration is not loaded'))
246 dest
='config_location', metavar
='PATH',
247 help='Location of the main configuration file; either the path to the config or its containing directory')
250 action
='store_const', dest
='extract_flat', const
='in_playlist', default
=False,
251 help='Do not extract the videos of a playlist, only list them')
253 '--no-flat-playlist',
254 action
='store_false', dest
='extract_flat',
255 help='Extract the videos of a playlist')
258 action
='store_true', dest
='mark_watched', default
=False,
259 help='Mark videos watched (YouTube only)')
262 action
='store_false', dest
='mark_watched',
263 help='Do not mark videos watched (default)')
266 action
='store_true', dest
='no_color', default
=False,
267 help='Do not emit color codes in output')
270 metavar
='OPTS', dest
='compat_opts', default
=set(), type='str',
271 action
='callback', callback
=_set_from_options_callback
,
274 'filename', 'format-sort', 'abort-on-error', 'format-spec', 'no-playlist-metafiles',
275 'multistreams', 'no-live-chat', 'playlist-index', 'list-formats', 'no-direct-merge',
276 'no-youtube-channel-redirect', 'no-youtube-unavailable-videos', 'no-attach-info-json',
277 'embed-thumbnail-atomicparsley', 'seperate-video-versions', 'no-clean-infojson', 'no-keep-subs',
279 'youtube-dl': ['-multistreams', 'all'],
280 'youtube-dlc': ['-no-youtube-channel-redirect', '-no-live-chat', 'all'],
283 'Options that can help keep compatibility with youtube-dl or youtube-dlc '
284 'configurations by reverting some of the changes made in yt-dlp. '
285 'See "Differences in default behavior" for details'))
287 network
= optparse
.OptionGroup(parser
, 'Network Options')
289 '--proxy', dest
='proxy',
290 default
=None, metavar
='URL',
292 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable '
293 'SOCKS proxy, specify a proper scheme. For example '
294 'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") '
295 'for direct connection'))
298 dest
='socket_timeout', type=float, default
=None, metavar
='SECONDS',
299 help='Time to wait before giving up, in seconds')
302 metavar
='IP', dest
='source_address', default
=None,
303 help='Client-side IP address to bind to',
306 '-4', '--force-ipv4',
307 action
='store_const', const
='0.0.0.0', dest
='source_address',
308 help='Make all connections via IPv4',
311 '-6', '--force-ipv6',
312 action
='store_const', const
='::', dest
='source_address',
313 help='Make all connections via IPv6',
316 geo
= optparse
.OptionGroup(parser
, 'Geo-restriction')
318 '--geo-verification-proxy',
319 dest
='geo_verification_proxy', default
=None, metavar
='URL',
321 'Use this proxy to verify the IP address for some geo-restricted sites. '
322 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
324 '--cn-verification-proxy',
325 dest
='cn_verification_proxy', default
=None, metavar
='URL',
326 help=optparse
.SUPPRESS_HELP
)
329 action
='store_true', dest
='geo_bypass', default
=True,
330 help='Bypass geographic restriction via faking X-Forwarded-For HTTP header')
333 action
='store_false', dest
='geo_bypass', default
=True,
334 help='Do not bypass geographic restriction via faking X-Forwarded-For HTTP header')
336 '--geo-bypass-country', metavar
='CODE',
337 dest
='geo_bypass_country', default
=None,
338 help='Force bypass geographic restriction with explicitly provided two-letter ISO 3166-2 country code')
340 '--geo-bypass-ip-block', metavar
='IP_BLOCK',
341 dest
='geo_bypass_ip_block', default
=None,
342 help='Force bypass geographic restriction with explicitly provided IP block in CIDR notation')
344 selection
= optparse
.OptionGroup(parser
, 'Video Selection')
345 selection
.add_option(
347 dest
='playliststart', metavar
='NUMBER', default
=1, type=int,
348 help='Playlist video to start at (default is %default)')
349 selection
.add_option(
351 dest
='playlistend', metavar
='NUMBER', default
=None, type=int,
352 help='Playlist video to end at (default is last)')
353 selection
.add_option(
355 dest
='playlist_items', metavar
='ITEM_SPEC', default
=None,
356 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')
357 selection
.add_option(
359 dest
='matchtitle', metavar
='REGEX',
360 help=optparse
.SUPPRESS_HELP
)
361 selection
.add_option(
363 dest
='rejecttitle', metavar
='REGEX',
364 help=optparse
.SUPPRESS_HELP
)
365 selection
.add_option(
367 dest
='max_downloads', metavar
='NUMBER', type=int, default
=None,
368 help='Abort after downloading NUMBER files')
369 selection
.add_option(
371 metavar
='SIZE', dest
='min_filesize', default
=None,
372 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
373 selection
.add_option(
375 metavar
='SIZE', dest
='max_filesize', default
=None,
376 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
377 selection
.add_option(
379 metavar
='DATE', dest
='date', default
=None,
381 'Download only videos uploaded in this date. '
382 'The date can be "YYYYMMDD" or in the format '
383 '"(now|today)[+-][0-9](day|week|month|year)(s)?"'))
384 selection
.add_option(
386 metavar
='DATE', dest
='datebefore', default
=None,
388 'Download only videos uploaded on or before this date. '
389 'The date formats accepted is the same as --date'))
390 selection
.add_option(
392 metavar
='DATE', dest
='dateafter', default
=None,
394 'Download only videos uploaded on or after this date. '
395 'The date formats accepted is the same as --date'))
396 selection
.add_option(
398 metavar
='COUNT', dest
='min_views', default
=None, type=int,
399 help=optparse
.SUPPRESS_HELP
)
400 selection
.add_option(
402 metavar
='COUNT', dest
='max_views', default
=None, type=int,
403 help=optparse
.SUPPRESS_HELP
)
404 selection
.add_option(
406 metavar
='FILTER', dest
='match_filter', default
=None,
408 'Generic video filter. Any field (see "OUTPUT TEMPLATE") can be compared with a '
409 'number or a string using the operators defined in "Filtering formats". '
410 'You can also simply specify a field to match if the field is present '
411 'and "!field" to check if the field is not present. In addition, '
412 'Python style regular expression matching can be done using "~=", '
413 'and multiple filters can be checked with "&". '
414 'Use a "\\" to escape "&" or quotes if needed. Eg: --match-filter '
415 '"!is_live & like_count>?100 & description~=\'(?i)\\bcats \\& dogs\\b\'" '
416 'matches only videos that are not live, has a like count more than 100 '
417 '(or the like field is not available), and also has a description '
418 'that contains the phrase "cats & dogs" (ignoring case)'))
419 selection
.add_option(
421 metavar
='FILTER', dest
='match_filter', action
='store_const', const
=None,
422 help='Do not use generic video filter (default)')
423 selection
.add_option(
425 action
='store_true', dest
='noplaylist', default
=False,
426 help='Download only the video, if the URL refers to a video and a playlist')
427 selection
.add_option(
429 action
='store_false', dest
='noplaylist',
430 help='Download the playlist, if the URL refers to a video and a playlist')
431 selection
.add_option(
433 metavar
='YEARS', dest
='age_limit', default
=None, type=int,
434 help='Download only videos suitable for the given age')
435 selection
.add_option(
436 '--download-archive', metavar
='FILE',
437 dest
='download_archive',
438 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
439 selection
.add_option(
440 '--break-on-existing',
441 action
='store_true', dest
='break_on_existing', default
=False,
442 help='Stop the download process when encountering a file that is in the archive')
443 selection
.add_option(
445 action
='store_true', dest
='break_on_reject', default
=False,
446 help='Stop the download process when encountering a file that has been filtered out')
447 selection
.add_option(
448 '--skip-playlist-after-errors', metavar
='N',
449 dest
='skip_playlist_after_errors', default
=None, type=int,
450 help='Number of allowed failures until the rest of the playlist is skipped')
451 selection
.add_option(
452 '--no-download-archive',
453 dest
='download_archive', action
="store_const", const
=None,
454 help='Do not use archive file (default)')
455 selection
.add_option(
457 dest
='include_ads', action
='store_true',
458 help=optparse
.SUPPRESS_HELP
)
459 selection
.add_option(
461 dest
='include_ads', action
='store_false',
462 help=optparse
.SUPPRESS_HELP
)
464 authentication
= optparse
.OptionGroup(parser
, 'Authentication Options')
465 authentication
.add_option(
467 dest
='username', metavar
='USERNAME',
468 help='Login with this account ID')
469 authentication
.add_option(
471 dest
='password', metavar
='PASSWORD',
472 help='Account password. If this option is left out, yt-dlp will ask interactively')
473 authentication
.add_option(
475 dest
='twofactor', metavar
='TWOFACTOR',
476 help='Two-factor authentication code')
477 authentication
.add_option(
479 action
='store_true', dest
='usenetrc', default
=False,
480 help='Use .netrc authentication data')
481 authentication
.add_option(
483 dest
='netrc_location', metavar
='PATH',
484 help='Location of .netrc authentication data; either the path or its containing directory. Defaults to ~/.netrc')
485 authentication
.add_option(
487 dest
='videopassword', metavar
='PASSWORD',
488 help='Video password (vimeo, youku)')
489 authentication
.add_option(
491 dest
='ap_mso', metavar
='MSO',
492 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
493 authentication
.add_option(
495 dest
='ap_username', metavar
='USERNAME',
496 help='Multiple-system operator account login')
497 authentication
.add_option(
499 dest
='ap_password', metavar
='PASSWORD',
500 help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
501 authentication
.add_option(
503 action
='store_true', dest
='ap_list_mso', default
=False,
504 help='List all supported multiple-system operators')
506 video_format
= optparse
.OptionGroup(parser
, 'Video Format Options')
507 video_format
.add_option(
509 action
='store', dest
='format', metavar
='FORMAT', default
=None,
510 help='Video format code, see "FORMAT SELECTION" for more details')
511 video_format
.add_option(
512 '-S', '--format-sort', metavar
='SORTORDER',
513 dest
='format_sort', default
=[], type='str', action
='callback',
514 callback
=_list_from_options_callback
, callback_kwargs
={'append': -1}
,
515 help='Sort the formats by the fields given, see "Sorting Formats" for more details')
516 video_format
.add_option(
517 '--format-sort-force', '--S-force',
518 action
='store_true', dest
='format_sort_force', metavar
='FORMAT', default
=False,
520 'Force user specified sort order to have precedence over all fields, '
521 'see "Sorting Formats" for more details'))
522 video_format
.add_option(
523 '--no-format-sort-force',
524 action
='store_false', dest
='format_sort_force', metavar
='FORMAT', default
=False,
526 'Some fields have precedence over the user specified sort order (default), '
527 'see "Sorting Formats" for more details'))
528 video_format
.add_option(
529 '--video-multistreams',
530 action
='store_true', dest
='allow_multiple_video_streams', default
=None,
531 help='Allow multiple video streams to be merged into a single file')
532 video_format
.add_option(
533 '--no-video-multistreams',
534 action
='store_false', dest
='allow_multiple_video_streams',
535 help='Only one video stream is downloaded for each output file (default)')
536 video_format
.add_option(
537 '--audio-multistreams',
538 action
='store_true', dest
='allow_multiple_audio_streams', default
=None,
539 help='Allow multiple audio streams to be merged into a single file')
540 video_format
.add_option(
541 '--no-audio-multistreams',
542 action
='store_false', dest
='allow_multiple_audio_streams',
543 help='Only one audio stream is downloaded for each output file (default)')
544 video_format
.add_option(
546 action
='store_const', dest
='format', const
='all',
547 help=optparse
.SUPPRESS_HELP
)
548 video_format
.add_option(
549 '--prefer-free-formats',
550 action
='store_true', dest
='prefer_free_formats', default
=False,
552 'Prefer video formats with free containers over non-free ones of same quality. '
553 'Use with "-S ext" to strictly prefer free containers irrespective of quality'))
554 video_format
.add_option(
555 '--no-prefer-free-formats',
556 action
='store_false', dest
='prefer_free_formats', default
=False,
557 help="Don't give any special preference to free containers (default)")
558 video_format
.add_option(
560 action
='store_true', dest
='check_formats', default
=None,
561 help='Check that the formats selected are actually downloadable')
562 video_format
.add_option(
563 '--no-check-formats',
564 action
='store_false', dest
='check_formats',
565 help='Do not check that the formats selected are actually downloadable')
566 video_format
.add_option(
567 '-F', '--list-formats',
568 action
='store_true', dest
='listformats',
569 help='List available formats of each video. Simulate unless --no-simulate is used')
570 video_format
.add_option(
571 '--list-formats-as-table',
572 action
='store_true', dest
='listformats_table', default
=True,
573 help=optparse
.SUPPRESS_HELP
)
574 video_format
.add_option(
575 '--list-formats-old', '--no-list-formats-as-table',
576 action
='store_false', dest
='listformats_table',
577 help=optparse
.SUPPRESS_HELP
)
578 video_format
.add_option(
579 '--merge-output-format',
580 action
='store', dest
='merge_output_format', metavar
='FORMAT', default
=None,
582 'If a merge is required (e.g. bestvideo+bestaudio), '
583 'output to given container format. One of mkv, mp4, ogg, webm, flv. '
584 'Ignored if no merge is required'))
585 video_format
.add_option(
586 '--allow-unplayable-formats',
587 action
='store_true', dest
='allow_unplayable_formats', default
=False,
588 help=optparse
.SUPPRESS_HELP
)
589 video_format
.add_option(
590 '--no-allow-unplayable-formats',
591 action
='store_false', dest
='allow_unplayable_formats',
592 help=optparse
.SUPPRESS_HELP
)
594 subtitles
= optparse
.OptionGroup(parser
, 'Subtitle Options')
595 subtitles
.add_option(
596 '--write-subs', '--write-srt',
597 action
='store_true', dest
='writesubtitles', default
=False,
598 help='Write subtitle file')
599 subtitles
.add_option(
600 '--no-write-subs', '--no-write-srt',
601 action
='store_false', dest
='writesubtitles',
602 help='Do not write subtitle file (default)')
603 subtitles
.add_option(
604 '--write-auto-subs', '--write-automatic-subs',
605 action
='store_true', dest
='writeautomaticsub', default
=False,
606 help='Write automatically generated subtitle file (Alias: --write-automatic-subs)')
607 subtitles
.add_option(
608 '--no-write-auto-subs', '--no-write-automatic-subs',
609 action
='store_false', dest
='writeautomaticsub', default
=False,
610 help='Do not write auto-generated subtitles (default) (Alias: --no-write-automatic-subs)')
611 subtitles
.add_option(
613 action
='store_true', dest
='allsubtitles', default
=False,
614 help=optparse
.SUPPRESS_HELP
)
615 subtitles
.add_option(
617 action
='store_true', dest
='listsubtitles', default
=False,
618 help='List available subtitles of each video. Simulate unless --no-simulate is used')
619 subtitles
.add_option(
621 action
='store', dest
='subtitlesformat', metavar
='FORMAT', default
='best',
622 help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
623 subtitles
.add_option(
624 '--sub-langs', '--srt-langs',
625 action
='callback', dest
='subtitleslangs', metavar
='LANGS', type='str',
626 default
=[], callback
=_list_from_options_callback
,
628 'Languages of the subtitles to download (can be regex) or "all" separated by commas. (Eg: --sub-langs en.*,ja) '
629 'You can prefix the language code with a "-" to exempt it from the requested languages. (Eg: --sub-langs all,-live_chat) '
630 'Use --list-subs for a list of available language tags'))
632 downloader
= optparse
.OptionGroup(parser
, 'Download Options')
633 downloader
.add_option(
634 '-N', '--concurrent-fragments',
635 dest
='concurrent_fragment_downloads', metavar
='N', default
=1, type=int,
636 help='Number of fragments of a dash/hlsnative video that should be download concurrently (default is %default)')
637 downloader
.add_option(
638 '-r', '--limit-rate', '--rate-limit',
639 dest
='ratelimit', metavar
='RATE',
640 help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
641 downloader
.add_option(
643 dest
='throttledratelimit', metavar
='RATE',
644 help='Minimum download rate in bytes per second below which throttling is assumed and the video data is re-extracted (e.g. 100K)')
645 downloader
.add_option(
647 dest
='retries', metavar
='RETRIES', default
=10,
648 help='Number of retries (default is %default), or "infinite"')
649 downloader
.add_option(
650 '--fragment-retries',
651 dest
='fragment_retries', metavar
='RETRIES', default
=10,
652 help='Number of retries for a fragment (default is %default), or "infinite" (DASH, hlsnative and ISM)')
653 downloader
.add_option(
654 '--skip-unavailable-fragments', '--no-abort-on-unavailable-fragment',
655 action
='store_true', dest
='skip_unavailable_fragments', default
=True,
656 help='Skip unavailable fragments for DASH, hlsnative and ISM (default) (Alias: --no-abort-on-unavailable-fragment)')
657 downloader
.add_option(
658 '--abort-on-unavailable-fragment', '--no-skip-unavailable-fragments',
659 action
='store_false', dest
='skip_unavailable_fragments',
660 help='Abort downloading if a fragment is unavailable (Alias: --no-skip-unavailable-fragments)')
661 downloader
.add_option(
663 action
='store_true', dest
='keep_fragments', default
=False,
664 help='Keep downloaded fragments on disk after downloading is finished')
665 downloader
.add_option(
666 '--no-keep-fragments',
667 action
='store_false', dest
='keep_fragments',
668 help='Delete downloaded fragments after downloading is finished (default)')
669 downloader
.add_option(
671 dest
='buffersize', metavar
='SIZE', default
='1024',
672 help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
673 downloader
.add_option(
675 action
='store_false', dest
='noresizebuffer',
676 help='The buffer size is automatically resized from an initial value of --buffer-size (default)')
677 downloader
.add_option(
678 '--no-resize-buffer',
679 action
='store_true', dest
='noresizebuffer', default
=False,
680 help='Do not automatically adjust the buffer size')
681 downloader
.add_option(
683 dest
='http_chunk_size', metavar
='SIZE', default
=None,
685 'Size of a chunk for chunk-based HTTP downloading (e.g. 10485760 or 10M) (default is disabled). '
686 'May be useful for bypassing bandwidth throttling imposed by a webserver (experimental)'))
687 downloader
.add_option(
689 action
='store_true', dest
='test', default
=False,
690 help=optparse
.SUPPRESS_HELP
)
691 downloader
.add_option(
692 '--playlist-reverse',
694 help='Download playlist videos in reverse order')
695 downloader
.add_option(
696 '--no-playlist-reverse',
697 action
='store_false', dest
='playlist_reverse',
698 help='Download playlist videos in default order (default)')
699 downloader
.add_option(
702 help='Download playlist videos in random order')
703 downloader
.add_option(
704 '--xattr-set-filesize',
705 dest
='xattr_set_filesize', action
='store_true',
706 help='Set file xattribute ytdl.filesize with expected file size')
707 downloader
.add_option(
708 '--hls-prefer-native',
709 dest
='hls_prefer_native', action
='store_true', default
=None,
710 help=optparse
.SUPPRESS_HELP
)
711 downloader
.add_option(
712 '--hls-prefer-ffmpeg',
713 dest
='hls_prefer_native', action
='store_false', default
=None,
714 help=optparse
.SUPPRESS_HELP
)
715 downloader
.add_option(
717 dest
='hls_use_mpegts', action
='store_true', default
=None,
719 'Use the mpegts container for HLS videos; '
720 'allowing some players to play the video while downloading, '
721 'and reducing the chance of file corruption if download is interrupted. '
722 'This is enabled by default for live streams'))
723 downloader
.add_option(
724 '--no-hls-use-mpegts',
725 dest
='hls_use_mpegts', action
='store_false',
727 'Do not use the mpegts container for HLS videos. '
728 'This is default when not downloading live streams'))
729 downloader
.add_option(
730 '--downloader', '--external-downloader',
731 dest
='external_downloader', metavar
='[PROTO:]NAME', default
={}, type='str',
732 action
='callback', callback
=_dict_from_options_callback
,
734 'allowed_keys': 'http|ftp|m3u8|dash|rtsp|rtmp|mms',
735 'default_key': 'default',
738 'Name or path of the external downloader to use (optionally) prefixed by '
739 'the protocols (http, ftp, m3u8, dash, rstp, rtmp, mms) to use it for. '
740 'Currently supports native, %s (Recommended: aria2c). '
741 'You can use this option multiple times to set different downloaders for different protocols. '
742 'For example, --downloader aria2c --downloader "dash,m3u8:native" will use '
743 'aria2c for http/ftp downloads, and the native downloader for dash/m3u8 downloads '
744 '(Alias: --external-downloader)' % ', '.join(list_external_downloaders())))
745 downloader
.add_option(
746 '--downloader-args', '--external-downloader-args',
747 metavar
='NAME:ARGS', dest
='external_downloader_args', default
={}, type='str',
748 action
='callback', callback
=_dict_from_options_callback
,
750 'allowed_keys': r
'ffmpeg_[io]\d*|%s' % '|'.join(list_external_downloaders()),
751 'default_key': 'default',
752 'process': compat_shlex_split
754 'Give these arguments to the external downloader. '
755 'Specify the downloader name and the arguments separated by a colon ":". '
756 'For ffmpeg, arguments can be passed to different positions using the same syntax as --postprocessor-args. '
757 'You can use this option multiple times to give different arguments to different downloaders '
758 '(Alias: --external-downloader-args)'))
760 workarounds
= optparse
.OptionGroup(parser
, 'Workarounds')
761 workarounds
.add_option(
763 dest
='encoding', metavar
='ENCODING',
764 help='Force the specified encoding (experimental)')
765 workarounds
.add_option(
766 '--no-check-certificate',
767 action
='store_true', dest
='no_check_certificate', default
=False,
768 help='Suppress HTTPS certificate validation')
769 workarounds
.add_option(
770 '--prefer-insecure', '--prefer-unsecure',
771 action
='store_true', dest
='prefer_insecure',
772 help='Use an unencrypted connection to retrieve information about the video (Currently supported only for YouTube)')
773 workarounds
.add_option(
775 metavar
='UA', dest
='user_agent',
776 help='Specify a custom user agent')
777 workarounds
.add_option(
779 metavar
='URL', dest
='referer', default
=None,
780 help='Specify a custom referer, use if the video access is restricted to one domain',
782 workarounds
.add_option(
784 metavar
='FIELD:VALUE', dest
='headers', default
={}, type='str',
785 action
='callback', callback
=_dict_from_options_callback
,
786 callback_kwargs
={'multiple_keys': False}
,
787 help='Specify a custom HTTP header and its value, separated by a colon ":". You can use this option multiple times',
789 workarounds
.add_option(
791 dest
='bidi_workaround', action
='store_true',
792 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
793 workarounds
.add_option(
794 '--sleep-requests', metavar
='SECONDS',
795 dest
='sleep_interval_requests', type=float,
796 help='Number of seconds to sleep between requests during data extraction')
797 workarounds
.add_option(
798 '--sleep-interval', '--min-sleep-interval', metavar
='SECONDS',
799 dest
='sleep_interval', type=float,
801 'Number of seconds to sleep before each download. '
802 'This is the minimum time to sleep when used along with --max-sleep-interval '
803 '(Alias: --min-sleep-interval)'))
804 workarounds
.add_option(
805 '--max-sleep-interval', metavar
='SECONDS',
806 dest
='max_sleep_interval', type=float,
807 help='Maximum number of seconds to sleep. Can only be used along with --min-sleep-interval')
808 workarounds
.add_option(
809 '--sleep-subtitles', metavar
='SECONDS',
810 dest
='sleep_interval_subtitles', default
=0, type=int,
811 help='Number of seconds to sleep before each subtitle download')
813 verbosity
= optparse
.OptionGroup(parser
, 'Verbosity and Simulation Options')
814 verbosity
.add_option(
816 action
='store_true', dest
='quiet', default
=False,
817 help='Activate quiet mode. If used with --verbose, print the log to stderr')
818 verbosity
.add_option(
820 dest
='no_warnings', action
='store_true', default
=False,
821 help='Ignore warnings')
822 verbosity
.add_option(
824 action
='store_true', dest
='simulate', default
=None,
825 help='Do not download the video and do not write anything to disk')
826 verbosity
.add_option(
828 action
='store_false', dest
='simulate',
829 help='Download the video even if printing/listing options are used')
830 verbosity
.add_option(
831 '--ignore-no-formats-error',
832 action
='store_true', dest
='ignore_no_formats_error', default
=False,
834 'Ignore "No video formats" error. Usefull for extracting metadata '
835 'even if the videos are not actually available for download (experimental)'))
836 verbosity
.add_option(
837 '--no-ignore-no-formats-error',
838 action
='store_false', dest
='ignore_no_formats_error',
839 help='Throw error when no downloadable video formats are found (default)')
840 verbosity
.add_option(
841 '--skip-download', '--no-download',
842 action
='store_true', dest
='skip_download', default
=False,
843 help='Do not download the video but write all related files (Alias: --no-download)')
844 verbosity
.add_option(
846 metavar
='TEMPLATE', action
='append', dest
='forceprint',
848 'Quiet, but print the given fields for each video. Simulate unless --no-simulate is used. '
849 'Either a field name or same syntax as the output template can be used'))
850 verbosity
.add_option(
852 action
='store_true', dest
='geturl', default
=False,
853 help=optparse
.SUPPRESS_HELP
)
854 verbosity
.add_option(
856 action
='store_true', dest
='gettitle', default
=False,
857 help=optparse
.SUPPRESS_HELP
)
858 verbosity
.add_option(
860 action
='store_true', dest
='getid', default
=False,
861 help=optparse
.SUPPRESS_HELP
)
862 verbosity
.add_option(
864 action
='store_true', dest
='getthumbnail', default
=False,
865 help=optparse
.SUPPRESS_HELP
)
866 verbosity
.add_option(
868 action
='store_true', dest
='getdescription', default
=False,
869 help=optparse
.SUPPRESS_HELP
)
870 verbosity
.add_option(
872 action
='store_true', dest
='getduration', default
=False,
873 help=optparse
.SUPPRESS_HELP
)
874 verbosity
.add_option(
876 action
='store_true', dest
='getfilename', default
=False,
877 help=optparse
.SUPPRESS_HELP
)
878 verbosity
.add_option(
880 action
='store_true', dest
='getformat', default
=False,
881 help=optparse
.SUPPRESS_HELP
)
882 verbosity
.add_option(
884 action
='store_true', dest
='dumpjson', default
=False,
885 help='Quiet, but print JSON information for each video. Simulate unless --no-simulate is used. See "OUTPUT TEMPLATE" for a description of available keys')
886 verbosity
.add_option(
887 '-J', '--dump-single-json',
888 action
='store_true', dest
='dump_single_json', default
=False,
890 'Quiet, but print JSON information for each url or infojson passed. Simulate unless --no-simulate is used. '
891 'If the URL refers to a playlist, the whole playlist information is dumped in a single line'))
892 verbosity
.add_option(
894 action
='store_true', dest
='print_json', default
=False,
895 help=optparse
.SUPPRESS_HELP
)
896 verbosity
.add_option(
897 '--force-write-archive', '--force-write-download-archive', '--force-download-archive',
898 action
='store_true', dest
='force_write_download_archive', default
=False,
900 'Force download archive entries to be written as far as no errors occur, '
901 'even if -s or another simulation option is used (Alias: --force-download-archive)'))
902 verbosity
.add_option(
904 action
='store_true', dest
='progress_with_newline', default
=False,
905 help='Output progress bar as new lines')
906 verbosity
.add_option(
908 action
='store_true', dest
='noprogress', default
=False,
909 help='Do not print progress bar')
910 verbosity
.add_option(
912 action
='store_true', dest
='consoletitle', default
=False,
913 help='Display progress in console titlebar')
914 verbosity
.add_option(
916 action
='store_true', dest
='verbose', default
=False,
917 help='Print various debugging information')
918 verbosity
.add_option(
919 '--dump-pages', '--dump-intermediate-pages',
920 action
='store_true', dest
='dump_intermediate_pages', default
=False,
921 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
922 verbosity
.add_option(
924 action
='store_true', dest
='write_pages', default
=False,
925 help='Write downloaded intermediary pages to files in the current directory to debug problems')
926 verbosity
.add_option(
927 '--youtube-print-sig-code',
928 action
='store_true', dest
='youtube_print_sig_code', default
=False,
929 help=optparse
.SUPPRESS_HELP
)
930 verbosity
.add_option(
931 '--print-traffic', '--dump-headers',
932 dest
='debug_printtraffic', action
='store_true', default
=False,
933 help='Display sent and read HTTP traffic')
934 verbosity
.add_option(
936 dest
='call_home', action
='store_true', default
=False,
937 # help='[Broken] Contact the yt-dlp server for debugging')
938 help=optparse
.SUPPRESS_HELP
)
939 verbosity
.add_option(
941 dest
='call_home', action
='store_false',
942 # help='Do not contact the yt-dlp server for debugging (default)')
943 help=optparse
.SUPPRESS_HELP
)
945 filesystem
= optparse
.OptionGroup(parser
, 'Filesystem Options')
946 filesystem
.add_option(
947 '-a', '--batch-file',
948 dest
='batchfile', metavar
='FILE',
949 help="File containing URLs to download ('-' for stdin), one URL per line. "
950 "Lines starting with '#', ';' or ']' are considered as comments and ignored")
951 filesystem
.add_option(
952 '--id', default
=False,
953 action
='store_true', dest
='useid', help=optparse
.SUPPRESS_HELP
)
954 filesystem
.add_option(
956 metavar
='[TYPES:]PATH', dest
='paths', default
={}, type='str',
957 action
='callback', callback
=_dict_from_options_callback
,
959 'allowed_keys': 'home|temp|%s' % '|'.join(OUTTMPL_TYPES
.keys()),
960 'default_key': 'home'
962 'The paths where the files should be downloaded. '
963 'Specify the type of file and the path separated by a colon ":". '
964 'All the same types as --output are supported. '
965 'Additionally, you can also provide "home" (default) and "temp" paths. '
966 'All intermediary files are first downloaded to the temp path and '
967 'then the final files are moved over to the home path after download is finished. '
968 'This option is ignored if --output is an absolute path'))
969 filesystem
.add_option(
971 metavar
='[TYPES:]TEMPLATE', dest
='outtmpl', default
={}, type='str',
972 action
='callback', callback
=_dict_from_options_callback
,
974 'allowed_keys': '|'.join(OUTTMPL_TYPES
.keys()),
975 'default_key': 'default'
976 }, help='Output filename template; see "OUTPUT TEMPLATE" for details')
977 filesystem
.add_option(
978 '--output-na-placeholder',
979 dest
='outtmpl_na_placeholder', metavar
='TEXT', default
='NA',
980 help=('Placeholder value for unavailable meta fields in output filename template (default: "%default")'))
981 filesystem
.add_option(
983 dest
='autonumber_size', metavar
='NUMBER', type=int,
984 help=optparse
.SUPPRESS_HELP
)
985 filesystem
.add_option(
986 '--autonumber-start',
987 dest
='autonumber_start', metavar
='NUMBER', default
=1, type=int,
988 help=optparse
.SUPPRESS_HELP
)
989 filesystem
.add_option(
990 '--restrict-filenames',
991 action
='store_true', dest
='restrictfilenames', default
=False,
992 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
993 filesystem
.add_option(
994 '--no-restrict-filenames',
995 action
='store_false', dest
='restrictfilenames',
996 help='Allow Unicode characters, "&" and spaces in filenames (default)')
997 filesystem
.add_option(
998 '--windows-filenames',
999 action
='store_true', dest
='windowsfilenames', default
=False,
1000 help='Force filenames to be windows compatible')
1001 filesystem
.add_option(
1002 '--no-windows-filenames',
1003 action
='store_false', dest
='windowsfilenames',
1004 help='Make filenames windows compatible only if using windows (default)')
1005 filesystem
.add_option(
1006 '--trim-filenames', '--trim-file-names', metavar
='LENGTH',
1007 dest
='trim_file_name', default
=0, type=int,
1008 help='Limit the filename length (excluding extension) to the specified number of characters')
1009 filesystem
.add_option(
1011 action
='store_true', dest
='autonumber', default
=False,
1012 help=optparse
.SUPPRESS_HELP
)
1013 filesystem
.add_option(
1015 action
='store_true', dest
='usetitle', default
=False,
1016 help=optparse
.SUPPRESS_HELP
)
1017 filesystem
.add_option(
1018 '--literal', default
=False,
1019 action
='store_true', dest
='usetitle',
1020 help=optparse
.SUPPRESS_HELP
)
1021 filesystem
.add_option(
1022 '-w', '--no-overwrites',
1023 action
='store_false', dest
='overwrites', default
=None,
1024 help='Do not overwrite any files')
1025 filesystem
.add_option(
1026 '--force-overwrites', '--yes-overwrites',
1027 action
='store_true', dest
='overwrites',
1028 help='Overwrite all video and metadata files. This option includes --no-continue')
1029 filesystem
.add_option(
1030 '--no-force-overwrites',
1031 action
='store_const', dest
='overwrites', const
=None,
1032 help='Do not overwrite the video, but overwrite related files (default)')
1033 filesystem
.add_option(
1035 action
='store_true', dest
='continue_dl', default
=True,
1036 help='Resume partially downloaded files/fragments (default)')
1037 filesystem
.add_option(
1039 action
='store_false', dest
='continue_dl',
1041 'Do not resume partially downloaded fragments. '
1042 'If the file is not fragmented, restart download of the entire file'))
1043 filesystem
.add_option(
1045 action
='store_false', dest
='nopart', default
=False,
1046 help='Use .part files instead of writing directly into output file (default)')
1047 filesystem
.add_option(
1049 action
='store_true', dest
='nopart',
1050 help='Do not use .part files - write directly into output file')
1051 filesystem
.add_option(
1053 action
='store_true', dest
='updatetime', default
=True,
1054 help='Use the Last-modified header to set the file modification time (default)')
1055 filesystem
.add_option(
1057 action
='store_false', dest
='updatetime',
1058 help='Do not use the Last-modified header to set the file modification time')
1059 filesystem
.add_option(
1060 '--write-description',
1061 action
='store_true', dest
='writedescription', default
=False,
1062 help='Write video description to a .description file')
1063 filesystem
.add_option(
1064 '--no-write-description',
1065 action
='store_false', dest
='writedescription',
1066 help='Do not write video description (default)')
1067 filesystem
.add_option(
1068 '--write-info-json',
1069 action
='store_true', dest
='writeinfojson', default
=False,
1070 help='Write video metadata to a .info.json file (this may contain personal information)')
1071 filesystem
.add_option(
1072 '--no-write-info-json',
1073 action
='store_false', dest
='writeinfojson',
1074 help='Do not write video metadata (default)')
1075 filesystem
.add_option(
1076 '--write-annotations',
1077 action
='store_true', dest
='writeannotations', default
=False,
1078 help=optparse
.SUPPRESS_HELP
)
1079 filesystem
.add_option(
1080 '--no-write-annotations',
1081 action
='store_false', dest
='writeannotations',
1082 help=optparse
.SUPPRESS_HELP
)
1083 filesystem
.add_option(
1084 '--write-playlist-metafiles',
1085 action
='store_true', dest
='allow_playlist_files', default
=None,
1087 'Write playlist metadata in addition to the video metadata '
1088 'when using --write-info-json, --write-description etc. (default)'))
1089 filesystem
.add_option(
1090 '--no-write-playlist-metafiles',
1091 action
='store_false', dest
='allow_playlist_files',
1092 help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
1093 filesystem
.add_option(
1095 action
='store_true', dest
='clean_infojson', default
=None,
1097 'Remove some private fields such as filenames from the infojson. '
1098 'Note that it could still contain some personal information (default)'))
1099 filesystem
.add_option(
1100 '--no-clean-infojson',
1101 action
='store_false', dest
='clean_infojson',
1102 help='Write all fields to the infojson')
1103 filesystem
.add_option(
1104 '--write-comments', '--get-comments',
1105 action
='store_true', dest
='getcomments', default
=False,
1107 'Retrieve video comments to be placed in the infojson. '
1108 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)'))
1109 filesystem
.add_option(
1110 '--no-write-comments', '--no-get-comments',
1111 action
='store_false', dest
='getcomments',
1112 help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)')
1113 filesystem
.add_option(
1114 '--load-info-json', '--load-info',
1115 dest
='load_info_filename', metavar
='FILE',
1116 help='JSON file containing the video information (created with the "--write-info-json" option)')
1117 filesystem
.add_option(
1119 dest
='cookiefile', metavar
='FILE',
1120 help='File to read cookies from and dump cookie jar in')
1121 filesystem
.add_option(
1123 action
='store_const', const
=None, dest
='cookiefile', metavar
='FILE',
1124 help='Do not read/dump cookies from/to file (default)')
1125 filesystem
.add_option(
1126 '--cookies-from-browser',
1127 dest
='cookiesfrombrowser', metavar
='BROWSER[:PROFILE]',
1129 'Load cookies from a user profile of the given web browser. '
1130 'Currently supported browsers are: {}. '
1131 'You can specify the user profile name or directory using '
1132 '"BROWSER:PROFILE_NAME" or "BROWSER:PROFILE_PATH". '
1133 'If no profile is given, the most recently accessed one is used'.format(
1134 ', '.join(sorted(SUPPORTED_BROWSERS
)))))
1135 filesystem
.add_option(
1136 '--no-cookies-from-browser',
1137 action
='store_const', const
=None, dest
='cookiesfrombrowser',
1138 help='Do not load cookies from browser (default)')
1139 filesystem
.add_option(
1140 '--cache-dir', dest
='cachedir', default
=None, metavar
='DIR',
1141 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')
1142 filesystem
.add_option(
1143 '--no-cache-dir', action
='store_false', dest
='cachedir',
1144 help='Disable filesystem caching')
1145 filesystem
.add_option(
1147 action
='store_true', dest
='rm_cachedir',
1148 help='Delete all filesystem cache files')
1150 thumbnail
= optparse
.OptionGroup(parser
, 'Thumbnail Options')
1151 thumbnail
.add_option(
1152 '--write-thumbnail',
1153 action
='store_true', dest
='writethumbnail', default
=False,
1154 help='Write thumbnail image to disk')
1155 thumbnail
.add_option(
1156 '--no-write-thumbnail',
1157 action
='store_false', dest
='writethumbnail',
1158 help='Do not write thumbnail image to disk (default)')
1159 thumbnail
.add_option(
1160 '--write-all-thumbnails',
1161 action
='store_true', dest
='write_all_thumbnails', default
=False,
1162 help='Write all thumbnail image formats to disk')
1163 thumbnail
.add_option(
1164 '--list-thumbnails',
1165 action
='store_true', dest
='list_thumbnails', default
=False,
1166 help='List available thumbnails of each video. Simulate unless --no-simulate is used')
1168 link
= optparse
.OptionGroup(parser
, 'Internet Shortcut Options')
1171 action
='store_true', dest
='writelink', default
=False,
1172 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1175 action
='store_true', dest
='writeurllink', default
=False,
1176 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1178 '--write-webloc-link',
1179 action
='store_true', dest
='writewebloclink', default
=False,
1180 help='Write a .webloc macOS internet shortcut')
1182 '--write-desktop-link',
1183 action
='store_true', dest
='writedesktoplink', default
=False,
1184 help='Write a .desktop Linux internet shortcut')
1186 postproc
= optparse
.OptionGroup(parser
, 'Post-Processing Options')
1187 postproc
.add_option(
1188 '-x', '--extract-audio',
1189 action
='store_true', dest
='extractaudio', default
=False,
1190 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1191 postproc
.add_option(
1192 '--audio-format', metavar
='FORMAT', dest
='audioformat', default
='best',
1194 'Specify audio format to convert the audio to when -x is used. Currently supported formats are: '
1195 'best (default) or one of %s' % '|'.join(FFmpegExtractAudioPP
.SUPPORTED_EXTS
)))
1196 postproc
.add_option(
1197 '--audio-quality', metavar
='QUALITY',
1198 dest
='audioquality', default
='5',
1199 help='Specify ffmpeg audio quality, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default %default)')
1200 postproc
.add_option(
1202 metavar
='FORMAT', dest
='remuxvideo', default
=None,
1204 'Remux the video into another container if necessary (currently supported: %s). '
1205 'If target container does not support the video/audio codec, remuxing will fail. '
1206 'You can specify multiple rules; Eg. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 '
1207 'and anything else to mkv.' % '|'.join(FFmpegVideoRemuxerPP
.SUPPORTED_EXTS
)))
1208 postproc
.add_option(
1210 metavar
='FORMAT', dest
='recodevideo', default
=None,
1212 'Re-encode the video into another format if re-encoding is necessary. '
1213 'The syntax and supported formats are the same as --remux-video'))
1214 postproc
.add_option(
1215 '--postprocessor-args', '--ppa',
1216 metavar
='NAME:ARGS', dest
='postprocessor_args', default
={}, type='str',
1217 action
='callback', callback
=_dict_from_options_callback
,
1219 'allowed_keys': r
'\w+(?:\+\w+)?', 'default_key': 'default-compat',
1220 'process': compat_shlex_split
,
1221 'multiple_keys': False
1223 'Give these arguments to the postprocessors. '
1224 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1225 'to give the argument to the specified postprocessor/executable. Supported PP are: '
1226 'Merger, ModifyChapters, SplitChapters, ExtractAudio, VideoRemuxer, VideoConvertor, '
1227 'Metadata, EmbedSubtitle, EmbedThumbnail, SubtitlesConvertor, ThumbnailsConvertor, '
1228 'FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. '
1229 'The supported executables are: AtomicParsley, FFmpeg and FFprobe. '
1230 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1231 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
1232 '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
1233 'before the specified input/output file. Eg: --ppa "Merger+ffmpeg_i1:-v quiet". '
1234 'You can use this option multiple times to give different arguments to different '
1235 'postprocessors. (Alias: --ppa)'))
1236 postproc
.add_option(
1237 '-k', '--keep-video',
1238 action
='store_true', dest
='keepvideo', default
=False,
1239 help='Keep the intermediate video file on disk after post-processing')
1240 postproc
.add_option(
1242 action
='store_false', dest
='keepvideo',
1243 help='Delete the intermediate video file after post-processing (default)')
1244 postproc
.add_option(
1245 '--post-overwrites',
1246 action
='store_false', dest
='nopostoverwrites',
1247 help='Overwrite post-processed files (default)')
1248 postproc
.add_option(
1249 '--no-post-overwrites',
1250 action
='store_true', dest
='nopostoverwrites', default
=False,
1251 help='Do not overwrite post-processed files')
1252 postproc
.add_option(
1254 action
='store_true', dest
='embedsubtitles', default
=False,
1255 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1256 postproc
.add_option(
1258 action
='store_false', dest
='embedsubtitles',
1259 help='Do not embed subtitles (default)')
1260 postproc
.add_option(
1261 '--embed-thumbnail',
1262 action
='store_true', dest
='embedthumbnail', default
=False,
1263 help='Embed thumbnail in the video as cover art')
1264 postproc
.add_option(
1265 '--no-embed-thumbnail',
1266 action
='store_false', dest
='embedthumbnail',
1267 help='Do not embed thumbnail (default)')
1268 postproc
.add_option(
1269 '--embed-metadata', '--add-metadata',
1270 action
='store_true', dest
='addmetadata', default
=False,
1271 help='Embed metadata to the video file. Also adds chapters to file unless --no-add-chapters is used (Alias: --add-metadata)')
1272 postproc
.add_option(
1273 '--no-embed-metadata', '--no-add-metadata',
1274 action
='store_false', dest
='addmetadata',
1275 help='Do not add metadata to file (default) (Alias: --no-add-metadata)')
1276 postproc
.add_option(
1277 '--embed-chapters', '--add-chapters',
1278 action
='store_true', dest
='addchapters', default
=None,
1279 help='Add chapter markers to the video file (Alias: --add-chapters)')
1280 postproc
.add_option(
1281 '--no-embed-chapters', '--no-add-chapters',
1282 action
='store_false', dest
='addchapters',
1283 help='Do not add chapter markers (default) (Alias: --no-add-chapters)')
1284 postproc
.add_option(
1285 '--metadata-from-title',
1286 metavar
='FORMAT', dest
='metafromtitle',
1287 help=optparse
.SUPPRESS_HELP
)
1288 postproc
.add_option(
1290 metavar
='FROM:TO', dest
='parse_metadata', action
='append',
1292 'Parse additional metadata like title/artist from other fields; '
1293 'see "MODIFYING METADATA" for details'))
1294 postproc
.add_option(
1295 '--replace-in-metadata',
1296 dest
='parse_metadata', metavar
='FIELDS REGEX REPLACE', action
='append', nargs
=3,
1297 help='Replace text in a metadata field using the given regex. This option can be used multiple times')
1298 postproc
.add_option(
1300 action
='store_true', dest
='xattrs', default
=False,
1301 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
1302 postproc
.add_option(
1304 metavar
='POLICY', dest
='fixup', default
=None,
1305 choices
=('never', 'ignore', 'warn', 'detect_or_warn', 'force'),
1307 'Automatically correct known faults of the file. '
1308 'One of never (do nothing), warn (only emit a warning), '
1309 'detect_or_warn (the default; fix file if we can, warn otherwise), '
1310 'force (try fixing even if file already exists'))
1311 postproc
.add_option(
1312 '--prefer-avconv', '--no-prefer-ffmpeg',
1313 action
='store_false', dest
='prefer_ffmpeg',
1314 help=optparse
.SUPPRESS_HELP
)
1315 postproc
.add_option(
1316 '--prefer-ffmpeg', '--no-prefer-avconv',
1317 action
='store_true', dest
='prefer_ffmpeg', default
=True,
1318 help=optparse
.SUPPRESS_HELP
)
1319 postproc
.add_option(
1320 '--ffmpeg-location', '--avconv-location', metavar
='PATH',
1321 dest
='ffmpeg_location',
1322 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1323 postproc
.add_option(
1324 '--exec', metavar
='CMD',
1325 action
='append', dest
='exec_cmd',
1327 'Execute a command on the file after downloading and post-processing. '
1328 'Same syntax as the output template can be used to pass any field as arguments to the command. '
1329 'An additional field "filepath" that contains the final path of the downloaded file is also available. '
1330 'If no fields are passed, %(filepath)q is appended to the end of the command. '
1331 'This option can be used multiple times'))
1332 postproc
.add_option(
1334 action
='store_const', dest
='exec_cmd', const
=[],
1335 help='Remove any previously defined --exec')
1336 postproc
.add_option(
1337 '--exec-before-download', metavar
='CMD',
1338 action
='append', dest
='exec_before_dl_cmd',
1340 'Execute a command before the actual download. '
1341 'The syntax is the same as --exec but "filepath" is not available. '
1342 'This option can be used multiple times'))
1343 postproc
.add_option(
1344 '--no-exec-before-download',
1345 action
='store_const', dest
='exec_before_dl_cmd', const
=[],
1346 help='Remove any previously defined --exec-before-download')
1347 postproc
.add_option(
1348 '--convert-subs', '--convert-sub', '--convert-subtitles',
1349 metavar
='FORMAT', dest
='convertsubtitles', default
=None,
1351 'Convert the subtitles to another format (currently supported: %s) '
1352 '(Alias: --convert-subtitles)' % '|'.join(FFmpegSubtitlesConvertorPP
.SUPPORTED_EXTS
)))
1353 postproc
.add_option(
1354 '--convert-thumbnails',
1355 metavar
='FORMAT', dest
='convertthumbnails', default
=None,
1357 'Convert the thumbnails to another format '
1358 '(currently supported: %s) ' % '|'.join(FFmpegThumbnailsConvertorPP
.SUPPORTED_EXTS
)))
1359 postproc
.add_option(
1360 '--split-chapters', '--split-tracks',
1361 dest
='split_chapters', action
='store_true', default
=False,
1363 'Split video into multiple files based on internal chapters. '
1364 'The "chapter:" prefix can be used with "--paths" and "--output" to '
1365 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1366 postproc
.add_option(
1367 '--no-split-chapters', '--no-split-tracks',
1368 dest
='split_chapters', action
='store_false',
1369 help='Do not split video based on chapters (default)')
1370 postproc
.add_option(
1371 '--remove-chapters',
1372 metavar
='REGEX', dest
='remove_chapters', action
='append',
1373 help='Remove chapters whose title matches the given regular expression. This option can be used multiple times')
1374 postproc
.add_option(
1375 '--no-remove-chapters', dest
='remove_chapters', action
='store_const', const
=None,
1376 help='Do not remove any chapters from the file (default)')
1377 postproc
.add_option(
1378 '--force-keyframes-at-cuts',
1379 action
='store_true', dest
='force_keyframes_at_cuts', default
=False,
1381 'Force keyframes around the chapters before removing/splitting them. '
1382 'Requires a reencode and thus is very slow, but the resulting video '
1383 'may have fewer artifacts around the cuts'))
1384 postproc
.add_option(
1385 '--no-force-keyframes-at-cuts',
1386 action
='store_false', dest
='force_keyframes_at_cuts',
1387 help='Do not force keyframes around the chapters when cutting/splitting (default)')
1389 sponsorblock
= optparse
.OptionGroup(parser
, 'SponsorBlock Options', description
=(
1390 'Make chapter entries for, or remove various segments (sponsor, introductions, etc.) '
1391 'from downloaded YouTube videos using the SponsorBlock API (https://sponsor.ajay.app)'))
1392 sponsorblock
.add_option(
1393 '--sponsorblock-mark', metavar
='CATS',
1394 dest
='sponsorblock_mark', default
=set(), action
='callback', type='str',
1395 callback
=_set_from_options_callback
, callback_kwargs
={'allowed_values': SponsorBlockPP.CATEGORIES.keys()}
,
1397 'SponsorBlock categories to create chapters for, separated by commas. '
1398 'Available categories are all, %s. You can prefix the category with a "-" to exempt it. '
1399 'See https://wiki.sponsor.ajay.app/index.php/Segment_Categories for description of the categories. '
1400 'Eg: --sponsorblock-mark all,-preview' % ', '.join(SponsorBlockPP
.CATEGORIES
.keys())))
1401 sponsorblock
.add_option(
1402 '--sponsorblock-remove', metavar
='CATS',
1403 dest
='sponsorblock_remove', default
=set(), action
='callback', type='str',
1404 callback
=_set_from_options_callback
, callback_kwargs
={'allowed_values': SponsorBlockPP.CATEGORIES.keys()}
,
1406 'SponsorBlock categories to be removed from the video file, separated by commas. '
1407 'If a category is present in both mark and remove, remove takes precedence. '
1408 'The syntax and available categories are the same as for --sponsorblock-mark'))
1409 sponsorblock
.add_option(
1410 '--sponsorblock-chapter-title', metavar
='TEMPLATE',
1411 default
=DEFAULT_SPONSORBLOCK_CHAPTER_TITLE
, dest
='sponsorblock_chapter_title',
1413 'The title template for SponsorBlock chapters created by --sponsorblock-mark. '
1414 'The same syntax as the output template is used, but the only available fields are '
1415 'start_time, end_time, category, categories, name, category_names. Defaults to "%default"'))
1416 sponsorblock
.add_option(
1417 '--no-sponsorblock', default
=False,
1418 action
='store_true', dest
='no_sponsorblock',
1419 help='Disable both --sponsorblock-mark and --sponsorblock-remove')
1420 sponsorblock
.add_option(
1421 '--sponsorblock-api', metavar
='URL',
1422 default
='https://sponsor.ajay.app', dest
='sponsorblock_api',
1423 help='SponsorBlock API location, defaults to %default')
1425 sponsorblock
.add_option(
1427 action
='store_true', dest
='sponskrub', default
=False,
1428 help=optparse
.SUPPRESS_HELP
)
1429 sponsorblock
.add_option(
1431 action
='store_false', dest
='sponskrub',
1432 help=optparse
.SUPPRESS_HELP
)
1433 sponsorblock
.add_option(
1434 '--sponskrub-cut', default
=False,
1435 action
='store_true', dest
='sponskrub_cut',
1436 help=optparse
.SUPPRESS_HELP
)
1437 sponsorblock
.add_option(
1438 '--no-sponskrub-cut',
1439 action
='store_false', dest
='sponskrub_cut',
1440 help=optparse
.SUPPRESS_HELP
)
1441 sponsorblock
.add_option(
1442 '--sponskrub-force', default
=False,
1443 action
='store_true', dest
='sponskrub_force',
1444 help=optparse
.SUPPRESS_HELP
)
1445 sponsorblock
.add_option(
1446 '--no-sponskrub-force',
1447 action
='store_true', dest
='sponskrub_force',
1448 help=optparse
.SUPPRESS_HELP
)
1449 sponsorblock
.add_option(
1450 '--sponskrub-location', metavar
='PATH',
1451 dest
='sponskrub_path', default
='',
1452 help=optparse
.SUPPRESS_HELP
)
1453 sponsorblock
.add_option(
1454 '--sponskrub-args', dest
='sponskrub_args', metavar
='ARGS',
1455 help=optparse
.SUPPRESS_HELP
)
1457 extractor
= optparse
.OptionGroup(parser
, 'Extractor Options')
1458 extractor
.add_option(
1459 '--extractor-retries',
1460 dest
='extractor_retries', metavar
='RETRIES', default
=3,
1461 help='Number of retries for known extractor errors (default is %default), or "infinite"')
1462 extractor
.add_option(
1463 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1464 action
='store_true', dest
='dynamic_mpd', default
=True,
1465 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1466 extractor
.add_option(
1467 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1468 action
='store_false', dest
='dynamic_mpd',
1469 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1470 extractor
.add_option(
1471 '--hls-split-discontinuity',
1472 dest
='hls_split_discontinuity', action
='store_true', default
=False,
1473 help='Split HLS playlists to different formats at discontinuities such as ad breaks'
1475 extractor
.add_option(
1476 '--no-hls-split-discontinuity',
1477 dest
='hls_split_discontinuity', action
='store_false',
1478 help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
1479 _extractor_arg_parser
= lambda key
, vals
='': (key
.strip().lower().replace('-', '_'), [val
.strip() for val
in vals
.split(',')])
1480 extractor
.add_option(
1482 metavar
='KEY:ARGS', dest
='extractor_args', default
={}, type='str',
1483 action
='callback', callback
=_dict_from_options_callback
,
1485 'multiple_keys': False,
1486 'process': lambda val
: dict(
1487 _extractor_arg_parser(*arg
.split('=', 1)) for arg
in val
.split(';'))
1489 'Pass these arguments to the extractor. See "EXTRACTOR ARGUMENTS" for details. '
1490 'You can use this option multiple times to give arguments for different extractors'))
1491 extractor
.add_option(
1492 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1493 action
='store_true', dest
='youtube_include_dash_manifest', default
=True,
1494 help=optparse
.SUPPRESS_HELP
)
1495 extractor
.add_option(
1496 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1497 action
='store_false', dest
='youtube_include_dash_manifest',
1498 help=optparse
.SUPPRESS_HELP
)
1499 extractor
.add_option(
1500 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1501 action
='store_true', dest
='youtube_include_hls_manifest', default
=True,
1502 help=optparse
.SUPPRESS_HELP
)
1503 extractor
.add_option(
1504 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1505 action
='store_false', dest
='youtube_include_hls_manifest',
1506 help=optparse
.SUPPRESS_HELP
)
1508 parser
.add_option_group(general
)
1509 parser
.add_option_group(network
)
1510 parser
.add_option_group(geo
)
1511 parser
.add_option_group(selection
)
1512 parser
.add_option_group(downloader
)
1513 parser
.add_option_group(filesystem
)
1514 parser
.add_option_group(thumbnail
)
1515 parser
.add_option_group(link
)
1516 parser
.add_option_group(verbosity
)
1517 parser
.add_option_group(workarounds
)
1518 parser
.add_option_group(video_format
)
1519 parser
.add_option_group(subtitles
)
1520 parser
.add_option_group(authentication
)
1521 parser
.add_option_group(postproc
)
1522 parser
.add_option_group(sponsorblock
)
1523 parser
.add_option_group(extractor
)
1525 if overrideArguments
is not None:
1526 opts
, args
= parser
.parse_args(overrideArguments
)
1528 write_string('[debug] Override config: ' + repr(overrideArguments
) + '\n')
1530 def compat_conf(conf
):
1531 if sys
.version_info
< (3,):
1532 return [a
.decode(preferredencoding(), 'replace') for a
in conf
]
1536 'command-line': compat_conf(sys
.argv
[1:]),
1537 'custom': [], 'home': [], 'portable': [], 'user': [], 'system': []}
1538 paths
= {'command-line': False}
1540 def read_options(name
, path
, user
=False):
1541 ''' loads config files and returns ignoreconfig '''
1542 # Multiple package names can be given here
1543 # Eg: ('yt-dlp', 'youtube-dlc', 'youtube-dl') will look for
1544 # the configuration file of any of these three packages
1545 for package
in ('yt-dlp',):
1547 config
, current_path
= _readUserConf(package
, default
=None)
1549 current_path
= os
.path
.join(path
, '%s.conf' % package
)
1550 config
= _readOptions(current_path
, default
=None)
1551 if config
is not None:
1552 configs
[name
], paths
[name
] = config
, current_path
1553 return parser
.parse_args(config
)[0].ignoreconfig
1557 opts
, _
= parser
.parse_args(configs
['command-line'])
1558 if opts
.config_location
is not None:
1559 location
= compat_expanduser(opts
.config_location
)
1560 if os
.path
.isdir(location
):
1561 location
= os
.path
.join(location
, 'yt-dlp.conf')
1562 if not os
.path
.exists(location
):
1563 parser
.error('config-location %s does not exist.' % location
)
1564 config
= _readOptions(location
, default
=None)
1566 configs
['custom'], paths
['config'] = config
, location
1568 if opts
.ignoreconfig
:
1570 if parser
.parse_args(configs
['custom'])[0].ignoreconfig
:
1572 if read_options('portable', get_executable_path()):
1574 opts
, _
= parser
.parse_args(configs
['portable'] + configs
['custom'] + configs
['command-line'])
1575 if read_options('home', expand_path(opts
.paths
.get('home', '')).strip()):
1577 if read_options('system', '/etc'):
1579 if read_options('user', None, user
=True):
1580 configs
['system'], paths
['system'] = [], None
1583 argv
= configs
['system'] + configs
['user'] + configs
['home'] + configs
['portable'] + configs
['custom'] + configs
['command-line']
1584 opts
, args
= parser
.parse_args(argv
)
1586 for label
in ('System', 'User', 'Portable', 'Home', 'Custom', 'Command-line'):
1589 write_string(f
'[debug] {label} config file: {paths[key]}\n')
1590 if paths
.get(key
) is not None:
1591 write_string(f
'[debug] {label} config: {_hide_login_info(configs[key])!r}\n')
1593 return parser
, opts
, args