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
.ffmpeg
import (
28 FFmpegSubtitlesConvertorPP
,
29 FFmpegThumbnailsConvertorPP
,
34 def _hide_login_info(opts
):
35 PRIVATE_OPTS
= set(['-p', '--password', '-u', '--username', '--video-password', '--ap-password', '--ap-username'])
36 eqre
= re
.compile('^(?P<key>' + ('|'.join(re
.escape(po
) for po
in PRIVATE_OPTS
)) + ')=.+$')
41 return m
.group('key') + '=PRIVATE'
45 opts
= list(map(_scrub_eq
, opts
))
46 for idx
, opt
in enumerate(opts
):
47 if opt
in PRIVATE_OPTS
and idx
+ 1 < len(opts
):
48 opts
[idx
+ 1] = 'PRIVATE'
52 def parseOpts(overrideArguments
=None):
53 def _readOptions(filename_bytes
, default
=[]):
55 optionf
= open(filename_bytes
)
57 return default
# silently skip if file is not present
59 # FIXME: https://github.com/ytdl-org/youtube-dl/commit/dfe5fa49aed02cf36ba9f743b11b0903554b5e56
60 contents
= optionf
.read()
61 if sys
.version_info
< (3,):
62 contents
= contents
.decode(preferredencoding())
63 res
= compat_shlex_split(contents
, comments
=True)
68 def _readUserConf(package_name
, default
=[]):
70 xdg_config_home
= compat_getenv('XDG_CONFIG_HOME') or compat_expanduser('~/.config')
71 userConfFile
= os
.path
.join(xdg_config_home
, package_name
, 'config')
72 if not os
.path
.isfile(userConfFile
):
73 userConfFile
= os
.path
.join(xdg_config_home
, '%s.conf' % package_name
)
74 userConf
= _readOptions(userConfFile
, default
=None)
75 if userConf
is not None:
76 return userConf
, userConfFile
79 appdata_dir
= compat_getenv('appdata')
81 userConfFile
= os
.path
.join(appdata_dir
, package_name
, 'config')
82 userConf
= _readOptions(userConfFile
, default
=None)
84 userConfFile
+= '.txt'
85 userConf
= _readOptions(userConfFile
, default
=None)
86 if userConf
is not None:
87 return userConf
, userConfFile
90 userConfFile
= os
.path
.join(compat_expanduser('~'), '%s.conf' % package_name
)
91 userConf
= _readOptions(userConfFile
, default
=None)
93 userConfFile
+= '.txt'
94 userConf
= _readOptions(userConfFile
, default
=None)
95 if userConf
is not None:
96 return userConf
, userConfFile
100 def _format_option_string(option
):
101 ''' ('-o', '--option') -> -o, --format METAVAR'''
105 if option
._short
_opts
:
106 opts
.append(option
._short
_opts
[0])
107 if option
._long
_opts
:
108 opts
.append(option
._long
_opts
[0])
112 if option
.takes_value():
113 opts
.append(' %s' % option
.metavar
)
117 def _list_from_options_callback(option
, opt_str
, value
, parser
, append
=True, delim
=','):
118 # append can be True, False or -1 (prepend)
119 current
= getattr(parser
.values
, option
.dest
) if append
else []
120 value
= [value
] if delim
is None else value
.split(delim
)
122 parser
.values
, option
.dest
,
123 current
+ value
if append
is True else value
+ current
)
125 def _dict_from_options_callback(
126 option
, opt_str
, value
, parser
,
127 allowed_keys
=r
'[\w-]+', delimiter
=':', default_key
=None, process
=None, multiple_keys
=True):
129 out_dict
= getattr(parser
.values
, option
.dest
)
131 allowed_keys
= r
'(%s)(,(%s))*' % (allowed_keys
, allowed_keys
)
132 mobj
= re
.match(r
'(?i)(?P<keys>%s)%s(?P<val>.*)$' % (allowed_keys
, delimiter
), value
)
134 keys
= [k
.strip() for k
in mobj
.group('keys').lower().split(',')]
135 val
= mobj
.group('val')
136 elif default_key
is not None:
137 keys
, val
= [default_key
], value
139 raise optparse
.OptionValueError(
140 'wrong %s formatting; it should be %s, not "%s"' % (opt_str
, option
.metavar
, value
))
142 val
= process(val
) if process
else val
143 except Exception as err
:
144 raise optparse
.OptionValueError(
145 'wrong %s formatting; %s' % (opt_str
, err
))
149 # No need to wrap help messages if we're on a wide console
150 columns
= compat_get_terminal_size().columns
151 max_width
= columns
if columns
else 80
152 # 47% is chosen because that is how README.md is currently formatted
153 # and moving help text even further to the right is undesirable.
154 # This can be reduced in the future to get a prettier output
155 max_help_position
= int(0.47 * max_width
)
157 fmt
= optparse
.IndentedHelpFormatter(width
=max_width
, max_help_position
=max_help_position
)
158 fmt
.format_option_strings
= _format_option_string
161 'version': __version__
,
163 'usage': '%prog [OPTIONS] URL [URL...]',
164 'conflict_handler': 'resolve',
167 parser
= optparse
.OptionParser(**compat_kwargs(kw
))
169 general
= optparse
.OptionGroup(parser
, 'General Options')
173 help='Print this help text and exit')
177 help='Print program version and exit')
180 action
='store_true', dest
='update_self',
181 help='Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
183 '-i', '--ignore-errors', '--no-abort-on-error',
184 action
='store_true', dest
='ignoreerrors', default
=None,
185 help='Continue on download errors, for example to skip unavailable videos in a playlist (default) (Alias: --no-abort-on-error)')
187 '--abort-on-error', '--no-ignore-errors',
188 action
='store_false', dest
='ignoreerrors',
189 help='Abort downloading of further videos if an error occurs (Alias: --no-ignore-errors)')
192 action
='store_true', dest
='dump_user_agent', default
=False,
193 help='Display the current browser identification')
196 action
='store_true', dest
='list_extractors', default
=False,
197 help='List all supported extractors')
199 '--extractor-descriptions',
200 action
='store_true', dest
='list_extractor_descriptions', default
=False,
201 help='Output descriptions of all supported extractors')
203 '--force-generic-extractor',
204 action
='store_true', dest
='force_generic_extractor', default
=False,
205 help='Force extraction to use the generic extractor')
208 dest
='default_search', metavar
='PREFIX',
209 help='Use this prefix for unqualified URLs. For example "gvsearch2:" downloads two videos from google videos for youtube-dl "large apple". Use the value "auto" to let youtube-dl guess ("auto_warning" to emit a warning when guessing). "error" just throws an error. The default value "fixup_error" repairs broken URLs, but emits an error if this is not possible instead of searching')
211 '--ignore-config', '--no-config',
214 'Disable loading any configuration files except the one provided by --config-location. '
215 'When given inside a configuration file, no further configuration files are loaded. '
216 'Additionally, (for backward compatibility) if this option is found inside the '
217 'system configuration file, the user configuration is not loaded'))
220 dest
='config_location', metavar
='PATH',
221 help='Location of the main configuration file; either the path to the config or its containing directory')
224 action
='store_const', dest
='extract_flat', const
='in_playlist', default
=False,
225 help='Do not extract the videos of a playlist, only list them')
228 action
='store_true', dest
='extract_flat',
229 # help='Do not resolve the video urls')
231 help=optparse
.SUPPRESS_HELP
)
233 '--no-flat-playlist',
234 action
='store_false', dest
='extract_flat',
235 help='Extract the videos of a playlist')
238 action
='store_true', dest
='mark_watched', default
=False,
239 help='Mark videos watched (YouTube only)')
242 action
='store_false', dest
='mark_watched',
243 help='Do not mark videos watched (default)')
246 action
='store_true', dest
='no_color', default
=False,
247 help='Do not emit color codes in output')
250 metavar
='OPTS', dest
='compat_opts', default
=[],
251 action
='callback', callback
=_list_from_options_callback
, type='str',
253 'Options that can help keep compatibility with youtube-dl and youtube-dlc '
254 'configurations by reverting some of the changes made in yt-dlp. '
255 'See "Differences in default behavior" for details'))
257 network
= optparse
.OptionGroup(parser
, 'Network Options')
259 '--proxy', dest
='proxy',
260 default
=None, metavar
='URL',
262 'Use the specified HTTP/HTTPS/SOCKS proxy. To enable '
263 'SOCKS proxy, specify a proper scheme. For example '
264 'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") '
265 'for direct connection'))
268 dest
='socket_timeout', type=float, default
=None, metavar
='SECONDS',
269 help='Time to wait before giving up, in seconds')
272 metavar
='IP', dest
='source_address', default
=None,
273 help='Client-side IP address to bind to',
276 '-4', '--force-ipv4',
277 action
='store_const', const
='0.0.0.0', dest
='source_address',
278 help='Make all connections via IPv4',
281 '-6', '--force-ipv6',
282 action
='store_const', const
='::', dest
='source_address',
283 help='Make all connections via IPv6',
286 geo
= optparse
.OptionGroup(parser
, 'Geo-restriction')
288 '--geo-verification-proxy',
289 dest
='geo_verification_proxy', default
=None, metavar
='URL',
291 'Use this proxy to verify the IP address for some geo-restricted sites. '
292 'The default proxy specified by --proxy (or none, if the option is not present) is used for the actual downloading'))
294 '--cn-verification-proxy',
295 dest
='cn_verification_proxy', default
=None, metavar
='URL',
296 help=optparse
.SUPPRESS_HELP
)
299 action
='store_true', dest
='geo_bypass', default
=True,
300 help='Bypass geographic restriction via faking X-Forwarded-For HTTP header')
303 action
='store_false', dest
='geo_bypass', default
=True,
304 help='Do not bypass geographic restriction via faking X-Forwarded-For HTTP header')
306 '--geo-bypass-country', metavar
='CODE',
307 dest
='geo_bypass_country', default
=None,
308 help='Force bypass geographic restriction with explicitly provided two-letter ISO 3166-2 country code')
310 '--geo-bypass-ip-block', metavar
='IP_BLOCK',
311 dest
='geo_bypass_ip_block', default
=None,
312 help='Force bypass geographic restriction with explicitly provided IP block in CIDR notation')
314 selection
= optparse
.OptionGroup(parser
, 'Video Selection')
315 selection
.add_option(
317 dest
='playliststart', metavar
='NUMBER', default
=1, type=int,
318 help='Playlist video to start at (default is %default)')
319 selection
.add_option(
321 dest
='playlistend', metavar
='NUMBER', default
=None, type=int,
322 help='Playlist video to end at (default is last)')
323 selection
.add_option(
325 dest
='playlist_items', metavar
='ITEM_SPEC', default
=None,
326 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')
327 selection
.add_option(
329 dest
='matchtitle', metavar
='REGEX',
330 help='Download only matching titles (regex or caseless sub-string)')
331 selection
.add_option(
333 dest
='rejecttitle', metavar
='REGEX',
334 help='Skip download for matching titles (regex or caseless sub-string)')
335 selection
.add_option(
337 dest
='max_downloads', metavar
='NUMBER', type=int, default
=None,
338 help='Abort after downloading NUMBER files')
339 selection
.add_option(
341 metavar
='SIZE', dest
='min_filesize', default
=None,
342 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
343 selection
.add_option(
345 metavar
='SIZE', dest
='max_filesize', default
=None,
346 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
347 selection
.add_option(
349 metavar
='DATE', dest
='date', default
=None,
351 'Download only videos uploaded in this date. '
352 'The date can be "YYYYMMDD" or in the format '
353 '"(now|today)[+-][0-9](day|week|month|year)(s)?"'))
354 selection
.add_option(
356 metavar
='DATE', dest
='datebefore', default
=None,
358 'Download only videos uploaded on or before this date. '
359 'The date formats accepted is the same as --date'))
360 selection
.add_option(
362 metavar
='DATE', dest
='dateafter', default
=None,
364 'Download only videos uploaded on or after this date. '
365 'The date formats accepted is the same as --date'))
366 selection
.add_option(
368 metavar
='COUNT', dest
='min_views', default
=None, type=int,
369 help='Do not download any videos with less than COUNT views')
370 selection
.add_option(
372 metavar
='COUNT', dest
='max_views', default
=None, type=int,
373 help='Do not download any videos with more than COUNT views')
374 selection
.add_option(
376 metavar
='FILTER', dest
='match_filter', default
=None,
378 'Generic video filter. Any field (see "OUTPUT TEMPLATE") can be compared with a '
379 'number or a string using the operators defined in "Filtering formats". '
380 'You can also simply specify a field to match if the field is present '
381 'and "!field" to check if the field is not present. In addition, '
382 'Python style regular expression matching can be done using "~=", '
383 'and multiple filters can be checked with "&". '
384 'Use a "\\" to escape "&" or quotes if needed. Eg: --match-filter '
385 r
'"!is_live & like_count>?100 & description~=\'(?i
)\bcats \
& dogs
\b\'" '
386 'matches only videos that are not live, has a like count more than 100 '
387 '(or the like field is not available), and also has a description '
388 'that contains the phrase "cats
& dogs
" (ignoring case)'))
389 selection.add_option(
391 metavar='FILTER', dest='match_filter', action='store_const', const=None,
392 help='Do not use generic video filter (default)')
393 selection.add_option(
395 action='store_true', dest='noplaylist', default=False,
396 help='Download only the video, if the URL refers to a video and a playlist')
397 selection.add_option(
399 action='store_false', dest='noplaylist',
400 help='Download the playlist, if the URL refers to a video and a playlist')
401 selection.add_option(
403 metavar='YEARS', dest='age_limit', default=None, type=int,
404 help='Download only videos suitable for the given age')
405 selection.add_option(
406 '--download-archive', metavar='FILE',
407 dest='download_archive',
408 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it')
409 selection.add_option(
410 '--break-on-existing',
411 action='store_true', dest='break_on_existing', default=False,
412 help='Stop the download process when encountering a file that is in the archive')
413 selection.add_option(
415 action='store_true', dest='break_on_reject', default=False,
416 help='Stop the download process when encountering a file that has been filtered out')
417 selection.add_option(
418 '--skip-playlist-after-errors', metavar='N',
419 dest='skip_playlist_after_errors', default=None, type=int,
420 help='Number of allowed failures until the rest of the playlist is skipped')
421 selection.add_option(
422 '--no-download-archive',
423 dest='download_archive', action="store_const
", const=None,
424 help='Do not use archive file (default)')
425 selection.add_option(
427 dest='include_ads', action='store_true',
428 help=optparse.SUPPRESS_HELP)
429 selection.add_option(
431 dest='include_ads', action='store_false',
432 help=optparse.SUPPRESS_HELP)
434 authentication = optparse.OptionGroup(parser, 'Authentication Options')
435 authentication.add_option(
437 dest='username', metavar='USERNAME',
438 help='Login with this account ID')
439 authentication.add_option(
441 dest='password', metavar='PASSWORD',
442 help='Account password. If this option is left out, yt-dlp will ask interactively')
443 authentication.add_option(
445 dest='twofactor', metavar='TWOFACTOR',
446 help='Two-factor authentication code')
447 authentication.add_option(
449 action='store_true', dest='usenetrc', default=False,
450 help='Use .netrc authentication data')
451 authentication.add_option(
453 dest='videopassword', metavar='PASSWORD',
454 help='Video password (vimeo, youku)')
455 authentication.add_option(
457 dest='ap_mso', metavar='MSO',
458 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
459 authentication.add_option(
461 dest='ap_username', metavar='USERNAME',
462 help='Multiple-system operator account login')
463 authentication.add_option(
465 dest='ap_password', metavar='PASSWORD',
466 help='Multiple-system operator account password. If this option is left out, yt-dlp will ask interactively')
467 authentication.add_option(
469 action='store_true', dest='ap_list_mso', default=False,
470 help='List all supported multiple-system operators')
472 video_format = optparse.OptionGroup(parser, 'Video Format Options')
473 video_format.add_option(
475 action='store', dest='format', metavar='FORMAT', default=None,
476 help='Video format code, see "FORMAT SELECTION
" for more details')
477 video_format.add_option(
478 '-S', '--format-sort', metavar='SORTORDER',
479 dest='format_sort', default=[], type='str', action='callback',
480 callback=_list_from_options_callback, callback_kwargs={'append': -1},
481 help='Sort the formats by the fields given, see "Sorting Formats
" for more details')
482 video_format.add_option(
483 '--format-sort-force', '--S-force',
484 action='store_true', dest='format_sort_force', metavar='FORMAT', default=False,
486 'Force user specified sort order to have precedence over all fields, '
487 'see "Sorting Formats
" for more details'))
488 video_format.add_option(
489 '--no-format-sort-force',
490 action='store_false', dest='format_sort_force', metavar='FORMAT', default=False,
492 'Some fields have precedence over the user specified sort order (default), '
493 'see "Sorting Formats
" for more details'))
494 video_format.add_option(
495 '--video-multistreams',
496 action='store_true', dest='allow_multiple_video_streams', default=None,
497 help='Allow multiple video streams to be merged into a single file')
498 video_format.add_option(
499 '--no-video-multistreams',
500 action='store_false', dest='allow_multiple_video_streams',
501 help='Only one video stream is downloaded for each output file (default)')
502 video_format.add_option(
503 '--audio-multistreams',
504 action='store_true', dest='allow_multiple_audio_streams', default=None,
505 help='Allow multiple audio streams to be merged into a single file')
506 video_format.add_option(
507 '--no-audio-multistreams',
508 action='store_false', dest='allow_multiple_audio_streams',
509 help='Only one audio stream is downloaded for each output file (default)')
510 video_format.add_option(
512 action='store_const', dest='format', const='all',
513 help=optparse.SUPPRESS_HELP)
514 video_format.add_option(
515 '--prefer-free-formats',
516 action='store_true', dest='prefer_free_formats', default=False,
518 'Prefer video formats with free containers over non-free ones of same quality. '
519 'Use with "-S ext
" to strictly prefer free containers irrespective of quality'))
520 video_format.add_option(
521 '--no-prefer-free-formats',
522 action='store_true', dest='prefer_free_formats', default=False,
523 help="Don
't give any special preference to free containers (default)")
524 video_format.add_option(
526 action='store_true
', dest='check_formats
', default=None,
527 help='Check that the formats selected are actually downloadable
')
528 video_format.add_option(
529 '--no
-check
-formats
',
530 action='store_false
', dest='check_formats
',
531 help='Do
not check that the formats selected are actually downloadable
')
532 video_format.add_option(
533 '-F
', '--list-formats
',
534 action='store_true
', dest='listformats
',
535 help='List all available formats of requested videos
')
536 video_format.add_option(
537 '--list-formats
-as-table
',
538 action='store_true
', dest='listformats_table
', default=True,
539 help=optparse.SUPPRESS_HELP)
540 video_format.add_option(
541 '--list-formats
-old
', '--no
-list-formats
-as-table
',
542 action='store_false
', dest='listformats_table
',
543 help=optparse.SUPPRESS_HELP)
544 video_format.add_option(
545 '--merge
-output
-format
',
546 action='store
', dest='merge_output_format
', metavar='FORMAT
', default=None,
548 'If a merge
is required (e
.g
. bestvideo
+bestaudio
), '
549 'output to given container format
. One of mkv
, mp4
, ogg
, webm
, flv
. '
550 'Ignored
if no merge
is required
'))
551 video_format.add_option(
552 '--allow
-unplayable
-formats
',
553 action='store_true
', dest='allow_unplayable_formats
', default=False,
555 'Allow unplayable formats to be listed
and downloaded
. '
556 'All video post
-processing will also be turned off
'))
557 video_format.add_option(
558 '--no
-allow
-unplayable
-formats
',
559 action='store_false
', dest='allow_unplayable_formats
',
560 help='Do
not allow unplayable formats to be listed
or downloaded (default
)')
562 subtitles = optparse.OptionGroup(parser, 'Subtitle Options
')
563 subtitles.add_option(
564 '--write
-subs
', '--write
-srt
',
565 action='store_true
', dest='writesubtitles
', default=False,
566 help='Write subtitle
file')
567 subtitles.add_option(
568 '--no
-write
-subs
', '--no
-write
-srt
',
569 action='store_false
', dest='writesubtitles
',
570 help='Do
not write subtitle
file (default
)')
571 subtitles.add_option(
572 '--write
-auto
-subs
', '--write
-automatic
-subs
',
573 action='store_true
', dest='writeautomaticsub
', default=False,
574 help='Write automatically generated subtitle
file (Alias
: --write
-automatic
-subs
)')
575 subtitles.add_option(
576 '--no
-write
-auto
-subs
', '--no
-write
-automatic
-subs
',
577 action='store_false
', dest='writeautomaticsub
', default=False,
578 help='Do
not write auto
-generated
subtitles (default
) (Alias
: --no
-write
-automatic
-subs
)')
579 subtitles.add_option(
581 action='store_true
', dest='allsubtitles
', default=False,
582 help=optparse.SUPPRESS_HELP)
583 subtitles.add_option(
585 action='store_true
', dest='listsubtitles
', default=False,
586 help='List all available subtitles
for the video
')
587 subtitles.add_option(
589 action='store
', dest='subtitlesformat
', metavar='FORMAT
', default='best
',
590 help='Subtitle format
, accepts formats preference
, for example
: "srt" or "ass/srt/best"')
591 subtitles.add_option(
592 '--sub
-langs
', '--srt
-langs
',
593 action='callback
', dest='subtitleslangs
', metavar='LANGS
', type='str',
594 default=[], callback=_list_from_options_callback,
596 'Languages of the subtitles to
download (can be regex
) or "all" separated by commas
. (Eg
: --sub
-langs en
.*,ja
) '
597 'You can prefix the language code
with a
"-" to exempt it
from the requested languages
. (Eg
: --sub
-langs all
,-live_chat
) '
598 'Use
--list-subs
for a
list of available language tags
'))
600 downloader = optparse.OptionGroup(parser, 'Download Options
')
601 downloader.add_option(
602 '-N
', '--concurrent
-fragments
',
603 dest='concurrent_fragment_downloads
', metavar='N
', default=1, type=int,
604 help='Number of fragments of a dash
/hlsnative video that should be download
concurrently (default
is %default
)')
605 downloader.add_option(
606 '-r
', '--limit
-rate
', '--rate
-limit
',
607 dest='ratelimit
', metavar='RATE
',
608 help='Maximum download rate
in bytes per
second (e
.g
. 50K
or 4.2M
)')
609 downloader.add_option(
611 dest='throttledratelimit
', metavar='RATE
',
612 help='Minimum download rate
in bytes per second below which throttling
is assumed
and the video data
is re
-extracted (e
.g
. 100K
)')
613 downloader.add_option(
615 dest='retries
', metavar='RETRIES
', default=10,
616 help='Number of
retries (default
is %default
), or "infinite"')
617 downloader.add_option(
618 '--fragment
-retries
',
619 dest='fragment_retries
', metavar='RETRIES
', default=10,
620 help='Number of retries
for a
fragment (default
is %default
), or "infinite" (DASH
, hlsnative
and ISM
)')
621 downloader.add_option(
622 '--skip
-unavailable
-fragments
', '--no
-abort
-on
-unavailable
-fragment
',
623 action='store_true
', dest='skip_unavailable_fragments
', default=True,
624 help='Skip unavailable fragments
for DASH
, hlsnative
and ISM (default
) (Alias
: --no
-abort
-on
-unavailable
-fragment
)')
625 downloader.add_option(
626 '--abort
-on
-unavailable
-fragment
', '--no
-skip
-unavailable
-fragments
',
627 action='store_false
', dest='skip_unavailable_fragments
',
628 help='Abort downloading
if a fragment
is unavailable (Alias
: --no
-skip
-unavailable
-fragments
)')
629 downloader.add_option(
631 action='store_true
', dest='keep_fragments
', default=False,
632 help='Keep downloaded fragments on disk after downloading
is finished
')
633 downloader.add_option(
634 '--no
-keep
-fragments
',
635 action='store_false
', dest='keep_fragments
',
636 help='Delete downloaded fragments after downloading
is finished (default
)')
637 downloader.add_option(
639 dest='buffersize
', metavar='SIZE
', default='1024',
640 help='Size of download
buffer (e
.g
. 1024 or 16K
) (default
is %default
)')
641 downloader.add_option(
643 action='store_false
', dest='noresizebuffer
',
644 help='The
buffer size
is automatically resized
from an initial value of
--buffer-size (default
)')
645 downloader.add_option(
646 '--no
-resize
-buffer',
647 action='store_true
', dest='noresizebuffer
', default=False,
648 help='Do
not automatically adjust the
buffer size
')
649 downloader.add_option(
651 dest='http_chunk_size
', metavar='SIZE
', default=None,
653 'Size of a chunk
for chunk
-based HTTP
downloading (e
.g
. 10485760 or 10M
) (default
is disabled
). '
654 'May be useful
for bypassing bandwidth throttling imposed by a
webserver (experimental
)'))
655 downloader.add_option(
657 action='store_true
', dest='test
', default=False,
658 help=optparse.SUPPRESS_HELP)
659 downloader.add_option(
660 '--playlist
-reverse
',
662 help='Download playlist videos
in reverse order
')
663 downloader.add_option(
664 '--no
-playlist
-reverse
',
665 action='store_false
', dest='playlist_reverse
',
666 help='Download playlist videos
in default
order (default
)')
667 downloader.add_option(
670 help='Download playlist videos
in random order
')
671 downloader.add_option(
672 '--xattr
-set-filesize
',
673 dest='xattr_set_filesize
', action='store_true
',
674 help='Set
file xattribute ytdl
.filesize
with expected
file size
')
675 downloader.add_option(
676 '--hls
-prefer
-native
',
677 dest='hls_prefer_native
', action='store_true
', default=None,
678 help=optparse.SUPPRESS_HELP)
679 downloader.add_option(
680 '--hls
-prefer
-ffmpeg
',
681 dest='hls_prefer_native
', action='store_false
', default=None,
682 help=optparse.SUPPRESS_HELP)
683 downloader.add_option(
685 dest='hls_use_mpegts
', action='store_true
', default=None,
687 'Use the mpegts container
for HLS videos
; '
688 'allowing some players to play the video
while downloading
, '
689 'and reducing the chance of
file corruption
if download
is interrupted
. '
690 'This
is enabled by default
for live streams
'))
691 downloader.add_option(
692 '--no
-hls
-use
-mpegts
',
693 dest='hls_use_mpegts
', action='store_false
',
695 'Do
not use the mpegts container
for HLS videos
. '
696 'This
is default when
not downloading live streams
'))
697 downloader.add_option(
698 '--downloader
', '--external
-downloader
',
699 dest='external_downloader
', metavar='[PROTO
:]NAME
', default={}, type='str',
700 action='callback
', callback=_dict_from_options_callback,
702 'allowed_keys
': 'http|ftp|m3u8|dash|rtsp|rtmp|mms
',
703 'default_key
': 'default
',
706 'Name
or path of the external downloader to
use (optionally
) prefixed by
'
707 'the
protocols (http
, ftp
, m3u8
, dash
, rstp
, rtmp
, mms
) to use it
for. '
708 'Currently supports native
, %s (Recommended
: aria2c
). '
709 'You can use this option multiple times to
set different downloaders
for different protocols
. '
710 'For example
, --downloader aria2c
--downloader
"dash,m3u8:native" will use
'
711 'aria2c
for http
/ftp downloads
, and the native downloader
for dash
/m3u8 downloads
'
712 '(Alias
: --external
-downloader
)' % ', '.join(list_external_downloaders())))
713 downloader.add_option(
714 '--downloader
-args
', '--external
-downloader
-args
',
715 metavar='NAME
:ARGS
', dest='external_downloader_args
', default={}, type='str',
716 action='callback
', callback=_dict_from_options_callback,
718 'allowed_keys
': '|
'.join(list_external_downloaders()),
719 'default_key
': 'default
',
720 'process
': compat_shlex_split
722 'Give these arguments to the external downloader
. '
723 'Specify the downloader name
and the arguments separated by a colon
":". '
724 'You can use this option multiple times to give different arguments to different downloaders
'
725 '(Alias
: --external
-downloader
-args
)'))
727 workarounds = optparse.OptionGroup(parser, 'Workarounds
')
728 workarounds.add_option(
730 dest='encoding
', metavar='ENCODING
',
731 help='Force the specified
encoding (experimental
)')
732 workarounds.add_option(
733 '--no
-check
-certificate
',
734 action='store_true
', dest='no_check_certificate
', default=False,
735 help='Suppress HTTPS certificate validation
')
736 workarounds.add_option(
737 '--prefer
-insecure
', '--prefer
-unsecure
',
738 action='store_true
', dest='prefer_insecure
',
739 help='Use an unencrypted connection to retrieve information about the
video (Currently supported only
for YouTube
)')
740 workarounds.add_option(
742 metavar='UA
', dest='user_agent
',
743 help='Specify a custom user agent
')
744 workarounds.add_option(
746 metavar='URL
', dest='referer
', default=None,
747 help='Specify a custom referer
, use
if the video access
is restricted to one domain
',
749 workarounds.add_option(
751 metavar='FIELD
:VALUE
', dest='headers
', default={}, type='str',
752 action='callback
', callback=_dict_from_options_callback,
753 callback_kwargs={'multiple_keys': False},
754 help='Specify a custom HTTP header
and its value
, separated by a colon
":". You can use this option multiple times
',
756 workarounds.add_option(
758 dest='bidi_workaround
', action='store_true
',
759 help='Work around terminals that lack bidirectional text support
. Requires bidiv
or fribidi executable
in PATH
')
760 workarounds.add_option(
761 '--sleep
-requests
', metavar='SECONDS
',
762 dest='sleep_interval_requests
', type=float,
763 help='Number of seconds to sleep between requests during data extraction
')
764 workarounds.add_option(
765 '--sleep
-interval
', '--min-sleep
-interval
', metavar='SECONDS
',
766 dest='sleep_interval
', type=float,
768 'Number of seconds to sleep before each download
. '
769 'This
is the minimum time to sleep when used along
with --max-sleep
-interval
'
770 '(Alias
: --min-sleep
-interval
)'))
771 workarounds.add_option(
772 '--max-sleep
-interval
', metavar='SECONDS
',
773 dest='max_sleep_interval
', type=float,
774 help='Maximum number of seconds to sleep
. Can only be used along
with --min-sleep
-interval
')
775 workarounds.add_option(
776 '--sleep
-subtitles
', metavar='SECONDS
',
777 dest='sleep_interval_subtitles
', default=0, type=int,
778 help='Number of seconds to sleep before each subtitle download
')
780 verbosity = optparse.OptionGroup(parser, 'Verbosity
and Simulation Options
')
781 verbosity.add_option(
783 action='store_true
', dest='quiet
', default=False,
784 help='Activate quiet mode
')
785 verbosity.add_option(
787 dest='no_warnings
', action='store_true
', default=False,
788 help='Ignore warnings
')
789 verbosity.add_option(
791 action='store_true
', dest='simulate
', default=False,
792 help='Do
not download the video
and do
not write anything to disk
')
793 verbosity.add_option(
794 '--ignore
-no
-formats
-error
',
795 action='store_true
', dest='ignore_no_formats_error
', default=False,
797 'Ignore
"No video formats" error
. Usefull
for extracting metadata
'
798 'even
if the video
is not actually available
for download (experimental
)'))
799 verbosity.add_option(
800 '--no
-ignore
-no
-formats
-error
',
801 action='store_false
', dest='ignore_no_formats_error
',
802 help='Throw error when no downloadable video formats are
found (default
)')
803 verbosity.add_option(
804 '--skip
-download
', '--no
-download
',
805 action='store_true
', dest='skip_download
', default=False,
806 help='Do
not download the video but write all related
files (Alias
: --no
-download
)')
807 verbosity.add_option(
808 '-O
', '--print', metavar='TEMPLATE
',
809 action='callback
', dest='forceprint
', type='str', default=[],
810 callback=_list_from_options_callback, callback_kwargs={'delim': None},
812 'Simulate
, quiet but
print the given fields
. Either a field name
'
813 'or similar formatting
as the output template can be used
'))
814 verbosity.add_option(
816 action='store_true
', dest='geturl
', default=False,
817 help=optparse.SUPPRESS_HELP)
818 verbosity.add_option(
820 action='store_true
', dest='gettitle
', default=False,
821 help=optparse.SUPPRESS_HELP)
822 verbosity.add_option(
824 action='store_true
', dest='getid
', default=False,
825 help=optparse.SUPPRESS_HELP)
826 verbosity.add_option(
828 action='store_true
', dest='getthumbnail
', default=False,
829 help=optparse.SUPPRESS_HELP)
830 verbosity.add_option(
832 action='store_true
', dest='getdescription
', default=False,
833 help=optparse.SUPPRESS_HELP)
834 verbosity.add_option(
836 action='store_true
', dest='getduration
', default=False,
837 help=optparse.SUPPRESS_HELP)
838 verbosity.add_option(
840 action='store_true
', dest='getfilename
', default=False,
841 help=optparse.SUPPRESS_HELP)
842 verbosity.add_option(
844 action='store_true
', dest='getformat
', default=False,
845 help=optparse.SUPPRESS_HELP)
846 verbosity.add_option(
848 action='store_true
', dest='dumpjson
', default=False,
849 help='Simulate
, quiet but
print JSON information
. See
"OUTPUT TEMPLATE" for a description of available keys
')
850 verbosity.add_option(
851 '-J
', '--dump
-single
-json
',
852 action='store_true
', dest='dump_single_json
', default=False,
854 'Simulate
, quiet but
print JSON information
for each command
-line argument
. '
855 'If the URL refers to a playlist
, dump the whole playlist information
in a single line
'))
856 verbosity.add_option(
858 action='store_true
', dest='print_json
', default=False,
859 help='Be quiet
and print the video information
as JSON (video
is still being downloaded
)')
860 verbosity.add_option(
861 '--force
-write
-archive
', '--force
-write
-download
-archive
', '--force
-download
-archive
',
862 action='store_true
', dest='force_write_download_archive
', default=False,
864 'Force download archive entries to be written
as far
as no errors occur
, '
865 'even
if -s
or another simulation option
is used (Alias
: --force
-download
-archive
)'))
866 verbosity.add_option(
868 action='store_true
', dest='progress_with_newline
', default=False,
869 help='Output progress bar
as new lines
')
870 verbosity.add_option(
872 action='store_true
', dest='noprogress
', default=False,
873 help='Do
not print progress bar
')
874 verbosity.add_option(
876 action='store_true
', dest='consoletitle
', default=False,
877 help='Display progress
in console titlebar
')
878 verbosity.add_option(
880 action='store_true
', dest='verbose
', default=False,
881 help='Print various debugging information
')
882 verbosity.add_option(
883 '--dump
-pages
', '--dump
-intermediate
-pages
',
884 action='store_true
', dest='dump_intermediate_pages
', default=False,
885 help='Print downloaded pages encoded using base64 to debug
problems (very verbose
)')
886 verbosity.add_option(
888 action='store_true
', dest='write_pages
', default=False,
889 help='Write downloaded intermediary pages to files
in the current directory to debug problems
')
890 verbosity.add_option(
891 '--youtube
-print-sig
-code
',
892 action='store_true
', dest='youtube_print_sig_code
', default=False,
893 help=optparse.SUPPRESS_HELP)
894 verbosity.add_option(
895 '--print-traffic
', '--dump
-headers
',
896 dest='debug_printtraffic
', action='store_true
', default=False,
897 help='Display sent
and read HTTP traffic
')
898 verbosity.add_option(
900 dest='call_home
', action='store_true
', default=False,
901 # help='[Broken
] Contact the yt
-dlp server
for debugging
')
902 help=optparse.SUPPRESS_HELP)
903 verbosity.add_option(
905 dest='call_home
', action='store_false
',
906 # help='Do
not contact the yt
-dlp server
for debugging (default
)')
907 help=optparse.SUPPRESS_HELP)
909 filesystem = optparse.OptionGroup(parser, 'Filesystem Options
')
910 filesystem.add_option(
911 '-a
', '--batch
-file',
912 dest='batchfile
', metavar='FILE
',
913 help="File containing URLs to download ('-' for stdin), one URL per line. "
914 "Lines starting with '#', ';' or ']' are considered as comments and ignored")
915 filesystem
.add_option(
916 '--id', default
=False,
917 action
='store_true', dest
='useid', help=optparse
.SUPPRESS_HELP
)
918 filesystem
.add_option(
920 metavar
='[TYPES:]PATH', dest
='paths', default
={}, type='str',
921 action
='callback', callback
=_dict_from_options_callback
,
923 'allowed_keys': 'home|temp|%s' % '|'.join(OUTTMPL_TYPES
.keys()),
924 'default_key': 'home'
926 'The paths where the files should be downloaded. '
927 'Specify the type of file and the path separated by a colon ":". '
928 'All the same types as --output are supported. '
929 'Additionally, you can also provide "home" (default) and "temp" paths. '
930 'All intermediary files are first downloaded to the temp path and '
931 'then the final files are moved over to the home path after download is finished. '
932 'This option is ignored if --output is an absolute path'))
933 filesystem
.add_option(
935 metavar
='[TYPES:]TEMPLATE', dest
='outtmpl', default
={}, type='str',
936 action
='callback', callback
=_dict_from_options_callback
,
938 'allowed_keys': '|'.join(OUTTMPL_TYPES
.keys()),
939 'default_key': 'default'
940 }, help='Output filename template; see "OUTPUT TEMPLATE" for details')
941 filesystem
.add_option(
942 '--output-na-placeholder',
943 dest
='outtmpl_na_placeholder', metavar
='TEXT', default
='NA',
944 help=('Placeholder value for unavailable meta fields in output filename template (default: "%default")'))
945 filesystem
.add_option(
947 dest
='autonumber_size', metavar
='NUMBER', type=int,
948 help=optparse
.SUPPRESS_HELP
)
949 filesystem
.add_option(
950 '--autonumber-start',
951 dest
='autonumber_start', metavar
='NUMBER', default
=1, type=int,
952 help=optparse
.SUPPRESS_HELP
)
953 filesystem
.add_option(
954 '--restrict-filenames',
955 action
='store_true', dest
='restrictfilenames', default
=False,
956 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
957 filesystem
.add_option(
958 '--no-restrict-filenames',
959 action
='store_false', dest
='restrictfilenames',
960 help='Allow Unicode characters, "&" and spaces in filenames (default)')
961 filesystem
.add_option(
962 '--windows-filenames',
963 action
='store_true', dest
='windowsfilenames', default
=False,
964 help='Force filenames to be windows compatible')
965 filesystem
.add_option(
966 '--no-windows-filenames',
967 action
='store_false', dest
='windowsfilenames',
968 help='Make filenames windows compatible only if using windows (default)')
969 filesystem
.add_option(
970 '--trim-filenames', '--trim-file-names', metavar
='LENGTH',
971 dest
='trim_file_name', default
=0, type=int,
972 help='Limit the filename length (excluding extension) to the specified number of characters')
973 filesystem
.add_option(
975 action
='store_true', dest
='autonumber', default
=False,
976 help=optparse
.SUPPRESS_HELP
)
977 filesystem
.add_option(
979 action
='store_true', dest
='usetitle', default
=False,
980 help=optparse
.SUPPRESS_HELP
)
981 filesystem
.add_option(
982 '--literal', default
=False,
983 action
='store_true', dest
='usetitle',
984 help=optparse
.SUPPRESS_HELP
)
985 filesystem
.add_option(
986 '-w', '--no-overwrites',
987 action
='store_false', dest
='overwrites', default
=None,
988 help='Do not overwrite any files')
989 filesystem
.add_option(
990 '--force-overwrites', '--yes-overwrites',
991 action
='store_true', dest
='overwrites',
992 help='Overwrite all video and metadata files. This option includes --no-continue')
993 filesystem
.add_option(
994 '--no-force-overwrites',
995 action
='store_const', dest
='overwrites', const
=None,
996 help='Do not overwrite the video, but overwrite related files (default)')
997 filesystem
.add_option(
999 action
='store_true', dest
='continue_dl', default
=True,
1000 help='Resume partially downloaded files/fragments (default)')
1001 filesystem
.add_option(
1003 action
='store_false', dest
='continue_dl',
1005 'Do not resume partially downloaded fragments. '
1006 'If the file is not fragmented, restart download of the entire file'))
1007 filesystem
.add_option(
1009 action
='store_false', dest
='nopart', default
=False,
1010 help='Use .part files instead of writing directly into output file (default)')
1011 filesystem
.add_option(
1013 action
='store_true', dest
='nopart',
1014 help='Do not use .part files - write directly into output file')
1015 filesystem
.add_option(
1017 action
='store_true', dest
='updatetime', default
=True,
1018 help='Use the Last-modified header to set the file modification time (default)')
1019 filesystem
.add_option(
1021 action
='store_false', dest
='updatetime',
1022 help='Do not use the Last-modified header to set the file modification time')
1023 filesystem
.add_option(
1024 '--write-description',
1025 action
='store_true', dest
='writedescription', default
=False,
1026 help='Write video description to a .description file')
1027 filesystem
.add_option(
1028 '--no-write-description',
1029 action
='store_false', dest
='writedescription',
1030 help='Do not write video description (default)')
1031 filesystem
.add_option(
1032 '--write-info-json',
1033 action
='store_true', dest
='writeinfojson', default
=False,
1034 help='Write video metadata to a .info.json file (this may contain personal information)')
1035 filesystem
.add_option(
1036 '--no-write-info-json',
1037 action
='store_false', dest
='writeinfojson',
1038 help='Do not write video metadata (default)')
1039 filesystem
.add_option(
1040 '--write-annotations',
1041 action
='store_true', dest
='writeannotations', default
=False,
1042 help='Write video annotations to a .annotations.xml file')
1043 filesystem
.add_option(
1044 '--no-write-annotations',
1045 action
='store_false', dest
='writeannotations',
1046 help='Do not write video annotations (default)')
1047 filesystem
.add_option(
1048 '--write-playlist-metafiles',
1049 action
='store_true', dest
='allow_playlist_files', default
=None,
1051 'Write playlist metadata in addition to the video metadata '
1052 'when using --write-info-json, --write-description etc. (default)'))
1053 filesystem
.add_option(
1054 '--no-write-playlist-metafiles',
1055 action
='store_false', dest
='allow_playlist_files',
1056 help='Do not write playlist metadata when using --write-info-json, --write-description etc.')
1057 filesystem
.add_option(
1059 action
='store_true', dest
='clean_infojson', default
=None,
1061 'Remove some private fields such as filenames from the infojson. '
1062 'Note that it could still contain some personal information (default)'))
1063 filesystem
.add_option(
1064 '--no-clean-infojson',
1065 action
='store_false', dest
='clean_infojson',
1066 help='Write all fields to the infojson')
1067 filesystem
.add_option(
1068 '--write-comments', '--get-comments',
1069 action
='store_true', dest
='getcomments', default
=False,
1071 'Retrieve video comments to be placed in the infojson. '
1072 'The comments are fetched even without this option if the extraction is known to be quick (Alias: --get-comments)'))
1073 filesystem
.add_option(
1074 '--no-write-comments', '--no-get-comments',
1075 action
='store_true', dest
='getcomments', default
=False,
1076 help='Do not retrieve video comments unless the extraction is known to be quick (Alias: --no-get-comments)')
1077 filesystem
.add_option(
1078 '--load-info-json', '--load-info',
1079 dest
='load_info_filename', metavar
='FILE',
1080 help='JSON file containing the video information (created with the "--write-info-json" option)')
1081 filesystem
.add_option(
1083 dest
='cookiefile', metavar
='FILE',
1084 help='File to read cookies from and dump cookie jar in')
1085 filesystem
.add_option(
1087 action
='store_const', const
=None, dest
='cookiefile', metavar
='FILE',
1088 help='Do not read/dump cookies from/to file (default)')
1089 filesystem
.add_option(
1090 '--cookies-from-browser',
1091 dest
='cookiesfrombrowser', metavar
='BROWSER[:PROFILE]',
1093 'Load cookies from a user profile of the given web browser. '
1094 'Currently supported browsers are: {}. '
1095 'You can specify the user profile name or directory using '
1096 '"BROWSER:PROFILE_NAME" or "BROWSER:PROFILE_PATH". '
1097 'If no profile is given, the most recently accessed one is used'.format(
1098 '|'.join(sorted(SUPPORTED_BROWSERS
)))))
1099 filesystem
.add_option(
1100 '--no-cookies-from-browser',
1101 action
='store_const', const
=None, dest
='cookiesfrombrowser',
1102 help='Do not load cookies from browser (default)')
1103 filesystem
.add_option(
1104 '--cache-dir', dest
='cachedir', default
=None, metavar
='DIR',
1105 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/youtube-dl or ~/.cache/youtube-dl')
1106 filesystem
.add_option(
1107 '--no-cache-dir', action
='store_false', dest
='cachedir',
1108 help='Disable filesystem caching')
1109 filesystem
.add_option(
1111 action
='store_true', dest
='rm_cachedir',
1112 help='Delete all filesystem cache files')
1114 thumbnail
= optparse
.OptionGroup(parser
, 'Thumbnail Options')
1115 thumbnail
.add_option(
1116 '--write-thumbnail',
1117 action
='store_true', dest
='writethumbnail', default
=False,
1118 help='Write thumbnail image to disk')
1119 thumbnail
.add_option(
1120 '--no-write-thumbnail',
1121 action
='store_false', dest
='writethumbnail',
1122 help='Do not write thumbnail image to disk (default)')
1123 thumbnail
.add_option(
1124 '--write-all-thumbnails',
1125 action
='store_true', dest
='write_all_thumbnails', default
=False,
1126 help='Write all thumbnail image formats to disk')
1127 thumbnail
.add_option(
1128 '--list-thumbnails',
1129 action
='store_true', dest
='list_thumbnails', default
=False,
1130 help='Simulate and list all available thumbnail formats')
1132 link
= optparse
.OptionGroup(parser
, 'Internet Shortcut Options')
1135 action
='store_true', dest
='writelink', default
=False,
1136 help='Write an internet shortcut file, depending on the current platform (.url, .webloc or .desktop). The URL may be cached by the OS')
1139 action
='store_true', dest
='writeurllink', default
=False,
1140 help='Write a .url Windows internet shortcut. The OS caches the URL based on the file path')
1142 '--write-webloc-link',
1143 action
='store_true', dest
='writewebloclink', default
=False,
1144 help='Write a .webloc macOS internet shortcut')
1146 '--write-desktop-link',
1147 action
='store_true', dest
='writedesktoplink', default
=False,
1148 help='Write a .desktop Linux internet shortcut')
1150 postproc
= optparse
.OptionGroup(parser
, 'Post-Processing Options')
1151 postproc
.add_option(
1152 '-x', '--extract-audio',
1153 action
='store_true', dest
='extractaudio', default
=False,
1154 help='Convert video files to audio-only files (requires ffmpeg and ffprobe)')
1155 postproc
.add_option(
1156 '--audio-format', metavar
='FORMAT', dest
='audioformat', default
='best',
1158 'Specify audio format to convert the audio to when -x is used. Currently supported formats are: '
1159 'best (default) or one of %s' % '|'.join(FFmpegExtractAudioPP
.SUPPORTED_EXTS
)))
1160 postproc
.add_option(
1161 '--audio-quality', metavar
='QUALITY',
1162 dest
='audioquality', default
='5',
1163 help='Specify ffmpeg audio quality, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default %default)')
1164 postproc
.add_option(
1166 metavar
='FORMAT', dest
='remuxvideo', default
=None,
1168 'Remux the video into another container if necessary (currently supported: %s). '
1169 'If target container does not support the video/audio codec, remuxing will fail. '
1170 'You can specify multiple rules; Eg. "aac>m4a/mov>mp4/mkv" will remux aac to m4a, mov to mp4 '
1171 'and anything else to mkv.' % '|'.join(FFmpegVideoRemuxerPP
.SUPPORTED_EXTS
)))
1172 postproc
.add_option(
1174 metavar
='FORMAT', dest
='recodevideo', default
=None,
1176 'Re-encode the video into another format if re-encoding is necessary. '
1177 'The syntax and supported formats are the same as --remux-video'))
1178 postproc
.add_option(
1179 '--postprocessor-args', '--ppa',
1180 metavar
='NAME:ARGS', dest
='postprocessor_args', default
={}, type='str',
1181 action
='callback', callback
=_dict_from_options_callback
,
1183 'allowed_keys': r
'\w+(?:\+\w+)?', 'default_key': 'default-compat',
1184 'process': compat_shlex_split
,
1185 'multiple_keys': False
1187 'Give these arguments to the postprocessors. '
1188 'Specify the postprocessor/executable name and the arguments separated by a colon ":" '
1189 'to give the argument to the specified postprocessor/executable. Supported PP are: '
1190 'Merger, ExtractAudio, SplitChapters, Metadata, EmbedSubtitle, EmbedThumbnail, '
1191 'SubtitlesConvertor, ThumbnailsConvertor, VideoRemuxer, VideoConvertor, '
1192 'SponSkrub, FixupStretched, FixupM4a, FixupM3u8, FixupTimestamp and FixupDuration. '
1193 'The supported executables are: AtomicParsley, FFmpeg, FFprobe, and SponSkrub. '
1194 'You can also specify "PP+EXE:ARGS" to give the arguments to the specified executable '
1195 'only when being used by the specified postprocessor. Additionally, for ffmpeg/ffprobe, '
1196 '"_i"/"_o" can be appended to the prefix optionally followed by a number to pass the argument '
1197 'before the specified input/output file. Eg: --ppa "Merger+ffmpeg_i1:-v quiet". '
1198 'You can use this option multiple times to give different arguments to different '
1199 'postprocessors. (Alias: --ppa)'))
1200 postproc
.add_option(
1201 '-k', '--keep-video',
1202 action
='store_true', dest
='keepvideo', default
=False,
1203 help='Keep the intermediate video file on disk after post-processing')
1204 postproc
.add_option(
1206 action
='store_false', dest
='keepvideo',
1207 help='Delete the intermediate video file after post-processing (default)')
1208 postproc
.add_option(
1209 '--post-overwrites',
1210 action
='store_false', dest
='nopostoverwrites',
1211 help='Overwrite post-processed files (default)')
1212 postproc
.add_option(
1213 '--no-post-overwrites',
1214 action
='store_true', dest
='nopostoverwrites', default
=False,
1215 help='Do not overwrite post-processed files')
1216 postproc
.add_option(
1218 action
='store_true', dest
='embedsubtitles', default
=False,
1219 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
1220 postproc
.add_option(
1222 action
='store_false', dest
='embedsubtitles',
1223 help='Do not embed subtitles (default)')
1224 postproc
.add_option(
1225 '--embed-thumbnail',
1226 action
='store_true', dest
='embedthumbnail', default
=False,
1227 help='Embed thumbnail in the video as cover art')
1228 postproc
.add_option(
1229 '--no-embed-thumbnail',
1230 action
='store_false', dest
='embedthumbnail',
1231 help='Do not embed thumbnail (default)')
1232 postproc
.add_option(
1233 '--embed-metadata', '--add-metadata',
1234 action
='store_true', dest
='addmetadata', default
=False,
1235 help='Embed metadata including chapter markers (if supported by the format) to the video file (Alias: --add-metadata)')
1236 postproc
.add_option(
1237 '--no-embed-metadata', '--no-add-metadata',
1238 action
='store_false', dest
='addmetadata',
1239 help='Do not write metadata (default) (Alias: --no-add-metadata)')
1240 postproc
.add_option(
1241 '--metadata-from-title',
1242 metavar
='FORMAT', dest
='metafromtitle',
1243 help=optparse
.SUPPRESS_HELP
)
1244 postproc
.add_option(
1246 metavar
='FROM:TO', dest
='metafromfield', action
='append',
1248 'Parse additional metadata like title/artist from other fields; '
1249 'see "MODIFYING METADATA" for details'))
1250 postproc
.add_option(
1252 action
='store_true', dest
='xattrs', default
=False,
1253 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
1254 postproc
.add_option(
1256 metavar
='POLICY', dest
='fixup', default
=None,
1257 choices
=('never', 'ignore', 'warn', 'detect_or_warn', 'force'),
1259 'Automatically correct known faults of the file. '
1260 'One of never (do nothing), warn (only emit a warning), '
1261 'detect_or_warn (the default; fix file if we can, warn otherwise), '
1262 'force (try fixing even if file already exists'))
1263 postproc
.add_option(
1264 '--prefer-avconv', '--no-prefer-ffmpeg',
1265 action
='store_false', dest
='prefer_ffmpeg',
1266 help=optparse
.SUPPRESS_HELP
)
1267 postproc
.add_option(
1268 '--prefer-ffmpeg', '--no-prefer-avconv',
1269 action
='store_true', dest
='prefer_ffmpeg', default
=True,
1270 help=optparse
.SUPPRESS_HELP
)
1271 postproc
.add_option(
1272 '--ffmpeg-location', '--avconv-location', metavar
='PATH',
1273 dest
='ffmpeg_location',
1274 help='Location of the ffmpeg binary; either the path to the binary or its containing directory')
1275 postproc
.add_option(
1277 metavar
='CMD', dest
='exec_cmd',
1279 'Execute a command on the file after downloading and post-processing. '
1280 'Similar syntax to the output template can be used to pass any field as arguments to the command. '
1281 'An additional field "filepath" that contains the final path of the downloaded file is also available. '
1282 'If no fields are passed, %(filepath)q is appended to the end of the command'))
1283 postproc
.add_option(
1284 '--exec-before-download',
1285 metavar
='CMD', dest
='exec_before_dl_cmd',
1286 help='Execute a command before the actual download. The syntax is the same as --exec but "filepath" is not available')
1287 postproc
.add_option(
1288 '--convert-subs', '--convert-sub', '--convert-subtitles',
1289 metavar
='FORMAT', dest
='convertsubtitles', default
=None,
1291 'Convert the subtitles to another format (currently supported: %s) '
1292 '(Alias: --convert-subtitles)' % '|'.join(FFmpegSubtitlesConvertorPP
.SUPPORTED_EXTS
)))
1293 postproc
.add_option(
1294 '--convert-thumbnails',
1295 metavar
='FORMAT', dest
='convertthumbnails', default
=None,
1297 'Convert the thumbnails to another format '
1298 '(currently supported: %s) ' % '|'.join(FFmpegThumbnailsConvertorPP
.SUPPORTED_EXTS
)))
1299 postproc
.add_option(
1300 '--split-chapters', '--split-tracks',
1301 dest
='split_chapters', action
='store_true', default
=False,
1303 'Split video into multiple files based on internal chapters. '
1304 'The "chapter:" prefix can be used with "--paths" and "--output" to '
1305 'set the output filename for the split files. See "OUTPUT TEMPLATE" for details'))
1306 postproc
.add_option(
1307 '--no-split-chapters', '--no-split-tracks',
1308 dest
='split_chapters', action
='store_false',
1309 help='Do not split video based on chapters (default)')
1311 sponskrub
= optparse
.OptionGroup(parser
, 'SponSkrub (SponsorBlock) Options', description
=(
1312 'SponSkrub (https://github.com/yt-dlp/SponSkrub) is a utility to mark/remove sponsor segments '
1313 'from downloaded YouTube videos using SponsorBlock API (https://sponsor.ajay.app)'))
1314 sponskrub
.add_option(
1316 action
='store_true', dest
='sponskrub', default
=None,
1318 'Use sponskrub to mark sponsored sections. '
1319 'This is enabled by default if the sponskrub binary exists (Youtube only)'))
1320 sponskrub
.add_option(
1322 action
='store_false', dest
='sponskrub',
1323 help='Do not use sponskrub')
1324 sponskrub
.add_option(
1325 '--sponskrub-cut', default
=False,
1326 action
='store_true', dest
='sponskrub_cut',
1327 help='Cut out the sponsor sections instead of simply marking them')
1328 sponskrub
.add_option(
1329 '--no-sponskrub-cut',
1330 action
='store_false', dest
='sponskrub_cut',
1331 help='Simply mark the sponsor sections, not cut them out (default)')
1332 sponskrub
.add_option(
1333 '--sponskrub-force', default
=False,
1334 action
='store_true', dest
='sponskrub_force',
1335 help='Run sponskrub even if the video was already downloaded')
1336 sponskrub
.add_option(
1337 '--no-sponskrub-force',
1338 action
='store_true', dest
='sponskrub_force',
1339 help='Do not cut out the sponsor sections if the video was already downloaded (default)')
1340 sponskrub
.add_option(
1341 '--sponskrub-location', metavar
='PATH',
1342 dest
='sponskrub_path', default
='',
1343 help='Location of the sponskrub binary; either the path to the binary or its containing directory')
1344 sponskrub
.add_option(
1345 '--sponskrub-args', dest
='sponskrub_args', metavar
='ARGS',
1346 help=optparse
.SUPPRESS_HELP
)
1348 extractor
= optparse
.OptionGroup(parser
, 'Extractor Options')
1349 extractor
.add_option(
1350 '--extractor-retries',
1351 dest
='extractor_retries', metavar
='RETRIES', default
=3,
1352 help='Number of retries for known extractor errors (default is %default), or "infinite"')
1353 extractor
.add_option(
1354 '--allow-dynamic-mpd', '--no-ignore-dynamic-mpd',
1355 action
='store_true', dest
='dynamic_mpd', default
=True,
1356 help='Process dynamic DASH manifests (default) (Alias: --no-ignore-dynamic-mpd)')
1357 extractor
.add_option(
1358 '--ignore-dynamic-mpd', '--no-allow-dynamic-mpd',
1359 action
='store_false', dest
='dynamic_mpd',
1360 help='Do not process dynamic DASH manifests (Alias: --no-allow-dynamic-mpd)')
1361 extractor
.add_option(
1362 '--hls-split-discontinuity',
1363 dest
='hls_split_discontinuity', action
='store_true', default
=False,
1364 help='Split HLS playlists to different formats at discontinuities such as ad breaks'
1366 extractor
.add_option(
1367 '--no-hls-split-discontinuity',
1368 dest
='hls_split_discontinuity', action
='store_false',
1369 help='Do not split HLS playlists to different formats at discontinuities such as ad breaks (default)')
1370 _extractor_arg_parser
= lambda key
, vals
='': (key
.strip().lower().replace('-', '_'), [val
.strip() for val
in vals
.split(',')])
1371 extractor
.add_option(
1373 metavar
='KEY:ARGS', dest
='extractor_args', default
={}, type='str',
1374 action
='callback', callback
=_dict_from_options_callback
,
1376 'multiple_keys': False,
1377 'process': lambda val
: dict(
1378 _extractor_arg_parser(*arg
.split('=', 1)) for arg
in val
.split(';'))
1380 'Pass these arguments to the extractor. See "EXTRACTOR ARGUMENTS" for details. '
1381 'You can use this option multiple times to give arguments for different extractors'))
1382 extractor
.add_option(
1383 '--youtube-include-dash-manifest', '--no-youtube-skip-dash-manifest',
1384 action
='store_true', dest
='youtube_include_dash_manifest', default
=True,
1385 help=optparse
.SUPPRESS_HELP
)
1386 extractor
.add_option(
1387 '--youtube-skip-dash-manifest', '--no-youtube-include-dash-manifest',
1388 action
='store_false', dest
='youtube_include_dash_manifest',
1389 help=optparse
.SUPPRESS_HELP
)
1390 extractor
.add_option(
1391 '--youtube-include-hls-manifest', '--no-youtube-skip-hls-manifest',
1392 action
='store_true', dest
='youtube_include_hls_manifest', default
=True,
1393 help=optparse
.SUPPRESS_HELP
)
1394 extractor
.add_option(
1395 '--youtube-skip-hls-manifest', '--no-youtube-include-hls-manifest',
1396 action
='store_false', dest
='youtube_include_hls_manifest',
1397 help=optparse
.SUPPRESS_HELP
)
1399 parser
.add_option_group(general
)
1400 parser
.add_option_group(network
)
1401 parser
.add_option_group(geo
)
1402 parser
.add_option_group(selection
)
1403 parser
.add_option_group(downloader
)
1404 parser
.add_option_group(filesystem
)
1405 parser
.add_option_group(thumbnail
)
1406 parser
.add_option_group(link
)
1407 parser
.add_option_group(verbosity
)
1408 parser
.add_option_group(workarounds
)
1409 parser
.add_option_group(video_format
)
1410 parser
.add_option_group(subtitles
)
1411 parser
.add_option_group(authentication
)
1412 parser
.add_option_group(postproc
)
1413 parser
.add_option_group(sponskrub
)
1414 parser
.add_option_group(extractor
)
1416 if overrideArguments
is not None:
1417 opts
, args
= parser
.parse_args(overrideArguments
)
1419 write_string('[debug] Override config: ' + repr(overrideArguments
) + '\n')
1421 def compat_conf(conf
):
1422 if sys
.version_info
< (3,):
1423 return [a
.decode(preferredencoding(), 'replace') for a
in conf
]
1427 'command-line': compat_conf(sys
.argv
[1:]),
1428 'custom': [], 'home': [], 'portable': [], 'user': [], 'system': []}
1429 paths
= {'command-line': False}
1430 opts
, args
= parser
.parse_args(configs
['command-line'])
1433 if '--config-location' in configs
['command-line']:
1434 location
= compat_expanduser(opts
.config_location
)
1435 if os
.path
.isdir(location
):
1436 location
= os
.path
.join(location
, 'yt-dlp.conf')
1437 if not os
.path
.exists(location
):
1438 parser
.error('config-location %s does not exist.' % location
)
1439 configs
['custom'] = _readOptions(location
, default
=None)
1440 if configs
['custom'] is None:
1441 configs
['custom'] = []
1443 paths
['custom'] = location
1444 if '--ignore-config' in configs
['command-line']:
1446 if '--ignore-config' in configs
['custom']:
1449 def read_options(path
, user
=False):
1450 # Multiple package names can be given here
1451 # Eg: ('yt-dlp', 'youtube-dlc', 'youtube-dl') will look for
1452 # the configuration file of any of these three packages
1453 for package
in ('yt-dlp',):
1455 config
, current_path
= _readUserConf(package
, default
=None)
1457 current_path
= os
.path
.join(path
, '%s.conf' % package
)
1458 config
= _readOptions(current_path
, default
=None)
1459 if config
is not None:
1460 return config
, current_path
1463 configs
['portable'], paths
['portable'] = read_options(get_executable_path())
1464 if '--ignore-config' in configs
['portable']:
1467 def get_home_path():
1468 opts
= parser
.parse_args(configs
['portable'] + configs
['custom'] + configs
['command-line'])[0]
1469 return expand_path(opts
.paths
.get('home', '')).strip()
1471 configs
['home'], paths
['home'] = read_options(get_home_path())
1472 if '--ignore-config' in configs
['home']:
1475 configs
['system'], paths
['system'] = read_options('/etc')
1476 if '--ignore-config' in configs
['system']:
1479 configs
['user'], paths
['user'] = read_options('', True)
1480 if '--ignore-config' in configs
['user']:
1481 configs
['system'], paths
['system'] = [], None
1484 argv
= configs
['system'] + configs
['user'] + configs
['home'] + configs
['portable'] + configs
['custom'] + configs
['command-line']
1485 opts
, args
= parser
.parse_args(argv
)
1487 for label
in ('System', 'User', 'Portable', 'Home', 'Custom', 'Command-line'):
1489 if paths
.get(key
) is None:
1492 write_string('[debug] %s config file: %s\n' % (label
, paths
[key
]))
1493 write_string('[debug] %s config: %s\n' % (label
, repr(_hide_login_info(configs
[key
]))))
1495 return parser
, opts
, args